increase 0.155.0 → 0.157.0

package/src/resources/card-payments.ts

@@ -1381,6 +1381,12 @@ export namespace CardPayment {
        */
       card_payment_id: string;
 
+      /**
+       * Cashback debited for this transaction, if eligible. Cashback is paid out in
+       * aggregate, monthly.
+       */
+      cashback: CardRefund.Cashback | null;
+
       /**
        * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
        * transaction's settlement currency.
@@ -1470,6 +1476,31 @@ export namespace CardPayment {
     }
 
     export namespace CardRefund {
+      /**
+       * Cashback debited for this transaction, if eligible. Cashback is paid out in
+       * aggregate, monthly.
+       */
+      export interface Cashback {
+        /**
+         * The cashback amount given as a string containing a decimal number. The amount is
+         * a positive number if it will be credited to you (e.g., settlements) and a
+         * negative number if it will be debited (e.g., refunds).
+         */
+        amount: string;
+
+        /**
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
+         *
+         * - `CAD` - Canadian Dollar (CAD)
+         * - `CHF` - Swiss Franc (CHF)
+         * - `EUR` - Euro (EUR)
+         * - `GBP` - British Pound (GBP)
+         * - `JPY` - Japanese Yen (JPY)
+         * - `USD` - US Dollar (USD)
+         */
+        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+      }
+
       /**
        * Interchange assessed as a part of this transaciton.
        */
@@ -2229,6 +2260,12 @@ export namespace CardPayment {
        */
       card_payment_id: string;
 
+      /**
+       * Cashback earned on this transaction, if eligible. Cashback is paid out in
+       * aggregate, monthly.
+       */
+      cashback: CardSettlement.Cashback | null;
+
       /**
        * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
        * transaction's settlement currency.
@@ -2243,7 +2280,7 @@ export namespace CardPayment {
       currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
       /**
-       * Interchange assessed as a part of this transaciton.
+       * Interchange assessed as a part of this transaction.
        */
       interchange: CardSettlement.Interchange | null;
 
@@ -2324,7 +2361,32 @@ export namespace CardPayment {
 
     export namespace CardSettlement {
       /**
-       * Interchange assessed as a part of this transaciton.
+       * Cashback earned on this transaction, if eligible. Cashback is paid out in
+       * aggregate, monthly.
+       */
+      export interface Cashback {
+        /**
+         * The cashback amount given as a string containing a decimal number. The amount is
+         * a positive number if it will be credited to you (e.g., settlements) and a
+         * negative number if it will be debited (e.g., refunds).
+         */
+        amount: string;
+
+        /**
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
+         *
+         * - `CAD` - Canadian Dollar (CAD)
+         * - `CHF` - Swiss Franc (CHF)
+         * - `EUR` - Euro (EUR)
+         * - `GBP` - British Pound (GBP)
+         * - `JPY` - Japanese Yen (JPY)
+         * - `USD` - US Dollar (USD)
+         */
+        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+      }
+
+      /**
+       * Interchange assessed as a part of this transaction.
        */
       export interface Interchange {
         /**

package/src/resources/exports.ts

@@ -65,6 +65,8 @@ export interface Export {
    * - `entity_csv` - Export a CSV of entities with a given status.
    * - `vendor_csv` - Export a CSV of vendors added to the third-party risk
    *   management dashboard.
+   * - `dashboard_table_csv` - Certain dashboard tables are available as CSV exports.
+   *   This export cannot be created via the API.
    */
   category:
     | 'account_statement_ofx'
@@ -72,7 +74,8 @@ export interface Export {
     | 'balance_csv'
     | 'bookkeeping_account_balance_csv'
     | 'entity_csv'
-    | 'vendor_csv';
+    | 'vendor_csv'
+    | 'dashboard_table_csv';
 
   /**
    * The time the Export was created.
@@ -426,6 +429,7 @@ export namespace ExportListParams {
       | 'bookkeeping_account_balance_csv'
       | 'entity_csv'
       | 'vendor_csv'
+      | 'dashboard_table_csv'
     >;
   }
 

package/src/resources/groups.ts

@@ -14,8 +14,9 @@ export class Groups extends APIResource {
 
 /**
  * Groups represent organizations using Increase. You can retrieve information
- * about your own organization via the API, or (more commonly) OAuth platforms can
+ * about your own organization via the API. More commonly, OAuth platforms can
  * retrieve information about the organizations that have granted them access.
+ * Learn more about OAuth [here](https://increase.com/documentation/oauth).
  */
 export interface Group {
   /**

package/src/resources/inbound-mail-items.ts

@@ -70,7 +70,7 @@ export interface InboundMailItem {
    *
    * - `no_matching_lockbox` - The mail item does not match any lockbox.
    * - `no_check` - The mail item does not contain a check.
-   * - `lockbox_not_active` - The Lockbox or its associataed Account is not active.
+   * - `lockbox_not_active` - The Lockbox or its associated Account is not active.
    */
   rejection_reason: 'no_matching_lockbox' | 'no_check' | 'lockbox_not_active' | null;
 

package/src/resources/index.ts

@@ -235,6 +235,12 @@ export {
   type LockboxUpdateParams,
   type LockboxListParams,
 } from './lockboxes';
+export {
+  OAuthApplicationsPage,
+  OAuthApplications,
+  type OAuthApplication,
+  type OAuthApplicationListParams,
+} from './oauth-applications';
 export {
   OAuthConnectionsPage,
   OAuthConnections,

package/src/resources/oauth-applications.ts

@@ -0,0 +1,137 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import { Page, type PageParams } from '../pagination';
+
+export class OAuthApplications extends APIResource {
+  /**
+   * Retrieve an OAuth Application
+   */
+  retrieve(oauthApplicationId: string, options?: Core.RequestOptions): Core.APIPromise<OAuthApplication> {
+    return this._client.get(`/oauth_applications/${oauthApplicationId}`, options);
+  }
+
+  /**
+   * List OAuth Applications
+   */
+  list(
+    query?: OAuthApplicationListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<OAuthApplicationsPage, OAuthApplication>;
+  list(options?: Core.RequestOptions): Core.PagePromise<OAuthApplicationsPage, OAuthApplication>;
+  list(
+    query: OAuthApplicationListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<OAuthApplicationsPage, OAuthApplication> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/oauth_applications', OAuthApplicationsPage, { query, ...options });
+  }
+}
+
+export class OAuthApplicationsPage extends Page<OAuthApplication> {}
+
+/**
+ * An OAuth Application lets you build an application for others to use with their
+ * Increase data. You can create an OAuth Application via the Dashboard and read
+ * information about it with the API. Learn more about OAuth
+ * [here](https://increase.com/documentation/oauth).
+ */
+export interface OAuthApplication {
+  /**
+   * The OAuth Application's identifier.
+   */
+  id: string;
+
+  /**
+   * The OAuth Application's client_id. Use this to authenticate with the OAuth
+   * Application.
+   */
+  client_id: string;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+   * Application was created.
+   */
+  created_at: string;
+
+  /**
+   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+   * Application was deleted.
+   */
+  deleted_at: string | null;
+
+  /**
+   * The name you chose for this OAuth Application.
+   */
+  name: string | null;
+
+  /**
+   * Whether the application is active.
+   *
+   * - `active` - The application is active and can be used by your users.
+   * - `deleted` - The application is deleted.
+   */
+  status: 'active' | 'deleted';
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `oauth_application`.
+   */
+  type: 'oauth_application';
+}
+
+export interface OAuthApplicationListParams extends PageParams {
+  created_at?: OAuthApplicationListParams.CreatedAt;
+
+  status?: OAuthApplicationListParams.Status;
+}
+
+export namespace OAuthApplicationListParams {
+  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 Status {
+    /**
+     * 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<'active' | 'deleted'>;
+  }
+}
+
+OAuthApplications.OAuthApplicationsPage = OAuthApplicationsPage;
+
+export declare namespace OAuthApplications {
+  export {
+    type OAuthApplication as OAuthApplication,
+    OAuthApplicationsPage as OAuthApplicationsPage,
+    type OAuthApplicationListParams as OAuthApplicationListParams,
+  };
+}

package/src/resources/oauth-connections.ts

@@ -62,6 +62,11 @@ export interface OAuthConnection {
    */
   group_id: string;
 
+  /**
+   * The identifier of the OAuth application this connection is for.
+   */
+  oauth_application_id: string;
+
   /**
    * Whether the connection is active.
    *
@@ -78,6 +83,12 @@ export interface OAuthConnection {
 }
 
 export interface OAuthConnectionListParams extends PageParams {
+  /**
+   * Filter results to only include OAuth Connections for a specific OAuth
+   * Application.
+   */
+  oauth_application_id?: string;
+
   status?: OAuthConnectionListParams.Status;
 }
 

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

@@ -67,6 +67,12 @@ export interface RealTimePaymentsTransfer {
    */
   account_id: string;
 
+  /**
+   * If the transfer is acknowledged by the recipient bank, this will contain
+   * supplemental details.
+   */
+  acknowledgement: RealTimePaymentsTransfer.Acknowledgement | null;
+
   /**
    * The transfer amount in USD cents.
    */
@@ -223,6 +229,17 @@ export interface RealTimePaymentsTransfer {
 }
 
 export namespace RealTimePaymentsTransfer {
+  /**
+   * If the transfer is acknowledged by the recipient bank, this will contain
+   * supplemental details.
+   */
+  export interface Acknowledgement {
+    /**
+     * When the transfer was acknowledged.
+     */
+    acknowledged_at: string;
+  }
+
   /**
    * If your account requires approvals for transfers and the transfer was approved,
    * this will contain details of the approval.

package/src/resources/transactions.ts

@@ -791,6 +791,12 @@ export namespace Transaction {
        */
       card_payment_id: string;
 
+      /**
+       * Cashback debited for this transaction, if eligible. Cashback is paid out in
+       * aggregate, monthly.
+       */
+      cashback: CardRefund.Cashback | null;
+
       /**
        * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
        * transaction's settlement currency.
@@ -880,6 +886,31 @@ export namespace Transaction {
     }
 
     export namespace CardRefund {
+      /**
+       * Cashback debited for this transaction, if eligible. Cashback is paid out in
+       * aggregate, monthly.
+       */
+      export interface Cashback {
+        /**
+         * The cashback amount given as a string containing a decimal number. The amount is
+         * a positive number if it will be credited to you (e.g., settlements) and a
+         * negative number if it will be debited (e.g., refunds).
+         */
+        amount: string;
+
+        /**
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
+         *
+         * - `CAD` - Canadian Dollar (CAD)
+         * - `CHF` - Swiss Franc (CHF)
+         * - `EUR` - Euro (EUR)
+         * - `GBP` - British Pound (GBP)
+         * - `JPY` - Japanese Yen (JPY)
+         * - `USD` - US Dollar (USD)
+         */
+        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+      }
+
       /**
        * Interchange assessed as a part of this transaciton.
        */
@@ -1527,6 +1558,12 @@ export namespace Transaction {
        */
       card_payment_id: string;
 
+      /**
+       * Cashback earned on this transaction, if eligible. Cashback is paid out in
+       * aggregate, monthly.
+       */
+      cashback: CardSettlement.Cashback | null;
+
       /**
        * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
        * transaction's settlement currency.
@@ -1541,7 +1578,7 @@ export namespace Transaction {
       currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
       /**
-       * Interchange assessed as a part of this transaciton.
+       * Interchange assessed as a part of this transaction.
        */
       interchange: CardSettlement.Interchange | null;
 
@@ -1622,7 +1659,32 @@ export namespace Transaction {
 
     export namespace CardSettlement {
       /**
-       * Interchange assessed as a part of this transaciton.
+       * Cashback earned on this transaction, if eligible. Cashback is paid out in
+       * aggregate, monthly.
+       */
+      export interface Cashback {
+        /**
+         * The cashback amount given as a string containing a decimal number. The amount is
+         * a positive number if it will be credited to you (e.g., settlements) and a
+         * negative number if it will be debited (e.g., refunds).
+         */
+        amount: string;
+
+        /**
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
+         *
+         * - `CAD` - Canadian Dollar (CAD)
+         * - `CHF` - Swiss Franc (CHF)
+         * - `EUR` - Euro (EUR)
+         * - `GBP` - British Pound (GBP)
+         * - `JPY` - Japanese Yen (JPY)
+         * - `USD` - US Dollar (USD)
+         */
+        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+      }
+
+      /**
+       * Interchange assessed as a part of this transaction.
        */
       export interface Interchange {
         /**
@@ -2940,7 +3002,7 @@ export namespace Transaction {
       /**
        * The account on which the interest was accrued.
        */
-      accrued_on_account_id: string | null;
+      accrued_on_account_id: string;
 
       /**
        * The amount in the minor unit of the transaction's currency. For dollars, for

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.155.0'; // x-release-please-version
+export const VERSION = '0.157.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.155.0";
+export declare const VERSION = "0.157.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.155.0'; // x-release-please-version
+exports.VERSION = '0.157.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.155.0'; // x-release-please-version
+export const VERSION = '0.157.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map