increase 0.11.1 → 0.11.3

package/resources/card-purchase-supplements.mjs

@@ -3,19 +3,21 @@ import { APIResource } from 'increase/resource';
 import { isRequestOptions } from 'increase/core';
 import { Page } from 'increase/pagination';
 export class CardPurchaseSupplements extends APIResource {
-  /**
-   * Retrieve a Card Purchase Supplement
-   */
-  retrieve(cardPurchaseSupplementId, options) {
-    return this.get(`/card_purchase_supplements/${cardPurchaseSupplementId}`, options);
-  }
-  list(query = {}, options) {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
+    /**
+     * Retrieve a Card Purchase Supplement
+     */
+    retrieve(cardPurchaseSupplementId, options) {
+        return this.get(`/card_purchase_supplements/${cardPurchaseSupplementId}`, options);
     }
-    return this.getAPIList('/card_purchase_supplements', CardPurchaseSupplementsPage, { query, ...options });
-  }
+    list(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list({}, query);
+        }
+        return this.getAPIList('/card_purchase_supplements', CardPurchaseSupplementsPage, { query, ...options });
+    }
+}
+export class CardPurchaseSupplementsPage extends Page {
 }
-export class CardPurchaseSupplementsPage extends Page {}
-(function (CardPurchaseSupplements) {})(CardPurchaseSupplements || (CardPurchaseSupplements = {}));
-//# sourceMappingURL=card-purchase-supplements.mjs.map
+(function (CardPurchaseSupplements) {
+})(CardPurchaseSupplements || (CardPurchaseSupplements = {}));
+//# sourceMappingURL=card-purchase-supplements.mjs.map

package/resources/cards.d.ts

