feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 239
-openapi_spec_hash: 49d468466a752f8ea72af00d00683f50
+openapi_spec_hash: 15bc6c08330309f7232c5377af693d8d
 config_hash: 1ca082e374ef7000e2a5971e8da740e0

src/resources/card-disputes.ts

@@ -109,6 +109,11 @@ export interface CardDispute {
    */
   id: string;
 
+  /**
+   * The Account that the Card Dispute is associated with.
+   */
+  account_id: string;
+
   /**
    * The amount of the dispute.
    */

src/resources/card-purchase-supplements.ts

@@ -56,6 +56,11 @@ export interface CardPurchaseSupplement {
    */
   id: string;
 
+  /**
+   * The identifier for the Account the Card Purchase Supplement belongs to.
+   */
+  account_id: string;
+
   /**
    * The ID of the Card Payment this transaction belongs to.
    */

src/resources/check-transfers.ts

@@ -895,7 +895,9 @@ export namespace CheckTransferCreateParams {
     check_voucher_image_file_id?: string;
 
     /**
-     * The descriptor that will be printed on the letter included with the check.
+     * A few paragraphs of text printed on the letter included with the check. It can
+     * contain at most 22 lines. Paragraphs will wrap at about 120 characters, but
+     * depending on your exact message, it might be slightly more or slightly less.
      */
     note?: string;
 

src/resources/digital-wallet-tokens.ts

@@ -54,6 +54,11 @@ export interface DigitalWalletToken {
    */
   id: string;
 
+  /**
+   * The identifier for the Account this Digital Wallet Token belongs to.
+   */
+  account_id: string;
+
   /**
    * The identifier for the Card this Digital Wallet Token belongs to.
    */

src/resources/entities.ts

@@ -1436,8 +1436,15 @@ export interface EntityCreateParams {
    * - `joint` - Multiple individual people.
    * - `trust` - A trust.
    * - `government_authority` - A government authority.
+   * - `sole_proprietorship` - A sole proprietorship.
    */
-  structure: 'corporation' | 'natural_person' | 'joint' | 'trust' | 'government_authority';
+  structure:
+    | 'corporation'
+    | 'natural_person'
+    | 'joint'
+    | 'trust'
+    | 'government_authority'
+    | 'sole_proprietorship';
 
   /**
    * Details of the corporation entity to create. Required if `structure` is equal to
@@ -1476,6 +1483,12 @@ export interface EntityCreateParams {
    */
   risk_rating?: EntityCreateParams.RiskRating;
 
+  /**
+   * Details of the sole proprietorship entity to create. Required if `structure` is
+   * equal to `sole_proprietorship`.
+   */
+  sole_proprietorship?: EntityCreateParams.SoleProprietorship;
+
   /**
    * Additional documentation associated with the entity.
    */
@@ -2421,6 +2434,183 @@ export namespace EntityCreateParams {
     rating: 'low' | 'medium' | 'high';
   }
 
+  /**
+   * Details of the sole proprietorship entity to create. Required if `structure` is
+   * equal to `sole_proprietorship`.
+   */
+  export interface SoleProprietorship {
+    /**
+     * The sole proprietorship's business address. Mail receiving locations like PO
+     * Boxes and PMB's are disallowed.
+     */
+    address: SoleProprietorship.Address;
+
+    /**
+     * The individual who operates the sole proprietorship.
+     */
+    sole_proprietor: SoleProprietorship.SoleProprietor;
+
+    /**
+     * The name under which the sole proprietorship does business, if it is different
+     * from the name of the sole proprietor.
+     */
+    doing_business_as_name?: string;
+
+    /**
+     * An email address for the sole proprietorship. Not every program requires an
+     * email for submitted Entities.
+     */
+    email?: string;
+
+    /**
+     * The North American Industry Classification System (NAICS) code for the sole
+     * proprietorship's primary line of business. This is a number, like `5132` for
+     * `Software Publishers`. A full list of classification codes is available
+     * [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
+     */
+    industry_code?: string;
+
+    /**
+     * The United States Employer Identification Number (EIN) for the sole
+     * proprietorship, if the sole proprietor has one. Submit nine digits with no
+     * dashes or other separators.
+     */
+    tax_identifier?: string;
+
+    /**
+     * A website for the sole proprietorship. Not every program requires a website for
+     * submitted Entities.
+     */
+    website?: string;
+  }
+
+  export namespace SoleProprietorship {
+    /**
+     * The sole proprietorship's business address. Mail receiving locations like PO
+     * Boxes and PMB's are disallowed.
+     */
+    export interface Address {
+      /**
+       * The city of the address.
+       */
+      city: string;
+
+      /**
+       * The first line of the address. This is usually the street number and street.
+       */
+      line1: string;
+
+      /**
+       * The two-letter United States Postal Service (USPS) abbreviation for the state of
+       * the address.
+       */
+      state: string;
+
+      /**
+       * The ZIP code of the address.
+       */
+      zip: string;
+
+      /**
+       * The second line of the address. This might be the floor or room number.
+       */
+      line2?: string;
+    }
+
+    /**
+     * The individual who operates the sole proprietorship.
+     */
+    export interface SoleProprietor {
+      /**
+       * The individual's physical address. Mail receiving locations like PO Boxes and
+       * PMB's are disallowed.
+       */
+      address: SoleProprietor.Address;
+
+      /**
+       * The person's date of birth in YYYY-MM-DD format.
+       */
+      date_of_birth: string;
+
+      /**
+       * A means of verifying the person's identity. Sole proprietors must be identified
+       * with a `social_security_number` or an
+       * `individual_taxpayer_identification_number`.
+       */
+      identification: SoleProprietor.Identification;
+
+      /**
+       * The person's legal name.
+       */
+      name: string;
+    }
+
+    export namespace SoleProprietor {
+      /**
+       * The individual's physical address. Mail receiving locations like PO Boxes and
+       * PMB's are disallowed.
+       */
+      export interface Address {
+        /**
+         * The city, district, town, or village of the address.
+         */
+        city: string;
+
+        /**
+         * The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+         *
+         * Defaults to `US`.
+         */
+        country: string;
+
+        /**
+         * The first line of the address. This is usually the street number and street.
+         */
+        line1: string;
+
+        /**
+         * The second line of the address. This might be the floor or room number.
+         */
+        line2?: string;
+
+        /**
+         * The two-letter United States Postal Service (USPS) abbreviation for the US
+         * state, province, or region of the address. Required in certain countries.
+         */
+        state?: string;
+
+        /**
+         * The ZIP or postal code of the address. Required in certain countries.
+         */
+        zip?: string;
+      }
+
+      /**
+       * A means of verifying the person's identity. Sole proprietors must be identified
+       * with a `social_security_number` or an
+       * `individual_taxpayer_identification_number`.
+       */
+      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).
+         */
+        method: 'social_security_number' | 'individual_taxpayer_identification_number';
+
+        /**
+         * An identification number that can be used to verify the individual's identity,
+         * such as a social security number. Submit nine digits with no dashes or other
+         * separators. When testing in sandbox, use one of our
+         * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
+         */
+        number: string;
+      }
+    }
+  }
+
   export interface SupplementalDocument {
     /**
      * The identifier of the File containing the document.

src/resources/inbound-mail-items.ts

@@ -79,6 +79,13 @@ export interface InboundMailItem {
    */
   id: string;
 
+  /**
+   * The identifier for the Account that checks in this mail item are deposited into.
+   * For mail items that could not be routed to a Lockbox Recipient, this will be
+   * null.
+   */
+  account_id: string | null;
+
   /**
    * The checks in the mail item.
    */

src/resources/inbound-wire-drawdown-requests.ts

@@ -60,6 +60,12 @@ export interface InboundWireDrawdownRequest {
    */
   id: string;
 
+  /**
+   * The Account from which the recipient of this request is being requested to send
+   * funds.
+   */
+  account_id: string;
+
   /**
    * The amount being requested in cents.
    */

src/resources/physical-cards.ts

@@ -99,6 +99,11 @@ export interface PhysicalCard {
    */
   id: string;
 
+  /**
+   * The identifier for the Account this Physical Card belongs to.
+   */
+  account_id: string;
+
   /**
    * The identifier for the Card this Physical Card represents.
    */

src/resources/simulations/programs.ts

@@ -45,6 +45,12 @@ export interface ProgramCreateParams {
    */
   lending_maximum_extendable_credit?: number;
 
+  /**
+   * Whether opening a loan Account under this Program requires an accepted Loan
+   * Offer. Requires `lending_maximum_extendable_credit`. Defaults to `false`.
+   */
+  loan_accounts_require_loan_offers?: boolean;
+
   /**
    * The identifier of the Account the Program should be added to is for.
    */

src/resources/wire-drawdown-requests.ts

@@ -90,6 +90,12 @@ export interface WireDrawdownRequest {
    */
   id: string;
 
+  /**
+   * The Account to which the debtor—the recipient of this request—is being requested
+   * to send funds.
+   */
+  account_id: string;
+
   /**
    * The Account Number to which the debtor—the recipient of this request—is being
    * requested to send funds.

tests/api-resources/entities.test.ts

@@ -170,6 +170,33 @@ describe('resource entities', () => {
         confirmed_no_us_tax_id: true,
       },
       risk_rating: { rated_at: '2019-12-27T18:11:19.117Z', rating: 'low' },
+      sole_proprietorship: {
+        address: {
+          city: 'x',
+          line1: 'x',
+          state: 'xx',
+          zip: 'x',
+          line2: 'x',
+        },
+        sole_proprietor: {
+          address: {
+            city: 'x',
+            country: 'x',
+            line1: 'x',
+            line2: 'x',
+            state: 'x',
+            zip: 'x',
+          },
+          date_of_birth: '2019-12-27',
+          identification: { method: 'social_security_number', number: 'xxxx' },
+          name: 'x',
+        },
+        doing_business_as_name: 'x',
+        email: '[email protected]',
+        industry_code: 'x',
+        tax_identifier: 'x',
+        website: 'website',
+      },
       supplemental_documents: [{ file_id: 'file_id' }],
       terms_agreements: [
         {

tests/api-resources/simulations/programs.test.ts

@@ -24,6 +24,7 @@ describe('resource programs', () => {
       name: 'For Benefit Of',
       bank: 'core_bank',
       lending_maximum_extendable_credit: 0,
+      loan_accounts_require_loan_offers: true,
       reserve_account_id: 'reserve_account_id',
     });
   });