RubyGems - stripe - Versions diffs - 18.1.0.pre.alpha.4 → 18.1.0 - Mend

stripe 18.1.0.pre.alpha.4 → 18.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (929) hide show

data/lib/stripe/resources/checkout/session.rb CHANGED Viewed

@@ -4,19 +4,19 @@
 module Stripe
   module Checkout
     # A Checkout Session represents your customer's session as they pay for
-    # one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)
-    # or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a
+    # one-time purchases or subscriptions through [Checkout](https://docs.stripe.com/payments/checkout)
+    # or [Payment Links](https://docs.stripe.com/payments/payment-links). We recommend creating a
     # new Session each time your customer attempts to pay.
     #
     # Once payment is successful, the Checkout Session will contain a reference
-    # to the [Customer](https://stripe.com/docs/api/customers), and either the successful
-    # [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active
-    # [Subscription](https://stripe.com/docs/api/subscriptions).
+    # to the [Customer](https://docs.stripe.com/api/customers), and either the successful
+    # [PaymentIntent](https://docs.stripe.com/api/payment_intents) or an active
+    # [Subscription](https://docs.stripe.com/api/subscriptions).
     #
     # You can create a Checkout Session on your server and redirect to its URL
     # to begin Checkout.
     #
-    # Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)
+    # Related guide: [Checkout quickstart](https://docs.stripe.com/checkout/quickstart)
     class Session < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
@@ -177,7 +177,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
             def self.inner_class_types
@@ -201,36 +201,15 @@ module Stripe
             @field_remappings = {}
           end
         end
-        class TaxId < ::Stripe::StripeObject
-          # The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
-          attr_reader :type
-          # The value of the tax ID.
-          attr_reader :value
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
         # Customer’s business name for this Checkout Session
         attr_reader :business_name
-        # Customer’s email for this Checkout Session
-        attr_reader :email
         # Customer’s individual name for this Checkout Session
         attr_reader :individual_name
-        # Customer’s phone number for this Checkout Session
-        attr_reader :phone
         # Shipping information for this Checkout Session.
         attr_reader :shipping_details
-        # Customer’s tax ids for this Checkout Session.
-        attr_reader :tax_ids
         def self.inner_class_types
-          @inner_class_types = { shipping_details: ShippingDetails, tax_ids: TaxId }
+          @inner_class_types = { shipping_details: ShippingDetails }
         end
         def self.field_remappings
@@ -501,7 +480,7 @@ module Stripe
           attr_reader :line2
           # ZIP or postal code.
           attr_reader :postal_code
-          # State, county, province, or region.
+          # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
           attr_reader :state
           def self.inner_class_types
@@ -625,7 +604,7 @@ module Stripe
           attr_reader :footer
           # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
           attr_reader :issuer
-          # 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.
+          # 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.
           attr_reader :metadata
           # Options for invoice PDF rendering.
           attr_reader :rendering_options
@@ -1031,8 +1010,6 @@ module Stripe
           # Attribute for field installments
           attr_reader :installments
           # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
-          attr_reader :request_decremental_authorization
-          # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
           attr_reader :request_extended_authorization
           # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
           attr_reader :request_incremental_authorization
@@ -1040,7 +1017,7 @@ module Stripe
           attr_reader :request_multicapture
           # Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.
           attr_reader :request_overcapture
-          # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
+          # We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
           attr_reader :request_three_d_secure
           # Attribute for field restrictions
           attr_reader :restrictions
@@ -1488,8 +1465,6 @@ module Stripe
           #
           # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
           attr_reader :setup_future_usage
-          # The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
-          attr_reader :subsellers
           def self.inner_class_types
             @inner_class_types = {}
@@ -1546,38 +1521,10 @@ module Stripe
         end
         class Pix < ::Stripe::StripeObject
-          class MandateOptions < ::Stripe::StripeObject
-            # Amount to be charged for future payments.
-            attr_reader :amount
-            # Determines if the amount includes the IOF tax.
-            attr_reader :amount_includes_iof
-            # Type of amount.
-            attr_reader :amount_type
-            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
-            attr_reader :currency
-            # Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
-            attr_reader :end_date
-            # Schedule at which the future payments will be charged.
-            attr_reader :payment_schedule
-            # Subscription name displayed to buyers in their bank app.
-            attr_reader :reference
-            # Start date of the mandate, in `YYYY-MM-DD`.
-            attr_reader :start_date
-            def self.inner_class_types
-              @inner_class_types = {}
-            end
-            def self.field_remappings
-              @field_remappings = {}
-            end
-          end
           # Determines if the amount includes the IOF tax.
           attr_reader :amount_includes_iof
           # The number of seconds after which Pix payment will expire.
           attr_reader :expires_after_seconds
