internalapi

Documentation

Overview

Package internalapi, DO NOT USE THIS FILE, THE API WILL CHANGE WITHOUT WARNING!!!!

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Index

• type InternalSvix
  • func New(token string, serverUrl *url.URL, debug bool, userAgentSuffix string) (*InternalSvix, error)
• type Management
• type ManagementAuthentication
  • func (managementAuthentication *ManagementAuthentication) CreateApiToken(ctx context.Context, envId string, apiTokenIn models.ApiTokenIn, ...) (*models.ApiTokenOut, error)
  • func (managementAuthentication *ManagementAuthentication) ExpireApiToken(ctx context.Context, envId string, keyId string, ...) error
• type ManagementAuthenticationCreateApiTokenOptions
• type ManagementAuthenticationExpireApiTokenOptions
• type ManagementEnvironment
  • func (managementEnvironment *ManagementEnvironment) Create(ctx context.Context, environmentModelIn models.EnvironmentModelIn, ...) (*models.EnvironmentModelOut, error)
  • func (managementEnvironment *ManagementEnvironment) Delete(ctx context.Context, envId string) error
  • func (managementEnvironment *ManagementEnvironment) Get(ctx context.Context, envId string) (*models.EnvironmentModelOut, error)
  • func (managementEnvironment *ManagementEnvironment) List(ctx context.Context, o *ManagementEnvironmentListOptions) (*models.ListResponseEnvironmentModelOut, error)
  • func (managementEnvironment *ManagementEnvironment) Update(ctx context.Context, envId string, ...) (*models.EnvironmentModelOut, error)
• type ManagementEnvironmentCreateOptions
• type ManagementEnvironmentListOptions
• type ManagementEnvironmentSettings
  • func (managementEnvironmentSettings *ManagementEnvironmentSettings) Get(ctx context.Context) (*models.SettingsInternalOut, error)
  • func (managementEnvironmentSettings *ManagementEnvironmentSettings) Patch(ctx context.Context, settingsInternalPatch models.SettingsInternalPatch) (*models.SettingsInternalOut, error)
  • func (managementEnvironmentSettings *ManagementEnvironmentSettings) Update(ctx context.Context, settingsInternalIn models.SettingsInternalIn) (*models.SettingsInternalUpdateOut, error)

Types

type InternalSvix

type InternalSvix struct {
	Management *Management
}

THIS TYPE CAN AND WILL CHANGE WITHOUT WARNING

func New

func New(token string, serverUrl *url.URL, debug bool, userAgentSuffix string) (*InternalSvix, error)

type Management

type Management struct {
	Authentication      *ManagementAuthentication
	Environment         *ManagementEnvironment
	EnvironmentSettings *ManagementEnvironmentSettings
}

type ManagementAuthentication

type ManagementAuthentication struct {
	// contains filtered or unexported fields
}

func (*ManagementAuthentication) CreateApiToken

func (managementAuthentication *ManagementAuthentication) CreateApiToken(
	ctx context.Context,
	envId string,
	apiTokenIn models.ApiTokenIn,
	o *ManagementAuthenticationCreateApiTokenOptions,
) (*models.ApiTokenOut, error)

Create a new API Token.

func (*ManagementAuthentication) ExpireApiToken

func (managementAuthentication *ManagementAuthentication) ExpireApiToken(
	ctx context.Context,
	envId string,
	keyId string,
	apiTokenExpireIn models.ApiTokenExpireIn,
	o *ManagementAuthenticationExpireApiTokenOptions,
) error

Expire the selected API Token.

type ManagementAuthenticationCreateApiTokenOptions

type ManagementAuthenticationCreateApiTokenOptions struct {
	IdempotencyKey *string
}

type ManagementAuthenticationExpireApiTokenOptions

type ManagementAuthenticationExpireApiTokenOptions struct {
	IdempotencyKey *string
}

type ManagementEnvironment

type ManagementEnvironment struct {
	// contains filtered or unexported fields
}

func (*ManagementEnvironment) Create

func (managementEnvironment *ManagementEnvironment) Create(
	ctx context.Context,
	environmentModelIn models.EnvironmentModelIn,
	o *ManagementEnvironmentCreateOptions,
) (*models.EnvironmentModelOut, error)

Create a new environment.

func (*ManagementEnvironment) Delete

func (managementEnvironment *ManagementEnvironment) Delete(
	ctx context.Context,
	envId string,
) error

Delete an environment.

func (*ManagementEnvironment) Get

func (managementEnvironment *ManagementEnvironment) Get(
	ctx context.Context,
	envId string,
) (*models.EnvironmentModelOut, error)

Get an environment.

func (*ManagementEnvironment) List

func (managementEnvironment *ManagementEnvironment) List(
	ctx context.Context,
	o *ManagementEnvironmentListOptions,
) (*models.ListResponseEnvironmentModelOut, error)

List all environments.

func (*ManagementEnvironment) Update

func (managementEnvironment *ManagementEnvironment) Update(
	ctx context.Context,
	envId string,
	environmentModelUpdate models.EnvironmentModelUpdate,
) (*models.EnvironmentModelOut, error)

Update an environment.

type ManagementEnvironmentCreateOptions

type ManagementEnvironmentCreateOptions struct {
	IdempotencyKey *string
}

type ManagementEnvironmentListOptions

type ManagementEnvironmentListOptions struct {
	// Limit the number of returned items
	Limit *uint64
	// The iterator returned from a prior invocation
	Iterator *string

	// The sorting order of the returned items
	Order *models.Ordering
}

type ManagementEnvironmentSettings

type ManagementEnvironmentSettings struct {
	// contains filtered or unexported fields
}

func (*ManagementEnvironmentSettings) Get

func (managementEnvironmentSettings *ManagementEnvironmentSettings) Get(
	ctx context.Context,
) (*models.SettingsInternalOut, error)

Get the environments's settings

func (*ManagementEnvironmentSettings) Patch

func (managementEnvironmentSettings *ManagementEnvironmentSettings) Patch(
	ctx context.Context,
	settingsInternalPatch models.SettingsInternalPatch,
) (*models.SettingsInternalOut, error)

Patch environment settings

func (*ManagementEnvironmentSettings) Update

func (managementEnvironmentSettings *ManagementEnvironmentSettings) Update(
	ctx context.Context,
	settingsInternalIn models.SettingsInternalIn,
) (*models.SettingsInternalUpdateOut, error)

Update the environment's settings