controlv1

package
v0.1.0-rc.38 Latest Latest
Warning

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

Go to latest
Published: Oct 2, 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 NewClosePublishRunRequest

func NewClosePublishRunRequest(server string, publishRunId PublishRunID) (*http.Request, error)

NewClosePublishRunRequest constructs an http.Request for the ClosePublishRun method

func NewCreateCertificateIssuanceRequest

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

NewCreateCertificateIssuanceRequest calls the generic CreateCertificateIssuance builder with application/json body

func NewCreateCertificateIssuanceRequestWithBody

func NewCreateCertificateIssuanceRequestWithBody(server string, publishRunId PublishRunID, 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 NewCreatePublicURLRequest

func NewCreatePublicURLRequest(server string, params *CreatePublicURLParams, body CreatePublicURLJSONRequestBody) (*http.Request, error)

NewCreatePublicURLRequest calls the generic CreatePublicURL builder with application/json body

func NewCreatePublicURLRequestWithBody

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

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

func NewCreatePublishRunRequest

func NewCreatePublishRunRequest(server string, publicUrlId PublicURLID, params *CreatePublishRunParams) (*http.Request, error)

NewCreatePublishRunRequest constructs an http.Request for the CreatePublishRun method

func NewDeletePublicURLRequest

func NewDeletePublicURLRequest(server string, publicUrlId PublicURLID) (*http.Request, error)

NewDeletePublicURLRequest constructs an http.Request for the DeletePublicURL 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 NewGetPublicURLRequest

func NewGetPublicURLRequest(server string, publicUrlId PublicURLID) (*http.Request, error)

NewGetPublicURLRequest constructs an http.Request for the GetPublicURL method

func NewGetReadinessRequest

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

NewGetReadinessRequest constructs an http.Request for the GetReadiness method

func NewHeartbeatPublishRunRequest

func NewHeartbeatPublishRunRequest(server string, publishRunId PublishRunID, body HeartbeatPublishRunJSONRequestBody) (*http.Request, error)

NewHeartbeatPublishRunRequest calls the generic HeartbeatPublishRun builder with application/json body

func NewHeartbeatPublishRunRequestWithBody

func NewHeartbeatPublishRunRequestWithBody(server string, publishRunId PublishRunID, contentType string, body io.Reader) (*http.Request, error)

NewHeartbeatPublishRunRequestWithBody constructs an http.Request for the HeartbeatPublishRun 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 NewListPublicURLsRequest

func NewListPublicURLsRequest(server string, params *ListPublicURLsParams) (*http.Request, error)

NewListPublicURLsRequest constructs an http.Request for the ListPublicURLs 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 NewMarkPublishRunCertificateInstalledRequest

func NewMarkPublishRunCertificateInstalledRequest(server string, publishRunId PublishRunID, body MarkPublishRunCertificateInstalledJSONRequestBody) (*http.Request, error)

NewMarkPublishRunCertificateInstalledRequest calls the generic MarkPublishRunCertificateInstalled builder with application/json body

func NewMarkPublishRunCertificateInstalledRequestWithBody

func NewMarkPublishRunCertificateInstalledRequestWithBody(server string, publishRunId PublishRunID, contentType string, body io.Reader) (*http.Request, error)

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

func NewMarkPublishRunReadyRequest

func NewMarkPublishRunReadyRequest(server string, publishRunId PublishRunID, body MarkPublishRunReadyJSONRequestBody) (*http.Request, error)

NewMarkPublishRunReadyRequest calls the generic MarkPublishRunReady builder with application/json body

func NewMarkPublishRunReadyRequestWithBody

func NewMarkPublishRunReadyRequestWithBody(server string, publishRunId PublishRunID, contentType string, body io.Reader) (*http.Request, error)

NewMarkPublishRunReadyRequestWithBody constructs an http.Request for the MarkPublishRunReady 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 NewUpdatePublicURLRequest

func NewUpdatePublicURLRequest(server string, publicUrlId PublicURLID, body UpdatePublicURLJSONRequestBody) (*http.Request, error)

NewUpdatePublicURLRequest calls the generic UpdatePublicURL builder with application/json body

func NewUpdatePublicURLRequestWithBody

func NewUpdatePublicURLRequestWithBody(server string, publicUrlId PublicURLID, contentType string, body io.Reader) (*http.Request, error)

NewUpdatePublicURLRequestWithBody constructs an http.Request for the UpdatePublicURL 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"`
	EnabledPublicUrls   int                   `json:"enabled_public_urls"`
	IngressLeases       int                   `json:"ingress_leases"`
	ReadyPublishRuns    int                   `json:"ready_publish_runs"`
	RelayLeases         int                   `json:"relay_leases"`
	Role                AdminServerStatusRole `json:"role"`
	StartedAt           time.Time             `json:"started_at"`
	StartingPublishRuns int                   `json:"starting_publish_runs"`
	SuspendedPublicUrls int                   `json:"suspended_public_urls"`
}

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"`
	PublishRunNumber int64      `json:"publish_run_number"`
}

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"`
	PublicUrlId      PublicURLID              `json:"public_url_id"`
	PublishRunId     PublishRunID             `json:"publish_run_id"`
	PublishRunNumber int64                    `json:"publish_run_number"`
	RetryAt          *time.Time               `json:"retry_at,omitempty"`
	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) ClosePublishRun

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

ClosePublishRun Close and drain a publish run without deleting its public URL

Corresponds with DELETE /v1/publish-runs/{publish_run_id} (the `ClosePublishRun` operationId).

func (*Client) CreateCertificateIssuance

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

CreateCertificateIssuance Begin issuance for the publish run's certificate plan

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

Corresponds with POST /v1/publish-runs/{publish_run_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).

func (*Client) CreateCertificateIssuanceWithBody

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

CreateCertificateIssuanceWithBody Begin issuance for the publish run's certificate plan

Takes any type of body and a specified content type.

Corresponds with POST /v1/publish-runs/{publish_run_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) CreatePublicURL

