Documentation
¶
Index ¶
- Variables
- func Bool(b bool) *bool
- func Float32(f float32) *float32
- func Float64(f float64) *float64
- func Int(i int) *int
- func Int64(i int64) *int64
- func String(s string) *string
- type Apis
- func (s *Apis) DeleteKeys(ctx context.Context, request operations.DeleteKeysRequestBody) (*operations.DeleteKeysResponse, error)
- func (s *Apis) GetAPI(ctx context.Context, request operations.GetAPIRequest) (*operations.GetAPIResponse, error)
- func (s *Apis) ListKeys(ctx context.Context, request operations.ListKeysRequest) (*operations.ListKeysResponse, error)
- type HTTPClient
- type Keys
- func (s *Keys) CreateKey(ctx context.Context, request operations.CreateKeyRequestBody) (*operations.CreateKeyResponse, error)
- func (s *Keys) DeleteKey(ctx context.Context, request operations.DeleteKeyRequestBody) (*operations.DeleteKeyResponse, error)
- func (s *Keys) GetKey(ctx context.Context, request operations.GetKeyRequest) (*operations.GetKeyResponse, error)
- func (s *Keys) GetVerifications(ctx context.Context, request operations.GetVerificationsRequest) (*operations.GetVerificationsResponse, error)
- func (s *Keys) UpdateKey(ctx context.Context, request operations.UpdateKeyRequestBody) (*operations.UpdateKeyResponse, error)
- func (s *Keys) UpdateRemaining(ctx context.Context, request operations.UpdateRemainingRequestBody) (*operations.UpdateRemainingResponse, error)
- func (s *Keys) VerifyKey(ctx context.Context, request components.V1KeysVerifyKeyRequest) (*operations.VerifyKeyResponse, error)
- type Liveness
- type Migrations
- func (s *Migrations) V1MigrationsCreateKeys(ctx context.Context, request []operations.RequestBody) (*operations.V1MigrationsCreateKeysResponse, error)
- func (s *Migrations) V1MigrationsEnqueueKeys(ctx context.Context, request operations.V1MigrationsEnqueueKeysRequestBody) (*operations.V1MigrationsEnqueueKeysResponse, error)
- type Ratelimits
- type SDKOption
- func WithClient(client HTTPClient) SDKOption
- func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
- func WithSecurity(bearerAuth string) SDKOption
- func WithSecuritySource(security func(context.Context) (components.Security, error)) SDKOption
- func WithServerIndex(serverIndex int) SDKOption
- func WithServerURL(serverURL string) SDKOption
- func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption
- type Unkey
Constants ¶
This section is empty.
Variables ¶
View Source
var ServerList = []string{
"https://api.unkey.dev",
}
ServerList contains the list of servers available to the SDK
Functions ¶
Types ¶
type Apis ¶
type Apis struct {
// contains filtered or unexported fields
}
func (*Apis) DeleteKeys ¶ added in v0.3.0
func (s *Apis) DeleteKeys(ctx context.Context, request operations.DeleteKeysRequestBody) (*operations.DeleteKeysResponse, error)
func (*Apis) GetAPI ¶
func (s *Apis) GetAPI(ctx context.Context, request operations.GetAPIRequest) (*operations.GetAPIResponse, error)
func (*Apis) ListKeys ¶
func (s *Apis) ListKeys(ctx context.Context, request operations.ListKeysRequest) (*operations.ListKeysResponse, error)
type HTTPClient ¶
HTTPClient provides an interface for suplying the SDK with a custom HTTP client
type Keys ¶
type Keys struct {
// contains filtered or unexported fields
}
func (*Keys) CreateKey ¶
func (s *Keys) CreateKey(ctx context.Context, request operations.CreateKeyRequestBody) (*operations.CreateKeyResponse, error)
func (*Keys) DeleteKey ¶
func (s *Keys) DeleteKey(ctx context.Context, request operations.DeleteKeyRequestBody) (*operations.DeleteKeyResponse, error)
func (*Keys) GetKey ¶
func (s *Keys) GetKey(ctx context.Context, request operations.GetKeyRequest) (*operations.GetKeyResponse, error)
func (*Keys) GetVerifications ¶
func (s *Keys) GetVerifications(ctx context.Context, request operations.GetVerificationsRequest) (*operations.GetVerificationsResponse, error)
func (*Keys) UpdateKey ¶
func (s *Keys) UpdateKey(ctx context.Context, request operations.UpdateKeyRequestBody) (*operations.UpdateKeyResponse, error)
func (*Keys) UpdateRemaining ¶
func (s *Keys) UpdateRemaining(ctx context.Context, request operations.UpdateRemainingRequestBody) (*operations.UpdateRemainingResponse, error)
func (*Keys) VerifyKey ¶
func (s *Keys) VerifyKey(ctx context.Context, request components.V1KeysVerifyKeyRequest) (*operations.VerifyKeyResponse, error)
type Liveness ¶
type Liveness struct {
// contains filtered or unexported fields
}
func (*Liveness) V1Liveness ¶
func (s *Liveness) V1Liveness(ctx context.Context) (*operations.V1LivenessResponse, error)
type Migrations ¶
type Migrations struct {
// contains filtered or unexported fields
}
func (*Migrations) V1MigrationsCreateKeys ¶
func (s *Migrations) V1MigrationsCreateKeys(ctx context.Context, request []operations.RequestBody) (*operations.V1MigrationsCreateKeysResponse, error)
func (*Migrations) V1MigrationsEnqueueKeys ¶ added in v0.3.1
func (s *Migrations) V1MigrationsEnqueueKeys(ctx context.Context, request operations.V1MigrationsEnqueueKeysRequestBody) (*operations.V1MigrationsEnqueueKeysResponse, error)
type Ratelimits ¶
type Ratelimits struct {
// contains filtered or unexported fields
}
func (*Ratelimits) Limit ¶
func (s *Ratelimits) Limit(ctx context.Context, request operations.LimitRequestBody) (*operations.LimitResponse, error)
type SDKOption ¶
type SDKOption func(*Unkey)
func WithClient ¶
func WithClient(client HTTPClient) SDKOption
WithClient allows the overriding of the default HTTP client used by the SDK
func WithRetryConfig ¶
func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
func WithSecurity ¶
WithSecurity configures the SDK to use the provided security details
func WithSecuritySource ¶
WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication
func WithServerIndex ¶
WithServerIndex allows the overriding of the default server by index
func WithServerURL ¶
WithServerURL allows the overriding of the default server URL
type Unkey ¶
type Unkey struct { Liveness *Liveness Keys *Keys Apis *Apis Ratelimits *Ratelimits Migrations *Migrations // contains filtered or unexported fields }
func (*Unkey) CreateAPI ¶
func (s *Unkey) CreateAPI(ctx context.Context, request operations.CreateAPIRequestBody) (*operations.CreateAPIResponse, error)
func (*Unkey) DeleteAPI ¶
func (s *Unkey) DeleteAPI(ctx context.Context, request operations.DeleteAPIRequestBody) (*operations.DeleteAPIResponse, error)
Source Files
¶
Click to show internal directories.
Click to hide internal directories.