authorityv1

package
v0.1.0-rc.39 Latest Latest
Warning

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

Go to latest
Published: Oct 3, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Handler

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux

func HandlerFromMux(si ServerInterface, m ServeMux) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL

func HandlerFromMuxWithBaseURL(si ServerInterface, m ServeMux, baseURL string) http.Handler

func HandlerWithOptions

func HandlerWithOptions(si ServerInterface, options StdHTTPServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

func NewAcceptInvitationRequest

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

NewAcceptInvitationRequest calls the generic AcceptInvitation builder with application/json body

func NewAcceptInvitationRequestWithBody

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

NewAcceptInvitationRequestWithBody constructs an http.Request for the AcceptInvitation method, with any body, and a specified content type

func NewAuthorizeServiceOperationRequest

func NewAuthorizeServiceOperationRequest(server string, body AuthorizeServiceOperationJSONRequestBody) (*http.Request, error)

NewAuthorizeServiceOperationRequest calls the generic AuthorizeServiceOperation builder with application/json body

func NewAuthorizeServiceOperationRequestWithBody

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

NewAuthorizeServiceOperationRequestWithBody constructs an http.Request for the AuthorizeServiceOperation method, with any body, and a specified content type

func NewClaimTeamDomainRequest

func NewClaimTeamDomainRequest(server string, teamId TeamID, params *ClaimTeamDomainParams, body ClaimTeamDomainJSONRequestBody) (*http.Request, error)

NewClaimTeamDomainRequest calls the generic ClaimTeamDomain builder with application/json body

func NewClaimTeamDomainRequestWithBody

func NewClaimTeamDomainRequestWithBody(server string, teamId TeamID, params *ClaimTeamDomainParams, contentType string, body io.Reader) (*http.Request, error)

NewClaimTeamDomainRequestWithBody constructs an http.Request for the ClaimTeamDomain method, with any body, and a specified content type

func NewCreateTeamInvitationRequest

func NewCreateTeamInvitationRequest(server string, teamId TeamID, params *CreateTeamInvitationParams, body CreateTeamInvitationJSONRequestBody) (*http.Request, error)

NewCreateTeamInvitationRequest calls the generic CreateTeamInvitation builder with application/json body

func NewCreateTeamInvitationRequestWithBody

func NewCreateTeamInvitationRequestWithBody(server string, teamId TeamID, params *CreateTeamInvitationParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateTeamInvitationRequestWithBody constructs an http.Request for the CreateTeamInvitation method, with any body, and a specified content type

func NewCreateTeamRequest

func NewCreateTeamRequest(server string, params *CreateTeamParams, body CreateTeamJSONRequestBody) (*http.Request, error)

NewCreateTeamRequest calls the generic CreateTeam builder with application/json body

func NewCreateTeamRequestWithBody

func NewCreateTeamRequestWithBody(server string, params *CreateTeamParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateTeamRequestWithBody constructs an http.Request for the CreateTeam method, with any body, and a specified content type

func NewExchangeLoginTokenRequest

func NewExchangeLoginTokenRequest(server string, body ExchangeLoginTokenJSONRequestBody) (*http.Request, error)

NewExchangeLoginTokenRequest calls the generic ExchangeLoginToken builder with application/json body

func NewExchangeLoginTokenRequestWithBody

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

NewExchangeLoginTokenRequestWithBody constructs an http.Request for the ExchangeLoginToken method, with any body, and a specified content type

func NewExchangeOIDCTokenRequest

func NewExchangeOIDCTokenRequest(server string, body ExchangeOIDCTokenJSONRequestBody) (*http.Request, error)

NewExchangeOIDCTokenRequest calls the generic ExchangeOIDCToken builder with application/json body

func NewExchangeOIDCTokenRequestWithBody

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

NewExchangeOIDCTokenRequestWithBody constructs an http.Request for the ExchangeOIDCToken method, with any body, and a specified content type

func NewGetIdentityContextRequest

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

NewGetIdentityContextRequest constructs an http.Request for the GetIdentityContext method

func NewGetTeamRequest

func NewGetTeamRequest(server string, teamId TeamID) (*http.Request, error)

NewGetTeamRequest constructs an http.Request for the GetTeam method

func NewListTeamDomainsRequest

func NewListTeamDomainsRequest(server string, teamId TeamID) (*http.Request, error)

NewListTeamDomainsRequest constructs an http.Request for the ListTeamDomains method

func NewListTeamInvitationsRequest

func NewListTeamInvitationsRequest(server string, teamId TeamID) (*http.Request, error)

NewListTeamInvitationsRequest constructs an http.Request for the ListTeamInvitations method

func NewListTeamMembershipsRequest

func NewListTeamMembershipsRequest(server string, teamId TeamID) (*http.Request, error)

NewListTeamMembershipsRequest constructs an http.Request for the ListTeamMemberships method

func NewListTeamsRequest

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

NewListTeamsRequest constructs an http.Request for the ListTeams method

func NewLogoutControlSessionRequest

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

NewLogoutControlSessionRequest constructs an http.Request for the LogoutControlSession method

func NewRefreshControlSessionRequest

func NewRefreshControlSessionRequest(server string, body RefreshControlSessionJSONRequestBody) (*http.Request, error)

NewRefreshControlSessionRequest calls the generic RefreshControlSession builder with application/json body

func NewRefreshControlSessionRequestWithBody

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

NewRefreshControlSessionRequestWithBody constructs an http.Request for the RefreshControlSession method, with any body, and a specified content type

func NewReleaseTeamDomainRequest

func NewReleaseTeamDomainRequest(server string, teamId TeamID, domainId DomainID) (*http.Request, error)

NewReleaseTeamDomainRequest constructs an http.Request for the ReleaseTeamDomain method

func NewRemoveMembershipRequest

func NewRemoveMembershipRequest(server string, teamId TeamID, membershipId MembershipID) (*http.Request, error)

NewRemoveMembershipRequest constructs an http.Request for the RemoveMembership method

func NewRevokeTeamInvitationRequest

func NewRevokeTeamInvitationRequest(server string, teamId TeamID, invitationId InvitationID) (*http.Request, error)

NewRevokeTeamInvitationRequest constructs an http.Request for the RevokeTeamInvitation method

func NewSetMembershipRoleRequest

func NewSetMembershipRoleRequest(server string, teamId TeamID, membershipId MembershipID, body SetMembershipRoleJSONRequestBody) (*http.Request, error)

NewSetMembershipRoleRequest calls the generic SetMembershipRole builder with application/json body

func NewSetMembershipRoleRequestWithBody

func NewSetMembershipRoleRequestWithBody(server string, teamId TeamID, membershipId MembershipID, contentType string, body io.Reader) (*http.Request, error)

NewSetMembershipRoleRequestWithBody constructs an http.Request for the SetMembershipRole method, with any body, and a specified content type

func NewSetTeamDefaultDomainRequest

func NewSetTeamDefaultDomainRequest(server string, teamId TeamID, domainId DomainID) (*http.Request, error)

NewSetTeamDefaultDomainRequest constructs an http.Request for the SetTeamDefaultDomain method

Types

type AcceptInvitationJSONRequestBody

type AcceptInvitationJSONRequestBody = AcceptInvitationRequest

AcceptInvitationJSONRequestBody defines body for AcceptInvitation for application/json ContentType.

type AcceptInvitationRequest

type AcceptInvitationRequest struct {
	Secret string `json:"secret"`
}

AcceptInvitationRequest defines model for AcceptInvitationRequest.

type AcceptInvitationResponse

type AcceptInvitationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Membership
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseAcceptInvitationResponse

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

ParseAcceptInvitationResponse parses an HTTP response from a AcceptInvitationWithResponse call

func (AcceptInvitationResponse) ContentType

func (r AcceptInvitationResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AcceptInvitationResponse) GetApplicationproblemJSONDefault

func (r AcceptInvitationResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (AcceptInvitationResponse) GetBody

func (r AcceptInvitationResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (AcceptInvitationResponse) GetJSON200

func (r AcceptInvitationResponse) GetJSON200() *Membership

GetJSON200 returns the response for an HTTP 200 `application/json` response

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 AuthorizationOperation

type AuthorizationOperation string

AuthorizationOperation defines model for AuthorizationOperation.

const (
	PublicUrlCreate  AuthorizationOperation = "public_url.create"
	PublicUrlDelete  AuthorizationOperation = "public_url.delete"
	PublicUrlUpdate  AuthorizationOperation = "public_url.update"
	PublishRunCreate AuthorizationOperation = "publish_run.create"
)

Defines values for AuthorizationOperation.

func (AuthorizationOperation) Valid

func (e AuthorizationOperation) Valid() bool

Valid indicates whether the value is a known member of the AuthorizationOperation enum.

type AuthorizeServiceOperationJSONRequestBody

type AuthorizeServiceOperationJSONRequestBody = ServiceAuthorizationRequest

AuthorizeServiceOperationJSONRequestBody defines body for AuthorizeServiceOperation for application/json ContentType.

type AuthorizeServiceOperationResponse

type AuthorizeServiceOperationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ServiceAuthorizationDecision
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseAuthorizeServiceOperationResponse

func ParseAuthorizeServiceOperationResponse(rsp *http.Response) (*AuthorizeServiceOperationResponse, error)

ParseAuthorizeServiceOperationResponse parses an HTTP response from a AuthorizeServiceOperationWithResponse call

func (AuthorizeServiceOperationResponse) ContentType

func (r AuthorizeServiceOperationResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (AuthorizeServiceOperationResponse) GetApplicationproblemJSONDefault

func (r AuthorizeServiceOperationResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (AuthorizeServiceOperationResponse) GetBody

GetBody returns the raw response body bytes

func (AuthorizeServiceOperationResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (AuthorizeServiceOperationResponse) Status

Status returns HTTPResponse.Status

func (AuthorizeServiceOperationResponse) StatusCode

func (r AuthorizeServiceOperationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BearerProblem

type BearerProblem = Problem

BearerProblem defines model for BearerProblem.

type CanonicalHostname

type CanonicalHostname = string

CanonicalHostname defines model for CanonicalHostname.

type CanonicalLabel

type CanonicalLabel = string

CanonicalLabel defines model for CanonicalLabel.

type CertificateChallengeMethod

type CertificateChallengeMethod string

CertificateChallengeMethod defines model for CertificateChallengeMethod.

const (
	Dns01     CertificateChallengeMethod = "dns-01"
	TlsAlpn01 CertificateChallengeMethod = "tls-alpn-01"
)

Defines values for CertificateChallengeMethod.

func (CertificateChallengeMethod) Valid

func (e CertificateChallengeMethod) Valid() bool

Valid indicates whether the value is a known member of the CertificateChallengeMethod enum.

type CertificatePlan

type CertificatePlan struct {
	CacheKey        string                     `json:"cache_key"`
	ChallengeMethod CertificateChallengeMethod `json:"challenge_method"`
	Identifiers     []string                   `json:"identifiers"`
	Scope           string                     `json:"scope"`
}

CertificatePlan defines model for CertificatePlan.

type ClaimDomainRequest

type ClaimDomainRequest struct {
	Domain      CanonicalHostname `json:"domain"`
	MakeDefault *bool             `json:"make_default,omitempty"`
}

ClaimDomainRequest defines model for ClaimDomainRequest.

type ClaimTeamDomainJSONRequestBody

type ClaimTeamDomainJSONRequestBody = ClaimDomainRequest

ClaimTeamDomainJSONRequestBody defines body for ClaimTeamDomain for application/json ContentType.

type ClaimTeamDomainParams

type ClaimTeamDomainParams struct {
	IdempotencyKey IdempotencyKey `json:"Idempotency-Key"`
}

ClaimTeamDomainParams defines parameters for ClaimTeamDomain.

type ClaimTeamDomainResponse

type ClaimTeamDomainResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *Domain
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseClaimTeamDomainResponse

func ParseClaimTeamDomainResponse(rsp *http.Response) (*ClaimTeamDomainResponse, error)

ParseClaimTeamDomainResponse parses an HTTP response from a ClaimTeamDomainWithResponse call

func (ClaimTeamDomainResponse) ContentType

func (r ClaimTeamDomainResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ClaimTeamDomainResponse) GetApplicationproblemJSONDefault

func (r ClaimTeamDomainResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ClaimTeamDomainResponse) GetBody

func (r ClaimTeamDomainResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ClaimTeamDomainResponse) GetJSON201

func (r ClaimTeamDomainResponse) GetJSON201() *Domain

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (ClaimTeamDomainResponse) Status

func (r ClaimTeamDomainResponse) Status() string

Status returns HTTPResponse.Status

func (ClaimTeamDomainResponse) StatusCode

func (r ClaimTeamDomainResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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, body AcceptInvitationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

AcceptInvitation Accept an invitation with its secret

Takes a body of the `application/json` content type.

Corresponds with POST /v1/invitations/accept (the `AcceptInvitation` operationId).

func (*Client) AcceptInvitationWithBody

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

AcceptInvitationWithBody Accept an invitation with its secret

Takes any type of body and a specified content type.

Corresponds with POST /v1/invitations/accept (the `AcceptInvitation` operationId).

func (*Client) AuthorizeServiceOperation

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

AuthorizeServiceOperation Authorize a control operation using current authority state

Takes a body of the `application/json` content type.

Corresponds with POST /v1/service/authorize (the `AuthorizeServiceOperation` operationId).

func (*Client) AuthorizeServiceOperationWithBody

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

AuthorizeServiceOperationWithBody Authorize a control operation using current authority state

Takes any type of body and a specified content type.

Corresponds with POST /v1/service/authorize (the `AuthorizeServiceOperation` operationId).

func (*Client) ClaimTeamDomain

func (c *Client) ClaimTeamDomain(ctx context.Context, teamId TeamID, params *ClaimTeamDomainParams, body ClaimTeamDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ClaimTeamDomain Begin claiming one domain

Takes a body of the `application/json` content type.

Corresponds with POST /v1/teams/{team_id}/domains (the `ClaimTeamDomain` operationId).

func (*Client) ClaimTeamDomainWithBody

func (c *Client) ClaimTeamDomainWithBody(ctx context.Context, teamId TeamID, params *ClaimTeamDomainParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ClaimTeamDomainWithBody Begin claiming one domain

Takes any type of body and a specified content type.

Corresponds with POST /v1/teams/{team_id}/domains (the `ClaimTeamDomain` operationId).

func (*Client) CreateTeam

func (c *Client) CreateTeam(ctx context.Context, params *CreateTeamParams, body CreateTeamJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateTeam Create an organization team

Takes a body of the `application/json` content type.

Corresponds with POST /v1/teams (the `CreateTeam` operationId).

func (*Client) CreateTeamInvitation

func (c *Client) CreateTeamInvitation(ctx context.Context, teamId TeamID, params *CreateTeamInvitationParams, body CreateTeamInvitationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateTeamInvitation Create an expiring invitation

Takes a body of the `application/json` content type.

Corresponds with POST /v1/teams/{team_id}/invitations (the `CreateTeamInvitation` operationId).

func (*Client) CreateTeamInvitationWithBody

func (c *Client) CreateTeamInvitationWithBody(ctx context.Context, teamId TeamID, params *CreateTeamInvitationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateTeamInvitationWithBody Create an expiring invitation

Takes any type of body and a specified content type.

Corresponds with POST /v1/teams/{team_id}/invitations (the `CreateTeamInvitation` operationId).

func (*Client) CreateTeamWithBody

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

CreateTeamWithBody Create an organization team

Takes any type of body and a specified content type.

Corresponds with POST /v1/teams (the `CreateTeam` operationId).

func (*Client) ExchangeLoginToken

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

ExchangeLoginToken Exchange a login token for a control session

Takes a body of the `application/json` content type.

Corresponds with POST /v1/auth/token (the `ExchangeLoginToken` operationId).

func (*Client) ExchangeLoginTokenWithBody

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

ExchangeLoginTokenWithBody Exchange a login token for a control session

Takes any type of body and a specified content type.

Corresponds with POST /v1/auth/token (the `ExchangeLoginToken` operationId).

func (*Client) ExchangeOIDCToken

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

ExchangeOIDCToken Exchange an OIDC ID token for a control session

Takes a body of the `application/json` content type.

Corresponds with POST /v1/auth/oidc (the `ExchangeOIDCToken` operationId).

func (*Client) ExchangeOIDCTokenWithBody

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

ExchangeOIDCTokenWithBody Exchange an OIDC ID token for a control session

Takes any type of body and a specified content type.

Corresponds with POST /v1/auth/oidc (the `ExchangeOIDCToken` operationId).

func (*Client) GetIdentityContext

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

GetIdentityContext Read the authenticated identity and memberships

Corresponds with GET /v1/identity (the `GetIdentityContext` operationId).

func (*Client) GetTeam

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

GetTeam Read one team

Corresponds with GET /v1/teams/{team_id} (the `GetTeam` operationId).

func (*Client) ListTeamDomains

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

ListTeamDomains List domains available to the team

Corresponds with GET /v1/teams/{team_id}/domains (the `ListTeamDomains` operationId).

func (*Client) ListTeamInvitations

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

ListTeamInvitations List team invitations

Corresponds with GET /v1/teams/{team_id}/invitations (the `ListTeamInvitations` operationId).

func (*Client) ListTeamMemberships

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

ListTeamMemberships List team memberships

Corresponds with GET /v1/teams/{team_id}/memberships (the `ListTeamMemberships` operationId).

func (*Client) ListTeams

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

ListTeams List teams for the authenticated identity

Corresponds with GET /v1/teams (the `ListTeams` operationId).

func (*Client) LogoutControlSession

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

LogoutControlSession Revoke the authenticated control session

Corresponds with POST /v1/auth/logout (the `LogoutControlSession` operationId).

func (*Client) RefreshControlSession

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

RefreshControlSession Rotate a control session's access and refresh tokens

Takes a body of the `application/json` content type.

Corresponds with POST /v1/auth/refresh (the `RefreshControlSession` operationId).

func (*Client) RefreshControlSessionWithBody

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

RefreshControlSessionWithBody Rotate a control session's access and refresh tokens

Takes any type of body and a specified content type.

Corresponds with POST /v1/auth/refresh (the `RefreshControlSession` operationId).

func (*Client) ReleaseTeamDomain

func (c *Client) ReleaseTeamDomain(ctx context.Context, teamId TeamID, domainId DomainID, reqEditors ...RequestEditorFn) (*http.Response, error)

ReleaseTeamDomain Release one claimed domain

Corresponds with DELETE /v1/teams/{team_id}/domains/{domain_id} (the `ReleaseTeamDomain` operationId).

func (*Client) RemoveMembership

func (c *Client) RemoveMembership(ctx context.Context, teamId TeamID, membershipId MembershipID, reqEditors ...RequestEditorFn) (*http.Response, error)

RemoveMembership Remove one membership

Corresponds with DELETE /v1/teams/{team_id}/memberships/{membership_id} (the `RemoveMembership` operationId).

func (*Client) RevokeTeamInvitation

func (c *Client) RevokeTeamInvitation(ctx context.Context, teamId TeamID, invitationId InvitationID, reqEditors ...RequestEditorFn) (*http.Response, error)

RevokeTeamInvitation Revoke one pending invitation

Corresponds with DELETE /v1/teams/{team_id}/invitations/{invitation_id} (the `RevokeTeamInvitation` operationId).

func (*Client) SetMembershipRole

func (c *Client) SetMembershipRole(ctx context.Context, teamId TeamID, membershipId MembershipID, body SetMembershipRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SetMembershipRole Change one membership's team role

Takes a body of the `application/json` content type.

Corresponds with PATCH /v1/teams/{team_id}/memberships/{membership_id} (the `SetMembershipRole` operationId).

func (*Client) SetMembershipRoleWithBody

func (c *Client) SetMembershipRoleWithBody(ctx context.Context, teamId TeamID, membershipId MembershipID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SetMembershipRoleWithBody Change one membership's team role

Takes any type of body and a specified content type.

Corresponds with PATCH /v1/teams/{team_id}/memberships/{membership_id} (the `SetMembershipRole` operationId).

func (*Client) SetTeamDefaultDomain

func (c *Client) SetTeamDefaultDomain(ctx context.Context, teamId TeamID, domainId DomainID, reqEditors ...RequestEditorFn) (*http.Response, error)

SetTeamDefaultDomain Select a ready default domain

Corresponds with POST /v1/teams/{team_id}/domains/{domain_id}/default (the `SetTeamDefaultDomain` operationId).

type ClientInterface

type ClientInterface interface {

	// LogoutControlSession Revoke the authenticated control session
	//
	// Corresponds with POST /v1/auth/logout (the `LogoutControlSession` operationId).
	LogoutControlSession(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExchangeOIDCTokenWithBody Exchange an OIDC ID token for a control session
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/auth/oidc (the `ExchangeOIDCToken` operationId).
	ExchangeOIDCTokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExchangeOIDCToken Exchange an OIDC ID token for a control session
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/auth/oidc (the `ExchangeOIDCToken` operationId).
	ExchangeOIDCToken(ctx context.Context, body ExchangeOIDCTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RefreshControlSessionWithBody Rotate a control session's access and refresh tokens
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/auth/refresh (the `RefreshControlSession` operationId).
	RefreshControlSessionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RefreshControlSession Rotate a control session's access and refresh tokens
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/auth/refresh (the `RefreshControlSession` operationId).
	RefreshControlSession(ctx context.Context, body RefreshControlSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExchangeLoginTokenWithBody Exchange a login token for a control session
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/auth/token (the `ExchangeLoginToken` operationId).
	ExchangeLoginTokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExchangeLoginToken Exchange a login token for a control session
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/auth/token (the `ExchangeLoginToken` operationId).
	ExchangeLoginToken(ctx context.Context, body ExchangeLoginTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIdentityContext Read the authenticated identity and memberships
	//
	// Corresponds with GET /v1/identity (the `GetIdentityContext` operationId).
	GetIdentityContext(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AcceptInvitationWithBody Accept an invitation with its secret
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/invitations/accept (the `AcceptInvitation` operationId).
	AcceptInvitationWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AcceptInvitation Accept an invitation with its secret
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/invitations/accept (the `AcceptInvitation` operationId).
	AcceptInvitation(ctx context.Context, body AcceptInvitationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AuthorizeServiceOperationWithBody Authorize a control operation using current authority state
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/service/authorize (the `AuthorizeServiceOperation` operationId).
	AuthorizeServiceOperationWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AuthorizeServiceOperation Authorize a control operation using current authority state
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/service/authorize (the `AuthorizeServiceOperation` operationId).
	AuthorizeServiceOperation(ctx context.Context, body AuthorizeServiceOperationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListTeams List teams for the authenticated identity
	//
	// Corresponds with GET /v1/teams (the `ListTeams` operationId).
	ListTeams(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateTeamWithBody Create an organization team
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/teams (the `CreateTeam` operationId).
	CreateTeamWithBody(ctx context.Context, params *CreateTeamParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateTeam Create an organization team
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/teams (the `CreateTeam` operationId).
	CreateTeam(ctx context.Context, params *CreateTeamParams, body CreateTeamJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTeam Read one team
	//
	// Corresponds with GET /v1/teams/{team_id} (the `GetTeam` operationId).
	GetTeam(ctx context.Context, teamId TeamID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListTeamDomains List domains available to the team
	//
	// Corresponds with GET /v1/teams/{team_id}/domains (the `ListTeamDomains` operationId).
	ListTeamDomains(ctx context.Context, teamId TeamID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ClaimTeamDomainWithBody Begin claiming one domain
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/teams/{team_id}/domains (the `ClaimTeamDomain` operationId).
	ClaimTeamDomainWithBody(ctx context.Context, teamId TeamID, params *ClaimTeamDomainParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ClaimTeamDomain Begin claiming one domain
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/teams/{team_id}/domains (the `ClaimTeamDomain` operationId).
	ClaimTeamDomain(ctx context.Context, teamId TeamID, params *ClaimTeamDomainParams, body ClaimTeamDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReleaseTeamDomain Release one claimed domain
	//
	// Corresponds with DELETE /v1/teams/{team_id}/domains/{domain_id} (the `ReleaseTeamDomain` operationId).
	ReleaseTeamDomain(ctx context.Context, teamId TeamID, domainId DomainID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetTeamDefaultDomain Select a ready default domain
	//
	// Corresponds with POST /v1/teams/{team_id}/domains/{domain_id}/default (the `SetTeamDefaultDomain` operationId).
	SetTeamDefaultDomain(ctx context.Context, teamId TeamID, domainId DomainID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListTeamInvitations List team invitations
	//
	// Corresponds with GET /v1/teams/{team_id}/invitations (the `ListTeamInvitations` operationId).
	ListTeamInvitations(ctx context.Context, teamId TeamID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateTeamInvitationWithBody Create an expiring invitation
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/teams/{team_id}/invitations (the `CreateTeamInvitation` operationId).
	CreateTeamInvitationWithBody(ctx context.Context, teamId TeamID, params *CreateTeamInvitationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateTeamInvitation Create an expiring invitation
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/teams/{team_id}/invitations (the `CreateTeamInvitation` operationId).
	CreateTeamInvitation(ctx context.Context, teamId TeamID, params *CreateTeamInvitationParams, body CreateTeamInvitationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RevokeTeamInvitation Revoke one pending invitation
	//
	// Corresponds with DELETE /v1/teams/{team_id}/invitations/{invitation_id} (the `RevokeTeamInvitation` operationId).
	RevokeTeamInvitation(ctx context.Context, teamId TeamID, invitationId InvitationID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListTeamMemberships List team memberships
	//
	// Corresponds with GET /v1/teams/{team_id}/memberships (the `ListTeamMemberships` operationId).
	ListTeamMemberships(ctx context.Context, teamId TeamID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RemoveMembership Remove one membership
	//
	// Corresponds with DELETE /v1/teams/{team_id}/memberships/{membership_id} (the `RemoveMembership` operationId).
	RemoveMembership(ctx context.Context, teamId TeamID, membershipId MembershipID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetMembershipRoleWithBody Change one membership's team role
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /v1/teams/{team_id}/memberships/{membership_id} (the `SetMembershipRole` operationId).
	SetMembershipRoleWithBody(ctx context.Context, teamId TeamID, membershipId MembershipID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetMembershipRole Change one membership's team role
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /v1/teams/{team_id}/memberships/{membership_id} (the `SetMembershipRole` operationId).
	SetMembershipRole(ctx context.Context, teamId TeamID, membershipId MembershipID, body SetMembershipRoleJSONRequestBody, 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) AcceptInvitationWithBodyWithResponse

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

AcceptInvitationWithBodyWithResponse Accept an invitation with its secret

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/invitations/accept (the `AcceptInvitation` operationId).

func (*ClientWithResponses) AcceptInvitationWithResponse

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

AcceptInvitationWithResponse Accept an invitation with its secret

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/invitations/accept (the `AcceptInvitation` operationId).

func (*ClientWithResponses) AuthorizeServiceOperationWithBodyWithResponse

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

AuthorizeServiceOperationWithBodyWithResponse Authorize a control operation using current authority state

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/service/authorize (the `AuthorizeServiceOperation` operationId).

func (*ClientWithResponses) AuthorizeServiceOperationWithResponse

func (c *ClientWithResponses) AuthorizeServiceOperationWithResponse(ctx context.Context, body AuthorizeServiceOperationJSONRequestBody, reqEditors ...RequestEditorFn) (*AuthorizeServiceOperationResponse, error)

AuthorizeServiceOperationWithResponse Authorize a control operation using current authority state

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/service/authorize (the `AuthorizeServiceOperation` operationId).

func (*ClientWithResponses) ClaimTeamDomainWithBodyWithResponse

func (c *ClientWithResponses) ClaimTeamDomainWithBodyWithResponse(ctx context.Context, teamId TeamID, params *ClaimTeamDomainParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ClaimTeamDomainResponse, error)

ClaimTeamDomainWithBodyWithResponse Begin claiming one domain

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/teams/{team_id}/domains (the `ClaimTeamDomain` operationId).

func (*ClientWithResponses) ClaimTeamDomainWithResponse

func (c *ClientWithResponses) ClaimTeamDomainWithResponse(ctx context.Context, teamId TeamID, params *ClaimTeamDomainParams, body ClaimTeamDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*ClaimTeamDomainResponse, error)

ClaimTeamDomainWithResponse Begin claiming one domain

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/teams/{team_id}/domains (the `ClaimTeamDomain` operationId).

func (*ClientWithResponses) CreateTeamInvitationWithBodyWithResponse

func (c *ClientWithResponses) CreateTeamInvitationWithBodyWithResponse(ctx context.Context, teamId TeamID, params *CreateTeamInvitationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTeamInvitationResponse, error)

CreateTeamInvitationWithBodyWithResponse Create an expiring invitation

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/teams/{team_id}/invitations (the `CreateTeamInvitation` operationId).

func (*ClientWithResponses) CreateTeamInvitationWithResponse

func (c *ClientWithResponses) CreateTeamInvitationWithResponse(ctx context.Context, teamId TeamID, params *CreateTeamInvitationParams, body CreateTeamInvitationJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTeamInvitationResponse, error)

CreateTeamInvitationWithResponse Create an expiring invitation

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/teams/{team_id}/invitations (the `CreateTeamInvitation` operationId).

func (*ClientWithResponses) CreateTeamWithBodyWithResponse

func (c *ClientWithResponses) CreateTeamWithBodyWithResponse(ctx context.Context, params *CreateTeamParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTeamResponse, error)

CreateTeamWithBodyWithResponse Create an organization team

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/teams (the `CreateTeam` operationId).

func (*ClientWithResponses) CreateTeamWithResponse

func (c *ClientWithResponses) CreateTeamWithResponse(ctx context.Context, params *CreateTeamParams, body CreateTeamJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTeamResponse, error)

CreateTeamWithResponse Create an organization team

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/teams (the `CreateTeam` operationId).

func (*ClientWithResponses) ExchangeLoginTokenWithBodyWithResponse

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

ExchangeLoginTokenWithBodyWithResponse Exchange a login token for a control session

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/auth/token (the `ExchangeLoginToken` operationId).

func (*ClientWithResponses) ExchangeLoginTokenWithResponse

func (c *ClientWithResponses) ExchangeLoginTokenWithResponse(ctx context.Context, body ExchangeLoginTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*ExchangeLoginTokenResponse, error)

ExchangeLoginTokenWithResponse Exchange a login token for a control session

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/auth/token (the `ExchangeLoginToken` operationId).

func (*ClientWithResponses) ExchangeOIDCTokenWithBodyWithResponse

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

ExchangeOIDCTokenWithBodyWithResponse Exchange an OIDC ID token for a control session

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/auth/oidc (the `ExchangeOIDCToken` operationId).

func (*ClientWithResponses) ExchangeOIDCTokenWithResponse

func (c *ClientWithResponses) ExchangeOIDCTokenWithResponse(ctx context.Context, body ExchangeOIDCTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*ExchangeOIDCTokenResponse, error)

ExchangeOIDCTokenWithResponse Exchange an OIDC ID token for a control session

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/auth/oidc (the `ExchangeOIDCToken` operationId).

func (*ClientWithResponses) GetIdentityContextWithResponse

func (c *ClientWithResponses) GetIdentityContextWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetIdentityContextResponse, error)

GetIdentityContextWithResponse Read the authenticated identity and memberships

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/identity (the `GetIdentityContext` operationId).

func (*ClientWithResponses) GetTeamWithResponse

func (c *ClientWithResponses) GetTeamWithResponse(ctx context.Context, teamId TeamID, reqEditors ...RequestEditorFn) (*GetTeamResponse, error)

GetTeamWithResponse Read one team

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/teams/{team_id} (the `GetTeam` operationId).

func (*ClientWithResponses) ListTeamDomainsWithResponse

func (c *ClientWithResponses) ListTeamDomainsWithResponse(ctx context.Context, teamId TeamID, reqEditors ...RequestEditorFn) (*ListTeamDomainsResponse, error)

ListTeamDomainsWithResponse List domains available to the team

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/teams/{team_id}/domains (the `ListTeamDomains` operationId).

func (*ClientWithResponses) ListTeamInvitationsWithResponse

func (c *ClientWithResponses) ListTeamInvitationsWithResponse(ctx context.Context, teamId TeamID, reqEditors ...RequestEditorFn) (*ListTeamInvitationsResponse, error)

ListTeamInvitationsWithResponse List team invitations

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/teams/{team_id}/invitations (the `ListTeamInvitations` operationId).

func (*ClientWithResponses) ListTeamMembershipsWithResponse

func (c *ClientWithResponses) ListTeamMembershipsWithResponse(ctx context.Context, teamId TeamID, reqEditors ...RequestEditorFn) (*ListTeamMembershipsResponse, error)

ListTeamMembershipsWithResponse List team memberships

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/teams/{team_id}/memberships (the `ListTeamMemberships` operationId).

func (*ClientWithResponses) ListTeamsWithResponse

func (c *ClientWithResponses) ListTeamsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListTeamsResponse, error)

ListTeamsWithResponse List teams for the authenticated identity

Returns a wrapper object for the known response body format(s).

Corresponds with GET /v1/teams (the `ListTeams` operationId).

func (*ClientWithResponses) LogoutControlSessionWithResponse

func (c *ClientWithResponses) LogoutControlSessionWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*LogoutControlSessionResponse, error)

LogoutControlSessionWithResponse Revoke the authenticated control session

Returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/auth/logout (the `LogoutControlSession` operationId).

func (*ClientWithResponses) RefreshControlSessionWithBodyWithResponse

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

RefreshControlSessionWithBodyWithResponse Rotate a control session's access and refresh tokens

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/auth/refresh (the `RefreshControlSession` operationId).

func (*ClientWithResponses) RefreshControlSessionWithResponse

func (c *ClientWithResponses) RefreshControlSessionWithResponse(ctx context.Context, body RefreshControlSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*RefreshControlSessionResponse, error)

RefreshControlSessionWithResponse Rotate a control session's access and refresh tokens

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/auth/refresh (the `RefreshControlSession` operationId).

func (*ClientWithResponses) ReleaseTeamDomainWithResponse

func (c *ClientWithResponses) ReleaseTeamDomainWithResponse(ctx context.Context, teamId TeamID, domainId DomainID, reqEditors ...RequestEditorFn) (*ReleaseTeamDomainResponse, error)

ReleaseTeamDomainWithResponse Release one claimed domain

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /v1/teams/{team_id}/domains/{domain_id} (the `ReleaseTeamDomain` operationId).

func (*ClientWithResponses) RemoveMembershipWithResponse

func (c *ClientWithResponses) RemoveMembershipWithResponse(ctx context.Context, teamId TeamID, membershipId MembershipID, reqEditors ...RequestEditorFn) (*RemoveMembershipResponse, error)

RemoveMembershipWithResponse Remove one membership

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /v1/teams/{team_id}/memberships/{membership_id} (the `RemoveMembership` operationId).

func (*ClientWithResponses) RevokeTeamInvitationWithResponse

func (c *ClientWithResponses) RevokeTeamInvitationWithResponse(ctx context.Context, teamId TeamID, invitationId InvitationID, reqEditors ...RequestEditorFn) (*RevokeTeamInvitationResponse, error)

RevokeTeamInvitationWithResponse Revoke one pending invitation

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /v1/teams/{team_id}/invitations/{invitation_id} (the `RevokeTeamInvitation` operationId).

func (*ClientWithResponses) SetMembershipRoleWithBodyWithResponse

func (c *ClientWithResponses) SetMembershipRoleWithBodyWithResponse(ctx context.Context, teamId TeamID, membershipId MembershipID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetMembershipRoleResponse, error)

SetMembershipRoleWithBodyWithResponse Change one membership's team role

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /v1/teams/{team_id}/memberships/{membership_id} (the `SetMembershipRole` operationId).

func (*ClientWithResponses) SetMembershipRoleWithResponse

func (c *ClientWithResponses) SetMembershipRoleWithResponse(ctx context.Context, teamId TeamID, membershipId MembershipID, body SetMembershipRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*SetMembershipRoleResponse, error)

SetMembershipRoleWithResponse Change one membership's team role

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /v1/teams/{team_id}/memberships/{membership_id} (the `SetMembershipRole` operationId).

func (*ClientWithResponses) SetTeamDefaultDomainWithResponse

func (c *ClientWithResponses) SetTeamDefaultDomainWithResponse(ctx context.Context, teamId TeamID, domainId DomainID, reqEditors ...RequestEditorFn) (*SetTeamDefaultDomainResponse, error)

SetTeamDefaultDomainWithResponse Select a ready default domain

Returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/teams/{team_id}/domains/{domain_id}/default (the `SetTeamDefaultDomain` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// LogoutControlSessionWithResponse Revoke the authenticated control session
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/auth/logout (the `LogoutControlSession` operationId).
	LogoutControlSessionWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*LogoutControlSessionResponse, error)

	// ExchangeOIDCTokenWithBodyWithResponse Exchange an OIDC ID token for a control session
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/auth/oidc (the `ExchangeOIDCToken` operationId).
	ExchangeOIDCTokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExchangeOIDCTokenResponse, error)

	// ExchangeOIDCTokenWithResponse Exchange an OIDC ID token for a control session
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/auth/oidc (the `ExchangeOIDCToken` operationId).
	ExchangeOIDCTokenWithResponse(ctx context.Context, body ExchangeOIDCTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*ExchangeOIDCTokenResponse, error)

	// RefreshControlSessionWithBodyWithResponse Rotate a control session's access and refresh tokens
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/auth/refresh (the `RefreshControlSession` operationId).
	RefreshControlSessionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RefreshControlSessionResponse, error)

	// RefreshControlSessionWithResponse Rotate a control session's access and refresh tokens
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/auth/refresh (the `RefreshControlSession` operationId).
	RefreshControlSessionWithResponse(ctx context.Context, body RefreshControlSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*RefreshControlSessionResponse, error)

	// ExchangeLoginTokenWithBodyWithResponse Exchange a login token for a control session
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/auth/token (the `ExchangeLoginToken` operationId).
	ExchangeLoginTokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExchangeLoginTokenResponse, error)

	// ExchangeLoginTokenWithResponse Exchange a login token for a control session
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/auth/token (the `ExchangeLoginToken` operationId).
	ExchangeLoginTokenWithResponse(ctx context.Context, body ExchangeLoginTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*ExchangeLoginTokenResponse, error)

	// GetIdentityContextWithResponse Read the authenticated identity and memberships
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/identity (the `GetIdentityContext` operationId).
	GetIdentityContextWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetIdentityContextResponse, error)

	// AcceptInvitationWithBodyWithResponse Accept an invitation with its secret
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/invitations/accept (the `AcceptInvitation` operationId).
	AcceptInvitationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AcceptInvitationResponse, error)

	// AcceptInvitationWithResponse Accept an invitation with its secret
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/invitations/accept (the `AcceptInvitation` operationId).
	AcceptInvitationWithResponse(ctx context.Context, body AcceptInvitationJSONRequestBody, reqEditors ...RequestEditorFn) (*AcceptInvitationResponse, error)

	// AuthorizeServiceOperationWithBodyWithResponse Authorize a control operation using current authority state
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/service/authorize (the `AuthorizeServiceOperation` operationId).
	AuthorizeServiceOperationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AuthorizeServiceOperationResponse, error)

	// AuthorizeServiceOperationWithResponse Authorize a control operation using current authority state
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/service/authorize (the `AuthorizeServiceOperation` operationId).
	AuthorizeServiceOperationWithResponse(ctx context.Context, body AuthorizeServiceOperationJSONRequestBody, reqEditors ...RequestEditorFn) (*AuthorizeServiceOperationResponse, error)

	// ListTeamsWithResponse List teams for the authenticated identity
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/teams (the `ListTeams` operationId).
	ListTeamsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListTeamsResponse, error)

	// CreateTeamWithBodyWithResponse Create an organization team
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/teams (the `CreateTeam` operationId).
	CreateTeamWithBodyWithResponse(ctx context.Context, params *CreateTeamParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTeamResponse, error)

	// CreateTeamWithResponse Create an organization team
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/teams (the `CreateTeam` operationId).
	CreateTeamWithResponse(ctx context.Context, params *CreateTeamParams, body CreateTeamJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTeamResponse, error)

	// GetTeamWithResponse Read one team
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/teams/{team_id} (the `GetTeam` operationId).
	GetTeamWithResponse(ctx context.Context, teamId TeamID, reqEditors ...RequestEditorFn) (*GetTeamResponse, error)

	// ListTeamDomainsWithResponse List domains available to the team
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/teams/{team_id}/domains (the `ListTeamDomains` operationId).
	ListTeamDomainsWithResponse(ctx context.Context, teamId TeamID, reqEditors ...RequestEditorFn) (*ListTeamDomainsResponse, error)

	// ClaimTeamDomainWithBodyWithResponse Begin claiming one domain
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/teams/{team_id}/domains (the `ClaimTeamDomain` operationId).
	ClaimTeamDomainWithBodyWithResponse(ctx context.Context, teamId TeamID, params *ClaimTeamDomainParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ClaimTeamDomainResponse, error)

	// ClaimTeamDomainWithResponse Begin claiming one domain
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/teams/{team_id}/domains (the `ClaimTeamDomain` operationId).
	ClaimTeamDomainWithResponse(ctx context.Context, teamId TeamID, params *ClaimTeamDomainParams, body ClaimTeamDomainJSONRequestBody, reqEditors ...RequestEditorFn) (*ClaimTeamDomainResponse, error)

	// ReleaseTeamDomainWithResponse Release one claimed domain
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /v1/teams/{team_id}/domains/{domain_id} (the `ReleaseTeamDomain` operationId).
	ReleaseTeamDomainWithResponse(ctx context.Context, teamId TeamID, domainId DomainID, reqEditors ...RequestEditorFn) (*ReleaseTeamDomainResponse, error)

	// SetTeamDefaultDomainWithResponse Select a ready default domain
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/teams/{team_id}/domains/{domain_id}/default (the `SetTeamDefaultDomain` operationId).
	SetTeamDefaultDomainWithResponse(ctx context.Context, teamId TeamID, domainId DomainID, reqEditors ...RequestEditorFn) (*SetTeamDefaultDomainResponse, error)

	// ListTeamInvitationsWithResponse List team invitations
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/teams/{team_id}/invitations (the `ListTeamInvitations` operationId).
	ListTeamInvitationsWithResponse(ctx context.Context, teamId TeamID, reqEditors ...RequestEditorFn) (*ListTeamInvitationsResponse, error)

	// CreateTeamInvitationWithBodyWithResponse Create an expiring invitation
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/teams/{team_id}/invitations (the `CreateTeamInvitation` operationId).
	CreateTeamInvitationWithBodyWithResponse(ctx context.Context, teamId TeamID, params *CreateTeamInvitationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTeamInvitationResponse, error)

	// CreateTeamInvitationWithResponse Create an expiring invitation
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/teams/{team_id}/invitations (the `CreateTeamInvitation` operationId).
	CreateTeamInvitationWithResponse(ctx context.Context, teamId TeamID, params *CreateTeamInvitationParams, body CreateTeamInvitationJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTeamInvitationResponse, error)

	// RevokeTeamInvitationWithResponse Revoke one pending invitation
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /v1/teams/{team_id}/invitations/{invitation_id} (the `RevokeTeamInvitation` operationId).
	RevokeTeamInvitationWithResponse(ctx context.Context, teamId TeamID, invitationId InvitationID, reqEditors ...RequestEditorFn) (*RevokeTeamInvitationResponse, error)

	// ListTeamMembershipsWithResponse List team memberships
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/teams/{team_id}/memberships (the `ListTeamMemberships` operationId).
	ListTeamMembershipsWithResponse(ctx context.Context, teamId TeamID, reqEditors ...RequestEditorFn) (*ListTeamMembershipsResponse, error)

	// RemoveMembershipWithResponse Remove one membership
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /v1/teams/{team_id}/memberships/{membership_id} (the `RemoveMembership` operationId).
	RemoveMembershipWithResponse(ctx context.Context, teamId TeamID, membershipId MembershipID, reqEditors ...RequestEditorFn) (*RemoveMembershipResponse, error)

	// SetMembershipRoleWithBodyWithResponse Change one membership's team role
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /v1/teams/{team_id}/memberships/{membership_id} (the `SetMembershipRole` operationId).
	SetMembershipRoleWithBodyWithResponse(ctx context.Context, teamId TeamID, membershipId MembershipID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetMembershipRoleResponse, error)

	// SetMembershipRoleWithResponse Change one membership's team role
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /v1/teams/{team_id}/memberships/{membership_id} (the `SetMembershipRole` operationId).
	SetMembershipRoleWithResponse(ctx context.Context, teamId TeamID, membershipId MembershipID, body SetMembershipRoleJSONRequestBody, reqEditors ...RequestEditorFn) (*SetMembershipRoleResponse, error)
}

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

type ControlSessionResponse

type ControlSessionResponse struct {
	AccessExpiresAt  time.Time       `json:"access_expires_at"`
	AccessToken      string          `json:"access_token"`
	Identity         IdentityContext `json:"identity"`
	RefreshExpiresAt time.Time       `json:"refresh_expires_at"`
	RefreshToken     string          `json:"refresh_token"`
	SessionId        ResourceID      `json:"session_id"`
}

ControlSessionResponse defines model for ControlSessionResponse.

type CreateInvitationRequest

type CreateInvitationRequest struct {
	EmailRestriction *openapi_types.Email `json:"email_restriction,omitempty"`
	ExpiresAt        time.Time            `json:"expires_at"`
	InitialRole      TeamRole             `json:"initial_role"`
	MemberSlug       CanonicalLabel       `json:"member_slug"`
}

CreateInvitationRequest defines model for CreateInvitationRequest.

type CreateTeamInvitationJSONRequestBody

type CreateTeamInvitationJSONRequestBody = CreateInvitationRequest

CreateTeamInvitationJSONRequestBody defines body for CreateTeamInvitation for application/json ContentType.

type CreateTeamInvitationParams

type CreateTeamInvitationParams struct {
	IdempotencyKey IdempotencyKey `json:"Idempotency-Key"`
}

CreateTeamInvitationParams defines parameters for CreateTeamInvitation.

type CreateTeamInvitationResponse

type CreateTeamInvitationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *InvitationSecret
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseCreateTeamInvitationResponse

func ParseCreateTeamInvitationResponse(rsp *http.Response) (*CreateTeamInvitationResponse, error)

ParseCreateTeamInvitationResponse parses an HTTP response from a CreateTeamInvitationWithResponse call

func (CreateTeamInvitationResponse) ContentType

func (r CreateTeamInvitationResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateTeamInvitationResponse) GetApplicationproblemJSONDefault

func (r CreateTeamInvitationResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (CreateTeamInvitationResponse) GetBody

func (r CreateTeamInvitationResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateTeamInvitationResponse) GetJSON201

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateTeamInvitationResponse) Status

Status returns HTTPResponse.Status

func (CreateTeamInvitationResponse) StatusCode

func (r CreateTeamInvitationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateTeamJSONRequestBody

type CreateTeamJSONRequestBody = CreateTeamRequest

CreateTeamJSONRequestBody defines body for CreateTeam for application/json ContentType.

type CreateTeamParams

type CreateTeamParams struct {
	IdempotencyKey IdempotencyKey `json:"Idempotency-Key"`
}

CreateTeamParams defines parameters for CreateTeam.

type CreateTeamRequest

type CreateTeamRequest struct {
	DisplayName CanonicalLabel  `json:"display_name"`
	MemberSlug  *CanonicalLabel `json:"member_slug,omitempty"`
}

CreateTeamRequest defines model for CreateTeamRequest.

type CreateTeamResponse

type CreateTeamResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *Team
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseCreateTeamResponse

func ParseCreateTeamResponse(rsp *http.Response) (*CreateTeamResponse, error)

ParseCreateTeamResponse parses an HTTP response from a CreateTeamWithResponse call

func (CreateTeamResponse) ContentType

func (r CreateTeamResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateTeamResponse) GetApplicationproblemJSONDefault

func (r CreateTeamResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (CreateTeamResponse) GetBody

func (r CreateTeamResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateTeamResponse) GetJSON201

func (r CreateTeamResponse) GetJSON201() *Team

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateTeamResponse) Status

func (r CreateTeamResponse) Status() string

Status returns HTTPResponse.Status

func (CreateTeamResponse) StatusCode

func (r CreateTeamResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DNSRecord

type DNSRecord struct {
	Name  CanonicalHostname `json:"name"`
	Type  DNSRecordType     `json:"type"`
	Value string            `json:"value"`
}

DNSRecord defines model for DNSRecord.

type DNSRecordType

type DNSRecordType string

DNSRecordType defines model for DNSRecord.Type.

const (
	A     DNSRecordType = "A"
	AAAA  DNSRecordType = "AAAA"
	CNAME DNSRecordType = "CNAME"
	NS    DNSRecordType = "NS"
	TXT   DNSRecordType = "TXT"
)

Defines values for DNSRecordType.

func (DNSRecordType) Valid

func (e DNSRecordType) Valid() bool

Valid indicates whether the value is a known member of the DNSRecordType enum.

type Domain

type Domain struct {
	AuthorityRevision int64             `json:"authority_revision"`
	CanonicalDomain   CanonicalHostname `json:"canonical_domain"`
	CreatedAt         time.Time         `json:"created_at"`
	Id                DomainID          `json:"id"`
	Kind              DomainKind        `json:"kind"`
	RequiredRecords   []DNSRecord       `json:"required_records"`
	State             DomainState       `json:"state"`
	TeamId            *TeamID           `json:"team_id,omitempty"`
	UpdatedAt         time.Time         `json:"updated_at"`
	VerifiedAt        *time.Time        `json:"verified_at,omitempty"`
}

Domain defines model for Domain.

type DomainID

type DomainID = ResourceID

DomainID defines model for DomainID.

type DomainKind

type DomainKind string

DomainKind defines model for DomainKind.

const (
	Claimed DomainKind = "claimed"
	Managed DomainKind = "managed"
)

Defines values for DomainKind.

func (DomainKind) Valid

func (e DomainKind) Valid() bool

Valid indicates whether the value is a known member of the DomainKind enum.

type DomainPage

type DomainPage struct {
	Domains    []Domain  `json:"domains"`
	NextCursor *DomainID `json:"next_cursor,omitempty"`
}

DomainPage defines model for DomainPage.

type DomainState

type DomainState string

DomainState defines model for DomainState.

const (
	DomainStateFailed    DomainState = "failed"
	DomainStatePending   DomainState = "pending"
	DomainStateReady     DomainState = "ready"
	DomainStateReleasing DomainState = "releasing"
)

Defines values for DomainState.

func (DomainState) Valid

func (e DomainState) Valid() bool

Valid indicates whether the value is a known member of the DomainState enum.

type ExchangeLoginTokenJSONRequestBody

type ExchangeLoginTokenJSONRequestBody = LoginTokenExchangeRequest

ExchangeLoginTokenJSONRequestBody defines body for ExchangeLoginToken for application/json ContentType.

type ExchangeLoginTokenResponse

type ExchangeLoginTokenResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ControlSessionResponse
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseExchangeLoginTokenResponse

func ParseExchangeLoginTokenResponse(rsp *http.Response) (*ExchangeLoginTokenResponse, error)

ParseExchangeLoginTokenResponse parses an HTTP response from a ExchangeLoginTokenWithResponse call

func (ExchangeLoginTokenResponse) ContentType

func (r ExchangeLoginTokenResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ExchangeLoginTokenResponse) GetApplicationproblemJSONDefault

func (r ExchangeLoginTokenResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ExchangeLoginTokenResponse) GetBody

func (r ExchangeLoginTokenResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ExchangeLoginTokenResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ExchangeLoginTokenResponse) Status

Status returns HTTPResponse.Status

func (ExchangeLoginTokenResponse) StatusCode

func (r ExchangeLoginTokenResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ExchangeOIDCTokenJSONRequestBody

type ExchangeOIDCTokenJSONRequestBody = OIDCTokenExchangeRequest

ExchangeOIDCTokenJSONRequestBody defines body for ExchangeOIDCToken for application/json ContentType.

type ExchangeOIDCTokenResponse

type ExchangeOIDCTokenResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ControlSessionResponse
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseExchangeOIDCTokenResponse

func ParseExchangeOIDCTokenResponse(rsp *http.Response) (*ExchangeOIDCTokenResponse, error)

ParseExchangeOIDCTokenResponse parses an HTTP response from a ExchangeOIDCTokenWithResponse call

func (ExchangeOIDCTokenResponse) ContentType

func (r ExchangeOIDCTokenResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ExchangeOIDCTokenResponse) GetApplicationproblemJSONDefault

func (r ExchangeOIDCTokenResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ExchangeOIDCTokenResponse) GetBody

func (r ExchangeOIDCTokenResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ExchangeOIDCTokenResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ExchangeOIDCTokenResponse) Status

func (r ExchangeOIDCTokenResponse) Status() string

Status returns HTTPResponse.Status

func (ExchangeOIDCTokenResponse) StatusCode

func (r ExchangeOIDCTokenResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIdentityContextResponse

type GetIdentityContextResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *IdentityContext
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *BearerProblem
	// HeadersDefault the parsed response headers for an HTTP default response
	HeadersDefault *GetIdentityContextResponseDefaultHeaders
}

func ParseGetIdentityContextResponse

func ParseGetIdentityContextResponse(rsp *http.Response) (*GetIdentityContextResponse, error)

ParseGetIdentityContextResponse parses an HTTP response from a GetIdentityContextWithResponse call

func (GetIdentityContextResponse) ContentType

func (r GetIdentityContextResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetIdentityContextResponse) GetApplicationproblemJSONDefault

func (r GetIdentityContextResponse) GetApplicationproblemJSONDefault() *BearerProblem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (GetIdentityContextResponse) GetBody

func (r GetIdentityContextResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetIdentityContextResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetIdentityContextResponse) Status

Status returns HTTPResponse.Status

func (GetIdentityContextResponse) StatusCode

func (r GetIdentityContextResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetIdentityContextResponseDefaultHeaders

type GetIdentityContextResponseDefaultHeaders struct {
	WWWAuthenticate string
}

GetIdentityContextResponseDefaultHeaders the declared response headers of an HTTP default response for GetIdentityContext

type GetTeamResponse

type GetTeamResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Team
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseGetTeamResponse

func ParseGetTeamResponse(rsp *http.Response) (*GetTeamResponse, error)

ParseGetTeamResponse parses an HTTP response from a GetTeamWithResponse call

func (GetTeamResponse) ContentType

func (r GetTeamResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetTeamResponse) GetApplicationproblemJSONDefault

func (r GetTeamResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (GetTeamResponse) GetBody

func (r GetTeamResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetTeamResponse) GetJSON200

func (r GetTeamResponse) GetJSON200() *Team

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetTeamResponse) Status

func (r GetTeamResponse) Status() string

Status returns HTTPResponse.Status

func (GetTeamResponse) StatusCode

func (r GetTeamResponse) 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 IdempotencyKey

type IdempotencyKey = string

IdempotencyKey defines model for IdempotencyKey.

type Identity

type Identity struct {
	Administrator   bool                 `json:"administrator"`
	CreatedAt       time.Time            `json:"created_at"`
	DisplayName     string               `json:"display_name"`
	EmailVerified   *bool                `json:"email_verified,omitempty"`
	Id              IdentityID           `json:"id"`
	NormalizedEmail *openapi_types.Email `json:"normalized_email,omitempty"`
}

Identity defines model for Identity.

type IdentityContext

type IdentityContext struct {
	Identity       Identity     `json:"identity"`
	Memberships    []Membership `json:"memberships"`
	PersonalTeamId TeamID       `json:"personal_team_id"`
}

IdentityContext defines model for IdentityContext.

type IdentityID

type IdentityID = ResourceID

IdentityID defines model for IdentityID.

type InvalidParamFormatError

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap

func (e *InvalidParamFormatError) Unwrap() error

type Invitation

type Invitation struct {
	CreatedAt                  time.Time            `json:"created_at"`
	ExpiresAt                  time.Time            `json:"expires_at"`
	Id                         InvitationID         `json:"id"`
	InitialRole                TeamRole             `json:"initial_role"`
	MemberSlug                 CanonicalLabel       `json:"member_slug"`
	NormalizedEmailRestriction *openapi_types.Email `json:"normalized_email_restriction,omitempty"`
	State                      InvitationState      `json:"state"`
	TeamId                     TeamID               `json:"team_id"`
}

Invitation defines model for Invitation.

type InvitationID

type InvitationID = ResourceID

InvitationID defines model for InvitationID.

type InvitationPage

type InvitationPage struct {
	Invitations []Invitation  `json:"invitations"`
	NextCursor  *InvitationID `json:"next_cursor,omitempty"`
}

InvitationPage defines model for InvitationPage.

type InvitationSecret

type InvitationSecret struct {
	Invitation Invitation `json:"invitation"`
	Secret     string     `json:"secret"`
}

InvitationSecret defines model for InvitationSecret.

type InvitationState

type InvitationState string

InvitationState defines model for InvitationState.

const (
	InvitationStateAccepted InvitationState = "accepted"
	InvitationStateExpired  InvitationState = "expired"
	InvitationStatePending  InvitationState = "pending"
	InvitationStateRevoked  InvitationState = "revoked"
)

Defines values for InvitationState.

func (InvitationState) Valid

func (e InvitationState) Valid() bool

Valid indicates whether the value is a known member of the InvitationState enum.

type ListTeamDomainsResponse

type ListTeamDomainsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *DomainPage
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseListTeamDomainsResponse

func ParseListTeamDomainsResponse(rsp *http.Response) (*ListTeamDomainsResponse, error)

ParseListTeamDomainsResponse parses an HTTP response from a ListTeamDomainsWithResponse call

func (ListTeamDomainsResponse) ContentType

func (r ListTeamDomainsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListTeamDomainsResponse) GetApplicationproblemJSONDefault

func (r ListTeamDomainsResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ListTeamDomainsResponse) GetBody

func (r ListTeamDomainsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListTeamDomainsResponse) GetJSON200

func (r ListTeamDomainsResponse) GetJSON200() *DomainPage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListTeamDomainsResponse) Status

func (r ListTeamDomainsResponse) Status() string

Status returns HTTPResponse.Status

func (ListTeamDomainsResponse) StatusCode

func (r ListTeamDomainsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListTeamInvitationsResponse

type ListTeamInvitationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *InvitationPage
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseListTeamInvitationsResponse

func ParseListTeamInvitationsResponse(rsp *http.Response) (*ListTeamInvitationsResponse, error)

ParseListTeamInvitationsResponse parses an HTTP response from a ListTeamInvitationsWithResponse call

func (ListTeamInvitationsResponse) ContentType

func (r ListTeamInvitationsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListTeamInvitationsResponse) GetApplicationproblemJSONDefault

func (r ListTeamInvitationsResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ListTeamInvitationsResponse) GetBody

func (r ListTeamInvitationsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListTeamInvitationsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListTeamInvitationsResponse) Status

Status returns HTTPResponse.Status

func (ListTeamInvitationsResponse) StatusCode

func (r ListTeamInvitationsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListTeamMembershipsResponse

type ListTeamMembershipsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *MembershipPage
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseListTeamMembershipsResponse

func ParseListTeamMembershipsResponse(rsp *http.Response) (*ListTeamMembershipsResponse, error)

ParseListTeamMembershipsResponse parses an HTTP response from a ListTeamMembershipsWithResponse call

func (ListTeamMembershipsResponse) ContentType

func (r ListTeamMembershipsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListTeamMembershipsResponse) GetApplicationproblemJSONDefault

func (r ListTeamMembershipsResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ListTeamMembershipsResponse) GetBody

func (r ListTeamMembershipsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListTeamMembershipsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListTeamMembershipsResponse) Status

Status returns HTTPResponse.Status

func (ListTeamMembershipsResponse) StatusCode

func (r ListTeamMembershipsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListTeamsResponse

type ListTeamsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *TeamPage
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *BearerProblem
	// HeadersDefault the parsed response headers for an HTTP default response
	HeadersDefault *ListTeamsResponseDefaultHeaders
}

func ParseListTeamsResponse

func ParseListTeamsResponse(rsp *http.Response) (*ListTeamsResponse, error)

ParseListTeamsResponse parses an HTTP response from a ListTeamsWithResponse call

func (ListTeamsResponse) ContentType

func (r ListTeamsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListTeamsResponse) GetApplicationproblemJSONDefault

func (r ListTeamsResponse) GetApplicationproblemJSONDefault() *BearerProblem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ListTeamsResponse) GetBody

func (r ListTeamsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListTeamsResponse) GetJSON200

func (r ListTeamsResponse) GetJSON200() *TeamPage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListTeamsResponse) Status

func (r ListTeamsResponse) Status() string

Status returns HTTPResponse.Status

func (ListTeamsResponse) StatusCode

func (r ListTeamsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListTeamsResponseDefaultHeaders

type ListTeamsResponseDefaultHeaders struct {
	WWWAuthenticate string
}

ListTeamsResponseDefaultHeaders the declared response headers of an HTTP default response for ListTeams

type LoginTokenExchangeRequest

type LoginTokenExchangeRequest struct {
	LoginToken string `json:"login_token"`
}

LoginTokenExchangeRequest defines model for LoginTokenExchangeRequest.

type LogoutControlSessionResponse

type LogoutControlSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *BearerProblem
	// HeadersDefault the parsed response headers for an HTTP default response
	HeadersDefault *LogoutControlSessionResponseDefaultHeaders
}

func ParseLogoutControlSessionResponse

func ParseLogoutControlSessionResponse(rsp *http.Response) (*LogoutControlSessionResponse, error)

ParseLogoutControlSessionResponse parses an HTTP response from a LogoutControlSessionWithResponse call

func (LogoutControlSessionResponse) ContentType

func (r LogoutControlSessionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (LogoutControlSessionResponse) GetApplicationproblemJSONDefault

func (r LogoutControlSessionResponse) GetApplicationproblemJSONDefault() *BearerProblem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (LogoutControlSessionResponse) GetBody

func (r LogoutControlSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (LogoutControlSessionResponse) Status

Status returns HTTPResponse.Status

func (LogoutControlSessionResponse) StatusCode

func (r LogoutControlSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type LogoutControlSessionResponseDefaultHeaders

type LogoutControlSessionResponseDefaultHeaders struct {
	WWWAuthenticate string
}

LogoutControlSessionResponseDefaultHeaders the declared response headers of an HTTP default response for LogoutControlSession

type Membership

type Membership struct {
	CreatedAt       time.Time      `json:"created_at"`
	Id              MembershipID   `json:"id"`
	IdentityId      IdentityID     `json:"identity_id"`
	ManagedLabel    CanonicalLabel `json:"managed_label"`
	MemberSlug      CanonicalLabel `json:"member_slug"`
	PolicyRevision  int64          `json:"policy_revision"`
	Role            TeamRole       `json:"role"`
	TeamDisplayName CanonicalLabel `json:"team_display_name"`
	TeamId          TeamID         `json:"team_id"`
	TeamKind        TeamKind       `json:"team_kind"`
	UpdatedAt       time.Time      `json:"updated_at"`
}

Membership defines model for Membership.

type MembershipID

type MembershipID = ResourceID

MembershipID defines model for MembershipID.

type MembershipPage

type MembershipPage struct {
	Memberships []Membership  `json:"memberships"`
	NextCursor  *MembershipID `json:"next_cursor,omitempty"`
}

MembershipPage defines model for MembershipPage.

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

type OIDCTokenExchangeRequest

type OIDCTokenExchangeRequest struct {
	IdToken string `json:"id_token"`
}

OIDCTokenExchangeRequest defines model for OIDCTokenExchangeRequest.

type Problem

type Problem struct {
	Code      ProblemCode             `json:"code"`
	Detail    *string                 `json:"detail,omitempty"`
	Details   *map[string]interface{} `json:"details,omitempty"`
	RequestId string                  `json:"request_id"`
	RetryAt   *time.Time              `json:"retry_at,omitempty"`
	Status    int                     `json:"status"`
	Title     string                  `json:"title"`
	Type      string                  `json:"type"`
}

Problem defines model for Problem.

type ProblemCode

type ProblemCode string

ProblemCode defines model for Problem.Code.

const (
	Conflict            ProblemCode = "conflict"
	DnsSetupPending     ProblemCode = "dns_setup_pending"
	Forbidden           ProblemCode = "forbidden"
	Internal            ProblemCode = "internal"
	InvalidRequest      ProblemCode = "invalid_request"
	NameUnavailable     ProblemCode = "name_unavailable"
	NotFound            ProblemCode = "not_found"
	PolicyRevisionStale ProblemCode = "policy_revision_stale"
	RateLimited         ProblemCode = "rate_limited"
	Unauthenticated     ProblemCode = "unauthenticated"
	Unavailable         ProblemCode = "unavailable"
)

Defines values for ProblemCode.

func (ProblemCode) Valid

func (e ProblemCode) Valid() bool

Valid indicates whether the value is a known member of the ProblemCode enum.

type PublicURLID

type PublicURLID = ResourceID

PublicURLID defines model for PublicURLID.

type PublicURLScope

type PublicURLScope string

PublicURLScope defines model for PublicURLScope.

const (
	PublicURLScopeMember PublicURLScope = "member"
	PublicURLScopeShared PublicURLScope = "shared"
)

Defines values for PublicURLScope.

func (PublicURLScope) Valid

func (e PublicURLScope) Valid() bool

Valid indicates whether the value is a known member of the PublicURLScope enum.

type RefreshControlSessionJSONRequestBody

type RefreshControlSessionJSONRequestBody = RefreshControlSessionRequest

RefreshControlSessionJSONRequestBody defines body for RefreshControlSession for application/json ContentType.

type RefreshControlSessionRequest

type RefreshControlSessionRequest struct {
	RefreshToken string `json:"refresh_token"`
}

RefreshControlSessionRequest defines model for RefreshControlSessionRequest.

type RefreshControlSessionResponse

type RefreshControlSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ControlSessionResponse
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseRefreshControlSessionResponse

func ParseRefreshControlSessionResponse(rsp *http.Response) (*RefreshControlSessionResponse, error)

ParseRefreshControlSessionResponse parses an HTTP response from a RefreshControlSessionWithResponse call

func (RefreshControlSessionResponse) ContentType

func (r RefreshControlSessionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RefreshControlSessionResponse) GetApplicationproblemJSONDefault

func (r RefreshControlSessionResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (RefreshControlSessionResponse) GetBody

func (r RefreshControlSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RefreshControlSessionResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RefreshControlSessionResponse) Status

Status returns HTTPResponse.Status

func (RefreshControlSessionResponse) StatusCode

func (r RefreshControlSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReleaseTeamDomainResponse

type ReleaseTeamDomainResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseReleaseTeamDomainResponse

func ParseReleaseTeamDomainResponse(rsp *http.Response) (*ReleaseTeamDomainResponse, error)

ParseReleaseTeamDomainResponse parses an HTTP response from a ReleaseTeamDomainWithResponse call

func (ReleaseTeamDomainResponse) ContentType

func (r ReleaseTeamDomainResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ReleaseTeamDomainResponse) GetApplicationproblemJSONDefault

func (r ReleaseTeamDomainResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ReleaseTeamDomainResponse) GetBody

func (r ReleaseTeamDomainResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ReleaseTeamDomainResponse) Status

func (r ReleaseTeamDomainResponse) Status() string

Status returns HTTPResponse.Status

func (ReleaseTeamDomainResponse) StatusCode

func (r ReleaseTeamDomainResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RemoveMembershipResponse

type RemoveMembershipResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseRemoveMembershipResponse

func ParseRemoveMembershipResponse(rsp *http.Response) (*RemoveMembershipResponse, error)

ParseRemoveMembershipResponse parses an HTTP response from a RemoveMembershipWithResponse call

func (RemoveMembershipResponse) ContentType

func (r RemoveMembershipResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RemoveMembershipResponse) GetApplicationproblemJSONDefault

func (r RemoveMembershipResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (RemoveMembershipResponse) GetBody

func (r RemoveMembershipResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RemoveMembershipResponse) Status

func (r RemoveMembershipResponse) Status() string

Status returns HTTPResponse.Status

func (RemoveMembershipResponse) StatusCode

func (r RemoveMembershipResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type RequiredHeaderError

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error

func (e *RequiredParamError) Error() string

type ResourceID

type ResourceID = string

ResourceID defines model for ResourceID.

type RevokeTeamInvitationResponse

type RevokeTeamInvitationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseRevokeTeamInvitationResponse

func ParseRevokeTeamInvitationResponse(rsp *http.Response) (*RevokeTeamInvitationResponse, error)

ParseRevokeTeamInvitationResponse parses an HTTP response from a RevokeTeamInvitationWithResponse call

func (RevokeTeamInvitationResponse) ContentType

func (r RevokeTeamInvitationResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RevokeTeamInvitationResponse) GetApplicationproblemJSONDefault

func (r RevokeTeamInvitationResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (RevokeTeamInvitationResponse) GetBody

func (r RevokeTeamInvitationResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RevokeTeamInvitationResponse) Status

Status returns HTTPResponse.Status

func (RevokeTeamInvitationResponse) StatusCode

func (r RevokeTeamInvitationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ServeMux

type ServeMux interface {
	HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
	http.Handler
}

ServeMux is an abstraction of http.ServeMux.

type ServerInterface

type ServerInterface interface {
	// LogoutControlSession Revoke the authenticated control session
	// (POST /v1/auth/logout)
	LogoutControlSession(w http.ResponseWriter, r *http.Request)
	// ExchangeOIDCToken Exchange an OIDC ID token for a control session
	// (POST /v1/auth/oidc)
	ExchangeOIDCToken(w http.ResponseWriter, r *http.Request)
	// RefreshControlSession Rotate a control session's access and refresh tokens
	// (POST /v1/auth/refresh)
	RefreshControlSession(w http.ResponseWriter, r *http.Request)
	// ExchangeLoginToken Exchange a login token for a control session
	// (POST /v1/auth/token)
	ExchangeLoginToken(w http.ResponseWriter, r *http.Request)
	// GetIdentityContext Read the authenticated identity and memberships
	// (GET /v1/identity)
	GetIdentityContext(w http.ResponseWriter, r *http.Request)
	// AcceptInvitation Accept an invitation with its secret
	// (POST /v1/invitations/accept)
	AcceptInvitation(w http.ResponseWriter, r *http.Request)
	// AuthorizeServiceOperation Authorize a control operation using current authority state
	// (POST /v1/service/authorize)
	AuthorizeServiceOperation(w http.ResponseWriter, r *http.Request)
	// ListTeams List teams for the authenticated identity
	// (GET /v1/teams)
	ListTeams(w http.ResponseWriter, r *http.Request)
	// CreateTeam Create an organization team
	// (POST /v1/teams)
	CreateTeam(w http.ResponseWriter, r *http.Request, params CreateTeamParams)
	// GetTeam Read one team
	// (GET /v1/teams/{team_id})
	GetTeam(w http.ResponseWriter, r *http.Request, teamId TeamID)
	// ListTeamDomains List domains available to the team
	// (GET /v1/teams/{team_id}/domains)
	ListTeamDomains(w http.ResponseWriter, r *http.Request, teamId TeamID)
	// ClaimTeamDomain Begin claiming one domain
	// (POST /v1/teams/{team_id}/domains)
	ClaimTeamDomain(w http.ResponseWriter, r *http.Request, teamId TeamID, params ClaimTeamDomainParams)
	// ReleaseTeamDomain Release one claimed domain
	// (DELETE /v1/teams/{team_id}/domains/{domain_id})
	ReleaseTeamDomain(w http.ResponseWriter, r *http.Request, teamId TeamID, domainId DomainID)
	// SetTeamDefaultDomain Select a ready default domain
	// (POST /v1/teams/{team_id}/domains/{domain_id}/default)
	SetTeamDefaultDomain(w http.ResponseWriter, r *http.Request, teamId TeamID, domainId DomainID)
	// ListTeamInvitations List team invitations
	// (GET /v1/teams/{team_id}/invitations)
	ListTeamInvitations(w http.ResponseWriter, r *http.Request, teamId TeamID)
	// CreateTeamInvitation Create an expiring invitation
	// (POST /v1/teams/{team_id}/invitations)
	CreateTeamInvitation(w http.ResponseWriter, r *http.Request, teamId TeamID, params CreateTeamInvitationParams)
	// RevokeTeamInvitation Revoke one pending invitation
	// (DELETE /v1/teams/{team_id}/invitations/{invitation_id})
	RevokeTeamInvitation(w http.ResponseWriter, r *http.Request, teamId TeamID, invitationId InvitationID)
	// ListTeamMemberships List team memberships
	// (GET /v1/teams/{team_id}/memberships)
	ListTeamMemberships(w http.ResponseWriter, r *http.Request, teamId TeamID)
	// RemoveMembership Remove one membership
	// (DELETE /v1/teams/{team_id}/memberships/{membership_id})
	RemoveMembership(w http.ResponseWriter, r *http.Request, teamId TeamID, membershipId MembershipID)
	// SetMembershipRole Change one membership's team role
	// (PATCH /v1/teams/{team_id}/memberships/{membership_id})
	SetMembershipRole(w http.ResponseWriter, r *http.Request, teamId TeamID, membershipId MembershipID)
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) AcceptInvitation

func (siw *ServerInterfaceWrapper) AcceptInvitation(w http.ResponseWriter, r *http.Request)

AcceptInvitation operation middleware

func (*ServerInterfaceWrapper) AuthorizeServiceOperation

func (siw *ServerInterfaceWrapper) AuthorizeServiceOperation(w http.ResponseWriter, r *http.Request)

AuthorizeServiceOperation operation middleware

func (*ServerInterfaceWrapper) ClaimTeamDomain

func (siw *ServerInterfaceWrapper) ClaimTeamDomain(w http.ResponseWriter, r *http.Request)

ClaimTeamDomain operation middleware

func (*ServerInterfaceWrapper) CreateTeam

func (siw *ServerInterfaceWrapper) CreateTeam(w http.ResponseWriter, r *http.Request)

CreateTeam operation middleware

func (*ServerInterfaceWrapper) CreateTeamInvitation

func (siw *ServerInterfaceWrapper) CreateTeamInvitation(w http.ResponseWriter, r *http.Request)

CreateTeamInvitation operation middleware

func (*ServerInterfaceWrapper) ExchangeLoginToken

func (siw *ServerInterfaceWrapper) ExchangeLoginToken(w http.ResponseWriter, r *http.Request)

ExchangeLoginToken operation middleware

func (*ServerInterfaceWrapper) ExchangeOIDCToken

func (siw *ServerInterfaceWrapper) ExchangeOIDCToken(w http.ResponseWriter, r *http.Request)

ExchangeOIDCToken operation middleware

func (*ServerInterfaceWrapper) GetIdentityContext

func (siw *ServerInterfaceWrapper) GetIdentityContext(w http.ResponseWriter, r *http.Request)

GetIdentityContext operation middleware

func (*ServerInterfaceWrapper) GetTeam

GetTeam operation middleware

func (*ServerInterfaceWrapper) ListTeamDomains

func (siw *ServerInterfaceWrapper) ListTeamDomains(w http.ResponseWriter, r *http.Request)

ListTeamDomains operation middleware

func (*ServerInterfaceWrapper) ListTeamInvitations

func (siw *ServerInterfaceWrapper) ListTeamInvitations(w http.ResponseWriter, r *http.Request)

ListTeamInvitations operation middleware

func (*ServerInterfaceWrapper) ListTeamMemberships

func (siw *ServerInterfaceWrapper) ListTeamMemberships(w http.ResponseWriter, r *http.Request)

ListTeamMemberships operation middleware

func (*ServerInterfaceWrapper) ListTeams

func (siw *ServerInterfaceWrapper) ListTeams(w http.ResponseWriter, r *http.Request)

ListTeams operation middleware

func (*ServerInterfaceWrapper) LogoutControlSession

func (siw *ServerInterfaceWrapper) LogoutControlSession(w http.ResponseWriter, r *http.Request)

LogoutControlSession operation middleware

func (*ServerInterfaceWrapper) RefreshControlSession

func (siw *ServerInterfaceWrapper) RefreshControlSession(w http.ResponseWriter, r *http.Request)

RefreshControlSession operation middleware

func (*ServerInterfaceWrapper) ReleaseTeamDomain

func (siw *ServerInterfaceWrapper) ReleaseTeamDomain(w http.ResponseWriter, r *http.Request)

ReleaseTeamDomain operation middleware

func (*ServerInterfaceWrapper) RemoveMembership

func (siw *ServerInterfaceWrapper) RemoveMembership(w http.ResponseWriter, r *http.Request)

RemoveMembership operation middleware

func (*ServerInterfaceWrapper) RevokeTeamInvitation

func (siw *ServerInterfaceWrapper) RevokeTeamInvitation(w http.ResponseWriter, r *http.Request)

RevokeTeamInvitation operation middleware

func (*ServerInterfaceWrapper) SetMembershipRole

func (siw *ServerInterfaceWrapper) SetMembershipRole(w http.ResponseWriter, r *http.Request)

SetMembershipRole operation middleware

func (*ServerInterfaceWrapper) SetTeamDefaultDomain

func (siw *ServerInterfaceWrapper) SetTeamDefaultDomain(w http.ResponseWriter, r *http.Request)

SetTeamDefaultDomain operation middleware

type ServiceAuthorizationDecision

type ServiceAuthorizationDecision struct {
	ActingMembershipId    MembershipID      `json:"acting_membership_id"`
	ActingRole            TeamRole          `json:"acting_role"`
	CanonicalHostname     CanonicalHostname `json:"canonical_hostname"`
	CertificatePlan       *CertificatePlan  `json:"certificate_plan,omitempty"`
	DnsAuthorityReference string            `json:"dns_authority_reference"`
	DomainId              DomainID          `json:"domain_id"`
	IdentityId            IdentityID        `json:"identity_id"`
	PolicyRevision        int64             `json:"policy_revision"`
	PublicUrlMembershipId *MembershipID     `json:"public_url_membership_id,omitempty"`
	PublicUrlScope        PublicURLScope    `json:"public_url_scope"`
	TeamId                TeamID            `json:"team_id"`
}

ServiceAuthorizationDecision defines model for ServiceAuthorizationDecision.

type ServiceAuthorizationRequest

type ServiceAuthorizationRequest struct {
	AccessToken               string                 `json:"access_token"`
	ActingMembershipId        *MembershipID          `json:"acting_membership_id,omitempty"`
	AllowedIpPrefixes         []string               `json:"allowed_ip_prefixes"`
	CanonicalHostname         CanonicalHostname      `json:"canonical_hostname"`
	DomainId                  DomainID               `json:"domain_id"`
	Ephemeral                 bool                   `json:"ephemeral"`
	Operation                 AuthorizationOperation `json:"operation"`
	PublicUrlId               *PublicURLID           `json:"public_url_id,omitempty"`
	PublicUrlMembershipId     *MembershipID          `json:"public_url_membership_id,omitempty"`
	PublicUrlMutationRevision *int64                 `json:"public_url_mutation_revision,omitempty"`
	PublicUrlScope            PublicURLScope         `json:"public_url_scope"`
	PublishRunNumber          *int64                 `json:"publish_run_number,omitempty"`
	Target                    string                 `json:"target"`
	TeamId                    TeamID                 `json:"team_id"`
}

ServiceAuthorizationRequest defines model for ServiceAuthorizationRequest.

type SetMembershipRoleJSONRequestBody

type SetMembershipRoleJSONRequestBody = SetMembershipRoleRequest

SetMembershipRoleJSONRequestBody defines body for SetMembershipRole for application/json ContentType.

type SetMembershipRoleRequest

type SetMembershipRoleRequest struct {
	Role TeamRole `json:"role"`
}

SetMembershipRoleRequest defines model for SetMembershipRoleRequest.

type SetMembershipRoleResponse

type SetMembershipRoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Membership
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseSetMembershipRoleResponse

func ParseSetMembershipRoleResponse(rsp *http.Response) (*SetMembershipRoleResponse, error)

ParseSetMembershipRoleResponse parses an HTTP response from a SetMembershipRoleWithResponse call

func (SetMembershipRoleResponse) ContentType

func (r SetMembershipRoleResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SetMembershipRoleResponse) GetApplicationproblemJSONDefault

func (r SetMembershipRoleResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (SetMembershipRoleResponse) GetBody

func (r SetMembershipRoleResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SetMembershipRoleResponse) GetJSON200

func (r SetMembershipRoleResponse) GetJSON200() *Membership

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SetMembershipRoleResponse) Status

func (r SetMembershipRoleResponse) Status() string

Status returns HTTPResponse.Status

func (SetMembershipRoleResponse) StatusCode

func (r SetMembershipRoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SetTeamDefaultDomainResponse

type SetTeamDefaultDomainResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Team
	// ApplicationproblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationproblemJSONDefault *Problem
}

func ParseSetTeamDefaultDomainResponse

func ParseSetTeamDefaultDomainResponse(rsp *http.Response) (*SetTeamDefaultDomainResponse, error)

ParseSetTeamDefaultDomainResponse parses an HTTP response from a SetTeamDefaultDomainWithResponse call

func (SetTeamDefaultDomainResponse) ContentType

func (r SetTeamDefaultDomainResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SetTeamDefaultDomainResponse) GetApplicationproblemJSONDefault

func (r SetTeamDefaultDomainResponse) GetApplicationproblemJSONDefault() *Problem

GetApplicationproblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (SetTeamDefaultDomainResponse) GetBody

func (r SetTeamDefaultDomainResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SetTeamDefaultDomainResponse) GetJSON200

func (r SetTeamDefaultDomainResponse) GetJSON200() *Team

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SetTeamDefaultDomainResponse) Status

Status returns HTTPResponse.Status

func (SetTeamDefaultDomainResponse) StatusCode

func (r SetTeamDefaultDomainResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StdHTTPServerOptions

type StdHTTPServerOptions struct {
	BaseURL          string
	BaseRouter       ServeMux
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type Team

type Team struct {
	CreatedAt       time.Time      `json:"created_at"`
	DefaultDomainId DomainID       `json:"default_domain_id"`
	DisplayName     CanonicalLabel `json:"display_name"`
	Id              TeamID         `json:"id"`
	Kind            TeamKind       `json:"kind"`
	ManagedLabel    CanonicalLabel `json:"managed_label"`
	PolicyRevision  int64          `json:"policy_revision"`
	UpdatedAt       time.Time      `json:"updated_at"`
}

Team defines model for Team.

type TeamID

type TeamID = ResourceID

TeamID defines model for TeamID.

type TeamKind

type TeamKind string

TeamKind defines model for TeamKind.

const (
	Organization TeamKind = "organization"
	Personal     TeamKind = "personal"
)

Defines values for TeamKind.

func (TeamKind) Valid

func (e TeamKind) Valid() bool

Valid indicates whether the value is a known member of the TeamKind enum.

type TeamPage

type TeamPage struct {
	NextCursor *TeamID `json:"next_cursor,omitempty"`
	Teams      []Team  `json:"teams"`
}

TeamPage defines model for TeamPage.

type TeamRole

type TeamRole string

TeamRole defines model for TeamRole.

const (
	TeamRoleAdmin  TeamRole = "admin"
	TeamRoleMember TeamRole = "member"
	TeamRoleOwner  TeamRole = "owner"
)

Defines values for TeamRole.

func (TeamRole) Valid

func (e TeamRole) Valid() bool

Valid indicates whether the value is a known member of the TeamRole enum.

type TooManyValuesForParamError

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error

type UnescapedCookieParamError

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap

func (e *UnescapedCookieParamError) Unwrap() error

type UnmarshalingParamError

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap

func (e *UnmarshalingParamError) Unwrap() error

Jump to

Keyboard shortcuts

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