stripe 19.4.0-alpha.2 → 20.0.0

package/types/Issuing/DisputeSettlementDetails.d.ts

@@ -1,85 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Issuing {
-      /**
-       * Represents a record from the card network of a money movement or change in state for an Issuing dispute. These records are included in the settlement reports that we receive from networks and expose to users as Settlement objects.
-       */
-      interface DisputeSettlementDetail {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'issuing.dispute_settlement_detail';
-
-        /**
-         * Disputed amount in the card's currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).
-         */
-        amount: number;
-
-        /**
-         * The card used to make the original transaction.
-         */
-        card: string;
-
-        /**
-         * Time at which the object was created. Measured in seconds since the Unix epoch.
-         */
-        created: number;
-
-        /**
-         * The currency the original transaction was made in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
-         */
-        currency: string;
-
-        /**
-         * The ID of the linked dispute.
-         */
-        dispute: string;
-
-        /**
-         * The type of event corresponding to this dispute settlement detail, representing the stage in the dispute network lifecycle.
-         */
-        event_type: DisputeSettlementDetail.EventType;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        /**
-         * The card network for this dispute settlement detail. One of ["visa", "mastercard", "maestro"]
-         */
-        network: DisputeSettlementDetail.Network;
-
-        /**
-         * Details about the transaction, such as processing dates, set by the card network.
-         */
-        network_data: DisputeSettlementDetail.NetworkData | null;
-
-        /**
-         * The ID of the linked card network settlement.
-         */
-        settlement: string | null;
-      }
-
-      namespace DisputeSettlementDetail {
-        type EventType = 'filing' | 'loss' | 'representment' | 'win';
-
-        type Network = 'maestro' | 'mastercard' | 'visa';
-
-        interface NetworkData {
-          /**
-           * The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
-           */
-          processing_date: string | null;
-        }
-      }
-    }
-  }
-}

package/types/Issuing/DisputeSettlementDetailsResource.d.ts

@@ -1,52 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Issuing {
-      interface DisputeSettlementDetailRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface DisputeSettlementDetailListParams extends PaginationParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * Select the Issuing dispute settlement details for the given settlement.
-         */
-        settlement?: string;
-      }
-
-      class DisputeSettlementDetailsResource {
-        /**
-         * Retrieves an Issuing DisputeSettlementDetail object.
-         */
-        retrieve(
-          id: string,
-          params?: DisputeSettlementDetailRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Issuing.DisputeSettlementDetail>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Issuing.DisputeSettlementDetail>>;
-
-        /**
-         * Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
-         */
-        list(
-          params?: DisputeSettlementDetailListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Issuing.DisputeSettlementDetail>;
-        list(
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Issuing.DisputeSettlementDetail>;
-      }
-    }
-  }
-}

package/types/Issuing/FraudLiabilityDebits.d.ts

@@ -1,52 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Issuing {
-      /**
-       * A fraud liability debit occurs when Stripe debits a platform's account for fraud losses on Issuing transactions.
-       */
-      interface FraudLiabilityDebit {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'issuing.fraud_liability_debit';
-
-        /**
-         * Debited amount. This is equal to the disputed amount and is given in the card's currency and in the smallest currency unit.
-         */
-        amount: number;
-
-        /**
-         * ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this debit.
-         */
-        balance_transaction: string | Stripe.BalanceTransaction | null;
-
-        /**
-         * Time at which the object was created. Measured in seconds since the Unix epoch.
-         */
-        created: number;
-
-        /**
-         * The currency of the debit. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
-         */
-        currency: string;
-
-        /**
-         * The ID of the linked dispute.
-         */
-        dispute: string;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-      }
-    }
-  }
-}

package/types/Issuing/FraudLiabilityDebitsResource.d.ts

