increase 0.4.0 → 0.6.0

package/src/resources/events.ts

@@ -0,0 +1,302 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from 'increase/core';
+import { APIResource } from 'increase/resource';
+import { isRequestOptions } from 'increase/core';
+import * as API from './';
+import { Page, PageParams } from 'increase/pagination';
+
+export class Events extends APIResource {
+  /**
+   * Retrieve an Event
+   */
+  retrieve(eventId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<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 | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<EventsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/events', EventsPage, { query, ...options });
+  }
+}
+
+export class EventsPage extends Page<Event> {}
+// alias so we can export it in the namespace
+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 namespace EventListParams {
+  export 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'
+    >;
+  }
+
+  export 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 namespace Events {
+  export import Event = API.Event;
+  export type EventsPage = _EventsPage;
+  export import EventListParams = API.EventListParams;
+}

package/src/resources/exports.ts

@@ -0,0 +1,225 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from 'increase/core';
+import { APIResource } from 'increase/resource';
+import { isRequestOptions } from 'increase/core';
+import * as API from './';
+import { Page, PageParams } from 'increase/pagination';
+
+export class Exports extends APIResource {
+  /**
+   * Create an Export
+   */
+  create(body: ExportCreateParams, options?: Core.RequestOptions): Promise<Core.APIResponse<Export>> {
+    return this.post('/exports', { body, ...options });
+  }
+
+  /**
+   * Retrieve an Export
+   */
+  retrieve(exportId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<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 | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ExportsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/exports', ExportsPage, { query, ...options });
+  }
+}
+
+export class ExportsPage extends Page<Export> {}
+// alias so we can export it in the namespace
+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 namespace ExportCreateParams {
+  /**
+   * Options for the created export. Required if `category` is equal to
+   * `balance_csv`.
+   */
+  export 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;
+  }
+
+  export namespace BalanceCsv {
+    /**
+     * Filter results by time range on the `created_at` attribute.
+     */
+    export 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`.
+   */
+  export 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;
+  }
+
+  export namespace TransactionCsv {
+    /**
+     * Filter results by time range on the `created_at` attribute.
+     */
+    export 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 namespace Exports {
+  export import Export = API.Export;
+  export type ExportsPage = _ExportsPage;
+  export import ExportCreateParams = API.ExportCreateParams;
+  export import ExportListParams = API.ExportListParams;
+}