// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { APIResource } from '../../../resource'; import * as Core from '../../../core'; import * as SecretsAPI from './secrets'; import { SecretBulkDeleteParams, SecretBulkDeleteResponse, SecretCreateParams, SecretCreateResponse, SecretCreateResponsesSinglePage, SecretDeleteParams, SecretDeleteResponse, SecretDuplicateParams, SecretDuplicateResponse, SecretEditParams, SecretEditResponse, SecretGetParams, SecretGetResponse, SecretListParams, SecretListResponse, SecretListResponsesV4PagePaginationArray, Secrets, } from './secrets'; import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../pagination'; export class Stores extends APIResource { secrets: SecretsAPI.Secrets = new SecretsAPI.Secrets(this._client); /** * Creates a store in the account * * @example * ```ts * const store = await client.secretsStore.stores.create({ * account_id: '985e105f4ecef8ad9ca31a8372d0c353', * name: 'service_x_keys', * }); * ``` */ create(params: StoreCreateParams, options?: Core.RequestOptions): Core.APIPromise { const { account_id, ...body } = params; return ( this._client.post(`/accounts/${account_id}/secrets_store/stores`, { body, ...options, }) as Core.APIPromise<{ result: StoreCreateResponse }> )._thenUnwrap((obj) => obj.result); } /** * Lists all the stores in an account * * @example * ```ts * // Automatically fetches more pages as needed. * for await (const storeListResponse of client.secretsStore.stores.list( * { account_id: '985e105f4ecef8ad9ca31a8372d0c353' }, * )) { * // ... * } * ``` */ list( params: StoreListParams, options?: Core.RequestOptions, ): Core.PagePromise { const { account_id, ...query } = params; return this._client.getAPIList( `/accounts/${account_id}/secrets_store/stores`, StoreListResponsesV4PagePaginationArray, { query, ...options }, ); } /** * Deletes a single store. By default, a store that still contains secrets cannot * be deleted and returns HTTP 409 (Conflict) with the "store_not_empty" error. * Pass `force=true` to cascade-delete all secrets in the store. Empty stores are * always deleted regardless of the force parameter. * * @example * ```ts * const store = await client.secretsStore.stores.delete( * '023e105f4ecef8ad9ca31a8372d0c353', * { account_id: '985e105f4ecef8ad9ca31a8372d0c353' }, * ); * ``` */ delete( storeId: string, params: StoreDeleteParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id, force } = params; return ( this._client.delete(`/accounts/${account_id}/secrets_store/stores/${storeId}`, { query: { force }, ...options, }) as Core.APIPromise<{ result: StoreDeleteResponse | null }> )._thenUnwrap((obj) => obj.result); } /** * Returns details of a single store * * @example * ```ts * const store = await client.secretsStore.stores.get( * '023e105f4ecef8ad9ca31a8372d0c353', * { account_id: '985e105f4ecef8ad9ca31a8372d0c353' }, * ); * ``` */ get( storeId: string, params: StoreGetParams, options?: Core.RequestOptions, ): Core.APIPromise { const { account_id } = params; return ( this._client.get( `/accounts/${account_id}/secrets_store/stores/${storeId}`, options, ) as Core.APIPromise<{ result: StoreGetResponse }> )._thenUnwrap((obj) => obj.result); } } export class StoreListResponsesV4PagePaginationArray extends V4PagePaginationArray {} export interface StoreCreateResponse { /** * Store Identifier */ id: string; /** * Whenthe secret was created. */ created: string; /** * When the secret was modified. */ modified: string; /** * The name of the store */ name: string; /** * Account Identifier */ account_id?: string; } export interface StoreListResponse { /** * Store Identifier */ id: string; /** * Whenthe secret was created. */ created: string; /** * When the secret was modified. */ modified: string; /** * The name of the store */ name: string; /** * Account Identifier */ account_id?: string; } /** * Result is null for delete operations. */ export type StoreDeleteResponse = unknown; export interface StoreGetResponse { /** * Store Identifier */ id: string; /** * Whenthe secret was created. */ created: string; /** * When the secret was modified. */ modified: string; /** * The name of the store */ name: string; /** * Account Identifier */ account_id?: string; } export interface StoreCreateParams { /** * Path param: Account Identifier */ account_id: string; /** * Body param: The name of the store */ name: string; } export interface StoreListParams extends V4PagePaginationArrayParams { /** * Path param: Account Identifier */ account_id: string; /** * Query param: Direction to sort objects */ direction?: 'asc' | 'desc'; /** * Query param: Order secrets by values in the given field */ order?: 'name' | 'comment' | 'created' | 'modified' | 'status'; } export interface StoreDeleteParams { /** * Path param: Account Identifier */ account_id: string; /** * Query param: When true, cascade-deletes all secrets in the store before deleting * the store itself. Required when deleting a non-empty store. Without this * parameter, attempting to delete a non-empty store returns 409. */ force?: boolean; } export interface StoreGetParams { /** * Account Identifier */ account_id: string; } Stores.StoreListResponsesV4PagePaginationArray = StoreListResponsesV4PagePaginationArray; Stores.Secrets = Secrets; Stores.SecretCreateResponsesSinglePage = SecretCreateResponsesSinglePage; Stores.SecretListResponsesV4PagePaginationArray = SecretListResponsesV4PagePaginationArray; export declare namespace Stores { export { type StoreCreateResponse as StoreCreateResponse, type StoreListResponse as StoreListResponse, type StoreDeleteResponse as StoreDeleteResponse, type StoreGetResponse as StoreGetResponse, StoreListResponsesV4PagePaginationArray as StoreListResponsesV4PagePaginationArray, type StoreCreateParams as StoreCreateParams, type StoreListParams as StoreListParams, type StoreDeleteParams as StoreDeleteParams, type StoreGetParams as StoreGetParams, }; export { Secrets as Secrets, type SecretCreateResponse as SecretCreateResponse, type SecretListResponse as SecretListResponse, type SecretDeleteResponse as SecretDeleteResponse, type SecretBulkDeleteResponse as SecretBulkDeleteResponse, type SecretDuplicateResponse as SecretDuplicateResponse, type SecretEditResponse as SecretEditResponse, type SecretGetResponse as SecretGetResponse, SecretCreateResponsesSinglePage as SecretCreateResponsesSinglePage, SecretListResponsesV4PagePaginationArray as SecretListResponsesV4PagePaginationArray, type SecretCreateParams as SecretCreateParams, type SecretListParams as SecretListParams, type SecretDeleteParams as SecretDeleteParams, type SecretBulkDeleteParams as SecretBulkDeleteParams, type SecretDuplicateParams as SecretDuplicateParams, type SecretEditParams as SecretEditParams, type SecretGetParams as SecretGetParams, }; }