stripe 22.3.0-alpha.4 → 22.3.0

package/cjs/resources/FxQuotes.d.ts

@@ -1,212 +0,0 @@
-import { StripeResource } from '../StripeResource.js';
-import { PaginationParams } from '../shared.js';
-import { RequestOptions, ApiListPromise, Response } from '../lib.js';
-export declare class FxQuoteResource extends StripeResource {
-    /**
-     * Returns a list of FX quotes that have been issued. The FX quotes are returned in sorted order, with the most recent FX quotes appearing first.
-     */
-    list(params?: FxQuoteListParams, options?: RequestOptions): ApiListPromise<FxQuote>;
-    /**
-     * Creates an FX Quote object
-     */
-    create(params: FxQuoteCreateParams, options?: RequestOptions): Promise<Response<FxQuote>>;
-    /**
-     * Retrieve an FX Quote object
-     */
-    retrieve(id: string, params?: FxQuoteRetrieveParams, options?: RequestOptions): Promise<Response<FxQuote>>;
-}
-export interface FxQuote {
-    /**
-     * Unique identifier for the object.
-     */
-    id: string;
-    /**
-     * String representing the object's type. Objects of the same type share the same value.
-     */
-    object: 'fx_quote';
-    /**
-     * Time at which the quote was created, measured in seconds since the Unix epoch.
-     */
-    created: number;
-    /**
-     * The duration the exchange rate quote remains valid from creation time. Allowed values are none, hour, and day. Note that for the test mode API available in alpha, you can request an extended quote, but it won't be usable for any transactions.
-     */
-    lock_duration: FxQuote.LockDuration;
-    /**
-     * Time at which the quote will expire, measured in seconds since the Unix epoch.
-     *
-     * If lock_duration is set to ‘none' this field will be set to null.
-     */
-    lock_expires_at: number | null;
-    /**
-     * Lock status of the quote. Transitions from active to expired once past the lock_expires_at timestamp.
-     *
-     * Can return value none, active, or expired.
-     */
-    lock_status: FxQuote.LockStatus;
-    /**
-     * Information about the rates.
-     */
-    rates: {
-        [key: string]: FxQuote.Rates;
-    };
-    /**
-     * The currency to convert into, typically this is the currency that you want to settle to your Stripe balance. Three-letter ISO currency code, in lowercase. Must be a supported currency.
-     */
-    to_currency: string;
-    usage: FxQuote.Usage;
-}
-export declare namespace FxQuote {
-    type LockDuration = 'day' | 'five_minutes' | 'hour' | 'none';
-    type LockStatus = 'active' | 'expired' | 'none';
-    interface Rates {
-        /**
-         * The rate that includes the FX fee rate.
-         */
-        exchange_rate: number;
-        rate_details: Rates.RateDetails;
-    }
-    interface Usage {
-        /**
-         * The details required to use an FX Quote for a payment
-         */
-        payment: Usage.Payment | null;
-        /**
-         * The details required to use an FX Quote for a transfer
-         */
-        transfer: Usage.Transfer | null;
-        /**
-         * The transaction type for which the FX Quote will be used.
-         *
-         * Can be 'payment' or 'transfer'.
-         */
-        type: Usage.Type;
-    }
-    namespace Rates {
-        interface RateDetails {
-            /**
-             * The rate for the currency pair.
-             */
-            base_rate: number;
-            /**
-             * The fee for locking the conversion rates.
-             */
-            duration_premium: number;
-            /**
-             * The FX fee for the currency pair.
-             */
-            fx_fee_rate: number;
-            /**
-             * A reference rate for the currency pair provided by the reference rate provider.
-             */
-            reference_rate: number | null;
-            /**
-             * The reference rate provider.
-             */
-            reference_rate_provider: 'ecb' | null;
-        }
-    }
-    namespace Usage {
-        interface Payment {
-            /**
-             * The Stripe account ID that the funds will be transferred to.
-             *
-             * This field should match the account ID that would be used in the PaymentIntent's transfer_data[destination] field.
-             */
-            destination: string | null;
-            /**
-             * The Stripe account ID that these funds are intended for.
-             *
-             * This field must match the account ID that would be used in the PaymentIntent's on_behalf_of field.
-             */
-            on_behalf_of: string | null;
-        }
-        interface Transfer {
-            /**
-             * The Stripe account ID that the funds will be transferred to.
-             *
-             * This field should match the account ID that would be used in the Transfer's destination field.
-             */
-            destination: string;
-        }
-        type Type = 'payment' | 'transfer';
-    }
-}
-export interface FxQuoteCreateParams {
-    /**
-     * A list of three letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be [supported currencies](https://stripe.com/docs/currencies).
-     */
-    from_currencies: Array<string>;
-    /**
-     * The duration that you wish the quote to be locked for. The quote will be usable for the duration specified. The default is `none`. The maximum is 1 day.
-     */
-    lock_duration: FxQuoteCreateParams.LockDuration;
-    /**
-     * 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).
-     */
-    to_currency: string;
-    /**
-     * Specifies which fields in the response should be expanded.
-     */
-    expand?: Array<string>;
-    /**
-     * The usage specific information for the quote.
-     */
-    usage?: FxQuoteCreateParams.Usage;
-}
-export declare namespace FxQuoteCreateParams {
-    type LockDuration = 'day' | 'five_minutes' | 'hour' | 'none';
-    interface Usage {
-        /**
-         * The payment transaction details that are intended for the FX Quote.
-         */
-        payment?: Usage.Payment;
-        /**
-         * The transfer transaction details that are intended for the FX Quote.
-         */
-        transfer?: Usage.Transfer;
-        /**
-         * Which transaction the FX Quote will be used for
-         *
-         * Can be “payment” | “transfer”
-         */
-        type: Usage.Type;
-    }
-    namespace Usage {
-        interface Payment {
-            /**
-             * The Stripe account ID that the funds will be transferred to.
-             *
-             * This field should match the account ID that would be used in the PaymentIntent's transfer_data[destination] field.
-             */
-            destination?: string;
-            /**
-             * The Stripe account ID that these funds are intended for.
-             *
-             * This field should match the account ID that would be used in the PaymentIntent's on_behalf_of field.
-             */
-            on_behalf_of?: string;
-        }
-        interface Transfer {
-            /**
-             * The Stripe account ID that the funds will be transferred to.
-             *
-             * This field should match the account ID that would be used in the Transfer's destination field.
-             */
-            destination: string;
-        }
-        type Type = 'payment' | 'transfer';
-    }
-}
-export interface FxQuoteRetrieveParams {
-    /**
-     * Specifies which fields in the response should be expanded.
-     */
-    expand?: Array<string>;
-}
-export interface FxQuoteListParams extends PaginationParams {
-    /**
-     * Specifies which fields in the response should be expanded.
-     */
-    expand?: Array<string>;
-}

