increase 0.2.0 → 0.4.0

package/resources/check-deposits.ts

@@ -35,7 +35,6 @@ export class CheckDeposits extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/check_deposits', CheckDepositsPage, { query, ...options });
   }
 }
@@ -119,6 +118,10 @@ export interface CheckDeposit {
 }
 
 export namespace CheckDeposit {
+  /**
+   * If your deposit is successfully parsed and accepted by Increase, this will
+   * contain details of the parsed check.
+   */
   export interface DepositAcceptance {
     /**
      * The account number printed on the check.
@@ -160,6 +163,10 @@ export namespace CheckDeposit {
     serial_number: string | null;
   }
 
+  /**
+   * If your deposit is rejected by Increase, this will contain details as to why it
+   * was rejected.
+   */
   export interface DepositRejection {
     /**
      * The rejected amount in the minor unit of check's currency. For dollars, for
@@ -183,6 +190,7 @@ export namespace CheckDeposit {
       | 'incorrect_amount'
       | 'incorrect_recipient'
       | 'not_eligible_for_mobile_deposit'
+      | 'missing_required_data_elements'
       | 'unknown';
 
     /**
@@ -192,6 +200,10 @@ export namespace CheckDeposit {
     rejected_at: string;
   }
 
+  /**
+   * If your deposit is returned, this will contain details as to why it was
+   * returned.
+   */
   export interface DepositReturn {
     /**
      * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -221,7 +233,8 @@ export namespace CheckDeposit {
       | 'stop_payment'
       | 'unknown_reason'
       | 'unmatched_details'
-      | 'unreadable_image';
+      | 'unreadable_image'
+      | 'endorsement_irregular';
 
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which

package/resources/check-transfers.ts

@@ -35,7 +35,6 @@ export class CheckTransfers extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/check_transfers', CheckTransfersPage, { query, ...options });
   }
 
@@ -106,6 +105,18 @@ export interface CheckTransfer {
    */
   amount: number;
 
+  /**
+   * If your account requires approvals for transfers and the transfer was approved,
+   * this will contain details of the approval.
+   */
+  approval: CheckTransfer.Approval | null;
+
+  /**
+   * If your account requires approvals for transfers and the transfer was not
+   * approved, this will contain details of the cancellation.
+   */
+  cancellation: CheckTransfer.Cancellation | null;
+
   /**
    * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
    * the transfer was created.
@@ -154,15 +165,22 @@ export interface CheckTransfer {
    */
   return_address: CheckTransfer.ReturnAddress | null;
 
+  /**
+   * After a check transfer is returned, this will contain supplemental details. A
+   * check transfer is returned when the receiver mails a never deposited check back
+   * to the bank printed on the check.
+   */
+  return_details: CheckTransfer.ReturnDetails | null;
+
   /**
    * The lifecycle status of the transfer.
    */
   status:
     | 'pending_approval'
     | 'pending_submission'
-    | 'submitting'
     | 'submitted'
     | 'pending_mailing'
+    | 'stopped_and_pending_mailing'
     | 'mailed'
     | 'canceled'
     | 'deposited'
@@ -188,11 +206,6 @@ export interface CheckTransfer {
    */
   submitted_at: string | null;
 
-  /**
-   * If the transfer was created from a template, this will be the template's ID.
-   */
-  template_id: string | null;
-
   /**
    * The ID for the transaction caused by the transfer.
    */
@@ -206,6 +219,9 @@ export interface CheckTransfer {
 }
 
 export namespace CheckTransfer {
+  /**
+   * The return address to be printed on the check.
+   */
   export interface ReturnAddress {
     /**
      * The city of the address.
@@ -238,13 +254,61 @@ export namespace CheckTransfer {
     zip: string | null;
   }
 
+  /**
+   * If your account requires approvals for transfers and the transfer was approved,
+   * this will contain details of the approval.
+   */
+  export interface Approval {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the transfer was approved.
+     */
+    approved_at: string;
+
+    /**
+     * If the Transfer was approved by a user in the dashboard, the email address of
+     * that user.
+     */
+    approved_by: string | null;
+  }
+
+  /**
+   * If your account requires approvals for transfers and the transfer was not
+   * approved, this will contain details of the cancellation.
+   */
+  export interface Cancellation {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the Transfer was canceled.
+     */
+    canceled_at: string;
+
+    /**
+     * If the Transfer was canceled by a user in the dashboard, the email address of
+     * that user.
+     */
+    canceled_by: string | null;
+  }
+
+  /**
+   * After the transfer is submitted, this will contain supplemental details.
+   */
   export interface Submission {
     /**
      * The identitying number of the check.
      */
     check_number: string;
+
+    /**
+     * When this check transfer was submitted to our check printer.
+     */
+    submitted_at: string;
   }
 
+  /**
+   * After a stop-payment is requested on the check, this will contain supplemental
+   * details.
+   */
   export interface StopPaymentRequest {
     /**
      * The time the stop-payment was requested.
@@ -268,12 +332,20 @@ export namespace CheckTransfer {
     type: 'check_transfer_stop_payment_request';
   }
 
+  /**
+   * After a check transfer is deposited, this will contain supplemental details.
+   */
   export interface Deposit {
     /**
      * The ID for the File containing the image of the rear of the check.
      */
     back_image_file_id: string | null;
 
+    /**
+     * When the check was deposited.
+     */
+    deposited_at: string;
+
     /**
      * The ID for the File containing the image of the front of the check.
      */
@@ -285,6 +357,40 @@ export namespace CheckTransfer {
      */
     type: 'check_transfer_deposit';
   }
+
+  /**
+   * After a check transfer is returned, this will contain supplemental details. A
+   * check transfer is returned when the receiver mails a never deposited check back
+   * to the bank printed on the check.
+   */
+  export interface ReturnDetails {
+    /**
+     * If available, a document with additional information about the return.
+     */
+    file_id: string | null;
+
+    /**
+     * The reason why the check was returned.
+     */
+    reason: 'mail_delivery_failure' | 'refused_by_recipient' | 'returned_not_authorized';
+
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the check was returned.
+     */
+    returned_at: string;
+
+    /**
+     * The identifier of the Transaction that was created to credit you for the
+     * returned check.
+     */
+    transaction_id: string | null;
+
+    /**
+     * The identifier of the returned Check Transfer.
+     */
+    transfer_id: string;
+  }
 }
 
 export interface CheckTransferCreateParams {
@@ -351,6 +457,10 @@ export interface CheckTransferCreateParams {
 }
 
 export namespace CheckTransferCreateParams {
+  /**
+   * The return address to be printed on the check. If omitted this will default to
+   * the address of the Entity of the Account used to make the Check Transfer.
+   */
   export interface ReturnAddress {
     /**
      * The city of the return address.

package/resources/declined-transactions.ts

@@ -3,8 +3,8 @@
 import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import { isRequestOptions } from '~/core';
-import { Page, PageParams } from '~/pagination';
 import * as Shared from '~/resources/shared';
+import { Page, PageParams } from '~/pagination';
 
 export class DeclinedTransactions extends APIResource {
   /**
@@ -32,7 +32,6 @@ export class DeclinedTransactions extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/declined_transactions', DeclinedTransactionsPage, { query, ...options });
   }
 }
@@ -88,7 +87,7 @@ export interface DeclinedTransaction {
   /**
    * The type of the route this Declined Transaction came through.
    */
-  route_type: string | null;
+  route_type: 'account_number' | 'card' | null;
 
   /**
    * This is an object giving more details on the network-level event that caused the
@@ -107,6 +106,13 @@ export interface DeclinedTransaction {
 }
 
 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
@@ -120,12 +126,6 @@ export namespace DeclinedTransaction {
      */
     card_decline: Source.CardDecline | null;
 
-    /**
-     * A Deprecated Card Decline object. This field will be present in the JSON
-     * response if and only if `category` is equal to `card_route_decline`.
-     */
-    card_route_decline: Source.CardRouteDecline | 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
@@ -137,7 +137,7 @@ export namespace DeclinedTransaction {
       | 'check_decline'
       | 'inbound_real_time_payments_transfer_decline'
       | 'international_ach_decline'
-      | 'card_route_decline'
+      | 'wire_decline'
       | 'other';
 
     /**
@@ -158,9 +158,19 @@ export namespace DeclinedTransaction {
      * 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
@@ -186,11 +196,12 @@ export namespace DeclinedTransaction {
         | 'credit_entry_refused_by_receiver'
         | 'duplicate_return'
         | 'entity_not_active'
-        | 'transaction_not_allowed'
         | 'group_locked'
         | 'insufficient_funds'
+        | 'misrouted_return'
         | 'no_ach_route'
-        | 'originator_request';
+        | 'originator_request'
+        | 'transaction_not_allowed';
 
       receiver_id_number: string | null;
 
@@ -199,6 +210,10 @@ export namespace DeclinedTransaction {
       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
@@ -276,13 +291,19 @@ export namespace DeclinedTransaction {
         | 'insufficient_funds'
         | 'cvv2_mismatch'
         | 'transaction_not_allowed'
+        | 'breaches_internal_limit'
         | 'breaches_limit'
         | 'webhook_declined'
         | 'webhook_timed_out'
-        | 'declined_by_stand_in_processing';
+        | '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
@@ -291,6 +312,9 @@ export namespace DeclinedTransaction {
       }
 
       export namespace NetworkDetails {
+        /**
+         * Fields specific to the `visa` network
+         */
         export interface Visa {
           /**
            * For electronic commerce transactions, this identifies the level of security used
@@ -312,11 +336,15 @@ export namespace DeclinedTransaction {
            * The method used to enter the cardholder's primary account number and card
            * expiration date
            */
-          point_of_service_entry_mode: Shared.PointOfServiceEntryMode;
+          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
@@ -337,12 +365,21 @@ export namespace DeclinedTransaction {
         | 'group_locked'
         | 'insufficient_funds'
         | 'unable_to_locate_account'
+        | 'not_our_item'
         | 'unable_to_process'
         | 'refer_to_image'
         | 'stop_payment_requested'
-        | 'returned';
+        | '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
@@ -383,6 +420,7 @@ export namespace DeclinedTransaction {
       reason:
         | 'account_number_canceled'
         | 'account_number_disabled'
+        | 'account_restricted'
         | 'group_locked'
         | 'entity_not_active'
         | 'real_time_payments_not_enabled';
@@ -398,6 +436,10 @@ export namespace DeclinedTransaction {
       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
@@ -476,30 +518,57 @@ export namespace DeclinedTransaction {
       trace_number: string;
     }
 
-    export interface CardRouteDecline {
+    /**
+     * 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;
 
-      /**
-       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
-       * account currency.
-       */
-      currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+      beneficiary_address_line1: string | null;
 
-      merchant_acceptor_id: string;
+      beneficiary_address_line2: string | null;
 
-      merchant_category_code: string | null;
+      beneficiary_address_line3: string | null;
 
-      merchant_city: string | null;
+      beneficiary_name: string | null;
 
-      merchant_country: string;
+      beneficiary_reference: string | null;
 
-      merchant_descriptor: string;
+      description: string;
 
-      merchant_state: string | null;
+      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';
     }
   }
 }

package/resources/digital-wallet-tokens.ts

@@ -31,7 +31,6 @@ export class DigitalWalletTokens extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/digital_wallet_tokens', DigitalWalletTokensPage, { query, ...options });
   }
 }

package/resources/documents.ts

@@ -25,7 +25,6 @@ export class Documents extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/documents', DocumentsPage, { query, ...options });
   }
 }
@@ -41,7 +40,56 @@ export interface Document {
   /**
    * The type of document.
    */
-  category: 'form_1099_int';
+  category:
+    | 'account_opening_disclosures'
+    | 'anti_money_laundering_policy'
+    | 'anti_money_laundering_procedures'
+    | 'audit_report'
+    | 'background_checks'
+    | 'business_continuity_plan'
+    | 'collections_policy'
+    | 'complaints_policy'
+    | 'complaint_report'
+    | 'compliance_report'
+    | 'compliance_staffing_plan'
+    | 'compliance_management_system_policy'
+    | 'consumer_privacy_notice'
+    | 'consumer_protection_policy'
+    | 'corporate_formation_document'
+    | 'credit_monitoring_report'
+    | 'customer_information_program_policy'
+    | 'electronic_funds_tranfer_act_policy'
+    | 'employee_overview'
+    | 'end_user_terms_of_service'
+    | 'e_sign_policy'
+    | 'financial_statement'
+    | 'form_1099_int'
+    | 'fraud_prevention_policy'
+    | 'funds_availability_policy'
+    | 'funds_availability_disclosure'
+    | 'funds_flow_diagram'
+    | 'gramm_leach_bliley_act_policy'
+    | 'information_security_policy'
+    | 'insurance_policy'
+    | 'investor_presentation'
+    | 'loan_application_processing_policy'
+    | 'management_biography'
+    | 'marketing_and_advertising_policy'
+    | 'network_security_diagram'
+    | 'onboarding_questionnaire'
+    | 'penetration_test_report'
+    | 'platform_compliance_metrics_submission'
+    | 'consumer_platform_compliance_metrics_submission'
+    | 'program_risk_assessment'
+    | 'security_audit_report'
+    | 'servicing_policy'
+    | 'transaction_monitoring_report'
+    | 'truth_in_savings_act_policy'
+    | 'underwriting_policy'
+    | 'vendor_list'
+    | 'vendor_management_policy'
+    | 'vendor_risk_management_report'
+    | 'volume_forecast';
 
   /**
    * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
@@ -85,10 +133,61 @@ export interface DocumentListParams extends PageParams {
 export namespace DocumentListParams {
   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`.
+     * Filter Documents 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<'form_1099_int'>;
+    in?: Array<
+      | 'account_opening_disclosures'
+      | 'anti_money_laundering_policy'
+      | 'anti_money_laundering_procedures'
+      | 'audit_report'
+      | 'background_checks'
+      | 'business_continuity_plan'
+      | 'collections_policy'
+      | 'complaints_policy'
+      | 'complaint_report'
+      | 'compliance_report'
+      | 'compliance_staffing_plan'
+      | 'compliance_management_system_policy'
+      | 'consumer_privacy_notice'
+      | 'consumer_protection_policy'
+      | 'corporate_formation_document'
+      | 'credit_monitoring_report'
+      | 'customer_information_program_policy'
+      | 'electronic_funds_tranfer_act_policy'
+      | 'employee_overview'
+      | 'end_user_terms_of_service'
+      | 'e_sign_policy'
+      | 'financial_statement'
+      | 'form_1099_int'
+      | 'fraud_prevention_policy'
+      | 'funds_availability_policy'
+      | 'funds_availability_disclosure'
+      | 'funds_flow_diagram'
+      | 'gramm_leach_bliley_act_policy'
+      | 'information_security_policy'
+      | 'insurance_policy'
+      | 'investor_presentation'
+      | 'loan_application_processing_policy'
+      | 'management_biography'
+      | 'marketing_and_advertising_policy'
+      | 'network_security_diagram'
+      | 'onboarding_questionnaire'
+      | 'penetration_test_report'
+      | 'platform_compliance_metrics_submission'
+      | 'consumer_platform_compliance_metrics_submission'
+      | 'program_risk_assessment'
+      | 'security_audit_report'
+      | 'servicing_policy'
+      | 'transaction_monitoring_report'
+      | 'truth_in_savings_act_policy'
+      | 'underwriting_policy'
+      | 'vendor_list'
+      | 'vendor_management_policy'
+      | 'vendor_risk_management_report'
+      | 'volume_forecast'
+    >;
   }
 
   export interface CreatedAt {