spec

package
v0.5.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 15, 2021 License: BSD-3-Clause Imports: 11 Imported by: 2

Documentation

Overview

Package spec provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.8.1 DO NOT EDIT.

Index

Constants

View Source
const (
	BearerAuthScopes = "bearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewAcceptInvitationRequest

func NewAcceptInvitationRequest(server string, inviteID string) (*http.Request, error)

NewAcceptInvitationRequest generates requests for AcceptInvitation

func NewAddAPITokenRequest

func NewAddAPITokenRequest(server string, userID string, body AddAPITokenJSONRequestBody) (*http.Request, error)

NewAddAPITokenRequest calls the generic AddAPIToken builder with application/json body

func NewAddAPITokenRequestWithBody

func NewAddAPITokenRequestWithBody(server string, userID string, contentType string, body io.Reader) (*http.Request, error)

NewAddAPITokenRequestWithBody generates requests for AddAPIToken with any type of body

func NewDeclineInvitationRequest

func NewDeclineInvitationRequest(server string, inviteID string) (*http.Request, error)

NewDeclineInvitationRequest generates requests for DeclineInvitation

func NewDeleteAPITokenRequest

func NewDeleteAPITokenRequest(server string, userID string, tokenName string) (*http.Request, error)

NewDeleteAPITokenRequest generates requests for DeleteAPIToken

func NewDeleteNetworkMemberRequest

func NewDeleteNetworkMemberRequest(server string, networkID string, memberID string) (*http.Request, error)

NewDeleteNetworkMemberRequest generates requests for DeleteNetworkMember

func NewDeleteNetworkRequest

func NewDeleteNetworkRequest(server string, networkID string) (*http.Request, error)

NewDeleteNetworkRequest generates requests for DeleteNetwork

func NewDeleteUserByIDRequest

func NewDeleteUserByIDRequest(server string, userID string) (*http.Request, error)

NewDeleteUserByIDRequest generates requests for DeleteUserByID

func NewGetInvitationByIDRequest

func NewGetInvitationByIDRequest(server string, inviteID string) (*http.Request, error)

NewGetInvitationByIDRequest generates requests for GetInvitationByID

func NewGetNetworkByIDRequest

func NewGetNetworkByIDRequest(server string, networkID string) (*http.Request, error)

NewGetNetworkByIDRequest generates requests for GetNetworkByID

func NewGetNetworkListRequest

func NewGetNetworkListRequest(server string) (*http.Request, error)

NewGetNetworkListRequest generates requests for GetNetworkList

func NewGetNetworkMemberListRequest

func NewGetNetworkMemberListRequest(server string, networkID string) (*http.Request, error)

NewGetNetworkMemberListRequest generates requests for GetNetworkMemberList

func NewGetNetworkMemberRequest

func NewGetNetworkMemberRequest(server string, networkID string, memberID string) (*http.Request, error)

NewGetNetworkMemberRequest generates requests for GetNetworkMember

func NewGetOrganizationByIDRequest

func NewGetOrganizationByIDRequest(server string, orgID string) (*http.Request, error)

NewGetOrganizationByIDRequest generates requests for GetOrganizationByID

func NewGetOrganizationInvitationListRequest

func NewGetOrganizationInvitationListRequest(server string) (*http.Request, error)

NewGetOrganizationInvitationListRequest generates requests for GetOrganizationInvitationList

func NewGetOrganizationMembersRequest

func NewGetOrganizationMembersRequest(server string, orgID string) (*http.Request, error)

NewGetOrganizationMembersRequest generates requests for GetOrganizationMembers

func NewGetOrganizationRequest

func NewGetOrganizationRequest(server string) (*http.Request, error)

NewGetOrganizationRequest generates requests for GetOrganization

func NewGetRandomTokenRequest

func NewGetRandomTokenRequest(server string) (*http.Request, error)

NewGetRandomTokenRequest generates requests for GetRandomToken

func NewGetStatusRequest added in v0.5.0

func NewGetStatusRequest(server string) (*http.Request, error)

NewGetStatusRequest generates requests for GetStatus

func NewGetUserByIDRequest

func NewGetUserByIDRequest(server string, userID string) (*http.Request, error)

NewGetUserByIDRequest generates requests for GetUserByID

func NewInviteUserByEmailRequest

func NewInviteUserByEmailRequest(server string, body InviteUserByEmailJSONRequestBody) (*http.Request, error)

NewInviteUserByEmailRequest calls the generic InviteUserByEmail builder with application/json body

func NewInviteUserByEmailRequestWithBody

func NewInviteUserByEmailRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewInviteUserByEmailRequestWithBody generates requests for InviteUserByEmail with any type of body

func NewNewNetworkRequest

func NewNewNetworkRequest(server string, body NewNetworkJSONRequestBody) (*http.Request, error)

NewNewNetworkRequest calls the generic NewNetwork builder with application/json body

func NewNewNetworkRequestWithBody

func NewNewNetworkRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewNewNetworkRequestWithBody generates requests for NewNetwork with any type of body

func NewUpdateNetworkMemberRequest

func NewUpdateNetworkMemberRequest(server string, networkID string, memberID string, body UpdateNetworkMemberJSONRequestBody) (*http.Request, error)

NewUpdateNetworkMemberRequest calls the generic UpdateNetworkMember builder with application/json body

func NewUpdateNetworkMemberRequestWithBody

func NewUpdateNetworkMemberRequestWithBody(server string, networkID string, memberID string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateNetworkMemberRequestWithBody generates requests for UpdateNetworkMember with any type of body

func NewUpdateNetworkRequest

func NewUpdateNetworkRequest(server string, networkID string, body UpdateNetworkJSONRequestBody) (*http.Request, error)

NewUpdateNetworkRequest calls the generic UpdateNetwork builder with application/json body

func NewUpdateNetworkRequestWithBody

func NewUpdateNetworkRequestWithBody(server string, networkID string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateNetworkRequestWithBody generates requests for UpdateNetwork with any type of body

func NewUpdateUserByIDRequest

func NewUpdateUserByIDRequest(server string, userID string, body UpdateUserByIDJSONRequestBody) (*http.Request, error)

NewUpdateUserByIDRequest calls the generic UpdateUserByID builder with application/json body

func NewUpdateUserByIDRequestWithBody

func NewUpdateUserByIDRequestWithBody(server string, userID string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateUserByIDRequestWithBody generates requests for UpdateUserByID with any type of body

Types

type APIToken

type APIToken struct {

	// API Token.  Minimum 32 characters. This token is encrypted in the database and can not be retrieved once set
	Token *string `json:"token,omitempty"`

	// user specified token name
	TokenName *string `json:"tokenName,omitempty"`
}

APIToken defines model for APIToken.

type AcceptInvitationResponse

type AcceptInvitationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OrganizationInvitation
}

func ParseAcceptInvitationResponse

func ParseAcceptInvitationResponse(rsp *http.Response) (*AcceptInvitationResponse, error)

ParseAcceptInvitationResponse parses an HTTP response from a AcceptInvitationWithResponse call

func (AcceptInvitationResponse) Status

func (r AcceptInvitationResponse) Status() string

Status returns HTTPResponse.Status

func (AcceptInvitationResponse) StatusCode

func (r AcceptInvitationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AddAPITokenJSONBody

type AddAPITokenJSONBody APIToken

AddAPITokenJSONBody defines parameters for AddAPIToken.

type AddAPITokenJSONRequestBody

type AddAPITokenJSONRequestBody AddAPITokenJSONBody

AddAPITokenJSONRequestBody defines body for AddAPIToken for application/json ContentType.

type AddAPITokenResponse

type AddAPITokenResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *APIToken
}

func ParseAddAPITokenResponse

func ParseAddAPITokenResponse(rsp *http.Response) (*AddAPITokenResponse, error)

ParseAddAPITokenResponse parses an HTTP response from a AddAPITokenWithResponse call

func (AddAPITokenResponse) Status

func (r AddAPITokenResponse) Status() string

Status returns HTTPResponse.Status

func (AddAPITokenResponse) StatusCode

func (r AddAPITokenResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AuthMethods

type AuthMethods struct {

	// Google OIDC ID
	Google *string `json:"google"`

	// email address for built-in authentication
	Local *string `json:"local"`

	// Generic OIDC ID
	Oidc *string `json:"oidc"`
}

AuthMethods defines model for AuthMethods.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) AcceptInvitation

func (c *Client) AcceptInvitation(ctx context.Context, inviteID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AddAPIToken

func (c *Client) AddAPIToken(ctx context.Context, userID string, body AddAPITokenJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AddAPITokenWithBody

func (c *Client) AddAPITokenWithBody(ctx context.Context, userID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeclineInvitation

func (c *Client) DeclineInvitation(ctx context.Context, inviteID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteAPIToken

func (c *Client) DeleteAPIToken(ctx context.Context, userID string, tokenName string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteNetwork

func (c *Client) DeleteNetwork(ctx context.Context, networkID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteNetworkMember

func (c *Client) DeleteNetworkMember(ctx context.Context, networkID string, memberID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteUserByID

func (c *Client) DeleteUserByID(ctx context.Context, userID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInvitationByID

func (c *Client) GetInvitationByID(ctx context.Context, inviteID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetNetworkByID

func (c *Client) GetNetworkByID(ctx context.Context, networkID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetNetworkList

func (c *Client) GetNetworkList(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetNetworkMember

func (c *Client) GetNetworkMember(ctx context.Context, networkID string, memberID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetNetworkMemberList

func (c *Client) GetNetworkMemberList(ctx context.Context, networkID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetOrganization

func (c *Client) GetOrganization(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetOrganizationByID

func (c *Client) GetOrganizationByID(ctx context.Context, orgID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetOrganizationInvitationList

func (c *Client) GetOrganizationInvitationList(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetOrganizationMembers

func (c *Client) GetOrganizationMembers(ctx context.Context, orgID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRandomToken

func (c *Client) GetRandomToken(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetStatus added in v0.5.0

func (c *Client) GetStatus(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetUserByID

func (c *Client) GetUserByID(ctx context.Context, userID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InviteUserByEmail

func (c *Client) InviteUserByEmail(ctx context.Context, body InviteUserByEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) InviteUserByEmailWithBody

func (c *Client) InviteUserByEmailWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) NewNetwork

func (c *Client) NewNetwork(ctx context.Context, body NewNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) NewNetworkWithBody

func (c *Client) NewNetworkWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateNetwork

func (c *Client) UpdateNetwork(ctx context.Context, networkID string, body UpdateNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateNetworkMember

func (c *Client) UpdateNetworkMember(ctx context.Context, networkID string, memberID string, body UpdateNetworkMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateNetworkMemberWithBody

func (c *Client) UpdateNetworkMemberWithBody(ctx context.Context, networkID string, memberID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateNetworkWithBody

func (c *Client) UpdateNetworkWithBody(ctx context.Context, networkID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateUserByID

func (c *Client) UpdateUserByID(ctx context.Context, userID string, body UpdateUserByIDJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateUserByIDWithBody

func (c *Client) UpdateUserByIDWithBody(ctx context.Context, userID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// GetNetworkList request
	GetNetworkList(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// NewNetwork request  with any body
	NewNetworkWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	NewNetwork(ctx context.Context, body NewNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteNetwork request
	DeleteNetwork(ctx context.Context, networkID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetNetworkByID request
	GetNetworkByID(ctx context.Context, networkID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateNetwork request  with any body
	UpdateNetworkWithBody(ctx context.Context, networkID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateNetwork(ctx context.Context, networkID string, body UpdateNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetNetworkMemberList request
	GetNetworkMemberList(ctx context.Context, networkID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteNetworkMember request
	DeleteNetworkMember(ctx context.Context, networkID string, memberID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetNetworkMember request
	GetNetworkMember(ctx context.Context, networkID string, memberID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateNetworkMember request  with any body
	UpdateNetworkMemberWithBody(ctx context.Context, networkID string, memberID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateNetworkMember(ctx context.Context, networkID string, memberID string, body UpdateNetworkMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrganization request
	GetOrganization(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrganizationInvitationList request
	GetOrganizationInvitationList(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InviteUserByEmail request  with any body
	InviteUserByEmailWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	InviteUserByEmail(ctx context.Context, body InviteUserByEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeclineInvitation request
	DeclineInvitation(ctx context.Context, inviteID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInvitationByID request
	GetInvitationByID(ctx context.Context, inviteID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AcceptInvitation request
	AcceptInvitation(ctx context.Context, inviteID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrganizationByID request
	GetOrganizationByID(ctx context.Context, orgID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOrganizationMembers request
	GetOrganizationMembers(ctx context.Context, orgID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRandomToken request
	GetRandomToken(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStatus request
	GetStatus(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteUserByID request
	DeleteUserByID(ctx context.Context, userID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetUserByID request
	GetUserByID(ctx context.Context, userID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateUserByID request  with any body
	UpdateUserByIDWithBody(ctx context.Context, userID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateUserByID(ctx context.Context, userID string, body UpdateUserByIDJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AddAPIToken request  with any body
	AddAPITokenWithBody(ctx context.Context, userID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AddAPIToken(ctx context.Context, userID string, body AddAPITokenJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteAPIToken request
	DeleteAPIToken(ctx context.Context, userID string, tokenName string, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) AcceptInvitationWithResponse

func (c *ClientWithResponses) AcceptInvitationWithResponse(ctx context.Context, inviteID string, reqEditors ...RequestEditorFn) (*AcceptInvitationResponse, error)

AcceptInvitationWithResponse request returning *AcceptInvitationResponse

func (*ClientWithResponses) AddAPITokenWithBodyWithResponse

func (c *ClientWithResponses) AddAPITokenWithBodyWithResponse(ctx context.Context, userID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddAPITokenResponse, error)

AddAPITokenWithBodyWithResponse request with arbitrary body returning *AddAPITokenResponse

func (*ClientWithResponses) AddAPITokenWithResponse

func (c *ClientWithResponses) AddAPITokenWithResponse(ctx context.Context, userID string, body AddAPITokenJSONRequestBody, reqEditors ...RequestEditorFn) (*AddAPITokenResponse, error)

func (*ClientWithResponses) DeclineInvitationWithResponse

func (c *ClientWithResponses) DeclineInvitationWithResponse(ctx context.Context, inviteID string, reqEditors ...RequestEditorFn) (*DeclineInvitationResponse, error)

DeclineInvitationWithResponse request returning *DeclineInvitationResponse

func (*ClientWithResponses) DeleteAPITokenWithResponse

func (c *ClientWithResponses) DeleteAPITokenWithResponse(ctx context.Context, userID string, tokenName string, reqEditors ...RequestEditorFn) (*DeleteAPITokenResponse, error)

DeleteAPITokenWithResponse request returning *DeleteAPITokenResponse

func (*ClientWithResponses) DeleteNetworkMemberWithResponse

func (c *ClientWithResponses) DeleteNetworkMemberWithResponse(ctx context.Context, networkID string, memberID string, reqEditors ...RequestEditorFn) (*DeleteNetworkMemberResponse, error)

DeleteNetworkMemberWithResponse request returning *DeleteNetworkMemberResponse

func (*ClientWithResponses) DeleteNetworkWithResponse

func (c *ClientWithResponses) DeleteNetworkWithResponse(ctx context.Context, networkID string, reqEditors ...RequestEditorFn) (*DeleteNetworkResponse, error)

DeleteNetworkWithResponse request returning *DeleteNetworkResponse

func (*ClientWithResponses) DeleteUserByIDWithResponse

func (c *ClientWithResponses) DeleteUserByIDWithResponse(ctx context.Context, userID string, reqEditors ...RequestEditorFn) (*DeleteUserByIDResponse, error)

DeleteUserByIDWithResponse request returning *DeleteUserByIDResponse

func (*ClientWithResponses) GetInvitationByIDWithResponse

func (c *ClientWithResponses) GetInvitationByIDWithResponse(ctx context.Context, inviteID string, reqEditors ...RequestEditorFn) (*GetInvitationByIDResponse, error)

GetInvitationByIDWithResponse request returning *GetInvitationByIDResponse

func (*ClientWithResponses) GetNetworkByIDWithResponse

func (c *ClientWithResponses) GetNetworkByIDWithResponse(ctx context.Context, networkID string, reqEditors ...RequestEditorFn) (*GetNetworkByIDResponse, error)

GetNetworkByIDWithResponse request returning *GetNetworkByIDResponse

func (*ClientWithResponses) GetNetworkListWithResponse

func (c *ClientWithResponses) GetNetworkListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetNetworkListResponse, error)

GetNetworkListWithResponse request returning *GetNetworkListResponse

func (*ClientWithResponses) GetNetworkMemberListWithResponse

func (c *ClientWithResponses) GetNetworkMemberListWithResponse(ctx context.Context, networkID string, reqEditors ...RequestEditorFn) (*GetNetworkMemberListResponse, error)

GetNetworkMemberListWithResponse request returning *GetNetworkMemberListResponse

func (*ClientWithResponses) GetNetworkMemberWithResponse

func (c *ClientWithResponses) GetNetworkMemberWithResponse(ctx context.Context, networkID string, memberID string, reqEditors ...RequestEditorFn) (*GetNetworkMemberResponse, error)

GetNetworkMemberWithResponse request returning *GetNetworkMemberResponse

func (*ClientWithResponses) GetOrganizationByIDWithResponse

func (c *ClientWithResponses) GetOrganizationByIDWithResponse(ctx context.Context, orgID string, reqEditors ...RequestEditorFn) (*GetOrganizationByIDResponse, error)

GetOrganizationByIDWithResponse request returning *GetOrganizationByIDResponse

func (*ClientWithResponses) GetOrganizationInvitationListWithResponse

func (c *ClientWithResponses) GetOrganizationInvitationListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOrganizationInvitationListResponse, error)

GetOrganizationInvitationListWithResponse request returning *GetOrganizationInvitationListResponse

func (*ClientWithResponses) GetOrganizationMembersWithResponse

func (c *ClientWithResponses) GetOrganizationMembersWithResponse(ctx context.Context, orgID string, reqEditors ...RequestEditorFn) (*GetOrganizationMembersResponse, error)

GetOrganizationMembersWithResponse request returning *GetOrganizationMembersResponse

func (*ClientWithResponses) GetOrganizationWithResponse

func (c *ClientWithResponses) GetOrganizationWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOrganizationResponse, error)

GetOrganizationWithResponse request returning *GetOrganizationResponse

func (*ClientWithResponses) GetRandomTokenWithResponse

func (c *ClientWithResponses) GetRandomTokenWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRandomTokenResponse, error)

GetRandomTokenWithResponse request returning *GetRandomTokenResponse

func (*ClientWithResponses) GetStatusWithResponse added in v0.5.0

func (c *ClientWithResponses) GetStatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetStatusResponse, error)

GetStatusWithResponse request returning *GetStatusResponse

func (*ClientWithResponses) GetUserByIDWithResponse

func (c *ClientWithResponses) GetUserByIDWithResponse(ctx context.Context, userID string, reqEditors ...RequestEditorFn) (*GetUserByIDResponse, error)

GetUserByIDWithResponse request returning *GetUserByIDResponse

func (*ClientWithResponses) InviteUserByEmailWithBodyWithResponse

func (c *ClientWithResponses) InviteUserByEmailWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InviteUserByEmailResponse, error)

InviteUserByEmailWithBodyWithResponse request with arbitrary body returning *InviteUserByEmailResponse

func (*ClientWithResponses) InviteUserByEmailWithResponse

func (c *ClientWithResponses) InviteUserByEmailWithResponse(ctx context.Context, body InviteUserByEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*InviteUserByEmailResponse, error)

func (*ClientWithResponses) NewNetworkWithBodyWithResponse

func (c *ClientWithResponses) NewNetworkWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*NewNetworkResponse, error)

NewNetworkWithBodyWithResponse request with arbitrary body returning *NewNetworkResponse

func (*ClientWithResponses) NewNetworkWithResponse

func (c *ClientWithResponses) NewNetworkWithResponse(ctx context.Context, body NewNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*NewNetworkResponse, error)

func (*ClientWithResponses) UpdateNetworkMemberWithBodyWithResponse

func (c *ClientWithResponses) UpdateNetworkMemberWithBodyWithResponse(ctx context.Context, networkID string, memberID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateNetworkMemberResponse, error)

UpdateNetworkMemberWithBodyWithResponse request with arbitrary body returning *UpdateNetworkMemberResponse

func (*ClientWithResponses) UpdateNetworkMemberWithResponse

func (c *ClientWithResponses) UpdateNetworkMemberWithResponse(ctx context.Context, networkID string, memberID string, body UpdateNetworkMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateNetworkMemberResponse, error)

func (*ClientWithResponses) UpdateNetworkWithBodyWithResponse

func (c *ClientWithResponses) UpdateNetworkWithBodyWithResponse(ctx context.Context, networkID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateNetworkResponse, error)

UpdateNetworkWithBodyWithResponse request with arbitrary body returning *UpdateNetworkResponse

func (*ClientWithResponses) UpdateNetworkWithResponse

func (c *ClientWithResponses) UpdateNetworkWithResponse(ctx context.Context, networkID string, body UpdateNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateNetworkResponse, error)

func (*ClientWithResponses) UpdateUserByIDWithBodyWithResponse

func (c *ClientWithResponses) UpdateUserByIDWithBodyWithResponse(ctx context.Context, userID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateUserByIDResponse, error)

UpdateUserByIDWithBodyWithResponse request with arbitrary body returning *UpdateUserByIDResponse

func (*ClientWithResponses) UpdateUserByIDWithResponse

func (c *ClientWithResponses) UpdateUserByIDWithResponse(ctx context.Context, userID string, body UpdateUserByIDJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateUserByIDResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetNetworkList request
	GetNetworkListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetNetworkListResponse, error)

	// NewNetwork request  with any body
	NewNetworkWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*NewNetworkResponse, error)

	NewNetworkWithResponse(ctx context.Context, body NewNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*NewNetworkResponse, error)

	// DeleteNetwork request
	DeleteNetworkWithResponse(ctx context.Context, networkID string, reqEditors ...RequestEditorFn) (*DeleteNetworkResponse, error)

	// GetNetworkByID request
	GetNetworkByIDWithResponse(ctx context.Context, networkID string, reqEditors ...RequestEditorFn) (*GetNetworkByIDResponse, error)

	// UpdateNetwork request  with any body
	UpdateNetworkWithBodyWithResponse(ctx context.Context, networkID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateNetworkResponse, error)

	UpdateNetworkWithResponse(ctx context.Context, networkID string, body UpdateNetworkJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateNetworkResponse, error)

	// GetNetworkMemberList request
	GetNetworkMemberListWithResponse(ctx context.Context, networkID string, reqEditors ...RequestEditorFn) (*GetNetworkMemberListResponse, error)

	// DeleteNetworkMember request
	DeleteNetworkMemberWithResponse(ctx context.Context, networkID string, memberID string, reqEditors ...RequestEditorFn) (*DeleteNetworkMemberResponse, error)

	// GetNetworkMember request
	GetNetworkMemberWithResponse(ctx context.Context, networkID string, memberID string, reqEditors ...RequestEditorFn) (*GetNetworkMemberResponse, error)

	// UpdateNetworkMember request  with any body
	UpdateNetworkMemberWithBodyWithResponse(ctx context.Context, networkID string, memberID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateNetworkMemberResponse, error)

	UpdateNetworkMemberWithResponse(ctx context.Context, networkID string, memberID string, body UpdateNetworkMemberJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateNetworkMemberResponse, error)

	// GetOrganization request
	GetOrganizationWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOrganizationResponse, error)

	// GetOrganizationInvitationList request
	GetOrganizationInvitationListWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOrganizationInvitationListResponse, error)

	// InviteUserByEmail request  with any body
	InviteUserByEmailWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InviteUserByEmailResponse, error)

	InviteUserByEmailWithResponse(ctx context.Context, body InviteUserByEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*InviteUserByEmailResponse, error)

	// DeclineInvitation request
	DeclineInvitationWithResponse(ctx context.Context, inviteID string, reqEditors ...RequestEditorFn) (*DeclineInvitationResponse, error)

	// GetInvitationByID request
	GetInvitationByIDWithResponse(ctx context.Context, inviteID string, reqEditors ...RequestEditorFn) (*GetInvitationByIDResponse, error)

	// AcceptInvitation request
	AcceptInvitationWithResponse(ctx context.Context, inviteID string, reqEditors ...RequestEditorFn) (*AcceptInvitationResponse, error)

	// GetOrganizationByID request
	GetOrganizationByIDWithResponse(ctx context.Context, orgID string, reqEditors ...RequestEditorFn) (*GetOrganizationByIDResponse, error)

	// GetOrganizationMembers request
	GetOrganizationMembersWithResponse(ctx context.Context, orgID string, reqEditors ...RequestEditorFn) (*GetOrganizationMembersResponse, error)

	// GetRandomToken request
	GetRandomTokenWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetRandomTokenResponse, error)

	// GetStatus request
	GetStatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetStatusResponse, error)

	// DeleteUserByID request
	DeleteUserByIDWithResponse(ctx context.Context, userID string, reqEditors ...RequestEditorFn) (*DeleteUserByIDResponse, error)

	// GetUserByID request
	GetUserByIDWithResponse(ctx context.Context, userID string, reqEditors ...RequestEditorFn) (*GetUserByIDResponse, error)

	// UpdateUserByID request  with any body
	UpdateUserByIDWithBodyWithResponse(ctx context.Context, userID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateUserByIDResponse, error)

	UpdateUserByIDWithResponse(ctx context.Context, userID string, body UpdateUserByIDJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateUserByIDResponse, error)

	// AddAPIToken request  with any body
	AddAPITokenWithBodyWithResponse(ctx context.Context, userID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddAPITokenResponse, error)

	AddAPITokenWithResponse(ctx context.Context, userID string, body AddAPITokenJSONRequestBody, reqEditors ...RequestEditorFn) (*AddAPITokenResponse, error)

	// DeleteAPIToken request
	DeleteAPITokenWithResponse(ctx context.Context, userID string, tokenName string, reqEditors ...RequestEditorFn) (*DeleteAPITokenResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type DNS added in v0.5.4

type DNS struct {

	// Search domain to use for DNS records
	Domain *string `json:"domain,omitempty"`

	// IP address of unicast DNS service
	Servers *[]string `json:"servers,omitempty"`
}

DNS defines model for DNS.

type DeclineInvitationResponse

type DeclineInvitationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDeclineInvitationResponse

func ParseDeclineInvitationResponse(rsp *http.Response) (*DeclineInvitationResponse, error)

ParseDeclineInvitationResponse parses an HTTP response from a DeclineInvitationWithResponse call

func (DeclineInvitationResponse) Status

func (r DeclineInvitationResponse) Status() string

Status returns HTTPResponse.Status

func (DeclineInvitationResponse) StatusCode

func (r DeclineInvitationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteAPITokenResponse

type DeleteAPITokenResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDeleteAPITokenResponse

func ParseDeleteAPITokenResponse(rsp *http.Response) (*DeleteAPITokenResponse, error)

ParseDeleteAPITokenResponse parses an HTTP response from a DeleteAPITokenWithResponse call

func (DeleteAPITokenResponse) Status

func (r DeleteAPITokenResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteAPITokenResponse) StatusCode

func (r DeleteAPITokenResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteNetworkMemberResponse

type DeleteNetworkMemberResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDeleteNetworkMemberResponse

func ParseDeleteNetworkMemberResponse(rsp *http.Response) (*DeleteNetworkMemberResponse, error)

ParseDeleteNetworkMemberResponse parses an HTTP response from a DeleteNetworkMemberWithResponse call

func (DeleteNetworkMemberResponse) Status

Status returns HTTPResponse.Status

func (DeleteNetworkMemberResponse) StatusCode

func (r DeleteNetworkMemberResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteNetworkResponse

type DeleteNetworkResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDeleteNetworkResponse

func ParseDeleteNetworkResponse(rsp *http.Response) (*DeleteNetworkResponse, error)

ParseDeleteNetworkResponse parses an HTTP response from a DeleteNetworkWithResponse call

func (DeleteNetworkResponse) Status

func (r DeleteNetworkResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteNetworkResponse) StatusCode

func (r DeleteNetworkResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteUserByIDResponse

type DeleteUserByIDResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDeleteUserByIDResponse

func ParseDeleteUserByIDResponse(rsp *http.Response) (*DeleteUserByIDResponse, error)

ParseDeleteUserByIDResponse parses an HTTP response from a DeleteUserByIDWithResponse call

func (DeleteUserByIDResponse) Status

func (r DeleteUserByIDResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteUserByIDResponse) StatusCode

func (r DeleteUserByIDResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInvitationByIDResponse

type GetInvitationByIDResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OrganizationInvitation
}

func ParseGetInvitationByIDResponse

func ParseGetInvitationByIDResponse(rsp *http.Response) (*GetInvitationByIDResponse, error)

ParseGetInvitationByIDResponse parses an HTTP response from a GetInvitationByIDWithResponse call

func (GetInvitationByIDResponse) Status

func (r GetInvitationByIDResponse) Status() string

Status returns HTTPResponse.Status

func (GetInvitationByIDResponse) StatusCode

func (r GetInvitationByIDResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetNetworkByIDResponse

type GetNetworkByIDResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Network
}

func ParseGetNetworkByIDResponse

func ParseGetNetworkByIDResponse(rsp *http.Response) (*GetNetworkByIDResponse, error)

ParseGetNetworkByIDResponse parses an HTTP response from a GetNetworkByIDWithResponse call

func (GetNetworkByIDResponse) Status

func (r GetNetworkByIDResponse) Status() string

Status returns HTTPResponse.Status

func (GetNetworkByIDResponse) StatusCode

func (r GetNetworkByIDResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetNetworkListResponse

type GetNetworkListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Network
}

func ParseGetNetworkListResponse

func ParseGetNetworkListResponse(rsp *http.Response) (*GetNetworkListResponse, error)

ParseGetNetworkListResponse parses an HTTP response from a GetNetworkListWithResponse call

func (GetNetworkListResponse) Status

func (r GetNetworkListResponse) Status() string

Status returns HTTPResponse.Status

func (GetNetworkListResponse) StatusCode

func (r GetNetworkListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetNetworkMemberListResponse

type GetNetworkMemberListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Member
}

func ParseGetNetworkMemberListResponse

func ParseGetNetworkMemberListResponse(rsp *http.Response) (*GetNetworkMemberListResponse, error)

ParseGetNetworkMemberListResponse parses an HTTP response from a GetNetworkMemberListWithResponse call

func (GetNetworkMemberListResponse) Status

Status returns HTTPResponse.Status

func (GetNetworkMemberListResponse) StatusCode

func (r GetNetworkMemberListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetNetworkMemberResponse

type GetNetworkMemberResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Member
}

func ParseGetNetworkMemberResponse

func ParseGetNetworkMemberResponse(rsp *http.Response) (*GetNetworkMemberResponse, error)

ParseGetNetworkMemberResponse parses an HTTP response from a GetNetworkMemberWithResponse call

func (GetNetworkMemberResponse) Status

func (r GetNetworkMemberResponse) Status() string

Status returns HTTPResponse.Status

func (GetNetworkMemberResponse) StatusCode

func (r GetNetworkMemberResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrganizationByIDResponse

type GetOrganizationByIDResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Organization
}

func ParseGetOrganizationByIDResponse

func ParseGetOrganizationByIDResponse(rsp *http.Response) (*GetOrganizationByIDResponse, error)

ParseGetOrganizationByIDResponse parses an HTTP response from a GetOrganizationByIDWithResponse call

func (GetOrganizationByIDResponse) Status

Status returns HTTPResponse.Status

func (GetOrganizationByIDResponse) StatusCode

func (r GetOrganizationByIDResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrganizationInvitationListResponse

type GetOrganizationInvitationListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]OrganizationInvitation
}

func ParseGetOrganizationInvitationListResponse

func ParseGetOrganizationInvitationListResponse(rsp *http.Response) (*GetOrganizationInvitationListResponse, error)

ParseGetOrganizationInvitationListResponse parses an HTTP response from a GetOrganizationInvitationListWithResponse call

func (GetOrganizationInvitationListResponse) Status

Status returns HTTPResponse.Status

func (GetOrganizationInvitationListResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetOrganizationMembersResponse

type GetOrganizationMembersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OrganizationMember
}

func ParseGetOrganizationMembersResponse

func ParseGetOrganizationMembersResponse(rsp *http.Response) (*GetOrganizationMembersResponse, error)

ParseGetOrganizationMembersResponse parses an HTTP response from a GetOrganizationMembersWithResponse call

func (GetOrganizationMembersResponse) Status

Status returns HTTPResponse.Status

func (GetOrganizationMembersResponse) StatusCode

func (r GetOrganizationMembersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrganizationResponse

type GetOrganizationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Organization
}

func ParseGetOrganizationResponse

func ParseGetOrganizationResponse(rsp *http.Response) (*GetOrganizationResponse, error)

ParseGetOrganizationResponse parses an HTTP response from a GetOrganizationWithResponse call

func (GetOrganizationResponse) Status

func (r GetOrganizationResponse) Status() string

Status returns HTTPResponse.Status

func (GetOrganizationResponse) StatusCode

func (r GetOrganizationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRandomTokenResponse

type GetRandomTokenResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *RandomToken
}

func ParseGetRandomTokenResponse

func ParseGetRandomTokenResponse(rsp *http.Response) (*GetRandomTokenResponse, error)

ParseGetRandomTokenResponse parses an HTTP response from a GetRandomTokenWithResponse call

func (GetRandomTokenResponse) Status

func (r GetRandomTokenResponse) Status() string

Status returns HTTPResponse.Status

func (GetRandomTokenResponse) StatusCode

func (r GetRandomTokenResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStatusResponse added in v0.5.0

type GetStatusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Status
}

func ParseGetStatusResponse added in v0.5.0

func ParseGetStatusResponse(rsp *http.Response) (*GetStatusResponse, error)

ParseGetStatusResponse parses an HTTP response from a GetStatusWithResponse call

func (GetStatusResponse) Status added in v0.5.0

func (r GetStatusResponse) Status() string

Status returns HTTPResponse.Status

func (GetStatusResponse) StatusCode added in v0.5.0

func (r GetStatusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetUserByIDResponse

type GetUserByIDResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *User
}

func ParseGetUserByIDResponse

func ParseGetUserByIDResponse(rsp *http.Response) (*GetUserByIDResponse, error)

ParseGetUserByIDResponse parses an HTTP response from a GetUserByIDWithResponse call

func (GetUserByIDResponse) Status

func (r GetUserByIDResponse) Status() string

Status returns HTTPResponse.Status

func (GetUserByIDResponse) StatusCode

func (r GetUserByIDResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type IPRange

type IPRange struct {
	IpRangeEnd   *string `json:"ipRangeEnd,omitempty"`
	IpRangeStart *string `json:"ipRangeStart,omitempty"`
}

IPRange defines model for IPRange.

type IPV4AssignMode

type IPV4AssignMode struct {
	Zt *bool `json:"zt,omitempty"`
}

IPV4AssignMode defines model for IPV4AssignMode.

type IPV6AssignMode

type IPV6AssignMode struct {
	N6plane *bool `json:"6plane,omitempty"`
	Rfc4193 *bool `json:"rfc4193,omitempty"`
	Zt      *bool `json:"zt,omitempty"`
}

IPV6AssignMode defines model for IPV6AssignMode.

type InviteStatus

type InviteStatus string

InviteStatus defines model for InviteStatus.

const (
	InviteStatusAccepted InviteStatus = "accepted"

	InviteStatusCanceled InviteStatus = "canceled"

	InviteStatusPending InviteStatus = "pending"
)

Defines values for InviteStatus.

type InviteUserByEmailJSONBody

type InviteUserByEmailJSONBody OrganizationInvitation

InviteUserByEmailJSONBody defines parameters for InviteUserByEmail.

type InviteUserByEmailJSONRequestBody

type InviteUserByEmailJSONRequestBody InviteUserByEmailJSONBody

InviteUserByEmailJSONRequestBody defines body for InviteUserByEmail for application/json ContentType.

type InviteUserByEmailResponse

type InviteUserByEmailResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OrganizationInvitation
}

func ParseInviteUserByEmailResponse

func ParseInviteUserByEmailResponse(rsp *http.Response) (*InviteUserByEmailResponse, error)

ParseInviteUserByEmailResponse parses an HTTP response from a InviteUserByEmailWithResponse call

func (InviteUserByEmailResponse) Status

func (r InviteUserByEmailResponse) Status() string

Status returns HTTPResponse.Status

func (InviteUserByEmailResponse) StatusCode

func (r InviteUserByEmailResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Member

type Member struct {

	// ZeroTier version the member is running
	ClientVersion *string       `json:"clientVersion,omitempty"`
	Clock         *int64        `json:"clock,omitempty"`
	Config        *MemberConfig `json:"config,omitempty"`
	ControllerId  *string       `json:"controllerId,omitempty"`

	// User defined description of the member
	Description *string `json:"description,omitempty"`

	// Whether or not the member is hidden in the UI
	Hidden *bool `json:"hidden,omitempty"`

	// concatenation of network ID and member ID
	Id *string `json:"id,omitempty"`

	// Last seen time of the member
	LastOnline *int64 `json:"lastOnline,omitempty"`

	// User defined name of the member
	Name      *string `json:"name,omitempty"`
	NetworkId *string `json:"networkId,omitempty"`

	// ZeroTier ID of the member
	NodeId *string `json:"nodeId,omitempty"`

	// IP address the member last spoke to the controller via
	PhysicalAddress *string `json:"physicalAddress,omitempty"`

	// ZeroTier protocol version
	ProtocolVersion *int `json:"protocolVersion,omitempty"`

	// Whether or not the client version is new enough to support the rules engine (1.4.0+)
	SupportsRulesEngine *bool `json:"supportsRulesEngine,omitempty"`
}

Member defines model for Member.

type MemberConfig

type MemberConfig struct {

	// Allow the member to be a bridge on the network
	ActiveBridge *bool `json:"activeBridge,omitempty"`

	// Is the member authorized on the network
	Authorized   *bool  `json:"authorized,omitempty"`
	Capabilities *[]int `json:"capabilities,omitempty"`

	// Time the member was created or first tried to join the network
	CreationTime *int64 `json:"creationTime,omitempty"`

	// ID of the member node.  This is the 10 digit identifier that identifies a ZeroTier node.
	Id *string `json:"id,omitempty"`

	// Public Key of the member's Identity
	Identity *string `json:"identity,omitempty"`

	// List of assigned IP addresses
	IpAssignments *[]string `json:"ipAssignments,omitempty"`

	// Time the member was authorized on the network
	LastAuthorizedTime *int64 `json:"lastAuthorizedTime,omitempty"`

	// Time the member was deauthorized on the network
	LastDeauthorizedTime *int64 `json:"lastDeauthorizedTime,omitempty"`

	// Exempt this member from the IP auto assignment pool on a Network
	NoAutoAssignIps *bool `json:"noAutoAssignIps,omitempty"`

	// Member record revision count
	Revision *int `json:"revision,omitempty"`

	// Array of 2 member tuples of tag [ID, tag value]
	Tags *[][]int `json:"tags,omitempty"`

	// Major version of the client
	VMajor *int `json:"vMajor,omitempty"`

	// Minor version of the client
	VMinor *int `json:"vMinor,omitempty"`

	// Protocol version of the client
	VProto *int `json:"vProto,omitempty"`

	// Revision number of the client
	VRev *int `json:"vRev,omitempty"`
}

MemberConfig defines model for MemberConfig.

type Network

type Network struct {
	AuthorizedMemberCount *int                    `json:"authorizedMemberCount,omitempty"`
	CapabilitiesByName    *map[string]interface{} `json:"capabilitiesByName,omitempty"`
	Clock                 *int64                  `json:"clock,omitempty"`
	Config                *NetworkConfig          `json:"config,omitempty"`
	Description           *string                 `json:"description,omitempty"`
	Id                    *string                 `json:"id,omitempty"`
	OnlineMemberCount     *int                    `json:"onlineMemberCount,omitempty"`
	OwnerId               *string                 `json:"ownerId,omitempty"`
	Permissions           *PermissionsMap         `json:"permissions,omitempty"`
	RulesSource           *string                 `json:"rulesSource,omitempty"`
	TagsByName            *map[string]interface{} `json:"tagsByName,omitempty"`
	TotalMemberCount      *int                    `json:"totalMemberCount,omitempty"`
}

Network object

type NetworkConfig

type NetworkConfig struct {

	// Array of network capabilities
	Capabilities *[]map[string]interface{} `json:"capabilities,omitempty"`

	// Time the network was created
	CreationTime *int64 `json:"creationTime,omitempty"`
	Dns          *DNS   `json:"dns,omitempty"`

	// Enable broadcast packets on the network
	EnableBroadcast *bool `json:"enableBroadcast,omitempty"`

	// Network ID
	Id *string `json:"id,omitempty"`

	// Range of IP addresses for the auto assign pool
	IpAssignmentPools *[]IPRange `json:"ipAssignmentPools,omitempty"`

	// Time the network was last modified
	LastModified *int64 `json:"lastModified,omitempty"`

	// MTU to set on the client virtual network adapter
	Mtu *int `json:"mtu,omitempty"`

	// Maximum number of recipients per multicast or broadcast. Warning - Setting this to 0 will disable IPv4 communication on your network!
	MulticastLimit *int    `json:"multicastLimit,omitempty"`
	Name           *string `json:"name,omitempty"`

	// Whether or not the network is private.  If false, members will *NOT* need to be authorized to join.
	Private      *bool                     `json:"private,omitempty"`
	Routes       *[]Route                  `json:"routes,omitempty"`
	Rules        *[]map[string]interface{} `json:"rules,omitempty"`
	Tags         *[]map[string]interface{} `json:"tags,omitempty"`
	V4AssignMode *IPV4AssignMode           `json:"v4AssignMode,omitempty"`
	V6AssignMode *IPV6AssignMode           `json:"v6AssignMode,omitempty"`
}

NetworkConfig defines model for NetworkConfig.

type NewNetworkJSONBody

type NewNetworkJSONBody map[string]interface{}

NewNetworkJSONBody defines parameters for NewNetwork.

type NewNetworkJSONRequestBody

type NewNetworkJSONRequestBody NewNetworkJSONBody

NewNetworkJSONRequestBody defines body for NewNetwork for application/json ContentType.

type NewNetworkResponse

type NewNetworkResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Network
}

func ParseNewNetworkResponse

func ParseNewNetworkResponse(rsp *http.Response) (*NewNetworkResponse, error)

ParseNewNetworkResponse parses an HTTP response from a NewNetworkWithResponse call

func (NewNetworkResponse) Status

func (r NewNetworkResponse) Status() string

Status returns HTTPResponse.Status

func (NewNetworkResponse) StatusCode

func (r NewNetworkResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Organization

type Organization struct {

	// Organization ID
	Id *string `json:"id,omitempty"`

	// List of organization members
	Members *[]OrganizationMember `json:"members,omitempty"`

	// Organization owner's email address
	OwnerEmail *string `json:"ownerEmail,omitempty"`

	// User ID of the organization owner
	OwnerId *string `json:"ownerId,omitempty"`
}

Organization defines model for Organization.

type OrganizationInvitation

type OrganizationInvitation struct {

	// Creation time of the invite
	CreationTime *int64 `json:"creation_time,omitempty"`

	// Email address of invitee
	Email *string `json:"email,omitempty"`

	// Invitation ID
	Id *string `json:"id,omitempty"`

	// Organization ID
	OrgId *string `json:"orgId,omitempty"`

	// Organization owner email address
	OwnerEmail *string `json:"ownerEmail,omitempty"`

	// Invitation status
	Status *struct {
		// Embedded struct due to allOf(#/components/schemas/InviteStatus)
		InviteStatus `yaml:",inline"`
	} `json:"status,omitempty"`

	// Last updated time of the invitation
	UpdateTime *int64 `json:"update_time,omitempty"`
}

OrganizationInvitation defines model for OrganizationInvitation.

type OrganizationMember

type OrganizationMember struct {

	// Organization member email address
	Email *string `json:"email"`

	// Organization member display name
	Name *string `json:"name"`

	// Organization ID
	OrgId *string `json:"orgId,omitempty"`

	// User ID
	UserId *string `json:"userId,omitempty"`
}

OrganizationMember defines model for OrganizationMember.

type Permissions

type Permissions struct {

	// Authorize permission
	A *bool `json:"a,omitempty"`

	// Delete permission
	D *bool `json:"d,omitempty"`

	// Modify network settings permission
	M *bool `json:"m,omitempty"`

	// Read network settings permission
	R *bool `json:"r,omitempty"`
}

Permissions defines model for Permissions.

type PermissionsMap

type PermissionsMap struct {
	AdditionalProperties map[string]Permissions `json:"-"`
}

PermissionsMap defines model for PermissionsMap.

func (PermissionsMap) Get

func (a PermissionsMap) Get(fieldName string) (value Permissions, found bool)

Getter for additional properties for PermissionsMap. Returns the specified element and whether it was found

func (PermissionsMap) MarshalJSON

func (a PermissionsMap) MarshalJSON() ([]byte, error)

Override default JSON handling for PermissionsMap to handle AdditionalProperties

func (*PermissionsMap) Set

func (a *PermissionsMap) Set(fieldName string, value Permissions)

Setter for additional properties for PermissionsMap

func (*PermissionsMap) UnmarshalJSON

func (a *PermissionsMap) UnmarshalJSON(b []byte) error

Override default JSON handling for PermissionsMap to handle AdditionalProperties

type RandomToken

type RandomToken struct {

	// Current time on server
	Clock *int64 `json:"clock,omitempty"`

	// hex encoded random bytes of the token
	Hex *string `json:"hex,omitempty"`

	// Random 32 character token
	Token *string `json:"token,omitempty"`
}

RandomToken defines model for RandomToken.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type Route

type Route struct {
	Target *string `json:"target,omitempty"`
	Via    *string `json:"via"`
}

Route defines model for Route.

type Status added in v0.5.0

type Status struct {
	ApiVersion *string `json:"apiVersion,omitempty"`

	// Current time on server
	Clock        *int64  `json:"clock,omitempty"`
	Id           *string `json:"id,omitempty"`
	LoginMethods *struct {
		Facebook *bool `json:"facebook,omitempty"`
		Github   *bool `json:"github,omitempty"`
		Google   *bool `json:"google,omitempty"`
		Local    *bool `json:"local,omitempty"`
		Oidc     *bool `json:"oidc,omitempty"`
		Saml     *bool `json:"saml,omitempty"`
		Twitter  *bool `json:"twitter,omitempty"`
	} `json:"loginMethods,omitempty"`
	ReadOnlyMode *bool   `json:"readOnlyMode,omitempty"`
	Type         *string `json:"type,omitempty"`

	// Uptime on server
	Uptime  *int64  `json:"uptime,omitempty"`
	User    *User   `json:"user,omitempty"`
	Version *string `json:"version,omitempty"`
}

Status defines model for Status.

type UpdateNetworkJSONBody

type UpdateNetworkJSONBody Network

UpdateNetworkJSONBody defines parameters for UpdateNetwork.

type UpdateNetworkJSONRequestBody

type UpdateNetworkJSONRequestBody UpdateNetworkJSONBody

UpdateNetworkJSONRequestBody defines body for UpdateNetwork for application/json ContentType.

type UpdateNetworkMemberJSONBody

type UpdateNetworkMemberJSONBody Member

UpdateNetworkMemberJSONBody defines parameters for UpdateNetworkMember.

type UpdateNetworkMemberJSONRequestBody

type UpdateNetworkMemberJSONRequestBody UpdateNetworkMemberJSONBody

UpdateNetworkMemberJSONRequestBody defines body for UpdateNetworkMember for application/json ContentType.

type UpdateNetworkMemberResponse

type UpdateNetworkMemberResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Member
}

func ParseUpdateNetworkMemberResponse

func ParseUpdateNetworkMemberResponse(rsp *http.Response) (*UpdateNetworkMemberResponse, error)

ParseUpdateNetworkMemberResponse parses an HTTP response from a UpdateNetworkMemberWithResponse call

func (UpdateNetworkMemberResponse) Status

Status returns HTTPResponse.Status

func (UpdateNetworkMemberResponse) StatusCode

func (r UpdateNetworkMemberResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateNetworkResponse

type UpdateNetworkResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Network
}

func ParseUpdateNetworkResponse

func ParseUpdateNetworkResponse(rsp *http.Response) (*UpdateNetworkResponse, error)

ParseUpdateNetworkResponse parses an HTTP response from a UpdateNetworkWithResponse call

func (UpdateNetworkResponse) Status

func (r UpdateNetworkResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateNetworkResponse) StatusCode

func (r UpdateNetworkResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateUserByIDJSONBody

type UpdateUserByIDJSONBody User

UpdateUserByIDJSONBody defines parameters for UpdateUserByID.

type UpdateUserByIDJSONRequestBody

type UpdateUserByIDJSONRequestBody UpdateUserByIDJSONBody

UpdateUserByIDJSONRequestBody defines body for UpdateUserByID for application/json ContentType.

type UpdateUserByIDResponse

type UpdateUserByIDResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *User
}

func ParseUpdateUserByIDResponse

func ParseUpdateUserByIDResponse(rsp *http.Response) (*UpdateUserByIDResponse, error)

ParseUpdateUserByIDResponse parses an HTTP response from a UpdateUserByIDWithResponse call

func (UpdateUserByIDResponse) Status

func (r UpdateUserByIDResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateUserByIDResponse) StatusCode

func (r UpdateUserByIDResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type User

type User struct {
	Auth *struct {
		// Embedded struct due to allOf(#/components/schemas/AuthMethods)
		AuthMethods `yaml:",inline"`
	} `json:"auth,omitempty"`

	// Display Name
	DisplayName *string `json:"displayName,omitempty"`

	// User email address
	Email             *string `json:"email,omitempty"`
	GlobalPermissions *struct {
		// Embedded struct due to allOf(#/components/schemas/Permissions)
		Permissions `yaml:",inline"`
	} `json:"globalPermissions,omitempty"`

	// User ID
	Id *string `json:"id,omitempty"`

	// Organization ID
	OrgId *string `json:"orgId,omitempty"`

	// SMS number
	SmsNumber *string `json:"smsNumber,omitempty"`

	// List of API token names.
	Tokens *[]string `json:"tokens,omitempty"`
}

User defines model for User.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL