increase 0.5.0 → 0.6.0

package/resources/events.d.ts

@@ -0,0 +1,271 @@
+import * as Core from 'increase/core';
+import { APIResource } from 'increase/resource';
+import * as API from './index.js';
+import { Page, PageParams } from 'increase/pagination';
+export declare class Events extends APIResource {
+  /**
+   * Retrieve an Event
+   */
+  retrieve(eventId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Event>>;
+  /**
+   * List Events
+   */
+  list(query?: EventListParams, options?: Core.RequestOptions): Core.PagePromise<EventsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<EventsPage>;
+}
+export declare 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.
+ */
+export interface Event {
+  /**
+   * The Event identifier.
+   */
+  id: string;
+  /**
+   * The identifier of the object that generated this Event.
+   */
+  associated_object_id: string;
+  /**
+   * The type of the object that generated this Event.
+   */
+  associated_object_type: string;
+  /**
+   * The category of the Event. We may add additional possible values for this enum
+   * over time; your application should be able to handle such additions gracefully.
+   *
+   * - `account.created` - Occurs whenever an Account is created.
+   * - `account.updated` - Occurs whenever an Account is updated.
+   * - `account_number.created` - Occurs whenever an Account Number is created.
+   * - `account_number.updated` - Occurs whenever an Account Number is updated.
+   * - `account_statement.created` - Occurs whenever an Account Statement is created.
+   * - `account_transfer.created` - Occurs whenever an Account Transfer is created.
+   * - `account_transfer.updated` - Occurs whenever an Account Transfer is updated.
+   * - `ach_prenotification.created` - Occurs whenever an ACH Prenotification is
+   *   created.
+   * - `ach_prenotification.updated` - Occurs whenever an ACH Prenotification is
+   *   updated.
+   * - `ach_transfer.created` - Occurs whenever an ACH Transfer is created.
+   * - `ach_transfer.updated` - Occurs whenever an ACH Transfer is updated.
+   * - `card.created` - Occurs whenever a Card is created.
+   * - `card.updated` - Occurs whenever a Card is updated.
+   * - `card_payment.created` - Occurs whenever a Card Payment is created.
+   * - `card_payment.updated` - Occurs whenever a Card Payment is updated.
+   * - `card_dispute.created` - Occurs whenever a Card Dispute is created.
+   * - `card_dispute.updated` - Occurs whenever a Card Dispute is updated.
+   * - `check_deposit.created` - Occurs whenever a Check Deposit is created.
+   * - `check_deposit.updated` - Occurs whenever a Check Deposit is updated.
+   * - `check_transfer.created` - Occurs whenever a Check Transfer is created.
+   * - `check_transfer.updated` - Occurs whenever a Check Transfer is updated.
+   * - `declined_transaction.created` - Occurs whenever a Declined Transaction is
+   *   created.
+   * - `digital_wallet_token.created` - Occurs whenever a Digital Wallet Token is
+   *   created.
+   * - `digital_wallet_token.updated` - Occurs whenever a Digital Wallet Token is
+   *   updated.
+   * - `document.created` - Occurs whenever a Document is created.
+   * - `entity.created` - Occurs whenever an Entity is created.
+   * - `entity.updated` - Occurs whenever an Entity is updated.
+   * - `external_account.created` - Occurs whenever an External Account is created.
+   * - `file.created` - Occurs whenever a File is created.
+   * - `group.updated` - Occurs whenever a Group is updated.
+   * - `group.heartbeat` - Increase may send webhooks with this category to see if a
+   *   webhook endpoint is working properly.
+   * - `inbound_ach_transfer_return.created` - Occurs whenever an Inbound ACH
+   *   Transfer Return is created.
+   * - `inbound_ach_transfer_return.updated` - Occurs whenever an Inbound ACH
+   *   Transfer Return is updated.
+   * - `inbound_wire_drawdown_request.created` - Occurs whenever an Inbound Wire
+   *   Drawdown Request is created.
+   * - `oauth_connection.created` - Occurs whenever an OAuth Connection is created.
+   * - `oauth_connection.deactivated` - Occurs whenever an OAuth Connection is
+   *   deactivated.
+   * - `pending_transaction.created` - Occurs whenever a Pending Transaction is
+   *   created.
+   * - `pending_transaction.updated` - Occurs whenever a Pending Transaction is
+   *   updated.
+   * - `real_time_decision.card_authorization_requested` - Occurs whenever a
+   *   Real-Time Decision is created in response to a card authorization.
+   * - `real_time_decision.digital_wallet_token_requested` - Occurs whenever a
+   *   Real-Time Decision is created in response to a digital wallet provisioning
+   *   attempt.
+   * - `real_time_decision.digital_wallet_authentication_requested` - Occurs whenever
+   *   a Real-Time Decision is created in response to a digital wallet requiring
+   *   two-factor authentication.
+   * - `real_time_payments_transfer.created` - Occurs whenever a Real Time Payments
+   *   Transfer is created.
+   * - `real_time_payments_transfer.updated` - Occurs whenever a Real Time Payments
+   *   Transfer is updated.
+   * - `real_time_payments_request_for_payment.created` - Occurs whenever a Real Time
+   *   Payments Request for Payment is created.
+   * - `real_time_payments_request_for_payment.updated` - Occurs whenever a Real Time
+   *   Payments Request for Payment is updated.
+   * - `transaction.created` - Occurs whenever a Transaction is updated.
+   * - `wire_drawdown_request.created` - Occurs whenever a Wire Drawdown Request is
+   *   created.
+   * - `wire_drawdown_request.updated` - Occurs whenever a Wire Drawdown Request is
+   *   updated.
+   * - `wire_transfer.created` - Occurs whenever a Wire Transfer is created.
+   * - `wire_transfer.updated` - Occurs whenever a Wire Transfer is updated.
+   */
+  category:
+    | 'account.created'
+    | 'account.updated'
+    | 'account_number.created'
+    | 'account_number.updated'
+    | 'account_statement.created'
+    | 'account_transfer.created'
+    | 'account_transfer.updated'
+    | 'ach_prenotification.created'
+    | 'ach_prenotification.updated'
+    | 'ach_transfer.created'
+    | 'ach_transfer.updated'
+    | 'card.created'
+    | 'card.updated'
+    | 'card_payment.created'
+    | 'card_payment.updated'
+    | 'card_dispute.created'
+    | 'card_dispute.updated'
+    | 'check_deposit.created'
+    | 'check_deposit.updated'
+    | 'check_transfer.created'
+    | 'check_transfer.updated'
+    | 'declined_transaction.created'
+    | 'digital_wallet_token.created'
+    | 'digital_wallet_token.updated'
+    | 'document.created'
+    | 'entity.created'
+    | 'entity.updated'
+    | 'external_account.created'
+    | 'file.created'
+    | 'group.updated'
+    | 'group.heartbeat'
+    | 'inbound_ach_transfer_return.created'
+    | 'inbound_ach_transfer_return.updated'
+    | 'inbound_wire_drawdown_request.created'
+    | 'oauth_connection.created'
+    | 'oauth_connection.deactivated'
+    | 'pending_transaction.created'
+    | 'pending_transaction.updated'
+    | 'real_time_decision.card_authorization_requested'
+    | 'real_time_decision.digital_wallet_token_requested'
+    | 'real_time_decision.digital_wallet_authentication_requested'
+    | 'real_time_payments_transfer.created'
+    | 'real_time_payments_transfer.updated'
+    | 'real_time_payments_request_for_payment.created'
+    | 'real_time_payments_request_for_payment.updated'
+    | 'transaction.created'
+    | 'wire_drawdown_request.created'
+    | 'wire_drawdown_request.updated'
+    | 'wire_transfer.created'
+    | 'wire_transfer.updated';
+  /**
+   * The time the Event was created.
+   */
+  created_at: string;
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `event`.
+   */
+  type: 'event';
+}
+export interface EventListParams extends PageParams {
+  /**
+   * Filter Events to those belonging to the object with the provided identifier.
+   */
+  associated_object_id?: string;
+  category?: EventListParams.Category;
+  created_at?: EventListParams.CreatedAt;
+}
+export declare namespace EventListParams {
+  interface Category {
+    /**
+     * Filter Events for those with the specified category or categories. For GET
+     * requests, this should be encoded as a comma-delimited string, such as
+     * `?in=one,two,three`.
+     */
+    in?: Array<
+      | 'account.created'
+      | 'account.updated'
+      | 'account_number.created'
+      | 'account_number.updated'
+      | 'account_statement.created'
+      | 'account_transfer.created'
+      | 'account_transfer.updated'
+      | 'ach_prenotification.created'
+      | 'ach_prenotification.updated'
+      | 'ach_transfer.created'
+      | 'ach_transfer.updated'
+      | 'card.created'
+      | 'card.updated'
+      | 'card_payment.created'
+      | 'card_payment.updated'
+      | 'card_dispute.created'
+      | 'card_dispute.updated'
+      | 'check_deposit.created'
+      | 'check_deposit.updated'
+      | 'check_transfer.created'
+      | 'check_transfer.updated'
+      | 'declined_transaction.created'
+      | 'digital_wallet_token.created'
+      | 'digital_wallet_token.updated'
+      | 'document.created'
+      | 'entity.created'
+      | 'entity.updated'
+      | 'external_account.created'
+      | 'file.created'
+      | 'group.updated'
+      | 'group.heartbeat'
+      | 'inbound_ach_transfer_return.created'
+      | 'inbound_ach_transfer_return.updated'
+      | 'inbound_wire_drawdown_request.created'
+      | 'oauth_connection.created'
+      | 'oauth_connection.deactivated'
+      | 'pending_transaction.created'
+      | 'pending_transaction.updated'
+      | 'real_time_decision.card_authorization_requested'
+      | 'real_time_decision.digital_wallet_token_requested'
+      | 'real_time_decision.digital_wallet_authentication_requested'
+      | 'real_time_payments_transfer.created'
+      | 'real_time_payments_transfer.updated'
+      | 'real_time_payments_request_for_payment.created'
+      | 'real_time_payments_request_for_payment.updated'
+      | 'transaction.created'
+      | 'wire_drawdown_request.created'
+      | 'wire_drawdown_request.updated'
+      | 'wire_transfer.created'
+      | 'wire_transfer.updated'
+    >;
+  }
+  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;
+  }
+}
+export declare namespace Events {
+  export import Event = API.Event;
+  type EventsPage = _EventsPage;
+  export import EventListParams = API.EventListParams;
+}
+export {};
+//# sourceMappingURL=events.d.ts.map

