stripe 17.1.0.pre.beta.2 → 17.2.0.pre.beta.1

data/lib/stripe/params/payment_intent_capture_params.rb

@@ -2,11 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PaymentIntentCaptureParams < Stripe::RequestParams
-    class AmountDetails < Stripe::RequestParams
-      class LineItem < Stripe::RequestParams
-        class PaymentMethodOptions < Stripe::RequestParams
-          class Card < Stripe::RequestParams
+  class PaymentIntentCaptureParams < ::Stripe::RequestParams
+    class AmountDetails < ::Stripe::RequestParams
+      class LineItem < ::Stripe::RequestParams
+        class PaymentMethodOptions < ::Stripe::RequestParams
+          class Card < ::Stripe::RequestParams
             # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
             attr_accessor :commodity_code
 
@@ -15,7 +15,7 @@ module Stripe
             end
           end
 
-          class CardPresent < Stripe::RequestParams
+          class CardPresent < ::Stripe::RequestParams
             # Identifier that categorizes the items being purchased using a standardized commodity scheme such as (but not limited to) UNSPSC, NAICS, NAPCS, etc.
             attr_accessor :commodity_code
 
@@ -24,22 +24,30 @@ module Stripe
             end
           end
 
-          class Klarna < Stripe::RequestParams
+          class Klarna < ::Stripe::RequestParams
             # URL to an image for the product. Max length, 4096 characters.
             attr_accessor :image_url
             # URL to the product page. Max length, 4096 characters.
             attr_accessor :product_url
+            # Unique reference for this line item to correlate it with your system’s internal records. The field is displayed in the Klarna Consumer App if passed.
+            attr_accessor :reference
             # Reference for the subscription this line item is for.
             attr_accessor :subscription_reference
 
-            def initialize(image_url: nil, product_url: nil, subscription_reference: nil)
+            def initialize(
+              image_url: nil,
+              product_url: nil,
+              reference: nil,
+              subscription_reference: nil
+            )
               @image_url = image_url
               @product_url = product_url
+              @reference = reference
               @subscription_reference = subscription_reference
             end
           end
 
-          class Paypal < Stripe::RequestParams
+          class Paypal < ::Stripe::RequestParams
             # Type of the line item.
             attr_accessor :category
             # Description of the line item.
@@ -70,27 +78,33 @@ module Stripe
           end
         end
 
-        class Tax < Stripe::RequestParams
-          # The total tax on an item. Non-negative integer.
+        class Tax < ::Stripe::RequestParams
+          # The total amount of tax on a single line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.
+          #
+          # This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field.
           attr_accessor :total_tax_amount
 
           def initialize(total_tax_amount: nil)
             @total_tax_amount = total_tax_amount
           end
         end
-        # The amount an item was discounted for. Positive integer.
+        # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0.
+        #
+        # This field is mutually exclusive with the `amount_details[discount_amount]` field.
         attr_accessor :discount_amount
         # Payment method-specific information for line items.
         attr_accessor :payment_method_options
-        # Unique identifier of the product. At most 12 characters long.
+        # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long.
         attr_accessor :product_code
-        # Name of the product. At most 100 characters long.
+        # The product name of the line item. Required for L3 rates. At most 1024 characters long.
+        #
+        # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters.
         attr_accessor :product_name
-        # Number of items of the product. Positive integer.
+        # The quantity of items. Required for L3 rates. An integer greater than 0.
         attr_accessor :quantity
         # Contains information about the tax on the item.
         attr_accessor :tax
-        # Cost of the product. Non-negative integer.
+        # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.
         attr_accessor :unit_cost
         # A unit of measure for the line item, such as gallons, feet, meters, etc.
         attr_accessor :unit_of_measure
@@ -116,12 +130,12 @@ module Stripe
         end
       end
 
-      class Shipping < Stripe::RequestParams
-        # Portion of the amount that is for shipping.
+      class Shipping < ::Stripe::RequestParams
+        # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0.
         attr_accessor :amount
-        # The postal code that represents the shipping source.
+        # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed.
         attr_accessor :from_postal_code