@@ -1,52 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Issuing {
-      interface FraudLiabilityDebitRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface FraudLiabilityDebitListParams extends PaginationParams {
-        /**
-         * Only return Issuing Fraud Liability Debits that were created during the given date interval.
-         */
-        created?: Stripe.RangeQueryParam | number;
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      class FraudLiabilityDebitsResource {
-        /**
-         * Retrieves an Issuing FraudLiabilityDebit object.
-         */
-        retrieve(
-          id: string,
-          params?: FraudLiabilityDebitRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Issuing.FraudLiabilityDebit>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Issuing.FraudLiabilityDebit>>;
-
-        /**
-         * Returns a list of Issuing FraudLiabilityDebit objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
-         */
-        list(
-          params?: FraudLiabilityDebitListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Issuing.FraudLiabilityDebit>;
-        list(
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Issuing.FraudLiabilityDebit>;
-      }
-    }
-  }
-}

package/types/Issuing/Programs.d.ts

@@ -1,42 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Issuing {
-      /**
-       * An Issuing `Program` represents a card program that the user has access to.
-       */
-      interface Program {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'issuing.program';
-
-        /**
-         * Time at which the object was created. Measured in seconds since the Unix epoch.
-         */
-        created: number;
-
-        /**
-         * Whether or not this is the "default" issuing program new cards are created on. Only one active `is_default` program at the same time.
-         */
-        is_default: boolean;
-
-        /**
-         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-         */
-        metadata: Stripe.Metadata;
-
-        /**
-         * The platform's Issuing Program for which this program is associated.
-         */
-        platform_program: string | null;
-      }
-    }
-  }
-}

package/types/Issuing/ProgramsResource.d.ts

@@ -1,96 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Issuing {
-      interface ProgramCreateParams {
-        /**
-         * The program to use as the parent for the new program to create.
-         */
-        platform_program: string;
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * If true, makes the specified program the default for the given account.
-         */
-        is_default?: boolean;
-      }
-
-      interface ProgramRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface ProgramUpdateParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * If true, makes the specified program the default.
-         */
-        is_default?: boolean;
-
-        /**
-         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-         */
-        metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
-      }
-
-      interface ProgramListParams extends PaginationParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      class ProgramsResource {
-        /**
-         * Create a Program object.
-         */
-        create(
-          params: ProgramCreateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Issuing.Program>>;
-
-        /**
-         * Retrieves the program specified by the given id.
-         */
-        retrieve(
-          id: string,
-          params?: ProgramRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Issuing.Program>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Issuing.Program>>;
-
-        /**
-         * Updates a Program object.
-         */
-        update(
-          id: string,
-          params?: ProgramUpdateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.Issuing.Program>>;
-
-        /**
-         * List all of the programs the given Issuing user has access to.
-         */
-        list(
-          params?: ProgramListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.Issuing.Program>;
-        list(options?: RequestOptions): ApiListPromise<Stripe.Issuing.Program>;
-      }
-    }
-  }
-}

package/types/Issuing/Settlements.d.ts

@@ -1,113 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace Issuing {
-      /**
-       * When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.
-       */
-      interface Settlement {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'issuing.settlement';
-
-        /**
-         * The Bank Identification Number reflecting this settlement record.
-         */
-        bin: string;
-
-        /**
-         * The date that the transactions are cleared and posted to user's accounts.
-         */
-        clearing_date: number;
-
-        /**
-         * Time at which the object was created. Measured in seconds since the Unix epoch.
-         */
-        created: number;
-
-        /**
-         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
-         */
-        currency: string;
-
-        /**
-         * The total interchange received as reimbursement for the transactions.
-         */
-        interchange_fees_amount: number;
-
-        /**
-         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-         */
-        livemode: boolean;
-
-        /**
-         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-         */
-        metadata: Stripe.Metadata;
-
-        /**
-         * The total net amount required to settle with the network.
-         */
-        net_total_amount: number;
-
-        /**
-         * The card network for this settlement report. One of ["visa", "maestro"]
-         */
-        network: Settlement.Network;
-
-        /**
-         * The total amount of fees owed to the network.
-         */
-        network_fees_amount: number;
-
-        /**
-         * The Settlement Identification Number assigned by the network.
-         */
-        network_settlement_identifier: string;
-
-        /**
-         * The total amount of any additional fees assessed by the card network.
-         */
-        other_fees_amount?: number;
-
-        /**
-         * The total number of additional fees assessed by the card network.
-         */
-        other_fees_count?: number;
-
-        /**
-         * One of `international` or `uk_national_net`.
-         */
-        settlement_service: string;
-
-        /**
-         * The current processing status of this settlement.
-         */
-        status: Settlement.Status;
-
-        /**
-         * The total transaction amount reflected in this settlement.
-         */
-        transaction_amount: number;
-
-        /**
-         * The total number of transactions reflected in this settlement.
-         */
-        transaction_count: number;
-      }
-
-      namespace Settlement {
-        type Network = 'maestro' | 'visa';
-
-        type Status = 'complete' | 'pending';
-      }
-    }
-  }
-}