@@ -1,31 +1,32 @@
 import * as Core from 'increase/core';
 import { APIResource } from 'increase/resource';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { Page, PageParams } from 'increase/pagination';
 export declare class Cards extends APIResource {
-  /**
-   * Create a Card
-   */
-  create(body: CardCreateParams, options?: Core.RequestOptions): Core.APIPromise<Card>;
-  /**
-   * Retrieve a Card
-   */
-  retrieve(cardId: string, options?: Core.RequestOptions): Core.APIPromise<Card>;
-  /**
-   * Update a Card
-   */
-  update(cardId: string, body: CardUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Card>;
-  /**
-   * List Cards
-   */
-  list(query?: CardListParams, options?: Core.RequestOptions): Core.PagePromise<CardsPage, Card>;
-  list(options?: Core.RequestOptions): Core.PagePromise<CardsPage, Card>;
-  /**
-   * Retrieve sensitive details for a Card
-   */
-  retrieveSensitiveDetails(cardId: string, options?: Core.RequestOptions): Core.APIPromise<CardDetails>;
+    /**
+     * Create a Card
+     */
+    create(body: CardCreateParams, options?: Core.RequestOptions): Core.APIPromise<Card>;
+    /**
+     * Retrieve a Card
+     */
+    retrieve(cardId: string, options?: Core.RequestOptions): Core.APIPromise<Card>;
+    /**
+     * Update a Card
+     */
+    update(cardId: string, body: CardUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Card>;
+    /**
+     * List Cards
+     */
+    list(query?: CardListParams, options?: Core.RequestOptions): Core.PagePromise<CardsPage, Card>;
+    list(options?: Core.RequestOptions): Core.PagePromise<CardsPage, Card>;
+    /**
+     * Retrieve sensitive details for a Card
+     */
+    retrieveSensitiveDetails(cardId: string, options?: Core.RequestOptions): Core.APIPromise<CardDetails>;
+}
+export declare class CardsPage extends Page<Card> {
 }
-export declare class CardsPage extends Page<Card> {}
 type _CardsPage = CardsPage;
 /**
  * Cards are commercial credit cards. They'll immediately work for online purchases
@@ -34,324 +35,332 @@ type _CardsPage = CardsPage;
  * the Account upon transaction settlement.
  */
 export interface Card {
-  /**
-   * The card identifier.
-   */
-  id: string;
-  /**
-   * The identifier for the account this card belongs to.
-   */
-  account_id: string;
-  /**
-   * The Card's billing address.
-   */
-  billing_address: Card.BillingAddress;
-  /**
-   * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
-   * the Card was created.
-   */
-  created_at: string;
-  /**
-   * The card's description for display purposes.
-   */
-  description: 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.
-   */
-  digital_wallet: Card.DigitalWallet | null;
-  /**
-   * The month the card expires in M format (e.g., August is 8).
-   */
-  expiration_month: number;
-  /**
-   * The year the card expires in YYYY format (e.g., 2025).
-   */
-  expiration_year: number;
-  /**
-   * The last 4 digits of the Card's Primary Account Number.
-   */
-  last4: string;
-  /**
-   * This indicates if payments can be made with the card.
-   *
-   * - `active` - The card is active.
-   * - `disabled` - The card is temporarily disabled.
-   * - `canceled` - The card is permanently canceled.
-   */
-  status: 'active' | 'disabled' | 'canceled';
-  /**
-   * A constant representing the object's type. For this resource it will always be
-   * `card`.
-   */
-  type: 'card';
-}
-export declare namespace Card {
-  /**
-   * The Card's billing address.
-   */
-  interface BillingAddress {
     /**
-     * The city of the billing address.
+     * The card identifier.
      */
-    city: string | null;
+    id: string;
     /**
-     * The first line of the billing address.
+     * The identifier for the account this card belongs to.
      */
-    line1: string | null;
+    account_id: string;
     /**
-     * The second line of the billing address.
+     * The Card's billing address.
      */
-    line2: string | null;
+    billing_address: Card.BillingAddress;
     /**
-     * The postal code of the billing address.
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the Card was created.
      */
-    postal_code: string | null;
+    created_at: string;
     /**
-     * The US state of the billing address.
+     * The card's description for display purposes.
      */
-    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.
-   */
-  interface DigitalWallet {
+    description: string | null;
     /**
-     * The card profile assigned to this digital card. Card profiles may also be
-     * assigned at the program level.
+     * 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.
      */
-    card_profile_id: string | null;
+    digital_wallet: Card.DigitalWallet | null;
     /**
-     * An email address that can be used to verify the cardholder via one-time passcode
-     * over email.
+     * The identifier for the entity associated with this card.
      */
-    email: string | null;
+    entity_id: string | null;
     /**
-     * A phone number that can be used to verify the cardholder via one-time passcode
-     * over SMS.
+     * The month the card expires in M format (e.g., August is 8).
      */
-    phone: string | null;
-  }
+    expiration_month: number;
+    /**
+     * The year the card expires in YYYY format (e.g., 2025).
+     */
+    expiration_year: number;
+    /**
+     * The last 4 digits of the Card's Primary Account Number.
+     */
+    last4: string;
+    /**
+     * This indicates if payments can be made with the card.
+     *
+     * - `active` - The card is active.
+     * - `disabled` - The card is temporarily disabled.
+     * - `canceled` - The card is permanently canceled.
+     */
+    status: 'active' | 'disabled' | 'canceled';
+    /**
+     * A constant representing the object's type. For this resource it will always be
+     * `card`.
+     */
+    type: 'card';
+}
+export declare namespace Card {
+    /**
+     * The Card's billing address.
+     */
+    interface BillingAddress {
+        /**
+         * The city of the billing address.
+         */
+        city: string | null;
+        /**
+         * The first line of the billing address.
+         */
+        line1: string | null;
+        /**
+         * The second line of the billing address.
+         */
+        line2: string | null;
+        /**
+         * The postal code of the billing address.
+         */
+        postal_code: string | null;
+        /**
+         * The US state of the billing address.
+         */
+        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.
+     */
+    interface DigitalWallet {
+        /**
+         * The card profile assigned to this digital card. Card profiles may also be
+         * assigned at the program level.
+         */
+        card_profile_id: string | null;
+        /**
+         * An email address that can be used to verify the cardholder via one-time passcode
+         * over email.
+         */
+        email: string | null;
+        /**
+         * A phone number that can be used to verify the cardholder via one-time passcode
+         * over SMS.
+         */
+        phone: string | null;
+    }
 }
 /**
  * An object containing the sensitive details (card number, cvc, etc) for a Card.
  */
 export interface CardDetails {
-  /**
-   * The identifier for the Card for which sensitive details have been returned.
-   */
-  card_id: string;
-  /**
-   * The month the card expires in M format (e.g., August is 8).
-   */
-  expiration_month: number;
-  /**
-   * The year the card expires in YYYY format (e.g., 2025).
-   */
-  expiration_year: number;
-  /**
-   * The card number.
-   */
-  primary_account_number: string;
-  /**
-   * A constant representing the object's type. For this resource it will always be
-   * `card_details`.
-   */
-  type: 'card_details';
-  /**
-   * The three-digit verification code for the card. It's also known as the Card
-   * Verification Code (CVC), the Card Verification Value (CVV), or the Card
-   * Identification (CID).
-   */
-  verification_code: string;
-}
-export interface CardCreateParams {
-  /**
-   * The Account the card should belong to.
-   */
-  account_id: string;
-  /**
-   * The card's billing address.
-   */
-  billing_address?: CardCreateParams.BillingAddress;
-  /**
-   * The description you choose to give the card.
-   */
-  description?: 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`.
-   */
-  digital_wallet?: CardCreateParams.DigitalWallet;
-}
-export declare namespace CardCreateParams {
-  /**
-   * The card's billing address.
-   */
-  interface BillingAddress {
     /**
-     * The city of the billing address.
+     * The identifier for the Card for which sensitive details have been returned.
      */
-    city: string;
+    card_id: string;
     /**
-     * The first line of the billing address.
+     * The month the card expires in M format (e.g., August is 8).
      */
-    line1: string;
+    expiration_month: number;
     /**
-     * The postal code of the billing address.
+     * The year the card expires in YYYY format (e.g., 2025).
      */
-    postal_code: string;
+    expiration_year: number;
     /**
-     * The US state of the billing address.
+     * The card number.
      */
-    state: string;
+    primary_account_number: string;
     /**
-     * The second line of the billing address.
+     * A constant representing the object's type. For this resource it will always be
+     * `card_details`.
      */
-    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`.
-   */
-  interface DigitalWallet {
+    type: 'card_details';
     /**
-     * The card profile assigned to this digital card. Card profiles may also be
-     * assigned at the program level.
+     * The three-digit verification code for the card. It's also known as the Card
+     * Verification Code (CVC), the Card Verification Value (CVV), or the Card
+     * Identification (CID).
      */
-    card_profile_id?: string;
+    verification_code: string;
+}
+export interface CardCreateParams {
     /**
-     * An email address that can be used to verify the cardholder via one-time passcode
-     * over email.
+     * The Account the card should belong to.
      */
-    email?: string;
+    account_id: string;
     /**
-     * A phone number that can be used to verify the cardholder via one-time passcode
-     * over SMS.
+     * The card's billing address.
      */
-    phone?: string;
-  }
-}
-export interface CardUpdateParams {
-  /**
-   * The card's updated billing address.
-   */
-  billing_address?: CardUpdateParams.BillingAddress;
-  /**
-   * The description you choose to give the card.
-   */
-  description?: 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.
-   */
-  digital_wallet?: CardUpdateParams.DigitalWallet;
-  /**
-   * The status to update the Card with.
-   *
-   * - `active` - The card is active.
-   * - `disabled` - The card is temporarily disabled.
-   * - `canceled` - The card is permanently canceled.
-   */
-  status?: 'active' | 'disabled' | 'canceled';
-}
-export declare namespace CardUpdateParams {
-  /**
-   * The card's updated billing address.
-   */
-  interface BillingAddress {
+    billing_address?: CardCreateParams.BillingAddress;
     /**
-     * The city of the billing address.
+     * The description you choose to give the card.
      */
-    city: string;
+    description?: string;
     /**
-     * The first line of the billing address.
+     * 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`.
      */
-    line1: string;
+    digital_wallet?: CardCreateParams.DigitalWallet;
     /**
-     * The postal code of the billing address.
+     * The Entity the card should belong to.
      */
-    postal_code: string;
+    entity_id?: string;
+}
+export declare namespace CardCreateParams {
     /**
-     * The US state of the billing address.
+     * The card's billing address.
      */
-    state: string;
+    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 second line of the billing address.
+     * 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`.
      */
-    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.
-   */
-  interface DigitalWallet {
+    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;
+    }
+}
+export interface CardUpdateParams {
     /**
-     * The card profile assigned to this card. Card profiles may also be assigned at
-     * the program level.
+     * The card's updated billing address.
      */
-    card_profile_id?: string;
+    billing_address?: CardUpdateParams.BillingAddress;
     /**
-     * An email address that can be used to verify the cardholder via one-time passcode
-     * over email.
+     * The description you choose to give the card.
      */
-    email?: string;
+    description?: string;
     /**
-     * A phone number that can be used to verify the cardholder via one-time passcode
-     * over SMS.
+     * 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.
      */
-    phone?: string;
-  }
-}
-export interface CardListParams extends PageParams {
-  /**
-   * Filter Cards to ones belonging to the specified Account.
-   */
-  account_id?: string;
-  created_at?: CardListParams.CreatedAt;
-}
-export declare namespace CardListParams {
-  interface CreatedAt {
+    digital_wallet?: CardUpdateParams.DigitalWallet;
     /**
-     * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-     * timestamp.
+     * The status to update the Card with.
+     *
+     * - `active` - The card is active.
+     * - `disabled` - The card is temporarily disabled.
+     * - `canceled` - The card is permanently canceled.
      */
-    after?: string;
+    status?: 'active' | 'disabled' | 'canceled';
+}
+export declare namespace CardUpdateParams {
     /**
-     * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
-     * timestamp.
+     * The card's updated billing address.
      */
-    before?: string;
+    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;
+    }
     /**
-     * Return results on or after this
-     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     * 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.
      */
-    on_or_after?: string;
+    interface DigitalWallet {
+        /**
+         * The card profile assigned to this 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;
+    }
+}
+export interface CardListParams extends PageParams {
     /**
-     * Return results on or before this
-     * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+     * Filter Cards to ones belonging to the specified Account.
      */
-    on_or_before?: string;
-  }
+    account_id?: string;
+    created_at?: CardListParams.CreatedAt;
+}
+export declare namespace CardListParams {
+    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 declare namespace Cards {
-  export import Card = API.Card;
-  export import CardDetails = API.CardDetails;
-  type CardsPage = _CardsPage;
-  export import CardCreateParams = API.CardCreateParams;
-  export import CardUpdateParams = API.CardUpdateParams;
-  export import CardListParams = API.CardListParams;
+    export import Card = API.Card;
+    export import CardDetails = API.CardDetails;
+    type CardsPage = _CardsPage;
+    export import CardCreateParams = API.CardCreateParams;
+    export import CardUpdateParams = API.CardUpdateParams;
+    export import CardListParams = API.CardListParams;
 }
 export {};
-//# sourceMappingURL=cards.d.ts.map
+//# sourceMappingURL=cards.d.ts.map