RubyGems - stripe - Versions diffs - 13.4.0.pre.beta.1 → 13.4.0.pre.beta.2 - Mend

stripe 13.4.0.pre.beta.1 → 13.4.0.pre.beta.2

Files changed (688) hide show

data/rbi/stripe/resources/line_item.rbi CHANGED Viewed

@@ -9,11 +9,9 @@ module Stripe
       # Attribute for field enabled
       sig { returns(T::Boolean) }
       attr_reader :enabled
       # Attribute for field maximum
       sig { returns(T.nilable(Integer)) }
       attr_reader :maximum
       # Attribute for field minimum
       sig { returns(T.nilable(Integer)) }
       attr_reader :minimum
@@ -22,7 +20,6 @@ module Stripe
       # 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.
       #
@@ -34,11 +31,9 @@ module Stripe
       # Attribute for field description
       sig { returns(T.nilable(String)) }
       attr_reader :description
       # Attribute for field images
       sig { returns(T::Array[String]) }
       attr_reader :images
       # Attribute for field name
       sig { returns(String) }
       attr_reader :name
@@ -47,17 +42,14 @@ module Stripe
       # Amount of tax applied for this rate.
       sig { returns(Integer) }
       attr_reader :amount
       # Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
       #
       # Related guide: [Tax rates](https://stripe.com/docs/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
@@ -65,65 +57,50 @@ module Stripe
     # Attribute for field adjustable_quantity
     sig { returns(T.nilable(AdjustableQuantity)) }
     attr_reader :adjustable_quantity
     # 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
     # Attribute for field display
     sig { returns(Display) }
     attr_reader :display
     # Unique identifier for the object.
     sig { returns(String) }
     attr_reader :id
     # 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.
     sig { returns(T.nilable(T::Hash[String, String])) }
     attr_reader :metadata
     # 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 ID of the product for this line item.
     #
     # This will always be the same as `price.product`.
     sig { returns(T.any(String, Stripe::Product)) }
     attr_reader :product
     # 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

data/rbi/stripe/resources/login_link.rbi CHANGED Viewed

@@ -8,11 +8,9 @@ module Stripe
     # 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

data/rbi/stripe/resources/mandate.rbi CHANGED Viewed

@@ -11,7 +11,6 @@ module Stripe
         # 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
@@ -19,15 +18,12 @@ module Stripe
       # 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
@@ -38,15 +34,12 @@ module Stripe
         # 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
@@ -61,15 +54,12 @@ module Stripe
         # 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
@@ -83,15 +73,12 @@ module Stripe
         # 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
         # Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
         sig { returns(T.nilable(String)) }
         attr_reader :fingerprint
         # PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
         sig { returns(T.nilable(String)) }
         attr_reader :payer_id
         # Owner's verified email. Values are verified or provided by PayPal directly
         # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
         sig { returns(T.nilable(String)) }
@@ -101,27 +88,21 @@ module Stripe
         # Amount that will be collected. It is required when `amount_type` is `fixed`.
         sig { returns(T.nilable(Integer)) }
         attr_reader :amount
         # 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.
         sig { returns(String) }
         attr_reader :amount_type
         # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
         sig { returns(T.nilable(String)) }
         attr_reader :end_date
         # The periodicity at which payments will be collected.
         sig { returns(String) }
         attr_reader :payment_schedule
         # 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.
         sig { returns(T.nilable(Integer)) }
         attr_reader :payments_per_period
         # The purpose for which payments are made. Defaults to retail.
         sig { returns(T.nilable(String)) }
         attr_reader :purpose
         # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
         sig { returns(T.nilable(String)) }
         attr_reader :start_date
@@ -131,7 +112,6 @@ module Stripe
         # 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
@@ -144,59 +124,45 @@ module Stripe
       # 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 kr_card
       sig { returns(KrCard) }
       attr_reader :kr_card
       # Attribute for field link
       sig { returns(Link) }
       attr_reader :link
       # Attribute for field paypal
       sig { returns(Paypal) }
       attr_reader :paypal
       # Attribute for field payto
       sig { returns(Payto) }
       attr_reader :payto
       # 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
@@ -205,7 +171,6 @@ module Stripe
       # 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
@@ -213,52 +178,40 @@ module Stripe
     # 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
     class RetrieveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
       sig { returns(T::Array[String]) }
       attr_accessor :expand
       sig { params(expand: T::Array[String]).void }
       def initialize(expand: nil); end
     end

data/rbi/stripe/resources/margin.rbi CHANGED Viewed

@@ -9,60 +9,46 @@ module Stripe
     # Whether the margin can be applied to invoices, invoice items, or invoice line items. Defaults to `true`.
     sig { returns(T::Boolean) }
     attr_reader :active
     # Time at which the object was created. Measured in seconds since the Unix epoch.
     sig { returns(Integer) }
     attr_reader :created
     # 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
     # 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.
     sig { returns(T.nilable(T::Hash[String, String])) }
     attr_reader :metadata
     # Name of the margin that's displayed on, for example, invoices.
     sig { returns(T.nilable(String)) }
     attr_reader :name
     # String representing the object's type. Objects of the same type share the same value.
     sig { returns(String) }
     attr_reader :object
     # Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
     sig { returns(Float) }
     attr_reader :percent_off
     # Time at which the object was last updated. Measured in seconds since the Unix epoch.
     sig { returns(Integer) }
     attr_reader :updated
     class ListParams < Stripe::RequestParams
       # Only return margins that are active or inactive. For example, pass `true` to only list active margins.
       sig { returns(T::Boolean) }
       attr_accessor :active
       # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
       sig { returns(String) }
       attr_accessor :ending_before
       # Specifies which fields in the response should be expanded.
       sig { returns(T::Array[String]) }
       attr_accessor :expand
       # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
       sig { returns(Integer) }
       attr_accessor :limit
       # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
       sig { returns(String) }
       attr_accessor :starting_after
       sig {
         params(active: T::Boolean, ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
        }
@@ -78,23 +64,18 @@ module Stripe
       # Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to `true`.
       sig { returns(T::Boolean) }
       attr_accessor :active
       # Specifies which fields in the response should be expanded.
       sig { returns(T::Array[String]) }
       attr_accessor :expand
       # 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`.
       sig { returns(T::Hash[String, String]) }
       attr_accessor :metadata
       # Name of the margin, which is displayed to customers, such as on invoices.
       sig { returns(String) }
       attr_accessor :name
       # Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
       sig { returns(Float) }
       attr_accessor :percent_off
       sig {
         params(active: T::Boolean, expand: T::Array[String], metadata: T::Hash[String, String], name: String, percent_off: Float).void
        }
@@ -104,7 +85,6 @@ module Stripe
       # Specifies which fields in the response should be expanded.
       sig { returns(T::Array[String]) }
       attr_accessor :expand
       sig { params(expand: T::Array[String]).void }
       def initialize(expand: nil); end
     end
@@ -112,19 +92,15 @@ module Stripe
       # Whether the margin can be applied to invoices, invoice items, or invoice line items or not.
       sig { returns(T::Boolean) }
       attr_accessor :active
       # Specifies which fields in the response should be expanded.
       sig { returns(T::Array[String]) }
       attr_accessor :expand
       # 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`.
       sig { returns(T::Hash[String, String]) }
       attr_accessor :metadata
       # Name of the margin, which is displayed to customers, such as on invoices.
       sig { returns(String) }
       attr_accessor :name
       sig {
         params(active: T::Boolean, expand: T::Array[String], metadata: T::Hash[String, String], name: String).void
        }