package/types/Margins.d.ts

@@ -1,56 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    /**
-     * A (partner) margin represents a specific discount distributed in partner reseller programs to business partners who
-     * resell products and services and earn a discount (margin) for doing so.
-     */
-    interface Margin {
-      /**
-       * Unique identifier for the object.
-       */
-      id: string;
-
-      /**
-       * String representing the object's type. Objects of the same type share the same value.
-       */
-      object: 'margin';
-
-      /**
-       * Whether the margin can be applied to invoices, invoice items, or invoice line items. Defaults to `true`.
-       */
-      active: boolean;
-
-      /**
-       * Time at which the object was created. Measured in seconds since the Unix epoch.
-       */
-      created: number;
-
-      /**
-       * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-       */
-      livemode: boolean;
-
-      /**
-       * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-       */
-      metadata: Stripe.Metadata | null;
-
-      /**
-       * Name of the margin that's displayed on, for example, invoices.
-       */
-      name: string | null;
-
-      /**
-       * Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
-       */
-      percent_off: number;
-
-      /**
-       * Time at which the object was last updated. Measured in seconds since the Unix epoch.
-       */
-      updated: number;
-    }
-  }
-}

package/types/MarginsResource.d.ts

@@ -1,114 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    interface MarginCreateParams {
-      /**
-       * Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
-       */
-      percent_off: number;
-
-      /**
-       * Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to `true`.
-       */
-      active?: boolean;
-
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-
-      /**
-       * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-       */
-      metadata?: Stripe.MetadataParam;
-
-      /**
-       * Name of the margin, which is displayed to customers, such as on invoices.
-       */
-      name?: string;
-    }
-
-    interface MarginRetrieveParams {
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-    }
-
-    interface MarginUpdateParams {
-      /**
-       * Whether the margin can be applied to invoices, invoice items, or invoice line items or not.
-       */
-      active?: boolean;
-
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-
-      /**
-       * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-       */
-      metadata?: Stripe.MetadataParam;
-
-      /**
-       * Name of the margin, which is displayed to customers, such as on invoices.
-       */
-      name?: string;
-    }
-
-    interface MarginListParams extends PaginationParams {
-      /**
-       * Only return margins that are active or inactive. For example, pass `true` to only list active margins.
-       */
-      active?: boolean;
-
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-    }
-
-    class MarginsResource {
-      /**
-       * Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.
-       */
-      create(
-        params: MarginCreateParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.Margin>>;
-
-      /**
-       * Retrieve a margin object with the given ID.
-       */
-      retrieve(
-        id: string,
-        params?: MarginRetrieveParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.Margin>>;
-      retrieve(
-        id: string,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.Margin>>;
-
-      /**
-       * Update the specified margin object. Certain fields of the margin object are not editable.
-       */
-      update(
-        id: string,
-        params?: MarginUpdateParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.Margin>>;
-
-      /**
-       * Retrieve a list of your margins.
-       */
-      list(
-        params?: MarginListParams,
-        options?: RequestOptions
-      ): ApiListPromise<Stripe.Margin>;
-      list(options?: RequestOptions): ApiListPromise<Stripe.Margin>;
-    }
-  }
-}