controlv1

package
v0.1.0-rc.28 Latest Latest
Warning

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

Go to latest
Published: Sep 24, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package controlv1 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 NewCloseRouteSessionRequest

func NewCloseRouteSessionRequest(server string, routeSessionId RouteSessionID) (*http.Request, error)

NewCloseRouteSessionRequest constructs an http.Request for the CloseRouteSession method

func NewCreateCertificateIssuanceRequest

func NewCreateCertificateIssuanceRequest(server string, routeSessionId RouteSessionID, params *CreateCertificateIssuanceParams, body CreateCertificateIssuanceJSONRequestBody) (*http.Request, error)

NewCreateCertificateIssuanceRequest calls the generic CreateCertificateIssuance builder with application/json body

func NewCreateCertificateIssuanceRequestWithBody

func NewCreateCertificateIssuanceRequestWithBody(server string, routeSessionId RouteSessionID, params *CreateCertificateIssuanceParams, contentType string, body io.Reader) (*http.Request, error)

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

func NewCreateDNSAuthorityRequest

func NewCreateDNSAuthorityRequest(server string, params *CreateDNSAuthorityParams, body CreateDNSAuthorityJSONRequestBody) (*http.Request, error)

NewCreateDNSAuthorityRequest calls the generic CreateDNSAuthority builder with application/json body

func NewCreateDNSAuthorityRequestWithBody

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

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

func NewCreateRouteRequest

func NewCreateRouteRequest(server string, params *CreateRouteParams, body CreateRouteJSONRequestBody) (*http.Request, error)

NewCreateRouteRequest calls the generic CreateRoute builder with application/json body

func NewCreateRouteRequestWithBody

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

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

func NewCreateRouteSessionRequest

func NewCreateRouteSessionRequest(server string, routeId RouteID, params *CreateRouteSessionParams) (*http.Request, error)

NewCreateRouteSessionRequest constructs an http.Request for the CreateRouteSession method

func NewDeleteRouteRequest

func NewDeleteRouteRequest(server string, routeId RouteID) (*http.Request, error)

NewDeleteRouteRequest constructs an http.Request for the DeleteRoute method

func NewDrainAdminRelayRequest

func NewDrainAdminRelayRequest(server string, relayId RelayID, body DrainAdminRelayJSONRequestBody) (*http.Request, error)

NewDrainAdminRelayRequest calls the generic DrainAdminRelay builder with application/json body

func NewDrainAdminRelayRequestWithBody

func NewDrainAdminRelayRequestWithBody(server string, relayId RelayID, contentType string, body io.Reader) (*http.Request, error)

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

func NewGetAdminServerStatusRequest

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

NewGetAdminServerStatusRequest constructs an http.Request for the GetAdminServerStatus method

func NewGetCertificateIssuanceRequest

func NewGetCertificateIssuanceRequest(server string, issuanceId IssuanceID) (*http.Request, error)

NewGetCertificateIssuanceRequest constructs an http.Request for the GetCertificateIssuance method

func NewGetClientIPRequest

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

NewGetClientIPRequest constructs an http.Request for the GetClientIP method

func NewGetControlDiscoveryRequest

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

NewGetControlDiscoveryRequest constructs an http.Request for the GetControlDiscovery method

func NewGetDNSAuthorityRequest

func NewGetDNSAuthorityRequest(server string, dnsAuthorityReference DNSAuthorityReference) (*http.Request, error)

NewGetDNSAuthorityRequest constructs an http.Request for the GetDNSAuthority method

func NewGetHealthRequest

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

NewGetHealthRequest constructs an http.Request for the GetHealth method

func NewGetReadinessRequest

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

NewGetReadinessRequest constructs an http.Request for the GetReadiness method

func NewGetRouteRequest

func NewGetRouteRequest(server string, routeId RouteID) (*http.Request, error)

NewGetRouteRequest constructs an http.Request for the GetRoute method

func NewHeartbeatRouteSessionRequest

func NewHeartbeatRouteSessionRequest(server string, routeSessionId RouteSessionID, body HeartbeatRouteSessionJSONRequestBody) (*http.Request, error)

NewHeartbeatRouteSessionRequest calls the generic HeartbeatRouteSession builder with application/json body

func NewHeartbeatRouteSessionRequestWithBody

func NewHeartbeatRouteSessionRequestWithBody(server string, routeSessionId RouteSessionID, contentType string, body io.Reader) (*http.Request, error)

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

func NewListAdminRelaysRequest

func NewListAdminRelaysRequest(server string, params *ListAdminRelaysParams) (*http.Request, error)

NewListAdminRelaysRequest constructs an http.Request for the ListAdminRelays method

func NewListMaintenanceControlsRequest

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

NewListMaintenanceControlsRequest constructs an http.Request for the ListMaintenanceControls method

func NewListRoutesRequest

func NewListRoutesRequest(server string, params *ListRoutesParams) (*http.Request, error)

NewListRoutesRequest constructs an http.Request for the ListRoutes method

func NewMarkCertificateChallengeReadyRequest

func NewMarkCertificateChallengeReadyRequest(server string, issuanceId IssuanceID) (*http.Request, error)

NewMarkCertificateChallengeReadyRequest constructs an http.Request for the MarkCertificateChallengeReady method

func NewMarkCertificateChallengeRemovedRequest

func NewMarkCertificateChallengeRemovedRequest(server string, issuanceId IssuanceID) (*http.Request, error)

NewMarkCertificateChallengeRemovedRequest constructs an http.Request for the MarkCertificateChallengeRemoved method

func NewMarkRouteSessionCertificateInstalledRequest

func NewMarkRouteSessionCertificateInstalledRequest(server string, routeSessionId RouteSessionID, body MarkRouteSessionCertificateInstalledJSONRequestBody) (*http.Request, error)

NewMarkRouteSessionCertificateInstalledRequest calls the generic MarkRouteSessionCertificateInstalled builder with application/json body

func NewMarkRouteSessionCertificateInstalledRequestWithBody

func NewMarkRouteSessionCertificateInstalledRequestWithBody(server string, routeSessionId RouteSessionID, contentType string, body io.Reader) (*http.Request, error)

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

func NewMarkRouteSessionReadyRequest

func NewMarkRouteSessionReadyRequest(server string, routeSessionId RouteSessionID, body MarkRouteSessionReadyJSONRequestBody) (*http.Request, error)

NewMarkRouteSessionReadyRequest calls the generic MarkRouteSessionReady builder with application/json body

func NewMarkRouteSessionReadyRequestWithBody

func NewMarkRouteSessionReadyRequestWithBody(server string, routeSessionId RouteSessionID, contentType string, body io.Reader) (*http.Request, error)

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

func NewReleaseDNSAuthorityRequest

func NewReleaseDNSAuthorityRequest(server string, dnsAuthorityReference DNSAuthorityReference, params *ReleaseDNSAuthorityParams) (*http.Request, error)

NewReleaseDNSAuthorityRequest constructs an http.Request for the ReleaseDNSAuthority method

func NewRevokeHostedPolicyRequest

func NewRevokeHostedPolicyRequest(server string, body RevokeHostedPolicyJSONRequestBody) (*http.Request, error)

NewRevokeHostedPolicyRequest calls the generic RevokeHostedPolicy builder with application/json body

func NewRevokeHostedPolicyRequestWithBody

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

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

func NewSetMaintenanceControlRequest

func NewSetMaintenanceControlRequest(server string, controlName MaintenanceControlName, body SetMaintenanceControlJSONRequestBody) (*http.Request, error)

NewSetMaintenanceControlRequest calls the generic SetMaintenanceControl builder with application/json body

func NewSetMaintenanceControlRequestWithBody

func NewSetMaintenanceControlRequestWithBody(server string, controlName MaintenanceControlName, contentType string, body io.Reader) (*http.Request, error)

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

func NewUpdateRouteRequest

func NewUpdateRouteRequest(server string, routeId RouteID, body UpdateRouteJSONRequestBody) (*http.Request, error)

NewUpdateRouteRequest calls the generic UpdateRoute builder with application/json body

func NewUpdateRouteRequestWithBody

func NewUpdateRouteRequestWithBody(server string, routeId RouteID, contentType string, body io.Reader) (*http.Request, error)

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

Types

type AdminDrainRelayRequest

type AdminDrainRelayRequest struct {
	Deadline           time.Time  `json:"deadline"`
	RelayLeaseRevision int64      `json:"relay_lease_revision"`
	RelayRunId         ResourceID `json:"relay_run_id"`
}

AdminDrainRelayRequest defines model for AdminDrainRelayRequest.

type AdminRelayLease

type AdminRelayLease struct {
	ConnectionCapacity   int64             `json:"connection_capacity"`
	DrainDeadline        *time.Time        `json:"drain_deadline,omitempty"`
	Draining             bool              `json:"draining"`
	InternalRelayAddress string            `json:"internal_relay_address"`
	LeaseExpiresAt       time.Time         `json:"lease_expires_at"`
	ProtocolVersion      int64             `json:"protocol_version"`
	RelayAddress         string            `json:"relay_address"`
	RelayId              RelayID           `json:"relay_id"`
	RelayLeaseRevision   int64             `json:"relay_lease_revision"`
	RelayRunId           ResourceID        `json:"relay_run_id"`
	RelayServiceId       RelayServiceID    `json:"relay_service_id"`
	RenewedAt            time.Time         `json:"renewed_at"`
	ReportedConnections  int64             `json:"reported_connections"`
	ReportedStreams      int64             `json:"reported_streams"`
	StreamCapacity       int64             `json:"stream_capacity"`
	TlsServerName        CanonicalHostname `json:"tls_server_name"`
}

AdminRelayLease defines model for AdminRelayLease.

type AdminRelayPage

type AdminRelayPage struct {
	NextCursor *RelayID          `json:"next_cursor,omitempty"`
	Relays     []AdminRelayLease `json:"relays"`
}

AdminRelayPage defines model for AdminRelayPage.

type AdminServerStatus

type AdminServerStatus struct {
	CurrentTime           time.Time             `json:"current_time"`
	EnabledRoutes         int                   `json:"enabled_routes"`
	IngressLeases         int                   `json:"ingress_leases"`
	ReadyRouteSessions    int                   `json:"ready_route_sessions"`
	RelayLeases           int                   `json:"relay_leases"`
	Role                  AdminServerStatusRole `json:"role"`
	StartedAt             time.Time             `json:"started_at"`
	StartingRouteSessions int                   `json:"starting_route_sessions"`
	SuspendedRoutes       int                   `json:"suspended_routes"`
}

AdminServerStatus defines model for AdminServerStatus.

type AdminServerStatusRole

type AdminServerStatusRole string

AdminServerStatusRole defines model for AdminServerStatus.Role.

const (
	Control    AdminServerStatusRole = "control"
	Standalone AdminServerStatusRole = "standalone"
)

Defines values for AdminServerStatusRole.

func (AdminServerStatusRole) Valid

func (e AdminServerStatusRole) Valid() bool

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

type AuthenticationFacts

type AuthenticationFacts struct {
	Methods []AuthenticationFactsMethods `json:"methods"`
	Oidc    *OIDCAuthenticationFacts     `json:"oidc,omitempty"`
}

AuthenticationFacts defines model for AuthenticationFacts.

type AuthenticationFactsMethods

type AuthenticationFactsMethods string

AuthenticationFactsMethods defines model for AuthenticationFacts.Methods.

const (
	LoginToken AuthenticationFactsMethods = "login_token"
	Oidc       AuthenticationFactsMethods = "oidc"
)

Defines values for AuthenticationFactsMethods.

func (AuthenticationFactsMethods) Valid

func (e AuthenticationFactsMethods) Valid() bool

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

type CanonicalHostname

type CanonicalHostname = string

CanonicalHostname defines model for CanonicalHostname.

type CanonicalHostnameQuery

type CanonicalHostnameQuery = CanonicalHostname

CanonicalHostnameQuery defines model for CanonicalHostnameQuery.

type CertificateChallenge

type CertificateChallenge struct {
	Digest     string                     `json:"digest"`
	ExpiresAt  time.Time                  `json:"expires_at"`
	Identifier CanonicalHostname          `json:"identifier"`
	Method     CertificateChallengeMethod `json:"method"`
	Token      string                     `json:"token"`
}

CertificateChallenge defines model for CertificateChallenge.

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 CertificateInstalledRequest

type CertificateInstalledRequest struct {
	IssuanceId   IssuanceID `json:"issuance_id"`
	NotAfter     time.Time  `json:"not_after"`
	RouteVersion int64      `json:"route_version"`
}

CertificateInstalledRequest defines model for CertificateInstalledRequest.

type CertificateIssuance

type CertificateIssuance struct {
	CertificatePem  *string                  `json:"certificate_pem,omitempty"`
	CertificatePlan CertificatePlan          `json:"certificate_plan"`
	Challenges      *[]CertificateChallenge  `json:"challenges,omitempty"`
	CreatedAt       time.Time                `json:"created_at"`
	Id              IssuanceID               `json:"id"`
	NotAfter        *time.Time               `json:"not_after,omitempty"`
	NotBefore       *time.Time               `json:"not_before,omitempty"`
	RetryAt         *time.Time               `json:"retry_at,omitempty"`
	RouteId         RouteID                  `json:"route_id"`
	RouteSessionId  RouteSessionID           `json:"route_session_id"`
	RouteVersion    int64                    `json:"route_version"`
	State           CertificateIssuanceState `json:"state"`
	UpdatedAt       time.Time                `json:"updated_at"`
}

CertificateIssuance defines model for CertificateIssuance.

type CertificateIssuanceState

type CertificateIssuanceState string

CertificateIssuanceState defines model for CertificateIssuanceState.

const (
	CertificateIssuanceStateAuthorizing       CertificateIssuanceState = "authorizing"
	CertificateIssuanceStateCanceled          CertificateIssuanceState = "canceled"
	CertificateIssuanceStateFailed            CertificateIssuanceState = "failed"
	CertificateIssuanceStateFinalizing        CertificateIssuanceState = "finalizing"
	CertificateIssuanceStateInstalled         CertificateIssuanceState = "installed"
	CertificateIssuanceStatePending           CertificateIssuanceState = "pending"
	CertificateIssuanceStateReadyToFinalize   CertificateIssuanceState = "ready_to_finalize"
	CertificateIssuanceStateWaitingForInstall CertificateIssuanceState = "waiting_for_install"
)

