api

package
v1.8.4 Latest Latest
Warning

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

Go to latest
Published: Oct 14, 2022 License: MIT Imports: 10 Imported by: 2

Documentation

Overview

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

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

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

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

Index

Constants

View Source
const (
	ApiKeyHeaderScopes = "apiKeyHeader.Scopes"
	ApiKeyParamScopes  = "apiKeyParam.Scopes"
	BearerScopes       = "bearer.Scopes"
)

Variables

This section is empty.

Functions

func NewCreateFunctionRequest

func NewCreateFunctionRequest(server string, ref string, body CreateFunctionJSONRequestBody) (*http.Request, error)

NewCreateFunctionRequest calls the generic CreateFunction builder with application/json body

func NewCreateFunctionRequestWithBody

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

NewCreateFunctionRequestWithBody generates requests for CreateFunction with any type of body

func NewCreateOrganizationRequest

func NewCreateOrganizationRequest(server string, body CreateOrganizationJSONRequestBody) (*http.Request, error)

NewCreateOrganizationRequest calls the generic CreateOrganization builder with application/json body

func NewCreateOrganizationRequestWithBody

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

NewCreateOrganizationRequestWithBody generates requests for CreateOrganization with any type of body

func NewCreateProjectRequest

func NewCreateProjectRequest(server string, body CreateProjectJSONRequestBody) (*http.Request, error)

NewCreateProjectRequest calls the generic CreateProject builder with application/json body

func NewCreateProjectRequestWithBody

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

NewCreateProjectRequestWithBody generates requests for CreateProject with any type of body

func NewCreateSecretsRequest

func NewCreateSecretsRequest(server string, ref string, body CreateSecretsJSONRequestBody) (*http.Request, error)

NewCreateSecretsRequest calls the generic CreateSecrets builder with application/json body

func NewCreateSecretsRequestWithBody

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

NewCreateSecretsRequestWithBody generates requests for CreateSecrets with any type of body

func NewDeleteFunctionRequest

func NewDeleteFunctionRequest(server string, ref string, functionSlug string) (*http.Request, error)

NewDeleteFunctionRequest generates requests for DeleteFunction

func NewDeleteSecretsRequest

func NewDeleteSecretsRequest(server string, ref string, body DeleteSecretsJSONRequestBody) (*http.Request, error)

NewDeleteSecretsRequest calls the generic DeleteSecrets builder with application/json body

func NewDeleteSecretsRequestWithBody

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

NewDeleteSecretsRequestWithBody generates requests for DeleteSecrets with any type of body

func NewGetConfigRequest added in v1.8.0

func NewGetConfigRequest(server string, ref string) (*http.Request, error)

NewGetConfigRequest generates requests for GetConfig

func NewGetFunctionRequest

func NewGetFunctionRequest(server string, ref string, functionSlug string, params *GetFunctionParams) (*http.Request, error)

NewGetFunctionRequest generates requests for GetFunction

func NewGetFunctionsRequest

func NewGetFunctionsRequest(server string, ref string) (*http.Request, error)

NewGetFunctionsRequest generates requests for GetFunctions

func NewGetOrganizationsRequest

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

NewGetOrganizationsRequest generates requests for GetOrganizations

func NewGetProjectsRequest

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

NewGetProjectsRequest generates requests for GetProjects

func NewGetSecretsRequest

func NewGetSecretsRequest(server string, ref string) (*http.Request, error)

NewGetSecretsRequest generates requests for GetSecrets

func NewGetTypescriptTypesRequest added in v1.8.0

func NewGetTypescriptTypesRequest(server string, ref string, params *GetTypescriptTypesParams) (*http.Request, error)

NewGetTypescriptTypesRequest generates requests for GetTypescriptTypes

func NewUpdateConfigRequest added in v1.8.0

func NewUpdateConfigRequest(server string, ref string, body UpdateConfigJSONRequestBody) (*http.Request, error)

NewUpdateConfigRequest calls the generic UpdateConfig builder with application/json body

func NewUpdateConfigRequestWithBody added in v1.8.0

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

