openapi

type AnalyticsGetVerificationsJSONRequestBody = V2AnalyticsGetVerificationsRequestBody

type ApisCreateApiJSONRequestBody = V2ApisCreateApiRequestBody

type ApisDeleteApiJSONRequestBody = V2ApisDeleteApiRequestBody

type ApisGetApiJSONRequestBody = V2ApisGetApiRequestBody

type ApisListKeysJSONRequestBody = V2ApisListKeysRequestBody

type App struct {
	// CreatedAt Unix timestamp in milliseconds when the app was created.
	CreatedAt int64 `json:"createdAt"`

	// CurrentDeploymentId The identifier of the deployment currently serving this app.
	// Omitted if the app has no active deployment yet.
	CurrentDeploymentId string `json:"currentDeploymentId,omitempty"`

	// DefaultBranch The default git branch deployments track for this app.
	DefaultBranch string `json:"defaultBranch"`

	// DeleteProtection Whether delete protection is enabled for this app.
	// When true, the app cannot be deleted until protection is disabled.
	DeleteProtection bool `json:"deleteProtection"`

	// Id The unique identifier of the app, generated by Unkey.
	Id string `json:"id"`

	// IsRolledBack Whether the app is currently serving a rolled-back deployment rather than its latest one.
	IsRolledBack bool `json:"isRolledBack"`

	// Name Human-readable name for this app.
	Name string `json:"name"`

	// Slug URL-safe handle for this app, unique within its project.
	// Chosen at creation time.
	Slug string `json:"slug"`

	// UpdatedAt Unix timestamp in milliseconds when the app was last updated.
	// Omitted if the app has never been updated.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

type AppsCreateAppJSONRequestBody = V2AppsCreateAppRequestBody

type AppsDeleteAppJSONRequestBody = V2AppsDeleteAppRequestBody

type AppsGetAppJSONRequestBody = V2AppsGetAppRequestBody

type AppsListAppsJSONRequestBody = V2AppsListAppsRequestBody

type AppsUpdateAppJSONRequestBody = V2AppsUpdateAppRequestBody

type AuthenticatedSubjectKey = map[string]interface{}

type BadRequestErrorDetails struct {
	// Detail A human-readable explanation specific to this occurrence of the problem. This provides detailed information about what went wrong and potential remediation steps. The message is intended to be helpful for developers troubleshooting the issue.
	Detail string `json:"detail"`

	// Errors List of individual validation errors that occurred in the request. Each error provides specific details about what failed validation, where the error occurred in the request, and suggestions for fixing it. This granular information helps developers quickly identify and resolve multiple issues in a single request without having to make repeated API calls.
	Errors []ValidationError `json:"errors"`

	// Status HTTP status code that corresponds to this error. This will match the status code in the HTTP response. Common codes include `400` (Bad Request), `401` (Unauthorized), `403` (Forbidden), `404` (Not Found), `409` (Conflict), and `500` (Internal Server Error).
	Status int `json:"status"`

	// Title A short, human-readable summary of the problem type. This remains constant from occurrence to occurrence of the same problem and should be used for programmatic handling.
	Title string `json:"title"`

	// Type A URI reference that identifies the problem type. This provides a stable identifier for the error that can be used for documentation lookups and programmatic error handling. When followed, this URI should provide human-readable documentation for the problem type.
	Type string `json:"type"`
}

type BadRequestErrorResponse struct {
	// Error Extended error details specifically for bad request (400) errors. This builds on the BaseError structure by adding an array of individual validation errors, making it easy to identify and fix multiple issues at once.
	Error BadRequestErrorDetails `json:"error"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type BaseError struct {
	// Detail A human-readable explanation specific to this occurrence of the problem. This provides detailed information about what went wrong and potential remediation steps. The message is intended to be helpful for developers troubleshooting the issue.
	Detail string `json:"detail"`

	// Status HTTP status code that corresponds to this error. This will match the status code in the HTTP response. Common codes include `400` (Bad Request), `401` (Unauthorized), `403` (Forbidden), `404` (Not Found), `409` (Conflict), and `500` (Internal Server Error).
	Status int `json:"status"`

	// Title A short, human-readable summary of the problem type. This remains constant from occurrence to occurrence of the same problem and should be used for programmatic handling.
	Title string `json:"title"`

	// Type A URI reference that identifies the problem type. This provides a stable identifier for the error that can be used for documentation lookups and programmatic error handling. When followed, this URI should provide human-readable documentation for the problem type.
	Type string `json:"type"`
}

type BearerTokenLocation = map[string]interface{}

type ConflictErrorResponse struct {
	// Error Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
	Error BaseError `json:"error"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type DeployCreateDeploymentJSONRequestBody = V2DeployCreateDeploymentRequestBody

type DeployGetDeploymentJSONRequestBody = V2DeployGetDeploymentRequestBody

type Deployment struct {
	// App Slug of the app this deployment belongs to.
	App string `json:"app"`

	// AvailableActions Lifecycle operations you are allowed to call on this deployment right now.
	// Empty when none apply (e.g. while building or in a terminal state).
	AvailableActions []DeploymentAction `json:"availableActions"`

	// CreatedAt Unix timestamp in milliseconds when the deployment was created.
	CreatedAt int64             `json:"createdAt"`
	Docker    *DeploymentDocker `json:"docker,omitempty"`

	// Domains Public hostnames this deployment is reachable at.
	Domains *[]string `json:"domains,omitempty"`

	// Environment Slug of the environment this deployment belongs to.
	Environment string           `json:"environment"`
	Error       *DeploymentError `json:"error,omitempty"`
	Git         *DeploymentGit   `json:"git,omitempty"`

	// Id The unique identifier of the deployment, generated by Unkey.
	Id string `json:"id"`

	// IsCurrent True when this is the production deployment currently serving traffic, i.e.
	// on api.acme.com. Only production deployments can be current, and at most one
	// deployment is current. Rollbacks and promotions change which deployment is
	// current and serves requests to api.acme.com.
	IsCurrent bool `json:"isCurrent"`

	// Project Slug of the project this deployment belongs to.
	Project string `json:"project"`

	// Regions Regions this deployment is configured to run in. Empty while the deployment
	// has no scheduled regions yet.
	Regions []string          `json:"regions"`
	Runtime DeploymentRuntime `json:"runtime"`

	// Status Current lifecycle status of the deployment. Poll until it reaches a
	// terminal state: ready (serving), failed, skipped, superseded, stopped,
	// or cancelled.
	Status DeploymentStatus `json:"status"`

	// UpdatedAt Unix timestamp in milliseconds when the deployment was last updated.
	// Omitted if the deployment has never been updated.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

type DeploymentAction string

type DeploymentDocker struct {
	// Image The Docker image this deployment runs.
	Image string `json:"image"`
}

type DeploymentError struct {
	// Code The reason a deployment failed. `unknown` means Unkey could not classify the
	// failure; see `message` for details.
	Code DeploymentErrorCode `json:"code"`

	// Message Human-readable description of why the deployment failed. For programmatic
	// handling, use `code`.
	Message string `json:"message"`

	// Step The pipeline step that failed (e.g. `building`, `deploying`, `starting`).
	Step string `json:"step"`
}

type DeploymentErrorCode string

type DeploymentGit struct {
	// Branch The git branch this deployment was built from. Omitted when unknown.
	Branch *string `json:"branch,omitempty"`

	// CommitSha The git commit SHA this deployment was built from.
	CommitSha string `json:"commitSha"`
}

type DeploymentRuntime struct {
	// Command Container entrypoint command override. Empty when none is set.
	Command     []string                `json:"command"`
	Healthcheck *EnvironmentHealthcheck `json:"healthcheck,omitempty"`

	// MemoryMib Memory allocation in mebibytes.
	MemoryMib int `json:"memoryMib"`

	// Port Port the container listens on.
	Port int `json:"port"`

	// ShutdownSignal Signal sent to the container on shutdown.
	ShutdownSignal EnvironmentShutdownSignal `json:"shutdownSignal"`

	// StorageMib Ephemeral storage allocation in mebibytes.
	StorageMib int `json:"storageMib"`

	// UpstreamProtocol Protocol used to reach the container.
	UpstreamProtocol EnvironmentUpstreamProtocol `json:"upstreamProtocol"`

	// VCpus CPU allocation in vCPUs (1 = one vCPU, 0.5 = half a vCPU).
	VCpus float64 `json:"vCpus"`
}

type DeploymentSourceDeployment struct {
	// DeploymentId Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	DeploymentId ResourceIdentifier `json:"deploymentId"`
}

type DeploymentSourceGit struct {
	// Branch Branch to build (its HEAD). Omit branch and commitSha to use the app's default branch.
	Branch *string `json:"branch,omitempty"`

	// CommitSha Commit to build (full or abbreviated SHA). Takes precedence over branch.
	CommitSha *string `json:"commitSha,omitempty"`

	// Repository Build from a fork instead of the app's connected repository, as "owner/repo". Requires commitSha.
	Repository *string `json:"repository,omitempty"`
}

type DeploymentSourceImage struct {
	// DockerImage Docker image to deploy as-is.
	DockerImage string `json:"dockerImage"`
}

type DeploymentStatus string

type DeploymentsCreateDeploymentJSONRequestBody = V2DeploymentsCreateDeploymentRequestBody

type DeploymentsGetDeploymentJSONRequestBody = V2DeploymentsGetDeploymentRequestBody

type DeploymentsListDeploymentsJSONRequestBody = V2DeploymentsListDeploymentsRequestBody

type DeploymentsPromoteDeploymentJSONRequestBody = V2DeploymentsPromoteDeploymentRequestBody

type DeploymentsRollbackDeploymentJSONRequestBody = V2DeploymentsRollbackDeploymentRequestBody

type DeploymentsStartDeploymentJSONRequestBody = V2DeploymentsStartDeploymentRequestBody

type DeploymentsStopDeploymentJSONRequestBody = V2DeploymentsStopDeploymentRequestBody

type EmptyResponse = map[string]interface{}

type Environment struct {
	// Build Build settings that control how the app is built.
	// Omitted until the environment has build settings.
	Build *EnvironmentBuild `json:"build,omitempty"`

	// CreatedAt Unix timestamp in milliseconds when the environment was created.
	CreatedAt int64 `json:"createdAt"`

	// DeleteProtection Whether delete protection is enabled for this environment.
	// When true, the environment cannot be deleted until protection is disabled.
	DeleteProtection bool `json:"deleteProtection"`

	// Description Human-readable description of this environment.
	// Empty string if none was provided.
	Description string `json:"description"`

	// Id The unique identifier of the environment, generated by Unkey.
	Id string `json:"id"`

	// Regions Per-region deployment settings for this environment.
	// Empty until regional settings are configured.
	Regions *[]EnvironmentRegion `json:"regions,omitempty"`

	// Runtime Runtime settings that control how the container runs.
	// Omitted until the environment has runtime settings.
	Runtime *EnvironmentRuntime `json:"runtime,omitempty"`

	// Slug Human-readable slug of the environment, unique within its app.
	Slug string `json:"slug"`

	// UpdatedAt Unix timestamp in milliseconds when the environment was last updated.
	// Omitted if the environment has never been updated.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

type EnvironmentBuild struct {
	// AutoDeploy Whether pushes automatically trigger a deployment.
	AutoDeploy bool `json:"autoDeploy"`

	// BuildCommand Overrides the build command auto-detected by Railpack, so monorepos can
	// scope the build to a single app. Omitted when left to auto-detection or
	// for Dockerfile builds.
	BuildCommand *string `json:"buildCommand,omitempty"`

	// Dockerfile Path to the Dockerfile used to build the app, if any.
	Dockerfile *string `json:"dockerfile,omitempty"`

	// RootDirectory The directory the app is built from. "." for the repository root.
	RootDirectory string `json:"rootDirectory"`

	// WatchPaths Paths that trigger a rebuild when changed.
	WatchPaths []string `json:"watchPaths"`
}

type EnvironmentHealthcheck struct {
	// FailureThreshold Consecutive failures before the container is restarted. Defaults to 3 when omitted.
	FailureThreshold *int `json:"failureThreshold,omitempty"`

	// InitialDelaySeconds Delay before the first probe runs, in seconds. Defaults to 0 when omitted.
	InitialDelaySeconds *int `json:"initialDelaySeconds,omitempty"`

	// IntervalSeconds How often the probe runs, in seconds. Defaults to 10 when omitted.
	IntervalSeconds *int `json:"intervalSeconds,omitempty"`

	// Method HTTP method used to probe the container.
	Method EnvironmentHealthcheckMethod `json:"method"`

	// Path HTTP path probed on the container. Must start with a slash.
	Path string `json:"path"`

	// TimeoutSeconds Per-probe timeout, in seconds. Defaults to 5 when omitted.
	TimeoutSeconds *int `json:"timeoutSeconds,omitempty"`
}

type EnvironmentHealthcheckMethod string

type EnvironmentRegion struct {
	// Name Region name, such as us-east-1.
	Name string `json:"name"`

	// Replicas Min and max replica bounds for autoscaling in a region.
	Replicas Replicas `json:"replicas"`
}

type EnvironmentRuntime struct {
	// Command Container entrypoint command override.
	Command     []string                `json:"command"`
	Healthcheck *EnvironmentHealthcheck `json:"healthcheck,omitempty"`

	// MemoryMib Memory allocation in mebibytes.
	MemoryMib int `json:"memoryMib"`

	// OpenapiSpecPath Path to the OpenAPI spec served by the container, if any.
	OpenapiSpecPath *string `json:"openapiSpecPath,omitempty"`

	// Port Port the container listens on.
	Port int `json:"port"`

	// ShutdownSignal Signal sent to the container on shutdown.
	ShutdownSignal EnvironmentShutdownSignal `json:"shutdownSignal"`

	// StorageMib Ephemeral storage allocation in mebibytes.
	StorageMib int `json:"storageMib"`

	// UpstreamProtocol Protocol used to reach the container.
	UpstreamProtocol EnvironmentUpstreamProtocol `json:"upstreamProtocol"`

	// VCpus CPU allocation in vCPUs (1 = one vCPU, 0.5 = half a vCPU).
	VCpus float64 `json:"vCpus"`
}

type EnvironmentShutdownSignal string

type EnvironmentUpstreamProtocol string

type EnvironmentVariable struct {
	// CreatedAt Unix timestamp in milliseconds when the variable was created.
	CreatedAt int64 `json:"createdAt"`

	// Description Human-readable description. Omitted if none was provided.
	Description string `json:"description,omitempty"`

	// Key The variable name.
	Key string `json:"key"`

	// Kind How the value may be read back. `writeonly` values can never be read back
	// through the API; `recoverable` values can be decrypted. Values are encrypted
	// at rest either way.
	Kind EnvironmentVariableKind `json:"kind"`

	// Value The decrypted plaintext value. Present only for `recoverable` variables.
	// Omitted for `writeonly` variables, which can never be read back.
	Value string `json:"value,omitempty"`
}

type EnvironmentVariableInput struct {
	// Description Human-readable description of the variable.
	Description *string `json:"description,omitempty"`

	// Key The variable name. Must be a POSIX shell name: letters, digits, and
	// underscores only, and must not start with a digit. Other names are
	// unreachable from shells and most runtimes.
	Key string `json:"key"`

	// Kind How the value may be read back. Defaults to `writeonly`.
	Kind *EnvironmentVariableKind `json:"kind,omitempty"`

	// Value The variable value. Always encrypted at rest. The limit is enforced
	// server-side in UTF-8 bytes, so a multibyte value may be rejected before
	// it reaches this code-point maximum.
	Value string `json:"value"`
}

type EnvironmentVariableKind string

type EnvironmentsGetEnvironmentJSONRequestBody = V2EnvironmentsGetEnvironmentRequestBody

type EnvironmentsListEnvironmentVariablesJSONRequestBody = V2EnvironmentsListEnvironmentVariablesRequestBody

type EnvironmentsListEnvironmentsJSONRequestBody = V2EnvironmentsListEnvironmentsRequestBody

type EnvironmentsRemoveEnvironmentVariablesJSONRequestBody = V2EnvironmentsRemoveEnvironmentVariablesRequestBody

type EnvironmentsSetEnvironmentVariablesJSONRequestBody = V2EnvironmentsSetEnvironmentVariablesRequestBody

type EnvironmentsUpdateSettingsJSONRequestBody = V2EnvironmentsUpdateSettingsRequestBody

type FieldMatch struct {
	Name string `json:"name"`

	// Present Matches when the field is present, regardless of value.
	Present *FieldMatchPresent `json:"present,omitempty"`

	// Value String matcher. Exactly one of `exact`, `prefix` or `regex` must be set.
	Value *StringMatch `json:"value,omitempty"`
}

type FieldMatchPresent bool

type FirewallPolicy struct {
	// Action What to do with matching requests.
	Action FirewallPolicyAction `json:"action"`
}

type FirewallPolicyAction string

type ForbiddenErrorResponse struct {
	// Error Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
	Error BaseError `json:"error"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type GatewayListPoliciesJSONRequestBody = V2GatewayListPoliciesRequestBody

type GatewaySetPoliciesJSONRequestBody = V2GatewaySetPoliciesRequestBody

type GatewayUpdatePolicyJSONRequestBody = V2GatewayUpdatePolicyRequestBody

type GoneErrorResponse struct {
	// Error Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
	Error BaseError `json:"error"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type HeaderKey struct {
	Name string `json:"name"`
}

type HeaderKeyLocation struct {
	Name string `json:"name"`

	// StripPrefix Optional prefix removed from the header value before verification.
	StripPrefix *string `json:"stripPrefix,omitempty"`
}

type IdentitiesCreateIdentityJSONRequestBody = V2IdentitiesCreateIdentityRequestBody

type IdentitiesDeleteIdentityJSONRequestBody = V2IdentitiesDeleteIdentityRequestBody

type IdentitiesGetIdentityJSONRequestBody = V2IdentitiesGetIdentityRequestBody

type IdentitiesListIdentitiesJSONRequestBody = V2IdentitiesListIdentitiesRequestBody

type IdentitiesUpdateIdentityJSONRequestBody = V2IdentitiesUpdateIdentityRequestBody

type Identity struct {
	// ExternalId External identity ID
	ExternalId string `json:"externalId"`

	// Id Identity ID
	Id string `json:"id"`

	// Meta Identity metadata
	Meta map[string]interface{} `json:"meta,omitempty"`

	// Ratelimits Identity ratelimits
	Ratelimits []RatelimitResponse `json:"ratelimits,omitempty"`
}

type InternalServerErrorResponse struct {
	// Error Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
	Error BaseError `json:"error"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type KeyCreditsData struct {
	// Refill Configuration for automatic credit refill behavior.
	Refill *KeyCreditsRefill `json:"refill,omitempty"`

	// Remaining Number of credits remaining (null for unlimited).
	Remaining nullable.Nullable[int64] `json:"remaining"`
}

type KeyCreditsRefill struct {
	// Amount Number of credits to add during each refill cycle.
	Amount int64 `json:"amount"`

	// Interval How often credits are automatically refilled.
	Interval KeyCreditsRefillInterval `json:"interval"`

	// RefillDay Day of the month for monthly refills (1-31).
	// Only required when interval is 'monthly'.
	// For days beyond the month's length, refill occurs on the last day of the month.
	RefillDay int `json:"refillDay,omitempty"`
}

type KeyCreditsRefillInterval string

type KeyLocation struct {
	// Bearer Extract the key from the `Authorization Bearer` header.
	Bearer *BearerTokenLocation `json:"bearer,omitempty"`

	// Header Extract the key from a custom header.
	Header *HeaderKeyLocation `json:"header,omitempty"`

	// QueryParam Extract the key from a query parameter.
	QueryParam *QueryParamKeyLocation `json:"queryParam,omitempty"`
}

type KeyRatelimit struct {
	// Cost Cost charged against the limit per request. Defaults to 1.
	Cost *int64 `json:"cost,omitempty"`

	// Duration Inline override: window duration in milliseconds. Must be set together
	// with `limit`.
	Duration *int64 `json:"duration,omitempty"`

	// Limit Inline override: maximum number of operations per window. Must be set
	// together with `duration`.
	Limit *int64 `json:"limit,omitempty"`

	// Name Name of a rate limit configured on the key or its identity, or the name
	// of the inline override defined by `limit` and `duration`.
	Name string `json:"name"`
}

type KeyResponseData struct {
	// CreatedAt Unix timestamp in milliseconds when key was created.
	CreatedAt int64 `json:"createdAt"`

	// Credits Credit configuration and remaining balance for this key.
	Credits *KeyCreditsData `json:"credits,omitempty"`

	// Enabled Whether the key is enabled or disabled.
	Enabled bool `json:"enabled"`

	// Expires Unix timestamp in milliseconds when key expires (if set).
	Expires  int64     `json:"expires,omitempty"`
	Identity *Identity `json:"identity,omitempty"`

	// KeyId Unique identifier for this key.
	KeyId string `json:"keyId"`

	// LastUsedAt Unix timestamp in milliseconds when key was last used for verification. This is an approximated value, accurate to within 5 minutes.
	LastUsedAt int64 `json:"lastUsedAt,omitempty"`

	// Meta Custom metadata associated with this key.
	Meta map[string]interface{} `json:"meta,omitempty"`

	// Name Human-readable name for this key.
	Name        string   `json:"name,omitempty"`
	Permissions []string `json:"permissions,omitempty"`

	// Plaintext Decrypted key value (only when decrypt=true).
	Plaintext  string              `json:"plaintext,omitempty"`
	Ratelimits []RatelimitResponse `json:"ratelimits,omitempty"`
	Roles      []string            `json:"roles,omitempty"`

	// Start First few characters of the key for identification.
	Start string `json:"start"`

	// UpdatedAt Unix timestamp in milliseconds when key was last updated.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

type KeyauthPolicy struct {
	// Keyspaces Keyspaces to verify keys against, referenced by id. All keyspaces must
	// belong to your workspace.
	Keyspaces []string `json:"keyspaces"`

	// Locations Where to look for the key on incoming requests, tried in order. Defaults
	// to the `Authorization Bearer` header when omitted.
	Locations *[]KeyLocation `json:"locations,omitempty"`

	// PermissionQuery Optional permission query the verified key must satisfy, e.g.
	// `documents.read AND documents.write`.
	PermissionQuery *string `json:"permissionQuery,omitempty"`

	// Ratelimits Rate limits applied during key verification.
	Ratelimits *[]KeyRatelimit `json:"ratelimits,omitempty"`
}

type KeysAddPermissionsJSONRequestBody = V2KeysAddPermissionsRequestBody

type KeysAddRolesJSONRequestBody = V2KeysAddRolesRequestBody

type KeysCreateKeyJSONRequestBody = V2KeysCreateKeyRequestBody

type KeysDeleteKeyJSONRequestBody = V2KeysDeleteKeyRequestBody

type KeysGetKeyJSONRequestBody = V2KeysGetKeyRequestBody

type KeysMigrateKeysJSONRequestBody = V2KeysMigrateKeysRequestBody

type KeysRemovePermissionsJSONRequestBody = V2KeysRemovePermissionsRequestBody

type KeysRemoveRolesJSONRequestBody = V2KeysRemoveRolesRequestBody

type KeysRerollKeyJSONRequestBody = V2KeysRerollKeyRequestBody

type KeysSetPermissionsJSONRequestBody = V2KeysSetPermissionsRequestBody

type KeysSetRolesJSONRequestBody = V2KeysSetRolesRequestBody

type KeysUpdateCreditsJSONRequestBody = V2KeysUpdateCreditsRequestBody

type KeysUpdateKeyJSONRequestBody = V2KeysUpdateKeyRequestBody

type KeysVerifyKeyCredits struct {
	// Cost Sets how many credits to deduct for this verification request.
	// Use 0 for read-only operations or free tier access, higher values for premium features.
	// Credits are deducted after all security checks pass.
	// Essential for implementing usage-based pricing with different operation costs.
	Cost int64 `json:"cost"`
}

type KeysVerifyKeyJSONRequestBody = V2KeysVerifyKeyRequestBody

type KeysVerifyKeyRatelimit struct {
	// Cost Optionally override how expensive this operation is and how many tokens are deducted from the current limit.
	Cost *int `json:"cost,omitempty"`

	// Duration Optionally override the duration of the rate limit window duration.
	Duration *int `json:"duration,omitempty"`

	// Limit Optionally override the maximum number of requests allowed within the specified interval.
	Limit *int `json:"limit,omitempty"`

	// Name References an existing ratelimit by its name. Key Ratelimits will take precedence over identifier-based limits.
	Name string `json:"name"`
}

type KeysWhoamiJSONRequestBody = V2KeysWhoamiRequestBody

type MatchExpr struct {
	// Header Matches a named request field (header or query parameter). Exactly one of
	// `present` or `value` must be set.
	Header *FieldMatch `json:"header,omitempty"`

	// Method Matches when the request method is one of the listed methods.
	Method *MethodMatch `json:"method,omitempty"`

	// Path Matches on the request path.
	Path *PathMatch `json:"path,omitempty"`

	// QueryParam Matches a named request field (header or query parameter). Exactly one of
	// `present` or `value` must be set.
	QueryParam *FieldMatch `json:"queryParam,omitempty"`
}

type Meta struct {
	// RequestId A unique id for this request. Always include this ID when contacting support about a specific API request. This identifier allows Unkey's support team to trace the exact request through logs and diagnostic systems to provide faster assistance.
	RequestId string `json:"requestId"`
}

type MethodMatch struct {
	Methods []MethodMatchMethods `json:"methods"`
}

type MethodMatchMethods string

type NotFoundErrorResponse struct {
	// Error Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
	Error BaseError `json:"error"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type OpenapiPolicy = map[string]interface{}

type Pagination struct {
	// Cursor Opaque pagination token for retrieving the next page of results.
	// Include this exact value in the cursor field of subsequent requests.
	// Cursors are temporary and may expire after extended periods.
	Cursor *string `json:"cursor,omitempty"`

	// HasMore Indicates whether additional results exist beyond this page.
	// When true, use the cursor to fetch the next page.
	// When false, you have reached the end of the result set.
	HasMore bool `json:"hasMore"`
}

type PathKey = map[string]interface{}

type PathMatch struct {
	// Path String matcher. Exactly one of `exact`, `prefix` or `regex` must be set.
	Path StringMatch `json:"path"`
}

type Permission struct {
	// Description Optional detailed explanation of what this permission grants access to.
	// Helps team members understand the scope and implications of granting this permission.
	// Include information about what resources can be accessed and what actions can be performed.
	// Not visible to end users - this is for internal documentation and team clarity.
	Description string `json:"description,omitempty"`

	// Id The unique identifier for this permission within Unkey's system.
	// Generated automatically when the permission is created and used to reference this permission in API operations.
	// Always begins with 'perm_' followed by alphanumeric characters and underscores.
	Id string `json:"id"`

	// Name The human-readable name for this permission that describes its purpose.
	// Should be descriptive enough for developers to understand what access it grants.
	// Use clear, semantic names that reflect the resources or actions being permitted.
	// Names must be unique within your workspace to avoid confusion and conflicts.
	Name string `json:"name"`

	// Slug The unique URL-safe identifier for this permission.
	Slug string `json:"slug"`
}

type PermissionsCreatePermissionJSONRequestBody = V2PermissionsCreatePermissionRequestBody

type PermissionsCreateRoleJSONRequestBody = V2PermissionsCreateRoleRequestBody

type PermissionsDeletePermissionJSONRequestBody = V2PermissionsDeletePermissionRequestBody

type PermissionsDeleteRoleJSONRequestBody = V2PermissionsDeleteRoleRequestBody

type PermissionsGetPermissionJSONRequestBody = V2PermissionsGetPermissionRequestBody

type PermissionsGetRoleJSONRequestBody = V2PermissionsGetRoleRequestBody

type PermissionsListPermissionsJSONRequestBody = V2PermissionsListPermissionsRequestBody

type PermissionsListRolesJSONRequestBody = V2PermissionsListRolesRequestBody

type Policy struct {
	// Enabled Disabled policies are stored but skipped during evaluation.
	Enabled bool `json:"enabled"`

	// Firewall Blocks matching requests.
	Firewall *FirewallPolicy `json:"firewall,omitempty"`

	// Keyauth Verifies Unkey API keys on matching requests.
	Keyauth *KeyauthPolicy `json:"keyauth,omitempty"`

	// Match Optional request matchers. The policy applies only to requests matching
	// all expressions; omit to apply to every request.
	Match *[]MatchExpr `json:"match,omitempty"`

	// Name Human-readable name shown in the dashboard.
	Name string `json:"name"`

	// Openapi Validates matching requests against the app's uploaded OpenAPI spec. Has no
	// configuration of its own. If no spec has been uploaded for the deployment,
	// the policy is a no-op and requests pass through unvalidated.
	Openapi *OpenapiPolicy `json:"openapi,omitempty"`

	// Ratelimit Rate limits matching requests.
	Ratelimit *RatelimitPolicy `json:"ratelimit,omitempty"`
}

type PolicyResponse struct {
	// Enabled Disabled policies are stored but skipped during evaluation.
	Enabled bool `json:"enabled"`

	// Firewall Blocks matching requests.
	Firewall *FirewallPolicy `json:"firewall,omitempty"`

	// Id Server-generated policy id. Regenerated on every `gateway.setPolicies` call, so treat it as stable only until the environment's policies are next replaced.
	Id string `json:"id"`

	// Keyauth Verifies Unkey API keys on matching requests.
	Keyauth *KeyauthPolicy `json:"keyauth,omitempty"`

	// Match Optional request matchers. The policy applies only to requests matching
	// all expressions; omitted when the policy applies to every request.
	Match *[]MatchExpr `json:"match,omitempty"`

	// Name Human-readable name shown in the dashboard.
	Name string `json:"name"`

	// Openapi Validates matching requests against the app's uploaded OpenAPI spec. Has no
	// configuration of its own. If no spec has been uploaded for the deployment,
	// the policy is a no-op and requests pass through unvalidated.
	Openapi *OpenapiPolicy `json:"openapi,omitempty"`

	// Ratelimit Rate limits matching requests.
	Ratelimit *RatelimitPolicy `json:"ratelimit,omitempty"`
}

type PortalCreateSessionJSONRequestBody = V2PortalCreateSessionRequestBody

type PortalExchangeSessionJSONRequestBody = V2PortalExchangeSessionRequestBody

type PortalGetVerificationsJSONRequestBody = V2PortalGetVerificationsRequestBody

type PortalListKeysJSONRequestBody = V2PortalListKeysRequestBody

type PortalRerollKeyJSONRequestBody = V2KeysRerollKeyRequestBody

type PreconditionFailedErrorResponse struct {
	// Error Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
	Error BaseError `json:"error"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type PrincipalFieldKey struct {
	Path string `json:"path"`
}

type Project struct {
	// CreatedAt Unix timestamp in milliseconds when the project was created.
	CreatedAt int64 `json:"createdAt"`

	// DeleteProtection Whether delete protection is enabled for this project.
	// When true, the project cannot be deleted until protection is disabled.
	DeleteProtection bool `json:"deleteProtection"`

	// Id The unique identifier of the project, generated by Unkey.
	Id string `json:"id"`

	// Name Human-readable name for this project.
	Name string `json:"name"`

	// Slug URL-safe handle for this project, unique within your workspace.
	// This is the caller-defined identifier used to reference the project in get, update, and delete operations.
	Slug string `json:"slug"`

	// UpdatedAt Unix timestamp in milliseconds when the project was last updated.
	// Omitted if the project has never been updated.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

type ProjectsCreateProjectJSONRequestBody = V2ProjectsCreateProjectRequestBody

type ProjectsDeleteProjectJSONRequestBody = V2ProjectsDeleteProjectRequestBody

type ProjectsGetProjectJSONRequestBody = V2ProjectsGetProjectRequestBody

type ProjectsListProjectsJSONRequestBody = V2ProjectsListProjectsRequestBody

type ProjectsUpdateProjectJSONRequestBody = V2ProjectsUpdateProjectRequestBody

type QueryParamKeyLocation struct {
	Name string `json:"name"`
}

type RatelimitDeleteOverrideJSONRequestBody = V2RatelimitDeleteOverrideRequestBody

type RatelimitGetOverrideJSONRequestBody = V2RatelimitGetOverrideRequestBody

type RatelimitIdentifier struct {
	// AuthenticatedSubject Rate limit by the authenticated subject (e.g. the verified key).
	AuthenticatedSubject *AuthenticatedSubjectKey `json:"authenticatedSubject,omitempty"`

	// Header Rate limit by the value of a request header.
	Header *HeaderKey `json:"header,omitempty"`

	// Path Rate limit by the request path.
	Path *PathKey `json:"path,omitempty"`

	// PrincipalField Rate limit by a field extracted from the authenticated principal.
	PrincipalField *PrincipalFieldKey `json:"principalField,omitempty"`

	// RemoteIp Rate limit by the client's IP address.
	RemoteIp *RemoteIpKey `json:"remoteIp,omitempty"`
}

type RatelimitLimitJSONRequestBody = V2RatelimitLimitRequestBody

type RatelimitListOverridesJSONRequestBody = V2RatelimitListOverridesRequestBody

type RatelimitMultiLimitJSONRequestBody = V2RatelimitMultiLimitRequestBody

type RatelimitOverride struct {
	// Duration The duration in milliseconds for this override's rate limit window. This may differ from the default duration for the namespace, allowing custom time windows for specific entities. After this duration elapses, the rate limit counter for affected identifiers resets to zero.
	Duration int64 `json:"duration"`

	// Identifier The identifier pattern this override applies to. This determines which entities receive the custom rate limit.
	//
	// This can be:
	// - An exact identifier for a specific entity
	// - A pattern with wildcards for matching multiple entities
	//
	// Wildcard examples:
	// - 'admin_*' matches any identifier starting with 'admin_'
	// - '*_test' matches any identifier ending with '_test'
	// - '*premium*' matches any identifier containing 'premium'
	//
	// More complex patterns can combine multiple wildcards. Detailed documentation on pattern matching rules is available at https://www.unkey.com/docs/ratelimiting/overrides#wildcard-rules
	Identifier string `json:"identifier"`

	// Limit The maximum number of requests allowed for entities matching this override. This replaces the default limit for the namespace when applied.
	//
	// Common use cases:
	// - Higher limits for premium customers
	// - Reduced limits for abusive or suspicious entities
	// - Zero limit to completely block specific patterns
	// - Custom tier-based limits for different customer segments
	Limit int64 `json:"limit"`

	// OverrideId The unique identifier of this specific rate limit override. This ID is generated when the override is created and can be used for management operations like updating or deleting the override.
	OverrideId string `json:"overrideId"`
}

type RatelimitPolicy struct {
	// Identifier How requests are grouped for rate limiting. Exactly one of `remoteIp`,
	// `header`, `authenticatedSubject`, `path` or `principalField` must be set.
	Identifier RatelimitIdentifier `json:"identifier"`

	// Limit Maximum number of requests per window.
	Limit int64 `json:"limit"`

	// WindowMs Window duration in milliseconds.
	WindowMs int64 `json:"windowMs"`
}

type RatelimitRequest struct {
	// AutoApply Whether this ratelimit should be automatically applied when verifying a key.
	AutoApply bool `json:"autoApply"`

	// Duration The duration for each ratelimit window in milliseconds.
	//
	// This controls how long the rate limit counter accumulates before resetting. Common values include:
	// - 1000 (1 second): For strict per-second limits on high-frequency operations
	// - 60000 (1 minute): For moderate API usage control
	// - 3600000 (1 hour): For less frequent but costly operations
	// - 86400000 (24 hours): For daily quotas
	//
	// Shorter windows provide more frequent resets but may allow large burst usage. Longer windows provide more consistent usage patterns but take longer to reset after limit exhaustion.
	Duration int64 `json:"duration"`

	// Limit The maximum number of operations allowed within the specified time window.
	//
	// When this limit is reached, verification requests will fail with `code=RATE_LIMITED` until the window resets. The limit should reflect:
	// - Your infrastructure capacity and scaling limitations
	// - Fair usage expectations for your service
	// - Different tier levels for various user types
	// - The relative cost of the operations being limited
	//
	// Higher values allow more frequent access but may impact service performance.
	Limit int64 `json:"limit"`

	// Name The name of this rate limit. This name is used to identify which limit to check during key verification.
	//
	// Best practices for limit names:
	// - Use descriptive, semantic names like 'api_requests', 'heavy_operations', or 'downloads'
	// - Be consistent with naming conventions across your application
	// - Create separate limits for different resource types or operation costs
	// - Consider using namespaced names for better organization (e.g., 'files.downloads', 'compute.training')
	//
	// You will reference this exact name when verifying keys to check against this specific limit.
	Name string `json:"name"`
}

type RatelimitResponse struct {
	// AutoApply Whether this rate limit was automatically applied when verifying the key.
	AutoApply bool `json:"autoApply"`

	// Duration Rate limit window duration in milliseconds.
	Duration int64 `json:"duration"`

	// Id Unique identifier for this rate limit configuration.
	Id string `json:"id"`

	// Limit Maximum requests allowed within the time window.
	Limit int64 `json:"limit"`

	// Name Human-readable name for this rate limit.
	Name string `json:"name"`
}

type RatelimitSetOverrideJSONRequestBody = V2RatelimitSetOverrideRequestBody

type RemoteIpKey = map[string]interface{}

type Replicas struct {
	// Max Maximum number of replicas.
	Max int `json:"max"`

	// Min Minimum number of replicas.
	Min int `json:"min"`
}

type ResourceIdentifier = string

type Role struct {
	// Description Optional detailed explanation of what this role encompasses and what access it provides.
	// Helps team members understand the role's scope, intended use cases, and security implications.
	// Include information about what types of users should receive this role and what they can accomplish.
	// Not visible to end users - this is for internal documentation and access control audits.
	Description string `json:"description,omitempty"`

	// Id The unique identifier for this role within Unkey's system.
	// Generated automatically when the role is created and used to reference this role in API operations.
	// Always begins with 'role_' followed by alphanumeric characters and underscores.
	Id string `json:"id"`

	// Name The human-readable name for this role that describes its function.
	// Should be descriptive enough for administrators to understand what access this role provides.
	// Use clear, semantic names that reflect the job function or responsibility level.
	// Names must be unique within your workspace to avoid confusion during role assignment.
	Name string `json:"name"`

	// Permissions Complete list of permissions currently assigned to this role.
	// Each permission grants specific access rights that will be inherited by any keys or users assigned this role.
	// Use this list to understand the full scope of access provided by this role.
	// Permissions can be added or removed from roles without affecting the role's identity or other properties.
	// Empty array indicates a role with no permissions currently assigned.
	Permissions []Permission `json:"permissions,omitempty"`
}

type ServiceUnavailableErrorResponse struct {
	// Error Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
	Error BaseError `json:"error"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type StringMatch struct {
	// Exact Matches when the input equals this value.
	Exact *string `json:"exact,omitempty"`

	// IgnoreCase Compare case-insensitively. May accompany any match mode.
	IgnoreCase *bool `json:"ignoreCase,omitempty"`

	// Prefix Matches when the input starts with this value.
	Prefix *string `json:"prefix,omitempty"`

	// Regex Matches when the input satisfies this RE2 regular expression. Invalid
	// patterns are rejected when the policy is created.
	Regex *string `json:"regex,omitempty"`
}

type TooManyRequestsErrorResponse struct {
	// Error Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
	Error BaseError `json:"error"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type UnauthorizedErrorResponse struct {
	// Error Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
	Error BaseError `json:"error"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type UnprocessableEntityErrorResponse struct {
	// Error Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
	Error BaseError `json:"error"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type UpdateKeyCreditsData struct {
	// Refill Configuration for automatic credit refill behavior.
	Refill nullable.Nullable[UpdateKeyCreditsRefill] `json:"refill,omitempty"`

	// Remaining Number of credits remaining (null for unlimited). This also clears the refilling schedule.
	Remaining nullable.Nullable[int64] `json:"remaining,omitempty"`
}

type UpdateKeyCreditsRefill struct {
	// Amount Number of credits to add during each refill cycle.
	Amount int64 `json:"amount"`

	// Interval How often credits are automatically refilled.
	Interval UpdateKeyCreditsRefillInterval `json:"interval"`

	// RefillDay Day of the month for monthly refills (1-31).
	// Only required when interval is 'monthly'.
	// For days beyond the month's length, refill occurs on the last day of the month.
	RefillDay *int `json:"refillDay,omitempty"`
}

type UpdateKeyCreditsRefillInterval string

type V2AnalyticsGetVerificationsRequestBody struct {
	// Query SQL query to execute against your analytics data.
	// Only SELECT queries are allowed.
	Query string `json:"query"`
}

type V2AnalyticsGetVerificationsResponseBody struct {
	// Data Array of verification rows returned by the query. Fields vary based on the SQL SELECT clause.
	Data V2AnalyticsGetVerificationsResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2AnalyticsGetVerificationsResponseData = []map[string]interface{}

type V2ApisCreateApiRequestBody struct {
	// Name Unique identifier for this API namespace within your workspace.
	// Use descriptive names like 'payment-service-prod' or 'user-api-dev' to clearly identify purpose and environment.
	Name string `json:"name"`
}

type V2ApisCreateApiResponseBody struct {
	Data V2ApisCreateApiResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2ApisCreateApiResponseData struct {
	// ApiId The unique identifier assigned to the newly created API.
	// Use this ID for all subsequent operations including key creation, verification, and API management.
	// Always begins with 'api_' followed by a unique alphanumeric sequence.
	//
	// Store this ID securely as it's required when:
	// - Creating API keys within this namespace
	// - Verifying keys associated with this API
	// - Managing API settings and metadata
	// - Listing keys belonging to this API
	//
	// This identifier is permanent and cannot be changed after creation.
	ApiId string `json:"apiId"`
}

type V2ApisDeleteApiRequestBody struct {
	// ApiId Specifies which API namespace to permanently delete from your workspace.
	// Must be a valid API ID that begins with 'api_' and exists within your workspace.
	//
	// Before proceeding, ensure you have the correct API ID and understand that this action cannot be undone. If you need to migrate functionality, create replacement keys in a new API namespace and update client applications before deletion.
	ApiId string `json:"apiId"`
}

type V2ApisDeleteApiResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2ApisGetApiRequestBody struct {
	// ApiId Specifies which API to retrieve by its unique identifier.
	// Must be a valid API ID that begins with 'api_' and exists within your workspace.
	ApiId string `json:"apiId"`
}

type V2ApisGetApiResponseBody struct {
	Data V2ApisGetApiResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2ApisGetApiResponseData struct {
	// Id The unique identifier of this API within Unkey's system.
	// Used in all operations related to this API including key creation, verification, and management.
	// Always begins with 'api_' followed by alphanumeric characters and underscores.
	// This identifier is permanent and never changes after API creation.
	Id string `json:"id"`

	// Name The internal name of this API as specified during creation.
	// Used for organization and identification within your workspace.
	// Helps distinguish between different environments, services, or access tiers.
	// Not visible to end users - this is purely for administrative purposes.
	Name string `json:"name"`
}

type V2ApisListKeysRequestBody struct {
	// ApiId The API namespace whose keys you want to list.
	// Returns all keys in this API, subject to pagination and filters.
	ApiId string `json:"apiId"`

	// Cursor Pagination cursor from previous response to fetch next page.
	// Use when `hasMore: true` in previous response.
	Cursor *string `json:"cursor,omitempty"`

	// Decrypt When true, attempts to include the plaintext key value in the response. SECURITY WARNING:
	// - This requires special permissions on the calling root key
	// - Only works for keys created with 'recoverable: true'
	// - Exposes sensitive key material in the response
	// - Should only be used in secure administrative contexts
	// - Never enable this in user-facing applications
	Decrypt *bool `json:"decrypt,omitempty"`

	// ExternalId Filter keys by external ID to find keys for a specific user or entity.
	// Must exactly match the externalId set during key creation.
	ExternalId *string `json:"externalId,omitempty"`

	// Limit Maximum number of keys to return per request.
	// Balance between response size and number of pagination calls needed.
	Limit *int `json:"limit,omitempty"`

	// RevalidateKeysCache EXPERIMENTAL: Skip the cache and fetch the keys directly from the database. This ensures you see the most recent state, including keys created moments ago. Use this when:
	// - You've just created a key and need to display it immediately
	// - You need absolute certainty about the current key state
	// - You're debugging cache consistency issues
	//
	// This parameter comes with a performance cost and should be used sparingly.
	RevalidateKeysCache *bool `json:"revalidateKeysCache,omitempty"`
}

type V2ApisListKeysResponseBody struct {
	// Data Array of API keys with complete configuration and metadata.
	Data V2ApisListKeysResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`

	// Pagination Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
	Pagination Pagination `json:"pagination"`
}

type V2ApisListKeysResponseData = []KeyResponseData

type V2AppsCreateAppRequestBody struct {
	// Name Human-readable name for this app.
	// Use a descriptive name like 'Payments API' to identify its purpose.
	Name string `json:"name"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`

	// Slug Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Slug ResourceIdentifier `json:"slug"`
}

type V2AppsCreateAppResponseBody struct {
	Data V2AppsCreateAppResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2AppsCreateAppResponseData struct {
	// AppId The unique identifier of the newly created app, generated by Unkey.
	// Always begins with 'app_' followed by a unique alphanumeric sequence.
	AppId string `json:"appId"`
}

type V2AppsDeleteAppRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`
}

type V2AppsDeleteAppResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2AppsGetAppRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`
}

type V2AppsGetAppResponseBody struct {
	Data App `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2AppsListAppsRequestBody struct {
	// Cursor Pagination cursor from a previous response to fetch the next page.
	// Use when `hasMore: true` in the previous response.
	Cursor *string `json:"cursor,omitempty"`

	// Limit Maximum number of apps to return per request.
	// Balance between response size and number of pagination calls needed.
	Limit *int `json:"limit,omitempty"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`

	// Search Free-form text to filter apps. Returns apps whose ID, name, or slug contains the search string. Matching is case-insensitive.
	Search *string `json:"search,omitempty"`
}

type V2AppsListAppsResponseBody struct {
	// Data Array of apps in the project, ordered by app id.
	Data []App `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`

	// Pagination Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
	Pagination Pagination `json:"pagination"`
}

type V2AppsUpdateAppRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// DefaultBranch New default git branch deployments track for this app.
	// Omit this field to leave the current branch unchanged.
	DefaultBranch *string `json:"defaultBranch,omitempty"`

	// DeleteProtection Enable or disable delete protection for the app.
	// Omit this field to leave the current setting unchanged.
	DeleteProtection *bool `json:"deleteProtection,omitempty"`

	// Name New human-readable name for the app.
	// Omit this field to leave the current name unchanged.
	Name *string `json:"name,omitempty"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`

	// Slug Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Slug *ResourceIdentifier `json:"slug,omitempty"`
}

type V2AppsUpdateAppResponseBody struct {
	Data App `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2DeployCreateDeploymentRequestBody struct {
	// App App slug within the project
	App string `json:"app"`

	// Branch Git branch name
	Branch string `json:"branch"`

	// DockerImage Docker image reference to deploy
	DockerImage string `json:"dockerImage"`

	// EnvironmentSlug Environment slug (e.g., "production", "staging")
	EnvironmentSlug string `json:"environmentSlug"`

	// GitCommit Optional git commit information
	GitCommit *V2DeployGitCommit `json:"gitCommit,omitempty"`

	// KeyspaceId Optional keyspace ID for authentication context
	KeyspaceId *string `json:"keyspaceId,omitempty"`

	// Project Project slug
	Project string `json:"project"`
}

type V2DeployCreateDeploymentResponseBody struct {
	Data V2DeployCreateDeploymentResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2DeployCreateDeploymentResponseData struct {
	// DeploymentId Unique deployment identifier
	DeploymentId string `json:"deploymentId"`
}

type V2DeployDeploymentStep struct {
	// CreatedAt Unix timestamp in milliseconds
	CreatedAt *int64 `json:"createdAt,omitempty"`

	// ErrorMessage Error message if step failed
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// Message Step message
	Message *string `json:"message,omitempty"`

	// Status Step status
	Status *string `json:"status,omitempty"`
}

type V2DeployGetDeploymentRequestBody struct {
	// DeploymentId Unique deployment identifier to retrieve
	DeploymentId string `json:"deploymentId"`
}

type V2DeployGetDeploymentResponseBody struct {
	Data V2DeployGetDeploymentResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2DeployGetDeploymentResponseData struct {
	// ErrorMessage Error message if deployment failed
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// Hostnames Hostnames associated with this deployment
	Hostnames *[]string `json:"hostnames,omitempty"`

	// Id Unique deployment identifier
	Id string `json:"id"`

	// Status Current deployment status
	Status V2DeployGetDeploymentResponseDataStatus `json:"status"`

	// Steps Deployment steps with status and messages
	Steps *[]V2DeployDeploymentStep `json:"steps,omitempty"`
}

type V2DeployGetDeploymentResponseDataStatus string

type V2DeployGitCommit struct {
	// AuthorAvatarUrl Git author avatar URL
	AuthorAvatarUrl *string `json:"authorAvatarUrl,omitempty"`

	// AuthorHandle Git author handle/username
	AuthorHandle *string `json:"authorHandle,omitempty"`

	// CommitMessage Git commit message
	CommitMessage *string `json:"commitMessage,omitempty"`

	// CommitSha Git commit SHA
	CommitSha *string `json:"commitSha,omitempty"`

	// Timestamp Commit timestamp in milliseconds
	Timestamp *int64 `json:"timestamp,omitempty"`
}

type V2DeploymentsCreateDeploymentRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// Deployment Re-run an existing deployment.
	Deployment *DeploymentSourceDeployment `json:"deployment,omitempty"`

	// Environment Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Environment ResourceIdentifier `json:"environment"`

	// Git Build from the app's connected GitHub repository.
	Git *DeploymentSourceGit `json:"git,omitempty"`

	// Image Deploy a prebuilt Docker image as-is.
	Image *DeploymentSourceImage `json:"image,omitempty"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`
	// contains filtered or unexported fields
}

type V2DeploymentsCreateDeploymentRequestBody0 = interface{}

type V2DeploymentsCreateDeploymentRequestBody1 = interface{}

type V2DeploymentsCreateDeploymentRequestBody2 = interface{}

type V2DeploymentsCreateDeploymentResponseBody struct {
	Data V2DeploymentsCreateDeploymentResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2DeploymentsCreateDeploymentResponseData struct {
	// DeploymentId Unique deployment identifier. Poll deployments.getDeployment with this id to watch status.
	DeploymentId string `json:"deploymentId"`
}

type V2DeploymentsGetDeploymentRequestBody struct {
	// DeploymentId Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	DeploymentId ResourceIdentifier `json:"deploymentId"`
}

type V2DeploymentsGetDeploymentResponseBody struct {
	Data Deployment `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2DeploymentsListDeploymentsRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App *ResourceIdentifier `json:"app,omitempty"`

	// Cursor Pagination cursor from a previous response to fetch the next page.
	// Use when `hasMore: true` in the previous response.
	Cursor *string `json:"cursor,omitempty"`

	// Environment Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Environment *ResourceIdentifier `json:"environment,omitempty"`

	// Limit Maximum number of deployments to return per request.
	// Balance between response size and number of pagination calls needed.
	Limit *int `json:"limit,omitempty"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project *ResourceIdentifier `json:"project,omitempty"`

	// Status Restrict results to deployments in any of the given lifecycle statuses.
	// Omit to return deployments in every status.
	Status *[]DeploymentStatus `json:"status,omitempty"`
}

type V2DeploymentsListDeploymentsResponseBody struct {
	// Data Array of deployments, ordered newest first.
	Data []Deployment `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`

	// Pagination Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
	Pagination Pagination `json:"pagination"`
}

type V2DeploymentsPromoteDeploymentRequestBody struct {
	// DeploymentId Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	DeploymentId ResourceIdentifier `json:"deploymentId"`
}

type V2DeploymentsPromoteDeploymentResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2DeploymentsRollbackDeploymentRequestBody struct {
	// DeploymentId Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	DeploymentId ResourceIdentifier `json:"deploymentId"`
}

type V2DeploymentsRollbackDeploymentResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2DeploymentsStartDeploymentRequestBody struct {
	// DeploymentId Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	DeploymentId ResourceIdentifier `json:"deploymentId"`
}

type V2DeploymentsStartDeploymentResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2DeploymentsStopDeploymentRequestBody struct {
	// DeploymentId Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	DeploymentId ResourceIdentifier `json:"deploymentId"`
}

type V2DeploymentsStopDeploymentResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2EnvironmentsGetEnvironmentRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// Environment Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Environment ResourceIdentifier `json:"environment"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`
}

type V2EnvironmentsGetEnvironmentResponseBody struct {
	Data Environment `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2EnvironmentsListEnvironmentVariablesRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// Cursor Pagination cursor from a previous response to fetch the next page.
	// Use when `hasMore: true` in the previous response.
	Cursor *string `json:"cursor,omitempty"`

	// Environment Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Environment ResourceIdentifier `json:"environment"`

	// Limit Maximum number of variables to return per request.
	Limit *int `json:"limit,omitempty"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`
}

type V2EnvironmentsListEnvironmentVariablesResponseBody struct {
	Data []EnvironmentVariable `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`

	// Pagination Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
	Pagination Pagination `json:"pagination"`
}

type V2EnvironmentsListEnvironmentsRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`
}

type V2EnvironmentsListEnvironmentsResponseBody struct {
	// Data Array of environments in the app, ordered by environment id.
	Data []Environment `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2EnvironmentsRemoveEnvironmentVariablesRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// Environment Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Environment ResourceIdentifier `json:"environment"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`

	// Variables The names of the variables to remove. Keys that exist are deleted; keys
	// that are not present are ignored, since their absence already matches the
	// requested state.
	//
	// Duplicate keys collapse to a single removal. The whole operation is atomic:
	// if any part fails the environment is left unchanged. Limited to 50
	// variables per request.
	Variables []string `json:"variables"`
}

type V2EnvironmentsRemoveEnvironmentVariablesResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2EnvironmentsSetEnvironmentVariablesRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// Environment Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Environment ResourceIdentifier `json:"environment"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`

	// Prune Optional. Defaults to false. When false, the variables above are upserted
	// and any existing variable not in the list is kept. When true, this becomes
	// a full replace: after upserting, every variable not in the list is deleted.
	// Combined with an empty `variables` list, `prune: true` resets the entire
	// environment by deleting every variable.
	Prune *bool `json:"prune,omitempty"`

	// Variables The variables to upsert. Each entry is created if its key is new or fully
	// overwritten if the key already exists. Existing variables whose keys are
	// not in this list are left untouched, unless `prune` is true.
	//
	// Each entry is written exactly as sent, never merged with the current
	// state. Only `value` is required; omitted optional fields (`kind`,
	// `description`) fall back to their defaults rather than any previous value,
	// so overwriting a variable without a `description` clears it.
	//
	// Each key may appear at most once; a duplicate key is rejected with a 400.
	// The whole operation is atomic: if any part fails the environment is left
	// unchanged. All values are encrypted at rest. Limited to 50 variables per
	// request.
	Variables []EnvironmentVariableInput `json:"variables"`
}

type V2EnvironmentsSetEnvironmentVariablesResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2EnvironmentsUpdateSettingsRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// AutoDeploy Whether pushes auto-deploy.
	// Omit to leave unchanged.
	AutoDeploy *bool `json:"autoDeploy,omitempty"`

	// BuildCommand Overrides the build command auto-detected by Railpack.
	// Omit to leave unchanged; set null to clear and fall back to auto-detection.
	BuildCommand nullable.Nullable[string] `json:"buildCommand,omitempty"`

	// Command Override container entrypoint command.
	// Omit to leave unchanged.
	Command *[]string `json:"command,omitempty"`

	// Dockerfile Path to the Dockerfile used for builds.
	// Omit to leave unchanged; set null to clear and fall back to Railpack.
	Dockerfile nullable.Nullable[string] `json:"dockerfile,omitempty"`

	// Environment Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Environment ResourceIdentifier `json:"environment"`

	// Healthcheck HTTP healthcheck configuration.
	// Omit to leave unchanged; set null to remove.
	Healthcheck nullable.Nullable[EnvironmentHealthcheck] `json:"healthcheck,omitempty"`

	// MemoryMib Memory allocation in MiB. Minimum 256, in steps of 256.
	// The upper bound is your workspace's per-instance quota; exceeding it returns 400.
	// Omit to leave unchanged.
	MemoryMib *int `json:"memoryMib,omitempty"`

	// OpenapiSpecPath Path to the OpenAPI spec file within the build. Must start with a slash.
	// Omit to leave unchanged; set null to clear.
	OpenapiSpecPath nullable.Nullable[string] `json:"openapiSpecPath,omitempty"`

	// Port Container port the app listens on.
	// Omit to leave unchanged.
	Port *int `json:"port,omitempty"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`

	// Regions Desired set of regions with per-region replica bounds.
	// Omit to leave regions unchanged; when present, this replaces the full set
	// (regions absent from the list are removed). At least one region is required;
	// an empty list is rejected because an environment cannot have zero regions.
	Regions *[]EnvironmentRegion `json:"regions,omitempty"`

	// RootDirectory The directory your app lives in. Unkey builds from here.
	// Use "." for the repository root, or set a subdirectory when your app
	// is nested (e.g., services/api). Omit to leave unchanged.
	RootDirectory *string `json:"rootDirectory,omitempty"`

	// ShutdownSignal Signal sent to the container on shutdown.
	ShutdownSignal *EnvironmentShutdownSignal `json:"shutdownSignal,omitempty"`

	// StorageMib Ephemeral storage allocation in MiB, in steps of 512 (0 for none).
	// The upper bound is your workspace's per-instance quota; exceeding it returns 400.
	// Omit to leave unchanged.
	StorageMib *int `json:"storageMib,omitempty"`

	// UpstreamProtocol Protocol used to reach the container.
	UpstreamProtocol *EnvironmentUpstreamProtocol `json:"upstreamProtocol,omitempty"`

	// VCpus CPU allocation in vCPUs. Minimum 0.25 (1/4 vCPU), in steps of 0.25.
	// The upper bound is your workspace's per-instance quota; exceeding it returns 400.
	// Omit to leave unchanged.
	VCpus *float64 `json:"vCpus,omitempty"`

	// WatchPaths Glob paths that trigger auto-deploys when changed.
	// Omit to leave unchanged.
	WatchPaths *[]string `json:"watchPaths,omitempty"`
}

type V2EnvironmentsUpdateSettingsResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2GatewayListPoliciesRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// Environment Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Environment ResourceIdentifier `json:"environment"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`
}

type V2GatewayListPoliciesResponseBody struct {
	// Data The environment's gateway policies in evaluation order.
	Data V2GatewayListPoliciesResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2GatewayListPoliciesResponseData = []PolicyResponse

type V2GatewaySetPoliciesRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// Environment Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Environment ResourceIdentifier `json:"environment"`

	// Policies The environment's complete policy list, in evaluation order. Every call
	// replaces all stored policies with exactly this list; an empty list
	// removes every policy. The operation is atomic: if any policy is
	// invalid, nothing is written. An environment can hold at most 50
	// policies.
	Policies []Policy `json:"policies"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`
}

type V2GatewaySetPoliciesResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2GatewayUpdatePolicyRequestBody struct {
	// App Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	App ResourceIdentifier `json:"app"`

	// Enabled Enable or disable the policy. Disabled policies are stored but skipped
	// during evaluation. Omit to keep the current setting.
	Enabled *bool `json:"enabled,omitempty"`

	// Environment Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Environment ResourceIdentifier `json:"environment"`

	// Firewall Blocks matching requests.
	Firewall *FirewallPolicy `json:"firewall,omitempty"`

	// Keyauth Verifies Unkey API keys on matching requests.
	Keyauth *KeyauthPolicy `json:"keyauth,omitempty"`

	// Match Replaces all match expressions. Set null to remove them so the policy
	// applies to every request. Omit to keep the current expressions.
	Match nullable.Nullable[[]MatchExpr] `json:"match,omitempty"`

	// Name New human-readable name. Omit to keep the current name.
	Name *string `json:"name,omitempty"`

	// Openapi Validates matching requests against the app's uploaded OpenAPI spec. Has no
	// configuration of its own. If no spec has been uploaded for the deployment,
	// the policy is a no-op and requests pass through unvalidated.
	Openapi *OpenapiPolicy `json:"openapi,omitempty"`

	// PolicyId Id of the policy to update, as returned by `gateway.listPolicies`.
	// Ids are regenerated whenever `gateway.setPolicies` replaces the list,
	// so list the policies first if you are unsure the id is current.
	PolicyId string `json:"policyId"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`

	// Ratelimit Rate limits matching requests.
	Ratelimit *RatelimitPolicy `json:"ratelimit,omitempty"`
}

type V2GatewayUpdatePolicyResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2IdentitiesCreateIdentityRequestBody struct {
	// ExternalId Creates an identity using your system's unique identifier for a user, organization, or entity.
	// Must be stable and unique across your workspace - duplicate externalIds return CONFLICT errors.
	// This identifier links Unkey identities to your authentication system, database records, or tenant structure.
	//
	// Avoid changing externalIds after creation as this breaks the link between your systems.
	// Use consistent identifier patterns across your application for easier management and debugging.
	// Accepts letters, numbers, underscores, dots, and hyphens for flexible identifier formats.
	// Essential for implementing proper multi-tenant isolation and user-specific rate limiting.
	ExternalId string `json:"externalId"`

	// Meta Stores arbitrary JSON metadata returned during key verification for contextual information.
	// Eliminates additional database lookups during verification, improving performance for stateless services.
	// Avoid storing sensitive data here as it's returned in verification responses.
	//
	// Large metadata objects increase verification latency and should stay under 10KB total size.
	// Use this for subscription details, feature flags, user preferences, and organization information.
	// Metadata is returned as-is whenever keys associated with this identity are verified.
	Meta *map[string]interface{} `json:"meta,omitempty"`

	// Ratelimits Defines shared rate limits that apply to all keys belonging to this identity.
	// Prevents abuse by users with multiple keys by enforcing consistent limits across their entire key portfolio.
	// Essential for implementing fair usage policies and tiered access levels in multi-tenant applications.
	//
	// Rate limit counters are shared across all keys with this identity, regardless of how many keys the user creates.
	// During verification, specify which named limits to check for enforcement.
	// Identity rate limits supplement any key-specific rate limits that may also be configured.
	// - Each named limit can have different thresholds and windows
	//
	// When verifying keys, you can specify which limits you want to use and all keys attached to this identity will share the limits, regardless of which specific key is used.
	Ratelimits *[]RatelimitRequest `json:"ratelimits,omitempty"`
}

type V2IdentitiesCreateIdentityResponseBody struct {
	Data V2IdentitiesCreateIdentityResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2IdentitiesCreateIdentityResponseData struct {
	// IdentityId The unique identifier of the created identity.
	IdentityId string `json:"identityId"`
}

type V2IdentitiesDeleteIdentityRequestBody struct {
	// Identity The ID of the identity to delete. This can be either the externalId (from your own system that was used during identity creation) or the identityId (the internal ID returned by the identity service).
	Identity string `json:"identity"`
}

type V2IdentitiesDeleteIdentityResponseBody struct {
	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2IdentitiesGetIdentityRequestBody struct {
	// Identity The ID of the identity to retrieve. This can be either the externalId (from your own system that was used during identity creation) or the identityId (the internal ID returned by the identity service).
	Identity string `json:"identity"`
}

type V2IdentitiesGetIdentityResponseBody struct {
	Data Identity `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2IdentitiesListIdentitiesRequestBody struct {
	// Cursor Pagination cursor from a previous response. Use this to fetch subsequent pages of results when the response contains a cursor value.
	Cursor *string `json:"cursor,omitempty"`

	// Limit The maximum number of identities to return in a single request. Use this to control response size and loading performance.
	Limit *int `json:"limit,omitempty"`

	// Search Free-form text to filter identities. Returns identities whose ID or external ID contains the search string. Matching is case-insensitive.
	Search *string `json:"search,omitempty"`
}

type V2IdentitiesListIdentitiesResponseBody struct {
	// Data List of identities matching the specified criteria.
	Data V2IdentitiesListIdentitiesResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`

	// Pagination Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
	Pagination Pagination `json:"pagination"`
}

type V2IdentitiesListIdentitiesResponseData = []Identity

type V2IdentitiesUpdateIdentityRequestBody struct {
	// Identity The ID of the identity to update. Accepts either the externalId (your system-generated identifier) or the identityId (internal identifier returned by the identity service).
	Identity string `json:"identity"`

	// Meta Replaces all existing metadata with this new metadata object.
	// Omitting this field preserves existing metadata, while providing an empty object clears all metadata.
	// Avoid storing sensitive data here as it's returned in verification responses.
	// Large metadata objects increase verification latency and should stay under 10KB total size.
	Meta *map[string]interface{} `json:"meta,omitempty"`

	// Ratelimits Replaces all existing identity rate limits with this complete list of rate limits.
	// Omitting this field preserves existing rate limits, while providing an empty array removes all rate limits.
	// These limits are shared across all keys belonging to this identity, preventing abuse through multiple keys.
	// Rate limit changes take effect immediately but may take up to 30 seconds to propagate across all regions.
	Ratelimits *[]RatelimitRequest `json:"ratelimits,omitempty"`
}

type V2IdentitiesUpdateIdentityResponseBody struct {
	Data Identity `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysAddPermissionsRequestBody struct {
	// KeyId Specifies which key receives the additional permissions using the database identifier returned from `keys.createKey`.
	// Do not confuse this with the actual API key string that users include in requests.
	KeyId string `json:"keyId"`

	// Permissions Grants additional permissions to the key through direct assignment or automatic creation.
	// Duplicate permissions are ignored automatically, making this operation idempotent.
	//
	// Adding permissions never removes existing permissions or role-based permissions.
	//
	// Any permissions that do not exist will be auto created if the root key has permissions, otherwise this operation will fail with a 403 error.
	Permissions []string `json:"permissions"`
}

type V2KeysAddPermissionsResponseBody struct {
	// Data Complete list of all permissions directly assigned to the key (including both newly added permissions and those that were already assigned).
	//
	// This response includes:
	// - All direct permissions assigned to the key (both pre-existing and newly added)
	// - Both the permission ID and name for each permission
	//
	// Important notes:
	// - This list does NOT include permissions granted through roles
	// - For a complete permission picture, use `/v2/keys.getKey` instead
	// - An empty array indicates the key has no direct permissions assigned
	Data V2KeysAddPermissionsResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysAddPermissionsResponseData = []Permission

type V2KeysAddRolesRequestBody struct {
	// KeyId Specifies which key receives the additional roles using the database identifier returned from `createKey`.
	// Do not confuse this with the actual API key string that users include in requests.
	// Added roles supplement existing roles and permissions without replacing them.
	// Role assignments take effect immediately but may take up to 30 seconds to propagate across all regions.
	KeyId string `json:"keyId"`

	// Roles Assigns additional roles to the key through direct assignment to existing workspace roles.
	// Operations are idempotent - adding existing roles has no effect and causes no errors.
	//
	// All roles must already exist in the workspace - roles cannot be created automatically.
	// Invalid roles cause the entire operation to fail atomically, ensuring consistent state.
	Roles []string `json:"roles"`
}

type V2KeysAddRolesResponseBody struct {
	// Data Complete list of all roles directly assigned to the key after the operation completes.
	//
	// The response includes:
	// - All roles now assigned to the key (both pre-existing and newly added)
	// - Both ID and name of each role for easy reference
	//
	// Important notes:
	// - The response shows the complete current state after the addition
	// - An empty array means the key has no roles assigned (unlikely after an add operation)
	// - This only shows direct role assignments, not inherited or nested roles
	// - Role permissions are not expanded in this response - use keys.getKey for full details
	Data V2KeysAddRolesResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysAddRolesResponseData = []Role

type V2KeysCreateKeyRequestBody struct {
	// ApiId The API namespace this key belongs to.
	// Keys from different APIs cannot access each other.
	ApiId string `json:"apiId"`

	// ByteLength Controls the cryptographic strength of the generated key in bytes.
	// Higher values increase security but result in longer keys that may be more annoying to handle.
	// The default 16 bytes provides 2^128 possible combinations, sufficient for most applications.
	// Consider 32 bytes for highly sensitive APIs, but avoid values above 64 bytes unless specifically required.
	ByteLength *int `json:"byteLength,omitempty"`

	// Credits Credit configuration and remaining balance for this key.
	Credits *KeyCreditsData `json:"credits,omitempty"`

	// Enabled Controls whether the key is active immediately upon creation.
	// When set to `false`, the key exists but all verification attempts fail with `code=DISABLED`.
	// Useful for pre-creating keys that will be activated later or for keys requiring manual approval.
	// Most keys should be created with `enabled=true` for immediate use.
	Enabled *bool `json:"enabled,omitempty"`

	// Expires Sets when this key automatically expires as a Unix timestamp in milliseconds.
	// Verification fails with code=EXPIRED immediately after this time passes.
	// Omitting this field creates a permanent key that never expires.
	//
	// Avoid setting timestamps in the past as they immediately invalidate the key.
	// Keys expire based on server time, not client time, which prevents timezone-related issues.
	// Essential for trial periods, temporary access, and security compliance requiring key rotation.
	Expires *int64 `json:"expires,omitempty"`

	// ExternalId Links this key to a user or entity in your system using your own identifier.
	// Returned during verification to identify the key owner without additional database lookups.
	// Essential for user-specific analytics, billing, and multi-tenant key management.
	// Use your primary user ID, organization ID, or tenant ID for best results.
	// Accepts letters, numbers, underscores, dots, and hyphens for flexible identifier formats.
	ExternalId *string `json:"externalId,omitempty"`

	// Meta Stores arbitrary JSON metadata returned during key verification for contextual information.
	// Eliminates additional database lookups during verification, improving performance for stateless services.
	// Avoid storing sensitive data here as it's returned in verification responses.
	// Large metadata objects increase verification latency and should stay under 10KB total size.
	Meta *map[string]interface{} `json:"meta,omitempty"`

	// Name Sets a human-readable identifier for internal organization and dashboard display.
	// Never exposed to end users, only visible in management interfaces and API responses.
	// Avoid generic names like "API Key" when managing multiple keys for the same user or service.
	Name *string `json:"name,omitempty"`

	// Permissions Grants specific permissions directly to this key without requiring role membership.
	// Wildcard permissions like `documents.*` grant access to all sub-permissions including `documents.read` and `documents.write`.
	// Direct permissions supplement any permissions inherited from assigned roles.
	Permissions *[]string `json:"permissions,omitempty"`

	// Prefix Adds a visual identifier to the beginning of the generated key for easier recognition in logs and dashboards.
	// The prefix becomes part of the actual key string (e.g., `prod_xxxxxxxxx`).
	// Avoid using sensitive information in prefixes as they may appear in logs and error messages.
	Prefix *string `json:"prefix,omitempty"`

	// Ratelimits Defines time-based rate limits that protect against abuse by controlling request frequency.
	// Unlike credits which track total usage, rate limits reset automatically after each window expires.
	// Multiple rate limits can control different operation types with separate thresholds and windows.
	// Essential for preventing API abuse while maintaining good performance for legitimate usage.
	Ratelimits *[]RatelimitRequest `json:"ratelimits,omitempty"`

	// Recoverable Controls whether the plaintext key is stored in an encrypted vault for later retrieval.
	// When true, allows recovering the actual key value using keys.getKey with decrypt=true.
	// When false, the key value cannot be retrieved after creation for maximum security.
	// Only enable for development keys or when key recovery is absolutely necessary.
	Recoverable *bool `json:"recoverable,omitempty"`

	// Roles Assigns existing roles to this key for permission management through role-based access control.
	// Roles must already exist in your workspace before assignment.
	// During verification, all permissions from assigned roles are checked against requested permissions.
	// Roles provide a convenient way to group permissions and apply consistent access patterns across multiple keys.
	Roles *[]string `json:"roles,omitempty"`
}

type V2KeysCreateKeyResponseBody struct {
	Data V2KeysCreateKeyResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysCreateKeyResponseData struct {
	// Key The full generated API key that should be securely provided to your user.
	// SECURITY WARNING: This is the only time you'll receive the complete key - Unkey only stores a securely hashed version. Never log or store this value in your own systems; provide it directly to your end user via secure channels. After this API call completes, this value cannot be retrieved again (unless created with `recoverable=true`).
	Key string `json:"key"`

	// KeyId The unique identifier for this key in Unkey's system. This is NOT the actual API key, but a reference ID used for management operations like updating or deleting the key. Store this ID in your database to reference the key later. This ID is not sensitive and can be logged or displayed in dashboards.
	KeyId string `json:"keyId"`
}

type V2KeysDeleteKeyRequestBody struct {
	// KeyId Specifies which key to delete using the database identifier returned from `createKey`.
	// Do not confuse this with the actual API key string that users include in requests.
	// Deletion immediately invalidates the key, causing all future verification attempts to fail with `code=NOT_FOUND`.
	// Key deletion triggers cache invalidation across all regions but may take up to 30 seconds to fully propagate.
	KeyId string `json:"keyId"`

	// Permanent Controls deletion behavior between recoverable soft-deletion and irreversible permanent erasure.
	// Soft deletion (default) preserves key data for potential recovery through direct database operations.
	// Permanent deletion completely removes all traces including hash values and metadata with no recovery option.
	//
	// Use permanent deletion only for regulatory compliance (GDPR), resolving hash collisions, or when reusing identical key strings.
	// Permanent deletion cannot be undone and may affect analytics data that references the deleted key.
	// Most applications should use soft deletion to maintain audit trails and prevent accidental data loss.
	Permanent *bool `json:"permanent,omitempty"`
}

type V2KeysDeleteKeyResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysGetKeyRequestBody struct {
	// Decrypt Controls whether to include the plaintext key value in the response for recovery purposes.
	// Only works for keys created with `recoverable=true` and requires the `decrypt_key` permission.
	// Returned keys must be handled securely, never logged, cached, or stored insecurely.
	//
	// Use only for legitimate recovery scenarios like user password resets or emergency access.
	// Most applications should keep this false to maintain security best practices and avoid accidental key exposure.
	// Decryption requests are audited and may trigger security alerts in enterprise environments.
	Decrypt *bool `json:"decrypt,omitempty"`

	// KeyId Specifies which key to retrieve using the database identifier returned from `keys.createKey`.
	// Do not confuse this with the actual API key string that users include in requests.
	// Key data includes metadata, permissions, usage statistics, and configuration but never the plaintext key value unless `decrypt=true`.
	// Find this ID in creation responses, key listings, dashboard, or verification responses.
	KeyId string `json:"keyId"`
}

type V2KeysGetKeyResponseBody struct {
	Data KeyResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysMigrateKeyData struct {
	// Credits Credit configuration and remaining balance for this key.
	Credits *KeyCreditsData `json:"credits,omitempty"`

	// Enabled Controls whether the key is active immediately upon creation.
	// When set to `false`, the key exists but all verification attempts fail with `code=DISABLED`.
	// Useful for pre-creating keys that will be activated later or for keys requiring manual approval.
	// Most keys should be created with `enabled=true` for immediate use.
	Enabled *bool `json:"enabled,omitempty"`

	// Expires Sets when this key automatically expires as a Unix timestamp in milliseconds.
	// Verification fails with code=EXPIRED immediately after this time passes.
	// Omitting this field creates a permanent key that never expires.
	//
	// Avoid setting timestamps in the past as they immediately invalidate the key.
	// Keys expire based on server time, not client time, which prevents timezone-related issues.
	// Essential for trial periods, temporary access, and security compliance requiring key rotation.
	Expires *int64 `json:"expires,omitempty"`

	// ExternalId Links this key to a user or entity in your system using your own identifier.
	// Returned during verification to identify the key owner without additional database lookups.
	// Essential for user-specific analytics, billing, and multi-tenant key management.
	// Use your primary user ID, organization ID, or tenant ID for best results.
	// Accepts letters, numbers, underscores, dots, and hyphens for flexible identifier formats.
	ExternalId *string `json:"externalId,omitempty"`

	// Hash The current hash of the key on your side
	Hash string `json:"hash"`

	// Meta Stores arbitrary JSON metadata returned during key verification for contextual information.
	// Eliminates additional database lookups during verification, improving performance for stateless services.
	// Avoid storing sensitive data here as it's returned in verification responses.
	// Large metadata objects increase verification latency and should stay under 10KB total size.
	Meta *map[string]interface{} `json:"meta,omitempty"`

	// Name Sets a human-readable identifier for internal organization and dashboard display.
	// Never exposed to end users, only visible in management interfaces and API responses.
	// Avoid generic names like "API Key" when managing multiple keys for the same user or service.
	Name *string `json:"name,omitempty"`

	// Permissions Grants specific permissions directly to this key without requiring role membership.
	// Wildcard permissions like `documents.*` grant access to all sub-permissions including `documents.read` and `documents.write`.
	// Direct permissions supplement any permissions inherited from assigned roles.
	Permissions *[]string `json:"permissions,omitempty"`

	// Ratelimits Defines time-based rate limits that protect against abuse by controlling request frequency.
	// Unlike credits which track total usage, rate limits reset automatically after each window expires.
	// Multiple rate limits can control different operation types with separate thresholds and windows.
	// Essential for preventing API abuse while maintaining good performance for legitimate usage.
	Ratelimits *[]RatelimitRequest `json:"ratelimits,omitempty"`

	// Roles Assigns existing roles to this key for permission management through role-based access control.
	// Roles must already exist in your workspace before assignment.
	// During verification, all permissions from assigned roles are checked against requested permissions.
	// Roles provide a convenient way to group permissions and apply consistent access patterns across multiple keys.
	Roles *[]string `json:"roles,omitempty"`
}

type V2KeysMigrateKeysMigration struct {
	// Hash The hash provided in the migration request
	Hash string `json:"hash"`

	// KeyId The unique identifier for this key in Unkey's system. This is NOT the actual API key, but a reference ID used for management operations like updating or deleting the key. Store this ID in your database to reference the key later. This ID is not sensitive and can be logged or displayed in dashboards.
	KeyId string `json:"keyId"`
}

type V2KeysMigrateKeysRequestBody struct {
	// ApiId The ID of the API that the keys should be inserted into
	ApiId string                 `json:"apiId"`
	Keys  []V2KeysMigrateKeyData `json:"keys"`

	// MigrationId Identifier of the configured migration provider/strategy to use (e.g., "your_company"). You will receive this from Unkey's support staff.
	MigrationId string `json:"migrationId"`
}

type V2KeysMigrateKeysResponseBody struct {
	Data V2KeysMigrateKeysResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysMigrateKeysResponseData struct {
	// Failed Hashes that could not be migrated (e.g., already exist in the system)
	Failed []string `json:"failed"`

	// Migrated Successfully migrated keys with their hash and generated keyId
	Migrated []V2KeysMigrateKeysMigration `json:"migrated"`
}

type V2KeysRemovePermissionsRequestBody struct {
	// KeyId Specifies which key to remove permissions from using the database identifier returned from `keys.createKey`.
	// Do not confuse this with the actual API key string that users include in requests.
	KeyId string `json:"keyId"`

	// Permissions Removes direct permissions from the key without affecting role-based permissions.
	//
	// You can either use a permission slug, or the permission ID.
	//
	// After removal, verification checks for these permissions will fail unless granted through roles.
	Permissions []string `json:"permissions"`
}

type V2KeysRemovePermissionsResponseBody struct {
	// Data Complete list of all permissions directly assigned to the key after the removal operation (remaining permissions only).
	//
	// Notes:
	// - This list does NOT include permissions granted through roles
	// - For a complete permission picture, use `/v2/keys.getKey` instead
	// - An empty array indicates the key has no direct permissions assigned
	// - Any cached versions of the key are immediately invalidated to ensure consistency
	// - Changes to permissions take effect within seconds for new verifications
	Data V2KeysRemovePermissionsResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysRemovePermissionsResponseData = []Permission

type V2KeysRemoveRolesRequestBody struct {
	// KeyId Specifies which key loses the roles using the database identifier returned from createKey.
	// Do not confuse this with the actual API key string that users include in requests.
	// Removing roles only affects direct assignments, not permissions inherited from other sources.
	// Role changes take effect immediately but may take up to 30 seconds to propagate across all regions.
	KeyId string `json:"keyId"`

	// Roles Removes direct role assignments from the key without affecting other role sources or permissions.
	// Operations are idempotent - removing non-assigned roles has no effect and causes no errors.
	//
	// After removal, the key loses access to permissions that were only granted through these roles.
	// Invalid role references cause the entire operation to fail atomically, ensuring consistent state.
	Roles []string `json:"roles"`
}

type V2KeysRemoveRolesResponseBody struct {
	// Data Complete list of all roles directly assigned to the key after the removal operation completes.
	//
	// The response includes:
	// - The remaining roles still assigned to the key (after removing the specified roles)
	// - Both ID and name for each role for easy reference
	//
	// Important notes:
	// - The response reflects the current state after the removal operation
	// - An empty array indicates the key now has no roles assigned
	// - This only shows direct role assignments
	// - Role permissions are not expanded in this response - use keys.getKey for full details
	// - Changes take effect immediately for new verifications but cached sessions may retain old permissions briefly
	Data V2KeysRemoveRolesResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysRemoveRolesResponseData = []Role

type V2KeysRerollKeyRequestBody struct {
	// Expiration Duration in milliseconds until the ORIGINAL key is revoked, starting from now.
	//
	// This parameter controls the overlap period for key rotation:
	// - Set to `0` to revoke the original key immediately
	// - Positive values keep the original key active for the specified duration
	// - Allows graceful migration by giving users time to update their credentials
	//
	// Common overlap periods:
	// - Immediate revocation: 0
	// - 1 hour grace period: 3600000
	// - 24 hours grace period: 86400000
	// - 7 days grace period: 604800000
	// - 30 days grace period: 2592000000
	Expiration int64 `json:"expiration"`

	// KeyId The database identifier of the key to reroll.
	//
	// This is the unique ID returned when creating or listing keys, NOT the actual API key token.
	// You can find this ID in:
	// - The response from `keys.createKey`
	// - Key verification responses
	// - The Unkey dashboard
	// - API key listing endpoints
	KeyId string `json:"keyId"`
}

type V2KeysRerollKeyResponseBody struct {
	Data V2KeysRerollKeyResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysRerollKeyResponseData struct {
	// Key The newly generated API key token (the actual secret that authenticates requests).
	//
	// **SECURITY CRITICAL:**
	// - This is the only time you'll receive the complete key
	// - Unkey stores only a hashed version (unless the original key was created with `recoverable=true`)
	// - Never log, store, or expose this value in your systems
	// - Transmit directly to the end user via secure channels only
	// - If lost and not recoverable, you must reroll or create a new key
	//
	// The key format follows: `[prefix]_[random_bytes]`
	// - Prefix is extracted from the original key or uses API default
	// - Random bytes follow API configuration (default: 16 bytes)
	//
	// This is NOT the keyId - it's the actual secret token used for authentication.
	Key string `json:"key"`

	// KeyId The unique identifier for the newly created key.
	//
	// This is NOT the actual API key token, but a reference ID for management operations.
	// Store this ID to:
	// - Update or revoke the key later
	// - Track the key in your database
	// - Display in admin dashboards (safe to log)
	//
	// Note: This is a new ID - the original key retains its own ID.
	KeyId string `json:"keyId"`
}

type V2KeysSetPermissionsRequestBody struct {
	// KeyId Specifies which key receives the additional permissions using the database identifier returned from `keys.createKey`.
	// Do not confuse this with the actual API key string that users include in requests.
	KeyId string `json:"keyId"`

	// Permissions The permissions to set for this key.
	//
	// This is a complete replacement operation - it overwrites all existing direct permissions with this new set.
	//
	// Key behaviors:
	// - Providing an empty array removes all direct permissions from the key
	// - This only affects direct permissions - permissions granted through roles are not affected
	// - All existing direct permissions not included in this list will be removed
	//
	// Any permissions that do not exist will be auto created if the root key has permissions, otherwise this operation will fail with a 403 error.
	Permissions []string `json:"permissions"`
}

type V2KeysSetPermissionsResponseBody struct {
	// Data Complete list of all permissions now directly assigned to the key after the set operation has completed.
	//
	// The response includes:
	// - The comprehensive, updated set of direct permissions (reflecting the complete replacement)
	// - Both ID and name for each permission for easy reference
	//
	// Important notes:
	// - This only shows direct permissions, not those granted through roles
	// - An empty array means the key has no direct permissions assigned
	// - For a complete permission picture including roles, use keys.getKey instead
	Data V2KeysSetPermissionsResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysSetPermissionsResponseData = []Permission

type V2KeysSetRolesRequestBody struct {
	// KeyId Specifies which key gets the complete role replacement using the database identifier returned from createKey.
	// Do not confuse this with the actual API key string that users include in requests.
	// This is a wholesale replacement operation that removes all existing roles not included in the request.
	// Role changes take effect immediately but may take up to 30 seconds to propagate across all regions.
	KeyId string `json:"keyId"`

	// Roles Replaces all existing role assignments with this complete list of roles.
	// This is a wholesale replacement operation, not an incremental update like add/remove operations.
	//
	// Providing an empty array removes all direct role assignments from the key.
	// All roles must already exist in the workspace - roles cannot be created automatically.
	// Invalid role references cause the entire operation to fail atomically, ensuring consistent state.
	Roles []string `json:"roles"`
}

type V2KeysSetRolesResponseBody struct {
	// Data Complete list of all roles now directly assigned to the key after the set operation has completed.
	//
	// The response includes:
	// - The comprehensive, updated set of roles (reflecting the complete replacement)
	// - Both ID and name for each role for easy reference
	//
	// Important notes:
	// - This response shows the final state after the complete replacement
	// - If you provided an empty array in the request, this will also be empty
	// - This only shows direct role assignments on the key
	// - Role permissions are not expanded in this response - use keys.getKey for complete details
	// - An empty array indicates the key now has no roles assigned at all
	Data V2KeysSetRolesResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysSetRolesResponseData = []Role

type V2KeysUpdateCreditsRequestBody struct {
	// KeyId The ID of the key to update (begins with `key_`). This is the database reference ID for the key, not the actual API key string that users authenticate with. This ID uniquely identifies which key's credits will be updated.
	KeyId string `json:"keyId"`

	// Operation Defines how to modify the key's remaining credits. Use 'set' to replace current credits with a specific value or unlimited usage, 'increment' to add credits for plan upgrades or credit purchases, and 'decrement' to reduce credits for refunds or policy violations.
	Operation V2KeysUpdateCreditsRequestBodyOperation `json:"operation"`

	// Value The credit value to use with the specified operation. The meaning depends on the operation: for 'set', this becomes the new remaining credits value; for 'increment', this amount is added to current credits; for 'decrement', this amount is subtracted from current credits.
	//
	// Set to null when using 'set' operation to make the key unlimited (removes usage restrictions entirely). When decrementing, if the result would be negative, remaining credits are automatically set to zero. Credits are consumed during successful key verification, and when credits reach zero, verification fails with `code=USAGE_EXCEEDED`.
	//
	// Required when using 'increment' or 'decrement' operations. Optional for 'set' operation (null creates unlimited usage).
	Value nullable.Nullable[int64] `json:"value,omitempty"`
}

type V2KeysUpdateCreditsRequestBodyOperation string

type V2KeysUpdateCreditsResponseBody struct {
	// Data Credit configuration and remaining balance for this key.
	Data KeyCreditsData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysUpdateKeyRequestBody struct {
	// Credits Credit configuration and remaining balance for this key.
	Credits nullable.Nullable[UpdateKeyCreditsData] `json:"credits,omitempty"`

	// Enabled Controls whether the key is currently active for verification requests.
	// When set to `false`, all verification attempts fail with `code=DISABLED` regardless of other settings.
	// Omitting this field preserves the current enabled status.
	// Useful for temporarily suspending access during billing issues, security incidents, or maintenance windows without losing key configuration.
	Enabled *bool `json:"enabled,omitempty"`

	// Expires Sets when this key automatically expires as a Unix timestamp in milliseconds.
	// Verification fails with code=EXPIRED immediately after this time passes.
	// Omitting this field preserves the current expiration, while setting null makes the key permanent.
	//
	// Avoid setting timestamps in the past as they immediately invalidate the key.
	// Keys expire based on server time, not client time, which prevents timezone-related issues.
	// Active sessions continue until their next verification attempt after expiry.
	Expires nullable.Nullable[int64] `json:"expires,omitempty"`

	// ExternalId Links this key to a user or entity in your system for ownership tracking during verification.
	// Omitting this field preserves the current association, while setting null disconnects the key from any identity.
	// Essential for user-specific analytics, billing, and key management across multiple users.
	// Supports letters, numbers, underscores, dots, and hyphens for flexible identifier formats.
	ExternalId nullable.Nullable[string] `json:"externalId,omitempty"`

	// KeyId Specifies which key to update using the database identifier returned from `createKey`.
	// Do not confuse this with the actual API key string that users include in requests.
	KeyId string `json:"keyId"`

	// Meta Stores arbitrary JSON metadata returned during key verification.
	// Omitting this field preserves existing metadata, while setting null removes all metadata entirely.
	// Avoid storing sensitive data here as it's returned in verification responses.
	// Large metadata objects increase verification latency and should stay under 10KB total size.
	Meta nullable.Nullable[map[string]interface{}] `json:"meta,omitempty"`

	// Name Sets a human-readable name for internal organization and identification.
	// Omitting this field leaves the current name unchanged, while setting null removes it entirely.
	// Avoid generic names like "API Key" when managing multiple keys per user or service.
	Name        nullable.Nullable[string] `json:"name,omitempty"`
	Permissions *[]string                 `json:"permissions,omitempty"`

	// Ratelimits Defines time-based rate limits that protect against abuse by controlling request frequency.
	// Omitting this field preserves existing rate limits, while setting null removes all rate limits.
	// Unlike credits which track total usage, rate limits reset automatically after each window expires.
	// Multiple rate limits can control different operation types with separate thresholds and windows.
	Ratelimits *[]RatelimitRequest `json:"ratelimits,omitempty"`
	Roles      *[]string           `json:"roles,omitempty"`
}

type V2KeysUpdateKeyResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysVerifyKeyRequestBody struct {
	// Credits Controls credit consumption for usage-based billing and quota enforcement.
	// Omitting this field uses the default cost of 1 credit per verification.
	// Credits provide globally consistent usage tracking, essential for paid APIs with strict quotas.
	Credits *KeysVerifyKeyCredits `json:"credits,omitempty"`

	// Key The API key to verify, exactly as provided by your user.
	// Include any prefix - even small changes will cause verification to fail.
	Key string `json:"key"`

	// MigrationId Migrate keys on demand from your previous system. Reach out for migration support at support@unkey.dev
	MigrationId *string `json:"migrationId,omitempty"`

	// Permissions Checks if the key has the specified permission(s) using a query syntax.
	// Supports single permissions, logical operators (AND, OR), and parentheses for grouping.
	// Examples:
	// - Single permission: "documents.read"
	// - Multiple permissions: "documents.read AND documents.write"
	// - Complex queries: "(documents.read OR documents.write) AND users.view"
	// Verification fails if the key lacks the required permissions through direct assignment or role inheritance.
	Permissions *string `json:"permissions,omitempty"`

	// Ratelimits Enforces time-based rate limiting during verification to prevent abuse and ensure fair usage.
	// Omitting this field skips rate limit checks entirely, relying only on configured key rate limits.
	// Multiple rate limits can be checked simultaneously, each with different costs and temporary overrides.
	// Rate limit checks are optimized for performance but may allow brief bursts during high concurrency.
	Ratelimits *[]KeysVerifyKeyRatelimit `json:"ratelimits,omitempty"`

	// Tags Attaches metadata tags for analytics and monitoring without affecting verification outcomes.
	// Enables segmentation of API usage in dashboards by endpoint, client version, region, or custom dimensions.
	// Use 'key=value' format for compatibility with most analytics tools and clear categorization.
	// Avoid including sensitive data in tags as they may appear in logs and analytics reports.
	Tags *[]string `json:"tags,omitempty"`
}

type V2KeysVerifyKeyResponseBody struct {
	Data V2KeysVerifyKeyResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2KeysVerifyKeyResponseData struct {
	// Code A machine-readable code indicating the verification status
	// or failure reason. Values: `VALID` (key is valid and passed all checks), `NOT_FOUND` (key doesn't
	// exist or belongs to wrong API), `FORBIDDEN` (key lacks required permissions), `INSUFFICIENT_PERMISSIONS`
	// (key lacks specific required permissions for this request), `USAGE_EXCEEDED` (key has no remaining credits), `RATE_LIMITED` (key exceeded rate limits), `DISABLED` (key was explicitly disabled),
	// `EXPIRED` (key has passed its expiration date).
	Code V2KeysVerifyKeyResponseDataCode `json:"code"`

	// Credits The number of requests/credits remaining for this key. If omitted,
	// the key has unlimited usage. This value decreases with
	// each verification (based on the 'cost' parameter) unless explicit credit
	// refills are configured.
	Credits *int64 `json:"credits,omitempty"`

	// Enabled Indicates if the key is currently enabled. Disabled keys will
	// always fail verification with `code=DISABLED`. This is useful for implementing
	// temporary suspensions without deleting the key.
	Enabled *bool `json:"enabled,omitempty"`

	// Expires Unix timestamp (in milliseconds) when the key will expire.
	// If omitted, the key has no expiration. You can use this to
	// warn users about upcoming expirations or to understand the validity period.
	Expires  int64     `json:"expires,omitempty"`
	Identity *Identity `json:"identity,omitempty"`

	// KeyId The unique identifier of the verified key in Unkey's system.
	// Use this ID for operations like updating or revoking the key. This field
	// is returned for both valid and invalid keys (except when `code=NOT_FOUND`).
	KeyId string `json:"keyId,omitempty"`

	// Meta Custom metadata associated with the key. This can include any
	// JSON-serializable data you stored with the key during creation or updates,
	// such as plan information, feature flags, or user details. Use this to
	// avoid additional database lookups for contextual information needed during
	// API calls.
	Meta map[string]interface{} `json:"meta,omitempty"`

	// Name The human-readable name assigned to this key during creation.
	// This is useful for displaying in logs or admin interfaces to identify
	// the key's purpose.
	Name string `json:"name,omitempty"`

	// Permissions A list of all permission names assigned to this key, either
	// directly or through roles. These permissions determine what actions the
	// key can perform. Only returned when permissions were checked during verification
	// or when the key fails with `code=FORBIDDEN`.
	Permissions []string                 `json:"permissions,omitempty"`
	Ratelimits  []VerifyKeyRatelimitData `json:"ratelimits,omitempty"`

	// Roles A list of all role names assigned to this key. Roles are collections
	// of permissions that grant access to specific functionality. Only returned
	// when permissions were checked during verification.
	Roles []string `json:"roles,omitempty"`

	// Valid The primary verification result. If true, the key is valid
	// and can be used. If false, check the 'code' field to understand why verification
	// failed. Your application should always check this field first before proceeding.
	Valid bool `json:"valid"`
}

type V2KeysVerifyKeyResponseDataCode string

type V2KeysWhoamiRequestBody struct {
	// Key The complete API key string provided by you, including any prefix.
	// Never log, cache, or store API keys in your system as they provide full access to user resources.
	// Include the full key exactly as provided - even minor modifications will cause a not found error.
	Key string `json:"key"`
}

type V2KeysWhoamiResponseBody struct {
	Data KeyResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2LivenessResponseBody struct {
	// Data Response data for the liveness check endpoint. This provides a simple indication of whether the Unkey API service is running and able to process requests. Monitoring systems can use this endpoint to track service availability and trigger alerts if the service becomes unhealthy.
	Data V2LivenessResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2LivenessResponseData struct {
	// Message Status message indicating the health of the service. A value of 'OK' indicates that the service is functioning properly and ready to accept requests. Any other value indicates a potential issue with the service health.
	Message string `json:"message"`
}

type V2PermissionsCreatePermissionRequestBody struct {
	// Description Provides detailed documentation of what this permission grants access to.
	// Include information about affected resources, allowed actions, and any important limitations.
	// This internal documentation helps team members understand permission scope and security implications.
	// Not visible to end users - designed for development teams and security audits.
	//
	// Consider documenting:
	// - What resources can be accessed
	// - What operations are permitted
	// - Any conditions or limitations
	// - Related permissions that might be needed
	Description *string `json:"description,omitempty"`

	// Name Creates a permission with this human-readable name that describes its purpose.
	// Names must be unique within your workspace to prevent conflicts during assignment.
	// Use clear, semantic names that developers can easily understand when building authorization logic.
	// Consider using hierarchical naming conventions like 'resource.action' for better organization.
	//
	// Examples: 'users.read', 'billing.write', 'analytics.view', 'admin.manage'
	Name string `json:"name"`

	// Slug Creates a URL-safe identifier for this permission that can be used in APIs and integrations.
	// Must start with a letter and contain only letters, numbers, periods, underscores, and hyphens.
	// Slugs are often used in REST endpoints, configuration files, and external integrations.
	// Should closely match the name but in a format suitable for technical usage.
	// Must be unique within your workspace to ensure reliable permission lookups.
	//
	// Keep slugs concise but descriptive for better developer experience.
	Slug string `json:"slug"`
}

type V2PermissionsCreatePermissionResponseBody struct {
	Data V2PermissionsCreatePermissionResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2PermissionsCreatePermissionResponseData struct {
	// PermissionId The unique identifier assigned to the newly created permission.
	// Use this ID to reference the permission in role assignments, key operations, and other API calls.
	// Always begins with 'perm_' followed by a unique alphanumeric sequence.
	// Store this ID if you need to manage or reference this permission in future operations.
	PermissionId string `json:"permissionId"`
}

type V2PermissionsCreateRoleRequestBody struct {
	// Description Provides comprehensive documentation of what this role encompasses and what access it grants.
	// Include information about the intended use case, what permissions should be assigned, and any important considerations.
	// This internal documentation helps team members understand role boundaries and security implications.
	// Not visible to end users - designed for administration teams and access control audits.
	//
	// Consider documenting:
	// - The role's intended purpose and scope
	// - What types of users should receive this role
	// - What permissions are typically associated with it
	// - Any security considerations or limitations
	// - Related roles that might be used together
	Description *string `json:"description,omitempty"`

	// Name The unique name for this role. Must be unique within your workspace and clearly indicate the role's purpose. Use descriptive names like 'admin', 'editor', or 'billing_manager'.
	//
	// Examples: 'admin.billing', 'support.readonly', 'developer.api', 'manager.analytics'
	Name string `json:"name"`
}

type V2PermissionsCreateRoleResponseBody struct {
	Data V2PermissionsCreateRoleResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2PermissionsCreateRoleResponseData struct {
	// RoleId The unique identifier assigned to the newly created role.
	// Use this ID to reference the role in permission assignments, key operations, and role management calls.
	// Always begins with 'role_' followed by a unique alphanumeric sequence.
	// Store this ID if you need to manage, modify, or assign this role in future operations.
	RoleId string `json:"roleId"`
}

type V2PermissionsDeletePermissionRequestBody struct {
	// Permission Specifies which permission to permanently delete from your workspace.
	//
	// This can be a permission ID or a permission slug.
	//
	// WARNING: Deleting a permission has immediate and irreversible consequences:
	// - All API keys with this permission will lose that access immediately
	// - All roles containing this permission will have it removed
	// - Any verification requests checking for this permission will fail
	// - This action cannot be undone
	//
	// Before deletion, ensure you:
	// - Have updated any keys or roles that depend on this permission
	// - Have migrated to alternative permissions if needed
	// - Have notified affected users about the access changes
	Permission string `json:"permission"`
}

type V2PermissionsDeletePermissionResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2PermissionsDeleteRoleRequestBody struct {
	// Role Unique identifier of the role to permanently delete from your workspace.
	// Must either be a valid role ID that begins with 'role_' or the given role name and exists within your workspace.
	//
	// WARNING: Deletion is immediate and irreversible with significant consequences:
	// - All API keys assigned this role will lose the associated permissions
	// - Access to resources protected by this role's permissions will be denied
	// - Any authorization logic depending on this role will start failing
	// - Historical analytics referencing this role remain intact
	//
	// Before deletion, ensure:
	// - You've updated any dependent authorization logic or code
	// - You've migrated any keys to use alternative roles or direct permissions
	// - You've notified relevant team members of the access changes
	Role string `json:"role"`
}

type V2PermissionsDeleteRoleResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2PermissionsGetPermissionRequestBody struct {
	// Permission The unique identifier of the permission to retrieve. Must be a valid permission ID that begins with 'perm_' and exists within your workspace.
	Permission string `json:"permission"`
}

type V2PermissionsGetPermissionResponseBody struct {
	Data Permission `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2PermissionsGetRoleRequestBody struct {
	// Role Unique identifier of the role to permanently delete from your workspace.
	// Must either be a valid role ID that begins with 'role_' or the given role name and exists within your workspace.
	//
	// Use this endpoint to verify role details, check its current permissions, or retrieve metadata.
	// Returns complete role information including all assigned permissions for comprehensive access review.
	Role string `json:"role"`
}

type V2PermissionsGetRoleResponseBody struct {
	Data Role `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2PermissionsListPermissionsRequestBody struct {
	// Cursor Pagination cursor from a previous response to fetch the next page of permissions.
	// Include this value when you need to retrieve additional permissions beyond the initial response.
	// Each response containing more results than the requested limit includes a cursor for subsequent pages.
	//
	// Leave empty or omit this field to start from the beginning of the permission list.
	// Cursors are temporary and may expire - always handle cases where a cursor becomes invalid.
	Cursor *string `json:"cursor,omitempty"`

	// Limit Maximum number of permissions to return in a single response.
	Limit *int `json:"limit,omitempty"`

	// Search Free-form text to filter permissions. Returns permissions whose ID, name, slug, or description contains the search string. Matching is case-insensitive.
	Search *string `json:"search,omitempty"`
}

type V2PermissionsListPermissionsResponseBody struct {
	// Data Array of permission objects with complete configuration details.
	Data V2PermissionsListPermissionsResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`

	// Pagination Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
	Pagination Pagination `json:"pagination"`
}

type V2PermissionsListPermissionsResponseData = []Permission

type V2PermissionsListRolesRequestBody struct {
	// Cursor Pagination cursor from a previous response to fetch the next page of roles.
	// Include this when you need to retrieve additional roles beyond the first page.
	// Each response containing more results will include a cursor value that can be used here.
	// Leave empty or omit this field to start from the beginning of the role list.
	Cursor *string `json:"cursor,omitempty"`

	// Limit Maximum number of roles to return in a single response.
	// Use smaller values for faster response times and better UI performance.
	// Use larger values when you need to process many roles efficiently.
	// Results exceeding this limit will be paginated with a cursor for continuation.
	Limit *int `json:"limit,omitempty"`

	// Search Free-form text to filter roles. Returns roles whose ID, name, or description contains the search string. Matching is case-insensitive.
	Search *string `json:"search,omitempty"`
}

type V2PermissionsListRolesResponseBody struct {
	// Data Array of roles with their assigned permissions.
	Data V2PermissionsListRolesResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`

	// Pagination Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
	Pagination Pagination `json:"pagination"`
}

type V2PermissionsListRolesResponseData = []Role

type V2PortalCreateSessionRequestBody struct {
	// ExternalId The end user's identifier in the customer's system.
	// Accepts arbitrary string values (user IDs, emails, UUIDs, etc.).
	ExternalId string `json:"externalId"`

	// Permissions The capabilities granted to the end user in the Portal, from a fixed
	// vocabulary. All capabilities are scoped to this end user: key capabilities
	// (`keys:*`) apply only to keys the end user owns within the keyspace
	// configured on the portal configuration, and `analytics:read` returns only
	// the end user's own verification events. An end user can never see another
	// identity's keys or analytics.
	//
	// Tab visibility is derived from the capabilities:
	// - Keys tab: any `keys:*` capability
	// - Analytics tab: `analytics:read`
	// - Docs tab: visible when any capability is present
	Permissions []V2PortalCreateSessionRequestBodyPermissions `json:"permissions"`

	// Preview When true, creates a preview session for testing the portal experience.
	Preview *bool `json:"preview,omitempty"`

	// Slug The human-readable slug of the portal configuration to create the session against.
	// Identifies which app's portal the end user will access.
	// Must be 3-64 characters, lowercase alphanumeric and hyphens only,
	// must not start or end with a hyphen, and must not contain consecutive hyphens.
	Slug string `json:"slug"`
}

type V2PortalCreateSessionRequestBodyPermissions string

type V2PortalCreateSessionResponseBody struct {
	Data V2PortalCreateSessionResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2PortalCreateSessionResponseData struct {
	// SessionId The short-lived session token ID. Valid for 15 minutes and can be exchanged once for a browser session.
	SessionId string `json:"sessionId"`

	// Url The full portal URL with the session parameter. Redirect the end user to this URL.
	Url string `json:"url"`
}

type V2PortalExchangeSessionRequestBody struct {
	// SessionId The session token ID received from `portal.createSession`.
	// Must be valid, unexpired, and not previously exchanged.
	SessionId string `json:"sessionId"`
}

type V2PortalExchangeSessionResponseBody struct {
	Data V2PortalExchangeSessionResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2PortalExchangeSessionResponseData struct {
	// ExpiresAt Unix timestamp in milliseconds when the browser session expires (24 hours from creation).
	ExpiresAt int64 `json:"expiresAt"`

	// Token The browser session token. Store this as an httpOnly cookie for subsequent portal requests.
	Token string `json:"token"`
}

type V2PortalGetVerificationsDataPoint struct {
	// Disabled Verifications rejected because the key was disabled.
	Disabled int64 `json:"disabled"`

	// Expired Verifications rejected because the key was expired.
	Expired int64 `json:"expired"`

	// Forbidden Verifications rejected as forbidden.
	Forbidden int64 `json:"forbidden"`

	// InsufficientPermissions Verifications rejected for insufficient permissions.
	InsufficientPermissions int64 `json:"insufficientPermissions"`

	// RateLimited Verifications rejected because a rate limit was exceeded.
	RateLimited int64 `json:"rateLimited"`

	// Time Bucket start as a unix timestamp in milliseconds.
	Time int64 `json:"time"`

	// Total Total verifications in this bucket, across all outcomes.
	Total int64 `json:"total"`

	// UsageExceeded Verifications rejected because remaining usage was exhausted.
	UsageExceeded int64 `json:"usageExceeded"`

	// Valid Verifications with a VALID outcome.
	Valid int64 `json:"valid"`
}

type V2PortalGetVerificationsRequestBody struct {
	// EndTime End of the query window as a unix timestamp in milliseconds (exclusive).
	// Bucket granularity (minute, hour, or day) is chosen automatically from the
	// window size.
	EndTime int64 `json:"endTime"`

	// KeyId Optional. Restrict results to a single key. The key must belong to the
	// authenticated end user; results are always scoped to the session identity
	// regardless of this value.
	KeyId *string `json:"keyId,omitempty"`

	// StartTime Start of the query window as a unix timestamp in milliseconds (inclusive).
	StartTime int64 `json:"startTime"`
}

type V2PortalGetVerificationsResponseBody struct {
	// Data Zero-filled verification timeseries for the authenticated end user, ordered
	// by time ascending. Buckets with no verifications are present with zero
	// counts so the series is contiguous across the requested window.
	Data []V2PortalGetVerificationsDataPoint `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2PortalListKeysRequestBody struct {
	// Cursor Pagination cursor from a previous response to fetch the next page.
	// Use when `hasMore: true` in the previous response.
	Cursor *string `json:"cursor,omitempty"`

	// Limit Maximum number of keys to return per request.
	// Balance between response size and number of pagination calls needed.
	Limit *int `json:"limit,omitempty"`
}

type V2PortalListKeysResponseBody struct {
	// Data Array of the portal end user's API keys.
	Data V2PortalListKeysResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`

	// Pagination Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
	Pagination Pagination `json:"pagination"`
}

type V2PortalListKeysResponseData = []KeyResponseData

type V2ProjectsCreateProjectRequestBody struct {
	// Name Human-readable name for this project.
	// Use a descriptive name like 'Payments Service' to identify its purpose.
	Name string `json:"name"`

	// Slug Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Slug ResourceIdentifier `json:"slug"`
}

type V2ProjectsCreateProjectResponseBody struct {
	Data V2ProjectsCreateProjectResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2ProjectsCreateProjectResponseData struct {
	// Id The unique identifier of the newly created project, generated by Unkey.
	// Always begins with 'proj_' followed by a unique alphanumeric sequence.
	Id string `json:"id"`
}

type V2ProjectsDeleteProjectRequestBody struct {
	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`
}

type V2ProjectsDeleteProjectResponseBody struct {
	// Data Empty response object by design. A successful response indicates this operation was successfully executed.
	Data EmptyResponse `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2ProjectsGetProjectRequestBody struct {
	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`
}

type V2ProjectsGetProjectResponseBody struct {
	Data Project `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2ProjectsListProjectsRequestBody struct {
	// Cursor Pagination cursor from a previous response to fetch the next page.
	// Use when `hasMore: true` in the previous response.
	Cursor *string `json:"cursor,omitempty"`

	// Limit Maximum number of projects to return per request.
	// Balance between response size and number of pagination calls needed.
	Limit *int `json:"limit,omitempty"`

	// Search Free-form text to filter projects. Returns projects whose ID, name, or slug contains the search string. Matching is case-insensitive.
	Search *string `json:"search,omitempty"`
}

type V2ProjectsListProjectsResponseBody struct {
	// Data Array of projects in the workspace, ordered by project id.
	Data []Project `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`

	// Pagination Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
	Pagination Pagination `json:"pagination"`
}

type V2ProjectsUpdateProjectRequestBody struct {
	// DeleteProtection Enable or disable delete protection for the project.
	// Omit this field to leave the current setting unchanged.
	DeleteProtection *bool `json:"deleteProtection,omitempty"`

	// Name New human-readable name for the project.
	// Omit this field to leave the current name unchanged.
	Name *string `json:"name,omitempty"`

	// Project Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Project ResourceIdentifier `json:"project"`

	// Slug Identifies a resource by either its unique ID or its slug.
	// Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
	Slug *ResourceIdentifier `json:"slug,omitempty"`
}

type V2ProjectsUpdateProjectResponseBody struct {
	Data Project `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2RatelimitDeleteOverrideRequestBody struct {
	// Identifier The exact identifier pattern of the override to delete. This must match exactly as it was specified when creating the override.
	//
	// Important notes:
	// - This is case-sensitive and must match exactly
	// - Include any wildcards (*) that were part of the original pattern
	// - For example, if the override was created for 'premium_*', you must use 'premium_*' here, not a specific ID
	//
	// After deletion, any identifiers previously affected by this override will immediately revert to using the default rate limit for the namespace.
	Identifier string `json:"identifier"`

	// Namespace The id or name of the namespace containing the override.
	Namespace string `json:"namespace"`
}

type V2RatelimitDeleteOverrideResponseBody struct {
	// Data Empty response object. A successful response indicates the override was successfully deleted. The operation is immediate - as soon as this response is received, the override no longer exists and affected identifiers have reverted to using the default rate limit for the namespace. No other data is returned as part of the deletion operation.
	Data V2RatelimitDeleteOverrideResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2RatelimitDeleteOverrideResponseData = map[string]interface{}

type V2RatelimitGetOverrideRequestBody struct {
	// Identifier The exact identifier pattern for the override you want to retrieve. This must match exactly as it was specified when creating the override.
	//
	// Important notes:
	// - This is case-sensitive and must match exactly
	// - Include any wildcards (*) that were part of the original pattern
	// - For example, if the override was created for 'premium_*', you must use 'premium_*' here, not a specific ID like 'premium_user1'
	//
	// This field is used to look up the specific override configuration for this pattern.
	Identifier string `json:"identifier"`

	// Namespace The id or name of the namespace containing the override.
	Namespace string `json:"namespace"`
}

type V2RatelimitGetOverrideResponseBody struct {
	Data RatelimitOverride `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2RatelimitLimitRequestBody struct {
	// Cost Sets how much of the rate limit quota this request consumes, enabling weighted rate limiting.
	// Use higher values for resource-intensive operations and 0 for tracking without limiting.
	// When accumulated cost exceeds the limit within the duration window, subsequent requests are rejected.
	// Essential for implementing fair usage policies and preventing resource abuse through expensive operations.
	Cost *int64 `json:"cost,omitempty"`

	// Duration Sets the rate limit window duration in milliseconds after which the counter resets.
	// Shorter durations enable faster recovery but may be less effective against sustained abuse.
	// Common values include 60000 (1 minute), 3600000 (1 hour), and 86400000 (24 hours).
	// Balance user experience with protection needs when choosing window sizes.
	Duration int64 `json:"duration"`

	// Identifier Defines the scope of rate limiting by identifying the entity being limited.
	// Use user IDs for per-user limits, IP addresses for anonymous limiting, or API key IDs for per-key limits.
	// Accepts letters, numbers, underscores, dots, colons, slashes, and hyphens for flexible identifier formats.
	// The same identifier can be used across different namespaces to apply multiple rate limit types.
	// Choose identifiers that provide appropriate granularity for your rate limiting strategy.
	Identifier string `json:"identifier"`

	// Limit Sets the maximum operations allowed within the duration window before requests are rejected.
	// When this limit is reached, subsequent requests fail with `RATE_LIMITED` until the window resets.
	// Balance user experience with resource protection when setting limits for different user tiers.
	// Consider system capacity, business requirements, and fair usage policies in limit determination.
	Limit int64 `json:"limit"`

	// Namespace The id or name of the namespace.
	Namespace string `json:"namespace"`
}

type V2RatelimitLimitResponseBody struct {
	Data V2RatelimitLimitResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2RatelimitLimitResponseData struct {
	// Limit The maximum number of operations allowed within the time window. This reflects either the default limit specified in the request or an override limit if one exists for this identifier.
	//
	// This value helps clients understand their total quota for the current window.
	Limit int64 `json:"limit"`

	// OverrideId If a rate limit override was applied for this identifier, this field contains the ID of the override that was used. Empty when no override is in effect.
	//
	// This can be useful for:
	// - Debugging which override rule was matched
	// - Tracking the effects of specific overrides
	// - Understanding why limits differ from default values
	OverrideId string `json:"overrideId,omitempty"`

	// Remaining The number of operations remaining in the current window before the rate limit is exceeded. Applications should use this value to:
	//
	// - Implement client-side throttling before hitting limits
	// - Display usage information to end users
	// - Trigger alerts when approaching limits
	// - Adjust request patterns based on available capacity
	//
	// When this reaches zero, requests will be rejected until the window resets.
	Remaining int64 `json:"remaining"`

	// Reset The Unix timestamp in milliseconds when the rate limit window will reset and 'remaining' will return to 'limit'.
	//
	// This timestamp enables clients to:
	// - Calculate and display wait times to users
	// - Implement intelligent retry mechanisms
	// - Schedule requests to resume after the reset
	// - Implement exponential backoff when needed
	//
	// The reset time is based on a sliding window from the first request in the current window.
	Reset int64 `json:"reset"`

	// Success Whether the request passed the rate limit check. If true, the request is allowed to proceed. If false, the request has exceeded the rate limit and should be blocked or rejected.
	//
	// You MUST check this field to determine if the request should proceed, as the endpoint always returns `HTTP 200` even when rate limited.
	Success bool `json:"success"`
}

type V2RatelimitListOverridesRequestBody struct {
	// Cursor Pagination cursor from a previous response. Include this when fetching subsequent pages of results. Each response containing more results than the requested limit will include a cursor value in the pagination object that can be used here.
	Cursor *string `json:"cursor,omitempty"`

	// Limit Maximum number of override entries to return in a single response. Use this to control response size and loading performance.
	//
	// - Lower values (10-20): Better for UI displays and faster response times
	// - Higher values (50-100): Better for data exports or bulk operations
	// - Default (10): Suitable for most dashboard views
	//
	// Results exceeding this limit will be paginated, with a cursor provided for fetching subsequent pages.
	Limit *int `json:"limit,omitempty"`

	// Namespace The id or name of the rate limit namespace to list overrides for.
	Namespace string `json:"namespace"`
}

type V2RatelimitListOverridesResponseBody struct {
	Data V2RatelimitListOverridesResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`

	// Pagination Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.
	Pagination Pagination `json:"pagination"`
}

type V2RatelimitListOverridesResponseData = []RatelimitOverride

type V2RatelimitMultiLimitCheck struct {
	// Identifier The identifier this rate limit result corresponds to. Use this field to correlate the response with the request when checking multiple rate limits.
	Identifier string `json:"identifier"`

	// Limit The maximum number of operations allowed within the time window. This reflects either the default limit specified in the request or an override limit if one exists for this identifier.
	//
	// This value helps clients understand their total quota for the current window.
	Limit int64 `json:"limit"`

	// Namespace The namespace this rate limit result corresponds to. Use this field to correlate the response with the request when checking multiple rate limits.
	Namespace string `json:"namespace"`

	// OverrideId If a rate limit override was applied for this identifier, this field contains the ID of the override that was used. Empty when no override is in effect.
	//
	// This can be useful for:
	// - Debugging which override rule was matched
	// - Tracking the effects of specific overrides
	// - Understanding why limits differ from default values
	OverrideId string `json:"overrideId,omitempty"`

	// Passed Whether the request passed the rate limit check. If true, the request is allowed to proceed. If false, the request has exceeded the rate limit and should be blocked or rejected.
	//
	// You MUST check this field to determine if the request should proceed, as the endpoint always returns `HTTP 200` even when rate limited.
	Passed bool `json:"passed"`

	// Remaining The number of operations remaining in the current window before the rate limit is exceeded. Applications should use this value to:
	//
	// - Implement client-side throttling before hitting limits
	// - Display usage information to end users
	// - Trigger alerts when approaching limits
	// - Adjust request patterns based on available capacity
	//
	// When this reaches zero, requests will be rejected until the window resets.
	Remaining int64 `json:"remaining"`

	// Reset The Unix timestamp in milliseconds when the rate limit window will reset and 'remaining' will return to 'limit'.
	//
	// This timestamp enables clients to:
	// - Calculate and display wait times to users
	// - Implement intelligent retry mechanisms
	// - Schedule requests to resume after the reset
	// - Implement exponential backoff when needed
	//
	// The reset time is based on a sliding window from the first request in the current window.
	Reset int64 `json:"reset"`
}

type V2RatelimitMultiLimitRequestBody = []V2RatelimitLimitRequestBody

type V2RatelimitMultiLimitResponseBody struct {
	// Data Container for multi-limit rate limit check results
	Data V2RatelimitMultiLimitResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2RatelimitMultiLimitResponseData struct {
	// Limits Array of individual rate limit check results, one for each rate limit check in the request
	Limits []V2RatelimitMultiLimitCheck `json:"limits"`

	// Passed Overall success indicator for all rate limit checks. This is true if ALL individual rate limit checks passed (all have success: true), and false if ANY check failed.
	//
	// Use this as a quick indicator to determine if the request should proceed.
	Passed bool `json:"passed"`
}

type V2RatelimitSetOverrideRequestBody struct {
	// Duration The duration in milliseconds for the rate limit window. This defines how long the rate limit counter accumulates before resetting to zero.
	//
	// Considerations:
	// - This can differ from the default duration for the namespace
	// - Longer durations create stricter limits that take longer to reset
	// - Shorter durations allow more frequent bursts of activity
	// - Common values: 60000 (1 minute), 3600000 (1 hour), 86400000 (1 day)
	Duration int64 `json:"duration"`

	// Identifier Identifier of the entity receiving this custom rate limit. This can be:
	//
	// - A specific user ID for individual custom limits
	// - An IP address for location-based rules
	// - An email domain for organization-wide policies
	// - Any other string that identifies the target entity
	//
	// Wildcards (*) can be used to create pattern-matching rules that apply to multiple identifiers. For example:
	// - 'premium_*' would match all identifiers starting with 'premium_'
	// - '*_admin' would match all identifiers ending with '_admin'
	// - '*suspicious*' would match any identifier containing 'suspicious'
	//
	// More detailed information on wildcard pattern rules is available at https://www.unkey.com/docs/ratelimiting/overrides#wildcard-rules
	Identifier string `json:"identifier"`

	// Limit The maximum number of requests allowed for this override. This defines the custom quota for the specified identifier(s).
	//
	// Special values:
	// - Higher than default: For premium or trusted entities
	// - Lower than default: For suspicious or abusive entities
	// - 0: To completely block access (useful for ban implementation)
	//
	// This limit entirely replaces the default limit for matching identifiers.
	Limit int64 `json:"limit"`

	// Namespace The ID or name of the rate limit namespace.
	Namespace string `json:"namespace"`
}

type V2RatelimitSetOverrideResponseBody struct {
	Data V2RatelimitSetOverrideResponseData `json:"data"`

	// Meta Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
	Meta Meta `json:"meta"`
}

type V2RatelimitSetOverrideResponseData struct {
	// OverrideId The unique identifier for the newly created or updated rate limit override. This ID can be used to:
	//
	// - Reference this specific override in subsequent API calls
	// - Delete or modify this override later
	// - Track which override is being applied in rate limit responses
	// - Associate override effects with specific rules in analytics
	//
	// Store this ID if you need to manage the override in the future.
	OverrideId string `json:"overrideId"`
}

type ValidationError struct {
	// Fix A human-readable suggestion describing how to fix the error. This provides practical guidance on what changes would satisfy the validation requirements. Not all validation errors include fix suggestions, but when present, they offer specific remediation advice.
	Fix *string `json:"fix,omitempty"`

	// Location JSON path indicating exactly where in the request the error occurred. This helps pinpoint the problematic field or parameter. Examples include:
	// - 'body.name' (field in request body)
	// - 'body.items[3].tags' (nested array element)
	// - 'path.apiId' (path parameter)
	// - 'query.limit' (query parameter)
	// Use this location to identify exactly which part of your request needs correction.
	Location string `json:"location"`

	// Message Detailed error message explaining what validation rule was violated. This provides specific information about why the field or parameter was rejected, such as format errors, invalid values, or constraint violations.
	Message string `json:"message"`
}

type VerifyKeyRatelimitData struct {
	// AutoApply Whether this rate limit should be automatically applied when verifying keys.
	// When true, we will automatically apply this limit during verification without it being explicitly listed.
	AutoApply bool `json:"autoApply"`

	// Duration Rate limit window duration in milliseconds.
	Duration int64 `json:"duration"`

	// Exceeded Whether the rate limit was exceeded.
	Exceeded bool `json:"exceeded"`

	// Id Unique identifier for this rate limit configuration.
	Id string `json:"id"`

	// Limit Maximum requests allowed within the time window.
	Limit int64 `json:"limit"`

	// Name Human-readable name for this rate limit.
	Name string `json:"name"`

	// Remaining Rate limit remaining requests within the time window.
	Remaining int64 `json:"remaining"`

	// Reset Rate limit reset duration in milliseconds.
	Reset int64 `json:"reset"`
}