stripe 16.6.0-beta.1 → 16.6.0

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';
-      }
-    }
-  }
-}

package/types/GiftCards/TransactionsResource.d.ts

@@ -1,201 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    namespace GiftCards {
-      interface TransactionCreateParams {
-        /**
-         * The amount of the transaction. A negative amount deducts funds, and a positive amount adds funds.
-         */
-        amount: number;
-
-        /**
-         * The currency of the transaction. This must match the currency of the gift card.
-         */
-        currency: string;
-
-        /**
-         * The gift card to create a new transaction on.
-         */
-        gift_card: string;
-
-        /**
-         * Whether this is a confirmed transaction. A confirmed transaction immediately deducts from/adds to the `amount_available` on the gift card. Otherwise, it creates a held transaction that increments the `amount_held` on the gift card.
-         */
-        confirm?: boolean;
-
-        /**
-         * Related objects which created this transaction.
-         */
-        created_by?: TransactionCreateParams.CreatedBy;
-
-        /**
-         * An arbitrary string attached to the object. Often useful for displaying to users.
-         */
-        description?: string;
-
-        /**
-         * 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;
-
-        /**
-         * 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;
-      }
-
-      namespace TransactionCreateParams {
-        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 TransactionRetrieveParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface TransactionUpdateParams {
-        /**
-         * An arbitrary string attached to the object. Often useful for displaying to users.
-         */
-        description?: string;
-
-        /**
-         * 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 TransactionListParams extends PaginationParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-
-        /**
-         * The gift card to list transactions for.
-         */
-        gift_card?: string;
-
-        /**
-         * 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;
-      }
-
-      interface TransactionCancelParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      interface TransactionConfirmParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
-      class TransactionsResource {
-        /**
-         * Create a gift card transaction
-         */
-        create(
-          params: TransactionCreateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Transaction>>;
-
-        /**
-         * Retrieves the gift card transaction.
-         */
-        retrieve(
-          id: string,
-          params?: TransactionRetrieveParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Transaction>>;
-        retrieve(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Transaction>>;
-
-        /**
-         * Update a gift card transaction
-         */
-        update(
-          id: string,
-          params?: TransactionUpdateParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Transaction>>;
-
-        /**
-         * List gift card transactions for a gift card
-         */
-        list(
-          params?: TransactionListParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.GiftCards.Transaction>;
-        list(
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.GiftCards.Transaction>;
-
-        /**
-         * Cancel a gift card transaction
-         */
-        cancel(
-          id: string,
-          params?: TransactionCancelParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Transaction>>;
-        cancel(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Transaction>>;
-
-        /**
-         * Confirm a gift card transaction
-         */
-        confirm(
-          id: string,
-          params?: TransactionConfirmParams,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Transaction>>;
-        confirm(
-          id: string,
-          options?: RequestOptions
-        ): Promise<Stripe.Response<Stripe.GiftCards.Transaction>>;
-      }
-    }
-  }
-}

package/types/InvoicePayments.d.ts

@@ -1,138 +0,0 @@
-// File generated from our OpenAPI spec
-
-declare module 'stripe' {
-  namespace Stripe {
-    /**
-     * The invoice payment object
-     */
-    interface InvoicePayment {
-      /**
-       * Unique identifier for the object.
-       */
-      id: string;
-
-      /**
-       * String representing the object's type. Objects of the same type share the same value.
-       */
-      object: 'invoice_payment';
-
-      /**
-       * Excess payment that was received for this invoice and credited to the customer's `invoice_credit_balance`. This field is null until the payment is `paid`. Overpayment can happen when you attach more than one PaymentIntent to the invoice, and each of them succeeds. To avoid overpayment, cancel any PaymentIntents that you do not need before attaching more.
-       */
-      amount_overpaid: number | null;
-
-      /**
-       * Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent's `amount_received` is not sufficient to pay all of the invoices that it is attached to.
-       */
-      amount_paid: number | null;
-
-      /**
-       * Amount intended to be paid toward this invoice, in cents (or local equivalent)
-       */
-      amount_requested: 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 invoice that was paid.
-       */
-      invoice: string | Stripe.Invoice | Stripe.DeletedInvoice;
-
-      /**
-       * Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice's `amount_remaining`. The PaymentIntent associated with the default payment can't be edited or canceled directly.
-       */
-      is_default: boolean | null;
-
-      /**
-       * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-       */
-      livemode: boolean;
-
-      payment: InvoicePayment.Payment;
-
-      /**
-       * The status of the payment, one of `open`, `paid`, or `canceled`.
-       */
-      status: string;
-
-      status_transitions: InvoicePayment.StatusTransitions;
-    }
-
-    namespace InvoicePayment {
-      interface Payment {
-        /**
-         * ID of the successful charge for this payment when `type` is `charge`.
-         */
-        charge?: string | Stripe.Charge;
-
-        out_of_band_payment?: Payment.OutOfBandPayment;
-
-        /**
-         * ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.
-         */
-        payment_intent?: string | Stripe.PaymentIntent;
-
-        /**
-         * Type of payment object associated with this invoice payment.
-         */
-        type: Payment.Type;
-      }
-
-      namespace Payment {
-        interface OutOfBandPayment {
-          /**
-           * Amount paid on this out of band payment, in cents (or local equivalent)
-           */
-          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;
-
-          /**
-           * 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;
-
-          /**
-           * The type of money movement for this out of band payment record.
-           */
-          money_movement_type: string;
-
-          /**
-           * The timestamp when this out of band payment was paid.
-           */
-          paid_at: number | null;
-
-          /**
-           * The reference for this out of band payment record.
-           */
-          payment_reference: string | null;
-        }
-
-        type Type = 'charge' | 'out_of_band_payment' | 'payment_intent';
-      }
-
-      interface StatusTransitions {
-        /**
-         * The time that the payment was canceled.
-         */
-        canceled_at: number | null;
-
-        /**
-         * The time that the payment succeeded.
-         */
-        paid_at: number | null;
-      }
-    }
-  }
-}