NewUpdateConfigRequestWithBody generates requests for UpdateConfig with any type of body

func NewUpdateFunctionRequest

func NewUpdateFunctionRequest(server string, ref string, functionSlug string, body UpdateFunctionJSONRequestBody) (*http.Request, error)

NewUpdateFunctionRequest calls the generic UpdateFunction builder with application/json body

func NewUpdateFunctionRequestWithBody

func NewUpdateFunctionRequestWithBody(server string, ref string, functionSlug string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateFunctionRequestWithBody generates requests for UpdateFunction with any type of body

Types

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

func (c *Client) CreateFunction(ctx context.Context, ref string, body CreateFunctionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateFunctionWithBody

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

func (*Client) CreateOrganization

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

func (*Client) CreateOrganizationWithBody

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

func (*Client) CreateProject

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

func (*Client) CreateProjectWithBody

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

func (*Client) CreateSecrets

func (c *Client) CreateSecrets(ctx context.Context, ref string, body CreateSecretsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateSecretsWithBody

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

func (*Client) DeleteFunction

func (c *Client) DeleteFunction(ctx context.Context, ref string, functionSlug string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteSecrets

func (c *Client) DeleteSecrets(ctx context.Context, ref string, body DeleteSecretsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteSecretsWithBody

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

func (*Client) GetConfig added in v1.8.0

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

func (*Client) GetFunction

func (c *Client) GetFunction(ctx context.Context, ref string, functionSlug string, params *GetFunctionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetFunctions

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

func (*Client) GetOrganizations

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

func (*Client) GetProjects

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

func (*Client) GetSecrets

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

func (*Client) GetTypescriptTypes added in v1.8.0

func (c *Client) GetTypescriptTypes(ctx context.Context, ref string, params *GetTypescriptTypesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateConfig added in v1.8.0

func (c *Client) UpdateConfig(ctx context.Context, ref string, body UpdateConfigJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateConfigWithBody added in v1.8.0

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

func (*Client) UpdateFunction

func (c *Client) UpdateFunction(ctx context.Context, ref string, functionSlug string, body UpdateFunctionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateFunctionWithBody

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

type ClientInterface

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

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

	CreateOrganization(ctx context.Context, body CreateOrganizationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	CreateProject(ctx context.Context, body CreateProjectJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	CreateFunction(ctx context.Context, ref string, body CreateFunctionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteFunction request
	DeleteFunction(ctx context.Context, ref string, functionSlug string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFunction request
	GetFunction(ctx context.Context, ref string, functionSlug string, params *GetFunctionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateFunction request with any body
	UpdateFunctionWithBody(ctx context.Context, ref string, functionSlug string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateFunction(ctx context.Context, ref string, functionSlug string, body UpdateFunctionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	UpdateConfig(ctx context.Context, ref string, body UpdateConfigJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	DeleteSecrets(ctx context.Context, ref string, body DeleteSecretsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	CreateSecrets(ctx context.Context, ref string, body CreateSecretsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTypescriptTypes request
	GetTypescriptTypes(ctx context.Context, ref string, params *GetTypescriptTypesParams, 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) CreateFunctionWithBodyWithResponse

func (c *ClientWithResponses) CreateFunctionWithBodyWithResponse(ctx context.Context, ref string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFunctionResponse, error)

CreateFunctionWithBodyWithResponse request with arbitrary body returning *CreateFunctionResponse

func (*ClientWithResponses) CreateFunctionWithResponse

func (c *ClientWithResponses) CreateFunctionWithResponse(ctx context.Context, ref string, body CreateFunctionJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFunctionResponse, error)

func (*ClientWithResponses) CreateOrganizationWithBodyWithResponse

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

CreateOrganizationWithBodyWithResponse request with arbitrary body returning *CreateOrganizationResponse

func (*ClientWithResponses) CreateOrganizationWithResponse

func (c *ClientWithResponses) CreateOrganizationWithResponse(ctx context.Context, body CreateOrganizationJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOrganizationResponse, error)

func (*ClientWithResponses) CreateProjectWithBodyWithResponse

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

CreateProjectWithBodyWithResponse request with arbitrary body returning *CreateProjectResponse

func (*ClientWithResponses) CreateProjectWithResponse

func (c *ClientWithResponses) CreateProjectWithResponse(ctx context.Context, body CreateProjectJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateProjectResponse, error)

func (*ClientWithResponses) CreateSecretsWithBodyWithResponse

func (c *ClientWithResponses) CreateSecretsWithBodyWithResponse(ctx context.Context, ref string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSecretsResponse, error)

CreateSecretsWithBodyWithResponse request with arbitrary body returning *CreateSecretsResponse

func (*ClientWithResponses) CreateSecretsWithResponse

func (c *ClientWithResponses) CreateSecretsWithResponse(ctx context.Context, ref string, body CreateSecretsJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSecretsResponse, error)

func (*ClientWithResponses) DeleteFunctionWithResponse

func (c *ClientWithResponses) DeleteFunctionWithResponse(ctx context.Context, ref string, functionSlug string, reqEditors ...RequestEditorFn) (*DeleteFunctionResponse, error)

DeleteFunctionWithResponse request returning *DeleteFunctionResponse

func (*ClientWithResponses) DeleteSecretsWithBodyWithResponse

func (c *ClientWithResponses) DeleteSecretsWithBodyWithResponse(ctx context.Context, ref string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteSecretsResponse, error)

DeleteSecretsWithBodyWithResponse request with arbitrary body returning *DeleteSecretsResponse

func (*ClientWithResponses) DeleteSecretsWithResponse

func (c *ClientWithResponses) DeleteSecretsWithResponse(ctx context.Context, ref string, body DeleteSecretsJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteSecretsResponse, error)

func (*ClientWithResponses) GetConfigWithResponse added in v1.8.0

func (c *ClientWithResponses) GetConfigWithResponse(ctx context.Context, ref string, reqEditors ...RequestEditorFn) (*GetConfigResponse, error)

GetConfigWithResponse request returning *GetConfigResponse

func (*ClientWithResponses) GetFunctionWithResponse

func (c *ClientWithResponses) GetFunctionWithResponse(ctx context.Context, ref string, functionSlug string, params *GetFunctionParams, reqEditors ...RequestEditorFn) (*GetFunctionResponse, error)

GetFunctionWithResponse request returning *GetFunctionResponse

func (*ClientWithResponses) GetFunctionsWithResponse

func (c *ClientWithResponses) GetFunctionsWithResponse(ctx context.Context, ref string, reqEditors ...RequestEditorFn) (*GetFunctionsResponse, error)

GetFunctionsWithResponse request returning *GetFunctionsResponse

func (*ClientWithResponses) GetOrganizationsWithResponse

func (c *ClientWithResponses) GetOrganizationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOrganizationsResponse, error)

GetOrganizationsWithResponse request returning *GetOrganizationsResponse

func (*ClientWithResponses) GetProjectsWithResponse

func (c *ClientWithResponses) GetProjectsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetProjectsResponse, error)

GetProjectsWithResponse request returning *GetProjectsResponse

func (*ClientWithResponses) GetSecretsWithResponse

func (c *ClientWithResponses) GetSecretsWithResponse(ctx context.Context, ref string, reqEditors ...RequestEditorFn) (*GetSecretsResponse, error)

GetSecretsWithResponse request returning *GetSecretsResponse

func (*ClientWithResponses) GetTypescriptTypesWithResponse added in v1.8.0

func (c *ClientWithResponses) GetTypescriptTypesWithResponse(ctx context.Context, ref string, params *GetTypescriptTypesParams, reqEditors ...RequestEditorFn) (*GetTypescriptTypesResponse, error)

GetTypescriptTypesWithResponse request returning *GetTypescriptTypesResponse

func (*ClientWithResponses) UpdateConfigWithBodyWithResponse added in v1.8.0

func (c *ClientWithResponses) UpdateConfigWithBodyWithResponse(ctx context.Context, ref string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateConfigResponse, error)

UpdateConfigWithBodyWithResponse request with arbitrary body returning *UpdateConfigResponse

func (*ClientWithResponses) UpdateConfigWithResponse added in v1.8.0

func (c *ClientWithResponses) UpdateConfigWithResponse(ctx context.Context, ref string, body UpdateConfigJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateConfigResponse, error)

func (*ClientWithResponses) UpdateFunctionWithBodyWithResponse

func (c *ClientWithResponses) UpdateFunctionWithBodyWithResponse(ctx context.Context, ref string, functionSlug string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateFunctionResponse, error)

UpdateFunctionWithBodyWithResponse request with arbitrary body returning *UpdateFunctionResponse

func (*ClientWithResponses) UpdateFunctionWithResponse

func (c *ClientWithResponses) UpdateFunctionWithResponse(ctx context.Context, ref string, functionSlug string, body UpdateFunctionJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateFunctionResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetOrganizations request
	GetOrganizationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOrganizationsResponse, error)

	// CreateOrganization request with any body
	CreateOrganizationWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateOrganizationResponse, error)

	CreateOrganizationWithResponse(ctx context.Context, body CreateOrganizationJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateOrganizationResponse, error)

	// GetProjects request
	GetProjectsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetProjectsResponse, error)

	// CreateProject request with any body
	CreateProjectWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateProjectResponse, error)

	CreateProjectWithResponse(ctx context.Context, body CreateProjectJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateProjectResponse, error)

	// GetFunctions request
	GetFunctionsWithResponse(ctx context.Context, ref string, reqEditors ...RequestEditorFn) (*GetFunctionsResponse, error)

	// CreateFunction request with any body
	CreateFunctionWithBodyWithResponse(ctx context.Context, ref string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFunctionResponse, error)

	CreateFunctionWithResponse(ctx context.Context, ref string, body CreateFunctionJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFunctionResponse, error)

	// DeleteFunction request
	DeleteFunctionWithResponse(ctx context.Context, ref string, functionSlug string, reqEditors ...RequestEditorFn) (*DeleteFunctionResponse, error)

	// GetFunction request
	GetFunctionWithResponse(ctx context.Context, ref string, functionSlug string, params *GetFunctionParams, reqEditors ...RequestEditorFn) (*GetFunctionResponse, error)

	// UpdateFunction request with any body
	UpdateFunctionWithBodyWithResponse(ctx context.Context, ref string, functionSlug string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateFunctionResponse, error)

	UpdateFunctionWithResponse(ctx context.Context, ref string, functionSlug string, body UpdateFunctionJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateFunctionResponse, error)

	// GetConfig request
	GetConfigWithResponse(ctx context.Context, ref string, reqEditors ...RequestEditorFn) (*GetConfigResponse, error)

	// UpdateConfig request with any body
	UpdateConfigWithBodyWithResponse(ctx context.Context, ref string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateConfigResponse, error)

	UpdateConfigWithResponse(ctx context.Context, ref string, body UpdateConfigJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateConfigResponse, error)

	// DeleteSecrets request with any body
	DeleteSecretsWithBodyWithResponse(ctx context.Context, ref string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteSecretsResponse, error)

	DeleteSecretsWithResponse(ctx context.Context, ref string, body DeleteSecretsJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteSecretsResponse, error)

	// GetSecrets request
	GetSecretsWithResponse(ctx context.Context, ref string, reqEditors ...RequestEditorFn) (*GetSecretsResponse, error)

	// CreateSecrets request with any body
	CreateSecretsWithBodyWithResponse(ctx context.Context, ref string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSecretsResponse, error)

	CreateSecretsWithResponse(ctx context.Context, ref string, body CreateSecretsJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSecretsResponse, error)

	// GetTypescriptTypes request
	GetTypescriptTypesWithResponse(ctx context.Context, ref string, params *GetTypescriptTypesParams, reqEditors ...RequestEditorFn) (*GetTypescriptTypesResponse, error)
}

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

type CreateFunctionBody

type CreateFunctionBody struct {
	Body      string `json:"body"`
	Name      string `json:"name"`
	Slug      string `json:"slug"`
	VerifyJwt *bool  `json:"verify_jwt,omitempty"`
}

CreateFunctionBody defines model for CreateFunctionBody.

type CreateFunctionJSONBody

type CreateFunctionJSONBody = CreateFunctionBody

CreateFunctionJSONBody defines parameters for CreateFunction.

type CreateFunctionJSONRequestBody

type CreateFunctionJSONRequestBody = CreateFunctionJSONBody

CreateFunctionJSONRequestBody defines body for CreateFunction for application/json ContentType.

type CreateFunctionResponse

type CreateFunctionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *FunctionResponse
}

func ParseCreateFunctionResponse

func ParseCreateFunctionResponse(rsp *http.Response) (*CreateFunctionResponse, error)

ParseCreateFunctionResponse parses an HTTP response from a CreateFunctionWithResponse call

func (CreateFunctionResponse) Status

func (r CreateFunctionResponse) Status() string

Status returns HTTPResponse.Status

func (CreateFunctionResponse) StatusCode

func (r CreateFunctionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateOrganizationBody

type CreateOrganizationBody struct {
	Name string `json:"name"`
}

CreateOrganizationBody defines model for CreateOrganizationBody.

type CreateOrganizationJSONBody

type CreateOrganizationJSONBody = CreateOrganizationBody

CreateOrganizationJSONBody defines parameters for CreateOrganization.

type CreateOrganizationJSONRequestBody

type CreateOrganizationJSONRequestBody = CreateOrganizationJSONBody

CreateOrganizationJSONRequestBody defines body for CreateOrganization for application/json ContentType.

type CreateOrganizationResponse

type CreateOrganizationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *OrganizationResponse
}

func ParseCreateOrganizationResponse

func ParseCreateOrganizationResponse(rsp *http.Response) (*CreateOrganizationResponse, error)

ParseCreateOrganizationResponse parses an HTTP response from a CreateOrganizationWithResponse call

func (CreateOrganizationResponse) Status

Status returns HTTPResponse.Status

func (CreateOrganizationResponse) StatusCode

func (r CreateOrganizationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateProjectBody

type CreateProjectBody struct {
	DbPass         string                  `json:"db_pass"`
	KpsEnabled     *bool                   `json:"kps_enabled,omitempty"`
	Name           string                  `json:"name"`
	OrganizationId string                  `json:"organization_id"`
	Plan           CreateProjectBodyPlan   `json:"plan"`
	Region         CreateProjectBodyRegion `json:"region"`
}

CreateProjectBody defines model for CreateProjectBody.

type CreateProjectBodyPlan

type CreateProjectBodyPlan string

CreateProjectBodyPlan defines model for CreateProjectBody.Plan.

const (
	Free CreateProjectBodyPlan = "free"
	Pro  CreateProjectBodyPlan = "pro"
)

Defines values for CreateProjectBodyPlan.

type CreateProjectBodyRegion

type CreateProjectBodyRegion string

CreateProjectBodyRegion defines model for CreateProjectBody.Region.

const (
	ApNortheast1 CreateProjectBodyRegion = "ap-northeast-1"
	ApNortheast2 CreateProjectBodyRegion = "ap-northeast-2"
	ApSouth1     CreateProjectBodyRegion = "ap-south-1"
	ApSoutheast1 CreateProjectBodyRegion = "ap-southeast-1"
	ApSoutheast2 CreateProjectBodyRegion = "ap-southeast-2"
	CaCentral1   CreateProjectBodyRegion = "ca-central-1"
	EuCentral1   CreateProjectBodyRegion = "eu-central-1"
	EuWest1      CreateProjectBodyRegion = "eu-west-1"
	EuWest2      CreateProjectBodyRegion = "eu-west-2"
	SaEast1      CreateProjectBodyRegion = "sa-east-1"
	UsEast1      CreateProjectBodyRegion = "us-east-1"
	UsWest1      CreateProjectBodyRegion = "us-west-1"
)

Defines values for CreateProjectBodyRegion.

type CreateProjectJSONBody

type CreateProjectJSONBody = CreateProjectBody

CreateProjectJSONBody defines parameters for CreateProject.

type CreateProjectJSONRequestBody

type CreateProjectJSONRequestBody = CreateProjectJSONBody

CreateProjectJSONRequestBody defines body for CreateProject for application/json ContentType.

type CreateProjectResponse

type CreateProjectResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *ProjectResponse
}

func ParseCreateProjectResponse

func ParseCreateProjectResponse(rsp *http.Response) (*CreateProjectResponse, error)

ParseCreateProjectResponse parses an HTTP response from a CreateProjectWithResponse call

func (CreateProjectResponse) Status

func (r CreateProjectResponse) Status() string

Status returns HTTPResponse.Status

func (CreateProjectResponse) StatusCode

func (r CreateProjectResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateSecretBody

type CreateSecretBody struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

CreateSecretBody defines model for CreateSecretBody.

type CreateSecretsJSONBody

type CreateSecretsJSONBody = []CreateSecretBody

CreateSecretsJSONBody defines parameters for CreateSecrets.

type CreateSecretsJSONRequestBody

type CreateSecretsJSONRequestBody = CreateSecretsJSONBody

CreateSecretsJSONRequestBody defines body for CreateSecrets for application/json ContentType.

type CreateSecretsResponse

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

func ParseCreateSecretsResponse

func ParseCreateSecretsResponse(rsp *http.Response) (*CreateSecretsResponse, error)

ParseCreateSecretsResponse parses an HTTP response from a CreateSecretsWithResponse call

func (CreateSecretsResponse) Status

func (r CreateSecretsResponse) Status() string

Status returns HTTPResponse.Status

func (CreateSecretsResponse) StatusCode

func (r CreateSecretsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteFunctionResponse

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

func ParseDeleteFunctionResponse

func ParseDeleteFunctionResponse(rsp *http.Response) (*DeleteFunctionResponse, error)

ParseDeleteFunctionResponse parses an HTTP response from a DeleteFunctionWithResponse call

func (DeleteFunctionResponse) Status

func (r DeleteFunctionResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteFunctionResponse) StatusCode

func (r DeleteFunctionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteSecretsJSONBody

type DeleteSecretsJSONBody = []string

DeleteSecretsJSONBody defines parameters for DeleteSecrets.

type DeleteSecretsJSONRequestBody

type DeleteSecretsJSONRequestBody = DeleteSecretsJSONBody

DeleteSecretsJSONRequestBody defines body for DeleteSecrets for application/json ContentType.

type DeleteSecretsResponse

type DeleteSecretsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseDeleteSecretsResponse

func ParseDeleteSecretsResponse(rsp *http.Response) (*DeleteSecretsResponse, error)

ParseDeleteSecretsResponse parses an HTTP response from a DeleteSecretsWithResponse call

func (DeleteSecretsResponse) Status

func (r DeleteSecretsResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteSecretsResponse) StatusCode

func (r DeleteSecretsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FunctionResponse

type FunctionResponse struct {
	CreatedAt float32                `json:"created_at"`
	Id        string                 `json:"id"`
	Name      string                 `json:"name"`
	Slug      string                 `json:"slug"`
	Status    FunctionResponseStatus `json:"status"`
	UpdatedAt float32                `json:"updated_at"`
	VerifyJwt *bool                  `json:"verify_jwt,omitempty"`
	Version   float32                `json:"version"`
}

FunctionResponse defines model for FunctionResponse.

type FunctionResponseStatus

type FunctionResponseStatus string

FunctionResponseStatus defines model for FunctionResponse.Status.

const (
	FunctionResponseStatusACTIVE    FunctionResponseStatus = "ACTIVE"
	FunctionResponseStatusREMOVED   FunctionResponseStatus = "REMOVED"
	FunctionResponseStatusTHROTTLED FunctionResponseStatus = "THROTTLED"
)

Defines values for FunctionResponseStatus.

type FunctionSlugResponse

type FunctionSlugResponse struct {
	Body      *string                    `json:"body,omitempty"`
	CreatedAt float32                    `json:"created_at"`
	Id        string                     `json:"id"`
	Name      string                     `json:"name"`
	Slug      string                     `json:"slug"`
	Status    FunctionSlugResponseStatus `json:"status"`
	UpdatedAt float32                    `json:"updated_at"`
	VerifyJwt *bool                      `json:"verify_jwt,omitempty"`
	Version   float32                    `json:"version"`
}

FunctionSlugResponse defines model for FunctionSlugResponse.

type FunctionSlugResponseStatus

type FunctionSlugResponseStatus string

FunctionSlugResponseStatus defines model for FunctionSlugResponse.Status.

const (
	FunctionSlugResponseStatusACTIVE    FunctionSlugResponseStatus = "ACTIVE"
	FunctionSlugResponseStatusREMOVED   FunctionSlugResponseStatus = "REMOVED"
	FunctionSlugResponseStatusTHROTTLED FunctionSlugResponseStatus = "THROTTLED"
)

Defines values for FunctionSlugResponseStatus.

type GetConfigResponse added in v1.8.0

type GetConfigResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseGetConfigResponse added in v1.8.0

func ParseGetConfigResponse(rsp *http.Response) (*GetConfigResponse, error)

ParseGetConfigResponse parses an HTTP response from a GetConfigWithResponse call

func (GetConfigResponse) Status added in v1.8.0

func (r GetConfigResponse) Status() string

Status returns HTTPResponse.Status

func (GetConfigResponse) StatusCode added in v1.8.0

func (r GetConfigResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFunctionParams

type GetFunctionParams struct {
	IncludeBody *bool `form:"include_body,omitempty" json:"include_body,omitempty"`
}

GetFunctionParams defines parameters for GetFunction.

type GetFunctionResponse

type GetFunctionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *FunctionSlugResponse
}

func ParseGetFunctionResponse

func ParseGetFunctionResponse(rsp *http.Response) (*GetFunctionResponse, error)

ParseGetFunctionResponse parses an HTTP response from a GetFunctionWithResponse call

func (GetFunctionResponse) Status

func (r GetFunctionResponse) Status() string

Status returns HTTPResponse.Status

func (GetFunctionResponse) StatusCode

func (r GetFunctionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetFunctionsResponse

type GetFunctionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]FunctionResponse
}

func ParseGetFunctionsResponse

func ParseGetFunctionsResponse(rsp *http.Response) (*GetFunctionsResponse, error)

ParseGetFunctionsResponse parses an HTTP response from a GetFunctionsWithResponse call

func (GetFunctionsResponse) Status

func (r GetFunctionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetFunctionsResponse) StatusCode

func (r GetFunctionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOrganizationsResponse

type GetOrganizationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]OrganizationResponse
}

func ParseGetOrganizationsResponse

func ParseGetOrganizationsResponse(rsp *http.Response) (*GetOrganizationsResponse, error)

ParseGetOrganizationsResponse parses an HTTP response from a GetOrganizationsWithResponse call

func (GetOrganizationsResponse) Status

func (r GetOrganizationsResponse) Status() string

Status returns HTTPResponse.Status

func (GetOrganizationsResponse) StatusCode

func (r GetOrganizationsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetProjectsResponse

type GetProjectsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]ProjectResponse
}

func ParseGetProjectsResponse

func ParseGetProjectsResponse(rsp *http.Response) (*GetProjectsResponse, error)

ParseGetProjectsResponse parses an HTTP response from a GetProjectsWithResponse call

func (GetProjectsResponse) Status

func (r GetProjectsResponse) Status() string

Status returns HTTPResponse.Status

func (GetProjectsResponse) StatusCode

func (r GetProjectsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSecretsResponse

type GetSecretsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]SecretResponse
}

func ParseGetSecretsResponse

func ParseGetSecretsResponse(rsp *http.Response) (*GetSecretsResponse, error)

ParseGetSecretsResponse parses an HTTP response from a GetSecretsWithResponse call

func (GetSecretsResponse) Status

func (r GetSecretsResponse) Status() string

Status returns HTTPResponse.Status

func (GetSecretsResponse) StatusCode

func (r GetSecretsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTypescriptTypesParams added in v1.8.0

type GetTypescriptTypesParams struct {
	IncludedSchemas *string `form:"included_schemas,omitempty" json:"included_schemas,omitempty"`
}

GetTypescriptTypesParams defines parameters for GetTypescriptTypes.

type GetTypescriptTypesResponse added in v1.8.0

type GetTypescriptTypesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TypescriptResponse
}

func ParseGetTypescriptTypesResponse added in v1.8.0

func ParseGetTypescriptTypesResponse(rsp *http.Response) (*GetTypescriptTypesResponse, error)

ParseGetTypescriptTypesResponse parses an HTTP response from a GetTypescriptTypesWithResponse call

func (GetTypescriptTypesResponse) Status added in v1.8.0

Status returns HTTPResponse.Status

func (GetTypescriptTypesResponse) StatusCode added in v1.8.0

func (r GetTypescriptTypesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type OrganizationResponse

type OrganizationResponse struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

OrganizationResponse defines model for OrganizationResponse.

type ProjectResponse

type ProjectResponse struct {
	CreatedAt      string `json:"created_at"`
	Id             string `json:"id"`
	Name           string `json:"name"`
	OrganizationId string `json:"organization_id"`
	Region         string `json:"region"`
}

ProjectResponse defines model for ProjectResponse.

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type SecretResponse

type SecretResponse struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

SecretResponse defines model for SecretResponse.

type TypescriptResponse added in v1.8.0

type TypescriptResponse struct {
	Types string `json:"types"`
}

TypescriptResponse defines model for TypescriptResponse.

type UpdateConfigJSONBody added in v1.8.0

type UpdateConfigJSONBody = UpdatePgsodiumConfigBody

UpdateConfigJSONBody defines parameters for UpdateConfig.

type UpdateConfigJSONRequestBody added in v1.8.0

type UpdateConfigJSONRequestBody = UpdateConfigJSONBody

UpdateConfigJSONRequestBody defines body for UpdateConfig for application/json ContentType.

type UpdateConfigResponse added in v1.8.0

type UpdateConfigResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
}

func ParseUpdateConfigResponse added in v1.8.0

func ParseUpdateConfigResponse(rsp *http.Response) (*UpdateConfigResponse, error)

ParseUpdateConfigResponse parses an HTTP response from a UpdateConfigWithResponse call

func (UpdateConfigResponse) Status added in v1.8.0

func (r UpdateConfigResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateConfigResponse) StatusCode added in v1.8.0

func (r UpdateConfigResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateFunctionBody

type UpdateFunctionBody struct {
	Body      *string `json:"body,omitempty"`
	Name      *string `json:"name,omitempty"`
	VerifyJwt *bool   `json:"verify_jwt,omitempty"`
}

UpdateFunctionBody defines model for UpdateFunctionBody.

type UpdateFunctionJSONBody

type UpdateFunctionJSONBody = UpdateFunctionBody

UpdateFunctionJSONBody defines parameters for UpdateFunction.

type UpdateFunctionJSONRequestBody

type UpdateFunctionJSONRequestBody = UpdateFunctionJSONBody

UpdateFunctionJSONRequestBody defines body for UpdateFunction for application/json ContentType.

type UpdateFunctionResponse

type UpdateFunctionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *FunctionResponse
}

func ParseUpdateFunctionResponse

func ParseUpdateFunctionResponse(rsp *http.Response) (*UpdateFunctionResponse, error)

ParseUpdateFunctionResponse parses an HTTP response from a UpdateFunctionWithResponse call

func (UpdateFunctionResponse) Status

func (r UpdateFunctionResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateFunctionResponse) StatusCode

func (r UpdateFunctionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdatePgsodiumConfigBody added in v1.8.0

type UpdatePgsodiumConfigBody struct {
	RootKey string `json:"root_key"`
}

UpdatePgsodiumConfigBody defines model for UpdatePgsodiumConfigBody.

Jump to

Keyboard shortcuts

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