increase 0.1.0

package/resources/entities/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export { Entity, EntityCreateParams, EntityListParams, EntitiesPage } from './entities';
+export { SupplementalDocumentCreateParams } from './supplemental-documents';

package/resources/entities/supplemental-documents.ts

@@ -0,0 +1,25 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import * as Entities from '~/resources/entities';
+
+export class SupplementalDocuments extends APIResource {
+  /**
+   * Create a supplemental document for an Entity
+   */
+  create(
+    entityId: string,
+    body: SupplementalDocumentCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<Entities.Entity>> {
+    return this.post(`/entities/${entityId}/supplemental_documents`, { body, ...options });
+  }
+}
+
+export interface SupplementalDocumentCreateParams {
+  /**
+   * The identifier of the File containing the document.
+   */
+  file_id: string;
+}

package/resources/event-subscriptions.ts

@@ -0,0 +1,232 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/pagination';
+
+export class EventSubscriptions extends APIResource {
+  /**
+   * Create an Event Subscription
+   */
+  create(
+    body: EventSubscriptionCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<EventSubscription>> {
+    return this.post('/event_subscriptions', { body, ...options });
+  }
+
+  /**
+   * Retrieve an Event Subscription
+   */
+  retrieve(
+    eventSubscriptionId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<EventSubscription>> {
+    return this.get(`/event_subscriptions/${eventSubscriptionId}`, options);
+  }
+
+  /**
+   * Update an Event Subscription
+   */
+  update(
+    eventSubscriptionId: string,
+    body: EventSubscriptionUpdateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<EventSubscription>> {
+    return this.patch(`/event_subscriptions/${eventSubscriptionId}`, { body, ...options });
+  }
+
+  /**
+   * List Event Subscriptions
+   */
+  list(
+    query?: EventSubscriptionListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<EventSubscriptionsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<EventSubscriptionsPage>;
+  list(
+    query: EventSubscriptionListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<EventSubscriptionsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/event_subscriptions', EventSubscriptionsPage, { query, ...options });
+  }
+}
+
+export class EventSubscriptionsPage extends Page<EventSubscription> {}
+
+/**
+ * Webhooks are event notifications we send to you by HTTPS POST requests. Event
+ * Subscriptions are how you configure your application to listen for them. You can
+ * create an Event Subscription through your
+ * [developer dashboard](https://dashboard.increase.com/developers/webhooks) or the
+ * API. For more information, see our
+ * [webhooks guide](https://increase.com/documentation/webhooks).
+ */
+export interface EventSubscription {
+  /**
+   * The time the event subscription was created.
+   */
+  created_at: string;
+
+  /**
+   * The event subscription identifier.
+   */
+  id: string;
+
+  /**
+   * If specified, this subscription will only receive webhooks for Events with the
+   * specified `category`.
+   */
+  selected_event_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_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'
+    | null;
+
+  /**
+   * The key that will be used to sign webhooks.
+   */
+  shared_secret: string;
+
+  /**
+   * This indicates if we'll send notifications to this subscription.
+   */
+  status: 'active' | 'disabled' | 'deleted' | 'requires_attention';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `event_subscription`.
+   */
+  type: 'event_subscription';
+
+  /**
+   * The webhook url where we'll send notifications.
+   */
+  url: string;
+}
+
+export interface EventSubscriptionCreateParams {
+  /**
+   * The URL you'd like us to send webhooks to.
+   */
+  url: string;
+
+  /**
+   * If specified, this subscription will only receive webhooks for Events with the
+   * specified `category`.
+   */
+  selected_event_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_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 key that will be used to sign webhooks. If no value is passed, a random
+   * string will be used as default.
+   */
+  shared_secret?: string;
+}
+
+export interface EventSubscriptionUpdateParams {
+  /**
+   * The status to update the Event Subscription with.
+   */
+  status?: 'active' | 'disabled' | 'deleted';
+}
+
+export interface EventSubscriptionListParams extends PageParams {}

package/resources/events.ts

@@ -0,0 +1,215 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/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> {}
+
+/**
+ * Events are records of things that happened to objects in the API. They also
+ * result in webhooks being generated.
+ */
+export interface Event {
+  /**
+   * 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.
+   */
+  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_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;
+
+  /**
+   * The Event identifier.
+   */
+  id: 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 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 Category {
+    /**
+     * Return results whose value is in the provided list. 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_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'
+    >;
+  }
+}

package/resources/external-accounts.ts

@@ -0,0 +1,162 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/pagination';
+
+export class ExternalAccounts extends APIResource {
+  /**
+   * Create an External Account
+   */
+  create(
+    body: ExternalAccountCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<ExternalAccount>> {
+    return this.post('/external_accounts', { body, ...options });
+  }
+
+  /**
+   * Retrieve an External Account
+   */
+  retrieve(
+    externalAccountId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<ExternalAccount>> {
+    return this.get(`/external_accounts/${externalAccountId}`, options);
+  }
+
+  /**
+   * Update an External Account
+   */
+  update(
+    externalAccountId: string,
+    body: ExternalAccountUpdateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<ExternalAccount>> {
+    return this.patch(`/external_accounts/${externalAccountId}`, { body, ...options });
+  }
+
+  /**
+   * List External Accounts
+   */
+  list(
+    query?: ExternalAccountListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ExternalAccountsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<ExternalAccountsPage>;
+  list(
+    query: ExternalAccountListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ExternalAccountsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+
+    return this.getAPIList('/external_accounts', ExternalAccountsPage, { query, ...options });
+  }
+}
+
+export class ExternalAccountsPage extends Page<ExternalAccount> {}
+
+/**
+ * External Accounts represent accounts at financial institutions other than
+ * Increase. You can use this API to store their details for reuse.
+ */
+export interface ExternalAccount {
+  /**
+   * The destination account number.
+   */
+  account_number: string;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+   * the External Account was created.
+   */
+  created_at: string;
+
+  /**
+   * The External Account's description for display purposes.
+   */
+  description: string;
+
+  /**
+   * The type of the account to which the transfer will be sent.
+   */
+  funding: 'checking' | 'savings' | 'other';
+
+  /**
+   * The External Account's identifier.
+   */
+  id: string;
+
+  /**
+   * The American Bankers' Association (ABA) Routing Transit Number (RTN).
+   */
+  routing_number: string;
+
+  /**
+   * The External Account's status.
+   */
+  status: 'active' | 'archived';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `external_account`.
+   */
+  type: 'external_account';
+
+  /**
+   * If you have verified ownership of the External Account.
+   */
+  verification_status: 'unverified' | 'pending' | 'verified';
+}
+
+export interface ExternalAccountCreateParams {
+  /**
+   * The account number for the destination account.
+   */
+  account_number: string;
+
+  /**
+   * The name you choose for the Account.
+   */
+  description: string;
+
+  /**
+   * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+   * destination account.
+   */
+  routing_number: string;
+
+  /**
+   * The type of the destination account. Defaults to `checking`.
+   */
+  funding?: 'checking' | 'savings' | 'other';
+}
+
+export interface ExternalAccountUpdateParams {
+  /**
+   * The description you choose to give the external account.
+   */
+  description?: string;
+
+  /**
+   * The status of the External Account.
+   */
+  status?: 'active' | 'archived';
+}
+
+export interface ExternalAccountListParams extends PageParams {
+  status?: ExternalAccountListParams.Status;
+}
+
+export namespace ExternalAccountListParams {
+  export interface Status {
+    /**
+     * Return results whose value is in the provided list. For GET requests, this
+     * should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+     */
+    in?: Array<'active' | 'archived'>;
+  }
+}