@augustusbank/typescript-sdk 0.20.0 → 0.22.0

package/resources/scopes.d.ts

@@ -19,7 +19,7 @@ export declare namespace ScopeListResponse {
         /**
          * Scope identifier in `resource:action` format.
          */
-        id: 'payouts:read' | 'payouts:write' | 'deposits:read' | 'returns:read' | 'returns:write' | 'conversions:read' | 'conversions:write' | 'quotes:read' | 'accounts:read' | 'accounts:write' | 'account_programs:read' | 'account_holders:read' | 'account_holders:write' | 'webhook_subscriptions:read' | 'webhook_subscriptions:write' | 'events:read' | 'webhook_deliveries:read' | 'webhook_deliveries:write' | 'transactions:read';
+        id: 'payouts:read' | 'payouts:write' | 'deposits:read' | 'returns:read' | 'returns:write' | 'conversions:read' | 'conversions:write' | 'quotes:read' | 'accounts:read' | 'accounts:write' | 'account_programs:read' | 'account_holders:read' | 'account_holders:write' | 'counterparties:read' | 'counterparties:write' | 'webhook_subscriptions:read' | 'webhook_subscriptions:write' | 'events:read' | 'webhook_deliveries:read' | 'webhook_deliveries:write' | 'transactions:read' | 'simulations:write';
         /**
          * Action category.
          */
@@ -40,6 +40,9 @@ export declare namespace ScopeListResponse {
          * Resource the scope applies to.
          */
         resource: string;
+        /**
+         * Resource type discriminator.
+         */
         type: 'scope';
     }
 }

