stripe 18.1.0-beta.3 → 18.1.0

package/types/FxQuotesResource.d.ts

@@ -1,130 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    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;
-    }
-
-    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';
-      }
-    }
-
-    interface FxQuoteRetrieveParams {
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-    }
-
-    interface FxQuoteListParams extends PaginationParams {
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-    }
-
-    class FxQuotesResource {
-      /**
-       * Creates an FX Quote object
-       */
-      create(
-        params: FxQuoteCreateParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.FxQuote>>;
-
-      /**
-       * Retrieve an FX Quote object
-       */
-      retrieve(
-        id: string,
-        params?: FxQuoteRetrieveParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.FxQuote>>;
-      retrieve(
-        id: string,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.FxQuote>>;
-
-      /**
-       * 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<Stripe.FxQuote>;
-      list(options?: RequestOptions): ApiListPromise<Stripe.FxQuote>;
-    }
-  }
-}

package/types/GiftCards/Cards.d.ts

@@ -1,118 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace GiftCards {
-      /**
-       * A gift card represents a single gift card owned by a customer, including the
-       * remaining balance, gift card code, and whether or not it is active.
-       */
-      interface Card {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'gift_cards.card';
-
-        /**
-         * Whether this gift card can be used or not.
-         */
-        active: boolean;
-
-        /**
-         * The amount of funds available for new transactions.
-         */
-        amount_available: number;
-
-        /**
-         * The amount of funds marked as held.
-         */
-        amount_held: number;
-
-        /**
-         * Code used to redeem this gift card.
-         */
-        code?: string | null;
-
-        /**
-         * Time at which the object was created. Measured in seconds since the Unix epoch.
-         */
-        created: number;
-
-        /**
-         * The related Stripe objects that created this gift card.
-         */
-        created_by: Card.CreatedBy | null;
-
-        /**
-         * 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;
-
-        /**
-         * 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;
-
-        /**
-         * Transactions on this gift card.
-         */
-        transactions?: ApiList<Stripe.GiftCards.Transaction>;
-      }
-
-      namespace Card {
-        interface CreatedBy {
-          checkout?: CreatedBy.Checkout;
-
-          order?: CreatedBy.Order;
-
-          payment?: CreatedBy.Payment;
-
-          /**
-           * The type of event that created this object.
-           */
-          type: CreatedBy.Type;
-        }
-
-        namespace CreatedBy {
-          interface Checkout {
-            /**
-             * The Stripe CheckoutSession that created this object.
-             */
-            checkout_session: string;
-
-            /**
-             * The Stripe CheckoutSession LineItem that created this object.
-             */
-            line_item: string | null;
-          }
-
-          interface Order {
-            /**
-             * The Stripe Order LineItem that created this object.
-             */
-            line_item: string | null;
-
-            /**
-             * The Stripe Order that created this object.
-             */
-            order: string;
-          }
-
-          interface Payment {
-            /**
-             * The PaymentIntent that created this object.
-             */
-            payment_intent: string;
-          }
-
-          type Type = 'checkout' | 'order' | 'payment';
-        }
-      }
-    }
-  }
-}

package/types/GiftCards/CardsResource.d.ts

@@ -1,159 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace GiftCards {
-      interface CardCreateParams {
-        /**
-         * 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 active state for the new gift card, defaults to false. The active state can be updated after creation.
-         */
-        active?: boolean;
-
-        /**
-         * Related objects which created this gift card.
-         */
-        created_by?: CardCreateParams.CreatedBy;
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * The initial amount to load onto the new gift card, defaults to 0.
-         */
-        initial_amount?: number;
-
-        /**
-         * 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;
-      }
-
-      namespace CardCreateParams {
-        interface CreatedBy {
-          /**
-           * The details for the payment that created this object.
-           */
-          payment: CreatedBy.Payment;
-
-          /**
-           * The type of event that created this object.
-           */
-          type: 'payment';
-        }
-
-        namespace CreatedBy {
-          interface Payment {
-            /**
-             * The PaymentIntent used to collect payment for this object.
-             */
-            payment_intent: string;
-          }
-        }
-      }
-
-      interface CardRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface CardUpdateParams {
-        /**
-         * The new active state for the gift card.
-         */
-        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.Emptyable<Stripe.MetadataParam>;
-      }
-
-      interface CardListParams extends PaginationParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface CardValidateParams {
-        /**
-         * The gift card code to be validated.
-         */
-        code: string;
-
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * The pin associated with the gift card. Not all gift cards have pins.
-         */
-        giftcard_pin?: string;
-      }
-
-      class CardsResource {
-        /**
-         * Creates a new gift card object.
-         */
-        create(
-          params: CardCreateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
-
-        /**
-         * Retrieve a gift card by id
-         */
-        retrieve(
-          id: string,
-          params?: CardRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
-
-        /**
-         * Update a gift card
-         */
-        update(
-          id: string,
-          params?: CardUpdateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
-
-        /**
-         * List gift cards for an account
-         */
-        list(
-          params?: CardListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.GiftCards.Card>;
-        list(options?: RequestOptions): ApiListPromise<Stripe.GiftCards.Card>;
-
-        /**
-         * Validates a gift card code, returning the matching gift card object if it exists.
-         */
-        validate(
-          params: CardValidateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Card>>;
-      }
-    }
-  }
-}

package/types/GiftCards/Transactions.d.ts

@@ -1,129 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace GiftCards {
-      /**
-       * A gift card transaction represents a single transaction on a referenced gift card.
-       * A transaction is in one of three states, `confirmed`, `held` or `canceled`. A `confirmed`
-       * transaction is one that has added/deducted funds. A `held` transaction has created a
-       * temporary hold on funds, which can then be cancelled or confirmed. A `held` transaction
-       * can be confirmed into a `confirmed` transaction, or canceled into a `canceled` transaction.
-       * A `canceled` transaction has no effect on a gift card's balance.
-       */
-      interface Transaction {
-        /**
-         * Unique identifier for the object.
-         */
-        id: string;
-
-        /**
-         * String representing the object's type. Objects of the same type share the same value.
-         */
-        object: 'gift_cards.transaction';
-
-        /**
-         * The amount of this transaction. A positive value indicates that funds were added to the gift card. A negative value indicates that funds were removed from the gift card.
-         */
-        amount: number | null;
-
-        /**
-         * Time at which the transaction was confirmed. Measured in seconds since the Unix epoch.
-         */
-        confirmed_at: number | null;
-
-        /**
-         * Time at which the object was created. Measured in seconds since the Unix epoch.
-         */
-        created: number | null;
-
-        /**
-         * The related Stripe objects that created this gift card transaction.
-         */
-        created_by: Transaction.CreatedBy | null;
-
-        /**
-         * 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 | null;
-
-        /**
-         * An arbitrary string attached to the object. Often useful for displaying to users.
-         */
-        description: string | null;
-
-        /**
-         * The gift card that this transaction occurred on
-         */
-        gift_card: string | null;
-
-        /**
-         * 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;
-
-        /**
-         * Status of this transaction, one of `held`, `confirmed`, or `canceled`.
-         */
-        status: Transaction.Status | null;
-
-        /**
-         * A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
-         */
-        transfer_group: string | null;
-      }
-
-      namespace Transaction {
-        interface CreatedBy {
-          checkout?: CreatedBy.Checkout;
-
-          order?: CreatedBy.Order;
-
-          payment?: CreatedBy.Payment;
-
-          /**
-           * The type of event that created this object.
-           */
-          type: CreatedBy.Type;
-        }
-
-        namespace CreatedBy {
-          interface Checkout {
-            /**
-             * The Stripe CheckoutSession that created this object.
-             */
-            checkout_session: string;
-
-            /**
-             * The Stripe CheckoutSession LineItem that created this object.
-             */
-            line_item: string | null;
-          }
-
-          interface Order {
-            /**
-             * The Stripe Order LineItem that created this object.
-             */
-            line_item: string | null;
-
-            /**
-             * The Stripe Order that created this object.
-             */
-            order: string;
-          }
-
-          interface Payment {
-            /**
-             * The PaymentIntent that created this object.
-             */
-            payment_intent: string;
-          }
-
-          type Type = 'checkout' | 'order' | 'payment';
-        }
-
-        type Status = 'canceled' | 'confirmed' | 'held' | 'invalid';
-      }
-    }
-  }
-}