stripe 5.55.0 → 18.2.0.pre.beta.1

data/lib/stripe/resources/customer_cash_balance_transaction.rb

@@ -0,0 +1,234 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Customers with certain payments enabled have a cash balance, representing funds that were paid
+  # by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions
+  # represent when funds are moved into or out of this balance. This includes funding by the customer, allocation
+  # to payments, and refunds to the customer.
+  class CustomerCashBalanceTransaction < APIResource
+    OBJECT_NAME = "customer_cash_balance_transaction"
+    def self.object_name
+      "customer_cash_balance_transaction"
+    end
+
+    class AdjustedForOverdraft < ::Stripe::StripeObject
+      # The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.
+      attr_reader :balance_transaction
+      # The [Cash Balance Transaction](https://docs.stripe.com/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.
+      attr_reader :linked_transaction
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class AppliedToPayment < ::Stripe::StripeObject
+      # The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were applied to.
+      attr_reader :payment_intent
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Funded < ::Stripe::StripeObject
+      class BankTransfer < ::Stripe::StripeObject
+        class EuBankTransfer < ::Stripe::StripeObject
+          # The BIC of the bank of the sender of the funding.
+          attr_reader :bic
+          # The last 4 digits of the IBAN of the sender of the funding.
+          attr_reader :iban_last4
+          # The full name of the sender, as supplied by the sending bank.
+          attr_reader :sender_name
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class GbBankTransfer < ::Stripe::StripeObject
+          # The last 4 digits of the account number of the sender of the funding.
+          attr_reader :account_number_last4
+          # The full name of the sender, as supplied by the sending bank.
+          attr_reader :sender_name
+          # The sort code of the bank of the sender of the funding
+          attr_reader :sort_code
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class JpBankTransfer < ::Stripe::StripeObject
+          # The name of the bank of the sender of the funding.
+          attr_reader :sender_bank
+          # The name of the bank branch of the sender of the funding.
+          attr_reader :sender_branch
+          # The full name of the sender, as supplied by the sending bank.
+          attr_reader :sender_name
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class UsBankTransfer < ::Stripe::StripeObject
+          # The banking network used for this funding.
+          attr_reader :network
+          # The full name of the sender, as supplied by the sending bank.
+          attr_reader :sender_name
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field eu_bank_transfer
+        attr_reader :eu_bank_transfer
+        # Attribute for field gb_bank_transfer
+        attr_reader :gb_bank_transfer
+        # Attribute for field jp_bank_transfer
+        attr_reader :jp_bank_transfer
+        # The user-supplied reference field on the bank transfer.
+        attr_reader :reference
+        # The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
+        attr_reader :type
+        # Attribute for field us_bank_transfer
+        attr_reader :us_bank_transfer
+
+        def self.inner_class_types
+          @inner_class_types = {
+            eu_bank_transfer: EuBankTransfer,
+            gb_bank_transfer: GbBankTransfer,
+            jp_bank_transfer: JpBankTransfer,
+            us_bank_transfer: UsBankTransfer,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field bank_transfer
+      attr_reader :bank_transfer
+
+      def self.inner_class_types
+        @inner_class_types = { bank_transfer: BankTransfer }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class RefundedFromPayment < ::Stripe::StripeObject
+      # The [Refund](https://docs.stripe.com/api/refunds/object) that moved these funds into the customer's cash balance.
+      attr_reader :refund
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class TransferredToBalance < ::Stripe::StripeObject
+      # The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.
+      attr_reader :balance_transaction
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class UnappliedFromPayment < ::Stripe::StripeObject
+      # The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were unapplied from.
+      attr_reader :payment_intent
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Attribute for field adjusted_for_overdraft
+    attr_reader :adjusted_for_overdraft
+    # Attribute for field applied_to_payment
+    attr_reader :applied_to_payment
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # 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).
+    attr_reader :currency
+    # The customer whose available cash balance changed as a result of this transaction.
+    attr_reader :customer
+    # The ID of an Account representing a customer whose available cash balance changed as a result of this transaction.
+    attr_reader :customer_account
+    # The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+    attr_reader :ending_balance
+    # Attribute for field funded
+    attr_reader :funded
+    # Unique identifier for the object.
+    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.
+    attr_reader :livemode
+    # The amount by which the cash balance changed, represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
+    attr_reader :net_amount
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Attribute for field refunded_from_payment
+    attr_reader :refunded_from_payment
+    # Attribute for field transferred_to_balance
+    attr_reader :transferred_to_balance
+    # The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://docs.stripe.com/payments/customer-balance#types) to learn more about these types.
+    attr_reader :type
+    # Attribute for field unapplied_from_payment
+    attr_reader :unapplied_from_payment
+
+    def self.inner_class_types
+      @inner_class_types = {
+        adjusted_for_overdraft: AdjustedForOverdraft,
+        applied_to_payment: AppliedToPayment,
+        funded: Funded,
+        refunded_from_payment: RefundedFromPayment,
+        transferred_to_balance: TransferredToBalance,
+        unapplied_from_payment: UnappliedFromPayment,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/customer_session.rb

@@ -0,0 +1,264 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access
+  # control over a Customer.
+  #
+  # Related guides: [Customer Session with the Payment Element](https://docs.stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),
+  # [Customer Session with the Pricing Table](https://docs.stripe.com/payments/checkout/pricing-table#customer-session),
+  # [Customer Session with the Buy Button](https://docs.stripe.com/payment-links/buy-button#pass-an-existing-customer).
+  class CustomerSession < APIResource
+    extend Stripe::APIOperations::Create
+
+    OBJECT_NAME = "customer_session"
+    def self.object_name
+      "customer_session"
+    end
+
+    class Components < ::Stripe::StripeObject
+      class BuyButton < ::Stripe::StripeObject
+        # Whether the buy button is enabled.
+        attr_reader :enabled
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class CustomerSheet < ::Stripe::StripeObject
+        class Features < ::Stripe::StripeObject
+          # A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the customer sheet displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.
+          #
+          # If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"].
+          attr_reader :payment_method_allow_redisplay_filters
+          # Controls whether the customer sheet displays the option to remove a saved payment method."
+          #
+          # Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).
+          attr_reader :payment_method_remove
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Whether the customer sheet is enabled.
+        attr_reader :enabled
+        # This hash defines whether the customer sheet supports certain features.
+        attr_reader :features
+
+        def self.inner_class_types
+          @inner_class_types = { features: Features }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class MobilePaymentElement < ::Stripe::StripeObject
+        class Features < ::Stripe::StripeObject
+          # A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the mobile payment element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.
+          #
+          # If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"].
+          attr_reader :payment_method_allow_redisplay_filters
+          # Controls whether or not the mobile payment element shows saved payment methods.
+          attr_reader :payment_method_redisplay
+          # Controls whether the mobile payment element displays the option to remove a saved payment method."
+          #
+          # Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).
+          attr_reader :payment_method_remove
+          # Controls whether the mobile payment element displays a checkbox offering to save a new payment method.
+          #
+          # If a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.
+          attr_reader :payment_method_save
+          # Allows overriding the value of allow_override when saving a new payment method when payment_method_save is set to disabled. Use values: "always", "limited", or "unspecified".
+          #
+          # If not specified, defaults to `nil` (no override value).
+          attr_reader :payment_method_save_allow_redisplay_override
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Whether the mobile payment element is enabled.
+        attr_reader :enabled
+        # This hash defines whether the mobile payment element supports certain features.
+        attr_reader :features
+
+        def self.inner_class_types
+          @inner_class_types = { features: Features }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class PaymentElement < ::Stripe::StripeObject
+        class Features < ::Stripe::StripeObject
+          # A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.
+          #
+          # If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"].
+          attr_reader :payment_method_allow_redisplay_filters
+          # Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.
+          attr_reader :payment_method_redisplay
+          # Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`.
+          attr_reader :payment_method_redisplay_limit
+          # Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.
+          #
+          # Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).
+          attr_reader :payment_method_remove
+          # Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.
+          #
+          # If a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.
+          attr_reader :payment_method_save
+          # When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.
+          #
+          # When using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.
+          attr_reader :payment_method_save_usage
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Whether the Payment Element is enabled.
+        attr_reader :enabled
+        # This hash defines whether the Payment Element supports certain features.
+        attr_reader :features
+
+        def self.inner_class_types
+          @inner_class_types = { features: Features }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class PricingTable < ::Stripe::StripeObject
+        # Whether the pricing table is enabled.
+        attr_reader :enabled
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class TaxIdElement < ::Stripe::StripeObject
+        class Features < ::Stripe::StripeObject
+          # Controls whether the Tax ID Element displays saved tax IDs for the customer. This parameter defaults to `disabled`.
+          #
+          # When enabled, the Tax ID Element will show existing tax IDs associated with the customer, allowing them to select from previously saved tax identification numbers.
+          attr_reader :tax_id_redisplay
+          # Controls whether the Tax ID Element allows merchants to save new tax IDs for their customer. This parameter defaults to `disabled`.
+          #
+          # When enabled, customers can enter and save new tax identification numbers during the payment flow, which will be stored securely and associated with their customer object for future use.
+          attr_reader :tax_id_save
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Whether the Tax ID Element is enabled.
+        attr_reader :enabled
+        # This hash defines whether the Tax ID Element supports certain features.
+        attr_reader :features
+
+        def self.inner_class_types
+          @inner_class_types = { features: Features }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # This hash contains whether the buy button is enabled.
+      attr_reader :buy_button
+      # This hash contains whether the customer sheet is enabled and the features it supports.
+      attr_reader :customer_sheet
+      # This hash contains whether the mobile payment element is enabled and the features it supports.
+      attr_reader :mobile_payment_element
+      # This hash contains whether the Payment Element is enabled and the features it supports.
+      attr_reader :payment_element
+      # This hash contains whether the pricing table is enabled.
+      attr_reader :pricing_table
+      # This hash contains whether the Tax ID Element is enabled and the features it supports.
+      attr_reader :tax_id_element
+
+      def self.inner_class_types
+        @inner_class_types = {
+          buy_button: BuyButton,
+          customer_sheet: CustomerSheet,
+          mobile_payment_element: MobilePaymentElement,
+          payment_element: PaymentElement,
+          pricing_table: PricingTable,
+          tax_id_element: TaxIdElement,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.
+    #
+    # The client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.
+    attr_reader :client_secret
+    # Configuration for the components supported by this Customer Session.
+    attr_reader :components
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # The Customer the Customer Session was created for.
+    attr_reader :customer
+    # The Account that the Customer Session was created for.
+    attr_reader :customer_account
+    # The timestamp at which this Customer Session will expire.
+    attr_reader :expires_at
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    attr_reader :livemode
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+
+    # Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: "/v1/customer_sessions",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.inner_class_types
+      @inner_class_types = { components: Components }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/discount.rb

@@ -2,7 +2,65 @@
 # frozen_string_literal: true
 
 module Stripe
+  # 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)
   class Discount < StripeObject
     OBJECT_NAME = "discount"
+    def self.object_name
+      "discount"
+    end
+
+    class Source < ::Stripe::StripeObject
+      # The coupon that was redeemed to create this discount.
+      attr_reader :coupon
+      # The source type of the discount.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.
+    attr_reader :checkout_session
+    # The ID of the customer associated with this discount.
+    attr_reader :customer
+    # The ID of the account representing the customer associated with this discount.
+    attr_reader :customer_account
+    # If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.
+    attr_reader :end
+    # The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.
+    attr_reader :id
+    # The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
+    attr_reader :invoice
+    # The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
+    attr_reader :invoice_item
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The promotion code applied to create this discount.
+    attr_reader :promotion_code
+    # Attribute for field source
+    attr_reader :source
+    # Date that the coupon was applied.
+    attr_reader :start
+    # The subscription that this coupon is applied to, if it is applied to a particular subscription.
+    attr_reader :subscription
+    # The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
+    attr_reader :subscription_item
+    # Always true for a deleted object
+    attr_reader :deleted
+
+    def self.inner_class_types
+      @inner_class_types = { source: Source }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end