increase 0.2.0 → 0.4.0

package/dist/cjs/resources/entities/entities.d.ts

@@ -1,7 +1,7 @@
 import * as Core from '../../core';
 import { APIResource } from '../../resource';
-import { Page, PageParams } from '../../pagination';
 import { SupplementalDocuments } from './supplemental-documents';
+import { Page, PageParams } from '../../pagination';
 export declare class Entities extends APIResource {
   supplementalDocuments: SupplementalDocuments;
   /**
@@ -55,7 +55,9 @@ export interface Entity {
    */
   structure: 'corporation' | 'natural_person' | 'joint' | 'trust';
   /**
-   * Additional documentation associated with the entity.
+   * Additional documentation associated with the entity. This is limited to the
+   * first 10 documents for an entity. If an entity has more than 10 documents, use
+   * the GET /entity_supplemental_documents list endpoint to retrieve them.
    */
   supplemental_documents: Array<Entity.SupplementalDocuments>;
   /**
@@ -69,6 +71,10 @@ export interface Entity {
   type: 'entity';
 }
 export declare namespace Entity {
+  /**
+   * Details of the corporation entity. Will be present if `structure` is equal to
+   * `corporation`.
+   */
   interface Corporation {
     /**
      * The corporation's address.
@@ -98,6 +104,9 @@ export declare namespace Entity {
     website: string | null;
   }
   namespace Corporation {
+    /**
+     * The corporation's address.
+     */
     interface Address {
       /**
        * The city of the address.
@@ -136,6 +145,9 @@ export declare namespace Entity {
       prong: 'ownership' | 'control';
     }
     namespace BeneficialOwners {
+      /**
+       * Personal details for the beneficial owner.
+       */
       interface Individual {
         /**
          * The person's address.
@@ -155,6 +167,9 @@ export declare namespace Entity {
         name: string;
       }
       namespace Individual {
+        /**
+         * The person's address.
+         */
         interface Address {
           /**
            * The city of the address.
@@ -178,6 +193,9 @@ export declare namespace Entity {
            */
           zip: string;
         }
+        /**
+         * A means of verifying the person's identity.
+         */
         interface Identification {
           /**
            * A method that can be used to verify the individual's identity.
@@ -197,6 +215,10 @@ export declare namespace Entity {
       }
     }
   }
+  /**
+   * Details of the natural person entity. Will be present if `structure` is equal to
+   * `natural_person`.
+   */
   interface NaturalPerson {
     /**
      * The person's address.
@@ -216,6 +238,9 @@ export declare namespace Entity {
     name: string;
   }
   namespace NaturalPerson {
+    /**
+     * The person's address.
+     */
     interface Address {
       /**
        * The city of the address.
@@ -239,6 +264,9 @@ export declare namespace Entity {
        */
       zip: string;
     }
+    /**
+     * A means of verifying the person's identity.
+     */
     interface Identification {
       /**
        * A method that can be used to verify the individual's identity.
@@ -256,6 +284,9 @@ export declare namespace Entity {
       number_last4: string;
     }
   }
+  /**
+   * Details of the joint entity. Will be present if `structure` is equal to `joint`.
+   */
   interface Joint {
     /**
      * The two individuals that share control of the entity.
@@ -286,6 +317,9 @@ export declare namespace Entity {
       name: string;
     }
     namespace Individuals {
+      /**
+       * The person's address.
+       */
       interface Address {
         /**
          * The city of the address.
@@ -309,6 +343,9 @@ export declare namespace Entity {
          */
         zip: string;
       }
+      /**
+       * A means of verifying the person's identity.
+       */
       interface Identification {
         /**
          * A method that can be used to verify the individual's identity.
@@ -327,6 +364,9 @@ export declare namespace Entity {
       }
     }
   }
+  /**
+   * Details of the trust entity. Will be present if `structure` is equal to `trust`.
+   */
   interface Trust {
     /**
      * The trust's address.
@@ -363,6 +403,9 @@ export declare namespace Entity {
     trustees: Array<Trust.Trustees>;
   }
   namespace Trust {
+    /**
+     * The trust's address.
+     */
     interface Address {
       /**
        * The city of the address.
@@ -398,6 +441,10 @@ export declare namespace Entity {
       structure: 'individual';
     }
     namespace Trustees {
+      /**
+       * The individual trustee of the trust. Will be present if the trustee's
+       * `structure` is equal to `individual`.
+       */
       interface Individual {
         /**
          * The person's address.
@@ -417,6 +464,9 @@ export declare namespace Entity {
         name: string;
       }
       namespace Individual {
+        /**
+         * The person's address.
+         */
         interface Address {
           /**
            * The city of the address.
@@ -440,6 +490,9 @@ export declare namespace Entity {
            */
           zip: string;
         }
+        /**
+         * A means of verifying the person's identity.
+         */
         interface Identification {
           /**
            * A method that can be used to verify the individual's identity.
@@ -458,6 +511,9 @@ export declare namespace Entity {
         }
       }
     }
+    /**
+     * The grantor of the trust. Will be present if the `category` is `revocable`.
+     */
     interface Grantor {
       /**
        * The person's address.
@@ -477,6 +533,9 @@ export declare namespace Entity {
       name: string;
     }
     namespace Grantor {
+      /**
+       * The person's address.
+       */
       interface Address {
         /**
          * The city of the address.
@@ -500,6 +559,9 @@ export declare namespace Entity {
          */
         zip: string;
       }
+      /**
+       * A means of verifying the person's identity.
+       */
       interface Identification {
         /**
          * A method that can be used to verify the individual's identity.
@@ -518,11 +580,25 @@ export declare namespace Entity {
       }
     }
   }
+  /**
+   * Supplemental Documents are uploaded files connected to an Entity during
+   * onboarding.
+   */
   interface SupplementalDocuments {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
+     * Supplemental Document was created.
+     */
+    created_at: string;
     /**
      * The File containing the document.
      */
     file_id: string;
+    /**
+     * A constant representing the object's type. For this resource it will always be
+     * `entity_supplemental_document`.
+     */
+    type: 'entity_supplemental_document';
   }
 }
 export interface EntityCreateParams {
@@ -566,6 +642,10 @@ export interface EntityCreateParams {
   trust?: EntityCreateParams.Trust;
 }
 export declare namespace EntityCreateParams {
+  /**
+   * Details of the corporation entity to create. Required if `structure` is equal to
+   * `corporation`.
+   */
   interface Corporation {
     /**
      * The corporation's address.
@@ -595,6 +675,9 @@ export declare namespace EntityCreateParams {
     website?: string;
   }
   namespace Corporation {
+    /**
+     * The corporation's address.
+     */
     interface Address {
       /**
        * The city of the address.
@@ -633,6 +716,9 @@ export declare namespace EntityCreateParams {
       company_title?: string;
     }
     namespace BeneficialOwners {
+      /**
+       * Personal details for the beneficial owner.
+       */
       interface Individual {
         /**
          * The individual's address.
@@ -659,6 +745,9 @@ export declare namespace EntityCreateParams {
         confirmed_no_us_tax_id?: boolean;
       }
       namespace Individual {
+        /**
+         * The individual's address.
+         */
         interface Address {
           /**
            * The city of the address.
@@ -682,6 +771,9 @@ export declare namespace EntityCreateParams {
            */
           line2?: string;
         }
+        /**
+         * A means of verifying the person's identity.
+         */
         interface Identification {
           /**
            * A method that can be used to verify the individual's identity.
@@ -714,6 +806,10 @@ export declare namespace EntityCreateParams {
           passport?: Identification.Passport;
         }
         namespace Identification {
+          /**
+           * Information about the passport used for identification. Required if `method` is
+           * equal to `passport`.
+           */
           interface Passport {
             /**
              * The country that issued the passport.
@@ -728,6 +824,10 @@ export declare namespace EntityCreateParams {
              */
             file_id: string;
           }
+          /**
+           * Information about the United States driver's license used for identification.
+           * Required if `method` is equal to `drivers_license`.
+           */
           interface DriversLicense {
             /**
              * The driver's license's expiration date in YYYY-MM-DD format.
@@ -742,6 +842,10 @@ export declare namespace EntityCreateParams {
              */
             state: string;
           }
+          /**
+           * Information about the identification document provided. Required if `method` is
+           * equal to `other`.
+           */
           interface Other {
             /**
              * The two-character ISO 3166-1 code representing the country that issued the
@@ -765,136 +869,10 @@ export declare namespace EntityCreateParams {
       }
     }
   }
-  interface NaturalPerson {
-    /**
-     * The individual's address.
-     */
-    address: NaturalPerson.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: NaturalPerson.Identification;
-    /**
-     * The person's legal name.
-     */
-    name: string;
-    /**
-     * The identification method for an individual can only be a passport, driver's
-     * license, or other document if you've confirmed the individual does not have a US
-     * tax id (either a Social Security Number or Individual Taxpayer Identification
-     * Number).
-     */
-    confirmed_no_us_tax_id?: boolean;
-  }
-  namespace NaturalPerson {
-    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;
-    }
-    interface Identification {
-      /**
-       * A method that can be used to verify the individual's identity.
-       */
-      method:
-        | 'social_security_number'
-        | 'individual_taxpayer_identification_number'
-        | 'passport'
-        | 'drivers_license'
-        | 'other';
-      /**
-       * An identification number that can be used to verify the individual's identity,
-       * such as a social security number.
-       */
-      number: string;
-      /**
-       * Information about the United States driver's license used for identification.
-       * Required if `method` is equal to `drivers_license`.
-       */
-      drivers_license?: Identification.DriversLicense;
-      /**
-       * Information about the identification document provided. Required if `method` is
-       * equal to `other`.
-       */
-      other?: Identification.Other;
-      /**
-       * Information about the passport used for identification. Required if `method` is
-       * equal to `passport`.
-       */
-      passport?: Identification.Passport;
-    }
-    namespace Identification {
-      interface Passport {
-        /**
-         * The country that issued the passport.
-         */
-        country: string;
-        /**
-         * The passport's expiration date in YYYY-MM-DD format.
-         */
-        expiration_date: string;
-        /**
-         * The identifier of the File containing the passport.
-         */
-        file_id: string;
-      }
-      interface DriversLicense {
-        /**
-         * The driver's license's expiration date in YYYY-MM-DD format.
-         */
-        expiration_date: string;
-        /**
-         * The identifier of the File containing the driver's license.
-         */
-        file_id: string;
-        /**
-         * The state that issued the provided driver's license.
-         */
-        state: string;
-      }
-      interface Other {
-        /**
-         * The two-character ISO 3166-1 code representing the country that issued the
-         * document.
-         */
-        country: string;
-        /**
-         * A description of the document submitted.
-         */
-        description: string;
-        /**
-         * The identifier of the File containing the document.
-         */
-        file_id: string;
-        /**
-         * The document's expiration date in YYYY-MM-DD format.
-         */
-        expiration_date?: string;
-      }
-    }
-  }
+  /**
+   * Details of the joint entity to create. Required if `structure` is equal to
+   * `joint`.
+   */
   interface Joint {
     /**
      * The two individuals that share control of the entity.
@@ -932,6 +910,9 @@ export declare namespace EntityCreateParams {
       confirmed_no_us_tax_id?: boolean;
     }
     namespace Individuals {
+      /**
+       * The individual's address.
+       */
       interface Address {
         /**
          * The city of the address.
@@ -955,6 +936,9 @@ export declare namespace EntityCreateParams {
          */
         line2?: string;
       }
+      /**
+       * A means of verifying the person's identity.
+       */
       interface Identification {
         /**
          * A method that can be used to verify the individual's identity.
@@ -987,6 +971,10 @@ export declare namespace EntityCreateParams {
         passport?: Identification.Passport;
       }
       namespace Identification {
+        /**
+         * Information about the passport used for identification. Required if `method` is
+         * equal to `passport`.
+         */
         interface Passport {
           /**
            * The country that issued the passport.
@@ -1001,6 +989,10 @@ export declare namespace EntityCreateParams {
            */
           file_id: string;
         }
+        /**
+         * Information about the United States driver's license used for identification.
+         * Required if `method` is equal to `drivers_license`.
+         */
         interface DriversLicense {
           /**
            * The driver's license's expiration date in YYYY-MM-DD format.
@@ -1015,6 +1007,10 @@ export declare namespace EntityCreateParams {
            */
           state: string;
         }
+        /**
+         * Information about the identification document provided. Required if `method` is
+         * equal to `other`.
+         */
         interface Other {
           /**
            * The two-character ISO 3166-1 code representing the country that issued the
@@ -1037,6 +1033,170 @@ export declare namespace EntityCreateParams {
       }
     }
   }
+  /**
+   * Details of the natural person entity to create. Required if `structure` is equal
+   * to `natural_person`. Natural people entities should be submitted with
+   * `social_security_number` or `individual_taxpayer_identification_number`
+   * identification methods.
+   */
+  interface NaturalPerson {
+    /**
+     * The individual's address.
+     */
+    address: NaturalPerson.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: NaturalPerson.Identification;
+    /**
+     * The person's legal name.
+     */
+    name: string;
+    /**
+     * The identification method for an individual can only be a passport, driver's
+     * license, or other document if you've confirmed the individual does not have a US
+     * tax id (either a Social Security Number or Individual Taxpayer Identification
+     * Number).
+     */
+    confirmed_no_us_tax_id?: boolean;
+  }
+  namespace NaturalPerson {
+    /**
+     * The individual's address.
+     */
+    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;
+    }
+    /**
+     * A means of verifying the person's identity.
+     */
+    interface Identification {
+      /**
+       * A method that can be used to verify the individual's identity.
+       */
+      method:
+        | 'social_security_number'
+        | 'individual_taxpayer_identification_number'
+        | 'passport'
+        | 'drivers_license'
+        | 'other';
+      /**
+       * An identification number that can be used to verify the individual's identity,
+       * such as a social security number.
+       */
+      number: string;
+      /**
+       * Information about the United States driver's license used for identification.
+       * Required if `method` is equal to `drivers_license`.
+       */
+      drivers_license?: Identification.DriversLicense;
+      /**
+       * Information about the identification document provided. Required if `method` is
+       * equal to `other`.
+       */
+      other?: Identification.Other;
+      /**
+       * Information about the passport used for identification. Required if `method` is
+       * equal to `passport`.
+       */
+      passport?: Identification.Passport;
+    }
+    namespace Identification {
+      /**
+       * Information about the passport used for identification. Required if `method` is
+       * equal to `passport`.
+       */
+      interface Passport {
+        /**
+         * The country that issued the passport.
+         */
+        country: string;
+        /**
+         * The passport's expiration date in YYYY-MM-DD format.
+         */
+        expiration_date: string;
+        /**
+         * The identifier of the File containing the passport.
+         */
+        file_id: string;
+      }
+      /**
+       * Information about the United States driver's license used for identification.
+       * Required if `method` is equal to `drivers_license`.
+       */
+      interface DriversLicense {
+        /**
+         * The driver's license's expiration date in YYYY-MM-DD format.
+         */
+        expiration_date: string;
+        /**
+         * The identifier of the File containing the driver's license.
+         */
+        file_id: string;
+        /**
+         * The state that issued the provided driver's license.
+         */
+        state: string;
+      }
+      /**
+       * Information about the identification document provided. Required if `method` is
+       * equal to `other`.
+       */
+      interface Other {
+        /**
+         * The two-character ISO 3166-1 code representing the country that issued the
+         * document.
+         */
+        country: string;
+        /**
+         * A description of the document submitted.
+         */
+        description: string;
+        /**
+         * The identifier of the File containing the document.
+         */
+        file_id: string;
+        /**
+         * The document's expiration date in YYYY-MM-DD format.
+         */
+        expiration_date?: string;
+      }
+    }
+  }
+  interface SupplementalDocuments {
+    /**
+     * The identifier of the File containing the document.
+     */
+    file_id: string;
+  }
+  /**
+   * Details of the trust entity to create. Required if `structure` is equal to
+   * `trust`.
+   */
   interface Trust {
     /**
      * The trust's address.
@@ -1076,6 +1236,9 @@ export declare namespace EntityCreateParams {
     tax_identifier?: string;
   }
   namespace Trust {
+    /**
+     * The trust's address.
+     */
     interface Address {
       /**
        * The city of the address.
@@ -1111,6 +1274,10 @@ export declare namespace EntityCreateParams {
       individual?: Trustees.Individual;
     }
     namespace Trustees {
+      /**
+       * Details of the individual trustee. Required when the trustee `structure` is
+       * equal to `individual`.
+       */
       interface Individual {
         /**
          * The individual's address.
@@ -1137,6 +1304,9 @@ export declare namespace EntityCreateParams {
         confirmed_no_us_tax_id?: boolean;
       }
       namespace Individual {
+        /**
+         * The individual's address.
+         */
         interface Address {
           /**
            * The city of the address.
@@ -1160,6 +1330,9 @@ export declare namespace EntityCreateParams {
            */
           line2?: string;
         }
+        /**
+         * A means of verifying the person's identity.
+         */
         interface Identification {
           /**
            * A method that can be used to verify the individual's identity.
@@ -1192,6 +1365,10 @@ export declare namespace EntityCreateParams {
           passport?: Identification.Passport;
         }
         namespace Identification {
+          /**
+           * Information about the passport used for identification. Required if `method` is
+           * equal to `passport`.
+           */
           interface Passport {
             /**
              * The country that issued the passport.
@@ -1206,6 +1383,10 @@ export declare namespace EntityCreateParams {
              */
             file_id: string;
           }
+          /**
+           * Information about the United States driver's license used for identification.
+           * Required if `method` is equal to `drivers_license`.
+           */
           interface DriversLicense {
             /**
              * The driver's license's expiration date in YYYY-MM-DD format.
@@ -1220,6 +1401,10 @@ export declare namespace EntityCreateParams {
              */
             state: string;
           }
+          /**
+           * Information about the identification document provided. Required if `method` is
+           * equal to `other`.
+           */
           interface Other {
             /**
              * The two-character ISO 3166-1 code representing the country that issued the
@@ -1242,6 +1427,9 @@ export declare namespace EntityCreateParams {
         }
       }
     }
+    /**
+     * The grantor of the trust. Required if `category` is equal to `revocable`.
+     */
     interface Grantor {
       /**
        * The individual's address.
@@ -1268,6 +1456,9 @@ export declare namespace EntityCreateParams {
       confirmed_no_us_tax_id?: boolean;
     }
     namespace Grantor {
+      /**
+       * The individual's address.
+       */
       interface Address {
         /**
          * The city of the address.
@@ -1291,6 +1482,9 @@ export declare namespace EntityCreateParams {
          */
         line2?: string;
       }
+      /**
+       * A means of verifying the person's identity.
+       */
       interface Identification {
         /**
          * A method that can be used to verify the individual's identity.
@@ -1323,6 +1517,10 @@ export declare namespace EntityCreateParams {
         passport?: Identification.Passport;
       }
       namespace Identification {
+        /**
+         * Information about the passport used for identification. Required if `method` is
+         * equal to `passport`.
+         */
         interface Passport {
           /**
            * The country that issued the passport.
@@ -1337,6 +1535,10 @@ export declare namespace EntityCreateParams {
            */
           file_id: string;
         }
+        /**
+         * Information about the United States driver's license used for identification.
+         * Required if `method` is equal to `drivers_license`.
+         */
         interface DriversLicense {
           /**
            * The driver's license's expiration date in YYYY-MM-DD format.
@@ -1351,6 +1553,10 @@ export declare namespace EntityCreateParams {
            */
           state: string;
         }
+        /**
+         * Information about the identification document provided. Required if `method` is
+         * equal to `other`.
+         */
         interface Other {
           /**
            * The two-character ISO 3166-1 code representing the country that issued the
@@ -1373,11 +1579,32 @@ export declare namespace EntityCreateParams {
       }
     }
   }
-  interface SupplementalDocuments {
+}
+export interface EntityListParams extends PageParams {
+  created_at?: EntityListParams.CreatedAt;
+}
+export declare namespace EntityListParams {
+  interface CreatedAt {
     /**
-     * The identifier of the File containing the document.
+     * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+     * timestamp.
      */
-    file_id: string;
+    after?: string;
+    /**
+     * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+     * timestamp.
+     */
+    before?: string;
+    /**
+     * Return results on or after this
+     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     */
+    on_or_after?: string;
+    /**
+     * Return results on or before this
+     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     */
+    on_or_before?: string;
   }
 }
-export interface EntityListParams extends PageParams {}
+//# sourceMappingURL=entities.d.ts.map