package/cjs/resources/FxQuotes.js

@@ -1,29 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FxQuoteResource = void 0;
-const StripeResource_js_1 = require("../StripeResource.js");
-class FxQuoteResource extends StripeResource_js_1.StripeResource {
-    /**
-     * Returns a list of FX quotes that have been issued. The FX quotes are returned in sorted order, with the most recent FX quotes appearing first.
-     */
-    list(params, options) {
-        return this._makeRequest('GET', '/v1/fx_quotes', params, options, {
-            methodType: 'list',
-        });
-    }
-    /**
-     * Creates an FX Quote object
-     */
-    create(params, options) {
-        return this._makeRequest('POST', '/v1/fx_quotes', params, options);
-    }
-    /**
-     * Retrieve an FX Quote object
-     */
-    retrieve(id, params, options) {
-        return this._makeRequest('GET', `/v1/fx_quotes/${encodeURIComponent(id)}`, params, options);
-    }
-}
-exports.FxQuoteResource = FxQuoteResource;
-//# sourceMappingURL=FxQuotes.js.map

package/cjs/resources/FxQuotes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FxQuotes.js","sourceRoot":"","sources":["../../src/resources/FxQuotes.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,4DAAoD;AAIpD,MAAa,eAAgB,SAAQ,kCAAc;IACjD;;OAEG;IACH,IAAI,CACF,MAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE;YAChE,UAAU,EAAE,MAAM;SACnB,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,CAAQ,CAAC;IAC5E,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,iBAAiB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACzC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AApCD,0CAoCC"}

package/cjs/resources/GiftCardOperations.d.ts

