increase 0.59.1 → 0.60.0

package/src/resources/{entities/entities.ts → entities.ts}

@@ -1,22 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
 import * as EntitiesAPI from './entities';
-import * as BeneficialOwnersAPI from './beneficial-owners';
-import * as IndustryCodeAPI from './industry-code';
 import * as SupplementalDocumentsAPI from './supplemental-documents';
-import { Page, type PageParams } from '../../pagination';
+import { Page, type PageParams } from '../pagination';
 
 export class Entities extends APIResource {
-  beneficialOwners: BeneficialOwnersAPI.BeneficialOwners = new BeneficialOwnersAPI.BeneficialOwners(
-    this._client,
-  );
-  supplementalDocuments: SupplementalDocumentsAPI.SupplementalDocuments =
-    new SupplementalDocumentsAPI.SupplementalDocuments(this._client);
-  industryCode: IndustryCodeAPI.IndustryCode = new IndustryCodeAPI.IndustryCode(this._client);
-
   /**
    * Create an Entity
    */
@@ -53,6 +44,17 @@ export class Entities extends APIResource {
     return this._client.post(`/entities/${entityId}/archive`, options);
   }
 
+  /**
+   * Archive a beneficial owner for a corporate Entity
+   */
+  archiveBeneficialOwner(
+    entityId: string,
+    body: EntityArchiveBeneficialOwnerParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Entity> {
+    return this._client.post(`/entities/${entityId}/archive_beneficial_owner`, { body, ...options });
+  }
+
   /**
    * Depending on your program, you may be required to re-confirm an Entity's details
    * on a recurring basis. After making any required updates, call this endpoint to
@@ -66,6 +68,17 @@ export class Entities extends APIResource {
     return this._client.post(`/entities/${entityId}/confirm`, { body, ...options });
   }
 
+  /**
+   * Create a beneficial owner for a corporate Entity
+   */
+  createBeneficialOwner(
+    entityId: string,
+    body: EntityCreateBeneficialOwnerParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Entity> {
+    return this._client.post(`/entities/${entityId}/create_beneficial_owner`, { body, ...options });
+  }
+
   /**
    * Update a Natural Person or Corporation's address
    */
@@ -74,7 +87,29 @@ export class Entities extends APIResource {
     body: EntityUpdateAddressParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<Entity> {
-    return this._client.post(`/entities/${entityId}/address`, { body, ...options });
+    return this._client.post(`/entities/${entityId}/update_address`, { body, ...options });
+  }
+
+  /**
+   * Update the address for a beneficial owner belonging to a corporate Entity
+   */
+  updateBeneficialOwnerAddress(
+    entityId: string,
+    body: EntityUpdateBeneficialOwnerAddressParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Entity> {
+    return this._client.post(`/entities/${entityId}/update_beneficial_owner_address`, { body, ...options });
+  }
+
+  /**
+   * Update the industry code for a corporate Entity
+   */
+  updateIndustryCode(
+    entityId: string,
+    body: EntityUpdateIndustryCodeParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Entity> {
+    return this._client.post(`/entities/${entityId}/update_industry_code`, { body, ...options });
   }
 }
 
@@ -164,7 +199,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.SupplementalDocument>;
+  supplemental_documents: Array<SupplementalDocumentsAPI.EntitySupplementalDocument>;
 
   /**
    * Details of the trust entity. Will be present if `structure` is equal to `trust`.
@@ -641,36 +676,6 @@ export namespace Entity {
     }
   }
 
-  /**
-   * Supplemental Documents are uploaded files connected to an Entity during
-   * onboarding.
-   */
-  export interface SupplementalDocument {
-    /**
-     * 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;
-
-    /**
-     * The idempotency key you chose for this 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 | null;
-
-    /**
-     * 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`.
    */
@@ -2345,6 +2350,14 @@ export namespace EntityListParams {
   }
 }
 
+export interface EntityArchiveBeneficialOwnerParams {
+  /**
+   * The identifying details of anyone controlling or owning 25% or more of the
+   * corporation.
+   */
+  beneficial_owner_id: string;
+}
+
 export interface EntityConfirmParams {
   /**
    * When your user confirmed the Entity's details. If not provided, the current time
@@ -2353,6 +2366,237 @@ export interface EntityConfirmParams {
   confirmed_at?: string;
 }
 
+export interface EntityCreateBeneficialOwnerParams {
+  /**
+   * The identifying details of anyone controlling or owning 25% or more of the
+   * corporation.
+   */
+  beneficial_owner: EntityCreateBeneficialOwnerParams.BeneficialOwner;
+}
+
+export namespace EntityCreateBeneficialOwnerParams {
+  /**
+   * The identifying details of anyone controlling or owning 25% or more of the
+   * corporation.
+   */
+  export interface BeneficialOwner {
+    /**
+     * Personal details for the beneficial owner.
+     */
+    individual: BeneficialOwner.Individual;
+
+    /**
+     * Why this person is considered a beneficial owner of the entity. At least one
+     * option is required, if a person is both a control person and owner, submit an
+     * array containing both.
+     */
+    prongs: Array<'ownership' | 'control'>;
+
+    /**
+     * This person's role or title within the entity.
+     */
+    company_title?: string;
+  }
+
+  export namespace BeneficialOwner {
+    /**
+     * Personal details for the beneficial owner.
+     */
+    export interface Individual {
+      /**
+       * The individual's physical address. Mail receiving locations like PO Boxes and
+       * PMB's are disallowed.
+       */
+      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;
+
+      /**
+       * 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;
+    }
+
+    export namespace Individual {
+      /**
+       * The individual's physical 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;
+      }
+
+      /**
+       * 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';
+
+        /**
+         * 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;
+      }
+
+      export namespace Identification {
+        /**
+         * Information about the United States driver's license used for identification.
+         * Required if `method` is equal to `drivers_license`.
+         */
+        export interface DriversLicense {
+          /**
+           * The driver's license's expiration date in YYYY-MM-DD format.
+           */
+          expiration_date: string;
+
+          /**
+           * The identifier of the File containing the front of the driver's license.
+           */
+          file_id: string;
+
+          /**
+           * The state that issued the provided driver's license.
+           */
+          state: string;
+
+          /**
+           * The identifier of the File containing the back of the driver's license.
+           */
+          back_file_id?: string;
+        }
+
+        /**
+         * Information about the identification document provided. Required if `method` is
+         * equal to `other`.
+         */
+        export 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 front of the document.
+           */
+          file_id: string;
+
+          /**
+           * The identifier of the File containing the back of the document. Not every
+           * document has a reverse side.
+           */
+          back_file_id?: string;
+
+          /**
+           * The document's expiration date in YYYY-MM-DD format.
+           */
+          expiration_date?: string;
+        }
+
+        /**
+         * Information about the passport used for identification. Required if `method` is
+         * equal to `passport`.
+         */
+        export 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;
+        }
+      }
+    }
+  }
+}
+
 export interface EntityUpdateAddressParams {
   /**
    * The entity's physical address. Mail receiving locations like PO Boxes and PMB's
@@ -2395,22 +2639,73 @@ export namespace EntityUpdateAddressParams {
   }
 }
 
+export interface EntityUpdateBeneficialOwnerAddressParams {
+  /**
+   * The individual's physical address. Mail receiving locations like PO Boxes and
+   * PMB's are disallowed.
+   */
+  address: EntityUpdateBeneficialOwnerAddressParams.Address;
+
+  /**
+   * The identifying details of anyone controlling or owning 25% or more of the
+   * corporation.
+   */
+  beneficial_owner_id: string;
+}
+
+export namespace EntityUpdateBeneficialOwnerAddressParams {
+  /**
+   * The individual's physical 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;
+  }
+}
+
+export interface EntityUpdateIndustryCodeParams {
+  /**
+   * The North American Industry Classification System (NAICS) code for the
+   * corporation'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;
+}
+
 export namespace Entities {
   export import Entity = EntitiesAPI.Entity;
   export import EntitiesPage = EntitiesAPI.EntitiesPage;
   export import EntityCreateParams = EntitiesAPI.EntityCreateParams;
   export import EntityListParams = EntitiesAPI.EntityListParams;
+  export import EntityArchiveBeneficialOwnerParams = EntitiesAPI.EntityArchiveBeneficialOwnerParams;
   export import EntityConfirmParams = EntitiesAPI.EntityConfirmParams;
+  export import EntityCreateBeneficialOwnerParams = EntitiesAPI.EntityCreateBeneficialOwnerParams;
   export import EntityUpdateAddressParams = EntitiesAPI.EntityUpdateAddressParams;
-  export import BeneficialOwners = BeneficialOwnersAPI.BeneficialOwners;
-  export import BeneficialOwnerCreateParams = BeneficialOwnersAPI.BeneficialOwnerCreateParams;
-  export import BeneficialOwnerArchiveParams = BeneficialOwnersAPI.BeneficialOwnerArchiveParams;
-  export import BeneficialOwnerUpdateAddressParams = BeneficialOwnersAPI.BeneficialOwnerUpdateAddressParams;
-  export import SupplementalDocuments = SupplementalDocumentsAPI.SupplementalDocuments;
-  export import SupplementalDocument = SupplementalDocumentsAPI.SupplementalDocument;
-  export import SupplementalDocumentsPage = SupplementalDocumentsAPI.SupplementalDocumentsPage;
-  export import SupplementalDocumentCreateParams = SupplementalDocumentsAPI.SupplementalDocumentCreateParams;
-  export import SupplementalDocumentListParams = SupplementalDocumentsAPI.SupplementalDocumentListParams;
-  export import IndustryCode = IndustryCodeAPI.IndustryCode;
-  export import IndustryCodeCreateParams = IndustryCodeAPI.IndustryCodeCreateParams;
+  export import EntityUpdateBeneficialOwnerAddressParams = EntitiesAPI.EntityUpdateBeneficialOwnerAddressParams;
+  export import EntityUpdateIndustryCodeParams = EntitiesAPI.EntityUpdateIndustryCodeParams;
 }

package/src/resources/groups.ts

@@ -8,7 +8,7 @@ export class Groups extends APIResource {
   /**
    * Returns details for the currently authenticated Group.
    */
-  retrieveDetails(options?: Core.RequestOptions): Core.APIPromise<Group> {
+  retrieve(options?: Core.RequestOptions): Core.APIPromise<Group> {
     return this._client.get('/groups/current', options);
   }
 }