stripe 15.4.0.pre.beta.2 → 15.4.0

data/rbi/stripe/resources/line_item.rbi

@@ -0,0 +1,72 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # A line item.
+  class LineItem < APIResource
+    class Discount < Stripe::StripeObject
+      # The amount discounted.
+      sig { returns(Integer) }
+      attr_reader :amount
+      # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#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://stripe.com/docs/billing/subscriptions/discounts)
+      sig { returns(Stripe::Discount) }
+      attr_reader :discount
+    end
+    class Tax < Stripe::StripeObject
+      # Amount of tax applied for this rate.
+      sig { returns(Integer) }
+      attr_reader :amount
+      # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
+      #
+      # Related guide: [Tax rates](/billing/taxes/tax-rates)
+      sig { returns(Stripe::TaxRate) }
+      attr_reader :rate
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :taxability_reason
+      # The amount on which tax is calculated, in cents (or local equivalent).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :taxable_amount
+    end
+    # Total discount amount applied. If no discounts were applied, defaults to 0.
+    sig { returns(Integer) }
+    attr_reader :amount_discount
+    # Total before any discounts or taxes are applied.
+    sig { returns(Integer) }
+    attr_reader :amount_subtotal
+    # Total tax amount applied. If no tax was applied, defaults to 0.
+    sig { returns(Integer) }
+    attr_reader :amount_tax
+    # Total after discounts and taxes.
+    sig { returns(Integer) }
+    attr_reader :amount_total
+    # 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).
+    sig { returns(String) }
+    attr_reader :currency
+    # An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
+    sig { returns(T.nilable(String)) }
+    attr_reader :description
+    # The discounts applied to the line item.
+    sig { returns(T::Array[Discount]) }
+    attr_reader :discounts
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # The price used to generate the line item.
+    sig { returns(T.nilable(Stripe::Price)) }
+    attr_reader :price
+    # The quantity of products being purchased.
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :quantity
+    # The taxes applied to the line item.
+    sig { returns(T::Array[Tax]) }
+    attr_reader :taxes
+  end
+end

data/rbi/stripe/resources/login_link.rbi

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module 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://stripe.com/docs/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://stripe.com/docs/connect/integrate-express-dashboard#create-login-link)
+  class LoginLink < APIResource
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # The URL for the login link.
+    sig { returns(String) }
+    attr_reader :url
+  end
+end

data/rbi/stripe/resources/mandate.rbi

@@ -0,0 +1,191 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # A Mandate is a record of the permission that your customer gives you to debit their payment method.
+  class Mandate < APIResource
+    class CustomerAcceptance < Stripe::StripeObject
+      class Offline < Stripe::StripeObject; end
+      class Online < Stripe::StripeObject
+        # The customer accepts the mandate from this IP address.
+        sig { returns(T.nilable(String)) }
+        attr_reader :ip_address
+        # The customer accepts the mandate using the user agent of the browser.
+        sig { returns(T.nilable(String)) }
+        attr_reader :user_agent
+      end
+      # The time that the customer accepts the mandate.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :accepted_at
+      # Attribute for field offline
+      sig { returns(Offline) }
+      attr_reader :offline
+      # Attribute for field online
+      sig { returns(Online) }
+      attr_reader :online
+      # The mandate includes the type of customer acceptance information, such as: `online` or `offline`.
+      sig { returns(String) }
+      attr_reader :type
+    end
+    class MultiUse < Stripe::StripeObject; end
+    class PaymentMethodDetails < Stripe::StripeObject
+      class AcssDebit < Stripe::StripeObject
+        # List of Stripe products where this mandate can be selected automatically.
+        sig { returns(T::Array[String]) }
+        attr_reader :default_for
+        # Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
+        sig { returns(T.nilable(String)) }
+        attr_reader :interval_description
+        # Payment schedule for the mandate.
+        sig { returns(String) }
+        attr_reader :payment_schedule
+        # Transaction type of the mandate.
+        sig { returns(String) }
+        attr_reader :transaction_type
+      end
+      class AmazonPay < Stripe::StripeObject; end
+      class AuBecsDebit < Stripe::StripeObject
+        # The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.
+        sig { returns(String) }
+        attr_reader :url
+      end
+      class BacsDebit < Stripe::StripeObject
+        # The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`.
+        sig { returns(String) }
+        attr_reader :network_status
+        # The unique reference identifying the mandate on the Bacs network.
+        sig { returns(String) }
+        attr_reader :reference
+        # When the mandate is revoked on the Bacs network this field displays the reason for the revocation.
+        sig { returns(T.nilable(String)) }
+        attr_reader :revocation_reason
+        # The URL that will contain the mandate that the customer has signed.
+        sig { returns(String) }
+        attr_reader :url
+      end
+      class Card < Stripe::StripeObject; end
+      class Cashapp < Stripe::StripeObject; end
+      class KakaoPay < Stripe::StripeObject; end
+      class Klarna < Stripe::StripeObject; end
+      class KrCard < Stripe::StripeObject; end
+      class Link < Stripe::StripeObject; end
+      class NaverPay < Stripe::StripeObject; end
+      class NzBankAccount < Stripe::StripeObject; end
+      class Paypal < Stripe::StripeObject
+        # The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
+        sig { returns(T.nilable(String)) }
+        attr_reader :billing_agreement_id
+        # PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
+        sig { returns(T.nilable(String)) }
+        attr_reader :payer_id
+      end
+      class RevolutPay < Stripe::StripeObject; end
+      class SepaDebit < Stripe::StripeObject
+        # The unique reference of the mandate.
+        sig { returns(String) }
+        attr_reader :reference
+        # The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.
+        sig { returns(String) }
+        attr_reader :url
+      end
+      class UsBankAccount < Stripe::StripeObject
+        # Mandate collection method
+        sig { returns(String) }
+        attr_reader :collection_method
+      end
+      # Attribute for field acss_debit
+      sig { returns(AcssDebit) }
+      attr_reader :acss_debit
+      # Attribute for field amazon_pay
+      sig { returns(AmazonPay) }
+      attr_reader :amazon_pay
+      # Attribute for field au_becs_debit
+      sig { returns(AuBecsDebit) }
+      attr_reader :au_becs_debit
+      # Attribute for field bacs_debit
+      sig { returns(BacsDebit) }
+      attr_reader :bacs_debit
+      # Attribute for field card
+      sig { returns(Card) }
+      attr_reader :card
+      # Attribute for field cashapp
+      sig { returns(Cashapp) }
+      attr_reader :cashapp
+      # Attribute for field kakao_pay
+      sig { returns(KakaoPay) }
+      attr_reader :kakao_pay
+      # Attribute for field klarna
+      sig { returns(Klarna) }
+      attr_reader :klarna
+      # Attribute for field kr_card
+      sig { returns(KrCard) }
+      attr_reader :kr_card
+      # Attribute for field link
+      sig { returns(Link) }
+      attr_reader :link
+      # Attribute for field naver_pay
+      sig { returns(NaverPay) }
+      attr_reader :naver_pay
+      # Attribute for field nz_bank_account
+      sig { returns(NzBankAccount) }
+      attr_reader :nz_bank_account
+      # Attribute for field paypal
+      sig { returns(Paypal) }
+      attr_reader :paypal
+      # Attribute for field revolut_pay
+      sig { returns(RevolutPay) }
+      attr_reader :revolut_pay
+      # Attribute for field sepa_debit
+      sig { returns(SepaDebit) }
+      attr_reader :sepa_debit
+      # 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.
+      sig { returns(String) }
+      attr_reader :type
+      # Attribute for field us_bank_account
+      sig { returns(UsBankAccount) }
+      attr_reader :us_bank_account
+    end
+    class SingleUse < Stripe::StripeObject
+      # The amount of the payment on a single use mandate.
+      sig { returns(Integer) }
+      attr_reader :amount
+      # The currency of the payment on a single use mandate.
+      sig { returns(String) }
+      attr_reader :currency
+    end
+    # Attribute for field customer_acceptance
+    sig { returns(CustomerAcceptance) }
+    attr_reader :customer_acceptance
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    sig { returns(T::Boolean) }
+    attr_reader :livemode
+    # Attribute for field multi_use
+    sig { returns(MultiUse) }
+    attr_reader :multi_use
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # The account (if any) that the mandate is intended for.
+    sig { returns(String) }
+    attr_reader :on_behalf_of
+    # ID of the payment method associated with this mandate.
+    sig { returns(T.any(String, Stripe::PaymentMethod)) }
+    attr_reader :payment_method
+    # Attribute for field payment_method_details
+    sig { returns(PaymentMethodDetails) }
+    attr_reader :payment_method_details
+    # Attribute for field single_use
+    sig { returns(SingleUse) }
+    attr_reader :single_use
+    # The mandate status indicates whether or not you can use it to initiate a payment.
+    sig { returns(String) }
+    attr_reader :status
+    # The type of the mandate.
+    sig { returns(String) }
+    attr_reader :type
+  end
+end