@@ -1,246 +0,0 @@
-import { StripeResource } from '../StripeResource.js';
-import { GiftCard } from './GiftCards.js';
-import { RequestOptions, Response } from '../lib.js';
-export declare class GiftCardOperationResource extends StripeResource {
-    /**
-     * Retrieves a third-party gift card operation object.
-     */
-    retrieve(id: string, params?: GiftCardOperationRetrieveParams, options?: RequestOptions): Promise<Response<GiftCardOperation>>;
-}
-export interface GiftCardOperation {
-    /**
-     * Unique identifier for the object.
-     */
-    id: string;
-    /**
-     * String representing the object's type. Objects of the same type share the same value.
-     */
-    object: 'gift_card_operation';
-    /**
-     * Details about a gift card activation operation.
-     */
-    activation?: GiftCardOperation.Activation;
-    /**
-     * Details about a gift card activation void operation.
-     */
-    activation_void?: GiftCardOperation.ActivationVoid;
-    /**
-     * Details about a gift card balance check operation.
-     */
-    balance_check?: GiftCardOperation.BalanceCheck;
-    /**
-     * Details about a gift card cashout operation.
-     */
-    cashout?: GiftCardOperation.Cashout;
-    /**
-     * Details about a gift card cashout void operation.
-     */
-    cashout_void?: GiftCardOperation.CashoutVoid;
-    /**
-     * The timestamp of when this operation was completed.
-     */
-    completed_at: number;
-    /**
-     * Time at which the object was created. Measured in seconds since the Unix epoch.
-     */
-    created: number;
-    /**
-     * Details about a gift card deactivation operation.
-     */
-    deactivation?: GiftCardOperation.Deactivation;
-    /**
-     * The failure code of the operation. Only present if the status is failed.
-     */
-    failure_code: GiftCardOperation.FailureCode | null;
-    /**
-     * The gift card this operation was performed on.
-     */
-    gift_card: string | GiftCard;
-    /**
-     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
-     */
-    livemode: boolean;
-    /**
-     * The connected account whose credentials were used to perform this operation.
-     */
-    on_behalf_of: string | null;
-    /**
-     * Details about a gift card reload operation.
-     */
-    reload?: GiftCardOperation.Reload;
-    /**
-     * Details about a gift card reload void operation.
-     */
-    reload_void?: GiftCardOperation.ReloadVoid;
-    /**
-     * The status of the operation.
-     */
-    status: GiftCardOperation.Status;
-    /**
-     * The type of operation performed.
-     */
-    type: GiftCardOperation.Type;
-}
-export declare namespace GiftCardOperation {
-    interface Activation {
-        /**
-         * The balance amount of a gift card, including currency and amount.
-         */
-        balance: Activation.Balance;
-    }
-    interface ActivationVoid {
-        /**
-         * The operation that was voided.
-         */
-        voided_operation: string;
-    }
-    interface BalanceCheck {
-        /**
-         * The balance amount of a gift card, including currency and amount.
-         */
-        balance: BalanceCheck.Balance;
-    }
-    interface Cashout {
-        /**
-         * The balance amount of a gift card, including currency and amount.
-         */
-        balance: Cashout.Balance;
-        /**
-         * The balance before the operation.
-         */
-        previous_balance: Cashout.PreviousBalance | null;
-    }
-    interface CashoutVoid {
-        /**
-         * The balance amount of a gift card, including currency and amount.
-         */
-        balance: CashoutVoid.Balance;
-        /**
-         * The operation that was voided.
-         */
-        voided_operation: string;
-    }
-    interface Deactivation {
-    }
-    type FailureCode = 'action_not_supported' | 'card_already_activated' | 'card_expired' | 'card_not_activated' | 'do_not_honor' | 'generic_failure' | 'insufficient_balance' | 'invalid_amount' | 'invalid_currency' | 'invalid_number' | 'invalid_pin' | 'invalid_track_data' | 'lost_card' | 'lost_or_stolen_card' | 'pin_required' | 'pin_tries_exceeded' | 'processing_error' | 'provider_unavailable' | 'stolen_card' | 'suspected_fraud' | 'timeout';
-    interface Reload {
-        /**
-         * The balance amount of a gift card, including currency and amount.
-         */
-        balance: Reload.Balance;
-        /**
-         * The balance before the operation.
-         */
-        previous_balance: Reload.PreviousBalance | null;
-    }
-    interface ReloadVoid {
-        /**
-         * The balance amount of a gift card, including currency and amount.
-         */
-        balance: ReloadVoid.Balance;
-        /**
-         * The operation that was voided.
-         */
-        voided_operation: string;
-    }
-    type Status = 'failed' | 'succeeded';
-    type Type = 'activation' | 'activation_void' | 'balance_check' | 'cashout' | 'cashout_void' | 'deactivation' | 'reload' | 'reload_void';
-    namespace Activation {
-        interface Balance {
-            /**
-             * The balance amount.
-             */
-            amount: number;
-            /**
-             * The currency of the balance.
-             */
-            currency: string;
-        }
-    }
-    namespace BalanceCheck {
-        interface Balance {
-            /**
-             * The balance amount.
-             */
-            amount: number;
-            /**
-             * The currency of the balance.
-             */
-            currency: string;
-        }
-    }
-    namespace Cashout {
-        interface Balance {
-            /**
-             * The balance amount.
-             */
-            amount: number;
-            /**
-             * The currency of the balance.
-             */
-            currency: string;
-        }
-        interface PreviousBalance {
-            /**
-             * The balance amount.
-             */
-            amount: number;
-            /**
-             * The currency of the balance.
-             */
-            currency: string;
-        }
-    }
-    namespace CashoutVoid {
-        interface Balance {
-            /**
-             * The balance amount.
-             */
-            amount: number;
-            /**
-             * The currency of the balance.
-             */
-            currency: string;
-        }
-    }
-    namespace Reload {
-        interface Balance {
-            /**
-             * The balance amount.
-             */
-            amount: number;
-            /**
-             * The currency of the balance.
-             */
-            currency: string;
-        }
-        interface PreviousBalance {
-            /**
-             * The balance amount.
-             */
-            amount: number;
-            /**
-             * The currency of the balance.
-             */
-            currency: string;
-        }
-    }
-    namespace ReloadVoid {
-        interface Balance {
-            /**
-             * The balance amount.
-             */
-            amount: number;
-            /**
-             * The currency of the balance.
-             */
-            currency: string;
-        }
-    }
-}
-export interface GiftCardOperationRetrieveParams {
-    /**
-     * Specifies which fields in the response should be expanded.
-     */
-    expand?: Array<string>;
-}