-        # The postal code that represents the shipping destination.
+        # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed.
         attr_accessor :to_postal_code
 
         def initialize(amount: nil, from_postal_code: nil, to_postal_code: nil)
@@ -131,15 +145,19 @@ module Stripe
         end
       end
 
-      class Tax < Stripe::RequestParams
-        # Total portion of the amount that is for tax.
+      class Tax < ::Stripe::RequestParams
+        # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.
+        #
+        # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field.
         attr_accessor :total_tax_amount
 
         def initialize(total_tax_amount: nil)
           @total_tax_amount = total_tax_amount
         end
       end
-      # The total discount applied on the transaction.
+      # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0.
+      #
+      # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field.
       attr_accessor :discount_amount
       # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
       attr_accessor :line_items
@@ -156,9 +174,9 @@ module Stripe
       end
     end
 
-    class Hooks < Stripe::RequestParams
-      class Inputs < Stripe::RequestParams
-        class Tax < Stripe::RequestParams
+    class Hooks < ::Stripe::RequestParams
+      class Inputs < ::Stripe::RequestParams
+        class Tax < ::Stripe::RequestParams
           # The [TaxCalculation](https://stripe.com/docs/api/tax/calculations) id
           attr_accessor :calculation
 
@@ -181,9 +199,9 @@ module Stripe
       end
     end
 
-    class PaymentDetails < Stripe::RequestParams
-      class CarRental < Stripe::RequestParams
-        class Affiliate < Stripe::RequestParams
+    class PaymentDetails < ::Stripe::RequestParams
+      class CarRental < ::Stripe::RequestParams
+        class Affiliate < ::Stripe::RequestParams
           # The name of the affiliate that originated the purchase.
           attr_accessor :name
 
@@ -192,8 +210,8 @@ module Stripe
           end
         end
 
-        class Delivery < Stripe::RequestParams
-          class Recipient < Stripe::RequestParams
+        class Delivery < ::Stripe::RequestParams
+          class Recipient < ::Stripe::RequestParams
             # The email of the recipient the ticket is delivered to.
             attr_accessor :email
             # The name of the recipient the ticket is delivered to.
@@ -218,7 +236,7 @@ module Stripe
           end
         end
 
-        class Distance < Stripe::RequestParams
+        class Distance < ::Stripe::RequestParams
           # Distance traveled.
           attr_accessor :amount
           # Unit of measurement for the distance traveled. One of `miles` or `kilometers`.
@@ -230,7 +248,7 @@ module Stripe
           end
         end
 
-        class Driver < Stripe::RequestParams
+        class Driver < ::Stripe::RequestParams
           # Driver's identification number.
           attr_accessor :driver_identification_number
           # Driver's tax number.
@@ -245,7 +263,7 @@ module Stripe
           end
         end
 
-        class PickupAddress < Stripe::RequestParams
+        class PickupAddress < ::Stripe::RequestParams
           # City, district, suburb, town, or village.
           attr_accessor :city
           # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
@@ -276,7 +294,7 @@ module Stripe
           end
         end
 
-        class ReturnAddress < Stripe::RequestParams
+        class ReturnAddress < ::Stripe::RequestParams
           # City, district, suburb, town, or village.
           attr_accessor :city
           # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
@@ -408,8 +426,8 @@ module Stripe
         end
       end
 
-      class EventDetails < Stripe::RequestParams
-        class Address < Stripe::RequestParams
+      class EventDetails < ::Stripe::RequestParams
+        class Address < ::Stripe::RequestParams
           # City, district, suburb, town, or village.
           attr_accessor :city
           # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
@@ -440,7 +458,7 @@ module Stripe
           end
         end
 
-        class Affiliate < Stripe::RequestParams
+        class Affiliate < ::Stripe::RequestParams
           # The name of the affiliate that originated the purchase.
           attr_accessor :name
 
@@ -449,8 +467,8 @@ module Stripe
           end
         end
 
-        class Delivery < Stripe::RequestParams
-          class Recipient < Stripe::RequestParams
+        class Delivery < ::Stripe::RequestParams
+          class Recipient < ::Stripe::RequestParams
             # The email of the recipient the ticket is delivered to.
             attr_accessor :email
             # The name of the recipient the ticket is delivered to.