-          # Attribute for field mandate_options
-          attr_reader :mandate_options
           # Indicates that you intend to make future payments with this PaymentIntent's payment method.
           #
           # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
@@ -1588,7 +1535,7 @@ module Stripe
           attr_reader :setup_future_usage
           def self.inner_class_types
-            @inner_class_types = { mandate_options: MandateOptions }
+            @inner_class_types = {}
           end
           def self.field_remappings
@@ -1734,21 +1681,6 @@ module Stripe
             class Filters < ::Stripe::StripeObject
               # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
               attr_reader :account_subcategories
-              # The institution to use to filter for possible accounts to link.
-              attr_reader :institution
-              def self.inner_class_types
-                @inner_class_types = {}
-              end
-              def self.field_remappings
-                @field_remappings = {}
-              end
-            end
-            class ManualEntry < ::Stripe::StripeObject
-              # Settings for configuring manual entry of account details.
-              attr_reader :mode
               def self.inner_class_types
                 @inner_class_types = {}
@@ -1760,8 +1692,6 @@ module Stripe
             end
             # Attribute for field filters
             attr_reader :filters
-            # Attribute for field manual_entry
-            attr_reader :manual_entry
             # The list of permissions to request. The `payment_method` permission must be included.
             attr_reader :permissions
             # Data features requested to be retrieved upon account creation.
@@ -1770,7 +1700,7 @@ module Stripe
             attr_reader :return_url
             def self.inner_class_types
-              @inner_class_types = { filters: Filters, manual_entry: ManualEntry }
+              @inner_class_types = { filters: Filters }
             end
             def self.field_remappings
@@ -1938,36 +1868,6 @@ module Stripe
       end
       class Permissions < ::Stripe::StripeObject
-        class Update < ::Stripe::StripeObject
-          # Determines which entity is allowed to update the line items.
-          #
-          # Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
-          #
-          # When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
-          attr_reader :line_items
-          # Determines which entity is allowed to update the shipping details.
-          #
-          # Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
-          #
-          # When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
-          attr_reader :shipping_details
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-        # Permissions for updating the Checkout Session.
-        attr_reader :update
-        # Determines which entity is allowed to update the line items.
-        #
-        # Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
-        #
-        # When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
-        attr_reader :update_line_items
         # Determines which entity is allowed to update the shipping details.
         #
         # Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
@@ -1976,7 +1876,7 @@ module Stripe
         attr_reader :update_shipping_details
         def self.inner_class_types
-          @inner_class_types = { update: Update }
+          @inner_class_types = {}
         end
         def self.field_remappings
@@ -2119,10 +2019,10 @@ module Stripe
           class Discount < ::Stripe::StripeObject
             # The amount discounted.
             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).
+            # 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://stripe.com/docs/billing/subscriptions/discounts)
+            # Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
             attr_reader :discount
             def self.inner_class_types
@@ -2209,95 +2109,6 @@ module Stripe
           @field_remappings = {}
         end
       end
-      class CheckoutItem < ::Stripe::StripeObject
-        class PricingPlanSubscriptionItem < ::Stripe::StripeObject
-          class ComponentConfigurations < ::Stripe::StripeObject
-            class LicenseFeeComponent < ::Stripe::StripeObject
-              # Attribute for field quantity
-              attr_reader :quantity
-              def self.inner_class_types
-                @inner_class_types = {}
-              end
-              def self.field_remappings
-                @field_remappings = {}
-              end
-            end
-            # Attribute for field type
-            attr_reader :type
-            # Attribute for field license_fee_component
-            attr_reader :license_fee_component
-            def self.inner_class_types
-              @inner_class_types = { license_fee_component: LicenseFeeComponent }
-            end
-            def self.field_remappings
-              @field_remappings = {}
-            end
-          end
-          # Attribute for field pricing_plan
-          attr_reader :pricing_plan
-          # Attribute for field pricing_plan_version
-          attr_reader :pricing_plan_version
-          # Attribute for field metadata
-          attr_reader :metadata
-          # Attribute for field component_configurations
-          attr_reader :component_configurations
-          # Attribute for field pricing_plan_subscription
-          attr_reader :pricing_plan_subscription
-          # Attribute for field billing_cadence
-          attr_reader :billing_cadence
-          def self.inner_class_types
-            @inner_class_types = { component_configurations: ComponentConfigurations }
-          end
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-        class RateCardSubscriptionItem < ::Stripe::StripeObject
-          # Attribute for field rate_card
-          attr_reader :rate_card
-          # Attribute for field metadata
-          attr_reader :metadata
-          # Attribute for field rate_card_version
-          attr_reader :rate_card_version
-          # Attribute for field billing_cadence
-          attr_reader :billing_cadence
-          # Attribute for field rate_card_subscription
-          attr_reader :rate_card_subscription
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-        # Attribute for field type
-        attr_reader :type
-        # Attribute for field rate_card_subscription_item
-        attr_reader :rate_card_subscription_item
-        # Attribute for field pricing_plan_subscription_item
-        attr_reader :pricing_plan_subscription_item
-        def self.inner_class_types
-          @inner_class_types = {
-            rate_card_subscription_item: RateCardSubscriptionItem,
-            pricing_plan_subscription_item: PricingPlanSubscriptionItem,
-          }
-        end
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
       # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
       attr_reader :adaptive_pricing
       # When set, provides configuration for actions to take if this Checkout Session expires.
