increase 0.8.0 → 0.8.1

package/src/resources/card-profiles.ts

@@ -3,7 +3,7 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class CardProfiles extends APIResource {
@@ -171,22 +171,36 @@ export namespace CardProfile {
     /**
      * The identifier of the File containing the physical card's back image.
      */
-    back_image_file_id: string;
+    back_image_file_id: string | null;
 
     /**
      * The identifier of the File containing the physical card's carrier image.
      */
-    carrier_image_file_id: string;
+    carrier_image_file_id: string | null;
 
     /**
      * A phone number the user can contact to receive support for their card.
      */
-    contact_phone: string;
+    contact_phone: string | null;
 
     /**
      * The identifier of the File containing the physical card's front image.
      */
-    front_image_file_id: string;
+    front_image_file_id: string | null;
+
+    /**
+     * The status of the Physical Card Profile.
+     *
+     * - `not_eligible` - The Card Profile is not eligible for physical cards.
+     * - `rejected` - There is an issue with the Physical Card Profile preventing it
+     *   from use.
+     * - `pending_reviewing` - The card profile is awaiting review by Increase.
+     * - `pending_submitting` - The card profile is awaiting submission to the
+     *   fulfillment provider.
+     * - `submitted` - The Physical Card Profile has been submitted to the fulfillment
+     *   provider.
+     */
+    status: 'not_eligible' | 'rejected' | 'pending_reviewing' | 'pending_submitting' | 'submitted';
   }
 }
 

package/src/resources/card-purchase-supplements.ts

