client

package
v2.6.0 Latest Latest
Warning

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

Go to latest
Published: Jul 3, 2026 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
const (
	CkoRequestId       = "cko-request-id"
	CkoVersion         = "cko-version"
	CkoTelemetryHeader = "cko-sdk-telemetry"
)
View Source
const SDK_VERSION = "2.6.0"

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiClient

type ApiClient struct {
	HttpClient          http.Client
	BaseUri             string
	EnableTelemetry     bool
	RequestMetricsQueue common.TelemetryQueue
	Log                 configuration.StdLogger
}

func NewApiClient

func NewApiClient(configuration *configuration.Configuration, baseUri string) *ApiClient

func (*ApiClient) Delete

func (a *ApiClient) Delete(path string, authorization *configuration.SdkAuthorization, responseMapping interface{}) error

func (*ApiClient) DeleteWithContext

func (a *ApiClient) DeleteWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, responseMapping interface{}) error

func (*ApiClient) Get

func (a *ApiClient) Get(path string, authorization *configuration.SdkAuthorization, responseMapping interface{}) error

func (*ApiClient) GetWithContext

func (a *ApiClient) GetWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, responseMapping interface{}) error

func (*ApiClient) Patch

func (a *ApiClient) Patch(path string, authorization *configuration.SdkAuthorization, request interface{}, responseMapping interface{}) error

func (*ApiClient) PatchWithContext

func (a *ApiClient) PatchWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, request interface{}, responseMapping interface{}) error

func (*ApiClient) Post

func (a *ApiClient) Post(path string, authorization *configuration.SdkAuthorization, request interface{}, responseMapping interface{}, idempotencyKey *string) error

func (*ApiClient) PostForm added in v2.3.0

func (a *ApiClient) PostForm(path string, authorization *configuration.SdkAuthorization, formData url.Values, responseMapping interface{}) error

func (*ApiClient) PostFormWithContext added in v2.3.0

func (a *ApiClient) PostFormWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, formData url.Values, responseMapping interface{}) error

func (*ApiClient) PostWithContext

func (a *ApiClient) PostWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, request interface{}, responseMapping interface{}, idempotencyKey *string) error

func (*ApiClient) Put

func (a *ApiClient) Put(path string, authorization *configuration.SdkAuthorization, request interface{}, responseMapping interface{}, idempotencyKey *string) error

func (*ApiClient) PutWithContext

func (a *ApiClient) PutWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, request interface{}, responseMapping interface{}, idempotencyKey *string) error

func (*ApiClient) Upload

func (a *ApiClient) Upload(path string, authorization *configuration.SdkAuthorization, request *common.FileUploadRequest, responseMapping interface{}) error

func (*ApiClient) UploadWithContext

func (a *ApiClient) UploadWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, request *common.FileUploadRequest, responseMapping interface{}) error

type HttpClient

type HttpClient interface {
	Get(path string, authorization *configuration.SdkAuthorization, responseMapping interface{}) error
	GetWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, responseMapping interface{}) error
	Post(path string, authorization *configuration.SdkAuthorization, request interface{}, responseMapping interface{}, idempotencyKey *string) error
	PostWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, request interface{}, responseMapping interface{}, idempotencyKey *string) error
	Put(path string, authorization *configuration.SdkAuthorization, request interface{}, responseMapping interface{}, idempotencyKey *string) error
	PutWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, request interface{}, responseMapping interface{}, idempotencyKey *string) error
	Patch(path string, authorization *configuration.SdkAuthorization, request interface{}, responseMapping interface{}) error
	PatchWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, request interface{}, responseMapping interface{}) error
	Delete(path string, authorization *configuration.SdkAuthorization, responseMapping interface{}) error
	DeleteWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, responseMapping interface{}) error
	Upload(path string, authorization *configuration.SdkAuthorization, request *common.FileUploadRequest, responseMapping interface{}) error
	UploadWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, request *common.FileUploadRequest, responseMapping interface{}) error
	PostForm(path string, authorization *configuration.SdkAuthorization, formData url.Values, responseMapping interface{}) error
	PostFormWithContext(ctx context.Context, path string, authorization *configuration.SdkAuthorization, formData url.Values, responseMapping interface{}) error
}

Jump to

Keyboard shortcuts

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