increase 0.2.0 → 0.3.0

package/resources/bookkeeping-accounts.ts

@@ -0,0 +1,98 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/pagination';
+
+export class BookkeepingAccounts extends APIResource {
+  /**
+   * Create a Bookkeeping Account
+   */
+  create(
+    body: BookkeepingAccountCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<BookkeepingAccount>> {
+    return this.post('/bookkeeping_accounts', { body, ...options });
+  }
+
+  /**
+   * List Bookkeeping Accounts
+   */
+  list(
+    query?: BookkeepingAccountListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BookkeepingAccountsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<BookkeepingAccountsPage>;
+  list(
+    query: BookkeepingAccountListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BookkeepingAccountsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/bookkeeping_accounts', BookkeepingAccountsPage, { query, ...options });
+  }
+}
+
+export class BookkeepingAccountsPage extends Page<BookkeepingAccount> {}
+
+/**
+ * Accounts are T-accounts. They can store accounting entries.
+ */
+export interface BookkeepingAccount {
+  /**
+   * The API Account associated with this bookkeeping account.
+   */
+  account_id: string | null;
+
+  /**
+   * The compliance category of the account.
+   */
+  compliance_category: 'commingled_cash' | 'customer_balance' | null;
+
+  /**
+   * The Entity associated with this bookkeeping account.
+   */
+  entity_id: string | null;
+
+  /**
+   * The account identifier.
+   */
+  id: string;
+
+  /**
+   * The name you choose for the account.
+   */
+  name: string;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `bookkeeping_account`.
+   */
+  type: 'bookkeeping_account';
+}
+
+export interface BookkeepingAccountCreateParams {
+  /**
+   * The entity, if `compliance_category` is `commingled_cash`.
+   */
+  account_id?: string;
+
+  /**
+   * The account compliance category.
+   */
+  compliance_category?: 'commingled_cash' | 'customer_balance';
+
+  /**
+   * The entity, if `compliance_category` is `customer_balance`.
+   */
+  entity_id?: string;
+
+  /**
+   * The name you choose for the account.
+   */
+  name: string;
+}
+
+export interface BookkeepingAccountListParams extends PageParams {}

package/resources/bookkeeping-entries.ts

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { isRequestOptions } from '~/core';
+import { Page, PageParams } from '~/pagination';
+
+export class BookkeepingEntries extends APIResource {
+  /**
+   * List Bookkeeping Entries
+   */
+  list(
+    query?: BookkeepingEntryListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BookkeepingEntriesPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<BookkeepingEntriesPage>;
+  list(
+    query: BookkeepingEntryListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<BookkeepingEntriesPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/bookkeeping_entries', BookkeepingEntriesPage, { query, ...options });
+  }
+}
+
+export class BookkeepingEntriesPage extends Page<BookkeepingEntry> {}
+
+/**
+ * Entries are T-account entries recording debits and credits.
+ */
+export interface BookkeepingEntry {
+  /**
+   * The identifier for the Account the Entry belongs to.
+   */
+  account_id: string;
+
+  /**
+   * The Entry amount in the minor unit of its currency. For dollars, for example,
+   * this is cents.
+   */
+  amount: number;
+
+  /**
+   * The identifier for the Account the Entry belongs to.
+   */
+  entry_set_id: string;
+
+  /**
+   * The entry identifier.
+   */
+  id: string;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `bookkeeping_entry`.
+   */
+  type: 'bookkeeping_entry';
+}
+
+export interface BookkeepingEntryListParams extends PageParams {}

package/resources/bookkeeping-entry-sets.ts

@@ -0,0 +1,114 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+
+export class BookkeepingEntrySets extends APIResource {
+  /**
+   * Create a Bookkeeping Entry Set
+   */
+  create(
+    body: BookkeepingEntrySetCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<BookkeepingEntrySet>> {
+    return this.post('/bookkeeping_entry_sets', { body, ...options });
+  }
+}
+
+/**
+ * Entry Sets are accounting entries that are transactionally applied.
+ */
+export interface BookkeepingEntrySet {
+  /**
+   * The timestamp of the entry set.
+   */
+  date: string;
+
+  /**
+   * The entries
+   */
+  entries: Array<BookkeepingEntrySet.Entries>;
+
+  /**
+   * The entry set identifier.
+   */
+  id: string;
+
+  /**
+   * The transaction identifier, if any.
+   */
+  transaction_id: string | null;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `bookkeeping_entry_set`.
+   */
+  type: 'bookkeeping_entry_set';
+}
+
+export namespace BookkeepingEntrySet {
+  export interface Entries {
+    /**
+     * The bookkeeping account impacted by the entry.
+     */
+    account_id: string;
+
+    /**
+     * The amount of the entry in minor units.
+     */
+    amount: number;
+
+    /**
+     * The entry identifier.
+     */
+    id: string;
+  }
+}
+
+export interface BookkeepingEntrySetCreateParams {
+  /**
+   * The date of the transaction. If `transaction_id` is provided, this must match
+   * the `created_at` field on that resource.
+   */
+  date?: string;
+
+  /**
+   * The bookkeeping entries.
+   */
+  entries: Array<BookkeepingEntrySetCreateParams.Entries>;
+
+  /**
+   * The identifier of the Transaction related to this entry set, if any.
+   */
+  transaction_id?: string;
+}
+
+export namespace BookkeepingEntrySetCreateParams {
+  export interface Entries {
+    /**
+     * The identifier for the Bookkeeping Account impacted by this entry.
+     */
+    account_id: string;
+
+    /**
+     * The entry amount in the minor unit of the account currency. For dollars, for
+     * example, this is cents. Debit entries have positive amounts; credit entries have
+     * negative amounts.
+     */
+    amount: number;
+  }
+
+  export interface Entries {
+    /**
+     * The identifier for the Bookkeeping Account impacted by this entry.
+     */
+    account_id: string;
+
+    /**
+     * The entry amount in the minor unit of the account currency. For dollars, for
+     * example, this is cents. Debit entries have positive amounts; credit entries have
+     * negative amounts.
+     */
+    amount: number;
+  }
+}

package/resources/card-disputes.ts

@@ -35,7 +35,6 @@ export class CardDisputes extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/card_disputes', CardDisputesPage, { query, ...options });
   }
 }
@@ -93,6 +92,10 @@ export interface CardDispute {
 }
 
 export namespace CardDispute {
+  /**
+   * If the Card Dispute's status is `accepted`, this will contain details of the
+   * successful dispute.
+   */
   export interface Acceptance {
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -109,9 +112,13 @@ export namespace CardDispute {
      * The identifier of the Transaction that was created to return the disputed funds
      * to your account.
      */
-    transaction_id: string | null;
+    transaction_id: string;
   }
 
+  /**
+   * If the Card Dispute's status is `rejected`, this will contain details of the
+   * unsuccessful dispute.
+   */
   export interface Rejection {
     /**
      * The identifier of the Card Dispute that was rejected.
@@ -145,9 +152,36 @@ export interface CardDisputeCreateParams {
 }
 
 export interface CardDisputeListParams extends PageParams {
-  created_at?: CardDisputeListParams.CreatedAt;
+  /**
+   * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+   * timestamp.
+   */
+  'created_at.after'?: string;
 
-  status?: CardDisputeListParams.Status;
+  /**
+   * 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;
+
+  /**
+   * Filter Card Disputes for those with the specified status or statuses. For GET
+   * requests, this should be encoded as a comma-delimited string, such as
+   * `?in=one,two,three`.
+   */
+  'status.in'?: Array<'pending_reviewing' | 'accepted' | 'rejected'>;
 }
 
 export namespace CardDisputeListParams {
@@ -179,8 +213,9 @@ export namespace CardDisputeListParams {
 
   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`.
+     * Filter Card Disputes for those with the specified status or statuses. For GET
+     * requests, this should be encoded as a comma-delimited string, such as
+     * `?in=one,two,three`.
      */
     in?: Array<'pending_reviewing' | 'accepted' | 'rejected'>;
   }

package/resources/card-profiles.ts

@@ -35,7 +35,6 @@ export class CardProfiles extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/card_profiles', CardProfilesPage, { query, ...options });
   }
 }
@@ -83,6 +82,10 @@ export interface CardProfile {
 }
 
 export namespace CardProfile {
+  /**
+   * How Cards should appear in digital wallets such as Apple Pay. Different wallets
+   * will use these values to render card artwork appropriately for their app.
+   */
   export interface DigitalWallets {
     /**
      * The identifier of the File containing the card's icon image.
@@ -126,6 +129,9 @@ export namespace CardProfile {
   }
 
   export namespace DigitalWallets {
+    /**
+     * The Card's text color, specified as an RGB triple.
+     */
     export interface TextColor {
       /**
        * The value of the blue channel in the RGB color.
@@ -159,6 +165,10 @@ export interface CardProfileCreateParams {
 }
 
 export namespace CardProfileCreateParams {
+  /**
+   * How Cards should appear in digital wallets such as Apple Pay. Different wallets
+   * will use these values to render card artwork appropriately for their app.
+   */
   export interface DigitalWallets {
     /**
      * The identifier of the File containing the card's icon image.
@@ -202,6 +212,77 @@ export namespace CardProfileCreateParams {
   }
 
   export namespace DigitalWallets {
+    /**
+     * The Card's text color, specified as an RGB triple. The default is white.
+     */
+    export interface TextColor {
+      /**
+       * The value of the blue channel in the RGB color.
+       */
+      blue: number;
+
+      /**
+       * The value of the green channel in the RGB color.
+       */
+      green: number;
+
+      /**
+       * The value of the red channel in the RGB color.
+       */
+      red: number;
+    }
+  }
+
+  /**
+   * How Cards should appear in digital wallets such as Apple Pay. Different wallets
+   * will use these values to render card artwork appropriately for their app.
+   */
+  export interface DigitalWallets {
+    /**
+     * The identifier of the File containing the card's icon image.
+     */
+    app_icon_file_id: string;
+
+    /**
+     * The identifier of the File containing the card's front image.
+     */
+    background_image_file_id: string;
+
+    /**
+     * A user-facing description for the card itself.
+     */
+    card_description: string;
+
+    /**
+     * A user-facing description for whoever is issuing the card.
+     */
+    issuer_name: string;
+
+    /**
+     * An email address the user can contact to receive support for their card.
+     */
+    contact_email?: string;
+
+    /**
+     * A phone number the user can contact to receive support for their card.
+     */
+    contact_phone?: string;
+
+    /**
+     * A website the user can visit to view and receive support for their card.
+     */
+    contact_website?: string;
+
+    /**
+     * The Card's text color, specified as an RGB triple. The default is white.
+     */
+    text_color?: DigitalWallets.TextColor;
+  }
+
+  export namespace DigitalWallets {
+    /**
+     * The Card's text color, specified as an RGB triple. The default is white.
+     */
     export interface TextColor {
       /**
        * The value of the blue channel in the RGB color.
@@ -222,14 +303,20 @@ export namespace CardProfileCreateParams {
 }
 
 export interface CardProfileListParams extends PageParams {
-  status?: CardProfileListParams.Status;
+  /**
+   * Filter Card Profiles for those with the specified status or statuses. For GET
+   * requests, this should be encoded as a comma-delimited string, such as
+   * `?in=one,two,three`.
+   */
+  'status.in'?: Array<'pending' | 'rejected' | 'active' | 'archived'>;
 }
 
 export namespace CardProfileListParams {
   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`.
+     * Filter Card Profiles for those with the specified status or statuses. For GET
+     * requests, this should be encoded as a comma-delimited string, such as
+     * `?in=one,two,three`.
      */
     in?: Array<'pending' | 'rejected' | 'active' | 'archived'>;
   }