@@ -0,0 +1,331 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as API from './index';
+import { Page, PageParams } from '../pagination';
+
+export class CardPurchaseSupplements extends APIResource {
+  /**
+   * Retrieve a Card Purchase Supplement
+   */
+  retrieve(
+    cardPurchaseSupplementId: string,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<CardPurchaseSupplement>> {
+    return this.get(`/card_purchase_supplements/${cardPurchaseSupplementId}`, options);
+  }
+
+  /**
+   * List Card Purchase Supplements
+   */
+  list(
+    query?: CardPurchaseSupplementListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<CardPurchaseSupplementsPage>;
+  list(options?: Core.RequestOptions): Core.PagePromise<CardPurchaseSupplementsPage>;
+  list(
+    query: CardPurchaseSupplementListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<CardPurchaseSupplementsPage> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this.getAPIList('/card_purchase_supplements', CardPurchaseSupplementsPage, { query, ...options });
+  }
+}
+
+export class CardPurchaseSupplementsPage extends Page<CardPurchaseSupplement> {}
+// alias so we can export it in the namespace
+type _CardPurchaseSupplementsPage = CardPurchaseSupplementsPage;
+
+/**
+ * Additional information about a card purchase (e.g., settlement or refund), such
+ * as level 3 line item data.
+ */
+export interface CardPurchaseSupplement {
+  /**
+   * The Card Purchase Supplement identifier.
+   */
+  id: string;
+
+  /**
+   * The ID of the Card Payment this transaction belongs to.
+   */
+  card_payment_id: string | null;
+
+  /**
+   * Invoice-level information about the payment.
+   */
+  invoice: CardPurchaseSupplement.Invoice | null;
+
+  /**
+   * Line item information, such as individual products purchased.
+   */
+  line_items: Array<CardPurchaseSupplement.LineItem> | null;
+
+  /**
+   * The ID of the transaction.
+   */
+  transaction_id: string;
+
+  /**
+   * A constant representing the object's type. For this resource it will always be
+   * `card_purchase_supplement`.
+   */
+  type: 'card_purchase_supplement';
+}
+
+export namespace CardPurchaseSupplement {
+  /**
+   * Invoice-level information about the payment.
+   */
+  export interface Invoice {
+    /**
+     * Discount given to cardholder.
+     */
+    discount_amount: number | null;
+
+    /**
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount.
+     */
+    discount_currency: string | null;
+
+    /**
+     * Indicates how the merchant applied the discount.
+     *
+     * - `no_invoice_level_discount_provided` - No invoice level discount provided
+     * - `tax_calculated_on_post_discount_invoice_total` - Tax calculated on post
+     *   discount invoice total
+     * - `tax_calculated_on_pre_discount_invoice_total` - Tax calculated on pre
+     *   discount invoice total
+     */
+    discount_treatment_code:
+      | 'no_invoice_level_discount_provided'
+      | 'tax_calculated_on_post_discount_invoice_total'
+      | 'tax_calculated_on_pre_discount_invoice_total'
+      | null;
+
+    /**
+     * Amount of duty taxes.
+     */
+    duty_tax_amount: number | null;
+
+    /**
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the duty tax.
+     */
+    duty_tax_currency: string | null;
+
+    /**
+     * Date the order was taken.
+     */
+    order_date: string | null;
+
+    /**
+     * The shipping cost.
+     */
+    shipping_amount: number | null;
+
+    /**
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping
+     * cost.
+     */
+    shipping_currency: string | null;
+
+    /**
+     * Country code of the shipping destination.
+     */
+    shipping_destination_country_code: string | null;
+
+    /**
+     * Postal code of the shipping destination.
+     */
+    shipping_destination_postal_code: string | null;
+
+    /**
+     * Postal code of the location being shipped from.
+     */
+    shipping_source_postal_code: string | null;
+
+    /**
+     * Taxes paid for freight and shipping.
+     */
+    shipping_tax_amount: number | null;
+
+    /**
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping
+     * tax.
+     */
+    shipping_tax_currency: string | null;
+
+    /**
+     * Tax rate for freight and shipping.
+     */
+    shipping_tax_rate: string | null;
+
+    /**
+     * Indicates how the merchant applied taxes.
+     *
+     * - `no_tax_applies` - No tax applies
+     * - `net_price_line_item_level` - Net price line item level
+     * - `net_price_invoice_level` - Net price invoice level
+     * - `gross_price_line_item_level` - Gross price line item level
+     * - `gross_price_invoice_level` - Gross price invoice level
+     */
+    tax_treatments:
+      | 'no_tax_applies'
+      | 'net_price_line_item_level'
+      | 'net_price_invoice_level'
+      | 'gross_price_line_item_level'
+      | 'gross_price_invoice_level'
+      | null;
+
+    /**
+     * Value added tax invoice reference number.
+     */
+    unique_value_added_tax_invoice_reference: string | null;
+  }
+
+  export interface LineItem {
+    /**
+     * Indicates the type of line item.
+     *
+     * - `normal` - Normal
+     * - `credit` - Credit
+     * - `payment` - Purchase
+     */
+    detail_indicator: 'normal' | 'credit' | 'payment' | null;
+
+    /**
+     * Discount amount for this specific line item.
+     */
+    discount_amount: number | null;
+
+    /**
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount.
+     */
+    discount_currency: string | null;
+
+    /**
+     * Indicates how the merchant applied the discount for this specific line item.
+     *
+     * - `no_line_item_level_discount_provided` - No line item level discount provided
+     * - `tax_calculated_on_post_discount_line_item_total` - Tax calculated on post
+     *   discount line item total
+     * - `tax_calculated_on_pre_discount_line_item_total` - Tax calculated on pre
+     *   discount line item total
+     */
+    discount_treatment_code:
+      | 'no_line_item_level_discount_provided'
+      | 'tax_calculated_on_post_discount_line_item_total'
+      | 'tax_calculated_on_pre_discount_line_item_total'
+      | null;
+
+    /**
+     * Code used to categorize the purchase item.
+     */
+    item_commodity_code: string | null;
+
+    /**
+     * Description of the purchase item.
+     */
+    item_descriptor: string | null;
+
+    /**
+     * The number of units of the product being purchased.
+     */
+    item_quantity: string | null;
+
+    /**
+     * Code used to categorize the product being purchased.
+     */
+    product_code: string | null;
+
+    /**
+     * Sales tax amount for this line item.
+     */
+    sales_tax_amount: number | null;
+
+    /**
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the sales tax
+     * assessed.
+     */
+    sales_tax_currency: string | null;
+
+    /**
+     * Sales tax rate for this line item.
+     */
+    sales_tax_rate: string | null;
+
+    /**
+     * Total amount of all line items
+     */
+    total_amount: number | null;
+
+    /**
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the totla
+     * amount.
+     */
+    total_amount_currency: string | null;
+
+    /**
+     * Cost of line item per unit of measure, in major units.
+     */
+    unit_cost: string | null;
+
+    /**
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the unit cost.
+     */
+    unit_cost_currency: string | null;
+
+    /**
+     * Code indicating unit of measure (gallons, etc.)
+     */
+    unit_of_measure_code: string | null;
+  }
+}
+
+export interface CardPurchaseSupplementListParams extends PageParams {
+  /**
+   * Filter Card Purchase Supplements to ones belonging to the specified Card
+   * Payment.
+   */
+  card_payment_id?: string;
+
+  created_at?: CardPurchaseSupplementListParams.CreatedAt;
+}
+
+export namespace CardPurchaseSupplementListParams {
+  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 namespace CardPurchaseSupplements {
+  export import CardPurchaseSupplement = API.CardPurchaseSupplement;
+  export type CardPurchaseSupplementsPage = _CardPurchaseSupplementsPage;
+  export import CardPurchaseSupplementListParams = API.CardPurchaseSupplementListParams;
+}

package/src/resources/cards.ts

@@ -3,7 +3,7 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class Cards extends APIResource {

package/src/resources/check-deposits.ts

@@ -3,7 +3,7 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class CheckDeposits extends APIResource {

package/src/resources/check-transfers.ts

@@ -3,7 +3,7 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class CheckTransfers extends APIResource {
@@ -417,9 +417,11 @@ export namespace CheckTransfer {
      * The reason why this transfer was stopped.
      *
      * - `mail_delivery_failed` - The check could not be delivered.
+     * - `rejected_by_increase` - The check was cancelled by an Increase operator who
+     *   will provide details out-of-band.
      * - `unknown` - The check was stopped for another reason.
      */
-    reason: 'mail_delivery_failed' | 'unknown';
+    reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'unknown';
 
     /**
      * The time the stop-payment was requested.

package/src/resources/declined-transactions.ts

@@ -4,7 +4,7 @@ import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
 import * as Shared from './shared';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class DeclinedTransactions extends APIResource {

package/src/resources/digital-wallet-tokens.ts

@@ -3,7 +3,7 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class DigitalWalletTokens extends APIResource {

package/src/resources/documents.ts

@@ -3,7 +3,7 @@
 import * as Core from '../core';
 import { APIResource } from '../resource';
 import { isRequestOptions } from '../core';
-import * as API from '.';
+import * as API from './index';
 import { Page, PageParams } from '../pagination';
 
 export class Documents extends APIResource {

package/src/resources/entities/beneficial-owners.ts

@@ -0,0 +1,255 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import * as Entities from './index';
+import * as API from './index';
+
+export class BeneficialOwners extends APIResource {
+  /**
+   * Create a beneficial owner for a corporate Entity
+   */
+  create(
+    entityId: string,
+    body: BeneficialOwnerCreateParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<Entities.Entity>> {
+    return this.post(`/entities/${entityId}/beneficial_owners`, { body, ...options });
+  }
+}
+
+export interface BeneficialOwnerCreateParams {
+  /**
+   * The identifying details of anyone controlling or owning 25% or more of the
+   * corporation.
+   */
+  beneficial_owner: BeneficialOwnerCreateParams.BeneficialOwner;
+}
+
+export namespace BeneficialOwnerCreateParams {
+  /**
+   * The identifying details of anyone controlling or owning 25% or more of the
+   * corporation.
+   */
+  export interface BeneficialOwner {
+    /**
+     * Personal details for the beneficial owner.
+     */
+    individual: BeneficialOwner.Individual;
+
+    /**
+     * Why this person is considered a beneficial owner of the entity.
+     *
+     * - `ownership` - A person with 25% or greater direct or indirect ownership of the
+     *   entity.
+     * - `control` - A person who manages, directs, or has significant control of the
+     *   entity.
+     */
+    prong: 'ownership' | 'control';
+
+    /**
+     * This person's role or title within the entity.
+     */
+    company_title?: string;
+  }
+
+  export namespace BeneficialOwner {
+    /**
+     * Personal details for the beneficial owner.
+     */
+    export interface Individual {
+      /**
+       * The individual's address.
+       */
+      address: Individual.Address;
+
+      /**
+       * The person's date of birth in YYYY-MM-DD format.
+       */
+      date_of_birth: string;
+
+      /**
+       * A means of verifying the person's identity.
+       */
+      identification: Individual.Identification;
+
+      /**
+       * The person's legal name.
+       */
+      name: string;
+
+      /**
+       * The identification method for an individual can only be a passport, driver's
+       * license, or other document if you've confirmed the individual does not have a US
+       * tax id (either a Social Security Number or Individual Taxpayer Identification
+       * Number).
+       */
+      confirmed_no_us_tax_id?: boolean;
+    }
+
+    export namespace Individual {
+      /**
+       * The individual's address.
+       */
+      export interface Address {
+        /**
+         * The city of the address.
+         */
+        city: string;
+
+        /**
+         * The first line of the address. This is usually the street number and street.
+         */
+        line1: string;
+
+        /**
+         * The two-letter United States Postal Service (USPS) abbreviation for the state of
+         * the address.
+         */
+        state: string;
+
+        /**
+         * The ZIP code of the address.
+         */
+        zip: string;
+
+        /**
+         * The second line of the address. This might be the floor or room number.
+         */
+        line2?: string;
+      }
+
+      /**
+       * A means of verifying the person's identity.
+       */
+      export interface Identification {
+        /**
+         * A method that can be used to verify the individual's identity.
+         *
+         * - `social_security_number` - A social security number.
+         * - `individual_taxpayer_identification_number` - An individual taxpayer
+         *   identification number (ITIN).
+         * - `passport` - A passport number.
+         * - `drivers_license` - A driver's license number.
+         * - `other` - Another identifying document.
+         */
+        method:
+          | 'social_security_number'
+          | 'individual_taxpayer_identification_number'
+          | 'passport'
+          | 'drivers_license'
+          | 'other';
+
+        /**
+         * An identification number that can be used to verify the individual's identity,
+         * such as a social security number.
+         */
+        number: string;
+
+        /**
+         * Information about the United States driver's license used for identification.
+         * Required if `method` is equal to `drivers_license`.
+         */
+        drivers_license?: Identification.DriversLicense;
+
+        /**
+         * Information about the identification document provided. Required if `method` is
+         * equal to `other`.
+         */
+        other?: Identification.Other;
+
+        /**
+         * Information about the passport used for identification. Required if `method` is
+         * equal to `passport`.
+         */
+        passport?: Identification.Passport;
+      }
+
+      export namespace Identification {
+        /**
+         * Information about the United States driver's license used for identification.
+         * Required if `method` is equal to `drivers_license`.
+         */
+        export interface DriversLicense {
+          /**
+           * The driver's license's expiration date in YYYY-MM-DD format.
+           */
+          expiration_date: string;
+
+          /**
+           * The identifier of the File containing the front of the driver's license.
+           */
+          file_id: string;
+
+          /**
+           * The state that issued the provided driver's license.
+           */
+          state: string;
+
+          /**
+           * The identifier of the File containing the back of the driver's license.
+           */
+          back_file_id?: string;
+        }
+
+        /**
+         * Information about the identification document provided. Required if `method` is
+         * equal to `other`.
+         */
+        export interface Other {
+          /**
+           * The two-character ISO 3166-1 code representing the country that issued the
+           * document.
+           */
+          country: string;
+
+          /**
+           * A description of the document submitted.
+           */
+          description: string;
+
+          /**
+           * The identifier of the File containing the front of the document.
+           */
+          file_id: string;
+
+          /**
+           * The identifier of the File containing the back of the document. Not every
+           * document has a reverse side.
+           */
+          back_file_id?: string;
+
+          /**
+           * The document's expiration date in YYYY-MM-DD format.
+           */
+          expiration_date?: string;
+        }
+
+        /**
+         * Information about the passport used for identification. Required if `method` is
+         * equal to `passport`.
+         */
+        export interface Passport {
+          /**
+           * The country that issued the passport.
+           */
+          country: string;
+
+          /**
+           * The passport's expiration date in YYYY-MM-DD format.
+           */
+          expiration_date: string;
+
+          /**
+           * The identifier of the File containing the passport.
+           */
+          file_id: string;
+        }
+      }
+    }
+  }
+}
+
+export namespace BeneficialOwners {
+  export import BeneficialOwnerCreateParams = API.BeneficialOwnerCreateParams;
+}