package/cjs/resources/GiftCardOperations.js

@@ -1,15 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GiftCardOperationResource = void 0;
-const StripeResource_js_1 = require("../StripeResource.js");
-class GiftCardOperationResource extends StripeResource_js_1.StripeResource {
-    /**
-     * Retrieves a third-party gift card operation object.
-     */
-    retrieve(id, params, options) {
-        return this._makeRequest('GET', `/v1/gift_card_operations/${encodeURIComponent(id)}`, params, options);
-    }
-}
-exports.GiftCardOperationResource = GiftCardOperationResource;
-//# sourceMappingURL=GiftCardOperations.js.map

package/cjs/resources/GiftCardOperations.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"GiftCardOperations.js","sourceRoot":"","sources":["../../src/resources/GiftCardOperations.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,4DAAoD;AAIpD,MAAa,yBAA0B,SAAQ,kCAAc;IAC3D;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,4BAA4B,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACpD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAhBD,8DAgBC"}

package/cjs/resources/GiftCards.d.ts

@@ -1,187 +0,0 @@
-import { StripeResource } from '../StripeResource.js';
-import { GiftCardOperation } from './GiftCardOperations.js';
-import { RequestOptions, Response } from '../lib.js';
-export declare class GiftCardResource extends StripeResource {
-    /**
-     * Retrieves a third-party gift card object.
-     */
-    retrieve(id: string, params?: GiftCardRetrieveParams, options?: RequestOptions): Promise<Response<GiftCard>>;
-    /**
-     * Creates a gift card object.
-     */
-    create(params: GiftCardCreateParams, options?: RequestOptions): Promise<Response<GiftCard>>;
-    /**
-     * Activates a third-party gift card and optionally sets its balance.
-     */
-    activate(id: string, params?: GiftCardActivateParams, options?: RequestOptions): Promise<Response<GiftCardOperation>>;
-    /**
-     * Cashout a third-party gift card by zeroing its balance.
-     */
-    cashout(id: string, params?: GiftCardCashoutParams, options?: RequestOptions): Promise<Response<GiftCardOperation>>;
-    /**
-     * Checks the balance of a third-party gift card.
-     */
-    checkBalance(id: string, params?: GiftCardCheckBalanceParams, options?: RequestOptions): Promise<Response<GiftCardOperation>>;
-    /**
-     * Reloads a third-party gift card by adding the specified amount to its balance.
-     */
-    reload(id: string, params: GiftCardReloadParams, options?: RequestOptions): Promise<Response<GiftCardOperation>>;
-    /**
-     * Voids a previously performed gift card operation.
-     */
-    voidOperation(id: string, params: GiftCardVoidOperationParams, options?: RequestOptions): Promise<Response<GiftCardOperation>>;
-}
-export interface GiftCard {
-    /**
-     * Unique identifier for the object.
-     */
-    id: string;
-    /**
-     * String representing the object's type. Objects of the same type share the same value.
-     */
-    object: 'gift_card';
-    /**
-     * The brand of the gift card.
-     */
-    brand: GiftCard.Brand;
-    /**
-     * The expiration month of the gift card.
-     */
-    exp_month: number | null;
-    /**
-     * The expiration year of the gift card.
-     */
-    exp_year: number | null;
-    /**
-     * Uniquely identifies this particular gift card number. You can use this attribute to check whether two gift cards are the same.
-     */
-    fingerprint: string;
-    /**
-     * The last operation performed on this gift card.
-     */
-    last_operation: string | GiftCardOperation | null;
-    /**
-     * The last four digits of the gift card number.
-     */
-    last4: string | null;
-    /**
-     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
-     */
-    livemode: boolean;
-}
-export declare namespace GiftCard {
-    type Brand = 'fiserv_valuelink' | 'givex' | 'svs';
-}
-export interface GiftCardCreateParams {
-    /**
-     * The brand of the gift card.
-     */
-    brand: GiftCardCreateParams.Brand;
-    /**
-     * Two-digit number representing the gift card's expiration month.
-     */
-    exp_month?: number;
-    /**
-     * Four-digit number representing the gift card's expiration year.
-     */
-    exp_year?: number;
-    /**
-     * Specifies which fields in the response should be expanded.
-     */
-    expand?: Array<string>;
-    /**
-     * The gift card number.
-     */
-    number?: string;
-    /**
-     * The gift card PIN.
-     */
-    pin?: string;
-}
-export declare namespace GiftCardCreateParams {
-    type Brand = 'fiserv_valuelink' | 'givex' | 'svs';
-}
-export interface GiftCardRetrieveParams {
-    /**
-     * Specifies which fields in the response should be expanded.
-     */
-    expand?: Array<string>;
-}
-export interface GiftCardActivateParams {
-    /**
-     * The initial balance to set on the gift card.
-     */
-    balance?: GiftCardActivateParams.Balance;
-    /**
-     * Specifies which fields in the response should be expanded.
-     */
-    expand?: Array<string>;
-    /**
-     * The Stripe account ID to process the gift card operation on behalf of.
-     */
-    on_behalf_of?: string;
-}
-export declare namespace GiftCardActivateParams {
-    interface Balance {
-        /**
-         * The initial balance amount to be loaded when activating the gift card, in the smallest currency unit
-         */
-        amount: 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;
-    }
-}
-export interface GiftCardCashoutParams {
-    /**
-     * Specifies which fields in the response should be expanded.
-     */
-    expand?: Array<string>;
-    /**
-     * The Stripe account ID to process the gift card operation on behalf of.
-     */
-    on_behalf_of?: string;
-}
-export interface GiftCardCheckBalanceParams {
-    /**
-     * Specifies which fields in the response should be expanded.
-     */
-    expand?: Array<string>;
-    /**
-     * The Stripe account ID to process the gift card operation on behalf of.
-     */
-    on_behalf_of?: string;
-}
-export interface GiftCardReloadParams {
-    /**
-     * The amount to add to the gift card balance, in the smallest currency unit.
-     */
-    amount: 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;
-    /**
-     * Specifies which fields in the response should be expanded.
-     */
-    expand?: Array<string>;
-    /**
-     * The Stripe account ID to process the gift card operation on behalf of.
-     */
-    on_behalf_of?: string;
-}
-export interface GiftCardVoidOperationParams {
-    /**
-     * The ID of the gift card operation to void.
-     */
-    operation: string;
-    /**
-     * Specifies which fields in the response should be expanded.
-     */
-    expand?: Array<string>;
-    /**
-     * The Stripe account ID to process the gift card operation on behalf of.
-     */
-    on_behalf_of?: string;
-}