func (c *Client) CreatePublicURL(ctx context.Context, params *CreatePublicURLParams, body CreatePublicURLJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreatePublicURL Create one team public URL

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

Corresponds with POST /v1/public-urls (the `CreatePublicURL` operationId).

func (*Client) CreatePublicURLWithBody

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

CreatePublicURLWithBody Create one team public URL

Takes any type of body and a specified content type.

Corresponds with POST /v1/public-urls (the `CreatePublicURL` operationId).

func (*Client) CreatePublishRun

func (c *Client) CreatePublishRun(ctx context.Context, publicUrlId PublicURLID, params *CreatePublishRunParams, reqEditors ...RequestEditorFn) (*http.Response, error)

CreatePublishRun Create a publish run and allocate its publish run number

Corresponds with POST /v1/public-urls/{public_url_id}/publish-runs (the `CreatePublishRun` operationId).

func (*Client) DeletePublicURL

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

DeletePublicURL Delete one public URL and close its publish run

Corresponds with DELETE /v1/public-urls/{public_url_id} (the `DeletePublicURL` 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 publish-run 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) GetPublicURL

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

GetPublicURL Read one public URL

Corresponds with GET /v1/public-urls/{public_url_id} (the `GetPublicURL` operationId).

func (*Client) GetReadiness

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

GetReadiness Confirm that the tnld role is ready to serve

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

func (*Client) HeartbeatPublishRun

func (c *Client) HeartbeatPublishRun(ctx context.Context, publishRunId PublishRunID, body HeartbeatPublishRunJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

HeartbeatPublishRun Renew a publish run and replace missing publisher connections

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

Corresponds with POST /v1/publish-runs/{publish_run_id}/heartbeat (the `HeartbeatPublishRun` operationId).

func (*Client) HeartbeatPublishRunWithBody

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

HeartbeatPublishRunWithBody Renew a publish run and replace missing publisher connections

Takes any type of body and a specified content type.

Corresponds with POST /v1/publish-runs/{publish_run_id}/heartbeat (the `HeartbeatPublishRun` 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) ListPublicURLs

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

ListPublicURLs List public URLs for one team

Corresponds with GET /v1/public-urls (the `ListPublicURLs` 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) MarkPublishRunCertificateInstalled

func (c *Client) MarkPublishRunCertificateInstalled(ctx context.Context, publishRunId PublishRunID, body MarkPublishRunCertificateInstalledJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

MarkPublishRunCertificateInstalled Record installation of the current public URL certificate

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

Corresponds with POST /v1/publish-runs/{publish_run_id}/certificate-installed (the `MarkPublishRunCertificateInstalled` operationId).

func (*Client) MarkPublishRunCertificateInstalledWithBody

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

MarkPublishRunCertificateInstalledWithBody Record installation of the current public URL certificate

Takes any type of body and a specified content type.

Corresponds with POST /v1/publish-runs/{publish_run_id}/certificate-installed (the `MarkPublishRunCertificateInstalled` operationId).

func (*Client) MarkPublishRunReady

func (c *Client) MarkPublishRunReady(ctx context.Context, publishRunId PublishRunID, body MarkPublishRunReadyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

MarkPublishRunReady Mark a publish run ready after its certificate and two publisher connections are ready

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

Corresponds with POST /v1/publish-runs/{publish_run_id}/ready (the `MarkPublishRunReady` operationId).

func (*Client) MarkPublishRunReadyWithBody

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

MarkPublishRunReadyWithBody Mark a publish run ready after its certificate and two publisher connections are ready

Takes any type of body and a specified content type.

Corresponds with POST /v1/publish-runs/{publish_run_id}/ready (the `MarkPublishRunReady` 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 publish runs

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 publish runs

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

func (c *Client) UpdatePublicURL(ctx context.Context, publicUrlId PublicURLID, body UpdatePublicURLJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdatePublicURL Update a public URL's target and IP policy

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

Corresponds with PATCH /v1/public-urls/{public_url_id} (the `UpdatePublicURL` operationId).

func (*Client) UpdatePublicURLWithBody

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

UpdatePublicURLWithBody Update a public URL's target and IP policy

Takes any type of body and a specified content type.

Corresponds with PATCH /v1/public-urls/{public_url_id} (the `UpdatePublicURL` 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 publish-run 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)

	// ListPublicURLs List public URLs for one team
	//
	// Corresponds with GET /v1/public-urls (the `ListPublicURLs` operationId).
	ListPublicURLs(ctx context.Context, params *ListPublicURLsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreatePublicURLWithBody Create one team public URL
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/public-urls (the `CreatePublicURL` operationId).
	CreatePublicURLWithBody(ctx context.Context, params *CreatePublicURLParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreatePublicURL Create one team public URL
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/public-urls (the `CreatePublicURL` operationId).
	CreatePublicURL(ctx context.Context, params *CreatePublicURLParams, body CreatePublicURLJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeletePublicURL Delete one public URL and close its publish run
	//
	// Corresponds with DELETE /v1/public-urls/{public_url_id} (the `DeletePublicURL` operationId).
	DeletePublicURL(ctx context.Context, publicUrlId PublicURLID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetPublicURL Read one public URL
	//
	// Corresponds with GET /v1/public-urls/{public_url_id} (the `GetPublicURL` operationId).
	GetPublicURL(ctx context.Context, publicUrlId PublicURLID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdatePublicURLWithBody Update a public URL's target and IP policy
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /v1/public-urls/{public_url_id} (the `UpdatePublicURL` operationId).
	UpdatePublicURLWithBody(ctx context.Context, publicUrlId PublicURLID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdatePublicURL Update a public URL's target and IP policy
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /v1/public-urls/{public_url_id} (the `UpdatePublicURL` operationId).
	UpdatePublicURL(ctx context.Context, publicUrlId PublicURLID, body UpdatePublicURLJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreatePublishRun Create a publish run and allocate its publish run number
	//
	// Corresponds with POST /v1/public-urls/{public_url_id}/publish-runs (the `CreatePublishRun` operationId).
	CreatePublishRun(ctx context.Context, publicUrlId PublicURLID, params *CreatePublishRunParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ClosePublishRun Close and drain a publish run without deleting its public URL
	//
	// Corresponds with DELETE /v1/publish-runs/{publish_run_id} (the `ClosePublishRun` operationId).
	ClosePublishRun(ctx context.Context, publishRunId PublishRunID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MarkPublishRunCertificateInstalledWithBody Record installation of the current public URL certificate
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/publish-runs/{publish_run_id}/certificate-installed (the `MarkPublishRunCertificateInstalled` operationId).
	MarkPublishRunCertificateInstalledWithBody(ctx context.Context, publishRunId PublishRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MarkPublishRunCertificateInstalled Record installation of the current public URL certificate
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/publish-runs/{publish_run_id}/certificate-installed (the `MarkPublishRunCertificateInstalled` operationId).
	MarkPublishRunCertificateInstalled(ctx context.Context, publishRunId PublishRunID, body MarkPublishRunCertificateInstalledJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// CreateCertificateIssuance Begin issuance for the publish run's certificate plan
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/publish-runs/{publish_run_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).
	CreateCertificateIssuance(ctx context.Context, publishRunId PublishRunID, params *CreateCertificateIssuanceParams, body CreateCertificateIssuanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// HeartbeatPublishRunWithBody Renew a publish run and replace missing publisher connections
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/publish-runs/{publish_run_id}/heartbeat (the `HeartbeatPublishRun` operationId).
	HeartbeatPublishRunWithBody(ctx context.Context, publishRunId PublishRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// HeartbeatPublishRun Renew a publish run and replace missing publisher connections
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/publish-runs/{publish_run_id}/heartbeat (the `HeartbeatPublishRun` operationId).
	HeartbeatPublishRun(ctx context.Context, publishRunId PublishRunID, body HeartbeatPublishRunJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MarkPublishRunReadyWithBody Mark a publish run ready after its certificate and two publisher connections are ready
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/publish-runs/{publish_run_id}/ready (the `MarkPublishRunReady` operationId).
	MarkPublishRunReadyWithBody(ctx context.Context, publishRunId PublishRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// MarkPublishRunReady Mark a publish run ready after its certificate and two publisher connections are ready
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/publish-runs/{publish_run_id}/ready (the `MarkPublishRunReady` operationId).
	MarkPublishRunReady(ctx context.Context, publishRunId PublishRunID, body MarkPublishRunReadyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetReadiness Confirm that the tnld role is ready to serve
	//
	// Corresponds with GET /v1/ready (the `GetReadiness` operationId).
	GetReadiness(ctx context.Context, 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 publish runs
	//
	// 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 publish runs
	//
	// 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) ClosePublishRunWithResponse

func (c *ClientWithResponses) ClosePublishRunWithResponse(ctx context.Context, publishRunId PublishRunID, reqEditors ...RequestEditorFn) (*ClosePublishRunResponse, error)

ClosePublishRunWithResponse Close and drain a publish run without deleting its public URL

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

Corresponds with DELETE /v1/publish-runs/{publish_run_id} (the `ClosePublishRun` operationId).

func (*ClientWithResponses) CreateCertificateIssuanceWithBodyWithResponse

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

CreateCertificateIssuanceWithBodyWithResponse Begin issuance for the publish run'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/publish-runs/{publish_run_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).

func (*ClientWithResponses) CreateCertificateIssuanceWithResponse

CreateCertificateIssuanceWithResponse Begin issuance for the publish run'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/publish-runs/{publish_run_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) CreatePublicURLWithBodyWithResponse

func (c *ClientWithResponses) CreatePublicURLWithBodyWithResponse(ctx context.Context, params *CreatePublicURLParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatePublicURLResponse, error)

CreatePublicURLWithBodyWithResponse Create one team public URL

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/public-urls (the `CreatePublicURL` operationId).

func (*ClientWithResponses) CreatePublicURLWithResponse

func (c *ClientWithResponses) CreatePublicURLWithResponse(ctx context.Context, params *CreatePublicURLParams, body CreatePublicURLJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatePublicURLResponse, error)

CreatePublicURLWithResponse Create one team public URL

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/public-urls (the `CreatePublicURL` operationId).

func (*ClientWithResponses) CreatePublishRunWithResponse

func (c *ClientWithResponses) CreatePublishRunWithResponse(ctx context.Context, publicUrlId PublicURLID, params *CreatePublishRunParams, reqEditors ...RequestEditorFn) (*CreatePublishRunResponse, error)

CreatePublishRunWithResponse Create a publish run and allocate its publish run number

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

Corresponds with POST /v1/public-urls/{public_url_id}/publish-runs (the `CreatePublishRun` operationId).

func (*ClientWithResponses) DeletePublicURLWithResponse

func (c *ClientWithResponses) DeletePublicURLWithResponse(ctx context.Context, publicUrlId PublicURLID, reqEditors ...RequestEditorFn) (*DeletePublicURLResponse, error)

DeletePublicURLWithResponse Delete one public URL and close its publish run

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

Corresponds with DELETE /v1/public-urls/{public_url_id} (the `DeletePublicURL` 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 publish-run 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) GetPublicURLWithResponse

func (c *ClientWithResponses) GetPublicURLWithResponse(ctx context.Context, publicUrlId PublicURLID, reqEditors ...RequestEditorFn) (*GetPublicURLResponse, error)

GetPublicURLWithResponse Read one public URL

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

Corresponds with GET /v1/public-urls/{public_url_id} (the `GetPublicURL` operationId).

func (*ClientWithResponses) GetReadinessWithResponse

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

GetReadinessWithResponse Confirm that the tnld role is ready to serve

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

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

func (*ClientWithResponses) HeartbeatPublishRunWithBodyWithResponse

func (c *ClientWithResponses) HeartbeatPublishRunWithBodyWithResponse(ctx context.Context, publishRunId PublishRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*HeartbeatPublishRunResponse, error)

HeartbeatPublishRunWithBodyWithResponse Renew a publish run 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/publish-runs/{publish_run_id}/heartbeat (the `HeartbeatPublishRun` operationId).

func (*ClientWithResponses) HeartbeatPublishRunWithResponse

func (c *ClientWithResponses) HeartbeatPublishRunWithResponse(ctx context.Context, publishRunId PublishRunID, body HeartbeatPublishRunJSONRequestBody, reqEditors ...RequestEditorFn) (*HeartbeatPublishRunResponse, error)

HeartbeatPublishRunWithResponse Renew a publish run 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/publish-runs/{publish_run_id}/heartbeat (the `HeartbeatPublishRun` 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) ListPublicURLsWithResponse

func (c *ClientWithResponses) ListPublicURLsWithResponse(ctx context.Context, params *ListPublicURLsParams, reqEditors ...RequestEditorFn) (*ListPublicURLsResponse, error)

ListPublicURLsWithResponse List public URLs for one team

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

Corresponds with GET /v1/public-urls (the `ListPublicURLs` 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) MarkPublishRunCertificateInstalledWithBodyWithResponse

func (c *ClientWithResponses) MarkPublishRunCertificateInstalledWithBodyWithResponse(ctx context.Context, publishRunId PublishRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MarkPublishRunCertificateInstalledResponse, error)

MarkPublishRunCertificateInstalledWithBodyWithResponse Record installation of the current public URL 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/publish-runs/{publish_run_id}/certificate-installed (the `MarkPublishRunCertificateInstalled` operationId).

func (*ClientWithResponses) MarkPublishRunCertificateInstalledWithResponse

func (c *ClientWithResponses) MarkPublishRunCertificateInstalledWithResponse(ctx context.Context, publishRunId PublishRunID, body MarkPublishRunCertificateInstalledJSONRequestBody, reqEditors ...RequestEditorFn) (*MarkPublishRunCertificateInstalledResponse, error)

MarkPublishRunCertificateInstalledWithResponse Record installation of the current public URL 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/publish-runs/{publish_run_id}/certificate-installed (the `MarkPublishRunCertificateInstalled` operationId).

func (*ClientWithResponses) MarkPublishRunReadyWithBodyWithResponse

func (c *ClientWithResponses) MarkPublishRunReadyWithBodyWithResponse(ctx context.Context, publishRunId PublishRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MarkPublishRunReadyResponse, error)

MarkPublishRunReadyWithBodyWithResponse Mark a publish run 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/publish-runs/{publish_run_id}/ready (the `MarkPublishRunReady` operationId).

func (*ClientWithResponses) MarkPublishRunReadyWithResponse

func (c *ClientWithResponses) MarkPublishRunReadyWithResponse(ctx context.Context, publishRunId PublishRunID, body MarkPublishRunReadyJSONRequestBody, reqEditors ...RequestEditorFn) (*MarkPublishRunReadyResponse, error)

MarkPublishRunReadyWithResponse Mark a publish run 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/publish-runs/{publish_run_id}/ready (the `MarkPublishRunReady` 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 publish runs

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 publish runs

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

func (c *ClientWithResponses) UpdatePublicURLWithBodyWithResponse(ctx context.Context, publicUrlId PublicURLID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdatePublicURLResponse, error)

UpdatePublicURLWithBodyWithResponse Update a public URL'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/public-urls/{public_url_id} (the `UpdatePublicURL` operationId).

func (*ClientWithResponses) UpdatePublicURLWithResponse

func (c *ClientWithResponses) UpdatePublicURLWithResponse(ctx context.Context, publicUrlId PublicURLID, body UpdatePublicURLJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdatePublicURLResponse, error)

UpdatePublicURLWithResponse Update a public URL'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/public-urls/{public_url_id} (the `UpdatePublicURL` 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 publish-run 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)

	// ListPublicURLsWithResponse List public URLs for one team
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/public-urls (the `ListPublicURLs` operationId).
	ListPublicURLsWithResponse(ctx context.Context, params *ListPublicURLsParams, reqEditors ...RequestEditorFn) (*ListPublicURLsResponse, error)

	// CreatePublicURLWithBodyWithResponse Create one team public URL
	//
	// 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/public-urls (the `CreatePublicURL` operationId).
	CreatePublicURLWithBodyWithResponse(ctx context.Context, params *CreatePublicURLParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreatePublicURLResponse, error)

	// CreatePublicURLWithResponse Create one team public URL
	//
	// 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/public-urls (the `CreatePublicURL` operationId).
	CreatePublicURLWithResponse(ctx context.Context, params *CreatePublicURLParams, body CreatePublicURLJSONRequestBody, reqEditors ...RequestEditorFn) (*CreatePublicURLResponse, error)

	// DeletePublicURLWithResponse Delete one public URL and close its publish run
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /v1/public-urls/{public_url_id} (the `DeletePublicURL` operationId).
	DeletePublicURLWithResponse(ctx context.Context, publicUrlId PublicURLID, reqEditors ...RequestEditorFn) (*DeletePublicURLResponse, error)

	// GetPublicURLWithResponse Read one public URL
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /v1/public-urls/{public_url_id} (the `GetPublicURL` operationId).
	GetPublicURLWithResponse(ctx context.Context, publicUrlId PublicURLID, reqEditors ...RequestEditorFn) (*GetPublicURLResponse, error)

	// UpdatePublicURLWithBodyWithResponse Update a public URL'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/public-urls/{public_url_id} (the `UpdatePublicURL` operationId).
	UpdatePublicURLWithBodyWithResponse(ctx context.Context, publicUrlId PublicURLID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdatePublicURLResponse, error)

	// UpdatePublicURLWithResponse Update a public URL'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/public-urls/{public_url_id} (the `UpdatePublicURL` operationId).
	UpdatePublicURLWithResponse(ctx context.Context, publicUrlId PublicURLID, body UpdatePublicURLJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdatePublicURLResponse, error)

	// CreatePublishRunWithResponse Create a publish run and allocate its publish run number
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/public-urls/{public_url_id}/publish-runs (the `CreatePublishRun` operationId).
	CreatePublishRunWithResponse(ctx context.Context, publicUrlId PublicURLID, params *CreatePublishRunParams, reqEditors ...RequestEditorFn) (*CreatePublishRunResponse, error)

	// ClosePublishRunWithResponse Close and drain a publish run without deleting its public URL
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /v1/publish-runs/{publish_run_id} (the `ClosePublishRun` operationId).
	ClosePublishRunWithResponse(ctx context.Context, publishRunId PublishRunID, reqEditors ...RequestEditorFn) (*ClosePublishRunResponse, error)

	// MarkPublishRunCertificateInstalledWithBodyWithResponse Record installation of the current public URL 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/publish-runs/{publish_run_id}/certificate-installed (the `MarkPublishRunCertificateInstalled` operationId).
	MarkPublishRunCertificateInstalledWithBodyWithResponse(ctx context.Context, publishRunId PublishRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MarkPublishRunCertificateInstalledResponse, error)

	// MarkPublishRunCertificateInstalledWithResponse Record installation of the current public URL 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/publish-runs/{publish_run_id}/certificate-installed (the `MarkPublishRunCertificateInstalled` operationId).
	MarkPublishRunCertificateInstalledWithResponse(ctx context.Context, publishRunId PublishRunID, body MarkPublishRunCertificateInstalledJSONRequestBody, reqEditors ...RequestEditorFn) (*MarkPublishRunCertificateInstalledResponse, error)

	// CreateCertificateIssuanceWithBodyWithResponse Begin issuance for the publish run'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/publish-runs/{publish_run_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).
	CreateCertificateIssuanceWithBodyWithResponse(ctx context.Context, publishRunId PublishRunID, params *CreateCertificateIssuanceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateCertificateIssuanceResponse, error)

	// CreateCertificateIssuanceWithResponse Begin issuance for the publish run'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/publish-runs/{publish_run_id}/certificate-issuances (the `CreateCertificateIssuance` operationId).
	CreateCertificateIssuanceWithResponse(ctx context.Context, publishRunId PublishRunID, params *CreateCertificateIssuanceParams, body CreateCertificateIssuanceJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateCertificateIssuanceResponse, error)

	// HeartbeatPublishRunWithBodyWithResponse Renew a publish run 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/publish-runs/{publish_run_id}/heartbeat (the `HeartbeatPublishRun` operationId).
	HeartbeatPublishRunWithBodyWithResponse(ctx context.Context, publishRunId PublishRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*HeartbeatPublishRunResponse, error)

	// HeartbeatPublishRunWithResponse Renew a publish run 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/publish-runs/{publish_run_id}/heartbeat (the `HeartbeatPublishRun` operationId).
	HeartbeatPublishRunWithResponse(ctx context.Context, publishRunId PublishRunID, body HeartbeatPublishRunJSONRequestBody, reqEditors ...RequestEditorFn) (*HeartbeatPublishRunResponse, error)

	// MarkPublishRunReadyWithBodyWithResponse Mark a publish run 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/publish-runs/{publish_run_id}/ready (the `MarkPublishRunReady` operationId).
	MarkPublishRunReadyWithBodyWithResponse(ctx context.Context, publishRunId PublishRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MarkPublishRunReadyResponse, error)

	// MarkPublishRunReadyWithResponse Mark a publish run 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/publish-runs/{publish_run_id}/ready (the `MarkPublishRunReady` operationId).
	MarkPublishRunReadyWithResponse(ctx context.Context, publishRunId PublishRunID, body MarkPublishRunReadyJSONRequestBody, reqEditors ...RequestEditorFn) (*MarkPublishRunReadyResponse, error)

	// GetReadinessWithResponse Confirm that the tnld role is ready to serve
	//
	// 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)

	// 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 publish runs
	//
	// 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 publish runs
	//
	// 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 ClosePublishRunResponse

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

func ParseClosePublishRunResponse

func ParseClosePublishRunResponse(rsp *http.Response) (*ClosePublishRunResponse, error)

ParseClosePublishRunResponse parses an HTTP response from a ClosePublishRunWithResponse call

func (ClosePublishRunResponse) ContentType

func (r ClosePublishRunResponse) ContentType() string

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

func (ClosePublishRunResponse) GetApplicationproblemJSONDefault

func (r ClosePublishRunResponse) GetApplicationproblemJSONDefault() *Problem

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

func (ClosePublishRunResponse) GetBody

func (r ClosePublishRunResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ClosePublishRunResponse) Status

func (r ClosePublishRunResponse) Status() string

Status returns HTTPResponse.Status

func (ClosePublishRunResponse) StatusCode

func (r ClosePublishRunResponse) 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"`
	PublishRunNumber int64  `json:"publish_run_number"`
}

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 CreatePublicURLJSONRequestBody

type CreatePublicURLJSONRequestBody = CreatePublicURLRequest

CreatePublicURLJSONRequestBody defines body for CreatePublicURL for application/json ContentType.

type CreatePublicURLParams

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

CreatePublicURLParams defines parameters for CreatePublicURL.

type CreatePublicURLRequest

type CreatePublicURLRequest 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"`
	PublicUrlScope    PublicURLScope    `json:"public_url_scope"`
	Target            string            `json:"target"`
	TeamId            TeamID            `json:"team_id"`
}

CreatePublicURLRequest defines model for CreatePublicURLRequest.

type CreatePublicURLResponse

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

func ParseCreatePublicURLResponse

func ParseCreatePublicURLResponse(rsp *http.Response) (*CreatePublicURLResponse, error)

ParseCreatePublicURLResponse parses an HTTP response from a CreatePublicURLWithResponse call

func (CreatePublicURLResponse) ContentType

func (r CreatePublicURLResponse) ContentType() string

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

func (CreatePublicURLResponse) GetApplicationproblemJSONDefault

func (r CreatePublicURLResponse) GetApplicationproblemJSONDefault() *Problem

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

func (CreatePublicURLResponse) GetBody

func (r CreatePublicURLResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreatePublicURLResponse) GetJSON201

func (r CreatePublicURLResponse) GetJSON201() *PublicURL

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

func (CreatePublicURLResponse) Status

func (r CreatePublicURLResponse) Status() string

Status returns HTTPResponse.Status

func (CreatePublicURLResponse) StatusCode

func (r CreatePublicURLResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreatePublishRunParams

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

CreatePublishRunParams defines parameters for CreatePublishRun.

type CreatePublishRunResponse

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

func ParseCreatePublishRunResponse

func ParseCreatePublishRunResponse(rsp *http.Response) (*CreatePublishRunResponse, error)

ParseCreatePublishRunResponse parses an HTTP response from a CreatePublishRunWithResponse call

func (CreatePublishRunResponse) ContentType

func (r CreatePublishRunResponse) ContentType() string

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

func (CreatePublishRunResponse) GetApplicationproblemJSONDefault

func (r CreatePublishRunResponse) GetApplicationproblemJSONDefault() *Problem

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

func (CreatePublishRunResponse) GetBody

func (r CreatePublishRunResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreatePublishRunResponse) GetJSON201

func (r CreatePublishRunResponse) GetJSON201() *PublishRunSetup

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

func (CreatePublishRunResponse) Status

func (r CreatePublishRunResponse) Status() string

Status returns HTTPResponse.Status

func (CreatePublishRunResponse) StatusCode

func (r CreatePublishRunResponse) 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 DeletePublicURLResponse

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

func ParseDeletePublicURLResponse

func ParseDeletePublicURLResponse(rsp *http.Response) (*DeletePublicURLResponse, error)

ParseDeletePublicURLResponse parses an HTTP response from a DeletePublicURLWithResponse call

func (DeletePublicURLResponse) ContentType

func (r DeletePublicURLResponse) ContentType() string

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

func (DeletePublicURLResponse) GetApplicationproblemJSONDefault

func (r DeletePublicURLResponse) GetApplicationproblemJSONDefault() *Problem

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

func (DeletePublicURLResponse) GetBody

func (r DeletePublicURLResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeletePublicURLResponse) Status

func (r DeletePublicURLResponse) Status() string

Status returns HTTPResponse.Status

func (DeletePublicURLResponse) StatusCode

func (r DeletePublicURLResponse) 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 GetPublicURLResponse

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

func ParseGetPublicURLResponse

func ParseGetPublicURLResponse(rsp *http.Response) (*GetPublicURLResponse, error)

ParseGetPublicURLResponse parses an HTTP response from a GetPublicURLWithResponse call

func (GetPublicURLResponse) ContentType

func (r GetPublicURLResponse) ContentType() string

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

func (GetPublicURLResponse) GetApplicationproblemJSONDefault

func (r GetPublicURLResponse) GetApplicationproblemJSONDefault() *Problem

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

func (GetPublicURLResponse) GetBody

func (r GetPublicURLResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetPublicURLResponse) GetJSON200

func (r GetPublicURLResponse) GetJSON200() *PublicURL

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

func (GetPublicURLResponse) Status

func (r GetPublicURLResponse) Status() string

Status returns HTTPResponse.Status

func (GetPublicURLResponse) StatusCode

func (r GetPublicURLResponse) 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 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 HeartbeatPublishRunJSONRequestBody

type HeartbeatPublishRunJSONRequestBody = PublishRunVersionRequest

HeartbeatPublishRunJSONRequestBody defines body for HeartbeatPublishRun for application/json ContentType.

type HeartbeatPublishRunResponse

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

func ParseHeartbeatPublishRunResponse

func ParseHeartbeatPublishRunResponse(rsp *http.Response) (*HeartbeatPublishRunResponse, error)

ParseHeartbeatPublishRunResponse parses an HTTP response from a HeartbeatPublishRunWithResponse call

func (HeartbeatPublishRunResponse) ContentType

func (r HeartbeatPublishRunResponse) ContentType() string

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

func (HeartbeatPublishRunResponse) GetApplicationproblemJSONDefault

func (r HeartbeatPublishRunResponse) GetApplicationproblemJSONDefault() *Problem

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

func (HeartbeatPublishRunResponse) GetBody

func (r HeartbeatPublishRunResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (HeartbeatPublishRunResponse) GetJSON200

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

func (HeartbeatPublishRunResponse) Status

Status returns HTTPResponse.Status

func (HeartbeatPublishRunResponse) StatusCode

func (r HeartbeatPublishRunResponse) 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 ListPublicURLsParams

type ListPublicURLsParams 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 public URL with no next cursor. Cannot be combined with cursor.
	CanonicalHostname *CanonicalHostnameQuery `form:"canonical_hostname,omitempty" json:"canonical_hostname,omitempty"`
}

ListPublicURLsParams defines parameters for ListPublicURLs.

type ListPublicURLsResponse

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

func ParseListPublicURLsResponse

func ParseListPublicURLsResponse(rsp *http.Response) (*ListPublicURLsResponse, error)

ParseListPublicURLsResponse parses an HTTP response from a ListPublicURLsWithResponse call

func (ListPublicURLsResponse) ContentType

func (r ListPublicURLsResponse) ContentType() string

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

func (ListPublicURLsResponse) GetApplicationproblemJSONDefault

func (r ListPublicURLsResponse) GetApplicationproblemJSONDefault() *Problem

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

func (ListPublicURLsResponse) GetBody

func (r ListPublicURLsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListPublicURLsResponse) GetJSON200

func (r ListPublicURLsResponse) GetJSON200() *PublicURLPage

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

func (ListPublicURLsResponse) Status

func (r ListPublicURLsResponse) Status() string

Status returns HTTPResponse.Status

func (ListPublicURLsResponse) StatusCode

func (r ListPublicURLsResponse) 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"
	MaintenanceControlNamePublicUrlCreation   MaintenanceControlName = "public_url_creation"
	MaintenanceControlNamePublishRunCreation  MaintenanceControlName = "publish_run_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 MarkPublishRunCertificateInstalledJSONRequestBody

type MarkPublishRunCertificateInstalledJSONRequestBody = CertificateInstalledRequest

MarkPublishRunCertificateInstalledJSONRequestBody defines body for MarkPublishRunCertificateInstalled for application/json ContentType.

type MarkPublishRunCertificateInstalledResponse

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

func ParseMarkPublishRunCertificateInstalledResponse

func ParseMarkPublishRunCertificateInstalledResponse(rsp *http.Response) (*MarkPublishRunCertificateInstalledResponse, error)

ParseMarkPublishRunCertificateInstalledResponse parses an HTTP response from a MarkPublishRunCertificateInstalledWithResponse call

func (MarkPublishRunCertificateInstalledResponse) ContentType

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

func (MarkPublishRunCertificateInstalledResponse) GetApplicationproblemJSONDefault

func (r MarkPublishRunCertificateInstalledResponse) GetApplicationproblemJSONDefault() *Problem

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

func (MarkPublishRunCertificateInstalledResponse) GetBody

GetBody returns the raw response body bytes

func (MarkPublishRunCertificateInstalledResponse) GetJSON200

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

func (MarkPublishRunCertificateInstalledResponse) Status

Status returns HTTPResponse.Status

func (MarkPublishRunCertificateInstalledResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type MarkPublishRunReadyJSONRequestBody

type MarkPublishRunReadyJSONRequestBody = PublishRunVersionRequest

MarkPublishRunReadyJSONRequestBody defines body for MarkPublishRunReady for application/json ContentType.

type MarkPublishRunReadyResponse

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

func ParseMarkPublishRunReadyResponse

func ParseMarkPublishRunReadyResponse(rsp *http.Response) (*MarkPublishRunReadyResponse, error)

ParseMarkPublishRunReadyResponse parses an HTTP response from a MarkPublishRunReadyWithResponse call

func (MarkPublishRunReadyResponse) ContentType

func (r MarkPublishRunReadyResponse) ContentType() string

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

func (MarkPublishRunReadyResponse) GetApplicationproblemJSONDefault

func (r MarkPublishRunReadyResponse) GetApplicationproblemJSONDefault() *Problem

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

func (MarkPublishRunReadyResponse) GetBody

func (r MarkPublishRunReadyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (MarkPublishRunReadyResponse) GetJSON200

func (r MarkPublishRunReadyResponse) GetJSON200() *PublishRun

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

func (MarkPublishRunReadyResponse) Status

Status returns HTTPResponse.Status

func (MarkPublishRunReadyResponse) StatusCode

func (r MarkPublishRunReadyResponse) 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"
	PublishRunOpen       ProblemCode = "publish_run_open"
	RateLimited          ProblemCode = "rate_limited"
	Unauthenticated      ProblemCode = "unauthenticated"
	Unavailable          ProblemCode = "unavailable"
)

Defines values for ProblemCode.

func (ProblemCode) Valid

func (e ProblemCode) Valid() bool

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

type PublicURL

type PublicURL 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                   PublicURLID             `json:"id"`
	LifecycleState       PublicURLLifecycleState `json:"lifecycle_state"`
	MembershipId         *MembershipID           `json:"membership_id,omitempty"`
	NextPublishRunNumber int64                   `json:"next_publish_run_number"`
	OpenPublishRunId     *PublishRunID           `json:"open_publish_run_id,omitempty"`
	PolicyRevision       int64                   `json:"policy_revision"`
	PublicUrlScope       PublicURLScope          `json:"public_url_scope"`
	Target               string                  `json:"target"`
	TeamId               TeamID                  `json:"team_id"`
	UpdatedAt            time.Time               `json:"updated_at"`
}

PublicURL defines model for PublicURL.

type PublicURLID

type PublicURLID = ResourceID

PublicURLID defines model for PublicURLID.

type PublicURLLifecycleState

type PublicURLLifecycleState string

PublicURLLifecycleState defines model for PublicURLLifecycleState.

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

Defines values for PublicURLLifecycleState.

func (PublicURLLifecycleState) Valid

func (e PublicURLLifecycleState) Valid() bool

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

type PublicURLPage

type PublicURLPage struct {
	NextCursor *PublicURLID `json:"next_cursor,omitempty"`
	PublicUrls []PublicURL  `json:"public_urls"`
}

PublicURLPage defines model for PublicURLPage.

type PublicURLScope

type PublicURLScope string

PublicURLScope defines model for PublicURLScope.

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

Defines values for PublicURLScope.

func (PublicURLScope) Valid

func (e PublicURLScope) Valid() bool

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

type PublishRun

type PublishRun struct {
	ClosedAt                  *time.Time      `json:"closed_at,omitempty"`
	CreatedAt                 time.Time       `json:"created_at"`
	ExpiresAt                 time.Time       `json:"expires_at"`
	Id                        PublishRunID    `json:"id"`
	MembershipId              *MembershipID   `json:"membership_id,omitempty"`
	PolicyRevision            int64           `json:"policy_revision"`
	PublicUrlId               PublicURLID     `json:"public_url_id"`
	PublishRunNumber          int64           `json:"publish_run_number"`
	ReadyAt                   *time.Time      `json:"ready_at,omitempty"`
	ReadyPublisherConnections *int            `json:"ready_publisher_connections,omitempty"`
	State                     PublishRunState `json:"state"`
	TeamId                    TeamID          `json:"team_id"`
}

PublishRun defines model for PublishRun.

type PublishRunHeartbeat

type PublishRunHeartbeat struct {
	// PolicyDenials Total IP policy denials reported so far for this publish run number. The total may lag.
	PolicyDenials        int64                  `json:"policy_denials"`
	PublishRun           PublishRun             `json:"publish_run"`
	PublisherConnections []ConnectionAssignment `json:"publisher_connections"`
}

PublishRunHeartbeat defines model for PublishRunHeartbeat.

type PublishRunID

type PublishRunID = ResourceID

PublishRunID defines model for PublishRunID.

type PublishRunSetup

type PublishRunSetup struct {
	CertificatePlan      CertificatePlan        `json:"certificate_plan"`
	PublicUrl            PublicURL              `json:"public_url"`
	PublishRun           PublishRun             `json:"publish_run"`
	PublishRunToken      string                 `json:"publish_run_token"`
	PublisherConnections []ConnectionAssignment `json:"publisher_connections"`
}

PublishRunSetup defines model for PublishRunSetup.

type PublishRunState

type PublishRunState string

PublishRunState defines model for PublishRunState.

const (
	PublishRunStateCanceled PublishRunState = "canceled"
	PublishRunStateClosed   PublishRunState = "closed"
	PublishRunStateDraining PublishRunState = "draining"
	PublishRunStateExpired  PublishRunState = "expired"
	PublishRunStateReady    PublishRunState = "ready"
	PublishRunStateStarting PublishRunState = "starting"
)

Defines values for PublishRunState.

func (PublishRunState) Valid

func (e PublishRunState) Valid() bool

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

type PublishRunVersionRequest

type PublishRunVersionRequest struct {
	PublishRunNumber int64 `json:"publish_run_number"`
}

PublishRunVersionRequest defines model for PublishRunVersionRequest.

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 {
		// Control Control listeners and public control certificate are ready.
		Control  ReadinessResponseChecksControl  `json:"control"`
		Database ReadinessResponseChecksDatabase `json:"database"`

		// Ingress Present in standalone; checks the ingress lease, routing table, and listener.
		Ingress *ReadinessResponseChecksIngress `json:"ingress,omitempty"`

		// Relay Present in standalone; checks both relay services and their listeners.
		Relay *ReadinessResponseChecksRelay `json:"relay,omitempty"`

		// Route53Credentials Present when control uses Route 53; checks that its AWS credentials can be obtained.
		Route53Credentials *ReadinessResponseChecksRoute53Credentials `json:"route53_credentials,omitempty"`
	} `json:"checks"`
	Status ReadinessResponseStatus `json:"status"`
}

ReadinessResponse defines model for ReadinessResponse.

type ReadinessResponseChecksControl

type ReadinessResponseChecksControl string

ReadinessResponseChecksControl Control listeners and public control certificate are ready.

const (
	ReadinessResponseChecksControlFailed ReadinessResponseChecksControl = "failed"
	ReadinessResponseChecksControlOk     ReadinessResponseChecksControl = "ok"
)

Defines values for ReadinessResponseChecksControl.

func (ReadinessResponseChecksControl) Valid

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

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 ReadinessResponseChecksIngress

type ReadinessResponseChecksIngress string

ReadinessResponseChecksIngress Present in standalone; checks the ingress lease, routing table, and listener.

const (
	ReadinessResponseChecksIngressFailed ReadinessResponseChecksIngress = "failed"
	ReadinessResponseChecksIngressOk     ReadinessResponseChecksIngress = "ok"
)

Defines values for ReadinessResponseChecksIngress.

func (ReadinessResponseChecksIngress) Valid

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

type ReadinessResponseChecksRelay

type ReadinessResponseChecksRelay string

ReadinessResponseChecksRelay Present in standalone; checks both relay services and their listeners.

const (
	ReadinessResponseChecksRelayFailed ReadinessResponseChecksRelay = "failed"
	ReadinessResponseChecksRelayOk     ReadinessResponseChecksRelay = "ok"
)

Defines values for ReadinessResponseChecksRelay.

func (ReadinessResponseChecksRelay) Valid

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

type ReadinessResponseChecksRoute53Credentials

type ReadinessResponseChecksRoute53Credentials string

ReadinessResponseChecksRoute53Credentials Present when control uses Route 53; checks that its AWS credentials can be obtained.

const (
	ReadinessResponseChecksRoute53CredentialsFailed ReadinessResponseChecksRoute53Credentials = "failed"
	ReadinessResponseChecksRoute53CredentialsOk     ReadinessResponseChecksRoute53Credentials = "ok"
)

Defines values for ReadinessResponseChecksRoute53Credentials.

func (ReadinessResponseChecksRoute53Credentials) Valid

Valid indicates whether the value is a known member of the ReadinessResponseChecksRoute53Credentials 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 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 publish-run 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)
	// ListPublicURLs List public URLs for one team
	// (GET /v1/public-urls)
	ListPublicURLs(w http.ResponseWriter, r *http.Request, params ListPublicURLsParams)
	// CreatePublicURL Create one team public URL
	// (POST /v1/public-urls)
	CreatePublicURL(w http.ResponseWriter, r *http.Request, params CreatePublicURLParams)
	// DeletePublicURL Delete one public URL and close its publish run
	// (DELETE /v1/public-urls/{public_url_id})
	DeletePublicURL(w http.ResponseWriter, r *http.Request, publicUrlId PublicURLID)
	// GetPublicURL Read one public URL
	// (GET /v1/public-urls/{public_url_id})
	GetPublicURL(w http.ResponseWriter, r *http.Request, publicUrlId PublicURLID)
	// UpdatePublicURL Update a public URL's target and IP policy
	// (PATCH /v1/public-urls/{public_url_id})
	UpdatePublicURL(w http.ResponseWriter, r *http.Request, publicUrlId PublicURLID)
	// CreatePublishRun Create a publish run and allocate its publish run number
	// (POST /v1/public-urls/{public_url_id}/publish-runs)
	CreatePublishRun(w http.ResponseWriter, r *http.Request, publicUrlId PublicURLID, params CreatePublishRunParams)
	// ClosePublishRun Close and drain a publish run without deleting its public URL
	// (DELETE /v1/publish-runs/{publish_run_id})
	ClosePublishRun(w http.ResponseWriter, r *http.Request, publishRunId PublishRunID)
	// MarkPublishRunCertificateInstalled Record installation of the current public URL certificate
	// (POST /v1/publish-runs/{publish_run_id}/certificate-installed)
	MarkPublishRunCertificateInstalled(w http.ResponseWriter, r *http.Request, publishRunId PublishRunID)
	// CreateCertificateIssuance Begin issuance for the publish run's certificate plan
	// (POST /v1/publish-runs/{publish_run_id}/certificate-issuances)
	CreateCertificateIssuance(w http.ResponseWriter, r *http.Request, publishRunId PublishRunID, params CreateCertificateIssuanceParams)
	// HeartbeatPublishRun Renew a publish run and replace missing publisher connections
	// (POST /v1/publish-runs/{publish_run_id}/heartbeat)
	HeartbeatPublishRun(w http.ResponseWriter, r *http.Request, publishRunId PublishRunID)
	// MarkPublishRunReady Mark a publish run ready after its certificate and two publisher connections are ready
	// (POST /v1/publish-runs/{publish_run_id}/ready)
	MarkPublishRunReady(w http.ResponseWriter, r *http.Request, publishRunId PublishRunID)
	// GetReadiness Confirm that the tnld role is ready to serve
	// (GET /v1/ready)
	GetReadiness(w http.ResponseWriter, r *http.Request)
	// 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 publish runs
	// (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) ClosePublishRun

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

ClosePublishRun 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) CreatePublicURL

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

CreatePublicURL operation middleware

func (*ServerInterfaceWrapper) CreatePublishRun

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

CreatePublishRun operation middleware

func (*ServerInterfaceWrapper) DeletePublicURL

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

DeletePublicURL 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) GetPublicURL

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

GetPublicURL operation middleware

func (*ServerInterfaceWrapper) GetReadiness

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

GetReadiness operation middleware

func (*ServerInterfaceWrapper) HeartbeatPublishRun

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

HeartbeatPublishRun 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) ListPublicURLs

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

ListPublicURLs 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) MarkPublishRunCertificateInstalled

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

MarkPublishRunCertificateInstalled operation middleware

func (*ServerInterfaceWrapper) MarkPublishRunReady

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

MarkPublishRunReady 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) UpdatePublicURL

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

UpdatePublicURL 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 UpdatePublicURLJSONRequestBody

type UpdatePublicURLJSONRequestBody = UpdatePublicURLRequest

UpdatePublicURLJSONRequestBody defines body for UpdatePublicURL for application/json ContentType.

type UpdatePublicURLRequest

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

UpdatePublicURLRequest defines model for UpdatePublicURLRequest.

type UpdatePublicURLResponse

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

func ParseUpdatePublicURLResponse

func ParseUpdatePublicURLResponse(rsp *http.Response) (*UpdatePublicURLResponse, error)

ParseUpdatePublicURLResponse parses an HTTP response from a UpdatePublicURLWithResponse call

func (UpdatePublicURLResponse) ContentType

func (r UpdatePublicURLResponse) ContentType() string

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

func (UpdatePublicURLResponse) GetApplicationproblemJSONDefault

func (r UpdatePublicURLResponse) GetApplicationproblemJSONDefault() *Problem

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

func (UpdatePublicURLResponse) GetBody

func (r UpdatePublicURLResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdatePublicURLResponse) GetJSON200

func (r UpdatePublicURLResponse) GetJSON200() *PublicURL

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

func (UpdatePublicURLResponse) Status

func (r UpdatePublicURLResponse) Status() string

Status returns HTTPResponse.Status

func (UpdatePublicURLResponse) StatusCode

func (r UpdatePublicURLResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

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