deliveryconnect

package
v1.8.1 Latest Latest
Warning

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

Go to latest
Published: Jun 13, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// DeliveryApiCreateTransferConfigProcedure is the fully-qualified name of the DeliveryApi's
	// CreateTransferConfig RPC.
	DeliveryApiCreateTransferConfigProcedure = "/api.v1alpha1.delivery.DeliveryApi/CreateTransferConfig"
	// DeliveryApiListTransferConfigsProcedure is the fully-qualified name of the DeliveryApi's
	// ListTransferConfigs RPC.
	DeliveryApiListTransferConfigsProcedure = "/api.v1alpha1.delivery.DeliveryApi/ListTransferConfigs"
	// DeliveryApiListTransferConfigsByCredentialIDProcedure is the fully-qualified name of the
	// DeliveryApi's ListTransferConfigsByCredentialID RPC.
	DeliveryApiListTransferConfigsByCredentialIDProcedure = "/api.v1alpha1.delivery.DeliveryApi/ListTransferConfigsByCredentialID"
	// DeliveryApiUpdateTransferConfigProcedure is the fully-qualified name of the DeliveryApi's
	// UpdateTransferConfig RPC.
	DeliveryApiUpdateTransferConfigProcedure = "/api.v1alpha1.delivery.DeliveryApi/UpdateTransferConfig"
	// DeliveryApiDeleteTransferConfigProcedure is the fully-qualified name of the DeliveryApi's
	// DeleteTransferConfig RPC.
	DeliveryApiDeleteTransferConfigProcedure = "/api.v1alpha1.delivery.DeliveryApi/DeleteTransferConfig"
	// DeliveryApiGetTransferConfigProcedure is the fully-qualified name of the DeliveryApi's
	// GetTransferConfig RPC.
	DeliveryApiGetTransferConfigProcedure = "/api.v1alpha1.delivery.DeliveryApi/GetTransferConfig"
	// DeliveryApiGetTransferConfigByNameProcedure is the fully-qualified name of the DeliveryApi's
	// GetTransferConfigByName RPC.
	DeliveryApiGetTransferConfigByNameProcedure = "/api.v1alpha1.delivery.DeliveryApi/GetTransferConfigByName"
	// DeliveryApiListHistoryProcedure is the fully-qualified name of the DeliveryApi's ListHistory RPC.
	DeliveryApiListHistoryProcedure = "/api.v1alpha1.delivery.DeliveryApi/ListHistory"
	// DeliveryApiListHistoryByTransferConfigProcedure is the fully-qualified name of the DeliveryApi's
	// ListHistoryByTransferConfig RPC.
	DeliveryApiListHistoryByTransferConfigProcedure = "/api.v1alpha1.delivery.DeliveryApi/ListHistoryByTransferConfig"
	// DeliveryApiListCredentialsProcedure is the fully-qualified name of the DeliveryApi's
	// ListCredentials RPC.
	DeliveryApiListCredentialsProcedure = "/api.v1alpha1.delivery.DeliveryApi/ListCredentials"
	// DeliveryApiGetCredentialProcedure is the fully-qualified name of the DeliveryApi's GetCredential
	// RPC.
	DeliveryApiGetCredentialProcedure = "/api.v1alpha1.delivery.DeliveryApi/GetCredential"
	// DeliveryApiCreateCredentialProcedure is the fully-qualified name of the DeliveryApi's
	// CreateCredential RPC.
	DeliveryApiCreateCredentialProcedure = "/api.v1alpha1.delivery.DeliveryApi/CreateCredential"
	// DeliveryApiDeleteCredentialProcedure is the fully-qualified name of the DeliveryApi's
	// DeleteCredential RPC.
	DeliveryApiDeleteCredentialProcedure = "/api.v1alpha1.delivery.DeliveryApi/DeleteCredential"
	// DeliveryApiUpdateCredentialProcedure is the fully-qualified name of the DeliveryApi's
	// UpdateCredential RPC.
	DeliveryApiUpdateCredentialProcedure = "/api.v1alpha1.delivery.DeliveryApi/UpdateCredential"
	// DeliveryApiCreateDeliveryDefinitionProcedure is the fully-qualified name of the DeliveryApi's
	// CreateDeliveryDefinition RPC.
	DeliveryApiCreateDeliveryDefinitionProcedure = "/api.v1alpha1.delivery.DeliveryApi/CreateDeliveryDefinition"
	// DeliveryApiDeleteDeliveryDefinitionProcedure is the fully-qualified name of the DeliveryApi's
	// DeleteDeliveryDefinition RPC.
	DeliveryApiDeleteDeliveryDefinitionProcedure = "/api.v1alpha1.delivery.DeliveryApi/DeleteDeliveryDefinition"
	// DeliveryApiGetDeliveryDefinitionProcedure is the fully-qualified name of the DeliveryApi's
	// GetDeliveryDefinition RPC.
	DeliveryApiGetDeliveryDefinitionProcedure = "/api.v1alpha1.delivery.DeliveryApi/GetDeliveryDefinition"
	// DeliveryApiGetDeliveryDefinitionByNameProcedure is the fully-qualified name of the DeliveryApi's
	// GetDeliveryDefinitionByName RPC.
	DeliveryApiGetDeliveryDefinitionByNameProcedure = "/api.v1alpha1.delivery.DeliveryApi/GetDeliveryDefinitionByName"
	// DeliveryApiListDeliveryDefinitionsProcedure is the fully-qualified name of the DeliveryApi's
	// ListDeliveryDefinitions RPC.
	DeliveryApiListDeliveryDefinitionsProcedure = "/api.v1alpha1.delivery.DeliveryApi/ListDeliveryDefinitions"
	// DeliveryApiListDeliveryDefinitionsByCredentialIDProcedure is the fully-qualified name of the
	// DeliveryApi's ListDeliveryDefinitionsByCredentialID RPC.
	DeliveryApiListDeliveryDefinitionsByCredentialIDProcedure = "/api.v1alpha1.delivery.DeliveryApi/ListDeliveryDefinitionsByCredentialID"
	// DeliveryApiUpdateDeliveryDefinitionProcedure is the fully-qualified name of the DeliveryApi's
	// UpdateDeliveryDefinition RPC.
	DeliveryApiUpdateDeliveryDefinitionProcedure = "/api.v1alpha1.delivery.DeliveryApi/UpdateDeliveryDefinition"
	// DeliveryApiCreateEncryptionProcedure is the fully-qualified name of the DeliveryApi's
	// CreateEncryption RPC.
	DeliveryApiCreateEncryptionProcedure = "/api.v1alpha1.delivery.DeliveryApi/CreateEncryption"
	// DeliveryApiDeleteEncryptionProcedure is the fully-qualified name of the DeliveryApi's
	// DeleteEncryption RPC.
	DeliveryApiDeleteEncryptionProcedure = "/api.v1alpha1.delivery.DeliveryApi/DeleteEncryption"
	// DeliveryApiGetEncryptionProcedure is the fully-qualified name of the DeliveryApi's GetEncryption
	// RPC.
	DeliveryApiGetEncryptionProcedure = "/api.v1alpha1.delivery.DeliveryApi/GetEncryption"
	// DeliveryApiListEncryptionsProcedure is the fully-qualified name of the DeliveryApi's
	// ListEncryptions RPC.
	DeliveryApiListEncryptionsProcedure = "/api.v1alpha1.delivery.DeliveryApi/ListEncryptions"
	// DeliveryApiUpdateEncryptionProcedure is the fully-qualified name of the DeliveryApi's
	// UpdateEncryption RPC.
	DeliveryApiUpdateEncryptionProcedure = "/api.v1alpha1.delivery.DeliveryApi/UpdateEncryption"
	// DeliveryApiListSMSNumbersProcedure is the fully-qualified name of the DeliveryApi's
	// ListSMSNumbers RPC.
	DeliveryApiListSMSNumbersProcedure = "/api.v1alpha1.delivery.DeliveryApi/ListSMSNumbers"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// DeliveryApiName is the fully-qualified name of the DeliveryApi service.
	DeliveryApiName = "api.v1alpha1.delivery.DeliveryApi"
)

