increase 0.5.0 → 0.6.0

package/resources/declined-transactions.ts

@@ -1,623 +0,0 @@
-// File generated from our OpenAPI spec by Stainless.
-
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
-import * as Shared from '~/resources/shared';
-import * as API from './';
-import { Page, PageParams } from '~/pagination';
-
-export class DeclinedTransactions extends APIResource {
-  /**
-   * Retrieve a Declined Transaction
-   */
-  retrieve(
-    declinedTransactionId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<DeclinedTransaction>> {
-    return this.get(`/declined_transactions/${declinedTransactionId}`, options);
-  }
-
-  /**
-   * List Declined Transactions
-   */
-  list(
-    query?: DeclinedTransactionListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<DeclinedTransactionsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<DeclinedTransactionsPage>;
-  list(
-    query: DeclinedTransactionListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<DeclinedTransactionsPage> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this.getAPIList('/declined_transactions', DeclinedTransactionsPage, { query, ...options });
-  }
-}
-
-export class DeclinedTransactionsPage extends Page<DeclinedTransaction> {}
-
-/**
- * Declined Transactions are refused additions and removals of money from your bank
- * account. For example, Declined Transactions are caused when your Account has an
- * insufficient balance or your Limits are triggered.
- */
-export interface DeclinedTransaction {
-  /**
-   * The Declined Transaction identifier.
-   */
-  id: string;
-
-  /**
-   * The identifier for the Account the Declined Transaction belongs to.
-   */
-  account_id: string;
-
-  /**
-   * The Declined Transaction amount in the minor unit of its currency. For dollars,
-   * for example, this is cents.
-   */
-  amount: number;
-
-  /**
-   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
-   * Transaction occured.
-   */
-  created_at: string;
-
-  /**
-   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
-   * Transaction's currency. This will match the currency on the Declined
-   * Transcation's Account.
-   */
-  currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-
-  /**
-   * This is the description the vendor provides.
-   */
-  description: string;
-
-  /**
-   * The identifier for the route this Declined Transaction came through. Routes are
-   * things like cards and ACH details.
-   */
-  route_id: string | null;
-
-  /**
-   * The type of the route this Declined Transaction came through.
-   */
-  route_type: 'account_number' | 'card' | null;
-
-  /**
-   * This is an object giving more details on the network-level event that caused the
-   * Declined Transaction. For example, for a card transaction this lists the
-   * merchant's industry and location. Note that for backwards compatibility reasons,
-   * additional undocumented keys may appear in this object. These should be treated
-   * as deprecated and will be removed in the future.
-   */
-  source: DeclinedTransaction.Source;
-
-  /**
-   * A constant representing the object's type. For this resource it will always be
-   * `declined_transaction`.
-   */
-  type: 'declined_transaction';
-}
-
-export namespace DeclinedTransaction {
-  /**
-   * This is an object giving more details on the network-level event that caused the
-   * Declined Transaction. For example, for a card transaction this lists the
-   * merchant's industry and location. Note that for backwards compatibility reasons,
-   * additional undocumented keys may appear in this object. These should be treated
-   * as deprecated and will be removed in the future.
-   */
-  export interface Source {
-    /**
-     * A ACH Decline object. This field will be present in the JSON response if and
-     * only if `category` is equal to `ach_decline`.
-     */
-    ach_decline: Source.ACHDecline | null;
-
-    /**
-     * A Card Decline object. This field will be present in the JSON response if and
-     * only if `category` is equal to `card_decline`.
-     */
-    card_decline: Source.CardDecline | null;
-
-    /**
-     * The type of decline that took place. We may add additional possible values for
-     * this enum over time; your application should be able to handle such additions
-     * gracefully.
-     */
-    category:
-      | 'ach_decline'
-      | 'card_decline'
-      | 'check_decline'
-      | 'inbound_real_time_payments_transfer_decline'
-      | 'international_ach_decline'
-      | 'wire_decline'
-      | 'other';
-
-    /**
-     * A Check Decline object. This field will be present in the JSON response if and
-     * only if `category` is equal to `check_decline`.
-     */
-    check_decline: Source.CheckDecline | null;
-
-    /**
-     * A Inbound Real Time Payments Transfer Decline object. This field will be present
-     * in the JSON response if and only if `category` is equal to
-     * `inbound_real_time_payments_transfer_decline`.
-     */
-    inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
-
-    /**
-     * A International ACH Decline object. This field will be present in the JSON
-     * response if and only if `category` is equal to `international_ach_decline`.
-     */
-    international_ach_decline: Source.InternationalACHDecline | null;
-
-    /**
-     * A Wire Decline object. This field will be present in the JSON response if and
-     * only if `category` is equal to `wire_decline`.
-     */
-    wire_decline: Source.WireDecline | null;
-  }
-
-  export namespace Source {
-    /**
-     * A ACH Decline object. This field will be present in the JSON response if and
-     * only if `category` is equal to `ach_decline`.
-     */
-    export interface ACHDecline {
-      /**
-       * The declined amount in the minor unit of the destination account currency. For
-       * dollars, for example, this is cents.
-       */
-      amount: number;
-
-      originator_company_descriptive_date: string | null;
-
-      originator_company_discretionary_data: string | null;
-
-      originator_company_id: string;
-
-      originator_company_name: string;
-
-      /**
-       * Why the ACH transfer was declined.
-       */
-      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'
-        | 'no_ach_route'
-        | 'originator_request'
-        | 'transaction_not_allowed';
-
-      receiver_id_number: string | null;
-
-      receiver_name: string | null;
-
-      trace_number: string;
-    }
-
-    /**
-     * A Card Decline object. This field will be present in the JSON response if and
-     * only if `category` is equal to `card_decline`.
-     */
-    export interface CardDecline {
-      /**
-       * The declined amount in the minor unit of the destination account currency. For
-       * dollars, for example, this is cents.
-       */
-      amount: number;
-
-      /**
-       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
-       * account currency.
-       */
-      currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-
-      /**
-       * If the authorization was attempted using a Digital Wallet Token (such as an
-       * Apple Pay purchase), the identifier of the token that was used.
-       */
-      digital_wallet_token_id: string | null;
-
-      /**
-       * The merchant identifier (commonly abbreviated as MID) of the merchant the card
-       * is transacting with.
-       */
-      merchant_acceptor_id: string;
-
-      /**
-       * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
-       * card is transacting with.
-       */
-      merchant_category_code: string | null;
-
-      /**
-       * The city the merchant resides in.
-       */
-      merchant_city: string | null;
-
-      /**
-       * The country the merchant resides in.
-       */
-      merchant_country: string | null;
-
-      /**
-       * The merchant descriptor of the merchant the card is transacting with.
-       */
-      merchant_descriptor: string;
-
-      /**
-       * The state the merchant resides in.
-       */
-      merchant_state: string | null;
-
-      /**
-       * The payment network used to process this card authorization
-       */
-      network: 'visa';
-
-      /**
-       * Fields specific to the `network`
-       */
-      network_details: CardDecline.NetworkDetails;
-
-      /**
-       * The identifier of the Real-Time Decision sent to approve or decline this
-       * transaction.
-       */
-      real_time_decision_id: string | null;
-
-      /**
-       * Why the transaction was declined.
-       */
-      reason:
-        | 'card_not_active'
-        | 'entity_not_active'
-        | 'group_locked'
-        | 'insufficient_funds'
-        | 'cvv2_mismatch'
-        | 'transaction_not_allowed'
-        | 'breaches_internal_limit'
-        | 'breaches_limit'
-        | 'webhook_declined'
-        | 'webhook_timed_out'
-        | 'declined_by_stand_in_processing'
-        | 'invalid_physical_card'
-        | 'missing_original_authorization';
-    }
-
-    export namespace CardDecline {
-      /**
-       * Fields specific to the `network`
-       */
-      export interface NetworkDetails {
-        /**
-         * Fields specific to the `visa` network
-         */
-        visa: NetworkDetails.Visa;
-      }
-
-      export namespace NetworkDetails {
-        /**
-         * Fields specific to the `visa` network
-         */
-        export interface Visa {
-          /**
-           * For electronic commerce transactions, this identifies the level of security used
-           * in obtaining the customer's payment credential. For mail or telephone order
-           * transactions, identifies the type of mail or telephone order.
-           */
-          electronic_commerce_indicator:
-            | 'mail_phone_order'
-            | 'recurring'
-            | 'installment'
-            | 'unknown_mail_phone_order'
-            | 'secure_electronic_commerce'
-            | 'non_authenticated_security_transaction_at_3ds_capable_merchant'
-            | 'non_authenticated_security_transaction'
-            | 'non_secure_transaction'
-            | null;
-
-          /**
-           * The method used to enter the cardholder's primary account number and card
-           * expiration date
-           */
-          point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
-        }
-      }
-    }
-
-    /**
-     * A Check Decline object. This field will be present in the JSON response if and
-     * only if `category` is equal to `check_decline`.
-     */
-    export interface CheckDecline {
-      /**
-       * The declined amount in the minor unit of the destination account currency. For
-       * dollars, for example, this is cents.
-       */
-      amount: number;
-
-      auxiliary_on_us: string | null;
-
-      /**
-       * Why the check was declined.
-       */
-      reason:
-        | 'ach_route_canceled'
-        | 'ach_route_disabled'
-        | 'breaches_limit'
-        | 'entity_not_active'
-        | 'group_locked'
-        | 'insufficient_funds'
-        | 'unable_to_locate_account'
-        | 'not_our_item'
-        | 'unable_to_process'
-        | 'refer_to_image'
-        | 'stop_payment_requested'
-        | 'returned'
-        | 'duplicate_presentment'
-        | 'not_authorized'
-        | 'altered_or_fictitious';
-    }
-
-    /**
-     * A Inbound Real Time Payments Transfer Decline object. This field will be present
-     * in the JSON response if and only if `category` is equal to
-     * `inbound_real_time_payments_transfer_decline`.
-     */
-    export interface InboundRealTimePaymentsTransferDecline {
-      /**
-       * The declined amount in the minor unit of the destination account currency. For
-       * dollars, for example, this is cents.
-       */
-      amount: number;
-
-      /**
-       * The name the sender of the transfer specified as the recipient of the transfer.
-       */
-      creditor_name: string;
-
-      /**
-       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
-       * transfer's currency. This will always be "USD" for a Real Time Payments
-       * transfer.
-       */
-      currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-
-      /**
-       * 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;
-
-      /**
-       * Why the transfer was declined.
-       */
-      reason:
-        | 'account_number_canceled'
-        | 'account_number_disabled'
-        | 'account_restricted'
-        | 'group_locked'
-        | 'entity_not_active'
-        | 'real_time_payments_not_enabled';
-
-      /**
-       * Additional information included with the transfer.
-       */
-      remittance_information: string | null;
-
-      /**
-       * The Real Time Payments network identification of the declined transfer.
-       */
-      transaction_identification: string;
-    }
-
-    /**
-     * A International ACH Decline object. This field will be present in the JSON
-     * response if and only if `category` is equal to `international_ach_decline`.
-     */
-    export interface InternationalACHDecline {
-      /**
-       * The declined amount in the minor unit of the destination account currency. For
-       * dollars, for example, this is cents.
-       */
-      amount: number;
-
-      destination_country_code: string;
-
-      destination_currency_code: string;
-
-      foreign_exchange_indicator: string;
-
-      foreign_exchange_reference: string | null;
-
-      foreign_exchange_reference_indicator: string;
-
-      foreign_payment_amount: number;
-
-      foreign_trace_number: string | null;
-
-      international_transaction_type_code: string;
-
-      originating_currency_code: string;
-
-      originating_depository_financial_institution_branch_country: string;
-
-      originating_depository_financial_institution_id: string;
-
-      originating_depository_financial_institution_id_qualifier: string;
-
-      originating_depository_financial_institution_name: string;
-
-      originator_city: string;
-
-      originator_company_entry_description: string;
-
-      originator_country: string;
-
-      originator_identification: string;
-
-      originator_name: string;
-
-      originator_postal_code: string | null;
-
-      originator_state_or_province: string | null;
-
-      originator_street_address: string;
-
-      payment_related_information: string | null;
-
-      payment_related_information2: string | null;
-
-      receiver_city: string;
-
-      receiver_country: string;
-
-      receiver_identification_number: string | null;
-
-      receiver_postal_code: string | null;
-
-      receiver_state_or_province: string | null;
-
-      receiver_street_address: string;
-
-      receiving_company_or_individual_name: string;
-
-      receiving_depository_financial_institution_country: string;
-
-      receiving_depository_financial_institution_id: string;
-
-      receiving_depository_financial_institution_id_qualifier: string;
-
-      receiving_depository_financial_institution_name: string;
-
-      trace_number: string;
-    }
-
-    /**
-     * A Wire Decline object. This field will be present in the JSON response if and
-     * only if `category` is equal to `wire_decline`.
-     */
-    export interface WireDecline {
-      /**
-       * The declined amount in the minor unit of the destination account currency. For
-       * dollars, for example, this is cents.
-       */
-      amount: number;
-
-      beneficiary_address_line1: string | null;
-
-      beneficiary_address_line2: string | null;
-
-      beneficiary_address_line3: string | null;
-
-      beneficiary_name: string | null;
-
-      beneficiary_reference: string | null;
-
-      description: string;
-
-      input_message_accountability_data: string | null;
-
-      originator_address_line1: string | null;
-
-      originator_address_line2: string | null;
-
-      originator_address_line3: string | null;
-
-      originator_name: string | null;
-
-      originator_to_beneficiary_information_line1: string | null;
-
-      originator_to_beneficiary_information_line2: string | null;
-
-      originator_to_beneficiary_information_line3: string | null;
-
-      originator_to_beneficiary_information_line4: string | null;
-
-      /**
-       * Why the wire transfer was declined.
-       */
-      reason:
-        | 'account_number_canceled'
-        | 'account_number_disabled'
-        | 'entity_not_active'
-        | 'group_locked'
-        | 'no_account_number'
-        | 'transaction_not_allowed';
-    }
-  }
-}
-
-export interface DeclinedTransactionListParams extends PageParams {
-  /**
-   * Filter Declined Transactions to ones belonging to the specified Account.
-   */
-  account_id?: string;
-
-  created_at?: DeclinedTransactionListParams.CreatedAt;
-
-  /**
-   * Filter Declined Transactions to those belonging to the specified route.
-   */
-  route_id?: string;
-}
-
-export namespace DeclinedTransactionListParams {
-  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 DeclinedTransactions {
-  export import DeclinedTransaction = API.DeclinedTransaction;
-  export import DeclinedTransactionsPage = API.DeclinedTransactionsPage;
-  export import DeclinedTransactionListParams = API.DeclinedTransactionListParams;
-}