stripe 13.4.1 → 17.0.1

data/lib/stripe/resources/billing_portal/session.rb

@@ -16,7 +16,7 @@ module Stripe
     # Create sessions on-demand when customers intend to manage their subscriptions
     # and billing details.
     #
-    # Related guide: [Customer management](https://stripe.com/customer-management)
+    # Related guide: [Customer management](https://docs.stripe.com/customer-management)
     class Session < APIResource
       extend Stripe::APIOperations::Create
 
@@ -25,6 +25,197 @@ module Stripe
         "billing_portal.session"
       end
 
+      class Flow < Stripe::StripeObject
+        class AfterCompletion < Stripe::StripeObject
+          class HostedConfirmation < Stripe::StripeObject
+            # A custom message to display to the customer after the flow is completed.
+            attr_reader :custom_message
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Redirect < Stripe::StripeObject
+            # The URL the customer will be redirected to after the flow is completed.
+            attr_reader :return_url
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Configuration when `after_completion.type=hosted_confirmation`.
+          attr_reader :hosted_confirmation
+          # Configuration when `after_completion.type=redirect`.
+          attr_reader :redirect
+          # The specified type of behavior after the flow is completed.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { hosted_confirmation: HostedConfirmation, redirect: Redirect }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SubscriptionCancel < Stripe::StripeObject
+          class Retention < Stripe::StripeObject
+            class CouponOffer < Stripe::StripeObject
+              # The ID of the coupon to be offered.
+              attr_reader :coupon
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Configuration when `retention.type=coupon_offer`.
+            attr_reader :coupon_offer
+            # Type of retention strategy that will be used.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = { coupon_offer: CouponOffer }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Specify a retention strategy to be used in the cancellation flow.
+          attr_reader :retention
+          # The ID of the subscription to be canceled.
+          attr_reader :subscription
+
+          def self.inner_class_types
+            @inner_class_types = { retention: Retention }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SubscriptionUpdate < Stripe::StripeObject
+          # The ID of the subscription to be updated.
+          attr_reader :subscription
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SubscriptionUpdateConfirm < Stripe::StripeObject
+          class Discount < Stripe::StripeObject
+            # The ID of the coupon to apply to this subscription update.
+            attr_reader :coupon
+            # The ID of a promotion code to apply to this subscription update.
+            attr_reader :promotion_code
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Item < Stripe::StripeObject
+            # The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
+            attr_reader :id
+            # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
+            attr_reader :price
+            # [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
+            attr_reader :quantity
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The coupon or promotion code to apply to this subscription update.
+          attr_reader :discounts
+          # The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
+          attr_reader :items
+          # The ID of the subscription to be updated.
+          attr_reader :subscription
+
+          def self.inner_class_types
+            @inner_class_types = { discounts: Discount, items: Item }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field after_completion
+        attr_reader :after_completion
+        # Configuration when `flow.type=subscription_cancel`.
+        attr_reader :subscription_cancel
+        # Configuration when `flow.type=subscription_update`.
+        attr_reader :subscription_update
+        # Configuration when `flow.type=subscription_update_confirm`.
+        attr_reader :subscription_update_confirm
+        # Type of flow that the customer will go through.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {
+            after_completion: AfterCompletion,
+            subscription_cancel: SubscriptionCancel,
+            subscription_update: SubscriptionUpdate,
+            subscription_update_confirm: SubscriptionUpdateConfirm,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The configuration used by this session, describing the features available.
+      attr_reader :configuration
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The ID of the customer for this session.
+      attr_reader :customer
+      # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
+      attr_reader :flow
+      # 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 IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
+      attr_reader :locale
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
+      attr_reader :on_behalf_of
+      # The URL to redirect customers to when they click on the portal's link to return to your website.
+      attr_reader :return_url
+      # The short-lived URL of the session that gives customers access to the customer portal.
+      attr_reader :url
+
       # Creates a session of the customer portal.
       def self.create(params = {}, opts = {})
         request_stripe_object(
@@ -34,6 +225,14 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = { flow: Flow }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

data/lib/stripe/resources/capability.rb

@@ -13,6 +13,138 @@ module Stripe
       "capability"
     end
 
+    class FutureRequirements < Stripe::StripeObject
+      class Alternative < Stripe::StripeObject
+        # Fields that can be provided to satisfy all fields in `original_fields_due`.
+        attr_reader :alternative_fields_due
+        # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
+        attr_reader :original_fields_due
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Error < Stripe::StripeObject
+        # The code for the type of error.
+        attr_reader :code
+        # An informative message that indicates the error type and provides additional details about the error.
+        attr_reader :reason
+        # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+        attr_reader :requirement
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
+      attr_reader :alternatives
+      # Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.
+      attr_reader :current_deadline
+      # Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
+      attr_reader :currently_due
+      # This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.
+      attr_reader :disabled_reason
+      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      attr_reader :errors
+      # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
+      attr_reader :eventually_due
+      # Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
+      attr_reader :past_due
+      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
+      attr_reader :pending_verification
+
+      def self.inner_class_types
+        @inner_class_types = { alternatives: Alternative, errors: Error }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Requirements < Stripe::StripeObject
+      class Alternative < Stripe::StripeObject
+        # Fields that can be provided to satisfy all fields in `original_fields_due`.
+        attr_reader :alternative_fields_due
+        # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
+        attr_reader :original_fields_due
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Error < Stripe::StripeObject
+        # The code for the type of error.
+        attr_reader :code
+        # An informative message that indicates the error type and provides additional details about the error.
+        attr_reader :reason
+        # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+        attr_reader :requirement
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
+      attr_reader :alternatives
+      # The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested.
+      attr_reader :current_deadline
+      # Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.
+      attr_reader :currently_due
+      # Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).
+      attr_reader :disabled_reason
+      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      attr_reader :errors
+      # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
+      attr_reader :eventually_due
+      # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.
+      attr_reader :past_due
+      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
+      attr_reader :pending_verification
+
+      def self.inner_class_types
+        @inner_class_types = { alternatives: Alternative, errors: Error }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # The account for which the capability enables functionality.
+    attr_reader :account
+    # Attribute for field future_requirements
+    attr_reader :future_requirements
+    # The identifier for the capability.
+    attr_reader :id
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Whether the capability has been requested.
+    attr_reader :requested
+    # Time at which the capability was requested. Measured in seconds since the Unix epoch.
+    attr_reader :requested_at
+    # Attribute for field requirements
+    attr_reader :requirements
+    # The status of the capability.
+    attr_reader :status
+
     def resource_url
       if !respond_to?(:account) || account.nil?
         raise NotImplementedError,
@@ -35,5 +167,13 @@ module Stripe
             "capability using `Account.update_capability('account_id', " \
             "'capability_id', update_params)`"
     end
+
+    def self.inner_class_types
+      @inner_class_types = { future_requirements: FutureRequirements, requirements: Requirements }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/card.rb

@@ -17,6 +17,91 @@ module Stripe
       "card"
     end
 
+    class Networks < Stripe::StripeObject
+      # The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.
+      attr_reader :preferred
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Attribute for field account
+    attr_reader :account
+    # City/District/Suburb/Town/Village.
+    attr_reader :address_city
+    # Billing address country, if provided when creating card.
+    attr_reader :address_country
+    # Address line 1 (Street address/PO Box/Company name).
+    attr_reader :address_line1
+    # If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+    attr_reader :address_line1_check
+    # Address line 2 (Apartment/Suite/Unit/Building).
+    attr_reader :address_line2
+    # State/County/Province/Region.
+    attr_reader :address_state
+    # ZIP or postal code.
+    attr_reader :address_zip
+    # If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+    attr_reader :address_zip_check
+    # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
+    attr_reader :allow_redisplay
+    # A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.
+    attr_reader :available_payout_methods
+    # Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
+    attr_reader :brand
+    # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
+    attr_reader :country
+    # Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.
+    attr_reader :currency
+    # The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
+    attr_reader :customer
+    # If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).
+    attr_reader :cvc_check
+    # Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
+    attr_reader :default_for_currency
+    # A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
+    attr_reader :description
+    # (For tokenized numbers only.) The last four digits of the device account number.
+    attr_reader :dynamic_last4
+    # Two-digit number representing the card's expiration month.
+    attr_reader :exp_month
+    # Four-digit number representing the card's expiration year.
+    attr_reader :exp_year
+    # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
+    #
+    # *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
+    attr_reader :fingerprint
+    # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
+    attr_reader :funding
+    # Unique identifier for the object.
+    attr_reader :id
+    # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
+    attr_reader :iin
+    # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
+    attr_reader :issuer
+    # The last four digits of the card.
+    attr_reader :last4
+    # 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.
+    attr_reader :metadata
+    # Cardholder name.
+    attr_reader :name
+    # Attribute for field networks
+    attr_reader :networks
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Status of a card based on the card issuer.
+    attr_reader :regulated_status
+    # For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.
+    attr_reader :status
+    # If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.
+    attr_reader :tokenization_method
+    # Always true for a deleted object
+    attr_reader :deleted
+
     def resource_url
       if respond_to?(:customer) && !customer.nil? && !customer.empty?
         "#{Customer.resource_url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
@@ -65,5 +150,13 @@ module Stripe
             "'customer_id')` or " \
             "`Account.list_external_accounts('account_id')`"
     end
+
+    def self.inner_class_types
+      @inner_class_types = { networks: Networks }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/cash_balance.rb

@@ -9,6 +9,31 @@ module Stripe
       "cash_balance"
     end
 
+    class Settings < Stripe::StripeObject
+      # The configuration for how funds that land in the customer cash balance are reconciled.
+      attr_reader :reconciliation_mode
+      # A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance
+      attr_reader :using_merchant_default
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+    attr_reader :available
+    # The ID of the customer whose cash balance this object represents.
+    attr_reader :customer
+    # 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
+    # Attribute for field settings
+    attr_reader :settings
+
     def resource_url
       if !respond_to?(:customer) || customer.nil?
         raise NotImplementedError,
@@ -22,5 +47,13 @@ module Stripe
             "Customer Cash Balance cannot be retrieved without a customer ID. " \
             "Retrieve a Customer Cash Balance using `Customer.retrieve_cash_balance('cus_123')`"
     end
+
+    def self.inner_class_types
+      @inner_class_types = { settings: Settings }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end