Variables

This section is empty.

Functions

func NewDeliveryApiHandler

func NewDeliveryApiHandler(svc DeliveryApiHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewDeliveryApiHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type DeliveryApiClient

type DeliveryApiClient interface {
	CreateTransferConfig(context.Context, *connect_go.Request[delivery.CreateTransferConfigReq]) (*connect_go.Response[delivery.CreateTransferConfigRes], error)
	ListTransferConfigs(context.Context, *connect_go.Request[delivery.ListTransferConfigsReq]) (*connect_go.Response[delivery.ListTransferConfigsRes], error)
	ListTransferConfigsByCredentialID(context.Context, *connect_go.Request[delivery.ListTransferConfigsByCredentialIDReq]) (*connect_go.Response[delivery.ListTransferConfigsByCredentialIDRes], error)
	UpdateTransferConfig(context.Context, *connect_go.Request[delivery.UpdateTransferConfigReq]) (*connect_go.Response[delivery.UpdateTransferConfigRes], error)
	DeleteTransferConfig(context.Context, *connect_go.Request[delivery.DeleteTransferConfigReq]) (*connect_go.Response[delivery.DeleteTransferConfigRes], error)
	GetTransferConfig(context.Context, *connect_go.Request[delivery.GetTransferConfigReq]) (*connect_go.Response[delivery.GetTransferConfigRes], error)
	GetTransferConfigByName(context.Context, *connect_go.Request[delivery.GetTransferConfigByNameReq]) (*connect_go.Response[delivery.GetTransferConfigByNameRes], error)
	ListHistory(context.Context, *connect_go.Request[delivery.ListHistoryReq]) (*connect_go.Response[delivery.ListHistoryRes], error)
	ListHistoryByTransferConfig(context.Context, *connect_go.Request[delivery.ListHistoryByTransferConfigReq]) (*connect_go.Response[delivery.ListHistoryByTransferConfigRes], error)
	ListCredentials(context.Context, *connect_go.Request[delivery.ListCredentialsReq]) (*connect_go.Response[delivery.ListCredentialsRes], error)
	GetCredential(context.Context, *connect_go.Request[delivery.GetCredentialReq]) (*connect_go.Response[delivery.GetCredentialRes], error)
	CreateCredential(context.Context, *connect_go.Request[delivery.CreateCredentialReq]) (*connect_go.Response[delivery.CreateCredentialRes], error)
	DeleteCredential(context.Context, *connect_go.Request[delivery.DeleteCredentialReq]) (*connect_go.Response[delivery.DeleteCredentialRes], error)
	UpdateCredential(context.Context, *connect_go.Request[delivery.UpdateCredentialReq]) (*connect_go.Response[delivery.UpdateCredentialRes], error)
	CreateDeliveryDefinition(context.Context, *connect_go.Request[delivery.CreateDeliveryDefinitionReq]) (*connect_go.Response[delivery.CreateDeliveryDefinitionRes], error)
	DeleteDeliveryDefinition(context.Context, *connect_go.Request[delivery.DeleteDeliveryDefinitionReq]) (*connect_go.Response[delivery.DeleteDeliveryDefinitionRes], error)
	GetDeliveryDefinition(context.Context, *connect_go.Request[delivery.GetDeliveryDefinitionReq]) (*connect_go.Response[delivery.GetDeliveryDefinitionRes], error)
	GetDeliveryDefinitionByName(context.Context, *connect_go.Request[delivery.GetDeliveryDefinitionByNameReq]) (*connect_go.Response[delivery.GetDeliveryDefinitionByNameRes], error)
	ListDeliveryDefinitions(context.Context, *connect_go.Request[delivery.ListDeliveryDefinitionsReq]) (*connect_go.Response[delivery.ListDeliveryDefinitionsRes], error)
	ListDeliveryDefinitionsByCredentialID(context.Context, *connect_go.Request[delivery.ListDeliveryDefinitionsByCredentialIDReq]) (*connect_go.Response[delivery.ListDeliveryDefinitionsByCredentialIDRes], error)
	UpdateDeliveryDefinition(context.Context, *connect_go.Request[delivery.UpdateDeliveryDefinitionReq]) (*connect_go.Response[delivery.UpdateDeliveryDefinitionRes], error)
	CreateEncryption(context.Context, *connect_go.Request[delivery.CreateEncryptionReq]) (*connect_go.Response[delivery.CreateEncryptionRes], error)
	DeleteEncryption(context.Context, *connect_go.Request[delivery.DeleteEncryptionReq]) (*connect_go.Response[delivery.DeleteEncryptionRes], error)
	GetEncryption(context.Context, *connect_go.Request[delivery.GetEncryptionReq]) (*connect_go.Response[delivery.GetEncryptionRes], error)
	ListEncryptions(context.Context, *connect_go.Request[delivery.ListEncryptionsReq]) (*connect_go.Response[delivery.ListEncryptionsRes], error)
	UpdateEncryption(context.Context, *connect_go.Request[delivery.UpdateEncryptionReq]) (*connect_go.Response[delivery.UpdateEncryptionRes], error)
	ListSMSNumbers(context.Context, *connect_go.Request[delivery.ListSMSNumbersReq]) (*connect_go.Response[delivery.ListSMSNumbersRes], error)
}

DeliveryApiClient is a client for the api.v1alpha1.delivery.DeliveryApi service.

func NewDeliveryApiClient

func NewDeliveryApiClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) DeliveryApiClient

