increase 0.59.1 → 0.61.0

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

@@ -0,0 +1,124 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as SimulationsInboundACHTransfersAPI from './inbound-ach-transfers';
+import * as InboundACHTransfersAPI from '../inbound-ach-transfers';
+
+export class InboundACHTransfers extends APIResource {
+  /**
+   * Simulates an inbound ACH transfer to your account. This imitates initiating a
+   * transfer to an Increase account from a different financial institution. The
+   * transfer may be either a credit or a debit depending on if the `amount` is
+   * positive or negative. The result of calling this API will contain the created
+   * transfer. You can pass a `resolve_at` parameter to allow for a window to
+   * [action on the Inbound ACH Transfer](https://increase.com/documentation/receiving-ach-transfers).
+   * Alternatively, if you don't pass the `resolve_at` parameter the result will
+   * contain either a [Transaction](#transactions) or a
+   * [Declined Transaction](#declined-transactions) depending on whether or not the
+   * transfer is allowed.
+   */
+  create(
+    body: InboundACHTransferCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InboundACHTransfersAPI.InboundACHTransfer> {
+    return this._client.post('/simulations/inbound_ach_transfers', { body, ...options });
+  }
+}
+
+export interface InboundACHTransferCreateParams {
+  /**
+   * The identifier of the Account Number the inbound ACH Transfer is for.
+   */
+  account_number_id: string;
+
+  /**
+   * The transfer amount in cents. A positive amount originates a credit transfer
+   * pushing funds to the receiving account. A negative amount originates a debit
+   * transfer pulling funds from the receiving account.
+   */
+  amount: number;
+
+  /**
+   * The description of the date of the transfer.
+   */
+  company_descriptive_date?: string;
+
+  /**
+   * Data associated with the transfer set by the sender.
+   */
+  company_discretionary_data?: string;
+
+  /**
+   * The description of the transfer set by the sender.
+   */
+  company_entry_description?: string;
+
+  /**
+   * The sender's company ID.
+   */
+  company_id?: string;
+
+  /**
+   * The name of the sender.
+   */
+  company_name?: string;
+
+  /**
+   * The ID of the receiver of the transfer.
+   */
+  receiver_id_number?: string;
+
+  /**
+   * The name of the receiver of the transfer.
+   */
+  receiver_name?: string;
+
+  /**
+   * The time at which the transfer should be resolved. If not provided will resolve
+   * immediately.
+   */
+  resolve_at?: string;
+
+  /**
+   * The standard entry class code for the transfer.
+   *
+   * - `corporate_credit_or_debit` - Corporate Credit and Debit (CCD).
+   * - `corporate_trade_exchange` - Corporate Trade Exchange (CTX).
+   * - `prearranged_payments_and_deposit` - Prearranged Payments and Deposits (PPD).
+   * - `internet_initiated` - Internet Initiated (WEB).
+   * - `point_of_sale` - Point of Sale (POS).
+   * - `telephone_initiated` - Telephone Initiated (TEL).
+   * - `customer_initiated` - Customer Initiated (CIE).
+   * - `accounts_receivable` - Accounts Receivable (ARC).
+   * - `machine_transfer` - Machine Transfer (MTE).
+   * - `shared_network_transaction` - Shared Network Transaction (SHR).
+   * - `represented_check` - Represented Check (RCK).
+   * - `back_office_conversion` - Back Office Conversion (BOC).
+   * - `point_of_purchase` - Point of Purchase (POP).
+   * - `check_truncation` - Check Truncation (TRC).
+   * - `destroyed_check` - Destroyed Check (XCK).
+   * - `international_ach_transaction` - International ACH Transaction (IAT).
+   */
+  standard_entry_class_code?:
+    | 'corporate_credit_or_debit'
+    | 'corporate_trade_exchange'
+    | 'prearranged_payments_and_deposit'
+    | 'internet_initiated'
+    | 'point_of_sale'
+    | 'telephone_initiated'
+    | 'customer_initiated'
+    | 'accounts_receivable'
+    | 'machine_transfer'
+    | 'shared_network_transaction'
+    | 'represented_check'
+    | 'back_office_conversion'
+    | 'point_of_purchase'
+    | 'check_truncation'
+    | 'destroyed_check'
+    | 'international_ach_transaction';
+}
+
+export namespace InboundACHTransfers {
+  export import InboundACHTransferCreateParams = SimulationsInboundACHTransfersAPI.InboundACHTransferCreateParams;
+}

package/src/resources/simulations/inbound-real-time-payments-transfers.ts

@@ -0,0 +1,89 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as InboundRealTimePaymentsTransfersAPI from './inbound-real-time-payments-transfers';
+import * as DeclinedTransactionsAPI from '../declined-transactions';
+import * as TransactionsAPI from '../transactions';
+
+export class InboundRealTimePaymentsTransfers extends APIResource {
+  /**
+   * Simulates an inbound Real-Time Payments transfer to your account. Real-Time
+   * Payments are a beta feature.
+   */
+  create(
+    body: InboundRealTimePaymentsTransferCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InboundRealTimePaymentsTransferCreateResponse> {
+    return this._client.post('/simulations/inbound_real_time_payments_transfers', { body, ...options });
+  }
+}
+
+/**
+ * The results of an inbound Real-Time Payments Transfer simulation.
+ */
+export interface InboundRealTimePaymentsTransferCreateResponse {
+  /**
+   * If the Real-Time Payments Transfer attempt fails, this will contain the
+   * resulting [Declined Transaction](#declined-transactions) object. The Declined
+   * Transaction's `source` will be of
+   * `category: inbound_real_time_payments_transfer_decline`.
+   */
+  declined_transaction: DeclinedTransactionsAPI.DeclinedTransaction | null;
+
+  /**
+   * If the Real-Time Payments Transfer attempt succeeds, this will contain the
+   * resulting [Transaction](#transactions) object. The Transaction's `source` will
+   * be of `category: inbound_real_time_payments_transfer_confirmation`.
+   */
+  transaction: TransactionsAPI.Transaction | null;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `inbound_real_time_payments_transfer_simulation_result`.
+   */
+  type: 'inbound_real_time_payments_transfer_simulation_result';
+}
+
+export interface InboundRealTimePaymentsTransferCreateParams {
+  /**
+   * The identifier of the Account Number the inbound Real-Time Payments Transfer is
+   * for.
+   */
+  account_number_id: string;
+
+  /**
+   * The transfer amount in USD cents. Must be positive.
+   */
+  amount: number;
+
+  /**
+   * The account number of the account that sent the transfer.
+   */
+  debtor_account_number?: string;
+
+  /**
+   * The name provided by the sender of the transfer.
+   */
+  debtor_name?: string;
+
+  /**
+   * The routing number of the account that sent the transfer.
+   */
+  debtor_routing_number?: string;
+
+  /**
+   * Additional information included with the transfer.
+   */
+  remittance_information?: string;
+
+  /**
+   * The identifier of a pending Request for Payment that this transfer will fulfill.
+   */
+  request_for_payment_id?: string;
+}
+
+export namespace InboundRealTimePaymentsTransfers {
+  export import InboundRealTimePaymentsTransferCreateResponse = InboundRealTimePaymentsTransfersAPI.InboundRealTimePaymentsTransferCreateResponse;
+  export import InboundRealTimePaymentsTransferCreateParams = InboundRealTimePaymentsTransfersAPI.InboundRealTimePaymentsTransferCreateParams;
+}

package/src/resources/simulations/inbound-wire-transfers.ts

@@ -0,0 +1,124 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as SimulationsInboundWireTransfersAPI from './inbound-wire-transfers';
+import * as InboundWireTransfersAPI from '../inbound-wire-transfers';
+
+export class InboundWireTransfers extends APIResource {
+  /**
+   * Simulates an inbound Wire Transfer to your account.
+   */
+  create(
+    body: InboundWireTransferCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InboundWireTransfersAPI.InboundWireTransfer> {
+    return this._client.post('/simulations/inbound_wire_transfers', { body, ...options });
+  }
+}
+
+export interface InboundWireTransferCreateParams {
+  /**
+   * The identifier of the Account Number the inbound Wire Transfer is for.
+   */
+  account_number_id: string;
+
+  /**
+   * The transfer amount in cents. Must be positive.
+   */
+  amount: number;
+
+  /**
+   * The sending bank will set beneficiary_address_line1 in production. You can
+   * simulate any value here.
+   */
+  beneficiary_address_line1?: string;
+
+  /**
+   * The sending bank will set beneficiary_address_line2 in production. You can
+   * simulate any value here.
+   */
+  beneficiary_address_line2?: string;
+
+  /**
+   * The sending bank will set beneficiary_address_line3 in production. You can
+   * simulate any value here.
+   */
+  beneficiary_address_line3?: string;
+
+  /**
+   * The sending bank will set beneficiary_name in production. You can simulate any
+   * value here.
+   */
+  beneficiary_name?: string;
+
+  /**
+   * The sending bank will set beneficiary_reference in production. You can simulate
+   * any value here.
+   */
+  beneficiary_reference?: string;
+
+  /**
+   * The sending bank will set originator_address_line1 in production. You can
+   * simulate any value here.
+   */
+  originator_address_line1?: string;
+
+  /**
+   * The sending bank will set originator_address_line2 in production. You can
+   * simulate any value here.
+   */
+  originator_address_line2?: string;
+
+  /**
+   * The sending bank will set originator_address_line3 in production. You can
+   * simulate any value here.
+   */
+  originator_address_line3?: string;
+
+  /**
+   * The sending bank will set originator_name in production. You can simulate any
+   * value here.
+   */
+  originator_name?: string;
+
+  /**
+   * The sending bank will set originator_routing_number in production. You can
+   * simulate any value here.
+   */
+  originator_routing_number?: string;
+
+  /**
+   * The sending bank will set originator_to_beneficiary_information_line1 in
+   * production. You can simulate any value here.
+   */
+  originator_to_beneficiary_information_line1?: string;
+
+  /**
+   * The sending bank will set originator_to_beneficiary_information_line2 in
+   * production. You can simulate any value here.
+   */
+  originator_to_beneficiary_information_line2?: string;
+
+  /**
+   * The sending bank will set originator_to_beneficiary_information_line3 in
+   * production. You can simulate any value here.
+   */
+  originator_to_beneficiary_information_line3?: string;
+
+  /**
+   * The sending bank will set originator_to_beneficiary_information_line4 in
+   * production. You can simulate any value here.
+   */
+  originator_to_beneficiary_information_line4?: string;
+
+  /**
+   * The sending bank will set sender_reference in production. You can simulate any
+   * value here.
+   */
+  sender_reference?: string;
+}
+
+export namespace InboundWireTransfers {
+  export import InboundWireTransferCreateParams = SimulationsInboundWireTransfersAPI.InboundWireTransferCreateParams;
+}

package/src/resources/simulations/index.ts

@@ -1,16 +1,27 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  ACHTransferCreateInboundParams,
-  ACHTransferNotificationOfChangeParams,
+  ACHTransferCreateNotificationOfChangeParams,
   ACHTransferReturnParams,
   ACHTransfers,
 } from './ach-transfers';
 export { AccountStatementCreateParams, AccountStatements } from './account-statements';
 export { AccountTransfers } from './account-transfers';
-export { CardAuthorizationSimulation, CardAuthorizeParams, CardSettlementParams, Cards } from './cards';
+export {
+  CardAuthorizationCreateResponse,
+  CardAuthorizationCreateParams,
+  CardAuthorizations,
+} from './card-authorizations';
+export {
+  CardAuthorizationExpirationCreateParams,
+  CardAuthorizationExpirations,
+} from './card-authorization-expirations';
 export { CardDisputeActionParams, CardDisputes } from './card-disputes';
+export { CardFuelConfirmationCreateParams, CardFuelConfirmations } from './card-fuel-confirmations';
+export { CardIncrementCreateParams, CardIncrements } from './card-increments';
 export { CardRefundCreateParams, CardRefunds } from './card-refunds';
+export { CardReversalCreateParams, CardReversals } from './card-reversals';
+export { CardSettlementCreateParams, CardSettlements } from './card-settlements';
 export { CheckDeposits } from './check-deposits';
 export { CheckTransfers } from './check-transfers';
 export {
@@ -19,31 +30,25 @@ export {
   DigitalWalletTokenRequests,
 } from './digital-wallet-token-requests';
 export { DocumentCreateParams, Documents } from './documents';
+export { InboundACHTransferCreateParams, InboundACHTransfers } from './inbound-ach-transfers';
 export { InboundCheckDepositCreateParams, InboundCheckDeposits } from './inbound-check-deposits';
 export { InboundFundsHoldReleaseResponse, InboundFundsHolds } from './inbound-funds-holds';
 export {
-  InboundInternationalACHTransfer,
-  InboundInternationalACHTransferCreateParams,
-  InboundInternationalACHTransfers,
-} from './inbound-international-ach-transfers';
-export {
-  InboundRealTimePaymentsTransferSimulationResult,
-  RealTimePaymentsTransferCompleteParams,
-  RealTimePaymentsTransferCreateInboundParams,
-  RealTimePaymentsTransfers,
-} from './real-time-payments-transfers';
+  InboundRealTimePaymentsTransferCreateResponse,
+  InboundRealTimePaymentsTransferCreateParams,
+  InboundRealTimePaymentsTransfers,
+} from './inbound-real-time-payments-transfers';
 export {
   InboundWireDrawdownRequestCreateParams,
   InboundWireDrawdownRequests,
 } from './inbound-wire-drawdown-requests';
+export { InboundWireTransferCreateParams, InboundWireTransfers } from './inbound-wire-transfers';
 export { InterestPaymentCreateParams, InterestPayments } from './interest-payments';
-export { PhysicalCardShipmentAdvanceParams, PhysicalCards } from './physical-cards';
+export { PhysicalCardAdvanceShipmentParams, PhysicalCards } from './physical-cards';
 export { ProgramCreateParams, Programs } from './programs';
 export {
-  SimulationCardAuthorizationExpirationsParams,
-  SimulationCardFuelConfirmationsParams,
-  SimulationCardIncrementsParams,
-  SimulationCardReversalsParams,
-  Simulations,
-} from './simulations';
-export { WireTransferCreateInboundParams, WireTransfers } from './wire-transfers';
+  RealTimePaymentsTransferCompleteParams,
+  RealTimePaymentsTransfers,
+} from './real-time-payments-transfers';
+export { Simulations } from './simulations';
+export { WireTransfers } from './wire-transfers';

package/src/resources/simulations/interest-payments.ts

@@ -14,7 +14,7 @@ export class InterestPayments extends APIResource {
     body: InterestPaymentCreateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<TransactionsAPI.Transaction> {
-    return this._client.post('/simulations/interest_payment', { body, ...options });
+    return this._client.post('/simulations/interest_payments', { body, ...options });
   }
 }
 

package/src/resources/simulations/physical-cards.ts

@@ -11,19 +11,19 @@ export class PhysicalCards extends APIResource {
    * Card, to simulate e.g., that a physical card was attempted shipped but then
    * failed delivery.
    */
-  shipmentAdvance(
+  advanceShipment(
     physicalCardId: string,
-    body: PhysicalCardShipmentAdvanceParams,
+    body: PhysicalCardAdvanceShipmentParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<PhysicalCardsAPI.PhysicalCard> {
-    return this._client.post(`/simulations/physical_cards/${physicalCardId}/shipment_advance`, {
+    return this._client.post(`/simulations/physical_cards/${physicalCardId}/advance_shipment`, {
       body,
       ...options,
     });
   }
 }
 
-export interface PhysicalCardShipmentAdvanceParams {
+export interface PhysicalCardAdvanceShipmentParams {
   /**
    * The shipment status to move the Physical Card to.
    *
@@ -50,5 +50,5 @@ export interface PhysicalCardShipmentAdvanceParams {
 }
 
 export namespace PhysicalCards {
-  export import PhysicalCardShipmentAdvanceParams = SimulationsPhysicalCardsAPI.PhysicalCardShipmentAdvanceParams;
+  export import PhysicalCardAdvanceShipmentParams = SimulationsPhysicalCardsAPI.PhysicalCardAdvanceShipmentParams;
 }