@@ -516,8 +534,8 @@ module Stripe
         end
       end
 
-      class Flight < Stripe::RequestParams
-        class Affiliate < Stripe::RequestParams
+      class Flight < ::Stripe::RequestParams
+        class Affiliate < ::Stripe::RequestParams
           # The name of the affiliate that originated the purchase.
           attr_accessor :name
 
@@ -526,8 +544,8 @@ module Stripe
           end
         end
 
-        class Delivery < Stripe::RequestParams
-          class Recipient < Stripe::RequestParams
+        class Delivery < ::Stripe::RequestParams
+          class Recipient < ::Stripe::RequestParams
             # The email of the recipient the ticket is delivered to.
             attr_accessor :email
             # The name of the recipient the ticket is delivered to.
@@ -552,7 +570,7 @@ module Stripe
           end
         end
 
-        class Passenger < Stripe::RequestParams
+        class Passenger < ::Stripe::RequestParams
           # Full name of the person or entity on the flight reservation.
           attr_accessor :name
 
@@ -561,7 +579,7 @@ module Stripe
           end
         end
 
-        class Segment < Stripe::RequestParams
+        class Segment < ::Stripe::RequestParams
           # The flight segment amount.
           attr_accessor :amount
           # The International Air Transport Association (IATA) airport code for the arrival airport.
@@ -637,8 +655,8 @@ module Stripe
         end
       end
 
-      class Lodging < Stripe::RequestParams
-        class Address < Stripe::RequestParams
+      class Lodging < ::Stripe::RequestParams
+        class Address < ::Stripe::RequestParams
           # City, district, suburb, town, or village.
           attr_accessor :city
           # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
@@ -669,7 +687,7 @@ module Stripe
           end
         end
 
-        class Affiliate < Stripe::RequestParams
+        class Affiliate < ::Stripe::RequestParams
           # The name of the affiliate that originated the purchase.
           attr_accessor :name
 
@@ -678,8 +696,8 @@ module Stripe
           end
         end
 
-        class Delivery < Stripe::RequestParams
-          class Recipient < Stripe::RequestParams
+        class Delivery < ::Stripe::RequestParams
+          class Recipient < ::Stripe::RequestParams
             # The email of the recipient the ticket is delivered to.
             attr_accessor :email
             # The name of the recipient the ticket is delivered to.
@@ -704,7 +722,7 @@ module Stripe
           end
         end
 
-        class Passenger < Stripe::RequestParams
+        class Passenger < ::Stripe::RequestParams
           # Full name of the person or entity on the lodging reservation.
           attr_accessor :name
 
@@ -802,8 +820,8 @@ module Stripe
         end
       end
 
-      class Subscription < Stripe::RequestParams
-        class Affiliate < Stripe::RequestParams
+      class Subscription < ::Stripe::RequestParams
+        class Affiliate < ::Stripe::RequestParams
           # The name of the affiliate that originated the purchase.
           attr_accessor :name
 
@@ -812,7 +830,7 @@ module Stripe
           end
         end
 
-        class BillingInterval < Stripe::RequestParams
+        class BillingInterval < ::Stripe::RequestParams
           # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
           attr_accessor :count
           # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
@@ -854,7 +872,9 @@ module Stripe
       end
       # Car rental details for this PaymentIntent.
       attr_accessor :car_rental
-      # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
+      # A unique value to identify the customer. This field is available only for card payments.
+      #
+      # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
       attr_accessor :customer_reference
       # Event details for this PaymentIntent
       attr_accessor :event_details
@@ -862,7 +882,11 @@ module Stripe
       attr_accessor :flight
       # Lodging reservation details for this PaymentIntent
       attr_accessor :lodging
-      # A unique value assigned by the business to identify the transaction.
+      # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
+      #
+      # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`.
+      #
+      # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.
       attr_accessor :order_reference
       # Subscription details for this PaymentIntent
       attr_accessor :subscription
@@ -886,7 +910,7 @@ module Stripe
       end
     end
 
-    class TransferData < Stripe::RequestParams
+    class TransferData < ::Stripe::RequestParams
       # The amount that will be transferred automatically when a charge succeeds.
       attr_accessor :amount