package/resources/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/resources/events.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,GAAG,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEvD,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAI1F;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;IAC1F,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;CAUlE;AAED,qBAAa,UAAW,SAAQ,IAAI,CAAC,KAAK,CAAC;CAAG;AAE9C,KAAK,WAAW,GAAG,UAAU,CAAC;AAE9B;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6EG;IACH,QAAQ,EACJ,iBAAiB,GACjB,iBAAiB,GACjB,wBAAwB,GACxB,wBAAwB,GACxB,2BAA2B,GAC3B,0BAA0B,GAC1B,0BAA0B,GAC1B,6BAA6B,GAC7B,6BAA6B,GAC7B,sBAAsB,GACtB,sBAAsB,GACtB,cAAc,GACd,cAAc,GACd,sBAAsB,GACtB,sBAAsB,GACtB,sBAAsB,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,GACxB,wBAAwB,GACxB,8BAA8B,GAC9B,8BAA8B,GAC9B,8BAA8B,GAC9B,kBAAkB,GAClB,gBAAgB,GAChB,gBAAgB,GAChB,0BAA0B,GAC1B,cAAc,GACd,eAAe,GACf,iBAAiB,GACjB,qCAAqC,GACrC,qCAAqC,GACrC,uCAAuC,GACvC,0BAA0B,GAC1B,8BAA8B,GAC9B,6BAA6B,GAC7B,6BAA6B,GAC7B,iDAAiD,GACjD,mDAAmD,GACnD,4DAA4D,GAC5D,qCAAqC,GACrC,qCAAqC,GACrC,gDAAgD,GAChD,gDAAgD,GAChD,qBAAqB,GACrB,+BAA+B,GAC/B,+BAA+B,GAC/B,uBAAuB,GACvB,uBAAuB,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,QAAQ,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC;IAEpC,UAAU,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC;CACxC;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,QAAQ;QACvB;;;;WAIG;QACH,EAAE,CAAC,EAAE,KAAK,CACN,iBAAiB,GACjB,iBAAiB,GACjB,wBAAwB,GACxB,wBAAwB,GACxB,2BAA2B,GAC3B,0BAA0B,GAC1B,0BAA0B,GAC1B,6BAA6B,GAC7B,6BAA6B,GAC7B,sBAAsB,GACtB,sBAAsB,GACtB,cAAc,GACd,cAAc,GACd,sBAAsB,GACtB,sBAAsB,GACtB,sBAAsB,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,GACxB,wBAAwB,GACxB,8BAA8B,GAC9B,8BAA8B,GAC9B,8BAA8B,GAC9B,kBAAkB,GAClB,gBAAgB,GAChB,gBAAgB,GAChB,0BAA0B,GAC1B,cAAc,GACd,eAAe,GACf,iBAAiB,GACjB,qCAAqC,GACrC,qCAAqC,GACrC,uCAAuC,GACvC,0BAA0B,GAC1B,8BAA8B,GAC9B,6BAA6B,GAC7B,6BAA6B,GAC7B,iDAAiD,GACjD,mDAAmD,GACnD,4DAA4D,GAC5D,qCAAqC,GACrC,qCAAqC,GACrC,gDAAgD,GAChD,gDAAgD,GAChD,qBAAqB,GACrB,+BAA+B,GAC/B,+BAA+B,GAC/B,uBAAuB,GACvB,uBAAuB,CAC1B,CAAC;KACH;IAED,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;CACF;AAED,yBAAiB,MAAM,CAAC;IACtB,MAAM,QAAQ,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAChC,KAAY,UAAU,GAAG,WAAW,CAAC;IACrC,MAAM,QAAQ,eAAe,GAAG,GAAG,CAAC,eAAe,CAAC;CACrD"}

