increase 0.8.1 → 0.9.0

package/src/resources/digital-wallet-tokens.ts

@@ -10,10 +10,7 @@ export class DigitalWalletTokens extends APIResource {
   /**
    * Retrieve a Digital Wallet Token
    */
-  retrieve(
-    digitalWalletTokenId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<DigitalWalletToken>> {
+  retrieve(digitalWalletTokenId: string, options?: Core.RequestOptions): Core.APIPromise<DigitalWalletToken> {
     return this.get(`/digital_wallet_tokens/${digitalWalletTokenId}`, options);
   }
 
@@ -23,12 +20,12 @@ export class DigitalWalletTokens extends APIResource {
   list(
     query?: DigitalWalletTokenListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<DigitalWalletTokensPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<DigitalWalletTokensPage>;
+  ): Core.PagePromise<DigitalWalletTokensPage, DigitalWalletToken>;
+  list(options?: Core.RequestOptions): Core.PagePromise<DigitalWalletTokensPage, DigitalWalletToken>;
   list(
     query: DigitalWalletTokenListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<DigitalWalletTokensPage> {
+  ): Core.PagePromise<DigitalWalletTokensPage, DigitalWalletToken> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/documents.ts

@@ -10,19 +10,19 @@ export class Documents extends APIResource {
   /**
    * Retrieve a Document
    */
-  retrieve(documentId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Document>> {
+  retrieve(documentId: string, options?: Core.RequestOptions): Core.APIPromise<Document> {
     return this.get(`/documents/${documentId}`, options);
   }
 
   /**
    * List Documents
    */
-  list(query?: DocumentListParams, options?: Core.RequestOptions): Core.PagePromise<DocumentsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<DocumentsPage>;
+  list(query?: DocumentListParams, options?: Core.RequestOptions): Core.PagePromise<DocumentsPage, Document>;
+  list(options?: Core.RequestOptions): Core.PagePromise<DocumentsPage, Document>;
   list(
     query: DocumentListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<DocumentsPage> {
+  ): Core.PagePromise<DocumentsPage, Document> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/entities/beneficial-owners.ts

@@ -13,7 +13,7 @@ export class BeneficialOwners extends APIResource {
     entityId: string,
     body: BeneficialOwnerCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Entities.Entity>> {
+  ): Core.APIPromise<Entities.Entity> {
     return this.post(`/entities/${entityId}/beneficial_owners`, { body, ...options });
   }
 }
@@ -38,14 +38,10 @@ export namespace BeneficialOwnerCreateParams {
     individual: BeneficialOwner.Individual;
 
     /**
-     * Why this person is considered a beneficial owner of the entity.
-     *
-     * - `ownership` - A person with 25% or greater direct or indirect ownership of the
-     *   entity.
-     * - `control` - A person who manages, directs, or has significant control of the
-     *   entity.
+     * Why this person is considered a beneficial owner of the entity. At least one
+     * option is required.
      */
-    prong: 'ownership' | 'control';
+    prongs: Array<'ownership' | 'control'>;
 
     /**
      * This person's role or title within the entity.

package/src/resources/entities/entities.ts

@@ -15,31 +15,38 @@ export class Entities extends APIResource {
   /**
    * Create an Entity
    */
-  create(body: EntityCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Entity>> {
+  create(body: EntityCreateParams, options?: Core.RequestOptions): Core.APIPromise<Entity> {
     return this.post('/entities', { body, ...options });
   }
 
   /**
    * Retrieve an Entity
    */
-  retrieve(entityId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Entity>> {
+  retrieve(entityId: string, options?: Core.RequestOptions): Core.APIPromise<Entity> {
     return this.get(`/entities/${entityId}`, options);
   }
 
   /**
    * List Entities
    */
-  list(query?: EntityListParams, options?: Core.RequestOptions): Core.PagePromise<EntitiesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<EntitiesPage>;
+  list(query?: EntityListParams, options?: Core.RequestOptions): Core.PagePromise<EntitiesPage, Entity>;
+  list(options?: Core.RequestOptions): Core.PagePromise<EntitiesPage, Entity>;
   list(
     query: EntityListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<EntitiesPage> {
+  ): Core.PagePromise<EntitiesPage, Entity> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
     return this.getAPIList('/entities', EntitiesPage, { query, ...options });
   }
+
+  /**
+   * Archive an Entity
+   */
+  archive(entityId: string, options?: Core.RequestOptions): Core.APIPromise<Entity> {
+    return this.post(`/entities/${entityId}/archive`, options);
+  }
 }
 
 export class EntitiesPage extends Page<Entity> {}
@@ -918,14 +925,10 @@ export namespace EntityCreateParams {
       individual: BeneficialOwner.Individual;
 
       /**
-       * Why this person is considered a beneficial owner of the entity.
-       *
-       * - `ownership` - A person with 25% or greater direct or indirect ownership of the
-       *   entity.
-       * - `control` - A person who manages, directs, or has significant control of the
-       *   entity.
+       * Why this person is considered a beneficial owner of the entity. At least one
+       * option is required.
        */
-      prong: 'ownership' | 'control';
+      prongs: Array<'ownership' | 'control'>;
 
       /**
        * This person's role or title within the entity.

package/src/resources/entities/supplemental-documents.ts

@@ -14,7 +14,7 @@ export class SupplementalDocuments extends APIResource {
     entityId: string,
     body: SupplementalDocumentCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Entities.Entity>> {
+  ): Core.APIPromise<Entities.Entity> {
     return this.post(`/entities/${entityId}/supplemental_documents`, { body, ...options });
   }
 
@@ -24,7 +24,7 @@ export class SupplementalDocuments extends APIResource {
   list(
     query: SupplementalDocumentListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<SupplementalDocumentsPage> {
+  ): Core.PagePromise<SupplementalDocumentsPage, SupplementalDocument> {
     return this.getAPIList('/entity_supplemental_documents', SupplementalDocumentsPage, {
       query,
       ...options,

package/src/resources/event-subscriptions.ts

@@ -13,17 +13,14 @@ export class EventSubscriptions extends APIResource {
   create(
     body: EventSubscriptionCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<EventSubscription>> {
+  ): Core.APIPromise<EventSubscription> {
     return this.post('/event_subscriptions', { body, ...options });
   }
 
   /**
    * Retrieve an Event Subscription
    */
-  retrieve(
-    eventSubscriptionId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<EventSubscription>> {
+  retrieve(eventSubscriptionId: string, options?: Core.RequestOptions): Core.APIPromise<EventSubscription> {
     return this.get(`/event_subscriptions/${eventSubscriptionId}`, options);
   }
 
@@ -34,7 +31,7 @@ export class EventSubscriptions extends APIResource {
     eventSubscriptionId: string,
     body: EventSubscriptionUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<EventSubscription>> {
+  ): Core.APIPromise<EventSubscription> {
     return this.patch(`/event_subscriptions/${eventSubscriptionId}`, { body, ...options });
   }
 
@@ -44,12 +41,12 @@ export class EventSubscriptions extends APIResource {
   list(
     query?: EventSubscriptionListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<EventSubscriptionsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<EventSubscriptionsPage>;
+  ): Core.PagePromise<EventSubscriptionsPage, EventSubscription>;
+  list(options?: Core.RequestOptions): Core.PagePromise<EventSubscriptionsPage, EventSubscription>;
   list(
     query: EventSubscriptionListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<EventSubscriptionsPage> {
+  ): Core.PagePromise<EventSubscriptionsPage, EventSubscription> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/events.ts

@@ -10,19 +10,19 @@ export class Events extends APIResource {
   /**
    * Retrieve an Event
    */
-  retrieve(eventId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Event>> {
+  retrieve(eventId: string, options?: Core.RequestOptions): Core.APIPromise<Event> {
     return this.get(`/events/${eventId}`, options);
   }
 
   /**
    * List Events
    */
-  list(query?: EventListParams, options?: Core.RequestOptions): Core.PagePromise<EventsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<EventsPage>;
+  list(query?: EventListParams, options?: Core.RequestOptions): Core.PagePromise<EventsPage, Event>;
+  list(options?: Core.RequestOptions): Core.PagePromise<EventsPage, Event>;
   list(
     query: EventListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<EventsPage> {
+  ): Core.PagePromise<EventsPage, Event> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -35,8 +35,10 @@ export class EventsPage extends Page<Event> {}
 type _EventsPage = EventsPage;
 
 /**
- * Events are records of things that happened to objects in the API. They also
- * result in webhooks being generated.
+ * Events are records of things that happened to objects at Increase. Events are
+ * accessible via the List Events endpoint and can be delivered to your application
+ * via webhooks. For more information, see our
+ * [webhooks guide](https://increase.com/documentation/webhooks).
  */
 export interface Event {
   /**

package/src/resources/exports.ts

@@ -10,26 +10,26 @@ export class Exports extends APIResource {
   /**
    * Create an Export
    */
-  create(body: ExportCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Export>> {
+  create(body: ExportCreateParams, options?: Core.RequestOptions): Core.APIPromise<Export> {
     return this.post('/exports', { body, ...options });
   }
 
   /**
    * Retrieve an Export
    */
-  retrieve(exportId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Export>> {
+  retrieve(exportId: string, options?: Core.RequestOptions): Core.APIPromise<Export> {
     return this.get(`/exports/${exportId}`, options);
   }
 
   /**
    * List Exports
    */
-  list(query?: ExportListParams, options?: Core.RequestOptions): Core.PagePromise<ExportsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<ExportsPage>;
+  list(query?: ExportListParams, options?: Core.RequestOptions): Core.PagePromise<ExportsPage, Export>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ExportsPage, Export>;
   list(
     query: ExportListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ExportsPage> {
+  ): Core.PagePromise<ExportsPage, Export> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/external-accounts.ts

@@ -10,20 +10,14 @@ export class ExternalAccounts extends APIResource {
   /**
    * Create an External Account
    */
-  create(
-    body: ExternalAccountCreateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<ExternalAccount>> {
+  create(body: ExternalAccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount> {
     return this.post('/external_accounts', { body, ...options });
   }
 
   /**
    * Retrieve an External Account
    */
-  retrieve(
-    externalAccountId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<ExternalAccount>> {
+  retrieve(externalAccountId: string, options?: Core.RequestOptions): Core.APIPromise<ExternalAccount> {
     return this.get(`/external_accounts/${externalAccountId}`, options);
   }
 
@@ -34,7 +28,7 @@ export class ExternalAccounts extends APIResource {
     externalAccountId: string,
     body: ExternalAccountUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<ExternalAccount>> {
+  ): Core.APIPromise<ExternalAccount> {
     return this.patch(`/external_accounts/${externalAccountId}`, { body, ...options });
   }
 
@@ -44,12 +38,12 @@ export class ExternalAccounts extends APIResource {
   list(
     query?: ExternalAccountListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ExternalAccountsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<ExternalAccountsPage>;
+  ): Core.PagePromise<ExternalAccountsPage, ExternalAccount>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ExternalAccountsPage, ExternalAccount>;
   list(
     query: ExternalAccountListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ExternalAccountsPage> {
+  ): Core.PagePromise<ExternalAccountsPage, ExternalAccount> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/files.ts

@@ -13,26 +13,26 @@ export class Files extends APIResource {
    * `multipart/form-data`. The request should contain the file you would like to
    * upload, as well as the parameters for creating a file.
    */
-  async create(body: FileCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<File>> {
-    return this.post('/files', await multipartFormRequestOptions({ body, ...options }));
+  create(body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<File> {
+    return this.post('/files', multipartFormRequestOptions({ body, ...options }));
   }
 
   /**
    * Retrieve a File
    */
-  retrieve(fileId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<File>> {
+  retrieve(fileId: string, options?: Core.RequestOptions): Core.APIPromise<File> {
     return this.get(`/files/${fileId}`, options);
   }
 
   /**
    * List Files
    */
-  list(query?: FileListParams, options?: Core.RequestOptions): Core.PagePromise<FilesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<FilesPage>;
+  list(query?: FileListParams, options?: Core.RequestOptions): Core.PagePromise<FilesPage, File>;
+  list(options?: Core.RequestOptions): Core.PagePromise<FilesPage, File>;
   list(
     query: FileListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<FilesPage> {
+  ): Core.PagePromise<FilesPage, File> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
@@ -92,6 +92,7 @@ export interface File {
    * - `check_image_front` - An image of the front of a check, used for check
    *   deposits.
    * - `check_image_back` - An image of the back of a check, used for check deposits.
+   * - `mailed_check_image` - An image of a check that was mailed to a recipient.
    * - `form_1099_int` - IRS Form 1099-INT.
    * - `form_ss_4` - IRS Form SS-4.
    * - `identity_document` - An image of a government-issued ID.
@@ -116,6 +117,7 @@ export interface File {
   purpose:
     | 'check_image_front'
     | 'check_image_back'
+    | 'mailed_check_image'
     | 'form_1099_int'
     | 'form_ss_4'
     | 'identity_document'
@@ -152,6 +154,7 @@ export interface FileCreateParams {
    * - `check_image_front` - An image of the front of a check, used for check
    *   deposits.
    * - `check_image_back` - An image of the back of a check, used for check deposits.
+   * - `mailed_check_image` - An image of a check that was mailed to a recipient.
    * - `form_ss_4` - IRS Form SS-4.
    * - `identity_document` - An image of a government-issued ID.
    * - `other` - A file purpose not covered by any of the other cases.
@@ -172,6 +175,7 @@ export interface FileCreateParams {
   purpose:
     | 'check_image_front'
     | 'check_image_back'
+    | 'mailed_check_image'
     | 'form_ss_4'
     | 'identity_document'
     | 'other'
@@ -230,6 +234,7 @@ export namespace FileListParams {
     in?: Array<
       | 'check_image_front'
       | 'check_image_back'
+      | 'mailed_check_image'
       | 'form_1099_int'
       | 'form_ss_4'
       | 'identity_document'

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): Promise<Core.APIResponse<Group>> {
+  retrieveDetails(options?: Core.RequestOptions): Core.APIPromise<Group> {
     return this.get('/groups/current', options);
   }
 }

package/src/resources/inbound-ach-transfer-returns.ts

@@ -13,7 +13,7 @@ export class InboundACHTransferReturns extends APIResource {
   create(
     body: InboundACHTransferReturnCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<InboundACHTransferReturn>> {
+  ): Core.APIPromise<InboundACHTransferReturn> {
     return this.post('/inbound_ach_transfer_returns', { body, ...options });
   }
 
@@ -23,7 +23,7 @@ export class InboundACHTransferReturns extends APIResource {
   retrieve(
     inboundACHTransferReturnId: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<InboundACHTransferReturn>> {
+  ): Core.APIPromise<InboundACHTransferReturn> {
     return this.get(`/inbound_ach_transfer_returns/${inboundACHTransferReturnId}`, options);
   }
 
@@ -33,12 +33,14 @@ export class InboundACHTransferReturns extends APIResource {
   list(
     query?: InboundACHTransferReturnListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<InboundACHTransferReturnsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<InboundACHTransferReturnsPage>;
+  ): Core.PagePromise<InboundACHTransferReturnsPage, InboundACHTransferReturn>;
+  list(
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InboundACHTransferReturnsPage, InboundACHTransferReturn>;
   list(
     query: InboundACHTransferReturnListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<InboundACHTransferReturnsPage> {
+  ): Core.PagePromise<InboundACHTransferReturnsPage, InboundACHTransferReturn> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

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

@@ -13,7 +13,7 @@ export class InboundWireDrawdownRequests extends APIResource {
   retrieve(
     inboundWireDrawdownRequestId: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<InboundWireDrawdownRequest>> {
+  ): Core.APIPromise<InboundWireDrawdownRequest> {
     return this.get(`/inbound_wire_drawdown_requests/${inboundWireDrawdownRequestId}`, options);
   }
 
@@ -23,12 +23,14 @@ export class InboundWireDrawdownRequests extends APIResource {
   list(
     query?: InboundWireDrawdownRequestListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<InboundWireDrawdownRequestsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<InboundWireDrawdownRequestsPage>;
+  ): Core.PagePromise<InboundWireDrawdownRequestsPage, InboundWireDrawdownRequest>;
+  list(
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InboundWireDrawdownRequestsPage, InboundWireDrawdownRequest>;
   list(
     query: InboundWireDrawdownRequestListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<InboundWireDrawdownRequestsPage> {
+  ): Core.PagePromise<InboundWireDrawdownRequestsPage, InboundWireDrawdownRequest> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/limits.ts

@@ -10,37 +10,33 @@ export class Limits extends APIResource {
   /**
    * Create a Limit
    */
-  create(body: LimitCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Limit>> {
+  create(body: LimitCreateParams, options?: Core.RequestOptions): Core.APIPromise<Limit> {
     return this.post('/limits', { body, ...options });
   }
 
   /**
    * Retrieve a Limit
    */
-  retrieve(limitId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Limit>> {
+  retrieve(limitId: string, options?: Core.RequestOptions): Core.APIPromise<Limit> {
     return this.get(`/limits/${limitId}`, options);
   }
 
   /**
    * Update a Limit
    */
-  update(
-    limitId: string,
-    body: LimitUpdateParams,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<Limit>> {
+  update(limitId: string, body: LimitUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Limit> {
     return this.patch(`/limits/${limitId}`, { body, ...options });
   }
 
   /**
    * List Limits
    */
-  list(query?: LimitListParams, options?: Core.RequestOptions): Core.PagePromise<LimitsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<LimitsPage>;
+  list(query?: LimitListParams, options?: Core.RequestOptions): Core.PagePromise<LimitsPage, Limit>;
+  list(options?: Core.RequestOptions): Core.PagePromise<LimitsPage, Limit>;
   list(
     query: LimitListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<LimitsPage> {
+  ): Core.PagePromise<LimitsPage, Limit> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/oauth-connections.ts

@@ -10,10 +10,7 @@ export class OauthConnections extends APIResource {
   /**
    * Retrieve an OAuth Connection
    */
-  retrieve(
-    oauthConnectionId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<OauthConnection>> {
+  retrieve(oauthConnectionId: string, options?: Core.RequestOptions): Core.APIPromise<OauthConnection> {
     return this.get(`/oauth_connections/${oauthConnectionId}`, options);
   }
 
@@ -23,12 +20,12 @@ export class OauthConnections extends APIResource {
   list(
     query?: OauthConnectionListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<OauthConnectionsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<OauthConnectionsPage>;
+  ): Core.PagePromise<OauthConnectionsPage, OauthConnection>;
+  list(options?: Core.RequestOptions): Core.PagePromise<OauthConnectionsPage, OauthConnection>;
   list(
     query: OauthConnectionListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<OauthConnectionsPage> {
+  ): Core.PagePromise<OauthConnectionsPage, OauthConnection> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }