@depup/stripe 21.0.0-depup.0

package/types/LineItems.d.ts

@@ -0,0 +1,145 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * A line item.
+     */
+    interface LineItem {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'item';
+
+      adjustable_quantity: LineItem.AdjustableQuantity | null;
+
+      /**
+       * Total discount amount applied. If no discounts were applied, defaults to 0.
+       */
+      amount_discount: number;
+
+      /**
+       * Total before any discounts or taxes are applied.
+       */
+      amount_subtotal: number;
+
+      /**
+       * Total tax amount applied. If no tax was applied, defaults to 0.
+       */
+      amount_tax: number;
+
+      /**
+       * Total after discounts and taxes.
+       */
+      amount_total: 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;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
+       */
+      description: string | null;
+
+      /**
+       * The discounts applied to the line item.
+       */
+      discounts?: Array<LineItem.Discount>;
+
+      /**
+       * Set of [key-value pairs](https://docs.stripe.com/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 price used to generate the line item.
+       */
+      price: Stripe.Price | null;
+
+      /**
+       * The quantity of products being purchased.
+       */
+      quantity: number | null;
+
+      /**
+       * The taxes applied to the line item.
+       */
+      taxes?: Array<LineItem.Tax>;
+    }
+
+    namespace LineItem {
+      interface AdjustableQuantity {
+        enabled: boolean;
+
+        maximum: number | null;
+
+        minimum: number | null;
+      }
+
+      interface Discount {
+        /**
+         * The amount discounted.
+         */
+        amount: number;
+
+        /**
+         * A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
+         * It contains information about when the discount began, when it will end, and what it is applied to.
+         *
+         * Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
+         */
+        discount: Stripe.Discount;
+      }
+
+      interface Tax {
+        /**
+         * Amount of tax applied for this rate.
+         */
+        amount: number;
+
+        /**
+         * Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
+         *
+         * Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
+         */
+        rate: Stripe.TaxRate;
+
+        /**
+         * The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
+         */
+        taxability_reason: Tax.TaxabilityReason | null;
+
+        /**
+         * The amount on which tax is calculated, in cents (or local equivalent).
+         */
+        taxable_amount: number | null;
+      }
+
+      namespace Tax {
+        type TaxabilityReason =
+          | 'customer_exempt'
+          | 'not_collecting'
+          | 'not_subject_to_tax'
+          | 'not_supported'
+          | 'portion_product_exempt'
+          | 'portion_reduced_rated'
+          | 'portion_standard_rated'
+          | 'product_exempt'
+          | 'product_exempt_holiday'
+          | 'proportionally_rated'
+          | 'reduced_rated'
+          | 'reverse_charge'
+          | 'standard_rated'
+          | 'taxable_basis_reduced'
+          | 'zero_rated';
+      }
+    }
+  }
+}

package/types/LoginLinks.d.ts

@@ -0,0 +1,26 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard.
+     * A Login Link differs from an [Account Link](https://docs.stripe.com/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://docs.stripe.com/connect/integrate-express-dashboard#create-login-link)
+     */
+    interface LoginLink {
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'login_link';
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * The URL for the login link.
+       */
+      url: string;
+    }
+  }
+}

package/types/Mandates.d.ts

@@ -0,0 +1,373 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * A Mandate is a record of the permission that your customer gives you to debit their payment method.
+     */
+    interface Mandate {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'mandate';
+
+      customer_acceptance: Mandate.CustomerAcceptance;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+
+      multi_use?: Mandate.MultiUse;
+
+      /**
+       * The account (if any) that the mandate is intended for.
+       */
+      on_behalf_of?: string;
+
+      /**
+       * ID of the payment method associated with this mandate.
+       */
+      payment_method: string | Stripe.PaymentMethod;
+
+      payment_method_details: Mandate.PaymentMethodDetails;
+
+      single_use?: Mandate.SingleUse;
+
+      /**
+       * The mandate status indicates whether or not you can use it to initiate a payment.
+       */
+      status: Mandate.Status;
+
+      /**
+       * The type of the mandate.
+       */
+      type: Mandate.Type;
+    }
+
+    namespace Mandate {
+      interface CustomerAcceptance {
+        /**
+         * The time that the customer accepts the mandate.
+         */
+        accepted_at: number | null;
+
+        offline?: CustomerAcceptance.Offline;
+
+        online?: CustomerAcceptance.Online;
+
+        /**
+         * The mandate includes the type of customer acceptance information, such as: `online` or `offline`.
+         */
+        type: CustomerAcceptance.Type;
+      }
+
+      namespace CustomerAcceptance {
+        interface Offline {}
+
+        interface Online {
+          /**
+           * The customer accepts the mandate from this IP address.
+           */
+          ip_address: string | null;
+
+          /**
+           * The customer accepts the mandate using the user agent of the browser.
+           */
+          user_agent: string | null;
+        }
+
+        type Type = 'offline' | 'online';
+      }
+
+      interface MultiUse {}
+
+      interface PaymentMethodDetails {
+        acss_debit?: PaymentMethodDetails.AcssDebit;
+
+        amazon_pay?: PaymentMethodDetails.AmazonPay;
+
+        au_becs_debit?: PaymentMethodDetails.AuBecsDebit;
+
+        bacs_debit?: PaymentMethodDetails.BacsDebit;
+
+        card?: PaymentMethodDetails.Card;
+
+        cashapp?: PaymentMethodDetails.Cashapp;
+
+        kakao_pay?: PaymentMethodDetails.KakaoPay;
+
+        klarna?: PaymentMethodDetails.Klarna;
+
+        kr_card?: PaymentMethodDetails.KrCard;
+
+        link?: PaymentMethodDetails.Link;
+
+        naver_pay?: PaymentMethodDetails.NaverPay;
+
+        nz_bank_account?: PaymentMethodDetails.NzBankAccount;
+
+        paypal?: PaymentMethodDetails.Paypal;
+
+        payto?: PaymentMethodDetails.Payto;
+
+        revolut_pay?: PaymentMethodDetails.RevolutPay;
+
+        sepa_debit?: PaymentMethodDetails.SepaDebit;
+
+        /**
+         * This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method.
+         */
+        type: string;
+
+        upi?: PaymentMethodDetails.Upi;
+
+        us_bank_account?: PaymentMethodDetails.UsBankAccount;
+      }
+
+      namespace PaymentMethodDetails {
+        interface AcssDebit {
+          /**
+           * List of Stripe products where this mandate can be selected automatically.
+           */
+          default_for?: Array<AcssDebit.DefaultFor>;
+
+          /**
+           * Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
+           */
+          interval_description: string | null;
+
+          /**
+           * Payment schedule for the mandate.
+           */
+          payment_schedule: AcssDebit.PaymentSchedule;
+
+          /**
+           * Transaction type of the mandate.
+           */
+          transaction_type: AcssDebit.TransactionType;
+        }
+
+        namespace AcssDebit {
+          type DefaultFor = 'invoice' | 'subscription';
+
+          type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
+
+          type TransactionType = 'business' | 'personal';
+        }
+
+        interface AmazonPay {}
+
+        interface AuBecsDebit {
+          /**
+           * The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.
+           */
+          url: string;
+        }
+
+        interface BacsDebit {
+          /**
+           * The display name for the account on this mandate.
+           */
+          display_name: string | null;
+
+          /**
+           * The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`.
+           */
+          network_status: BacsDebit.NetworkStatus;
+
+          /**
+           * The unique reference identifying the mandate on the Bacs network.
+           */
+          reference: string;
+
+          /**
+           * When the mandate is revoked on the Bacs network this field displays the reason for the revocation.
+           */
+          revocation_reason: BacsDebit.RevocationReason | null;
+
+          /**
+           * The service user number for the account on this mandate.
+           */
+          service_user_number: string | null;
+
+          /**
+           * The URL that will contain the mandate that the customer has signed.
+           */
+          url: string;
+        }
+
+        namespace BacsDebit {
+          type NetworkStatus = 'accepted' | 'pending' | 'refused' | 'revoked';
+
+          type RevocationReason =
+            | 'account_closed'
+            | 'bank_account_restricted'
+            | 'bank_ownership_changed'
+            | 'could_not_process'
+            | 'debit_not_authorized';
+        }
+
+        interface Card {}
+
+        interface Cashapp {}
+
+        interface KakaoPay {}
+
+        interface Klarna {}
+
+        interface KrCard {}
+
+        interface Link {}
+
+        interface NaverPay {}
+
+        interface NzBankAccount {}
+
+        interface Paypal {
+          /**
+           * The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
+           */
+          billing_agreement_id: string | null;
+
+          /**
+           * PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
+           */
+          payer_id: string | null;
+        }
+
+        interface Payto {
+          /**
+           * Amount that will be collected. It is required when `amount_type` is `fixed`.
+           */
+          amount: number | null;
+
+          /**
+           * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.
+           */
+          amount_type: Payto.AmountType;
+
+          /**
+           * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
+           */
+          end_date: string | null;
+
+          /**
+           * The periodicity at which payments will be collected. Defaults to `adhoc`.
+           */
+          payment_schedule: Payto.PaymentSchedule;
+
+          /**
+           * The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
+           */
+          payments_per_period: number | null;
+
+          /**
+           * The purpose for which payments are made. Has a default value based on your merchant category code.
+           */
+          purpose: Payto.Purpose | null;
+
+          /**
+           * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
+           */
+          start_date: string | null;
+        }
+
+        namespace Payto {
+          type AmountType = 'fixed' | 'maximum';
+
+          type PaymentSchedule =
+            | 'adhoc'
+            | 'annual'
+            | 'daily'
+            | 'fortnightly'
+            | 'monthly'
+            | 'quarterly'
+            | 'semi_annual'
+            | 'weekly';
+
+          type Purpose =
+            | 'dependant_support'
+            | 'government'
+            | 'loan'
+            | 'mortgage'
+            | 'other'
+            | 'pension'
+            | 'personal'
+            | 'retail'
+            | 'salary'
+            | 'tax'
+            | 'utility';
+        }
+
+        interface RevolutPay {}
+
+        interface SepaDebit {
+          /**
+           * The unique reference of the mandate.
+           */
+          reference: string;
+
+          /**
+           * The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.
+           */
+          url: string;
+        }
+
+        interface Upi {
+          /**
+           * Amount to be charged for future payments.
+           */
+          amount: number | null;
+
+          /**
+           * One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
+           */
+          amount_type: Upi.AmountType | null;
+
+          /**
+           * A description of the mandate or subscription that is meant to be displayed to the customer.
+           */
+          description: string | null;
+
+          /**
+           * End date of the mandate or subscription.
+           */
+          end_date: number | null;
+        }
+
+        namespace Upi {
+          type AmountType = 'fixed' | 'maximum';
+        }
+
+        interface UsBankAccount {
+          /**
+           * Mandate collection method
+           */
+          collection_method?: 'paper';
+        }
+      }
+
+      interface SingleUse {
+        /**
+         * The amount of the payment on a single use mandate.
+         */
+        amount: number;
+
+        /**
+         * The currency of the payment on a single use mandate.
+         */
+        currency: string;
+      }
+
+      type Status = 'active' | 'inactive' | 'pending';
+
+      type Type = 'multi_use' | 'single_use';
+    }
+  }
+}

package/types/MandatesResource.d.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface MandateRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class MandatesResource {
+      /**
+       * Retrieves a Mandate object.
+       */
+      retrieve(
+        id: string,
+        params?: MandateRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Mandate>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.Mandate>>;
+    }
+  }
+}