package/resources/events.js

@@ -0,0 +1,26 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.EventsPage = exports.Events = void 0;
+const resource_1 = require('increase/resource');
+const core_1 = require('increase/core');
+const pagination_1 = require('increase/pagination');
+class Events extends resource_1.APIResource {
+  /**
+   * Retrieve an Event
+   */
+  retrieve(eventId, options) {
+    return this.get(`/events/${eventId}`, options);
+  }
+  list(query = {}, options) {
+    if ((0, core_1.isRequestOptions)(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/events', EventsPage, { query, ...options });
+  }
+}
+exports.Events = Events;
+class EventsPage extends pagination_1.Page {}
+exports.EventsPage = EventsPage;
+(function (Events) {})((Events = exports.Events || (exports.Events = {})));
+//# sourceMappingURL=events.js.map

package/resources/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/resources/events.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,gDAAgD;AAChD,wCAAiD;AAEjD,oDAAuD;AAEvD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAOD,IAAI,CACF,QAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AAtBD,wBAsBC;AAED,MAAa,UAAW,SAAQ,iBAAW;CAAG;AAA9C,gCAA8C;AAyQ9C,WAAiB,MAAM;AAIvB,CAAC,EAJgB,MAAM,GAAN,cAAM,KAAN,cAAM,QAItB"}

package/resources/events.mjs

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from 'increase/resource';
+import { isRequestOptions } from 'increase/core';
+import { Page } from 'increase/pagination';
+export class Events extends APIResource {
+  /**
+   * Retrieve an Event
+   */
+  retrieve(eventId, options) {
+    return this.get(`/events/${eventId}`, options);
+  }
+  list(query = {}, options) {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/events', EventsPage, { query, ...options });
+  }
+}
+export class EventsPage extends Page {}
+(function (Events) {})(Events || (Events = {}));
+//# sourceMappingURL=events.mjs.map

package/resources/events.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.mjs","sourceRoot":"","sources":["../src/resources/events.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,mBAAmB;OACxC,EAAE,gBAAgB,EAAE,MAAM,eAAe;OAEzC,EAAE,IAAI,EAAc,MAAM,qBAAqB;AAEtD,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAOD,IAAI,CACF,QAA+C,EAAE,EACjD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AAED,MAAM,OAAO,UAAW,SAAQ,IAAW;CAAG;AAyQ9C,WAAiB,MAAM;AAIvB,CAAC,EAJgB,MAAM,KAAN,MAAM,QAItB"}

package/resources/exports.d.ts

@@ -0,0 +1,182 @@
+import * as Core from 'increase/core';
+import { APIResource } from 'increase/resource';
+import * as API from './index.js';
+import { Page, PageParams } from 'increase/pagination';
+export declare class Exports extends APIResource {
+  /**
+   * Create an Export
+   */
+  create(body: ExportCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Export>>;
+  /**
+   * Retrieve an Export
+   */
+  retrieve(exportId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Export>>;
+  /**
+   * List Exports
+   */
+  list(query?: ExportListParams, options?: Core.RequestOptions): Core.PagePromise<ExportsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ExportsPage>;
+}
+export declare class ExportsPage extends Page<Export> {}
+type _ExportsPage = ExportsPage;
+/**
+ * Exports are batch summaries of your Increase data. You can make them from the
+ * API or dashboard. Since they can take a while, they are generated
+ * asynchronously. We send a webhook when they are ready. For more information,
+ * please read our
+ * [Exports documentation](https://increase.com/documentation/exports).
+ */
+export interface Export {
+  /**
+   * The Export identifier.
+   */
+  id: string;
+  /**
+   * The category of the Export. We may add additional possible values for this enum
+   * over time; your application should be able to handle that gracefully.
+   *
+   * - `transaction_csv` - Export a CSV of all transactions for a given time range.
+   * - `balance_csv` - Export a CSV of account balances for the dates in a given
+   *   range.
+   */
+  category: 'transaction_csv' | 'balance_csv';
+  /**
+   * The time the Export was created.
+   */
+  created_at: string;
+  /**
+   * A URL at which the Export's file can be downloaded. This will be present when
+   * the Export's status transitions to `complete`.
+   */
+  file_download_url: string | null;
+  /**
+   * The File containing the contents of the Export. This will be present when the
+   * Export's status transitions to `complete`.
+   */
+  file_id: string | null;
+  /**
+   * The status of the Export.
+   *
+   * - `pending` - Increase is generating the export.
+   * - `complete` - The export has been successfully generated.
+   */
+  status: 'pending' | 'complete';
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `export`.
+   */
+  type: 'export';
+}
+export interface ExportCreateParams {
+  /**
+   * The type of Export to create.
+   *
+   * - `transaction_csv` - Export a CSV of all transactions for a given time range.
+   * - `balance_csv` - Export a CSV of account balances for the dates in a given
+   *   range.
+   */
+  category: 'transaction_csv' | 'balance_csv';
+  /**
+   * Options for the created export. Required if `category` is equal to
+   * `balance_csv`.
+   */
+  balance_csv?: ExportCreateParams.BalanceCsv;
+  /**
+   * Options for the created export. Required if `category` is equal to
+   * `transaction_csv`.
+   */
+  transaction_csv?: ExportCreateParams.TransactionCsv;
+}
+export declare namespace ExportCreateParams {
+  /**
+   * Options for the created export. Required if `category` is equal to
+   * `balance_csv`.
+   */
+  interface BalanceCsv {
+    /**
+     * Filter exported Transactions to the specified Account.
+     */
+    account_id?: string;
+    /**
+     * Filter results by time range on the `created_at` attribute.
+     */
+    created_at?: BalanceCsv.CreatedAt;
+  }
+  namespace BalanceCsv {
+    /**
+     * Filter results by time range on the `created_at` attribute.
+     */
+    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;
+    }
+  }
+  /**
+   * Options for the created export. Required if `category` is equal to
+   * `transaction_csv`.
+   */
+  interface TransactionCsv {
+    /**
+     * Filter exported Transactions to the specified Account.
+     */
+    account_id?: string;
+    /**
+     * Filter results by time range on the `created_at` attribute.
+     */
+    created_at?: TransactionCsv.CreatedAt;
+  }
+  namespace TransactionCsv {
+    /**
+     * Filter results by time range on the `created_at` attribute.
+     */
+    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;
+    }
+  }
+}
+export interface ExportListParams extends PageParams {}
+export declare namespace Exports {
+  export import Export = API.Export;
+  type ExportsPage = _ExportsPage;
+  export import ExportCreateParams = API.ExportCreateParams;
+  export import ExportListParams = API.ExportListParams;
+}
+export {};
+//# sourceMappingURL=exports.d.ts.map

package/resources/exports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../src/resources/exports.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,GAAG,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEvD,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAIlG;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAI5F;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;IAC5F,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;CAUnE;AAED,qBAAa,WAAY,SAAQ,IAAI,CAAC,MAAM,CAAC;CAAG;AAEhD,KAAK,YAAY,GAAG,WAAW,CAAC;AAEhC;;;;;;GAMG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;;OAOG;IACH,QAAQ,EAAE,iBAAiB,GAAG,aAAa,CAAC;IAE5C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;;OAKG;IACH,MAAM,EAAE,SAAS,GAAG,UAAU,CAAC;IAE/B;;;OAGG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;;OAMG;IACH,QAAQ,EAAE,iBAAiB,GAAG,aAAa,CAAC;IAE5C;;;OAGG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAE5C;;;OAGG;IACH,eAAe,CAAC,EAAE,kBAAkB,CAAC,cAAc,CAAC;CACrD;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC;KACnC;IAED,UAAiB,UAAU,CAAC;QAC1B;;WAEG;QACH,UAAiB,SAAS;YACxB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;;eAGG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;KACF;IAED;;;OAGG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC;KACvC;IAED,UAAiB,cAAc,CAAC;QAC9B;;WAEG;QACH,UAAiB,SAAS;YACxB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;;eAGG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;;eAGG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;KACF;CACF;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;CAAG;AAEvD,yBAAiB,OAAO,CAAC;IACvB,MAAM,QAAQ,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAClC,KAAY,WAAW,GAAG,YAAY,CAAC;IACvC,MAAM,QAAQ,kBAAkB,GAAG,GAAG,CAAC,kBAAkB,CAAC;IAC1D,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;CACvD"}

package/resources/exports.js

@@ -0,0 +1,32 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.ExportsPage = exports.Exports = void 0;
+const resource_1 = require('increase/resource');
+const core_1 = require('increase/core');
+const pagination_1 = require('increase/pagination');
+class Exports extends resource_1.APIResource {
+  /**
+   * Create an Export
+   */
+  create(body, options) {
+    return this.post('/exports', { body, ...options });
+  }
+  /**
+   * Retrieve an Export
+   */
+  retrieve(exportId, options) {
+    return this.get(`/exports/${exportId}`, options);
+  }
+  list(query = {}, options) {
+    if ((0, core_1.isRequestOptions)(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/exports', ExportsPage, { query, ...options });
+  }
+}
+exports.Exports = Exports;
+class ExportsPage extends pagination_1.Page {}
+exports.ExportsPage = ExportsPage;
+(function (Exports) {})((Exports = exports.Exports || (exports.Exports = {})));
+//# sourceMappingURL=exports.js.map

package/resources/exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.js","sourceRoot":"","sources":["../src/resources/exports.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,gDAAgD;AAChD,wCAAiD;AAEjD,oDAAuD;AAEvD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAOD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AA7BD,0BA6BC;AAED,MAAa,WAAY,SAAQ,iBAAY;CAAG;AAAhD,kCAAgD;AAoLhD,WAAiB,OAAO;AAKxB,CAAC,EALgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAKvB"}

package/resources/exports.mjs

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from 'increase/resource';
+import { isRequestOptions } from 'increase/core';
+import { Page } from 'increase/pagination';
+export class Exports extends APIResource {
+  /**
+   * Create an Export
+   */
+  create(body, options) {
+    return this.post('/exports', { body, ...options });
+  }
+  /**
+   * Retrieve an Export
+   */
+  retrieve(exportId, options) {
+    return this.get(`/exports/${exportId}`, options);
+  }
+  list(query = {}, options) {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/exports', ExportsPage, { query, ...options });
+  }
+}
+export class ExportsPage extends Page {}
+(function (Exports) {})(Exports || (Exports = {}));
+//# sourceMappingURL=exports.mjs.map

package/resources/exports.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.mjs","sourceRoot":"","sources":["../src/resources/exports.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,mBAAmB;OACxC,EAAE,gBAAgB,EAAE,MAAM,eAAe;OAEzC,EAAE,IAAI,EAAc,MAAM,qBAAqB;AAEtD,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAOD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,IAAY;CAAG;AAoLhD,WAAiB,OAAO;AAKxB,CAAC,EALgB,OAAO,KAAP,OAAO,QAKvB"}