package/resources/scopes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scopes.d.ts","sourceRoot":"","sources":["../src/resources/scopes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAG9D;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EACE,cAAc,GACd,eAAe,GACf,eAAe,GACf,cAAc,GACd,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,aAAa,GACb,eAAe,GACf,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,uBAAuB,GACvB,4BAA4B,GAC5B,6BAA6B,GAC7B,aAAa,GACb,yBAAyB,GACzB,0BAA0B,GAC1B,mBAAmB,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAEzB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB,IAAI,EAAE,OAAO,CAAC;KACf;CACF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACxD"}
+{"version":3,"file":"scopes.d.ts","sourceRoot":"","sources":["../src/resources/scopes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAG9D;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EACE,cAAc,GACd,eAAe,GACf,eAAe,GACf,cAAc,GACd,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,aAAa,GACb,eAAe,GACf,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,uBAAuB,GACvB,qBAAqB,GACrB,sBAAsB,GACtB,4BAA4B,GAC5B,6BAA6B,GAC7B,aAAa,GACb,yBAAyB,GACzB,0BAA0B,GAC1B,mBAAmB,GACnB,mBAAmB,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAEzB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;KACf;CACF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACxD"}

package/resources/simulations/account-programs.d.mts

@@ -0,0 +1,281 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class AccountPrograms extends APIResource {
+    /**
+     * Creates a Mock-US USD account program owned by the caller merchant. This
+     * endpoint is unavailable in live production.
+     *
+     * @example
+     * ```ts
+     * const accountProgram =
+     *   await client.simulations.accountPrograms.create({
+     *     label: 'x',
+     *     type: 'fbo-program',
+     *   });
+     * ```
+     */
+    create(body: AccountProgramCreateParams, options?: RequestOptions): APIPromise<AccountProgramCreateResponse>;
+    /**
+     * Closes an account program. All child accounts must be drained via the drain
+     * endpoint first. This endpoint is unavailable in live production.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.simulations.accountPrograms.close(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     { reason: 'aml_risk_fraud' },
+     *   );
+     * ```
+     */
+    close(id: string, body: AccountProgramCloseParams, options?: RequestOptions): APIPromise<AccountProgramCloseResponse>;
+    /**
+     * Creates outbound payouts that drain the residual balance of every frozen account
+     * under the program to the provided destination. The program must be frozen. Every
+     * returned `payout_ids[i]` must be settled via
+     * `POST /v1/simulations/payouts/{id}/send` for the program balance to reach zero.
+     * This endpoint is unavailable in live production.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.simulations.accountPrograms.drain(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     {
+     *       destination: {
+     *         account_holder_name: 'Acme Sandbox Ltd.',
+     *         bic: 'COBADEFFXXX',
+     *         iban: 'DE89370400440532013000',
+     *         type: 'iban',
+     *       },
+     *     },
+     *   );
+     * ```
+     */
+    drain(id: string, body: AccountProgramDrainParams, options?: RequestOptions): APIPromise<AccountProgramDrainResponse>;
+    /**
+     * Freezes an existing account program and its virtual accounts. This endpoint is
+     * unavailable in live production.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.simulations.accountPrograms.freeze(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    freeze(id: string, options?: RequestOptions): APIPromise<AccountProgramFreezeResponse>;
+    /**
+     * Unfreezes an existing account program and its virtual accounts. This endpoint is
+     * unavailable in live production.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.simulations.accountPrograms.unfreeze(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    unfreeze(id: string, options?: RequestOptions): APIPromise<AccountProgramUnfreezeResponse>;
+}
+export interface AccountProgramCreateResponse {
+    /**
+     * Account program whose lifecycle is being simulated.
+     */
+    account_program_id: string;
+    /**
+     * Account program lifecycle event submitted to the sandbox.
+     */
+    event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
+    /**
+     * Payouts created by a drain event. Feed each id to
+     * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
+     */
+    payout_ids: Array<string> | null;
+    /**
+     * Whether the simulation submission was successful.
+     */
+    success: boolean;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'account_program_simulation';
+}
+export interface AccountProgramCloseResponse {
+    /**
+     * Account program whose lifecycle is being simulated.
+     */
+    account_program_id: string;
+    /**
+     * Account program lifecycle event submitted to the sandbox.
+     */
+    event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
+    /**
+     * Payouts created by a drain event. Feed each id to
+     * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
+     */
+    payout_ids: Array<string> | null;
+    /**
+     * Whether the simulation submission was successful.
+     */
+    success: boolean;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'account_program_simulation';
+}
+export interface AccountProgramDrainResponse {
+    /**
+     * Account program whose lifecycle is being simulated.
+     */
+    account_program_id: string;
+    /**
+     * Account program lifecycle event submitted to the sandbox.
+     */
+    event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
+    /**
+     * Payouts created by a drain event. Feed each id to
+     * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
+     */
+    payout_ids: Array<string> | null;
+    /**
+     * Whether the simulation submission was successful.
+     */
+    success: boolean;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'account_program_simulation';
+}
+export interface AccountProgramFreezeResponse {
+    /**
+     * Account program whose lifecycle is being simulated.
+     */
+    account_program_id: string;
+    /**
+     * Account program lifecycle event submitted to the sandbox.
+     */
+    event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
+    /**
+     * Payouts created by a drain event. Feed each id to
+     * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
+     */
+    payout_ids: Array<string> | null;
+    /**
+     * Whether the simulation submission was successful.
+     */
+    success: boolean;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'account_program_simulation';
+}
+export interface AccountProgramUnfreezeResponse {
+    /**
+     * Account program whose lifecycle is being simulated.
+     */
+    account_program_id: string;
+    /**
+     * Account program lifecycle event submitted to the sandbox.
+     */
+    event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
+    /**
+     * Payouts created by a drain event. Feed each id to
+     * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
+     */
+    payout_ids: Array<string> | null;
+    /**
+     * Whether the simulation submission was successful.
+     */
+    success: boolean;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'account_program_simulation';
+}
+export interface AccountProgramCreateParams {
+    /**
+     * Human-readable label for the account program.
+     */
+    label: string;
+    /**
+     * Account program type.
+     */
+    type: 'fbo-program' | 'fbo-sponsored';
+}
+export interface AccountProgramCloseParams {
+    /**
+     * Reason for closing the account program.
+     */
+    reason: 'aml_risk_fraud' | 'client_request';
+}
+export interface AccountProgramDrainParams {
+    /**
+     * Fiat financial address to which the residual balance of every frozen account
+     * under the program is drained.
+     */
+    destination: AccountProgramDrainParams.IbanFinancialAddress | AccountProgramDrainParams.SortCodeFinancialAddress | AccountProgramDrainParams.AbaFinancialAddress;
+}
+export declare namespace AccountProgramDrainParams {
+    interface IbanFinancialAddress {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * Bank Identifier Code, or null if not provided.
+         */
+        bic: string | null;
+        /**
+         * International Bank Account Number.
+         */
+        iban: string;
+        /**
+         * Discriminator for IBAN financial address.
+         */
+        type: 'iban';
+    }
+    interface SortCodeFinancialAddress {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * UK account number (8 digits).
+         */
+        account_number: string;
+        /**
+         * UK sort code (6 digits).
+         */
+        sort_code: string;
+        /**
+         * Discriminator for UK sort code financial address.
+         */
+        type: 'sort_code';
+    }
+    interface AbaFinancialAddress {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * Bank account number.
+         */
+        account_number: string;
+        /**
+         * ABA routing number (9 digits).
+         */
+        routing_number: string;
+        /**
+         * Discriminator for ABA wire financial address.
+         */
+        type: 'aba';
+    }
+}
+export declare namespace AccountPrograms {
+    export { type AccountProgramCreateResponse as AccountProgramCreateResponse, type AccountProgramCloseResponse as AccountProgramCloseResponse, type AccountProgramDrainResponse as AccountProgramDrainResponse, type AccountProgramFreezeResponse as AccountProgramFreezeResponse, type AccountProgramUnfreezeResponse as AccountProgramUnfreezeResponse, type AccountProgramCreateParams as AccountProgramCreateParams, type AccountProgramCloseParams as AccountProgramCloseParams, type AccountProgramDrainParams as AccountProgramDrainParams, };
+}
+//# sourceMappingURL=account-programs.d.mts.map

package/resources/simulations/account-programs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-programs.d.mts","sourceRoot":"","sources":["../../src/resources/simulations/account-programs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;OAYG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAItF;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;CAG3F;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;IAE5D;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;IAE5D;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;IAE5D;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;IAE5D;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;IAE5D;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,aAAa,GAAG,eAAe,CAAC;CACvC;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,MAAM,EAAE,gBAAgB,GAAG,gBAAgB,CAAC;CAC7C;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,WAAW,EACP,yBAAyB,CAAC,oBAAoB,GAC9C,yBAAyB,CAAC,wBAAwB,GAClD,yBAAyB,CAAC,mBAAmB,CAAC;CACnD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,oBAAoB;QACnC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,wBAAwB;QACvC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,WAAW,CAAC;KACnB;IAED,UAAiB,mBAAmB;QAClC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC;KACb;CACF;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/simulations/account-programs.d.ts

@@ -0,0 +1,281 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class AccountPrograms extends APIResource {
+    /**
+     * Creates a Mock-US USD account program owned by the caller merchant. This
+     * endpoint is unavailable in live production.
+     *
+     * @example
+     * ```ts
+     * const accountProgram =
+     *   await client.simulations.accountPrograms.create({
+     *     label: 'x',
+     *     type: 'fbo-program',
+     *   });
+     * ```
+     */
+    create(body: AccountProgramCreateParams, options?: RequestOptions): APIPromise<AccountProgramCreateResponse>;
+    /**
+     * Closes an account program. All child accounts must be drained via the drain
+     * endpoint first. This endpoint is unavailable in live production.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.simulations.accountPrograms.close(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     { reason: 'aml_risk_fraud' },
+     *   );
+     * ```
+     */
+    close(id: string, body: AccountProgramCloseParams, options?: RequestOptions): APIPromise<AccountProgramCloseResponse>;
+    /**
+     * Creates outbound payouts that drain the residual balance of every frozen account
+     * under the program to the provided destination. The program must be frozen. Every
+     * returned `payout_ids[i]` must be settled via
+     * `POST /v1/simulations/payouts/{id}/send` for the program balance to reach zero.
+     * This endpoint is unavailable in live production.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.simulations.accountPrograms.drain(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *     {
+     *       destination: {
+     *         account_holder_name: 'Acme Sandbox Ltd.',
+     *         bic: 'COBADEFFXXX',
+     *         iban: 'DE89370400440532013000',
+     *         type: 'iban',
+     *       },
+     *     },
+     *   );
+     * ```
+     */
+    drain(id: string, body: AccountProgramDrainParams, options?: RequestOptions): APIPromise<AccountProgramDrainResponse>;
+    /**
+     * Freezes an existing account program and its virtual accounts. This endpoint is
+     * unavailable in live production.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.simulations.accountPrograms.freeze(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    freeze(id: string, options?: RequestOptions): APIPromise<AccountProgramFreezeResponse>;
+    /**
+     * Unfreezes an existing account program and its virtual accounts. This endpoint is
+     * unavailable in live production.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.simulations.accountPrograms.unfreeze(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    unfreeze(id: string, options?: RequestOptions): APIPromise<AccountProgramUnfreezeResponse>;
+}
+export interface AccountProgramCreateResponse {
+    /**
+     * Account program whose lifecycle is being simulated.
+     */
+    account_program_id: string;
+    /**
+     * Account program lifecycle event submitted to the sandbox.
+     */
+    event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
+    /**
+     * Payouts created by a drain event. Feed each id to
+     * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
+     */
+    payout_ids: Array<string> | null;
+    /**
+     * Whether the simulation submission was successful.
+     */
+    success: boolean;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'account_program_simulation';
+}
+export interface AccountProgramCloseResponse {
+    /**
+     * Account program whose lifecycle is being simulated.
+     */
+    account_program_id: string;
+    /**
+     * Account program lifecycle event submitted to the sandbox.
+     */
+    event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
+    /**
+     * Payouts created by a drain event. Feed each id to
+     * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
+     */
+    payout_ids: Array<string> | null;
+    /**
+     * Whether the simulation submission was successful.
+     */
+    success: boolean;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'account_program_simulation';
+}
+export interface AccountProgramDrainResponse {
+    /**
+     * Account program whose lifecycle is being simulated.
+     */
+    account_program_id: string;
+    /**
+     * Account program lifecycle event submitted to the sandbox.
+     */
+    event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
+    /**
+     * Payouts created by a drain event. Feed each id to
+     * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
+     */
+    payout_ids: Array<string> | null;
+    /**
+     * Whether the simulation submission was successful.
+     */
+    success: boolean;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'account_program_simulation';
+}
+export interface AccountProgramFreezeResponse {
+    /**
+     * Account program whose lifecycle is being simulated.
+     */
+    account_program_id: string;
+    /**
+     * Account program lifecycle event submitted to the sandbox.
+     */
+    event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
+    /**
+     * Payouts created by a drain event. Feed each id to
+     * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
+     */
+    payout_ids: Array<string> | null;
+    /**
+     * Whether the simulation submission was successful.
+     */
+    success: boolean;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'account_program_simulation';
+}
+export interface AccountProgramUnfreezeResponse {
+    /**
+     * Account program whose lifecycle is being simulated.
+     */
+    account_program_id: string;
+    /**
+     * Account program lifecycle event submitted to the sandbox.
+     */
+    event: 'create' | 'freeze' | 'unfreeze' | 'close' | 'drain';
+    /**
+     * Payouts created by a drain event. Feed each id to
+     * `POST /v1/simulations/payouts/{id}/send` to settle. `null` for non-drain events.
+     */
+    payout_ids: Array<string> | null;
+    /**
+     * Whether the simulation submission was successful.
+     */
+    success: boolean;
+    /**
+     * Resource type discriminator.
+     */
+    type: 'account_program_simulation';
+}
+export interface AccountProgramCreateParams {
+    /**
+     * Human-readable label for the account program.
+     */
+    label: string;
+    /**
+     * Account program type.
+     */
+    type: 'fbo-program' | 'fbo-sponsored';
+}
+export interface AccountProgramCloseParams {
+    /**
+     * Reason for closing the account program.
+     */
+    reason: 'aml_risk_fraud' | 'client_request';
+}
+export interface AccountProgramDrainParams {
+    /**
+     * Fiat financial address to which the residual balance of every frozen account
+     * under the program is drained.
+     */
+    destination: AccountProgramDrainParams.IbanFinancialAddress | AccountProgramDrainParams.SortCodeFinancialAddress | AccountProgramDrainParams.AbaFinancialAddress;
+}
+export declare namespace AccountProgramDrainParams {
+    interface IbanFinancialAddress {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * Bank Identifier Code, or null if not provided.
+         */
+        bic: string | null;
+        /**
+         * International Bank Account Number.
+         */
+        iban: string;
+        /**
+         * Discriminator for IBAN financial address.
+         */
+        type: 'iban';
+    }
+    interface SortCodeFinancialAddress {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * UK account number (8 digits).
+         */
+        account_number: string;
+        /**
+         * UK sort code (6 digits).
+         */
+        sort_code: string;
+        /**
+         * Discriminator for UK sort code financial address.
+         */
+        type: 'sort_code';
+    }
+    interface AbaFinancialAddress {
+        /**
+         * Name of the account holder.
+         */
+        account_holder_name: string;
+        /**
+         * Bank account number.
+         */
+        account_number: string;
+        /**
+         * ABA routing number (9 digits).
+         */
+        routing_number: string;
+        /**
+         * Discriminator for ABA wire financial address.
+         */
+        type: 'aba';
+    }
+}
+export declare namespace AccountPrograms {
+    export { type AccountProgramCreateResponse as AccountProgramCreateResponse, type AccountProgramCloseResponse as AccountProgramCloseResponse, type AccountProgramDrainResponse as AccountProgramDrainResponse, type AccountProgramFreezeResponse as AccountProgramFreezeResponse, type AccountProgramUnfreezeResponse as AccountProgramUnfreezeResponse, type AccountProgramCreateParams as AccountProgramCreateParams, type AccountProgramCloseParams as AccountProgramCloseParams, type AccountProgramDrainParams as AccountProgramDrainParams, };
+}
+//# sourceMappingURL=account-programs.d.ts.map

package/resources/simulations/account-programs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-programs.d.ts","sourceRoot":"","sources":["../../src/resources/simulations/account-programs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;OAYG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAItF;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;CAG3F;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;IAE5D;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;IAE5D;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;IAE5D;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;IAE5D;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;IAE5D;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,aAAa,GAAG,eAAe,CAAC;CACvC;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,MAAM,EAAE,gBAAgB,GAAG,gBAAgB,CAAC;CAC7C;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,WAAW,EACP,yBAAyB,CAAC,oBAAoB,GAC9C,yBAAyB,CAAC,wBAAwB,GAClD,yBAAyB,CAAC,mBAAmB,CAAC;CACnD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,oBAAoB;QACnC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,wBAAwB;QACvC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,WAAW,CAAC;KACnB;IAED,UAAiB,mBAAmB;QAClC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC;KACb;CACF;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}