increase 0.4.0 → 0.5.0

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

@@ -1,6 +1,7 @@
 import * as Core from '../../core';
 import { APIResource } from '../../resource';
 import { SupplementalDocuments } from './supplemental-documents';
+import * as API from './';
 import { Page, PageParams } from '../../pagination';
 export declare class Entities extends APIResource {
   supplementalDocuments: SupplementalDocuments;
@@ -24,6 +25,10 @@ export declare class EntitiesPage extends Page<Entity> {}
  * corporations, partnerships, or trusts.
  */
 export interface Entity {
+  /**
+   * The entity's identifier.
+   */
+  id: string;
   /**
    * Details of the corporation entity. Will be present if `structure` is equal to
    * `corporation`.
@@ -33,10 +38,6 @@ export interface Entity {
    * The entity's description for display purposes.
    */
   description: string | null;
-  /**
-   * The entity's identifier.
-   */
-  id: string;
   /**
    * Details of the joint entity. Will be present if `structure` is equal to `joint`.
    */
@@ -59,7 +60,7 @@ export interface Entity {
    * 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>;
+  supplemental_documents: Array<Entity.SupplementalDocument>;
   /**
    * Details of the trust entity. Will be present if `structure` is equal to `trust`.
    */
@@ -84,7 +85,7 @@ export declare namespace Entity {
      * The identifying details of anyone controlling or owning 25% or more of the
      * corporation.
      */
-    beneficial_owners: Array<Corporation.BeneficialOwners>;
+    beneficial_owners: Array<Corporation.BeneficialOwner>;
     /**
      * The two-letter United States Postal Service (USPS) abbreviation for the
      * corporation's state of incorporation.
@@ -130,7 +131,7 @@ export declare namespace Entity {
        */
       zip: string;
     }
-    interface BeneficialOwners {
+    interface BeneficialOwner {
       /**
        * This person's role or title within the entity.
        */
@@ -138,13 +139,13 @@ export declare namespace Entity {
       /**
        * Personal details for the beneficial owner.
        */
-      individual: BeneficialOwners.Individual;
+      individual: BeneficialOwner.Individual;
       /**
        * Why this person is considered a beneficial owner of the entity.
        */
       prong: 'ownership' | 'control';
     }
-    namespace BeneficialOwners {
+    namespace BeneficialOwner {
       /**
        * Personal details for the beneficial owner.
        */
@@ -215,6 +216,86 @@ export declare namespace Entity {
       }
     }
   }
+  /**
+   * 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.
+     */
+    individuals: Array<Joint.Individual>;
+    /**
+     * The entity's name.
+     */
+    name: string;
+  }
+  namespace Joint {
+    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;
+    }
+    namespace Individual {
+      /**
+       * The person's address.
+       */
+      interface Address {
+        /**
+         * The city of the address.
+         */
+        city: 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 state of
+         * the address.
+         */
+        state: string;
+        /**
+         * The ZIP code of the address.
+         */
+        zip: 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';
+        /**
+         * The last 4 digits of the identification number that can be used to verify the
+         * individual's identity.
+         */
+        number_last4: string;
+      }
+    }
+  }
   /**
    * Details of the natural person entity. Will be present if `structure` is equal to
    * `natural_person`.
@@ -285,84 +366,24 @@ export declare namespace Entity {
     }
   }
   /**
-   * Details of the joint entity. Will be present if `structure` is equal to `joint`.
+   * Supplemental Documents are uploaded files connected to an Entity during
+   * onboarding.
    */
-  interface Joint {
+  interface SupplementalDocument {
     /**
-     * The two individuals that share control of the entity.
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
+     * Supplemental Document was created.
      */
-    individuals: Array<Joint.Individuals>;
+    created_at: string;
     /**
-     * The entity's name.
+     * The File containing the document.
      */
-    name: string;
-  }
-  namespace Joint {
-    interface Individuals {
-      /**
-       * The person's address.
-       */
-      address: Individuals.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: Individuals.Identification;
-      /**
-       * The person's legal name.
-       */
-      name: string;
-    }
-    namespace Individuals {
-      /**
-       * The person's address.
-       */
-      interface Address {
-        /**
-         * The city of the address.
-         */
-        city: 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 state of
-         * the address.
-         */
-        state: string;
-        /**
-         * The ZIP code of the address.
-         */
-        zip: 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';
-        /**
-         * The last 4 digits of the identification number that can be used to verify the
-         * individual's identity.
-         */
-        number_last4: string;
-      }
-    }
+    file_id: string;
+    /**
+     * A constant representing the object's type. For this resource it will always be
+     * `entity_supplemental_document`.
+     */
+    type: 'entity_supplemental_document';
   }
   /**
    * Details of the trust entity. Will be present if `structure` is equal to `trust`.
@@ -400,7 +421,7 @@ export declare namespace Entity {
     /**
      * The trustees of the trust.
      */
-    trustees: Array<Trust.Trustees>;
+    trustees: Array<Trust.Trustee>;
   }
   namespace Trust {
     /**
@@ -429,18 +450,86 @@ export declare namespace Entity {
        */
       zip: string;
     }
-    interface Trustees {
+    /**
+     * The grantor of the trust. Will be present if the `category` is `revocable`.
+     */
+    interface Grantor {
+      /**
+       * The person's address.
+       */
+      address: Grantor.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: Grantor.Identification;
+      /**
+       * The person's legal name.
+       */
+      name: string;
+    }
+    namespace Grantor {
+      /**
+       * The person's address.
+       */
+      interface Address {
+        /**
+         * The city of the address.
+         */
+        city: 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 state of
+         * the address.
+         */
+        state: string;
+        /**
+         * The ZIP code of the address.
+         */
+        zip: 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';
+        /**
+         * The last 4 digits of the identification number that can be used to verify the
+         * individual's identity.
+         */
+        number_last4: string;
+      }
+    }
+    interface Trustee {
       /**
        * The individual trustee of the trust. Will be present if the trustee's
        * `structure` is equal to `individual`.
        */
-      individual: Trustees.Individual | null;
+      individual: Trustee.Individual | null;
       /**
        * The structure of the trustee. Will always be equal to `individual`.
        */
       structure: 'individual';
     }
-    namespace Trustees {
+    namespace Trustee {
       /**
        * The individual trustee of the trust. Will be present if the trustee's
        * `structure` is equal to `individual`.
@@ -511,94 +600,6 @@ export declare namespace Entity {
         }
       }
     }
-    /**
-     * The grantor of the trust. Will be present if the `category` is `revocable`.
-     */
-    interface Grantor {
-      /**
-       * The person's address.
-       */
-      address: Grantor.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: Grantor.Identification;
-      /**
-       * The person's legal name.
-       */
-      name: string;
-    }
-    namespace Grantor {
-      /**
-       * The person's address.
-       */
-      interface Address {
-        /**
-         * The city of the address.
-         */
-        city: 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 state of
-         * the address.
-         */
-        state: string;
-        /**
-         * The ZIP code of the address.
-         */
-        zip: 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';
-        /**
-         * The last 4 digits of the identification number that can be used to verify the
-         * individual's identity.
-         */
-        number_last4: string;
-      }
-    }
-  }
-  /**
-   * 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 {
@@ -634,7 +635,7 @@ export interface EntityCreateParams {
   /**
    * Additional documentation associated with the entity.
    */
-  supplemental_documents?: Array<EntityCreateParams.SupplementalDocuments>;
+  supplemental_documents?: Array<EntityCreateParams.SupplementalDocument>;
   /**
    * Details of the trust entity to create. Required if `structure` is equal to
    * `trust`.
@@ -655,7 +656,7 @@ export declare namespace EntityCreateParams {
      * The identifying details of anyone controlling or owning 25% or more of the
      * corporation.
      */
-    beneficial_owners: Array<Corporation.BeneficialOwners>;
+    beneficial_owners: Array<Corporation.BeneficialOwner>;
     /**
      * The legal name of the corporation.
      */
@@ -701,11 +702,11 @@ export declare namespace EntityCreateParams {
        */
       line2?: string;
     }
-    interface BeneficialOwners {
+    interface BeneficialOwner {
       /**
        * Personal details for the beneficial owner.
        */
-      individual: BeneficialOwners.Individual;
+      individual: BeneficialOwner.Individual;
       /**
        * Why this person is considered a beneficial owner of the entity.
        */
@@ -715,7 +716,7 @@ export declare namespace EntityCreateParams {
        */
       company_title?: string;
     }
-    namespace BeneficialOwners {
+    namespace BeneficialOwner {
       /**
        * Personal details for the beneficial owner.
        */
@@ -806,24 +807,6 @@ 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.
-             */
-            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`.
@@ -865,6 +848,24 @@ export declare namespace EntityCreateParams {
              */
             expiration_date?: string;
           }
+          /**
+           * 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;
+          }
         }
       }
     }
@@ -877,18 +878,18 @@ export declare namespace EntityCreateParams {
     /**
      * The two individuals that share control of the entity.
      */
-    individuals: Array<Joint.Individuals>;
+    individuals: Array<Joint.Individual>;
     /**
      * The name of the joint entity.
      */
     name?: string;
   }
   namespace Joint {
-    interface Individuals {
+    interface Individual {
       /**
        * The individual's address.
        */
-      address: Individuals.Address;
+      address: Individual.Address;
       /**
        * The person's date of birth in YYYY-MM-DD format.
        */
@@ -896,7 +897,7 @@ export declare namespace EntityCreateParams {
       /**
        * A means of verifying the person's identity.
        */
-      identification: Individuals.Identification;
+      identification: Individual.Identification;
       /**
        * The person's legal name.
        */
@@ -909,7 +910,7 @@ export declare namespace EntityCreateParams {
        */
       confirmed_no_us_tax_id?: boolean;
     }
-    namespace Individuals {
+    namespace Individual {
       /**
        * The individual's address.
        */
@@ -971,24 +972,6 @@ 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.
-           */
-          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`.
@@ -1030,6 +1013,24 @@ export declare namespace EntityCreateParams {
            */
           expiration_date?: string;
         }
+        /**
+         * 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;
+        }
       }
     }
   }
@@ -1126,24 +1127,6 @@ 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.
-         */
-        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`.
@@ -1185,9 +1168,27 @@ export declare namespace EntityCreateParams {
          */
         expiration_date?: string;
       }
+      /**
+       * 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;
+      }
     }
   }
-  interface SupplementalDocuments {
+  interface SupplementalDocument {
     /**
      * The identifier of the File containing the document.
      */
@@ -1215,7 +1216,7 @@ export declare namespace EntityCreateParams {
     /**
      * The trustees of the trust.
      */
-    trustees: Array<Trust.Trustees>;
+    trustees: Array<Trust.Trustee>;
     /**
      * The identifier of the File containing the formation document of the trust.
      */
@@ -1262,7 +1263,7 @@ export declare namespace EntityCreateParams {
        */
       line2?: string;
     }
-    interface Trustees {
+    interface Trustee {
       /**
        * The structure of the trustee.
        */
@@ -1271,9 +1272,9 @@ export declare namespace EntityCreateParams {
        * Details of the individual trustee. Required when the trustee `structure` is
        * equal to `individual`.
        */
-      individual?: Trustees.Individual;
+      individual?: Trustee.Individual;
     }
-    namespace Trustees {
+    namespace Trustee {
       /**
        * Details of the individual trustee. Required when the trustee `structure` is
        * equal to `individual`.
@@ -1365,24 +1366,6 @@ 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.
-             */
-            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`.
@@ -1424,6 +1407,24 @@ export declare namespace EntityCreateParams {
              */
             expiration_date?: string;
           }
+          /**
+           * 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;
+          }
         }
       }
     }
@@ -1517,24 +1518,6 @@ 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.
-           */
-          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`.
@@ -1576,6 +1559,24 @@ export declare namespace EntityCreateParams {
            */
           expiration_date?: string;
         }
+        /**
+         * 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;
+        }
       }
     }
   }
@@ -1607,4 +1608,15 @@ export declare namespace EntityListParams {
     on_or_before?: string;
   }
 }
+export declare namespace Entities {
+  export import Entity = API.Entity;
+  export import EntitiesPage = API.EntitiesPage;
+  export import EntityCreateParams = API.EntityCreateParams;
+  export import EntityListParams = API.EntityListParams;
+  export import SupplementalDocuments = API.SupplementalDocuments;
+  export import SupplementalDocument = API.SupplementalDocument;
+  export import SupplementalDocumentsPage = API.SupplementalDocumentsPage;
+  export import SupplementalDocumentCreateParams = API.SupplementalDocumentCreateParams;
+  export import SupplementalDocumentListParams = API.SupplementalDocumentListParams;
+}
 //# sourceMappingURL=entities.d.ts.map