Defines values for CertificateIssuanceState.

func (CertificateIssuanceState) Valid

func (e CertificateIssuanceState) Valid() bool

Valid indicates whether the value is a known member of the CertificateIssuanceState 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 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) CloseRouteSession

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

CloseRouteSession Close and drain a route session without deleting its route

Corresponds with DELETE /v1/route-sessions/{route_session_id} (the `CloseRouteSession` operationId).

func (*Client) CreateCertificateIssuance

func (c *Client) CreateCertificateIssuance(ctx context.Context, routeSessionId RouteSessionID, params *CreateCertificateIssuanceParams, body CreateCertificateIssuanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateCertificateIssuance Begin issuance for the route session's certificate plan

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

Corresponds with POST /v1/route-sessions/{route_session_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).

func (*Client) CreateCertificateIssuanceWithBody

func (c *Client) CreateCertificateIssuanceWithBody(ctx context.Context, routeSessionId RouteSessionID, params *CreateCertificateIssuanceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateCertificateIssuanceWithBody Begin issuance for the route session's certificate plan

Takes any type of body and a specified content type.

Corresponds with POST /v1/route-sessions/{route_session_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).

func (*Client) CreateDNSAuthority

func (c *Client) CreateDNSAuthority(ctx context.Context, params *CreateDNSAuthorityParams, body CreateDNSAuthorityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateDNSAuthority Create a DNS authority for one claimed domain

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

Corresponds with POST /v1/service/dns-authorities (the `CreateDNSAuthority` operationId).

func (*Client) CreateDNSAuthorityWithBody

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

CreateDNSAuthorityWithBody Create a DNS authority for one claimed domain

Takes any type of body and a specified content type.

Corresponds with POST /v1/service/dns-authorities (the `CreateDNSAuthority` operationId).

func (*Client) CreateRoute

func (c *Client) CreateRoute(ctx context.Context, params *CreateRouteParams, body CreateRouteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateRoute Create one team route

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

Corresponds with POST /v1/routes (the `CreateRoute` operationId).

func (*Client) CreateRouteSession

func (c *Client) CreateRouteSession(ctx context.Context, routeId RouteID, params *CreateRouteSessionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateRouteSession Create a route session and allocate its route version

Corresponds with POST /v1/routes/{route_id}/sessions (the `CreateRouteSession` operationId).

func (*Client) CreateRouteWithBody

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

CreateRouteWithBody Create one team route

Takes any type of body and a specified content type.

Corresponds with POST /v1/routes (the `CreateRoute` operationId).

func (*Client) DeleteRoute

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

DeleteRoute Delete one route and close its route session

Corresponds with DELETE /v1/routes/{route_id} (the `DeleteRoute` operationId).

func (*Client) DrainAdminRelay

func (c *Client) DrainAdminRelay(ctx context.Context, relayId RelayID, body DrainAdminRelayJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

DrainAdminRelay Remove a matching relay lease from placement and begin draining

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

Corresponds with POST /v1/admin/relays/{relay_id}/drain (the `DrainAdminRelay` operationId).

func (*Client) DrainAdminRelayWithBody

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

DrainAdminRelayWithBody Remove a matching relay lease from placement and begin draining

Takes any type of body and a specified content type.

Corresponds with POST /v1/admin/relays/{relay_id}/drain (the `DrainAdminRelay` operationId).

func (*Client) GetAdminServerStatus

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

GetAdminServerStatus Read control, ingress, and relay status

Corresponds with GET /v1/admin/status (the `GetAdminServerStatus` operationId).

func (*Client) GetCertificateIssuance

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

GetCertificateIssuance Read one route-session certificate issuance

Corresponds with GET /v1/certificate-issuances/{issuance_id} (the `GetCertificateIssuance` operationId).

func (*Client) GetClientIP

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

GetClientIP Return the requesting client's public IP address

Corresponds with GET /v1/client-ip (the `GetClientIP` operationId).

func (*Client) GetControlDiscovery

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

GetControlDiscovery Describe control and its authentication methods

Corresponds with GET /v1/discovery (the `GetControlDiscovery` operationId).

func (*Client) GetDNSAuthority

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

GetDNSAuthority Read a claimed domain's DNS authority

Corresponds with GET /v1/service/dns-authorities/{dns_authority_reference} (the `GetDNSAuthority` operationId).

func (*Client) GetHealth

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

GetHealth Confirm that the control HTTP server is serving

Corresponds with GET /v1/health (the `GetHealth` operationId).

func (*Client) GetReadiness

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

GetReadiness Confirm that control and its database are ready

Corresponds with GET /v1/ready (the `GetReadiness` operationId).

func (*Client) GetRoute

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

GetRoute Read one route

Corresponds with GET /v1/routes/{route_id} (the `GetRoute` operationId).

func (*Client) HeartbeatRouteSession

func (c *Client) HeartbeatRouteSession(ctx context.Context, routeSessionId RouteSessionID, body HeartbeatRouteSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

HeartbeatRouteSession Renew a route session and replace missing publisher connections

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

Corresponds with POST /v1/route-sessions/{route_session_id}/heartbeat (the `HeartbeatRouteSession` operationId).

func (*Client) HeartbeatRouteSessionWithBody

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

HeartbeatRouteSessionWithBody Renew a route session and replace missing publisher connections

Takes any type of body and a specified content type.

Corresponds with POST /v1/route-sessions/{route_session_id}/heartbeat (the `HeartbeatRouteSession` operationId).

func (*Client) ListAdminRelays

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

ListAdminRelays List relay leases

Corresponds with GET /v1/admin/relays (the `ListAdminRelays` operationId).

func (*Client) ListMaintenanceControls

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

ListMaintenanceControls List maintenance controls

Corresponds with GET /v1/admin/maintenance-controls (the `ListMaintenanceControls` operationId).

func (*Client) ListRoutes

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

ListRoutes List routes for one team

Corresponds with GET /v1/routes (the `ListRoutes` operationId).

func (*Client) MarkCertificateChallengeReady

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

MarkCertificateChallengeReady Confirm a TLS-ALPN-01 challenge is installed

Corresponds with POST /v1/certificate-issuances/{issuance_id}/challenge-ready (the `MarkCertificateChallengeReady` operationId).

func (*Client) MarkCertificateChallengeRemoved

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

MarkCertificateChallengeRemoved Confirm a TLS-ALPN-01 challenge is removed

Corresponds with POST /v1/certificate-issuances/{issuance_id}/challenge-removed (the `MarkCertificateChallengeRemoved` operationId).

func (*Client) MarkRouteSessionCertificateInstalled

func (c *Client) MarkRouteSessionCertificateInstalled(ctx context.Context, routeSessionId RouteSessionID, body MarkRouteSessionCertificateInstalledJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

MarkRouteSessionCertificateInstalled Record installation of the current route certificate

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

Corresponds with POST /v1/route-sessions/{route_session_id}/certificate-installed (the `MarkRouteSessionCertificateInstalled` operationId).

func (*Client) MarkRouteSessionCertificateInstalledWithBody

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

MarkRouteSessionCertificateInstalledWithBody Record installation of the current route certificate

Takes any type of body and a specified content type.

Corresponds with POST /v1/route-sessions/{route_session_id}/certificate-installed (the `MarkRouteSessionCertificateInstalled` operationId).

func (*Client) MarkRouteSessionReady

func (c *Client) MarkRouteSessionReady(ctx context.Context, routeSessionId RouteSessionID, body MarkRouteSessionReadyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

MarkRouteSessionReady Mark a route session ready after its certificate and two publisher connections are ready

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

Corresponds with POST /v1/route-sessions/{route_session_id}/ready (the `MarkRouteSessionReady` operationId).

func (*Client) MarkRouteSessionReadyWithBody

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

MarkRouteSessionReadyWithBody Mark a route session ready after its certificate and two publisher connections are ready

Takes any type of body and a specified content type.

Corresponds with POST /v1/route-sessions/{route_session_id}/ready (the `MarkRouteSessionReady` operationId).

func (*Client) ReleaseDNSAuthority

func (c *Client) ReleaseDNSAuthority(ctx context.Context, dnsAuthorityReference DNSAuthorityReference, params *ReleaseDNSAuthorityParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ReleaseDNSAuthority Begin releasing a claimed domain's DNS authority

Corresponds with DELETE /v1/service/dns-authorities/{dns_authority_reference} (the `ReleaseDNSAuthority` operationId).

func (*Client) RevokeHostedPolicy

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

RevokeHostedPolicy Apply a policy revision from the external authority and close affected route sessions

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

Corresponds with POST /v1/service/revoke (the `RevokeHostedPolicy` operationId).

func (*Client) RevokeHostedPolicyWithBody

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

RevokeHostedPolicyWithBody Apply a policy revision from the external authority and close affected route sessions

Takes any type of body and a specified content type.

Corresponds with POST /v1/service/revoke (the `RevokeHostedPolicy` operationId).

func (*Client) SetMaintenanceControl

func (c *Client) SetMaintenanceControl(ctx context.Context, controlName MaintenanceControlName, body SetMaintenanceControlJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SetMaintenanceControl Set one maintenance control

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

Corresponds with PUT /v1/admin/maintenance-controls/{control_name} (the `SetMaintenanceControl` operationId).

func (*Client) SetMaintenanceControlWithBody

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

SetMaintenanceControlWithBody Set one maintenance control

Takes any type of body and a specified content type.

Corresponds with PUT /v1/admin/maintenance-controls/{control_name} (the `SetMaintenanceControl` operationId).

func (*Client) UpdateRoute

func (c *Client) UpdateRoute(ctx context.Context, routeId RouteID, body UpdateRouteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateRoute Update a route's target and IP policy

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

Corresponds with PATCH /v1/routes/{route_id} (the `UpdateRoute` operationId).

func (*Client) UpdateRouteWithBody

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

UpdateRouteWithBody Update a route's target and IP policy

Takes any type of body and a specified content type.

Corresponds with PATCH /v1/routes/{route_id} (the `UpdateRoute` operationId).

type ClientIPResponse

type ClientIPResponse struct {
	Ip string `json:"ip"`
}

ClientIPResponse defines model for ClientIPResponse.

type ClientInterface

type ClientInterface interface {

	// ListMaintenanceControls List maintenance controls
	//
	// Corresponds with GET /v1/admin/maintenance-controls (the `ListMaintenanceControls` operationId).
	ListMaintenanceControls(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetMaintenanceControlWithBody Set one maintenance control
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /v1/admin/maintenance-controls/{control_name} (the `SetMaintenanceControl` operationId).
	SetMaintenanceControlWithBody(ctx context.Context, controlName MaintenanceControlName, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetMaintenanceControl Set one maintenance control
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /v1/admin/maintenance-controls/{control_name} (the `SetMaintenanceControl` operationId).
	SetMaintenanceControl(ctx context.Context, controlName MaintenanceControlName, body SetMaintenanceControlJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListAdminRelays List relay leases
	//
	// Corresponds with GET /v1/admin/relays (the `ListAdminRelays` operationId).
	ListAdminRelays(ctx context.Context, params *ListAdminRelaysParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DrainAdminRelayWithBody Remove a matching relay lease from placement and begin draining
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/admin/relays/{relay_id}/drain (the `DrainAdminRelay` operationId).
	DrainAdminRelayWithBody(ctx context.Context, relayId RelayID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DrainAdminRelay Remove a matching relay lease from placement and begin draining
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/admin/relays/{relay_id}/drain (the `DrainAdminRelay` operationId).
	DrainAdminRelay(ctx context.Context, relayId RelayID, body DrainAdminRelayJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAdminServerStatus Read control, ingress, and relay status
	//
	// Corresponds with GET /v1/admin/status (the `GetAdminServerStatus` operationId).
	GetAdminServerStatus(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCertificateIssuance Read one route-session certificate issuance
	//
	// Corresponds with GET /v1/certificate-issuances/{issuance_id} (the `GetCertificateIssuance` operationId).
	GetCertificateIssuance(ctx context.Context, issuanceId IssuanceID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MarkCertificateChallengeReady Confirm a TLS-ALPN-01 challenge is installed
	//
	// Corresponds with POST /v1/certificate-issuances/{issuance_id}/challenge-ready (the `MarkCertificateChallengeReady` operationId).
	MarkCertificateChallengeReady(ctx context.Context, issuanceId IssuanceID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MarkCertificateChallengeRemoved Confirm a TLS-ALPN-01 challenge is removed
	//
	// Corresponds with POST /v1/certificate-issuances/{issuance_id}/challenge-removed (the `MarkCertificateChallengeRemoved` operationId).
	MarkCertificateChallengeRemoved(ctx context.Context, issuanceId IssuanceID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetClientIP Return the requesting client's public IP address
	//
	// Corresponds with GET /v1/client-ip (the `GetClientIP` operationId).
	GetClientIP(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetControlDiscovery Describe control and its authentication methods
	//
	// Corresponds with GET /v1/discovery (the `GetControlDiscovery` operationId).
	GetControlDiscovery(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHealth Confirm that the control HTTP server is serving
	//
	// Corresponds with GET /v1/health (the `GetHealth` operationId).
	GetHealth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetReadiness Confirm that control and its database are ready
	//
	// Corresponds with GET /v1/ready (the `GetReadiness` operationId).
	GetReadiness(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CloseRouteSession Close and drain a route session without deleting its route
	//
	// Corresponds with DELETE /v1/route-sessions/{route_session_id} (the `CloseRouteSession` operationId).
	CloseRouteSession(ctx context.Context, routeSessionId RouteSessionID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MarkRouteSessionCertificateInstalledWithBody Record installation of the current route certificate
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/route-sessions/{route_session_id}/certificate-installed (the `MarkRouteSessionCertificateInstalled` operationId).
	MarkRouteSessionCertificateInstalledWithBody(ctx context.Context, routeSessionId RouteSessionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MarkRouteSessionCertificateInstalled Record installation of the current route certificate
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/route-sessions/{route_session_id}/certificate-installed (the `MarkRouteSessionCertificateInstalled` operationId).
	MarkRouteSessionCertificateInstalled(ctx context.Context, routeSessionId RouteSessionID, body MarkRouteSessionCertificateInstalledJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateCertificateIssuanceWithBody Begin issuance for the route session's certificate plan
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/route-sessions/{route_session_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).
	CreateCertificateIssuanceWithBody(ctx context.Context, routeSessionId RouteSessionID, params *CreateCertificateIssuanceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateCertificateIssuance Begin issuance for the route session's certificate plan
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/route-sessions/{route_session_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).
	CreateCertificateIssuance(ctx context.Context, routeSessionId RouteSessionID, params *CreateCertificateIssuanceParams, body CreateCertificateIssuanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// HeartbeatRouteSessionWithBody Renew a route session and replace missing publisher connections
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/route-sessions/{route_session_id}/heartbeat (the `HeartbeatRouteSession` operationId).
	HeartbeatRouteSessionWithBody(ctx context.Context, routeSessionId RouteSessionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// HeartbeatRouteSession Renew a route session and replace missing publisher connections
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/route-sessions/{route_session_id}/heartbeat (the `HeartbeatRouteSession` operationId).
	HeartbeatRouteSession(ctx context.Context, routeSessionId RouteSessionID, body HeartbeatRouteSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MarkRouteSessionReadyWithBody Mark a route session ready after its certificate and two publisher connections are ready
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/route-sessions/{route_session_id}/ready (the `MarkRouteSessionReady` operationId).
	MarkRouteSessionReadyWithBody(ctx context.Context, routeSessionId RouteSessionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MarkRouteSessionReady Mark a route session ready after its certificate and two publisher connections are ready
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/route-sessions/{route_session_id}/ready (the `MarkRouteSessionReady` operationId).
	MarkRouteSessionReady(ctx context.Context, routeSessionId RouteSessionID, body MarkRouteSessionReadyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListRoutes List routes for one team
	//
	// Corresponds with GET /v1/routes (the `ListRoutes` operationId).
	ListRoutes(ctx context.Context, params *ListRoutesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRouteWithBody Create one team route
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/routes (the `CreateRoute` operationId).
	CreateRouteWithBody(ctx context.Context, params *CreateRouteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRoute Create one team route
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/routes (the `CreateRoute` operationId).
	CreateRoute(ctx context.Context, params *CreateRouteParams, body CreateRouteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteRoute Delete one route and close its route session
	//
	// Corresponds with DELETE /v1/routes/{route_id} (the `DeleteRoute` operationId).
	DeleteRoute(ctx context.Context, routeId RouteID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRoute Read one route
	//
	// Corresponds with GET /v1/routes/{route_id} (the `GetRoute` operationId).
	GetRoute(ctx context.Context, routeId RouteID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateRouteWithBody Update a route's target and IP policy
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /v1/routes/{route_id} (the `UpdateRoute` operationId).
	UpdateRouteWithBody(ctx context.Context, routeId RouteID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateRoute Update a route's target and IP policy
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /v1/routes/{route_id} (the `UpdateRoute` operationId).
	UpdateRoute(ctx context.Context, routeId RouteID, body UpdateRouteJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRouteSession Create a route session and allocate its route version
	//
	// Corresponds with POST /v1/routes/{route_id}/sessions (the `CreateRouteSession` operationId).
	CreateRouteSession(ctx context.Context, routeId RouteID, params *CreateRouteSessionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDNSAuthorityWithBody Create a DNS authority for one claimed domain
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/service/dns-authorities (the `CreateDNSAuthority` operationId).
	CreateDNSAuthorityWithBody(ctx context.Context, params *CreateDNSAuthorityParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDNSAuthority Create a DNS authority for one claimed domain
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/service/dns-authorities (the `CreateDNSAuthority` operationId).
	CreateDNSAuthority(ctx context.Context, params *CreateDNSAuthorityParams, body CreateDNSAuthorityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReleaseDNSAuthority Begin releasing a claimed domain's DNS authority
	//
	// Corresponds with DELETE /v1/service/dns-authorities/{dns_authority_reference} (the `ReleaseDNSAuthority` operationId).
	ReleaseDNSAuthority(ctx context.Context, dnsAuthorityReference DNSAuthorityReference, params *ReleaseDNSAuthorityParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDNSAuthority Read a claimed domain's DNS authority
	//
	// Corresponds with GET /v1/service/dns-authorities/{dns_authority_reference} (the `GetDNSAuthority` operationId).
	GetDNSAuthority(ctx context.Context, dnsAuthorityReference DNSAuthorityReference, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RevokeHostedPolicyWithBody Apply a policy revision from the external authority and close affected route sessions
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/service/revoke (the `RevokeHostedPolicy` operationId).
	RevokeHostedPolicyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RevokeHostedPolicy Apply a policy revision from the external authority and close affected route sessions
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/service/revoke (the `RevokeHostedPolicy` operationId).
	RevokeHostedPolicy(ctx context.Context, body RevokeHostedPolicyJSONRequestBody, 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) CloseRouteSessionWithResponse

func (c *ClientWithResponses) CloseRouteSessionWithResponse(ctx context.Context, routeSessionId RouteSessionID, reqEditors ...RequestEditorFn) (*CloseRouteSessionResponse, error)

CloseRouteSessionWithResponse Close and drain a route session without deleting its route

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

Corresponds with DELETE /v1/route-sessions/{route_session_id} (the `CloseRouteSession` operationId).

func (*ClientWithResponses) CreateCertificateIssuanceWithBodyWithResponse

func (c *ClientWithResponses) CreateCertificateIssuanceWithBodyWithResponse(ctx context.Context, routeSessionId RouteSessionID, params *CreateCertificateIssuanceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCertificateIssuanceResponse, error)

CreateCertificateIssuanceWithBodyWithResponse Begin issuance for the route session's certificate plan

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/route-sessions/{route_session_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).

func (*ClientWithResponses) CreateCertificateIssuanceWithResponse

CreateCertificateIssuanceWithResponse Begin issuance for the route session's certificate plan

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/route-sessions/{route_session_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).

func (*ClientWithResponses) CreateDNSAuthorityWithBodyWithResponse

func (c *ClientWithResponses) CreateDNSAuthorityWithBodyWithResponse(ctx context.Context, params *CreateDNSAuthorityParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDNSAuthorityResponse, error)

CreateDNSAuthorityWithBodyWithResponse Create a DNS authority for one claimed 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/service/dns-authorities (the `CreateDNSAuthority` operationId).

func (*ClientWithResponses) CreateDNSAuthorityWithResponse

CreateDNSAuthorityWithResponse Create a DNS authority for one claimed 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/service/dns-authorities (the `CreateDNSAuthority` operationId).

func (*ClientWithResponses) CreateRouteSessionWithResponse

func (c *ClientWithResponses) CreateRouteSessionWithResponse(ctx context.Context, routeId RouteID, params *CreateRouteSessionParams, reqEditors ...RequestEditorFn) (*CreateRouteSessionResponse, error)

CreateRouteSessionWithResponse Create a route session and allocate its route version

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

Corresponds with POST /v1/routes/{route_id}/sessions (the `CreateRouteSession` operationId).

func (*ClientWithResponses) CreateRouteWithBodyWithResponse

func (c *ClientWithResponses) CreateRouteWithBodyWithResponse(ctx context.Context, params *CreateRouteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRouteResponse, error)

CreateRouteWithBodyWithResponse Create one team route

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/routes (the `CreateRoute` operationId).

func (*ClientWithResponses) CreateRouteWithResponse

func (c *ClientWithResponses) CreateRouteWithResponse(ctx context.Context, params *CreateRouteParams, body CreateRouteJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRouteResponse, error)

CreateRouteWithResponse Create one team route

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/routes (the `CreateRoute` operationId).

func (*ClientWithResponses) DeleteRouteWithResponse

func (c *ClientWithResponses) DeleteRouteWithResponse(ctx context.Context, routeId RouteID, reqEditors ...RequestEditorFn) (*DeleteRouteResponse, error)

DeleteRouteWithResponse Delete one route and close its route session

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

Corresponds with DELETE /v1/routes/{route_id} (the `DeleteRoute` operationId).

func (*ClientWithResponses) DrainAdminRelayWithBodyWithResponse

func (c *ClientWithResponses) DrainAdminRelayWithBodyWithResponse(ctx context.Context, relayId RelayID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DrainAdminRelayResponse, error)

DrainAdminRelayWithBodyWithResponse Remove a matching relay lease from placement and begin draining

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/admin/relays/{relay_id}/drain (the `DrainAdminRelay` operationId).

func (*ClientWithResponses) DrainAdminRelayWithResponse

func (c *ClientWithResponses) DrainAdminRelayWithResponse(ctx context.Context, relayId RelayID, body DrainAdminRelayJSONRequestBody, reqEditors ...RequestEditorFn) (*DrainAdminRelayResponse, error)

DrainAdminRelayWithResponse Remove a matching relay lease from placement and begin draining

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/admin/relays/{relay_id}/drain (the `DrainAdminRelay` operationId).

func (*ClientWithResponses) GetAdminServerStatusWithResponse

func (c *ClientWithResponses) GetAdminServerStatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAdminServerStatusResponse, error)

GetAdminServerStatusWithResponse Read control, ingress, and relay status

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

Corresponds with GET /v1/admin/status (the `GetAdminServerStatus` operationId).

func (*ClientWithResponses) GetCertificateIssuanceWithResponse

func (c *ClientWithResponses) GetCertificateIssuanceWithResponse(ctx context.Context, issuanceId IssuanceID, reqEditors ...RequestEditorFn) (*GetCertificateIssuanceResponse, error)

GetCertificateIssuanceWithResponse Read one route-session certificate issuance

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

Corresponds with GET /v1/certificate-issuances/{issuance_id} (the `GetCertificateIssuance` operationId).

func (*ClientWithResponses) GetClientIPWithResponse

func (c *ClientWithResponses) GetClientIPWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetClientIPResponse, error)

GetClientIPWithResponse Return the requesting client's public IP address

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

Corresponds with GET /v1/client-ip (the `GetClientIP` operationId).

func (*ClientWithResponses) GetControlDiscoveryWithResponse

func (c *ClientWithResponses) GetControlDiscoveryWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetControlDiscoveryResponse, error)

GetControlDiscoveryWithResponse Describe control and its authentication methods

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

Corresponds with GET /v1/discovery (the `GetControlDiscovery` operationId).

func (*ClientWithResponses) GetDNSAuthorityWithResponse

func (c *ClientWithResponses) GetDNSAuthorityWithResponse(ctx context.Context, dnsAuthorityReference DNSAuthorityReference, reqEditors ...RequestEditorFn) (*GetDNSAuthorityResponse, error)

GetDNSAuthorityWithResponse Read a claimed domain's DNS authority

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

Corresponds with GET /v1/service/dns-authorities/{dns_authority_reference} (the `GetDNSAuthority` operationId).

func (*ClientWithResponses) GetHealthWithResponse

func (c *ClientWithResponses) GetHealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHealthResponse, error)

GetHealthWithResponse Confirm that the control HTTP server is serving

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

Corresponds with GET /v1/health (the `GetHealth` operationId).

func (*ClientWithResponses) GetReadinessWithResponse

func (c *ClientWithResponses) GetReadinessWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetReadinessResponse, error)

GetReadinessWithResponse Confirm that control and its database are ready

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

Corresponds with GET /v1/ready (the `GetReadiness` operationId).

func (*ClientWithResponses) GetRouteWithResponse

func (c *ClientWithResponses) GetRouteWithResponse(ctx context.Context, routeId RouteID, reqEditors ...RequestEditorFn) (*GetRouteResponse, error)

GetRouteWithResponse Read one route

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

Corresponds with GET /v1/routes/{route_id} (the `GetRoute` operationId).

func (*ClientWithResponses) HeartbeatRouteSessionWithBodyWithResponse

func (c *ClientWithResponses) HeartbeatRouteSessionWithBodyWithResponse(ctx context.Context, routeSessionId RouteSessionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*HeartbeatRouteSessionResponse, error)

HeartbeatRouteSessionWithBodyWithResponse Renew a route session and replace missing publisher connections

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/route-sessions/{route_session_id}/heartbeat (the `HeartbeatRouteSession` operationId).

func (*ClientWithResponses) HeartbeatRouteSessionWithResponse

func (c *ClientWithResponses) HeartbeatRouteSessionWithResponse(ctx context.Context, routeSessionId RouteSessionID, body HeartbeatRouteSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*HeartbeatRouteSessionResponse, error)

HeartbeatRouteSessionWithResponse Renew a route session and replace missing publisher connections

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/route-sessions/{route_session_id}/heartbeat (the `HeartbeatRouteSession` operationId).

func (*ClientWithResponses) ListAdminRelaysWithResponse

func (c *ClientWithResponses) ListAdminRelaysWithResponse(ctx context.Context, params *ListAdminRelaysParams, reqEditors ...RequestEditorFn) (*ListAdminRelaysResponse, error)

ListAdminRelaysWithResponse List relay leases

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

Corresponds with GET /v1/admin/relays (the `ListAdminRelays` operationId).

func (*ClientWithResponses) ListMaintenanceControlsWithResponse

func (c *ClientWithResponses) ListMaintenanceControlsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListMaintenanceControlsResponse, error)

ListMaintenanceControlsWithResponse List maintenance controls

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

Corresponds with GET /v1/admin/maintenance-controls (the `ListMaintenanceControls` operationId).

func (*ClientWithResponses) ListRoutesWithResponse

func (c *ClientWithResponses) ListRoutesWithResponse(ctx context.Context, params *ListRoutesParams, reqEditors ...RequestEditorFn) (*ListRoutesResponse, error)

ListRoutesWithResponse List routes for one team

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

Corresponds with GET /v1/routes (the `ListRoutes` operationId).

func (*ClientWithResponses) MarkCertificateChallengeReadyWithResponse

func (c *ClientWithResponses) MarkCertificateChallengeReadyWithResponse(ctx context.Context, issuanceId IssuanceID, reqEditors ...RequestEditorFn) (*MarkCertificateChallengeReadyResponse, error)

MarkCertificateChallengeReadyWithResponse Confirm a TLS-ALPN-01 challenge is installed

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

Corresponds with POST /v1/certificate-issuances/{issuance_id}/challenge-ready (the `MarkCertificateChallengeReady` operationId).

func (*ClientWithResponses) MarkCertificateChallengeRemovedWithResponse

func (c *ClientWithResponses) MarkCertificateChallengeRemovedWithResponse(ctx context.Context, issuanceId IssuanceID, reqEditors ...RequestEditorFn) (*MarkCertificateChallengeRemovedResponse, error)

MarkCertificateChallengeRemovedWithResponse Confirm a TLS-ALPN-01 challenge is removed

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

Corresponds with POST /v1/certificate-issuances/{issuance_id}/challenge-removed (the `MarkCertificateChallengeRemoved` operationId).

func (*ClientWithResponses) MarkRouteSessionCertificateInstalledWithBodyWithResponse

func (c *ClientWithResponses) MarkRouteSessionCertificateInstalledWithBodyWithResponse(ctx context.Context, routeSessionId RouteSessionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MarkRouteSessionCertificateInstalledResponse, error)

MarkRouteSessionCertificateInstalledWithBodyWithResponse Record installation of the current route certificate

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/route-sessions/{route_session_id}/certificate-installed (the `MarkRouteSessionCertificateInstalled` operationId).

func (*ClientWithResponses) MarkRouteSessionCertificateInstalledWithResponse

func (c *ClientWithResponses) MarkRouteSessionCertificateInstalledWithResponse(ctx context.Context, routeSessionId RouteSessionID, body MarkRouteSessionCertificateInstalledJSONRequestBody, reqEditors ...RequestEditorFn) (*MarkRouteSessionCertificateInstalledResponse, error)

MarkRouteSessionCertificateInstalledWithResponse Record installation of the current route certificate

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/route-sessions/{route_session_id}/certificate-installed (the `MarkRouteSessionCertificateInstalled` operationId).

func (*ClientWithResponses) MarkRouteSessionReadyWithBodyWithResponse

func (c *ClientWithResponses) MarkRouteSessionReadyWithBodyWithResponse(ctx context.Context, routeSessionId RouteSessionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MarkRouteSessionReadyResponse, error)

MarkRouteSessionReadyWithBodyWithResponse Mark a route session ready after its certificate and two publisher connections are ready

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/route-sessions/{route_session_id}/ready (the `MarkRouteSessionReady` operationId).

func (*ClientWithResponses) MarkRouteSessionReadyWithResponse

func (c *ClientWithResponses) MarkRouteSessionReadyWithResponse(ctx context.Context, routeSessionId RouteSessionID, body MarkRouteSessionReadyJSONRequestBody, reqEditors ...RequestEditorFn) (*MarkRouteSessionReadyResponse, error)

MarkRouteSessionReadyWithResponse Mark a route session ready after its certificate and two publisher connections are ready

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/route-sessions/{route_session_id}/ready (the `MarkRouteSessionReady` operationId).

func (*ClientWithResponses) ReleaseDNSAuthorityWithResponse

func (c *ClientWithResponses) ReleaseDNSAuthorityWithResponse(ctx context.Context, dnsAuthorityReference DNSAuthorityReference, params *ReleaseDNSAuthorityParams, reqEditors ...RequestEditorFn) (*ReleaseDNSAuthorityResponse, error)

ReleaseDNSAuthorityWithResponse Begin releasing a claimed domain's DNS authority

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

Corresponds with DELETE /v1/service/dns-authorities/{dns_authority_reference} (the `ReleaseDNSAuthority` operationId).

func (*ClientWithResponses) RevokeHostedPolicyWithBodyWithResponse

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

RevokeHostedPolicyWithBodyWithResponse Apply a policy revision from the external authority and close affected route sessions

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/revoke (the `RevokeHostedPolicy` operationId).

func (*ClientWithResponses) RevokeHostedPolicyWithResponse

func (c *ClientWithResponses) RevokeHostedPolicyWithResponse(ctx context.Context, body RevokeHostedPolicyJSONRequestBody, reqEditors ...RequestEditorFn) (*RevokeHostedPolicyResponse, error)

RevokeHostedPolicyWithResponse Apply a policy revision from the external authority and close affected route sessions

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/revoke (the `RevokeHostedPolicy` operationId).

func (*ClientWithResponses) SetMaintenanceControlWithBodyWithResponse

func (c *ClientWithResponses) SetMaintenanceControlWithBodyWithResponse(ctx context.Context, controlName MaintenanceControlName, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetMaintenanceControlResponse, error)

SetMaintenanceControlWithBodyWithResponse Set one maintenance control

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

Corresponds with PUT /v1/admin/maintenance-controls/{control_name} (the `SetMaintenanceControl` operationId).

func (*ClientWithResponses) SetMaintenanceControlWithResponse

func (c *ClientWithResponses) SetMaintenanceControlWithResponse(ctx context.Context, controlName MaintenanceControlName, body SetMaintenanceControlJSONRequestBody, reqEditors ...RequestEditorFn) (*SetMaintenanceControlResponse, error)

SetMaintenanceControlWithResponse Set one maintenance control

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

Corresponds with PUT /v1/admin/maintenance-controls/{control_name} (the `SetMaintenanceControl` operationId).

func (*ClientWithResponses) UpdateRouteWithBodyWithResponse

func (c *ClientWithResponses) UpdateRouteWithBodyWithResponse(ctx context.Context, routeId RouteID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRouteResponse, error)

UpdateRouteWithBodyWithResponse Update a route's target and IP policy

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/routes/{route_id} (the `UpdateRoute` operationId).

func (*ClientWithResponses) UpdateRouteWithResponse

func (c *ClientWithResponses) UpdateRouteWithResponse(ctx context.Context, routeId RouteID, body UpdateRouteJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRouteResponse, error)

UpdateRouteWithResponse Update a route's target and IP policy

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/routes/{route_id} (the `UpdateRoute` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// ListMaintenanceControlsWithResponse List maintenance controls
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/admin/maintenance-controls (the `ListMaintenanceControls` operationId).
	ListMaintenanceControlsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListMaintenanceControlsResponse, error)

	// SetMaintenanceControlWithBodyWithResponse Set one maintenance control
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /v1/admin/maintenance-controls/{control_name} (the `SetMaintenanceControl` operationId).
	SetMaintenanceControlWithBodyWithResponse(ctx context.Context, controlName MaintenanceControlName, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetMaintenanceControlResponse, error)

	// SetMaintenanceControlWithResponse Set one maintenance control
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /v1/admin/maintenance-controls/{control_name} (the `SetMaintenanceControl` operationId).
	SetMaintenanceControlWithResponse(ctx context.Context, controlName MaintenanceControlName, body SetMaintenanceControlJSONRequestBody, reqEditors ...RequestEditorFn) (*SetMaintenanceControlResponse, error)

	// ListAdminRelaysWithResponse List relay leases
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/admin/relays (the `ListAdminRelays` operationId).
	ListAdminRelaysWithResponse(ctx context.Context, params *ListAdminRelaysParams, reqEditors ...RequestEditorFn) (*ListAdminRelaysResponse, error)

	// DrainAdminRelayWithBodyWithResponse Remove a matching relay lease from placement and begin draining
	//
	// 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/admin/relays/{relay_id}/drain (the `DrainAdminRelay` operationId).
	DrainAdminRelayWithBodyWithResponse(ctx context.Context, relayId RelayID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DrainAdminRelayResponse, error)

	// DrainAdminRelayWithResponse Remove a matching relay lease from placement and begin draining
	//
	// 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/admin/relays/{relay_id}/drain (the `DrainAdminRelay` operationId).
	DrainAdminRelayWithResponse(ctx context.Context, relayId RelayID, body DrainAdminRelayJSONRequestBody, reqEditors ...RequestEditorFn) (*DrainAdminRelayResponse, error)

	// GetAdminServerStatusWithResponse Read control, ingress, and relay status
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/admin/status (the `GetAdminServerStatus` operationId).
	GetAdminServerStatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAdminServerStatusResponse, error)

	// GetCertificateIssuanceWithResponse Read one route-session certificate issuance
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/certificate-issuances/{issuance_id} (the `GetCertificateIssuance` operationId).
	GetCertificateIssuanceWithResponse(ctx context.Context, issuanceId IssuanceID, reqEditors ...RequestEditorFn) (*GetCertificateIssuanceResponse, error)

	// MarkCertificateChallengeReadyWithResponse Confirm a TLS-ALPN-01 challenge is installed
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/certificate-issuances/{issuance_id}/challenge-ready (the `MarkCertificateChallengeReady` operationId).
	MarkCertificateChallengeReadyWithResponse(ctx context.Context, issuanceId IssuanceID, reqEditors ...RequestEditorFn) (*MarkCertificateChallengeReadyResponse, error)

	// MarkCertificateChallengeRemovedWithResponse Confirm a TLS-ALPN-01 challenge is removed
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/certificate-issuances/{issuance_id}/challenge-removed (the `MarkCertificateChallengeRemoved` operationId).
	MarkCertificateChallengeRemovedWithResponse(ctx context.Context, issuanceId IssuanceID, reqEditors ...RequestEditorFn) (*MarkCertificateChallengeRemovedResponse, error)

	// GetClientIPWithResponse Return the requesting client's public IP address
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/client-ip (the `GetClientIP` operationId).
	GetClientIPWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetClientIPResponse, error)

	// GetControlDiscoveryWithResponse Describe control and its authentication methods
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/discovery (the `GetControlDiscovery` operationId).
	GetControlDiscoveryWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetControlDiscoveryResponse, error)

	// GetHealthWithResponse Confirm that the control HTTP server is serving
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/health (the `GetHealth` operationId).
	GetHealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHealthResponse, error)

	// GetReadinessWithResponse Confirm that control and its database are ready
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/ready (the `GetReadiness` operationId).
	GetReadinessWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetReadinessResponse, error)

	// CloseRouteSessionWithResponse Close and drain a route session without deleting its route
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /v1/route-sessions/{route_session_id} (the `CloseRouteSession` operationId).
	CloseRouteSessionWithResponse(ctx context.Context, routeSessionId RouteSessionID, reqEditors ...RequestEditorFn) (*CloseRouteSessionResponse, error)

	// MarkRouteSessionCertificateInstalledWithBodyWithResponse Record installation of the current route certificate
	//
	// 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/route-sessions/{route_session_id}/certificate-installed (the `MarkRouteSessionCertificateInstalled` operationId).
	MarkRouteSessionCertificateInstalledWithBodyWithResponse(ctx context.Context, routeSessionId RouteSessionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MarkRouteSessionCertificateInstalledResponse, error)

	// MarkRouteSessionCertificateInstalledWithResponse Record installation of the current route certificate
	//
	// 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/route-sessions/{route_session_id}/certificate-installed (the `MarkRouteSessionCertificateInstalled` operationId).
	MarkRouteSessionCertificateInstalledWithResponse(ctx context.Context, routeSessionId RouteSessionID, body MarkRouteSessionCertificateInstalledJSONRequestBody, reqEditors ...RequestEditorFn) (*MarkRouteSessionCertificateInstalledResponse, error)

	// CreateCertificateIssuanceWithBodyWithResponse Begin issuance for the route session's certificate plan
	//
	// 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/route-sessions/{route_session_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).
	CreateCertificateIssuanceWithBodyWithResponse(ctx context.Context, routeSessionId RouteSessionID, params *CreateCertificateIssuanceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCertificateIssuanceResponse, error)

	// CreateCertificateIssuanceWithResponse Begin issuance for the route session's certificate plan
	//
	// 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/route-sessions/{route_session_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).
	CreateCertificateIssuanceWithResponse(ctx context.Context, routeSessionId RouteSessionID, params *CreateCertificateIssuanceParams, body CreateCertificateIssuanceJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCertificateIssuanceResponse, error)

	// HeartbeatRouteSessionWithBodyWithResponse Renew a route session and replace missing publisher connections
	//
	// 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/route-sessions/{route_session_id}/heartbeat (the `HeartbeatRouteSession` operationId).
	HeartbeatRouteSessionWithBodyWithResponse(ctx context.Context, routeSessionId RouteSessionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*HeartbeatRouteSessionResponse, error)

	// HeartbeatRouteSessionWithResponse Renew a route session and replace missing publisher connections
	//
	// 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/route-sessions/{route_session_id}/heartbeat (the `HeartbeatRouteSession` operationId).
	HeartbeatRouteSessionWithResponse(ctx context.Context, routeSessionId RouteSessionID, body HeartbeatRouteSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*HeartbeatRouteSessionResponse, error)

	// MarkRouteSessionReadyWithBodyWithResponse Mark a route session ready after its certificate and two publisher connections are ready
	//
	// 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/route-sessions/{route_session_id}/ready (the `MarkRouteSessionReady` operationId).
	MarkRouteSessionReadyWithBodyWithResponse(ctx context.Context, routeSessionId RouteSessionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MarkRouteSessionReadyResponse, error)

	// MarkRouteSessionReadyWithResponse Mark a route session ready after its certificate and two publisher connections are ready
	//
	// 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/route-sessions/{route_session_id}/ready (the `MarkRouteSessionReady` operationId).
	MarkRouteSessionReadyWithResponse(ctx context.Context, routeSessionId RouteSessionID, body MarkRouteSessionReadyJSONRequestBody, reqEditors ...RequestEditorFn) (*MarkRouteSessionReadyResponse, error)

	// ListRoutesWithResponse List routes for one team
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/routes (the `ListRoutes` operationId).
	ListRoutesWithResponse(ctx context.Context, params *ListRoutesParams, reqEditors ...RequestEditorFn) (*ListRoutesResponse, error)

	// CreateRouteWithBodyWithResponse Create one team route
	//
	// 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/routes (the `CreateRoute` operationId).
	CreateRouteWithBodyWithResponse(ctx context.Context, params *CreateRouteParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRouteResponse, error)

	// CreateRouteWithResponse Create one team route
	//
	// 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/routes (the `CreateRoute` operationId).
	CreateRouteWithResponse(ctx context.Context, params *CreateRouteParams, body CreateRouteJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRouteResponse, error)

	// DeleteRouteWithResponse Delete one route and close its route session
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /v1/routes/{route_id} (the `DeleteRoute` operationId).
	DeleteRouteWithResponse(ctx context.Context, routeId RouteID, reqEditors ...RequestEditorFn) (*DeleteRouteResponse, error)

	// GetRouteWithResponse Read one route
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/routes/{route_id} (the `GetRoute` operationId).
	GetRouteWithResponse(ctx context.Context, routeId RouteID, reqEditors ...RequestEditorFn) (*GetRouteResponse, error)

	// UpdateRouteWithBodyWithResponse Update a route's target and IP policy
	//
	// 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/routes/{route_id} (the `UpdateRoute` operationId).
	UpdateRouteWithBodyWithResponse(ctx context.Context, routeId RouteID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateRouteResponse, error)

	// UpdateRouteWithResponse Update a route's target and IP policy
	//
	// 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/routes/{route_id} (the `UpdateRoute` operationId).
	UpdateRouteWithResponse(ctx context.Context, routeId RouteID, body UpdateRouteJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateRouteResponse, error)

	// CreateRouteSessionWithResponse Create a route session and allocate its route version
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/routes/{route_id}/sessions (the `CreateRouteSession` operationId).
	CreateRouteSessionWithResponse(ctx context.Context, routeId RouteID, params *CreateRouteSessionParams, reqEditors ...RequestEditorFn) (*CreateRouteSessionResponse, error)

	// CreateDNSAuthorityWithBodyWithResponse Create a DNS authority for one claimed 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/service/dns-authorities (the `CreateDNSAuthority` operationId).
	CreateDNSAuthorityWithBodyWithResponse(ctx context.Context, params *CreateDNSAuthorityParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDNSAuthorityResponse, error)

	// CreateDNSAuthorityWithResponse Create a DNS authority for one claimed 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/service/dns-authorities (the `CreateDNSAuthority` operationId).
	CreateDNSAuthorityWithResponse(ctx context.Context, params *CreateDNSAuthorityParams, body CreateDNSAuthorityJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateDNSAuthorityResponse, error)

	// ReleaseDNSAuthorityWithResponse Begin releasing a claimed domain's DNS authority
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /v1/service/dns-authorities/{dns_authority_reference} (the `ReleaseDNSAuthority` operationId).
	ReleaseDNSAuthorityWithResponse(ctx context.Context, dnsAuthorityReference DNSAuthorityReference, params *ReleaseDNSAuthorityParams, reqEditors ...RequestEditorFn) (*ReleaseDNSAuthorityResponse, error)

	// GetDNSAuthorityWithResponse Read a claimed domain's DNS authority
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/service/dns-authorities/{dns_authority_reference} (the `GetDNSAuthority` operationId).
	GetDNSAuthorityWithResponse(ctx context.Context, dnsAuthorityReference DNSAuthorityReference, reqEditors ...RequestEditorFn) (*GetDNSAuthorityResponse, error)

	// RevokeHostedPolicyWithBodyWithResponse Apply a policy revision from the external authority and close affected route sessions
	//
	// 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/revoke (the `RevokeHostedPolicy` operationId).
	RevokeHostedPolicyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RevokeHostedPolicyResponse, error)

	// RevokeHostedPolicyWithResponse Apply a policy revision from the external authority and close affected route sessions
	//
	// 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/revoke (the `RevokeHostedPolicy` operationId).
	RevokeHostedPolicyWithResponse(ctx context.Context, body RevokeHostedPolicyJSONRequestBody, reqEditors ...RequestEditorFn) (*RevokeHostedPolicyResponse, error)
}

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

type CloseRouteSessionResponse

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

func ParseCloseRouteSessionResponse

func ParseCloseRouteSessionResponse(rsp *http.Response) (*CloseRouteSessionResponse, error)

ParseCloseRouteSessionResponse parses an HTTP response from a CloseRouteSessionWithResponse call

func (CloseRouteSessionResponse) ContentType

func (r CloseRouteSessionResponse) ContentType() string

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

func (CloseRouteSessionResponse) GetApplicationproblemJSONDefault

func (r CloseRouteSessionResponse) GetApplicationproblemJSONDefault() *Problem

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

func (CloseRouteSessionResponse) GetBody

func (r CloseRouteSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CloseRouteSessionResponse) Status

func (r CloseRouteSessionResponse) Status() string

Status returns HTTPResponse.Status

func (CloseRouteSessionResponse) StatusCode

func (r CloseRouteSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ConnectionAssignment

type ConnectionAssignment struct {
	ConnectionAssignmentRevision           int64                    `json:"connection_assignment_revision"`
	ConnectionSlot                         int                      `json:"connection_slot"`
	PublisherConnectionCredential          string                   `json:"publisher_connection_credential"`
	PublisherConnectionCredentialExpiresAt time.Time                `json:"publisher_connection_credential_expires_at"`
	PublisherConnectionId                  PublisherConnectionID    `json:"publisher_connection_id"`
	RelayAddress                           string                   `json:"relay_address"`
	RelayServiceId                         RelayServiceID           `json:"relay_service_id"`
	State                                  PublisherConnectionState `json:"state"`
	TlsServerName                          CanonicalHostname        `json:"tls_server_name"`
}

ConnectionAssignment defines model for ConnectionAssignment.

type ControlDiscovery

type ControlDiscovery struct {
	Authentication          AuthenticationFacts `json:"authentication"`
	AuthorityEndpoint       string              `json:"authority_endpoint"`
	DnsAutomation           bool                `json:"dns_automation"`
	ManagedDeploymentDomain CanonicalHostname   `json:"managed_deployment_domain"`
}

ControlDiscovery defines model for ControlDiscovery.

type CreateCertificateIssuanceJSONRequestBody

type CreateCertificateIssuanceJSONRequestBody = CreateCertificateIssuanceRequest

CreateCertificateIssuanceJSONRequestBody defines body for CreateCertificateIssuance for application/json ContentType.

type CreateCertificateIssuanceParams

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

CreateCertificateIssuanceParams defines parameters for CreateCertificateIssuance.

type CreateCertificateIssuanceRequest

type CreateCertificateIssuanceRequest struct {
	Csr          []byte `json:"csr"`
	RouteVersion int64  `json:"route_version"`
}

CreateCertificateIssuanceRequest defines model for CreateCertificateIssuanceRequest.

type CreateCertificateIssuanceResponse

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

func ParseCreateCertificateIssuanceResponse

func ParseCreateCertificateIssuanceResponse(rsp *http.Response) (*CreateCertificateIssuanceResponse, error)

ParseCreateCertificateIssuanceResponse parses an HTTP response from a CreateCertificateIssuanceWithResponse call

func (CreateCertificateIssuanceResponse) ContentType

func (r CreateCertificateIssuanceResponse) ContentType() string

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

func (CreateCertificateIssuanceResponse) GetApplicationproblemJSONDefault

func (r CreateCertificateIssuanceResponse) GetApplicationproblemJSONDefault() *Problem

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

func (CreateCertificateIssuanceResponse) GetBody

GetBody returns the raw response body bytes

func (CreateCertificateIssuanceResponse) GetJSON201

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

func (CreateCertificateIssuanceResponse) Status

Status returns HTTPResponse.Status

func (CreateCertificateIssuanceResponse) StatusCode

func (r CreateCertificateIssuanceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDNSAuthorityJSONRequestBody

type CreateDNSAuthorityJSONRequestBody = CreateDNSAuthorityRequest

CreateDNSAuthorityJSONRequestBody defines body for CreateDNSAuthority for application/json ContentType.

type CreateDNSAuthorityParams

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

CreateDNSAuthorityParams defines parameters for CreateDNSAuthority.

type CreateDNSAuthorityRequest

type CreateDNSAuthorityRequest struct {
	CanonicalDomain CanonicalHostname `json:"canonical_domain"`
	DomainId        DomainID          `json:"domain_id"`
	TeamId          TeamID            `json:"team_id"`
}

CreateDNSAuthorityRequest defines model for CreateDNSAuthorityRequest.

type CreateDNSAuthorityResponse

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

func ParseCreateDNSAuthorityResponse

func ParseCreateDNSAuthorityResponse(rsp *http.Response) (*CreateDNSAuthorityResponse, error)

ParseCreateDNSAuthorityResponse parses an HTTP response from a CreateDNSAuthorityWithResponse call

func (CreateDNSAuthorityResponse) ContentType

func (r CreateDNSAuthorityResponse) ContentType() string

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

func (CreateDNSAuthorityResponse) GetApplicationproblemJSONDefault

func (r CreateDNSAuthorityResponse) GetApplicationproblemJSONDefault() *Problem

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

func (CreateDNSAuthorityResponse) GetBody

func (r CreateDNSAuthorityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateDNSAuthorityResponse) GetJSON201

func (r CreateDNSAuthorityResponse) GetJSON201() *DNSAuthority

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

func (CreateDNSAuthorityResponse) Status

Status returns HTTPResponse.Status

func (CreateDNSAuthorityResponse) StatusCode

func (r CreateDNSAuthorityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateRouteJSONRequestBody

type CreateRouteJSONRequestBody = CreateRouteRequest

CreateRouteJSONRequestBody defines body for CreateRoute for application/json ContentType.

type CreateRouteParams

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

CreateRouteParams defines parameters for CreateRoute.

type CreateRouteRequest

type CreateRouteRequest struct {
	AllowedIpPrefixes *[]string         `json:"allowed_ip_prefixes,omitempty"`
	CanonicalHostname CanonicalHostname `json:"canonical_hostname"`
	DomainId          DomainID          `json:"domain_id"`
	Ephemeral         *bool             `json:"ephemeral,omitempty"`
	MembershipId      *MembershipID     `json:"membership_id,omitempty"`
	RouteScope        RouteScope        `json:"route_scope"`
	Target            string            `json:"target"`
	TeamId            TeamID            `json:"team_id"`
}

CreateRouteRequest defines model for CreateRouteRequest.

type CreateRouteResponse

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

func ParseCreateRouteResponse

func ParseCreateRouteResponse(rsp *http.Response) (*CreateRouteResponse, error)

ParseCreateRouteResponse parses an HTTP response from a CreateRouteWithResponse call

func (CreateRouteResponse) ContentType

func (r CreateRouteResponse) ContentType() string

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

func (CreateRouteResponse) GetApplicationproblemJSONDefault

func (r CreateRouteResponse) GetApplicationproblemJSONDefault() *Problem

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

func (CreateRouteResponse) GetBody

func (r CreateRouteResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateRouteResponse) GetJSON201

func (r CreateRouteResponse) GetJSON201() *Route

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

func (CreateRouteResponse) Status

func (r CreateRouteResponse) Status() string

Status returns HTTPResponse.Status

func (CreateRouteResponse) StatusCode

func (r CreateRouteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateRouteSessionParams

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

CreateRouteSessionParams defines parameters for CreateRouteSession.

type CreateRouteSessionResponse

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

func ParseCreateRouteSessionResponse

func ParseCreateRouteSessionResponse(rsp *http.Response) (*CreateRouteSessionResponse, error)

ParseCreateRouteSessionResponse parses an HTTP response from a CreateRouteSessionWithResponse call

func (CreateRouteSessionResponse) ContentType

func (r CreateRouteSessionResponse) ContentType() string

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

func (CreateRouteSessionResponse) GetApplicationproblemJSONDefault

func (r CreateRouteSessionResponse) GetApplicationproblemJSONDefault() *Problem

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

func (CreateRouteSessionResponse) GetBody

func (r CreateRouteSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateRouteSessionResponse) GetJSON201

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

func (CreateRouteSessionResponse) Status

Status returns HTTPResponse.Status

func (CreateRouteSessionResponse) StatusCode

func (r CreateRouteSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Cursor

type Cursor = ResourceID

Cursor defines model for Cursor.

type DNSAuthority

type DNSAuthority struct {
	CanonicalDomain CanonicalHostname `json:"canonical_domain"`
	CreatedAt       time.Time         `json:"created_at"`
	DomainId        DomainID          `json:"domain_id"`
	LastError       *string           `json:"last_error,omitempty"`
	Reference       string            `json:"reference"`
	RequiredRecords []DNSRecord       `json:"required_records"`
	State           DNSAuthorityState `json:"state"`
	TeamId          TeamID            `json:"team_id"`
	UpdatedAt       time.Time         `json:"updated_at"`
}

DNSAuthority defines model for DNSAuthority.

type DNSAuthorityReference

type DNSAuthorityReference = string

DNSAuthorityReference defines model for DNSAuthorityReference.

type DNSAuthorityState

type DNSAuthorityState string

DNSAuthorityState defines model for DNSAuthorityState.

const (
	DNSAuthorityStateFailed    DNSAuthorityState = "failed"
	DNSAuthorityStatePending   DNSAuthorityState = "pending"
	DNSAuthorityStateReady     DNSAuthorityState = "ready"
	DNSAuthorityStateReleased  DNSAuthorityState = "released"
	DNSAuthorityStateReleasing DNSAuthorityState = "releasing"
)

Defines values for DNSAuthorityState.

func (DNSAuthorityState) Valid

func (e DNSAuthorityState) Valid() bool

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

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"
	NS   DNSRecordType = "NS"
	SOA  DNSRecordType = "SOA"
	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 DeleteRouteResponse

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

func ParseDeleteRouteResponse

func ParseDeleteRouteResponse(rsp *http.Response) (*DeleteRouteResponse, error)

ParseDeleteRouteResponse parses an HTTP response from a DeleteRouteWithResponse call

func (DeleteRouteResponse) ContentType

func (r DeleteRouteResponse) ContentType() string

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

func (DeleteRouteResponse) GetApplicationproblemJSONDefault

func (r DeleteRouteResponse) GetApplicationproblemJSONDefault() *Problem

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

func (DeleteRouteResponse) GetBody

func (r DeleteRouteResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteRouteResponse) Status

func (r DeleteRouteResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteRouteResponse) StatusCode

func (r DeleteRouteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DomainID

type DomainID = ResourceID

DomainID defines model for DomainID.

type DrainAdminRelayJSONRequestBody

type DrainAdminRelayJSONRequestBody = AdminDrainRelayRequest

DrainAdminRelayJSONRequestBody defines body for DrainAdminRelay for application/json ContentType.

type DrainAdminRelayResponse

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

func ParseDrainAdminRelayResponse

func ParseDrainAdminRelayResponse(rsp *http.Response) (*DrainAdminRelayResponse, error)

ParseDrainAdminRelayResponse parses an HTTP response from a DrainAdminRelayWithResponse call

func (DrainAdminRelayResponse) ContentType

func (r DrainAdminRelayResponse) ContentType() string

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

func (DrainAdminRelayResponse) GetApplicationproblemJSONDefault

func (r DrainAdminRelayResponse) GetApplicationproblemJSONDefault() *Problem

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

func (DrainAdminRelayResponse) GetBody

func (r DrainAdminRelayResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DrainAdminRelayResponse) GetJSON200

func (r DrainAdminRelayResponse) GetJSON200() *AdminRelayLease

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

func (DrainAdminRelayResponse) Status

func (r DrainAdminRelayResponse) Status() string

Status returns HTTPResponse.Status

func (DrainAdminRelayResponse) StatusCode

func (r DrainAdminRelayResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAdminServerStatusResponse

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

func ParseGetAdminServerStatusResponse

func ParseGetAdminServerStatusResponse(rsp *http.Response) (*GetAdminServerStatusResponse, error)

ParseGetAdminServerStatusResponse parses an HTTP response from a GetAdminServerStatusWithResponse call

func (GetAdminServerStatusResponse) ContentType

func (r GetAdminServerStatusResponse) ContentType() string

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

func (GetAdminServerStatusResponse) GetApplicationproblemJSONDefault

func (r GetAdminServerStatusResponse) GetApplicationproblemJSONDefault() *Problem

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

func (GetAdminServerStatusResponse) GetBody

func (r GetAdminServerStatusResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetAdminServerStatusResponse) GetJSON200

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

func (GetAdminServerStatusResponse) Status

Status returns HTTPResponse.Status

func (GetAdminServerStatusResponse) StatusCode

func (r GetAdminServerStatusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCertificateIssuanceResponse

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

func ParseGetCertificateIssuanceResponse

func ParseGetCertificateIssuanceResponse(rsp *http.Response) (*GetCertificateIssuanceResponse, error)

ParseGetCertificateIssuanceResponse parses an HTTP response from a GetCertificateIssuanceWithResponse call

func (GetCertificateIssuanceResponse) ContentType

func (r GetCertificateIssuanceResponse) ContentType() string

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

func (GetCertificateIssuanceResponse) GetApplicationproblemJSONDefault

func (r GetCertificateIssuanceResponse) GetApplicationproblemJSONDefault() *Problem

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

func (GetCertificateIssuanceResponse) GetBody

func (r GetCertificateIssuanceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetCertificateIssuanceResponse) GetJSON200

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

func (GetCertificateIssuanceResponse) Status

Status returns HTTPResponse.Status

func (GetCertificateIssuanceResponse) StatusCode

func (r GetCertificateIssuanceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetClientIPResponse

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

func ParseGetClientIPResponse

func ParseGetClientIPResponse(rsp *http.Response) (*GetClientIPResponse, error)

ParseGetClientIPResponse parses an HTTP response from a GetClientIPWithResponse call

func (GetClientIPResponse) ContentType

func (r GetClientIPResponse) ContentType() string

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

func (GetClientIPResponse) GetApplicationproblemJSONDefault

func (r GetClientIPResponse) GetApplicationproblemJSONDefault() *Problem

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

func (GetClientIPResponse) GetBody

func (r GetClientIPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetClientIPResponse) GetJSON200

func (r GetClientIPResponse) GetJSON200() *ClientIPResponse

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

func (GetClientIPResponse) Status

func (r GetClientIPResponse) Status() string

Status returns HTTPResponse.Status

func (GetClientIPResponse) StatusCode

func (r GetClientIPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetControlDiscoveryResponse

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

func ParseGetControlDiscoveryResponse

func ParseGetControlDiscoveryResponse(rsp *http.Response) (*GetControlDiscoveryResponse, error)

ParseGetControlDiscoveryResponse parses an HTTP response from a GetControlDiscoveryWithResponse call

func (GetControlDiscoveryResponse) ContentType

func (r GetControlDiscoveryResponse) ContentType() string

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

func (GetControlDiscoveryResponse) GetApplicationproblemJSONDefault

func (r GetControlDiscoveryResponse) GetApplicationproblemJSONDefault() *Problem

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

func (GetControlDiscoveryResponse) GetBody

func (r GetControlDiscoveryResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetControlDiscoveryResponse) GetJSON200

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

func (GetControlDiscoveryResponse) Status

Status returns HTTPResponse.Status

func (GetControlDiscoveryResponse) StatusCode

func (r GetControlDiscoveryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDNSAuthorityResponse

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

func ParseGetDNSAuthorityResponse

func ParseGetDNSAuthorityResponse(rsp *http.Response) (*GetDNSAuthorityResponse, error)

ParseGetDNSAuthorityResponse parses an HTTP response from a GetDNSAuthorityWithResponse call

func (GetDNSAuthorityResponse) ContentType

func (r GetDNSAuthorityResponse) ContentType() string

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

func (GetDNSAuthorityResponse) GetApplicationproblemJSONDefault

func (r GetDNSAuthorityResponse) GetApplicationproblemJSONDefault() *Problem

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

func (GetDNSAuthorityResponse) GetBody

func (r GetDNSAuthorityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetDNSAuthorityResponse) GetJSON200

func (r GetDNSAuthorityResponse) GetJSON200() *DNSAuthority

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

func (GetDNSAuthorityResponse) Status

func (r GetDNSAuthorityResponse) Status() string

Status returns HTTPResponse.Status

func (GetDNSAuthorityResponse) StatusCode

func (r GetDNSAuthorityResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHealthResponse

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

func ParseGetHealthResponse

func ParseGetHealthResponse(rsp *http.Response) (*GetHealthResponse, error)

ParseGetHealthResponse parses an HTTP response from a GetHealthWithResponse call

func (GetHealthResponse) ContentType

func (r GetHealthResponse) ContentType() string

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

func (GetHealthResponse) GetApplicationproblemJSONDefault

func (r GetHealthResponse) GetApplicationproblemJSONDefault() *Problem

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

func (GetHealthResponse) GetBody

func (r GetHealthResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHealthResponse) GetJSON200

func (r GetHealthResponse) GetJSON200() *HealthResponse

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

func (GetHealthResponse) Status

func (r GetHealthResponse) Status() string

Status returns HTTPResponse.Status

func (GetHealthResponse) StatusCode

func (r GetHealthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetReadinessResponse

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

func ParseGetReadinessResponse

func ParseGetReadinessResponse(rsp *http.Response) (*GetReadinessResponse, error)

ParseGetReadinessResponse parses an HTTP response from a GetReadinessWithResponse call

func (GetReadinessResponse) ContentType

func (r GetReadinessResponse) ContentType() string

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

func (GetReadinessResponse) GetApplicationproblemJSONDefault

func (r GetReadinessResponse) GetApplicationproblemJSONDefault() *Problem

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

func (GetReadinessResponse) GetBody

func (r GetReadinessResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetReadinessResponse) GetJSON200

func (r GetReadinessResponse) GetJSON200() *ReadinessResponse

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

func (GetReadinessResponse) GetJSON503

func (r GetReadinessResponse) GetJSON503() *ReadinessResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetReadinessResponse) Status

func (r GetReadinessResponse) Status() string

Status returns HTTPResponse.Status

func (GetReadinessResponse) StatusCode

func (r GetReadinessResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRouteResponse

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

func ParseGetRouteResponse

func ParseGetRouteResponse(rsp *http.Response) (*GetRouteResponse, error)

ParseGetRouteResponse parses an HTTP response from a GetRouteWithResponse call

func (GetRouteResponse) ContentType

func (r GetRouteResponse) ContentType() string

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

func (GetRouteResponse) GetApplicationproblemJSONDefault

func (r GetRouteResponse) GetApplicationproblemJSONDefault() *Problem

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

func (GetRouteResponse) GetBody

func (r GetRouteResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetRouteResponse) GetJSON200

func (r GetRouteResponse) GetJSON200() *Route

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

func (GetRouteResponse) Status

func (r GetRouteResponse) Status() string

Status returns HTTPResponse.Status

func (GetRouteResponse) StatusCode

func (r GetRouteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HealthResponse

type HealthResponse struct {
	Status HealthResponseStatus `json:"status"`
}

HealthResponse defines model for HealthResponse.

type HealthResponseStatus

type HealthResponseStatus string

HealthResponseStatus defines model for HealthResponse.Status.

const (
	HealthResponseStatusOk HealthResponseStatus = "ok"
)

Defines values for HealthResponseStatus.

func (HealthResponseStatus) Valid

func (e HealthResponseStatus) Valid() bool

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

type HeartbeatRouteSessionJSONRequestBody

type HeartbeatRouteSessionJSONRequestBody = RouteSessionVersionRequest

HeartbeatRouteSessionJSONRequestBody defines body for HeartbeatRouteSession for application/json ContentType.

type HeartbeatRouteSessionResponse

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

func ParseHeartbeatRouteSessionResponse

func ParseHeartbeatRouteSessionResponse(rsp *http.Response) (*HeartbeatRouteSessionResponse, error)

ParseHeartbeatRouteSessionResponse parses an HTTP response from a HeartbeatRouteSessionWithResponse call

func (HeartbeatRouteSessionResponse) ContentType

func (r HeartbeatRouteSessionResponse) ContentType() string

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

func (HeartbeatRouteSessionResponse) GetApplicationproblemJSONDefault

func (r HeartbeatRouteSessionResponse) GetApplicationproblemJSONDefault() *Problem

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

func (HeartbeatRouteSessionResponse) GetBody

func (r HeartbeatRouteSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (HeartbeatRouteSessionResponse) GetJSON200

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

func (HeartbeatRouteSessionResponse) Status

Status returns HTTPResponse.Status

func (HeartbeatRouteSessionResponse) StatusCode

func (r HeartbeatRouteSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HostedPolicyRevocation

type HostedPolicyRevocation struct {
	AllSessions    bool           `json:"all_sessions"`
	DomainIds      []DomainID     `json:"domain_ids"`
	MembershipIds  []MembershipID `json:"membership_ids"`
	PolicyRevision int64          `json:"policy_revision"`
	TeamId         TeamID         `json:"team_id"`
}

HostedPolicyRevocation defines model for HostedPolicyRevocation.

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 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 IssuanceID

type IssuanceID = ResourceID

IssuanceID defines model for IssuanceID.

type ListAdminRelaysParams

type ListAdminRelaysParams struct {
	Cursor *Cursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListAdminRelaysParams defines parameters for ListAdminRelays.

type ListAdminRelaysResponse

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

func ParseListAdminRelaysResponse

func ParseListAdminRelaysResponse(rsp *http.Response) (*ListAdminRelaysResponse, error)

ParseListAdminRelaysResponse parses an HTTP response from a ListAdminRelaysWithResponse call

func (ListAdminRelaysResponse) ContentType

func (r ListAdminRelaysResponse) ContentType() string

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

func (ListAdminRelaysResponse) GetApplicationproblemJSONDefault

func (r ListAdminRelaysResponse) GetApplicationproblemJSONDefault() *Problem

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

func (ListAdminRelaysResponse) GetBody

func (r ListAdminRelaysResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListAdminRelaysResponse) GetJSON200

func (r ListAdminRelaysResponse) GetJSON200() *AdminRelayPage

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

func (ListAdminRelaysResponse) Status

func (r ListAdminRelaysResponse) Status() string

Status returns HTTPResponse.Status

func (ListAdminRelaysResponse) StatusCode

func (r ListAdminRelaysResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListMaintenanceControlsResponse

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

func ParseListMaintenanceControlsResponse

func ParseListMaintenanceControlsResponse(rsp *http.Response) (*ListMaintenanceControlsResponse, error)

ParseListMaintenanceControlsResponse parses an HTTP response from a ListMaintenanceControlsWithResponse call

func (ListMaintenanceControlsResponse) ContentType

func (r ListMaintenanceControlsResponse) ContentType() string

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

func (ListMaintenanceControlsResponse) GetApplicationproblemJSONDefault

func (r ListMaintenanceControlsResponse) GetApplicationproblemJSONDefault() *Problem

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

func (ListMaintenanceControlsResponse) GetBody

func (r ListMaintenanceControlsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListMaintenanceControlsResponse) GetJSON200

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

func (ListMaintenanceControlsResponse) Status

Status returns HTTPResponse.Status

func (ListMaintenanceControlsResponse) StatusCode

func (r ListMaintenanceControlsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListRoutesParams

type ListRoutesParams struct {
	TeamId TeamIDQuery `form:"team_id" json:"team_id"`
	Cursor *Cursor     `form:"cursor,omitempty" json:"cursor,omitempty"`

	// CanonicalHostname Exact canonical hostname within the selected team. Returns zero or one non-deleted route with no next cursor. Cannot be combined with cursor.
	CanonicalHostname *CanonicalHostnameQuery `form:"canonical_hostname,omitempty" json:"canonical_hostname,omitempty"`
}

ListRoutesParams defines parameters for ListRoutes.

type ListRoutesResponse

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

func ParseListRoutesResponse

func ParseListRoutesResponse(rsp *http.Response) (*ListRoutesResponse, error)

ParseListRoutesResponse parses an HTTP response from a ListRoutesWithResponse call

func (ListRoutesResponse) ContentType

func (r ListRoutesResponse) ContentType() string

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

func (ListRoutesResponse) GetApplicationproblemJSONDefault

func (r ListRoutesResponse) GetApplicationproblemJSONDefault() *Problem

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

func (ListRoutesResponse) GetBody

func (r ListRoutesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListRoutesResponse) GetJSON200

func (r ListRoutesResponse) GetJSON200() *RoutePage

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

func (ListRoutesResponse) Status

func (r ListRoutesResponse) Status() string

Status returns HTTPResponse.Status

func (ListRoutesResponse) StatusCode

func (r ListRoutesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MaintenanceControl

type MaintenanceControl struct {
	Allowed   bool                   `json:"allowed"`
	Name      MaintenanceControlName `json:"name"`
	Revision  int64                  `json:"revision"`
	UpdatedAt time.Time              `json:"updated_at"`
	UpdatedBy IdentityID             `json:"updated_by"`
}

MaintenanceControl defines model for MaintenanceControl.

type MaintenanceControlName

type MaintenanceControlName string

MaintenanceControlName defines model for MaintenanceControlName.

const (
	MaintenanceControlNameCertificateIssuance  MaintenanceControlName = "certificate_issuance"
	MaintenanceControlNameRouteCreation        MaintenanceControlName = "route_creation"
	MaintenanceControlNameRouteSessionCreation MaintenanceControlName = "route_session_creation"
)

Defines values for MaintenanceControlName.

func (MaintenanceControlName) Valid

func (e MaintenanceControlName) Valid() bool

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

type MarkCertificateChallengeReadyResponse

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

func ParseMarkCertificateChallengeReadyResponse

func ParseMarkCertificateChallengeReadyResponse(rsp *http.Response) (*MarkCertificateChallengeReadyResponse, error)

ParseMarkCertificateChallengeReadyResponse parses an HTTP response from a MarkCertificateChallengeReadyWithResponse call

func (MarkCertificateChallengeReadyResponse) ContentType

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

func (MarkCertificateChallengeReadyResponse) GetApplicationproblemJSONDefault

func (r MarkCertificateChallengeReadyResponse) GetApplicationproblemJSONDefault() *Problem

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

func (MarkCertificateChallengeReadyResponse) GetBody

GetBody returns the raw response body bytes

func (MarkCertificateChallengeReadyResponse) GetJSON200

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

func (MarkCertificateChallengeReadyResponse) Status

Status returns HTTPResponse.Status

func (MarkCertificateChallengeReadyResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MarkCertificateChallengeRemovedResponse

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

func ParseMarkCertificateChallengeRemovedResponse

func ParseMarkCertificateChallengeRemovedResponse(rsp *http.Response) (*MarkCertificateChallengeRemovedResponse, error)

ParseMarkCertificateChallengeRemovedResponse parses an HTTP response from a MarkCertificateChallengeRemovedWithResponse call

func (MarkCertificateChallengeRemovedResponse) ContentType

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

func (MarkCertificateChallengeRemovedResponse) GetApplicationproblemJSONDefault

func (r MarkCertificateChallengeRemovedResponse) GetApplicationproblemJSONDefault() *Problem

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

func (MarkCertificateChallengeRemovedResponse) GetBody

GetBody returns the raw response body bytes

func (MarkCertificateChallengeRemovedResponse) GetJSON200

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

func (MarkCertificateChallengeRemovedResponse) Status

Status returns HTTPResponse.Status

func (MarkCertificateChallengeRemovedResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MarkRouteSessionCertificateInstalledJSONRequestBody

type MarkRouteSessionCertificateInstalledJSONRequestBody = CertificateInstalledRequest

MarkRouteSessionCertificateInstalledJSONRequestBody defines body for MarkRouteSessionCertificateInstalled for application/json ContentType.

type MarkRouteSessionCertificateInstalledResponse

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

func ParseMarkRouteSessionCertificateInstalledResponse

func ParseMarkRouteSessionCertificateInstalledResponse(rsp *http.Response) (*MarkRouteSessionCertificateInstalledResponse, error)

ParseMarkRouteSessionCertificateInstalledResponse parses an HTTP response from a MarkRouteSessionCertificateInstalledWithResponse call

func (MarkRouteSessionCertificateInstalledResponse) ContentType

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

func (MarkRouteSessionCertificateInstalledResponse) GetApplicationproblemJSONDefault

func (r MarkRouteSessionCertificateInstalledResponse) GetApplicationproblemJSONDefault() *Problem

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

func (MarkRouteSessionCertificateInstalledResponse) GetBody

GetBody returns the raw response body bytes

func (MarkRouteSessionCertificateInstalledResponse) GetJSON200

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

func (MarkRouteSessionCertificateInstalledResponse) Status

Status returns HTTPResponse.Status

func (MarkRouteSessionCertificateInstalledResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MarkRouteSessionReadyJSONRequestBody

type MarkRouteSessionReadyJSONRequestBody = RouteSessionVersionRequest

MarkRouteSessionReadyJSONRequestBody defines body for MarkRouteSessionReady for application/json ContentType.

type MarkRouteSessionReadyResponse

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

func ParseMarkRouteSessionReadyResponse

func ParseMarkRouteSessionReadyResponse(rsp *http.Response) (*MarkRouteSessionReadyResponse, error)

ParseMarkRouteSessionReadyResponse parses an HTTP response from a MarkRouteSessionReadyWithResponse call

func (MarkRouteSessionReadyResponse) ContentType

func (r MarkRouteSessionReadyResponse) ContentType() string

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

func (MarkRouteSessionReadyResponse) GetApplicationproblemJSONDefault

func (r MarkRouteSessionReadyResponse) GetApplicationproblemJSONDefault() *Problem

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

func (MarkRouteSessionReadyResponse) GetBody

func (r MarkRouteSessionReadyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (MarkRouteSessionReadyResponse) GetJSON200

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

func (MarkRouteSessionReadyResponse) Status

Status returns HTTPResponse.Status

func (MarkRouteSessionReadyResponse) StatusCode

func (r MarkRouteSessionReadyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MembershipID

type MembershipID = ResourceID

MembershipID defines model for MembershipID.

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

type OIDCAuthenticationFacts

type OIDCAuthenticationFacts struct {
	ClientId  string                           `json:"client_id"`
	Issuer    string                           `json:"issuer"`
	LoginFlow OIDCAuthenticationFactsLoginFlow `json:"login_flow"`
	Scopes    []string                         `json:"scopes"`
}

OIDCAuthenticationFacts defines model for OIDCAuthenticationFacts.

type OIDCAuthenticationFactsLoginFlow

type OIDCAuthenticationFactsLoginFlow string

OIDCAuthenticationFactsLoginFlow defines model for OIDCAuthenticationFacts.LoginFlow.

const (
	AuthorizationCodePkce OIDCAuthenticationFactsLoginFlow = "authorization_code_pkce"
	DeviceCode            OIDCAuthenticationFactsLoginFlow = "device_code"
)

Defines values for OIDCAuthenticationFactsLoginFlow.

func (OIDCAuthenticationFactsLoginFlow) Valid

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

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 ProblemCode.

const (
	Conflict             ProblemCode = "conflict"
	DnsSetupPending      ProblemCode = "dns_setup_pending"
	Forbidden            ProblemCode = "forbidden"
	Internal             ProblemCode = "internal"
	InvalidRequest       ProblemCode = "invalid_request"
	IssuanceRetry        ProblemCode = "issuance_retry"
	NameUnavailable      ProblemCode = "name_unavailable"
	NotFound             ProblemCode = "not_found"
	PlacementUnavailable ProblemCode = "placement_unavailable"
	PolicyRevisionStale  ProblemCode = "policy_revision_stale"
	RateLimited          ProblemCode = "rate_limited"
	RouteSessionOpen     ProblemCode = "route_session_open"
	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 PublisherConnectionID

type PublisherConnectionID = ResourceID

PublisherConnectionID defines model for PublisherConnectionID.

type PublisherConnectionState

type PublisherConnectionState string

PublisherConnectionState defines model for PublisherConnectionState.

const (
	PublisherConnectionStateAssigned  PublisherConnectionState = "assigned"
	PublisherConnectionStateConnected PublisherConnectionState = "connected"
	PublisherConnectionStateReady     PublisherConnectionState = "ready"
	PublisherConnectionStateReplacing PublisherConnectionState = "replacing"
)

Defines values for PublisherConnectionState.

func (PublisherConnectionState) Valid

func (e PublisherConnectionState) Valid() bool

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

type ReadinessResponse

type ReadinessResponse struct {
	Checks struct {
		Database ReadinessResponseChecksDatabase `json:"database"`
	} `json:"checks"`
	Status ReadinessResponseStatus `json:"status"`
}

ReadinessResponse defines model for ReadinessResponse.

type ReadinessResponseChecksDatabase

type ReadinessResponseChecksDatabase string

ReadinessResponseChecksDatabase defines model for ReadinessResponse.Checks.Database.

const (
	ReadinessResponseChecksDatabaseFailed ReadinessResponseChecksDatabase = "failed"
	ReadinessResponseChecksDatabaseOk     ReadinessResponseChecksDatabase = "ok"
)

Defines values for ReadinessResponseChecksDatabase.

func (ReadinessResponseChecksDatabase) Valid

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

type ReadinessResponseStatus

type ReadinessResponseStatus string

ReadinessResponseStatus defines model for ReadinessResponse.Status.

const (
	ReadinessResponseStatusNotReady ReadinessResponseStatus = "not_ready"
	ReadinessResponseStatusReady    ReadinessResponseStatus = "ready"
)

Defines values for ReadinessResponseStatus.

func (ReadinessResponseStatus) Valid

func (e ReadinessResponseStatus) Valid() bool

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

type RelayID

type RelayID = ResourceID

RelayID defines model for RelayID.

type RelayServiceID

type RelayServiceID = ResourceID

RelayServiceID defines model for RelayServiceID.

type ReleaseDNSAuthorityParams

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

ReleaseDNSAuthorityParams defines parameters for ReleaseDNSAuthority.

type ReleaseDNSAuthorityResponse

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

func ParseReleaseDNSAuthorityResponse

func ParseReleaseDNSAuthorityResponse(rsp *http.Response) (*ReleaseDNSAuthorityResponse, error)

ParseReleaseDNSAuthorityResponse parses an HTTP response from a ReleaseDNSAuthorityWithResponse call

func (ReleaseDNSAuthorityResponse) ContentType

func (r ReleaseDNSAuthorityResponse) ContentType() string

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

func (ReleaseDNSAuthorityResponse) GetApplicationproblemJSONDefault

func (r ReleaseDNSAuthorityResponse) GetApplicationproblemJSONDefault() *Problem

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

func (ReleaseDNSAuthorityResponse) GetBody

func (r ReleaseDNSAuthorityResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ReleaseDNSAuthorityResponse) GetJSON202

func (r ReleaseDNSAuthorityResponse) GetJSON202() *DNSAuthority

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (ReleaseDNSAuthorityResponse) Status

Status returns HTTPResponse.Status

func (ReleaseDNSAuthorityResponse) StatusCode

func (r ReleaseDNSAuthorityResponse) 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 RevokeHostedPolicyJSONRequestBody

type RevokeHostedPolicyJSONRequestBody = HostedPolicyRevocation

RevokeHostedPolicyJSONRequestBody defines body for RevokeHostedPolicy for application/json ContentType.

type RevokeHostedPolicyResponse

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

func ParseRevokeHostedPolicyResponse

func ParseRevokeHostedPolicyResponse(rsp *http.Response) (*RevokeHostedPolicyResponse, error)

ParseRevokeHostedPolicyResponse parses an HTTP response from a RevokeHostedPolicyWithResponse call

func (RevokeHostedPolicyResponse) ContentType

func (r RevokeHostedPolicyResponse) ContentType() string

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

func (RevokeHostedPolicyResponse) GetApplicationproblemJSONDefault

func (r RevokeHostedPolicyResponse) GetApplicationproblemJSONDefault() *Problem

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

func (RevokeHostedPolicyResponse) GetBody

func (r RevokeHostedPolicyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RevokeHostedPolicyResponse) Status

Status returns HTTPResponse.Status

func (RevokeHostedPolicyResponse) StatusCode

func (r RevokeHostedPolicyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Route

type Route struct {
	AllowedIpPrefixes  *[]string           `json:"allowed_ip_prefixes,omitempty"`
	CanonicalHostname  CanonicalHostname   `json:"canonical_hostname"`
	CreatedAt          time.Time           `json:"created_at"`
	DomainId           DomainID            `json:"domain_id"`
	Ephemeral          bool                `json:"ephemeral"`
	ExpiresAt          *time.Time          `json:"expires_at,omitempty"`
	Id                 RouteID             `json:"id"`
	LifecycleState     RouteLifecycleState `json:"lifecycle_state"`
	MembershipId       *MembershipID       `json:"membership_id,omitempty"`
	NextRouteVersion   int64               `json:"next_route_version"`
	OpenRouteSessionId *RouteSessionID     `json:"open_route_session_id,omitempty"`
	PolicyRevision     int64               `json:"policy_revision"`
	RouteScope         RouteScope          `json:"route_scope"`
	Target             string              `json:"target"`
	TeamId             TeamID              `json:"team_id"`
	UpdatedAt          time.Time           `json:"updated_at"`
}

Route defines model for Route.

type RouteID

type RouteID = ResourceID

RouteID defines model for RouteID.

type RouteLifecycleState

type RouteLifecycleState string

RouteLifecycleState defines model for RouteLifecycleState.

const (
	Enabled   RouteLifecycleState = "enabled"
	Suspended RouteLifecycleState = "suspended"
)

Defines values for RouteLifecycleState.

func (RouteLifecycleState) Valid

func (e RouteLifecycleState) Valid() bool

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

type RoutePage

type RoutePage struct {
	NextCursor *RouteID `json:"next_cursor,omitempty"`
	Routes     []Route  `json:"routes"`
}

RoutePage defines model for RoutePage.

type RouteScope

type RouteScope string

RouteScope defines model for RouteScope.

const (
	Member RouteScope = "member"
	Shared RouteScope = "shared"
)

Defines values for RouteScope.

func (RouteScope) Valid

func (e RouteScope) Valid() bool

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

type RouteSession

type RouteSession struct {
	ClosedAt                  *time.Time        `json:"closed_at,omitempty"`
	CreatedAt                 time.Time         `json:"created_at"`
	ExpiresAt                 time.Time         `json:"expires_at"`
	Id                        RouteSessionID    `json:"id"`
	MembershipId              *MembershipID     `json:"membership_id,omitempty"`
	PolicyRevision            int64             `json:"policy_revision"`
	ReadyAt                   *time.Time        `json:"ready_at,omitempty"`
	ReadyPublisherConnections *int              `json:"ready_publisher_connections,omitempty"`
	RouteId                   RouteID           `json:"route_id"`
	RouteVersion              int64             `json:"route_version"`
	State                     RouteSessionState `json:"state"`
	TeamId                    TeamID            `json:"team_id"`
}

RouteSession defines model for RouteSession.

type RouteSessionHeartbeat

type RouteSessionHeartbeat struct {
	// PolicyDenials Total IP policy denials reported so far for this route version. The total may lag.
	PolicyDenials        int64                  `json:"policy_denials"`
	PublisherConnections []ConnectionAssignment `json:"publisher_connections"`
	RouteSession         RouteSession           `json:"route_session"`
}

RouteSessionHeartbeat defines model for RouteSessionHeartbeat.

type RouteSessionID

type RouteSessionID = ResourceID

RouteSessionID defines model for RouteSessionID.

type RouteSessionSetup

type RouteSessionSetup struct {
	CertificatePlan      CertificatePlan        `json:"certificate_plan"`
	PublisherConnections []ConnectionAssignment `json:"publisher_connections"`
	Route                Route                  `json:"route"`
	RouteSession         RouteSession           `json:"route_session"`
	RouteSessionToken    string                 `json:"route_session_token"`
}

RouteSessionSetup defines model for RouteSessionSetup.

type RouteSessionState

type RouteSessionState string

RouteSessionState defines model for RouteSessionState.

const (
	RouteSessionStateCanceled RouteSessionState = "canceled"
	RouteSessionStateClosed   RouteSessionState = "closed"
	RouteSessionStateDraining RouteSessionState = "draining"
	RouteSessionStateExpired  RouteSessionState = "expired"
	RouteSessionStateReady    RouteSessionState = "ready"
	RouteSessionStateStarting RouteSessionState = "starting"
)

Defines values for RouteSessionState.

func (RouteSessionState) Valid

func (e RouteSessionState) Valid() bool

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

type RouteSessionVersionRequest

type RouteSessionVersionRequest struct {
	RouteVersion int64 `json:"route_version"`
}

RouteSessionVersionRequest defines model for RouteSessionVersionRequest.

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 {
	// ListMaintenanceControls List maintenance controls
	// (GET /v1/admin/maintenance-controls)
	ListMaintenanceControls(w http.ResponseWriter, r *http.Request)
	// SetMaintenanceControl Set one maintenance control
	// (PUT /v1/admin/maintenance-controls/{control_name})
	SetMaintenanceControl(w http.ResponseWriter, r *http.Request, controlName MaintenanceControlName)
	// ListAdminRelays List relay leases
	// (GET /v1/admin/relays)
	ListAdminRelays(w http.ResponseWriter, r *http.Request, params ListAdminRelaysParams)
	// DrainAdminRelay Remove a matching relay lease from placement and begin draining
	// (POST /v1/admin/relays/{relay_id}/drain)
	DrainAdminRelay(w http.ResponseWriter, r *http.Request, relayId RelayID)
	// GetAdminServerStatus Read control, ingress, and relay status
	// (GET /v1/admin/status)
	GetAdminServerStatus(w http.ResponseWriter, r *http.Request)
	// GetCertificateIssuance Read one route-session certificate issuance
	// (GET /v1/certificate-issuances/{issuance_id})
	GetCertificateIssuance(w http.ResponseWriter, r *http.Request, issuanceId IssuanceID)
	// MarkCertificateChallengeReady Confirm a TLS-ALPN-01 challenge is installed
	// (POST /v1/certificate-issuances/{issuance_id}/challenge-ready)
	MarkCertificateChallengeReady(w http.ResponseWriter, r *http.Request, issuanceId IssuanceID)
	// MarkCertificateChallengeRemoved Confirm a TLS-ALPN-01 challenge is removed
	// (POST /v1/certificate-issuances/{issuance_id}/challenge-removed)
	MarkCertificateChallengeRemoved(w http.ResponseWriter, r *http.Request, issuanceId IssuanceID)
	// GetClientIP Return the requesting client's public IP address
	// (GET /v1/client-ip)
	GetClientIP(w http.ResponseWriter, r *http.Request)
	// GetControlDiscovery Describe control and its authentication methods
	// (GET /v1/discovery)
	GetControlDiscovery(w http.ResponseWriter, r *http.Request)
	// GetHealth Confirm that the control HTTP server is serving
	// (GET /v1/health)
	GetHealth(w http.ResponseWriter, r *http.Request)
	// GetReadiness Confirm that control and its database are ready
	// (GET /v1/ready)
	GetReadiness(w http.ResponseWriter, r *http.Request)
	// CloseRouteSession Close and drain a route session without deleting its route
	// (DELETE /v1/route-sessions/{route_session_id})
	CloseRouteSession(w http.ResponseWriter, r *http.Request, routeSessionId RouteSessionID)
	// MarkRouteSessionCertificateInstalled Record installation of the current route certificate
	// (POST /v1/route-sessions/{route_session_id}/certificate-installed)
	MarkRouteSessionCertificateInstalled(w http.ResponseWriter, r *http.Request, routeSessionId RouteSessionID)
	// CreateCertificateIssuance Begin issuance for the route session's certificate plan
	// (POST /v1/route-sessions/{route_session_id}/certificate-issuances)
	CreateCertificateIssuance(w http.ResponseWriter, r *http.Request, routeSessionId RouteSessionID, params CreateCertificateIssuanceParams)
	// HeartbeatRouteSession Renew a route session and replace missing publisher connections
	// (POST /v1/route-sessions/{route_session_id}/heartbeat)
	HeartbeatRouteSession(w http.ResponseWriter, r *http.Request, routeSessionId RouteSessionID)
	// MarkRouteSessionReady Mark a route session ready after its certificate and two publisher connections are ready
	// (POST /v1/route-sessions/{route_session_id}/ready)
	MarkRouteSessionReady(w http.ResponseWriter, r *http.Request, routeSessionId RouteSessionID)
	// ListRoutes List routes for one team
	// (GET /v1/routes)
	ListRoutes(w http.ResponseWriter, r *http.Request, params ListRoutesParams)
	// CreateRoute Create one team route
	// (POST /v1/routes)
	CreateRoute(w http.ResponseWriter, r *http.Request, params CreateRouteParams)
	// DeleteRoute Delete one route and close its route session
	// (DELETE /v1/routes/{route_id})
	DeleteRoute(w http.ResponseWriter, r *http.Request, routeId RouteID)
	// GetRoute Read one route
	// (GET /v1/routes/{route_id})
	GetRoute(w http.ResponseWriter, r *http.Request, routeId RouteID)
	// UpdateRoute Update a route's target and IP policy
	// (PATCH /v1/routes/{route_id})
	UpdateRoute(w http.ResponseWriter, r *http.Request, routeId RouteID)
	// CreateRouteSession Create a route session and allocate its route version
	// (POST /v1/routes/{route_id}/sessions)
	CreateRouteSession(w http.ResponseWriter, r *http.Request, routeId RouteID, params CreateRouteSessionParams)
	// CreateDNSAuthority Create a DNS authority for one claimed domain
	// (POST /v1/service/dns-authorities)
	CreateDNSAuthority(w http.ResponseWriter, r *http.Request, params CreateDNSAuthorityParams)
	// ReleaseDNSAuthority Begin releasing a claimed domain's DNS authority
	// (DELETE /v1/service/dns-authorities/{dns_authority_reference})
	ReleaseDNSAuthority(w http.ResponseWriter, r *http.Request, dnsAuthorityReference DNSAuthorityReference, params ReleaseDNSAuthorityParams)
	// GetDNSAuthority Read a claimed domain's DNS authority
	// (GET /v1/service/dns-authorities/{dns_authority_reference})
	GetDNSAuthority(w http.ResponseWriter, r *http.Request, dnsAuthorityReference DNSAuthorityReference)
	// RevokeHostedPolicy Apply a policy revision from the external authority and close affected route sessions
	// (POST /v1/service/revoke)
	RevokeHostedPolicy(w http.ResponseWriter, r *http.Request)
}

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) CloseRouteSession

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

CloseRouteSession operation middleware

func (*ServerInterfaceWrapper) CreateCertificateIssuance

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

CreateCertificateIssuance operation middleware

func (*ServerInterfaceWrapper) CreateDNSAuthority

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

CreateDNSAuthority operation middleware

func (*ServerInterfaceWrapper) CreateRoute

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

CreateRoute operation middleware

func (*ServerInterfaceWrapper) CreateRouteSession

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

CreateRouteSession operation middleware

func (*ServerInterfaceWrapper) DeleteRoute

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

DeleteRoute operation middleware

func (*ServerInterfaceWrapper) DrainAdminRelay

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

DrainAdminRelay operation middleware

func (*ServerInterfaceWrapper) GetAdminServerStatus

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

GetAdminServerStatus operation middleware

func (*ServerInterfaceWrapper) GetCertificateIssuance

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

GetCertificateIssuance operation middleware

func (*ServerInterfaceWrapper) GetClientIP

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

GetClientIP operation middleware

func (*ServerInterfaceWrapper) GetControlDiscovery

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

GetControlDiscovery operation middleware

func (*ServerInterfaceWrapper) GetDNSAuthority

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

GetDNSAuthority operation middleware

func (*ServerInterfaceWrapper) GetHealth

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

GetHealth operation middleware

func (*ServerInterfaceWrapper) GetReadiness

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

GetReadiness operation middleware

func (*ServerInterfaceWrapper) GetRoute

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

GetRoute operation middleware

func (*ServerInterfaceWrapper) HeartbeatRouteSession

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

HeartbeatRouteSession operation middleware

func (*ServerInterfaceWrapper) ListAdminRelays

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

ListAdminRelays operation middleware

func (*ServerInterfaceWrapper) ListMaintenanceControls

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

ListMaintenanceControls operation middleware

func (*ServerInterfaceWrapper) ListRoutes

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

ListRoutes operation middleware

func (*ServerInterfaceWrapper) MarkCertificateChallengeReady

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

MarkCertificateChallengeReady operation middleware

func (*ServerInterfaceWrapper) MarkCertificateChallengeRemoved

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

MarkCertificateChallengeRemoved operation middleware

func (*ServerInterfaceWrapper) MarkRouteSessionCertificateInstalled

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

MarkRouteSessionCertificateInstalled operation middleware

func (*ServerInterfaceWrapper) MarkRouteSessionReady

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

MarkRouteSessionReady operation middleware

func (*ServerInterfaceWrapper) ReleaseDNSAuthority

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

ReleaseDNSAuthority operation middleware

func (*ServerInterfaceWrapper) RevokeHostedPolicy

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

RevokeHostedPolicy operation middleware

func (*ServerInterfaceWrapper) SetMaintenanceControl

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

SetMaintenanceControl operation middleware

func (*ServerInterfaceWrapper) UpdateRoute

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

UpdateRoute operation middleware

type SetMaintenanceControlJSONRequestBody

type SetMaintenanceControlJSONRequestBody = SetMaintenanceControlRequest

SetMaintenanceControlJSONRequestBody defines body for SetMaintenanceControl for application/json ContentType.

type SetMaintenanceControlRequest

type SetMaintenanceControlRequest struct {
	Allowed bool `json:"allowed"`
}

SetMaintenanceControlRequest defines model for SetMaintenanceControlRequest.

type SetMaintenanceControlResponse

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

func ParseSetMaintenanceControlResponse

func ParseSetMaintenanceControlResponse(rsp *http.Response) (*SetMaintenanceControlResponse, error)

ParseSetMaintenanceControlResponse parses an HTTP response from a SetMaintenanceControlWithResponse call

func (SetMaintenanceControlResponse) ContentType

func (r SetMaintenanceControlResponse) ContentType() string

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

func (SetMaintenanceControlResponse) GetApplicationproblemJSONDefault

func (r SetMaintenanceControlResponse) GetApplicationproblemJSONDefault() *Problem

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

func (SetMaintenanceControlResponse) GetBody

func (r SetMaintenanceControlResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SetMaintenanceControlResponse) GetJSON200

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

func (SetMaintenanceControlResponse) Status

Status returns HTTPResponse.Status

func (SetMaintenanceControlResponse) StatusCode

func (r SetMaintenanceControlResponse) 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 TeamID

type TeamID = ResourceID

TeamID defines model for TeamID.

type TeamIDQuery

type TeamIDQuery = TeamID

TeamIDQuery defines model for TeamIDQuery.

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

type UpdateRouteJSONRequestBody

type UpdateRouteJSONRequestBody = UpdateRouteRequest

UpdateRouteJSONRequestBody defines body for UpdateRoute for application/json ContentType.

type UpdateRouteRequest

type UpdateRouteRequest struct {
	AllowedIpPrefixes []string `json:"allowed_ip_prefixes"`
	Target            string   `json:"target"`
}

UpdateRouteRequest defines model for UpdateRouteRequest.

type UpdateRouteResponse

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

func ParseUpdateRouteResponse

func ParseUpdateRouteResponse(rsp *http.Response) (*UpdateRouteResponse, error)

ParseUpdateRouteResponse parses an HTTP response from a UpdateRouteWithResponse call

func (UpdateRouteResponse) ContentType

func (r UpdateRouteResponse) ContentType() string

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

func (UpdateRouteResponse) GetApplicationproblemJSONDefault

func (r UpdateRouteResponse) GetApplicationproblemJSONDefault() *Problem

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

func (UpdateRouteResponse) GetBody

func (r UpdateRouteResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateRouteResponse) GetJSON200

func (r UpdateRouteResponse) GetJSON200() *Route

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

func (UpdateRouteResponse) Status

func (r UpdateRouteResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateRouteResponse) StatusCode

func (r UpdateRouteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

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