increase 0.11.0 → 0.11.2

package/resources/files.d.ts

@@ -1,26 +1,27 @@
 import * as Core from 'increase/core';
 import { APIResource } from 'increase/resource';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { type Uploadable } from 'increase/core';
 import { Page, PageParams } from 'increase/pagination';
 export declare class Files extends APIResource {
-  /**
-   * To upload a file to Increase, you'll need to send a request of Content-Type
-   * `multipart/form-data`. The request should contain the file you would like to
-   * upload, as well as the parameters for creating a file.
-   */
-  create(body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<File>;
-  /**
-   * Retrieve a File
-   */
-  retrieve(fileId: string, options?: Core.RequestOptions): Core.APIPromise<File>;
-  /**
-   * List Files
-   */
-  list(query?: FileListParams, options?: Core.RequestOptions): Core.PagePromise<FilesPage, File>;
-  list(options?: Core.RequestOptions): Core.PagePromise<FilesPage, File>;
+    /**
+     * To upload a file to Increase, you'll need to send a request of Content-Type
+     * `multipart/form-data`. The request should contain the file you would like to
+     * upload, as well as the parameters for creating a file.
+     */
+    create(body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<File>;
+    /**
+     * Retrieve a File
+     */
+    retrieve(fileId: string, options?: Core.RequestOptions): Core.APIPromise<File>;
+    /**
+     * List Files
+     */
+    list(query?: FileListParams, options?: Core.RequestOptions): Core.PagePromise<FilesPage, File>;
+    list(options?: Core.RequestOptions): Core.PagePromise<FilesPage, File>;
+}
+export declare class FilesPage extends Page<File> {
 }
-export declare class FilesPage extends Page<File> {}
 type _FilesPage = FilesPage;
 /**
  * Files are objects that represent a file hosted on Increase's servers. The file
@@ -28,196 +29,148 @@ type _FilesPage = FilesPage;
  * may have been created by Increase (for example, an autogenerated statement PDF).
  */
 export interface File {
-  /**
-   * The File's identifier.
-   */
-  id: string;
-  /**
-   * The time the File was created.
-   */
-  created_at: string;
-  /**
-   * A description of the File.
-   */
-  description: string | null;
-  /**
-   * Whether the File was generated by Increase or by you and sent to Increase.
-   *
-   * - `to_increase` - This File was sent by you to Increase.
-   * - `from_increase` - This File was generated by Increase.
-   */
-  direction: 'to_increase' | 'from_increase';
-  /**
-   * A URL from where the File can be downloaded at this point in time. The location
-   * of this URL may change over time.
-   */
-  download_url: string | null;
-  /**
-   * The filename that was provided upon upload or generated by Increase.
-   */
-  filename: string | null;
-  /**
-   * What the File will be used for. We may add additional possible values for this
-   * enum over time; your application should be able to handle such additions
-   * gracefully.
-   *
-   * - `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.
-   * - `increase_statement` - A statement generated by Increase.
-   * - `other` - A file purpose not covered by any of the other cases.
-   * - `trust_formation_document` - A legal document forming a trust.
-   * - `digital_wallet_artwork` - A card image to be rendered inside digital wallet
-   *   apps. This must be a 1536x969 pixel PNG.
-   * - `digital_wallet_app_icon` - An icon for you app to be rendered inside digital
-   *   wallet apps. This must be a 100x100 pixel PNG.
-   * - `physical_card_front` - A card image to be printed on the front of a physical
-   *   card. This must be a 2100x1340 pixel PNG with no other color but black.
-   * - `physical_card_back` - The image to be printed on the back of a physical card.
-   * - `physical_card_carrier` - An image representing the entirety of the carrier
-   *   used for a physical card. This must be a 2550x3300 pixel PNG with no other
-   *   color but black.
-   * - `document_request` - A document requested by Increase.
-   * - `entity_supplemental_document` - A supplemental document associated an an
-   *   Entity.
-   * - `export` - The results of an Export you requested via the dashboard or API.
-   */
-  purpose:
-    | 'check_image_front'
-    | 'check_image_back'
-    | 'mailed_check_image'
-    | 'form_1099_int'
-    | 'form_ss_4'
-    | 'identity_document'
-    | 'increase_statement'
-    | 'other'
-    | 'trust_formation_document'
-    | 'digital_wallet_artwork'
-    | 'digital_wallet_app_icon'
-    | 'physical_card_front'
-    | 'physical_card_back'
-    | 'physical_card_carrier'
-    | 'document_request'
-    | 'entity_supplemental_document'
-    | 'export';
-  /**
-   * A constant representing the object's type. For this resource it will always be
-   * `file`.
-   */
-  type: 'file';
-}
-export interface FileCreateParams {
-  /**
-   * The file contents. This should follow the specifications of
-   * [RFC 7578](https://datatracker.ietf.org/doc/html/rfc7578) which defines file
-   * transfers for the multipart/form-data protocol.
-   */
-  file: Uploadable;
-  /**
-   * What the File will be used for in Increase's systems.
-   *
-   * - `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.
-   * - `trust_formation_document` - A legal document forming a trust.
-   * - `digital_wallet_artwork` - A card image to be rendered inside digital wallet
-   *   apps. This must be a 1536x969 pixel PNG.
-   * - `digital_wallet_app_icon` - An icon for you app to be rendered inside digital
-   *   wallet apps. This must be a 100x100 pixel PNG.
-   * - `physical_card_front` - A card image to be printed on the front of a physical
-   *   card. This must be a 2100x1340 pixel PNG with no other color but black.
-   * - `physical_card_carrier` - An image representing the entirety of the carrier
-   *   used for a physical card. This must be a 2550x3300 pixel PNG with no other
-   *   color but black.
-   * - `document_request` - A document requested by Increase.
-   * - `entity_supplemental_document` - A supplemental document associated an an
-   *   Entity.
-   */
-  purpose:
-    | 'check_image_front'
-    | 'check_image_back'
-    | 'mailed_check_image'
-    | 'form_ss_4'
-    | 'identity_document'
-    | 'other'
-    | 'trust_formation_document'
-    | 'digital_wallet_artwork'
-    | 'digital_wallet_app_icon'
-    | 'physical_card_front'
-    | 'physical_card_carrier'
-    | 'document_request'
-    | 'entity_supplemental_document';
-  /**
-   * The description you choose to give the File.
-   */
-  description?: string;
-}
-export interface FileListParams extends PageParams {
-  created_at?: FileListParams.CreatedAt;
-  purpose?: FileListParams.Purpose;
-}
-export declare namespace FileListParams {
-  interface CreatedAt {
     /**
-     * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-     * timestamp.
+     * The File's identifier.
+     */
+    id: string;
+    /**
+     * The time the File was created.
      */
-    after?: string;
+    created_at: string;
     /**
-     * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-     * timestamp.
+     * A description of the File.
      */
-    before?: string;
+    description: string | null;
     /**
-     * Return results on or after this
-     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     * Whether the File was generated by Increase or by you and sent to Increase.
+     *
+     * - `to_increase` - This File was sent by you to Increase.
+     * - `from_increase` - This File was generated by Increase.
      */
-    on_or_after?: string;
+    direction: 'to_increase' | 'from_increase';
     /**
-     * Return results on or before this
-     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     * A URL from where the File can be downloaded at this point in time. The location
+     * of this URL may change over time.
      */
-    on_or_before?: string;
-  }
-  interface Purpose {
+    download_url: string | null;
     /**
-     * Filter Files for those with the specified purpose or purposes. For GET requests,
-     * this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+     * The filename that was provided upon upload or generated by Increase.
      */
-    in?: Array<
-      | 'check_image_front'
-      | 'check_image_back'
-      | 'mailed_check_image'
-      | 'form_1099_int'
-      | 'form_ss_4'
-      | 'identity_document'
-      | 'increase_statement'
-      | 'other'
-      | 'trust_formation_document'
-      | 'digital_wallet_artwork'
-      | 'digital_wallet_app_icon'
-      | 'physical_card_front'
-      | 'physical_card_back'
-      | 'physical_card_carrier'
-      | 'document_request'
-      | 'entity_supplemental_document'
-      | 'export'
-    >;
-  }
+    filename: string | null;
+    /**
+     * What the File will be used for. We may add additional possible values for this
+     * enum over time; your application should be able to handle such additions
+     * gracefully.
+     *
+     * - `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.
+     * - `increase_statement` - A statement generated by Increase.
+     * - `other` - A file purpose not covered by any of the other cases.
+     * - `trust_formation_document` - A legal document forming a trust.
+     * - `digital_wallet_artwork` - A card image to be rendered inside digital wallet
+     *   apps. This must be a 1536x969 pixel PNG.
+     * - `digital_wallet_app_icon` - An icon for you app to be rendered inside digital
+     *   wallet apps. This must be a 100x100 pixel PNG.
+     * - `physical_card_front` - A card image to be printed on the front of a physical
+     *   card. This must be a 2100x1340 pixel PNG with no other color but black.
+     * - `physical_card_back` - The image to be printed on the back of a physical card.
+     * - `physical_card_carrier` - An image representing the entirety of the carrier
+     *   used for a physical card. This must be a 2550x3300 pixel PNG with no other
+     *   color but black.
+     * - `document_request` - A document requested by Increase.
+     * - `entity_supplemental_document` - A supplemental document associated an an
+     *   Entity.
+     * - `export` - The results of an Export you requested via the dashboard or API.
+     */
+    purpose: 'check_image_front' | 'check_image_back' | 'mailed_check_image' | 'form_1099_int' | 'form_ss_4' | 'identity_document' | 'increase_statement' | 'other' | 'trust_formation_document' | 'digital_wallet_artwork' | 'digital_wallet_app_icon' | 'physical_card_front' | 'physical_card_back' | 'physical_card_carrier' | 'document_request' | 'entity_supplemental_document' | 'export';
+    /**
+     * A constant representing the object's type. For this resource it will always be
+     * `file`.
+     */
+    type: 'file';
+}
+export interface FileCreateParams {
+    /**
+     * The file contents. This should follow the specifications of
+     * [RFC 7578](https://datatracker.ietf.org/doc/html/rfc7578) which defines file
+     * transfers for the multipart/form-data protocol.
+     */
+    file: Uploadable;
+    /**
+     * What the File will be used for in Increase's systems.
+     *
+     * - `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.
+     * - `trust_formation_document` - A legal document forming a trust.
+     * - `digital_wallet_artwork` - A card image to be rendered inside digital wallet
+     *   apps. This must be a 1536x969 pixel PNG.
+     * - `digital_wallet_app_icon` - An icon for you app to be rendered inside digital
+     *   wallet apps. This must be a 100x100 pixel PNG.
+     * - `physical_card_front` - A card image to be printed on the front of a physical
+     *   card. This must be a 2100x1340 pixel PNG with no other color but black.
+     * - `physical_card_carrier` - An image representing the entirety of the carrier
+     *   used for a physical card. This must be a 2550x3300 pixel PNG with no other
+     *   color but black.
+     * - `document_request` - A document requested by Increase.
+     * - `entity_supplemental_document` - A supplemental document associated an an
+     *   Entity.
+     */
+    purpose: 'check_image_front' | 'check_image_back' | 'mailed_check_image' | 'form_ss_4' | 'identity_document' | 'other' | 'trust_formation_document' | 'digital_wallet_artwork' | 'digital_wallet_app_icon' | 'physical_card_front' | 'physical_card_carrier' | 'document_request' | 'entity_supplemental_document';
+    /**
+     * The description you choose to give the File.
+     */
+    description?: string;
+}
+export interface FileListParams extends PageParams {
+    created_at?: FileListParams.CreatedAt;
+    purpose?: FileListParams.Purpose;
+}
+export declare namespace FileListParams {
+    interface CreatedAt {
+        /**
+         * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+         * timestamp.
+         */
+        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;
+    }
+    interface Purpose {
+        /**
+         * Filter Files for those with the specified purpose or purposes. For GET requests,
+         * this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+         */
+        in?: Array<'check_image_front' | 'check_image_back' | 'mailed_check_image' | 'form_1099_int' | 'form_ss_4' | 'identity_document' | 'increase_statement' | 'other' | 'trust_formation_document' | 'digital_wallet_artwork' | 'digital_wallet_app_icon' | 'physical_card_front' | 'physical_card_back' | 'physical_card_carrier' | 'document_request' | 'entity_supplemental_document' | 'export'>;
+    }
 }
 export declare namespace Files {
-  export import File = API.File;
-  type FilesPage = _FilesPage;
-  export import FileCreateParams = API.FileCreateParams;
-  export import FileListParams = API.FileListParams;
+    export import File = API.File;
+    type FilesPage = _FilesPage;
+    export import FileCreateParams = API.FileCreateParams;
+    export import FileListParams = API.FileListParams;
 }
 export {};
-//# sourceMappingURL=files.d.ts.map
+//# sourceMappingURL=files.d.ts.map

package/resources/files.js

@@ -1,35 +1,37 @@
-'use strict';
+"use strict";
 // File generated from our OpenAPI spec by Stainless.
-Object.defineProperty(exports, '__esModule', { value: true });
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.FilesPage = exports.Files = void 0;
-const resource_1 = require('increase/resource');
-const core_1 = require('increase/core');
-const core_2 = require('increase/core');
-const pagination_1 = require('increase/pagination');
+const resource_1 = require("increase/resource");
+const core_1 = require("increase/core");
+const core_2 = require("increase/core");
+const pagination_1 = require("increase/pagination");
 class Files extends resource_1.APIResource {
-  /**
-   * To upload a file to Increase, you'll need to send a request of Content-Type
-   * `multipart/form-data`. The request should contain the file you would like to
-   * upload, as well as the parameters for creating a file.
-   */
-  create(body, options) {
-    return this.post('/files', (0, core_2.multipartFormRequestOptions)({ body, ...options }));
-  }
-  /**
-   * Retrieve a File
-   */
-  retrieve(fileId, options) {
-    return this.get(`/files/${fileId}`, options);
-  }
-  list(query = {}, options) {
-    if ((0, core_1.isRequestOptions)(query)) {
-      return this.list({}, query);
+    /**
+     * To upload a file to Increase, you'll need to send a request of Content-Type
+     * `multipart/form-data`. The request should contain the file you would like to
+     * upload, as well as the parameters for creating a file.
+     */
+    create(body, options) {
+        return this.post('/files', (0, core_2.multipartFormRequestOptions)({ body, ...options }));
+    }
+    /**
+     * Retrieve a File
+     */
+    retrieve(fileId, options) {
+        return this.get(`/files/${fileId}`, options);
+    }
+    list(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.list({}, query);
+        }
+        return this.getAPIList('/files', FilesPage, { query, ...options });
     }
-    return this.getAPIList('/files', FilesPage, { query, ...options });
-  }
 }
 exports.Files = Files;
-class FilesPage extends pagination_1.Page {}
+class FilesPage extends pagination_1.Page {
+}
 exports.FilesPage = FilesPage;
-(function (Files) {})((Files = exports.Files || (exports.Files = {})));
-//# sourceMappingURL=files.js.map
+(function (Files) {
+})(Files = exports.Files || (exports.Files = {}));
+//# sourceMappingURL=files.js.map

package/resources/files.mjs

@@ -4,27 +4,29 @@ import { isRequestOptions } from 'increase/core';
 import { multipartFormRequestOptions } from 'increase/core';
 import { Page } from 'increase/pagination';
 export class Files extends APIResource {
-  /**
-   * To upload a file to Increase, you'll need to send a request of Content-Type
-   * `multipart/form-data`. The request should contain the file you would like to
-   * upload, as well as the parameters for creating a file.
-   */
-  create(body, options) {
-    return this.post('/files', multipartFormRequestOptions({ body, ...options }));
-  }
-  /**
-   * Retrieve a File
-   */
-  retrieve(fileId, options) {
-    return this.get(`/files/${fileId}`, options);
-  }
-  list(query = {}, options) {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
+    /**
+     * To upload a file to Increase, you'll need to send a request of Content-Type
+     * `multipart/form-data`. The request should contain the file you would like to
+     * upload, as well as the parameters for creating a file.
+     */
+    create(body, options) {
+        return this.post('/files', multipartFormRequestOptions({ body, ...options }));
     }
-    return this.getAPIList('/files', FilesPage, { query, ...options });
-  }
+    /**
+     * Retrieve a File
+     */
+    retrieve(fileId, options) {
+        return this.get(`/files/${fileId}`, options);
+    }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this.getAPIList('/files', FilesPage, { query, ...options });
+    }
+}
+export class FilesPage extends Page {
 }
-export class FilesPage extends Page {}
-(function (Files) {})(Files || (Files = {}));
-//# sourceMappingURL=files.mjs.map
+(function (Files) {
+})(Files || (Files = {}));
+//# sourceMappingURL=files.mjs.map

package/resources/groups.d.ts

@@ -1,11 +1,11 @@
 import * as Core from 'increase/core';
 import { APIResource } from 'increase/resource';
-import * as API from './index.js';
+import * as API from "./index.js";
 export declare class Groups extends APIResource {
-  /**
-   * Returns details for the currently authenticated Group.
-   */
-  retrieveDetails(options?: Core.RequestOptions): Core.APIPromise<Group>;
+    /**
+     * Returns details for the currently authenticated Group.
+     */
+    retrieveDetails(options?: Core.RequestOptions): Core.APIPromise<Group>;
 }
 /**
  * Groups represent organizations using Increase. You can retrieve information
@@ -13,36 +13,36 @@ export declare class Groups extends APIResource {
  * retrieve information about the organizations that have granted them access.
  */
 export interface Group {
-  /**
-   * The Group identifier.
-   */
-  id: string;
-  /**
-   * If the Group is allowed to create ACH debits.
-   *
-   * - `disabled` - The Group cannot make ACH debits.
-   * - `enabled` - The Group can make ACH debits.
-   */
-  ach_debit_status: 'disabled' | 'enabled';
-  /**
-   * If the Group is activated or not.
-   *
-   * - `unactivated` - The Group is not activated.
-   * - `activated` - The Group is activated.
-   */
-  activation_status: 'unactivated' | 'activated';
-  /**
-   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group
-   * was created.
-   */
-  created_at: string;
-  /**
-   * A constant representing the object's type. For this resource it will always be
-   * `group`.
-   */
-  type: 'group';
+    /**
+     * The Group identifier.
+     */
+    id: string;
+    /**
+     * If the Group is allowed to create ACH debits.
+     *
+     * - `disabled` - The Group cannot make ACH debits.
+     * - `enabled` - The Group can make ACH debits.
+     */
+    ach_debit_status: 'disabled' | 'enabled';
+    /**
+     * If the Group is activated or not.
+     *
+     * - `unactivated` - The Group is not activated.
+     * - `activated` - The Group is activated.
+     */
+    activation_status: 'unactivated' | 'activated';
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group
+     * was created.
+     */
+    created_at: string;
+    /**
+     * A constant representing the object's type. For this resource it will always be
+     * `group`.
+     */
+    type: 'group';
 }
 export declare namespace Groups {
-  export import Group = API.Group;
+    export import Group = API.Group;
 }
-//# sourceMappingURL=groups.d.ts.map
+//# sourceMappingURL=groups.d.ts.map

package/resources/groups.js

@@ -1,16 +1,17 @@
-'use strict';
+"use strict";
 // File generated from our OpenAPI spec by Stainless.
-Object.defineProperty(exports, '__esModule', { value: true });
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.Groups = void 0;
-const resource_1 = require('increase/resource');
+const resource_1 = require("increase/resource");
 class Groups extends resource_1.APIResource {
-  /**
-   * Returns details for the currently authenticated Group.
-   */
-  retrieveDetails(options) {
-    return this.get('/groups/current', options);
-  }
+    /**
+     * Returns details for the currently authenticated Group.
+     */
+    retrieveDetails(options) {
+        return this.get('/groups/current', options);
+    }
 }
 exports.Groups = Groups;
-(function (Groups) {})((Groups = exports.Groups || (exports.Groups = {})));
-//# sourceMappingURL=groups.js.map
+(function (Groups) {
+})(Groups = exports.Groups || (exports.Groups = {}));
+//# sourceMappingURL=groups.js.map

package/resources/groups.mjs

@@ -1,12 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 import { APIResource } from 'increase/resource';
 export class Groups extends APIResource {
-  /**
-   * Returns details for the currently authenticated Group.
-   */
-  retrieveDetails(options) {
-    return this.get('/groups/current', options);
-  }
+    /**
+     * Returns details for the currently authenticated Group.
+     */
+    retrieveDetails(options) {
+        return this.get('/groups/current', options);
+    }
 }
-(function (Groups) {})(Groups || (Groups = {}));
-//# sourceMappingURL=groups.mjs.map
+(function (Groups) {
+})(Groups || (Groups = {}));
+//# sourceMappingURL=groups.mjs.map