NewDeliveryApiClient constructs a client for the api.v1alpha1.delivery.DeliveryApi service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type DeliveryApiHandler

type DeliveryApiHandler interface {
	CreateTransferConfig(context.Context, *connect_go.Request[delivery.CreateTransferConfigReq]) (*connect_go.Response[delivery.CreateTransferConfigRes], error)
	ListTransferConfigs(context.Context, *connect_go.Request[delivery.ListTransferConfigsReq]) (*connect_go.Response[delivery.ListTransferConfigsRes], error)
	ListTransferConfigsByCredentialID(context.Context, *connect_go.Request[delivery.ListTransferConfigsByCredentialIDReq]) (*connect_go.Response[delivery.ListTransferConfigsByCredentialIDRes], error)
	UpdateTransferConfig(context.Context, *connect_go.Request[delivery.UpdateTransferConfigReq]) (*connect_go.Response[delivery.UpdateTransferConfigRes], error)
	DeleteTransferConfig(context.Context, *connect_go.Request[delivery.DeleteTransferConfigReq]) (*connect_go.Response[delivery.DeleteTransferConfigRes], error)
	GetTransferConfig(context.Context, *connect_go.Request[delivery.GetTransferConfigReq]) (*connect_go.Response[delivery.GetTransferConfigRes], error)
	GetTransferConfigByName(context.Context, *connect_go.Request[delivery.GetTransferConfigByNameReq]) (*connect_go.Response[delivery.GetTransferConfigByNameRes], error)
	ListHistory(context.Context, *connect_go.Request[delivery.ListHistoryReq]) (*connect_go.Response[delivery.ListHistoryRes], error)
	ListHistoryByTransferConfig(context.Context, *connect_go.Request[delivery.ListHistoryByTransferConfigReq]) (*connect_go.Response[delivery.ListHistoryByTransferConfigRes], error)
	ListCredentials(context.Context, *connect_go.Request[delivery.ListCredentialsReq]) (*connect_go.Response[delivery.ListCredentialsRes], error)
	GetCredential(context.Context, *connect_go.Request[delivery.GetCredentialReq]) (*connect_go.Response[delivery.GetCredentialRes], error)
	CreateCredential(context.Context, *connect_go.Request[delivery.CreateCredentialReq]) (*connect_go.Response[delivery.CreateCredentialRes], error)
	DeleteCredential(context.Context, *connect_go.Request[delivery.DeleteCredentialReq]) (*connect_go.Response[delivery.DeleteCredentialRes], error)
	UpdateCredential(context.Context, *connect_go.Request[delivery.UpdateCredentialReq]) (*connect_go.Response[delivery.UpdateCredentialRes], error)
	CreateDeliveryDefinition(context.Context, *connect_go.Request[delivery.CreateDeliveryDefinitionReq]) (*connect_go.Response[delivery.CreateDeliveryDefinitionRes], error)
	DeleteDeliveryDefinition(context.Context, *connect_go.Request[delivery.DeleteDeliveryDefinitionReq]) (*connect_go.Response[delivery.DeleteDeliveryDefinitionRes], error)
	GetDeliveryDefinition(context.Context, *connect_go.Request[delivery.GetDeliveryDefinitionReq]) (*connect_go.Response[delivery.GetDeliveryDefinitionRes], error)
	GetDeliveryDefinitionByName(context.Context, *connect_go.Request[delivery.GetDeliveryDefinitionByNameReq]) (*connect_go.Response[delivery.GetDeliveryDefinitionByNameRes], error)
	ListDeliveryDefinitions(context.Context, *connect_go.Request[delivery.ListDeliveryDefinitionsReq]) (*connect_go.Response[delivery.ListDeliveryDefinitionsRes], error)
	ListDeliveryDefinitionsByCredentialID(context.Context, *connect_go.Request[delivery.ListDeliveryDefinitionsByCredentialIDReq]) (*connect_go.Response[delivery.ListDeliveryDefinitionsByCredentialIDRes], error)
	UpdateDeliveryDefinition(context.Context, *connect_go.Request[delivery.UpdateDeliveryDefinitionReq]) (*connect_go.Response[delivery.UpdateDeliveryDefinitionRes], error)
	CreateEncryption(context.Context, *connect_go.Request[delivery.CreateEncryptionReq]) (*connect_go.Response[delivery.CreateEncryptionRes], error)
	DeleteEncryption(context.Context, *connect_go.Request[delivery.DeleteEncryptionReq]) (*connect_go.Response[delivery.DeleteEncryptionRes], error)
	GetEncryption(context.Context, *connect_go.Request[delivery.GetEncryptionReq]) (*connect_go.Response[delivery.GetEncryptionRes], error)
	ListEncryptions(context.Context, *connect_go.Request[delivery.ListEncryptionsReq]) (*connect_go.Response[delivery.ListEncryptionsRes], error)
	UpdateEncryption(context.Context, *connect_go.Request[delivery.UpdateEncryptionReq]) (*connect_go.Response[delivery.UpdateEncryptionRes], error)
	ListSMSNumbers(context.Context, *connect_go.Request[delivery.ListSMSNumbersReq]) (*connect_go.Response[delivery.ListSMSNumbersRes], error)
}

DeliveryApiHandler is an implementation of the api.v1alpha1.delivery.DeliveryApi service.

type UnimplementedDeliveryApiHandler

type UnimplementedDeliveryApiHandler struct{}

UnimplementedDeliveryApiHandler returns CodeUnimplemented from all methods.

func (UnimplementedDeliveryApiHandler) GetEncryption added in v1.7.36

func (UnimplementedDeliveryApiHandler) ListEncryptions added in v1.7.36

func (UnimplementedDeliveryApiHandler) ListSMSNumbers added in v1.7.59

Jump to

Keyboard shortcuts

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