increase 0.10.0 → 0.10.2

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

@@ -7,16 +7,6 @@ import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class InboundACHTransferReturns extends APIResource {
-  /**
-   * Create an ACH Return
-   */
-  create(
-    body: InboundACHTransferReturnCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<InboundACHTransferReturn> {
-    return this.post('/inbound_ach_transfer_returns', { body, ...options });
-  }
-
   /**
    * Retrieve an Inbound ACH Transfer Return
    */
@@ -120,7 +110,7 @@ export interface InboundACHTransferReturn {
   /**
    * The ID for the transaction refunding the transfer.
    */
-  transaction_id: string | null;
+  transaction_id: string;
 
   /**
    * A constant representing the object's type. For this resource it will always be
@@ -146,51 +136,10 @@ export namespace InboundACHTransferReturn {
   }
 }
 
-export interface InboundACHTransferReturnCreateParams {
-  /**
-   * The reason why this transfer will be returned. The most usual return codes are
-   * `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.
-   *
-   * - `authorization_revoked_by_customer` - The customer no longer authorizes this
-   *   transaction. The Nacha return code is R07.
-   * - `payment_stopped` - The customer asked for the payment to be stopped. This
-   *   reason is only allowed for debits. The Nacha return code is R08.
-   * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - The
-   *   customer advises that the debit was unauthorized. The Nacha return code is
-   *   R10.
-   * - `representative_payee_deceased_or_unable_to_continue_in_that_capacity` - The
-   *   payee is deceased. The Nacha return code is R14.
-   * - `beneficiary_or_account_holder_deceased` - The account holder is deceased. The
-   *   Nacha return code is R15.
-   * - `credit_entry_refused_by_receiver` - The customer refused a credit entry. This
-   *   reason is only allowed for credits. The Nacha return code is R23.
-   * - `duplicate_entry` - The account holder identified this transaction as a
-   *   duplicate. The Nacha return code is R24.
-   * - `corporate_customer_advised_not_authorized` - The corporate customer no longer
-   *   authorizes this transaction. The Nacha return code is R29.
-   */
-  reason:
-    | 'authorization_revoked_by_customer'
-    | 'payment_stopped'
-    | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
-    | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
-    | 'beneficiary_or_account_holder_deceased'
-    | 'credit_entry_refused_by_receiver'
-    | 'duplicate_entry'
-    | 'corporate_customer_advised_not_authorized';
-
-  /**
-   * The transaction identifier of the Inbound ACH Transfer to return to the
-   * originating financial institution.
-   */
-  transaction_id: string;
-}
-
 export interface InboundACHTransferReturnListParams extends PageParams {}
 
 export namespace InboundACHTransferReturns {
   export import InboundACHTransferReturn = API.InboundACHTransferReturn;
   export type InboundACHTransferReturnsPage = _InboundACHTransferReturnsPage;
-  export import InboundACHTransferReturnCreateParams = API.InboundACHTransferReturnCreateParams;
   export import InboundACHTransferReturnListParams = API.InboundACHTransferReturnListParams;
 }

package/src/resources/inbound-ach-transfers.ts

@@ -0,0 +1,359 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
+
+export class InboundACHTransfers extends APIResource {
+  /**
+   * Retrieve an Inbound ACH Transfer
+   */
+  retrieve(inboundACHTransferId: string, options?: Core.RequestOptions): Core.APIPromise<InboundACHTransfer> {
+    return this.get(`/inbound_ach_transfers/${inboundACHTransferId}`, options);
+  }
+
+  /**
+   * List Inbound ACH Transfers
+   */
+  list(
+    query?: InboundACHTransferListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InboundACHTransfersPage, InboundACHTransfer>;
+  list(options?: Core.RequestOptions): Core.PagePromise<InboundACHTransfersPage, InboundACHTransfer>;
+  list(
+    query: InboundACHTransferListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InboundACHTransfersPage, InboundACHTransfer> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/inbound_ach_transfers', InboundACHTransfersPage, { query, ...options });
+  }
+
+  /**
+   * Decline an Inbound ACH Transfer
+   */
+  decline(inboundACHTransferId: string, options?: Core.RequestOptions): Core.APIPromise<InboundACHTransfer> {
+    return this.post(`/inbound_ach_transfers/${inboundACHTransferId}/decline`, options);
+  }
+
+  /**
+   * Create an ACH Return
+   */
+  transferReturn(
+    inboundACHTransferId: string,
+    body: InboundACHTransferTransferReturnParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InboundACHTransfer> {
+    return this.post(`/inbound_ach_transfer/${inboundACHTransferId}/transfer_returns`, { body, ...options });
+  }
+}
+
+export class InboundACHTransfersPage extends Page<InboundACHTransfer> {}
+// alias so we can export it in the namespace
+type _InboundACHTransfersPage = InboundACHTransfersPage;
+
+/**
+ * An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your
+ * account.
+ */
+export interface InboundACHTransfer {
+  /**
+   * The inbound ach transfer's identifier.
+   */
+  id: string;
+
+  /**
+   * If your transfer is accepted, this will contain details of the acceptance.
+   */
+  acceptance: InboundACHTransfer.Acceptance | null;
+
+  /**
+   * The transfer amount in USD cents.
+   */
+  amount: number;
+
+  /**
+   * The time at which the transfer will be automatically resolved.
+   */
+  automatically_resolves_at: string;
+
+  /**
+   * If your transfer is declined, this will contain details of the decline.
+   */
+  decline: InboundACHTransfer.Decline | null;
+
+  /**
+   * The direction of the transfer.
+   *
+   * - `credit` - Credit
+   * - `debit` - Debit
+   */
+  direction: 'credit' | 'debit';
+
+  /**
+   * The descriptive date of the transfer.
+   */
+  originator_company_descriptive_date: string | null;
+
+  /**
+   * The additional information included with the transfer.
+   */
+  originator_company_discretionary_data: string | null;
+
+  /**
+   * The description of the transfer.
+   */
+  originator_company_entry_description: string;
+
+  /**
+   * The id of the company that initiated the transfer.
+   */
+  originator_company_id: string;
+
+  /**
+   * The name of the company that initiated the transfer.
+   */
+  originator_company_name: string;
+
+  /**
+   * The id of the receiver of the transfer.
+   */
+  receiver_id_number: string | null;
+
+  /**
+   * The name of the receiver of the transfer.
+   */
+  receiver_name: string | null;
+
+  /**
+   * The status of the transfer.
+   *
+   * - `pending` - The Inbound ACH Transfer is awaiting action, will transition
+   *   automatically if no action is taken.
+   * - `declined` - The Inbound ACH Transfer has been declined.
+   * - `accepted` - The Inbound ACH Transfer is accepted.
+   * - `returned` - The Inbound ACH Transfer has been returned.
+   */
+  status: 'pending' | 'declined' | 'accepted' | 'returned';
+
+  /**
+   * The trace number of the transfer.
+   */
+  trace_number: string;
+
+  /**
+   * If your transfer is returned, this will contain details of the return.
+   */
+  transfer_return: InboundACHTransfer.TransferReturn | null;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `inbound_ach_transfer`.
+   */
+  type: 'inbound_ach_transfer';
+}
+
+export namespace InboundACHTransfer {
+  /**
+   * If your transfer is accepted, this will contain details of the acceptance.
+   */
+  export interface Acceptance {
+    /**
+     * The time at which the transfer was accepted.
+     */
+    accepted_at: string;
+
+    /**
+     * The id of the transaction for the accepted transfer.
+     */
+    transaction_id: string;
+  }
+
+  /**
+   * If your transfer is declined, this will contain details of the decline.
+   */
+  export interface Decline {
+    /**
+     * The time at which the transfer was declined.
+     */
+    declined_at: string;
+
+    /**
+     * The id of the transaction for the declined transfer.
+     */
+    declined_transaction_id: string;
+
+    /**
+     * The reason for the transfer decline
+     *
+     * - `ach_route_canceled` - The account number is canceled.
+     * - `ach_route_disabled` - The account number is disabled.
+     * - `breaches_limit` - The transaction would cause a limit to be exceeded.
+     * - `credit_entry_refused_by_receiver` - A credit was refused.
+     * - `duplicate_return` - Other.
+     * - `entity_not_active` - The account's entity is not active.
+     * - `group_locked` - Your account is inactive.
+     * - `insufficient_funds` - Your account contains insufficient funds.
+     * - `misrouted_return` - Other.
+     * - `return_of_erroneous_or_reversing_debit` - Other.
+     * - `no_ach_route` - The account number that was debited does not exist.
+     * - `originator_request` - Other.
+     * - `transaction_not_allowed` - The transaction is not allowed per Increase's
+     *   terms.
+     * - `user_initiated` - The user initiated the decline.
+     */
+    reason:
+      | 'ach_route_canceled'
+      | 'ach_route_disabled'
+      | 'breaches_limit'
+      | 'credit_entry_refused_by_receiver'
+      | 'duplicate_return'
+      | 'entity_not_active'
+      | 'group_locked'
+      | 'insufficient_funds'
+      | 'misrouted_return'
+      | 'return_of_erroneous_or_reversing_debit'
+      | 'no_ach_route'
+      | 'originator_request'
+      | 'transaction_not_allowed'
+      | 'user_initiated';
+  }
+
+  /**
+   * If your transfer is returned, this will contain details of the return.
+   */
+  export interface TransferReturn {
+    /**
+     * The reason for the transfer return
+     *
+     * - `authorization_revoked_by_customer` - The customer no longer authorizes this
+     *   transaction. The Nacha return code is R07.
+     * - `payment_stopped` - The customer asked for the payment to be stopped. This
+     *   reason is only allowed for debits. The Nacha return code is R08.
+     * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - The
+     *   customer advises that the debit was unauthorized. The Nacha return code is
+     *   R10.
+     * - `representative_payee_deceased_or_unable_to_continue_in_that_capacity` - The
+     *   payee is deceased. The Nacha return code is R14.
+     * - `beneficiary_or_account_holder_deceased` - The account holder is deceased. The
+     *   Nacha return code is R15.
+     * - `credit_entry_refused_by_receiver` - The customer refused a credit entry. This
+     *   reason is only allowed for credits. The Nacha return code is R23.
+     * - `duplicate_entry` - The account holder identified this transaction as a
+     *   duplicate. The Nacha return code is R24.
+     * - `corporate_customer_advised_not_authorized` - The corporate customer no longer
+     *   authorizes this transaction. The Nacha return code is R29.
+     */
+    reason:
+      | 'authorization_revoked_by_customer'
+      | 'payment_stopped'
+      | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
+      | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
+      | 'beneficiary_or_account_holder_deceased'
+      | 'credit_entry_refused_by_receiver'
+      | 'duplicate_entry'
+      | 'corporate_customer_advised_not_authorized';
+
+    /**
+     * The time at which the transfer was returned.
+     */
+    returned_at: string;
+
+    /**
+     * The id of the transaction for the returned transfer.
+     */
+    transaction_id: string;
+  }
+}
+
+export interface InboundACHTransferListParams extends PageParams {
+  /**
+   * Filter Inbound ACH Tranfers to ones belonging to the specified Account.
+   */
+  account_id?: string;
+
+  created_at?: InboundACHTransferListParams.CreatedAt;
+
+  /**
+   * Filter Inbound ACH Transfers to those with the specified status.
+   *
+   * - `pending` - The Inbound ACH Transfer is awaiting action, will transition
+   *   automatically if no action is taken.
+   * - `declined` - The Inbound ACH Transfer has been declined.
+   * - `accepted` - The Inbound ACH Transfer is accepted.
+   * - `returned` - The Inbound ACH Transfer has been returned.
+   */
+  status?: 'pending' | 'declined' | 'accepted' | 'returned';
+}
+
+export namespace InboundACHTransferListParams {
+  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 InboundACHTransferTransferReturnParams {
+  /**
+   * The reason why this transfer will be returned. The most usual return codes are
+   * `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.
+   *
+   * - `authorization_revoked_by_customer` - The customer no longer authorizes this
+   *   transaction. The Nacha return code is R07.
+   * - `payment_stopped` - The customer asked for the payment to be stopped. This
+   *   reason is only allowed for debits. The Nacha return code is R08.
+   * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - The
+   *   customer advises that the debit was unauthorized. The Nacha return code is
+   *   R10.
+   * - `representative_payee_deceased_or_unable_to_continue_in_that_capacity` - The
+   *   payee is deceased. The Nacha return code is R14.
+   * - `beneficiary_or_account_holder_deceased` - The account holder is deceased. The
+   *   Nacha return code is R15.
+   * - `credit_entry_refused_by_receiver` - The customer refused a credit entry. This
+   *   reason is only allowed for credits. The Nacha return code is R23.
+   * - `duplicate_entry` - The account holder identified this transaction as a
+   *   duplicate. The Nacha return code is R24.
+   * - `corporate_customer_advised_not_authorized` - The corporate customer no longer
+   *   authorizes this transaction. The Nacha return code is R29.
+   */
+  reason:
+    | 'authorization_revoked_by_customer'
+    | 'payment_stopped'
+    | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
+    | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
+    | 'beneficiary_or_account_holder_deceased'
+    | 'credit_entry_refused_by_receiver'
+    | 'duplicate_entry'
+    | 'corporate_customer_advised_not_authorized';
+}
+
+export namespace InboundACHTransfers {
+  export import InboundACHTransfer = API.InboundACHTransfer;
+  export type InboundACHTransfersPage = _InboundACHTransfersPage;
+  export import InboundACHTransferListParams = API.InboundACHTransferListParams;
+  export import InboundACHTransferTransferReturnParams = API.InboundACHTransferTransferReturnParams;
+}

package/src/resources/index.ts

@@ -1,6 +1,5 @@
 // File generated from our OpenAPI spec by Stainless.
 
-export * from './shared';
 export {
   ACHPrenotification,
   ACHPrenotificationCreateParams,
@@ -141,9 +140,15 @@ export {
 } from './external-accounts';
 export { File, FileCreateParams, FileListParams, FilesPage, Files } from './files';
 export { Group, Groups } from './groups';
+export {
+  InboundACHTransfer,
+  InboundACHTransferListParams,
+  InboundACHTransferTransferReturnParams,
+  InboundACHTransfersPage,
+  InboundACHTransfers,
+} from './inbound-ach-transfers';
 export {
   InboundACHTransferReturn,
-  InboundACHTransferReturnCreateParams,
   InboundACHTransferReturnListParams,
   InboundACHTransferReturnsPage,
   InboundACHTransferReturns,

package/src/resources/pending-transactions.ts

@@ -3,7 +3,6 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as Shared from './shared';
 import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
@@ -67,14 +66,14 @@ export interface PendingTransaction {
 
   /**
    * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
-   * Transaction occured.
+   * Transaction occurred.
    */
   created_at: string;
 
   /**
    * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
    * Transaction's currency. This will match the currency on the Pending
-   * Transcation's Account.
+   * Transaction's Account.
    *
    * - `CAD` - Canadian Dollar (CAD)
    * - `CHF` - Swiss Franc (CHF)
@@ -172,7 +171,7 @@ export namespace PendingTransaction {
      *   under the `check_transfer_instruction` object.
      * - `inbound_funds_hold` - Inbound Funds Hold: details will be under the
      *   `inbound_funds_hold` object.
-     * - `real_time_payments_transfer_instruction` - Real Time Payments Transfer
+     * - `real_time_payments_transfer_instruction` - Real-Time Payments Transfer
      *   Instruction: details will be under the
      *   `real_time_payments_transfer_instruction` object.
      * - `wire_transfer_instruction` - Wire Transfer Instruction: details will be under
@@ -210,7 +209,7 @@ export namespace PendingTransaction {
     inbound_funds_hold: Source.InboundFundsHold | null;
 
     /**
-     * A Real Time Payments Transfer Instruction object. This field will be present in
+     * A Real-Time Payments Transfer Instruction object. This field will be present in
      * the JSON response if and only if `category` is equal to
      * `real_time_payments_transfer_instruction`.
      */
@@ -440,8 +439,33 @@ export namespace PendingTransaction {
           /**
            * The method used to enter the cardholder's primary account number and card
            * expiration date
+           *
+           * - `unknown` - Unknown
+           * - `manual` - Manual key entry
+           * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
+           *   value
+           * - `optical_code` - Optical code
+           * - `integrated_circuit_card` - Contact chip card
+           * - `contactless` - Contactless read of chip card
+           * - `credential_on_file` - Transaction initiated using a credential that has
+           *   previously been stored on file
+           * - `magnetic_stripe` - Magnetic stripe read
+           * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
+           * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
+           *   verification value
            */
-          point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
+          point_of_service_entry_mode:
+            | 'unknown'
+            | 'manual'
+            | 'magnetic_stripe_no_cvv'
+            | 'optical_code'
+            | 'integrated_circuit_card'
+            | 'contactless'
+            | 'credential_on_file'
+            | 'magnetic_stripe'
+            | 'contactless_magnetic_stripe'
+            | 'integrated_circuit_card_no_cvv'
+            | null;
         }
       }
     }
@@ -590,7 +614,7 @@ export namespace PendingTransaction {
     }
 
     /**
-     * A Real Time Payments Transfer Instruction object. This field will be present in
+     * A Real-Time Payments Transfer Instruction object. This field will be present in
      * the JSON response if and only if `category` is equal to
      * `real_time_payments_transfer_instruction`.
      */
@@ -602,7 +626,7 @@ export namespace PendingTransaction {
       amount: number;
 
       /**
-       * The identifier of the Real Time Payments Transfer that led to this Pending
+       * The identifier of the Real-Time Payments Transfer that led to this Pending
        * Transaction.
        */
       transfer_id: string;
@@ -636,6 +660,8 @@ export interface PendingTransactionListParams extends PageParams {
    */
   account_id?: string;
 
+  category?: PendingTransactionListParams.Category;
+
   created_at?: PendingTransactionListParams.CreatedAt;
 
   /**
@@ -652,6 +678,24 @@ export interface PendingTransactionListParams extends PageParams {
 }
 
 export namespace PendingTransactionListParams {
+  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_transfer_instruction'
+      | 'ach_transfer_instruction'
+      | 'card_authorization'
+      | 'check_deposit_instruction'
+      | 'check_transfer_instruction'
+      | 'inbound_funds_hold'
+      | 'real_time_payments_transfer_instruction'
+      | 'wire_transfer_instruction'
+      | 'other'
+    >;
+  }
+
   export interface CreatedAt {
     /**
      * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)

package/src/resources/real-time-decisions.ts

@@ -2,7 +2,6 @@
 
 import * as Core from '../core';
 import { APIResource } from '../resource';
-import * as Shared from './shared';
 import * as API from './index';
 
 export class RealTimeDecisions extends APIResource {
@@ -258,8 +257,33 @@ export namespace RealTimeDecision {
         /**
          * The method used to enter the cardholder's primary account number and card
          * expiration date
+         *
+         * - `unknown` - Unknown
+         * - `manual` - Manual key entry
+         * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
+         *   value
+         * - `optical_code` - Optical code
+         * - `integrated_circuit_card` - Contact chip card
+         * - `contactless` - Contactless read of chip card
+         * - `credential_on_file` - Transaction initiated using a credential that has
+         *   previously been stored on file
+         * - `magnetic_stripe` - Magnetic stripe read
+         * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
+         * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
+         *   verification value
          */
-        point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
+        point_of_service_entry_mode:
+          | 'unknown'
+          | 'manual'
+          | 'magnetic_stripe_no_cvv'
+          | 'optical_code'
+          | 'integrated_circuit_card'
+          | 'contactless'
+          | 'credential_on_file'
+          | 'magnetic_stripe'
+          | 'contactless_magnetic_stripe'
+          | 'integrated_circuit_card_no_cvv'
+          | null;
       }
     }
 
@@ -278,7 +302,7 @@ export namespace RealTimeDecision {
       category: 'initial_authorization' | 'incremental_authorization';
 
       /**
-       * Fields specific to the categorty `incremental_authorization`.
+       * Fields specific to the category `incremental_authorization`.
        */
       incremental_authorization: RequestDetails.IncrementalAuthorization | null;
 
@@ -290,7 +314,7 @@ export namespace RealTimeDecision {
 
     export namespace RequestDetails {
       /**
-       * Fields specific to the categorty `incremental_authorization`.
+       * Fields specific to the category `incremental_authorization`.
        */
       export interface IncrementalAuthorization {
         /**