operations

type AddPermissionsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Permissions added successfully. Returns all permissions currently assigned to the key.
	V2KeysAddPermissionsResponseBody *components.V2KeysAddPermissionsResponseBody
}

type AddRolesResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Roles added successfully. Returns all roles currently assigned to the key.
	V2KeysAddRolesResponseBody *components.V2KeysAddRolesResponseBody
}

type CreateAPIResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// API namespace created successfully. The response contains the unique API ID for referencing this namespace in key operations.
	//
	V2ApisCreateAPIResponseBody *components.V2ApisCreateAPIResponseBody
}

type CreateKeyResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successfully created a new API key. The response includes both the keyId (for reference in your system) and the full key string. IMPORTANT: This is the only time the complete key is available - it cannot be retrieved later. You must securely provide this key to your end user immediately.
	V2KeysCreateKeyResponseBody *components.V2KeysCreateKeyResponseBody
}

type CreatePermissionResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Permission created successfully
	V2PermissionsCreatePermissionResponseBody *components.V2PermissionsCreatePermissionResponseBody
}

type CreateRoleResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Role created successfully
	V2PermissionsCreateRoleResponseBody *components.V2PermissionsCreateRoleResponseBody
}

type DeleteAPIResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// API namespace deleted successfully. All associated keys are immediately invalidated and will fail verification with `code=NOT_FOUND`.
	V2ApisDeleteAPIResponseBody *components.V2ApisDeleteAPIResponseBody
}

type DeleteKeyResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Key deleted successfully. Verification fails immediately with up to 30-second edge propagation.
	//
	V2KeysDeleteKeyResponseBody *components.V2KeysDeleteKeyResponseBody
}

type DeletePermissionResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Permission deleted successfully
	V2PermissionsDeletePermissionResponseBody *components.V2PermissionsDeletePermissionResponseBody
}

type DeleteRoleResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Role deleted successfully
	V2PermissionsDeleteRoleResponseBody *components.V2PermissionsDeleteRoleResponseBody
}

type GetAPIResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// API information retrieved successfully. Contains the unique API ID and human-readable name.
	V2ApisGetAPIResponseBody *components.V2ApisGetAPIResponseBody
}

type GetKeyResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successfully retrieved key information. When `decrypt: true`, includes plaintext key value for recoverable keys.
	//
	V2KeysGetKeyResponseBody *components.V2KeysGetKeyResponseBody
}

type GetPermissionResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Permission retrieved successfully
	V2PermissionsGetPermissionResponseBody *components.V2PermissionsGetPermissionResponseBody
}

type GetRoleResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Role retrieved successfully
	V2PermissionsGetRoleResponseBody *components.V2PermissionsGetRoleResponseBody
}

type IdentitiesCreateIdentityResponse struct {
	HTTPMeta                               components.HTTPMetadata `json:"-"`
	V2IdentitiesCreateIdentityResponseBody *components.V2IdentitiesCreateIdentityResponseBody
}

type IdentitiesGetIdentityResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successfully retrieved the identity information
	V2IdentitiesGetIdentityResponseBody *components.V2IdentitiesGetIdentityResponseBody
}

type IdentitiesListIdentitiesResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successfully retrieved the list of identities
	V2IdentitiesListIdentitiesResponseBody *components.V2IdentitiesListIdentitiesResponseBody

	Next func() (*IdentitiesListIdentitiesResponse, error)
}

type ListKeysResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successfully retrieved paginated keys. Use the pagination cursor for additional results when `hasMore: true`.
	//
	V2ApisListKeysResponseBody *components.V2ApisListKeysResponseBody
}

type ListPermissionsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Permissions retrieved successfully
	V2PermissionsListPermissionsResponseBody *components.V2PermissionsListPermissionsResponseBody
}

type ListRolesResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Roles retrieved successfully
	V2PermissionsListRolesResponseBody *components.V2PermissionsListRolesResponseBody
}

type Option func(*Options, ...string) error

type Options struct {
	ServerURL   *string
	Retries     *retry.Config
	Timeout     *time.Duration
	URLOverride *string
	SetHeaders  map[string]string
}

type RatelimitDeleteOverrideResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Override successfully deleted. Affected identifiers now use default limits.
	V2RatelimitDeleteOverrideResponseBody *components.V2RatelimitDeleteOverrideResponseBody
}

type RatelimitGetOverrideResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Override found and returned successfully.
	V2RatelimitGetOverrideResponseBody *components.V2RatelimitGetOverrideResponseBody
}

type RatelimitLimitResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Rate limit check completed. Always returns HTTP 200 - check the `success` field to determine if the request is allowed.
	//
	V2RatelimitLimitResponseBody *components.V2RatelimitLimitResponseBody
}

type RatelimitListOverridesResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Overrides retrieved successfully. Includes pagination metadata if more results are available.
	V2RatelimitListOverridesResponseBody *components.V2RatelimitListOverridesResponseBody
}

type RatelimitSetOverrideResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Override successfully created or updated and is now active.
	V2RatelimitSetOverrideResponseBody *components.V2RatelimitSetOverrideResponseBody
}

type RemovePermissionsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Permissions removed successfully. Returns all permissions currently assigned to the key.
	V2KeysRemovePermissionsResponseBody *components.V2KeysRemovePermissionsResponseBody
}

type RemoveRolesResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Roles removed successfully. Returns all roles currently assigned to the key.
	V2KeysRemoveRolesResponseBody *components.V2KeysRemoveRolesResponseBody
}

type SetPermissionsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Permissions set successfully. Returns all permissions currently assigned to the key.
	V2KeysSetPermissionsResponseBody *components.V2KeysSetPermissionsResponseBody
}

type SetRolesResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Roles set successfully. Returns all roles currently assigned to the key.
	V2KeysSetRolesResponseBody *components.V2KeysSetRolesResponseBody
}

type UpdateCreditsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Credits updated successfully. Response includes updated remaining credits and refill settings.
	//
	V2KeysUpdateCreditsResponseBody *components.V2KeysUpdateCreditsResponseBody
}

type UpdateKeyResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Key updated successfully. Changes take effect immediately with up to 30-second edge propagation.
	//
	V2KeysUpdateKeyResponseBody *components.V2KeysUpdateKeyResponseBody
}

type V2IdentitiesDeleteIdentityResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Identity successfully deleted
	V2IdentitiesDeleteIdentityResponseBody *components.V2IdentitiesDeleteIdentityResponseBody
}

type V2IdentitiesUpdateIdentityResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Identity successfully updated
	V2IdentitiesUpdateIdentityResponseBody *components.V2IdentitiesUpdateIdentityResponseBody
}

type VerifyKeyResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Key verification process completed. This endpoint always returns HTTP 200 regardless of whether the key passed or failed verification. You must check the `valid` field in the response data to determine the actual verification result.
	//
	// When verification succeeds, the response includes comprehensive information about the key including its current status, remaining credits, expiration time, associated permissions and roles, metadata, and any rate limiting information. This data enables your application to make informed authorization decisions and provide appropriate user experiences.
	//
	// When verification fails, the response indicates the specific reason through the `code` field while setting `valid` to false. The failure codes help you handle different scenarios appropriately, such as directing users to renew expired keys, upgrade for more credits, or contact support for disabled keys.
	//
	// The response also includes identity information when the key is associated with an identity, providing additional context about the key holder and any identity-specific rate limits or metadata that may apply to the verification.
	//
	V2KeysVerifyKeyResponseBody *components.V2KeysVerifyKeyResponseBody
}

type WhoamiResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successfully retrieved key information.
	//
	V2KeysWhoamiResponseBody *components.V2KeysWhoamiResponseBody
}