@@ -2321,7 +2132,7 @@ module Stripe
       # Session with your internal systems.
       attr_reader :client_reference_id
       # The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. For `ui_mode: embedded`, the client secret is to be used when initializing Stripe.js embedded checkout.
-      #  For `ui_mode: custom`, use the client secret with [initCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.
+      #  For `ui_mode: custom`, use the client secret with [initCheckout](https://docs.stripe.com/js/custom_checkout/init) on your front end.
       attr_reader :client_secret
       # Information about the customer collected within the Checkout Session.
       attr_reader :collected_information
@@ -2375,7 +2186,7 @@ module Stripe
       attr_reader :livemode
       # The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
       attr_reader :locale
-      # 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.
+      # 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.
       attr_reader :metadata
       # The mode of the Checkout Session.
       attr_reader :mode
@@ -2387,7 +2198,7 @@ module Stripe
       attr_reader :optional_items
       # Where the user is coming from. This informs the optimizations that are applied to the session.
       attr_reader :origin_context
-      # The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
+      # The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead.
       attr_reader :payment_intent
       # The ID of the Payment Link that created this Session.
       attr_reader :payment_link
@@ -2413,13 +2224,13 @@ module Stripe
       attr_reader :presentment_details
       # The ID of the original expired Checkout Session that triggered the recovery flow.
       attr_reader :recovered_from
-      # This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
+      # This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
       attr_reader :redirect_on_completion
       # Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
       attr_reader :return_url
       # Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
       attr_reader :saved_payment_method_options
-      # The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
+      # The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead.
       attr_reader :setup_intent
       # When set, provides configuration for Checkout to collect a shipping address from a customer.
       attr_reader :shipping_address_collection
@@ -2433,7 +2244,7 @@ module Stripe
       # relevant text on the page, such as the submit button. `submit_type` can only be
       # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
       attr_reader :submit_type
-      # The ID of the [Subscription](https://stripe.com/docs/api/subscriptions) for Checkout Sessions in `subscription` mode.
+      # The ID of the [Subscription](https://docs.stripe.com/api/subscriptions) for Checkout Sessions in `subscription` mode.
       attr_reader :subscription
       # The URL the customer will be directed to after the payment or
       # subscription creation is successful.
@@ -2444,13 +2255,11 @@ module Stripe
       attr_reader :total_details
       # The UI mode of the Session. Defaults to `hosted`.
       attr_reader :ui_mode
-      # The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`
+      # The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://docs.stripe.com/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`
       # This value is only present when the session is active.
       attr_reader :url
       # Wallet-specific configuration for this Checkout Session.
       attr_reader :wallet_options
-      # Attribute for field checkout_items
-      attr_reader :checkout_items
       # Creates a Checkout Session object.
       def self.create(params = {}, opts = {})
@@ -2557,7 +2366,6 @@ module Stripe
           tax_id_collection: TaxIdCollection,
           total_details: TotalDetails,
           wallet_options: WalletOptions,
-          checkout_items: CheckoutItem,
         }
       end

data/lib/stripe/resources/climate/order.rb CHANGED Viewed

@@ -100,7 +100,7 @@ module Stripe
       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
-      # 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.
+      # 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.
       attr_reader :metadata
       # Quantity of carbon removal that is included in this order.
       attr_reader :metric_tons