increase 0.2.0 → 0.3.0

package/resources/cards.ts

@@ -43,7 +43,6 @@ export class Cards extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/cards', CardsPage, { query, ...options });
   }
 
@@ -128,6 +127,9 @@ export interface Card {
 }
 
 export namespace Card {
+  /**
+   * The Card's billing address.
+   */
   export interface BillingAddress {
     /**
      * The city of the billing address.
@@ -155,6 +157,11 @@ export namespace Card {
     state: string | null;
   }
 
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. At least one field must be present to complete the digital wallet
+   * steps.
+   */
   export interface DigitalWallet {
     /**
      * The card profile assigned to this digital card. Card profiles may also be
@@ -232,13 +239,75 @@ export interface CardCreateParams {
 
   /**
    * The contact information used in the two-factor steps for digital wallet card
-   * creation. At least one field must be present to complete the digital wallet
-   * steps.
+   * creation. To add the card to a digital wallet, you may supply an email or phone
+   * number with this request. Otherwise, subscribe and then action a Real Time
+   * Decision with the category `digital_wallet_token_requested` or
+   * `digital_wallet_authentication_requested`.
    */
   digital_wallet?: CardCreateParams.DigitalWallet;
 }
 
 export namespace CardCreateParams {
+  /**
+   * The card's billing address.
+   */
+  export interface BillingAddress {
+    /**
+     * The city of the billing address.
+     */
+    city: string;
+
+    /**
+     * The first line of the billing address.
+     */
+    line1: string;
+
+    /**
+     * The postal code of the billing address.
+     */
+    postal_code: string;
+
+    /**
+     * The US state of the billing address.
+     */
+    state: string;
+
+    /**
+     * The second line of the billing address.
+     */
+    line2?: string;
+  }
+
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. To add the card to a digital wallet, you may supply an email or phone
+   * number with this request. Otherwise, subscribe and then action a Real Time
+   * Decision with the category `digital_wallet_token_requested` or
+   * `digital_wallet_authentication_requested`.
+   */
+  export interface DigitalWallet {
+    /**
+     * The card profile assigned to this digital card. Card profiles may also be
+     * assigned at the program level.
+     */
+    card_profile_id?: string;
+
+    /**
+     * An email address that can be used to verify the cardholder via one-time passcode
+     * over email.
+     */
+    email?: string;
+
+    /**
+     * A phone number that can be used to verify the cardholder via one-time passcode
+     * over SMS.
+     */
+    phone?: string;
+  }
+
+  /**
+   * The card's billing address.
+   */
   export interface BillingAddress {
     /**
      * The city of the billing address.
@@ -266,6 +335,13 @@ export namespace CardCreateParams {
     line2?: string;
   }
 
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. To add the card to a digital wallet, you may supply an email or phone
+   * number with this request. Otherwise, subscribe and then action a Real Time
+   * Decision with the category `digital_wallet_token_requested` or
+   * `digital_wallet_authentication_requested`.
+   */
   export interface DigitalWallet {
     /**
      * The card profile assigned to this digital card. Card profiles may also be
@@ -312,6 +388,64 @@ export interface CardUpdateParams {
 }
 
 export namespace CardUpdateParams {
+  /**
+   * The card's updated billing address.
+   */
+  export interface BillingAddress {
+    /**
+     * The city of the billing address.
+     */
+    city: string;
+
+    /**
+     * The first line of the billing address.
+     */
+    line1: string;
+
+    /**
+     * The postal code of the billing address.
+     */
+    postal_code: string;
+
+    /**
+     * The US state of the billing address.
+     */
+    state: string;
+
+    /**
+     * The second line of the billing address.
+     */
+    line2?: string;
+  }
+
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. At least one field must be present to complete the digital wallet
+   * steps.
+   */
+  export interface DigitalWallet {
+    /**
+     * The card profile assigned to this digital card. Card profiles may also be
+     * assigned at the program level.
+     */
+    card_profile_id?: string;
+
+    /**
+     * An email address that can be used to verify the cardholder via one-time passcode
+     * over email.
+     */
+    email?: string;
+
+    /**
+     * A phone number that can be used to verify the cardholder via one-time passcode
+     * over SMS.
+     */
+    phone?: string;
+  }
+
+  /**
+   * The card's updated billing address.
+   */
   export interface BillingAddress {
     /**
      * The city of the billing address.
@@ -339,6 +473,11 @@ export namespace CardUpdateParams {
     line2?: string;
   }
 
+  /**
+   * The contact information used in the two-factor steps for digital wallet card
+   * creation. At least one field must be present to complete the digital wallet
+   * steps.
+   */
   export interface DigitalWallet {
     /**
      * The card profile assigned to this digital card. Card profiles may also be
@@ -366,7 +505,29 @@ export interface CardListParams extends PageParams {
    */
   account_id?: string;
 
-  created_at?: CardListParams.CreatedAt;
+  /**
+   * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   * timestamp.
+   */
+  'created_at.after'?: string;
+
+  /**
+   * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   * timestamp.
+   */
+  'created_at.before'?: string;
+
+  /**
+   * Return results on or after this
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+   */
+  'created_at.on_or_after'?: string;
+
+  /**
+   * Return results on or before this
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+   */
+  'created_at.on_or_before'?: string;
 }
 
 export namespace CardListParams {

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
@@ -271,7 +283,29 @@ export interface CheckDepositListParams extends PageParams {
    */
   account_id?: string;
 
-  created_at?: CheckDepositListParams.CreatedAt;
+  /**
+   * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   * timestamp.
+   */
+  'created_at.after'?: string;
+
+  /**
+   * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   * timestamp.
+   */
+  'created_at.before'?: string;
+
+  /**
+   * Return results on or after this
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+   */
+  'created_at.on_or_after'?: string;
+
+  /**
+   * Return results on or before this
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+   */
+  'created_at.on_or_before'?: string;
 }
 
 export namespace CheckDepositListParams {

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,13 +165,19 @@ 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'
     | 'mailed'
@@ -188,11 +205,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 +218,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 +253,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 +331,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 +356,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 {
@@ -303,6 +408,11 @@ export interface CheckTransferCreateParams {
    */
   address_line1: string;
 
+  /**
+   * The second line of the address of the check's destination.
+   */
+  address_line2?: string;
+
   /**
    * The state of the check's destination.
    */
@@ -324,19 +434,14 @@ export interface CheckTransferCreateParams {
   message: string;
 
   /**
-   * The name that will be printed on the check.
-   */
-  recipient_name: string;
-
-  /**
-   * The second line of the address of the check's destination.
+   * The descriptor that will be printed on the letter included with the check.
    */
-  address_line2?: string;
+  note?: string;
 
   /**
-   * The descriptor that will be printed on the letter included with the check.
+   * The name that will be printed on the check.
    */
-  note?: string;
+  recipient_name: string;
 
   /**
    * Whether the transfer requires explicit approval via the dashboard or API.
@@ -351,6 +456,46 @@ 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.
+     */
+    city: string;
+
+    /**
+     * The first line of the return address.
+     */
+    line1: string;
+
+    /**
+     * The name of the return address.
+     */
+    name: string;
+
+    /**
+     * The US state of the return address.
+     */
+    state: string;
+
+    /**
+     * The postal code of the return address.
+     */
+    zip: string;
+
+    /**
+     * The second line of the return address.
+     */
+    line2?: string;
+  }
+
+  /**
+   * 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.
@@ -390,7 +535,29 @@ export interface CheckTransferListParams extends PageParams {
    */
   account_id?: string;
 
-  created_at?: CheckTransferListParams.CreatedAt;
+  /**
+   * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   * timestamp.
+   */
+  'created_at.after'?: string;
+
+  /**
+   * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   * timestamp.
+   */
+  'created_at.before'?: string;
+
+  /**
+   * Return results on or after this
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+   */
+  'created_at.on_or_after'?: string;
+
+  /**
+   * Return results on or before this
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+   */
+  'created_at.on_or_before'?: string;
 }
 
 export namespace CheckTransferListParams {