import { BaseFilterable, OperatorMap } from "../../dal"; /** * An API key's type. */ export type ApiKeyType = "secret" | "publishable"; /** * The API key details. */ export interface ApiKeyDTO { /** * The ID of the API key. */ id: string; /** * The token of the API key. */ token: string; /** * The redacted form of the API key's token. This is useful * when showing portion of the token. For example `sk_...123`. */ redacted: string; /** * The title of the API key. */ title: string; /** * The type of the API key. */ type: ApiKeyType; /** * The date the API key was last used. */ last_used_at: Date | null; /** * Who created the API key. */ created_by: string; /** * The date the API key was created. */ created_at: Date; /** * The date the API key was updated. */ updated_at: Date; /** * The date the API key was deleted. */ deleted_at: Date | null; /** * Who revoked the API key. For example, * the ID of the user that revoked it. */ revoked_by: string | null; /** * The date the API key was revoked. */ revoked_at: Date | null; } /** * The filters to apply on the retrieved API keys. */ export interface FilterableApiKeyProps extends BaseFilterable { /** * Search through the api key names and redacted keys using this search term. */ q?: string; /** * The IDs to filter the API keys by. */ id?: string | string[]; /** * The tokens to filter the API keys by. */ token?: string | string[]; /** * The titles to filter the API keys by. */ title?: string | string[]; /** * Filter the API keys by their type. */ type?: ApiKeyType; revoked_at?: OperatorMap; } //# sourceMappingURL=api-key.d.ts.map