increase 0.468.0 → 0.470.0

package/resources/simulations/card-tokens.d.ts

@@ -27,6 +27,10 @@ export interface CardTokenCreateParams {
      * The last 4 digits of the card number.
      */
     last4?: string;
+    /**
+     * The outcome to simulate for card push transfers using this token.
+     */
+    outcome?: CardTokenCreateParams.Outcome;
     /**
      * The prefix of the card number, usually the first 8 digits.
      */
@@ -60,6 +64,107 @@ export declare namespace CardTokenCreateParams {
          */
         route: 'visa' | 'mastercard';
     }
+    /**
+     * The outcome to simulate for card push transfers using this token.
+     */
+    interface Outcome {
+        /**
+         * Whether card push transfers or validations will be approved or declined.
+         *
+         * - `approve` - Any card push transfers or validations will be approved.
+         * - `decline` - Any card push transfers or validations will be declined.
+         */
+        result: 'approve' | 'decline';
+        /**
+         * If the result is declined, the details of the decline.
+         */
+        decline?: Outcome.Decline;
+    }
+    namespace Outcome {
+        /**
+         * If the result is declined, the details of the decline.
+         */
+        interface Decline {
+            /**
+             * The reason for the decline.
+             *
+             * - `do_not_honor` - The card issuer has declined the transaction without
+             *   providing a specific reason.
+             * - `activity_count_limit_exceeded` - The number of transactions for the card has
+             *   exceeded the limit set by the issuer.
+             * - `refer_to_card_issuer` - The card issuer requires the cardholder to contact
+             *   them for further information regarding the transaction.
+             * - `refer_to_card_issuer_special_condition` - The card issuer requires the
+             *   cardholder to contact them due to a special condition related to the
+             *   transaction.
+             * - `invalid_merchant` - The merchant is not valid for this transaction.
+             * - `pick_up_card` - The card should be retained by the terminal.
+             * - `error` - An error occurred during processing of the transaction.
+             * - `pick_up_card_special` - The card should be retained by the terminal due to a
+             *   special condition.
+             * - `invalid_transaction` - The transaction is invalid and cannot be processed.
+             * - `invalid_amount` - The amount of the transaction is invalid.
+             * - `invalid_account_number` - The account number provided is invalid.
+             * - `no_such_issuer` - The issuer of the card could not be found.
+             * - `re_enter_transaction` - The transaction should be re-entered for processing.
+             * - `no_credit_account` - There is no credit account associated with the card.
+             * - `pick_up_card_lost` - The card should be retained by the terminal because it
+             *   has been reported lost.
+             * - `pick_up_card_stolen` - The card should be retained by the terminal because it
+             *   has been reported stolen.
+             * - `closed_account` - The account associated with the card has been closed.
+             * - `insufficient_funds` - There are insufficient funds in the account to complete
+             *   the transaction.
+             * - `no_checking_account` - There is no checking account associated with the card.
+             * - `no_savings_account` - There is no savings account associated with the card.
+             * - `expired_card` - The card has expired and cannot be used for transactions.
+             * - `transaction_not_permitted_to_cardholder` - The transaction is not permitted
+             *   for this cardholder.
+             * - `transaction_not_allowed_at_terminal` - The transaction is not allowed at this
+             *   terminal.
+             * - `suspected_fraud` - The transaction has been flagged as suspected fraud and
+             *   cannot be processed.
+             * - `activity_amount_limit_exceeded` - The amount of activity on the card has
+             *   exceeded the limit set by the issuer.
+             * - `restricted_card` - The card has restrictions that prevent it from being used
+             *   for this transaction.
+             * - `security_violation` - A security violation has occurred, preventing the
+             *   transaction from being processed.
+             * - `transaction_does_not_fulfill_anti_money_laundering_requirement` - The
+             *   transaction does not meet the anti-money laundering requirements set by the
+             *   issuer.
+             * - `blocked_first_use` - The first use of the card has been blocked by the
+             *   issuer.
+             * - `credit_issuer_unavailable` - The credit issuer is currently unavailable to
+             *   process the transaction.
+             * - `negative_card_verification_value_results` - The card verification value (CVV)
+             *   results were negative, indicating a potential issue with the card.
+             * - `issuer_unavailable` - The issuer of the card is currently unavailable to
+             *   process the transaction.
+             * - `financial_institution_cannot_be_found` - The financial institution associated
+             *   with the card could not be found.
+             * - `transaction_cannot_be_completed` - The transaction cannot be completed due to
+             *   an unspecified reason.
+             * - `duplicate_transaction` - The transaction is a duplicate of a previous
+             *   transaction and cannot be processed again.
+             * - `system_malfunction` - A system malfunction occurred, preventing the
+             *   transaction from being processed.
+             * - `additional_customer_authentication_required` - Additional customer
+             *   authentication is required to complete the transaction.
+             * - `surcharge_amount_not_permitted` - The surcharge amount applied to the
+             *   transaction is not permitted by the issuer.
+             * - `decline_for_cvv2_failure` - The transaction was declined due to a failure in
+             *   verifying the CVV2 code.
+             * - `stop_payment_order` - A stop payment order has been placed on this
+             *   transaction.
+             * - `revocation_of_authorization_order` - An order has been placed to revoke
+             *   authorization for this transaction.
+             * - `revocation_of_all_authorizations_order` - An order has been placed to revoke
+             *   all authorizations for this cardholder.
+             */
+            reason?: 'do_not_honor' | 'activity_count_limit_exceeded' | 'refer_to_card_issuer' | 'refer_to_card_issuer_special_condition' | 'invalid_merchant' | 'pick_up_card' | 'error' | 'pick_up_card_special' | 'invalid_transaction' | 'invalid_amount' | 'invalid_account_number' | 'no_such_issuer' | 're_enter_transaction' | 'no_credit_account' | 'pick_up_card_lost' | 'pick_up_card_stolen' | 'closed_account' | 'insufficient_funds' | 'no_checking_account' | 'no_savings_account' | 'expired_card' | 'transaction_not_permitted_to_cardholder' | 'transaction_not_allowed_at_terminal' | 'suspected_fraud' | 'activity_amount_limit_exceeded' | 'restricted_card' | 'security_violation' | 'transaction_does_not_fulfill_anti_money_laundering_requirement' | 'blocked_first_use' | 'credit_issuer_unavailable' | 'negative_card_verification_value_results' | 'issuer_unavailable' | 'financial_institution_cannot_be_found' | 'transaction_cannot_be_completed' | 'duplicate_transaction' | 'system_malfunction' | 'additional_customer_authentication_required' | 'surcharge_amount_not_permitted' | 'decline_for_cvv2_failure' | 'stop_payment_order' | 'revocation_of_authorization_order' | 'revocation_of_all_authorizations_order';
+        }
+    }
 }
 export declare namespace CardTokens {
     export { type CardTokenCreateParams as CardTokenCreateParams };

package/resources/simulations/card-tokens.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"card-tokens.d.ts","sourceRoot":"","sources":["../../src/resources/simulations/card-tokens.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;CAGnG;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAEvD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;CACxC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,UAAU;QACzB;;;;;WAKG;QACH,2BAA2B,EAAE,WAAW,GAAG,eAAe,CAAC;QAE3D;;;;;WAKG;QACH,uBAAuB,EAAE,WAAW,GAAG,eAAe,CAAC;QAEvD;;;;;WAKG;QACH,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;KAC9B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;CAChE"}
+{"version":3,"file":"card-tokens.d.ts","sourceRoot":"","sources":["../../src/resources/simulations/card-tokens.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;CAGnG;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAEvD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;CACxC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,UAAU;QACzB;;;;;WAKG;QACH,2BAA2B,EAAE,WAAW,GAAG,eAAe,CAAC;QAE3D;;;;;WAKG;QACH,uBAAuB,EAAE,WAAW,GAAG,eAAe,CAAC;QAEvD;;;;;WAKG;QACH,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;KAC9B;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;;;;WAKG;QACH,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;QAE9B;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;KAC3B;IAED,UAAiB,OAAO,CAAC;QACvB;;WAEG;QACH,UAAiB,OAAO;YACtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eA4EG;YACH,MAAM,CAAC,EACH,cAAc,GACd,+BAA+B,GAC/B,sBAAsB,GACtB,wCAAwC,GACxC,kBAAkB,GAClB,cAAc,GACd,OAAO,GACP,sBAAsB,GACtB,qBAAqB,GACrB,gBAAgB,GAChB,wBAAwB,GACxB,gBAAgB,GAChB,sBAAsB,GACtB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,gBAAgB,GAChB,oBAAoB,GACpB,qBAAqB,GACrB,oBAAoB,GACpB,cAAc,GACd,yCAAyC,GACzC,qCAAqC,GACrC,iBAAiB,GACjB,gCAAgC,GAChC,iBAAiB,GACjB,oBAAoB,GACpB,gEAAgE,GAChE,mBAAmB,GACnB,2BAA2B,GAC3B,0CAA0C,GAC1C,oBAAoB,GACpB,uCAAuC,GACvC,iCAAiC,GACjC,uBAAuB,GACvB,oBAAoB,GACpB,6CAA6C,GAC7C,gCAAgC,GAChC,0BAA0B,GAC1B,oBAAoB,GACpB,mCAAmC,GACnC,wCAAwC,CAAC;SAC9C;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;CAChE"}

package/src/client.ts

@@ -64,6 +64,12 @@ import {
   ACHTransfers,
   ACHTransfersPage,
 } from './resources/ach-transfers';
+import {
+  BeneficialOwnerListParams,
+  BeneficialOwners,
+  EntityBeneficialOwner,
+  EntityBeneficialOwnersPage,
+} from './resources/beneficial-owners';
 import {
   BookkeepingAccount,
   BookkeepingAccountBalanceParams,
@@ -1178,6 +1184,7 @@ export class Increase {
   routingNumbers: API.RoutingNumbers = new API.RoutingNumbers(this);
   externalAccounts: API.ExternalAccounts = new API.ExternalAccounts(this);
   entities: API.Entities = new API.Entities(this);
+  beneficialOwners: API.BeneficialOwners = new API.BeneficialOwners(this);
   supplementalDocuments: API.SupplementalDocuments = new API.SupplementalDocuments(this);
   programs: API.Programs = new API.Programs(this);
   accountStatements: API.AccountStatements = new API.AccountStatements(this);
@@ -1237,6 +1244,7 @@ Increase.InboundMailItems = InboundMailItems;
 Increase.RoutingNumbers = RoutingNumbers;
 Increase.ExternalAccounts = ExternalAccounts;
 Increase.Entities = Entities;
+Increase.BeneficialOwners = BeneficialOwners;
 Increase.SupplementalDocuments = SupplementalDocuments;
 Increase.Programs = Programs;
 Increase.AccountStatements = AccountStatements;
@@ -1553,6 +1561,13 @@ export declare namespace Increase {
     type EntityUpdateBeneficialOwnerAddressParams as EntityUpdateBeneficialOwnerAddressParams,
   };
 
+  export {
+    BeneficialOwners as BeneficialOwners,
+    type EntityBeneficialOwner as EntityBeneficialOwner,
+    type EntityBeneficialOwnersPage as EntityBeneficialOwnersPage,
+    type BeneficialOwnerListParams as BeneficialOwnerListParams,
+  };
+
   export {
     SupplementalDocuments as SupplementalDocuments,
     type EntitySupplementalDocument as EntitySupplementalDocument,

package/src/resources/beneficial-owners.ts

@@ -0,0 +1,204 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { Page, type PageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class BeneficialOwners extends APIResource {
+  /**
+   * Retrieve a Beneficial Owner
+   *
+   * @example
+   * ```ts
+   * const entityBeneficialOwner =
+   *   await client.beneficialOwners.retrieve(
+   *     'entity_setup_beneficial_owner_submission_vgkyk7dj5eb4sfhdbkx7',
+   *   );
+   * ```
+   */
+  retrieve(entityBeneficialOwnerID: string, options?: RequestOptions): APIPromise<EntityBeneficialOwner> {
+    return this._client.get(path`/entity_beneficial_owners/${entityBeneficialOwnerID}`, options);
+  }
+
+  /**
+   * List Beneficial Owners
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const entityBeneficialOwner of client.beneficialOwners.list(
+   *   { entity_id: 'entity_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: BeneficialOwnerListParams,
+    options?: RequestOptions,
+  ): PagePromise<EntityBeneficialOwnersPage, EntityBeneficialOwner> {
+    return this._client.getAPIList('/entity_beneficial_owners', Page<EntityBeneficialOwner>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type EntityBeneficialOwnersPage = Page<EntityBeneficialOwner>;
+
+export interface EntityBeneficialOwner {
+  /**
+   * The identifier of this beneficial owner.
+   */
+  id: string;
+
+  /**
+   * This person's role or title within the entity.
+   */
+  company_title: string | null;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
+   * Beneficial Owner was created.
+   */
+  created_at: string;
+
+  /**
+   * Personal details for the beneficial owner.
+   */
+  individual: EntityBeneficialOwner.Individual;
+
+  /**
+   * Why this person is considered a beneficial owner of the entity.
+   */
+  prongs: Array<'ownership' | 'control'>;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `entity_beneficial_owner`.
+   */
+  type: 'entity_beneficial_owner';
+
+  [k: string]: unknown;
+}
+
+export namespace EntityBeneficialOwner {
+  /**
+   * Personal details for the beneficial owner.
+   */
+  export interface Individual {
+    /**
+     * The person's address.
+     */
+    address: Individual.Address;
+
+    /**
+     * The person's date of birth in YYYY-MM-DD format.
+     */
+    date_of_birth: string;
+
+    /**
+     * A means of verifying the person's identity.
+     */
+    identification: Individual.Identification;
+
+    /**
+     * The person's legal name.
+     */
+    name: string;
+  }
+
+  export namespace Individual {
+    /**
+     * The person's address.
+     */
+    export interface Address {
+      /**
+       * The city, district, town, or village of the address.
+       */
+      city: string | null;
+
+      /**
+       * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+       */
+      country: string;
+
+      /**
+       * The first line of the address.
+       */
+      line1: string;
+
+      /**
+       * The second line of the address.
+       */
+      line2: string | null;
+
+      /**
+       * The two-letter United States Postal Service (USPS) abbreviation for the US
+       * state, province, or region of the address.
+       */
+      state: string | null;
+
+      /**
+       * The ZIP or postal code of the address.
+       */
+      zip: string | null;
+    }
+
+    /**
+     * A means of verifying the person's identity.
+     */
+    export interface Identification {
+      /**
+       * A method that can be used to verify the individual's identity.
+       *
+       * - `social_security_number` - A social security number.
+       * - `individual_taxpayer_identification_number` - An individual taxpayer
+       *   identification number (ITIN).
+       * - `passport` - A passport number.
+       * - `drivers_license` - A driver's license number.
+       * - `other` - Another identifying document.
+       */
+      method:
+        | 'social_security_number'
+        | 'individual_taxpayer_identification_number'
+        | 'passport'
+        | 'drivers_license'
+        | 'other';
+
+      /**
+       * The last 4 digits of the identification number that can be used to verify the
+       * individual's identity.
+       */
+      number_last4: string;
+
+      [k: string]: unknown;
+    }
+  }
+}
+
+export interface BeneficialOwnerListParams extends PageParams {
+  /**
+   * The identifier of the Entity to list beneficial owners for. Only `corporation`
+   * entities have beneficial owners.
+   */
+  entity_id: string;
+
+  /**
+   * Filter records to the one with the specified `idempotency_key` you chose for
+   * that object. This value is unique across Increase and is used to ensure that a
+   * request is only processed once. Learn more about
+   * [idempotency](https://increase.com/documentation/idempotency-keys).
+   */
+  idempotency_key?: string;
+}
+
+export declare namespace BeneficialOwners {
+  export {
+    type EntityBeneficialOwner as EntityBeneficialOwner,
+    type EntityBeneficialOwnersPage as EntityBeneficialOwnersPage,
+    type BeneficialOwnerListParams as BeneficialOwnerListParams,
+  };
+}

package/src/resources/entities.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as BeneficialOwnersAPI from './beneficial-owners';
 import * as SupplementalDocumentsAPI from './supplemental-documents';
 import { APIPromise } from '../core/api-promise';
 import { Page, type PageParams, PagePromise } from '../core/pagination';
@@ -308,7 +309,7 @@ export namespace Entity {
      * The identifying details of anyone controlling or owning 25% or more of the
      * corporation.
      */
-    beneficial_owners: Array<Corporation.BeneficialOwner>;
+    beneficial_owners: Array<BeneficialOwnersAPI.EntityBeneficialOwner>;
 
     /**
      * An email address for the business.
@@ -374,125 +375,6 @@ export namespace Entity {
        */
       zip: string;
     }
-
-    export interface BeneficialOwner {
-      /**
-       * The identifier of this beneficial owner.
-       */
-      id: string;
-
-      /**
-       * This person's role or title within the entity.
-       */
-      company_title: string | null;
-
-      /**
-       * Personal details for the beneficial owner.
-       */
-      individual: BeneficialOwner.Individual;
-
-      /**
-       * Why this person is considered a beneficial owner of the entity.
-       */
-      prongs: Array<'ownership' | 'control'>;
-
-      [k: string]: unknown;
-    }
-
-    export namespace BeneficialOwner {
-      /**
-       * Personal details for the beneficial owner.
-       */
-      export interface Individual {
-        /**
-         * The person's address.
-         */
-        address: Individual.Address;
-
-        /**
-         * The person's date of birth in YYYY-MM-DD format.
-         */
-        date_of_birth: string;
-
-        /**
-         * A means of verifying the person's identity.
-         */
-        identification: Individual.Identification;
-
-        /**
-         * The person's legal name.
-         */
-        name: string;
-      }
-
-      export namespace Individual {
-        /**
-         * The person's address.
-         */
-        export interface Address {
-          /**
-           * The city, district, town, or village of the address.
-           */
-          city: string | null;
-
-          /**
-           * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-           */
-          country: string;
-
-          /**
-           * The first line of the address.
-           */
-          line1: string;
-
-          /**
-           * The second line of the address.
-           */
-          line2: string | null;
-
-          /**
-           * The two-letter United States Postal Service (USPS) abbreviation for the US
-           * state, province, or region of the address.
-           */
-          state: string | null;
-
-          /**
-           * The ZIP or postal code of the address.
-           */
-          zip: string | null;
-        }
-
-        /**
-         * A means of verifying the person's identity.
-         */
-        export interface Identification {
-          /**
-           * A method that can be used to verify the individual's identity.
-           *
-           * - `social_security_number` - A social security number.
-           * - `individual_taxpayer_identification_number` - An individual taxpayer
-           *   identification number (ITIN).
-           * - `passport` - A passport number.
-           * - `drivers_license` - A driver's license number.
-           * - `other` - Another identifying document.
-           */
-          method:
-            | 'social_security_number'
-            | 'individual_taxpayer_identification_number'
-            | 'passport'
-            | 'drivers_license'
-            | 'other';
-
-          /**
-           * The last 4 digits of the identification number that can be used to verify the
-           * individual's identity.
-           */
-          number_last4: string;
-
-          [k: string]: unknown;
-        }
-      }
-    }
   }
 
   /**

package/src/resources/index.ts

@@ -45,6 +45,12 @@ export {
   type AccountBalanceParams,
   type AccountsPage,
 } from './accounts';
+export {
+  BeneficialOwners,
+  type EntityBeneficialOwner,
+  type BeneficialOwnerListParams,
+  type EntityBeneficialOwnersPage,
+} from './beneficial-owners';
 export {
   BookkeepingAccounts,
   type BookkeepingAccount,