stripe 17.0.1 → 17.1.0

data/lib/stripe/params/payment_record_report_payment_attempt_params.rb

@@ -0,0 +1,186 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordReportPaymentAttemptParams < ::Stripe::RequestParams
+    class Failed < ::Stripe::RequestParams
+      # When the reported payment failed. Measured in seconds since the Unix epoch.
+      attr_accessor :failed_at
+
+      def initialize(failed_at: nil)
+        @failed_at = failed_at
+      end
+    end
+
+    class Guaranteed < ::Stripe::RequestParams
+      # When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+      attr_accessor :guaranteed_at
+
+      def initialize(guaranteed_at: nil)
+        @guaranteed_at = guaranteed_at
+      end
+    end
+
+    class PaymentMethodDetails < ::Stripe::RequestParams
+      class BillingDetails < ::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)).
+          attr_accessor :country
+          # Address line 1, such as the street, PO Box, or company name.
+          attr_accessor :line1
+          # Address line 2, such as the apartment, suite, unit, or building.
+          attr_accessor :line2
+          # ZIP or postal code.
+          attr_accessor :postal_code
+          # State, county, province, or region.
+          attr_accessor :state
+
+          def initialize(
+            city: nil,
+            country: nil,
+            line1: nil,
+            line2: nil,
+            postal_code: nil,
+            state: nil
+          )
+            @city = city
+            @country = country
+            @line1 = line1
+            @line2 = line2
+            @postal_code = postal_code
+            @state = state
+          end
+        end
+        # The billing address associated with the method of payment.
+        attr_accessor :address
+        # The billing email associated with the method of payment.
+        attr_accessor :email
+        # The billing name associated with the method of payment.
+        attr_accessor :name
+        # The billing phone number associated with the method of payment.
+        attr_accessor :phone
+
+        def initialize(address: nil, email: nil, name: nil, phone: nil)
+          @address = address
+          @email = email
+          @name = name
+          @phone = phone
+        end
+      end
+
+      class Custom < ::Stripe::RequestParams
+        # Display name for the custom (user-defined) payment method type used to make this payment.
+        attr_accessor :display_name
+        # The custom payment method type associated with this payment.
+        attr_accessor :type
+
+        def initialize(display_name: nil, type: nil)
+          @display_name = display_name
+          @type = type
+        end
+      end
+      # The billing details associated with the method of payment.
+      attr_accessor :billing_details
+      # Information about the custom (user-defined) payment method used to make this payment.
+      attr_accessor :custom
+      # ID of the Stripe Payment Method used to make this payment.
+      attr_accessor :payment_method
+      # The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
+      attr_accessor :type
+
+      def initialize(billing_details: nil, custom: nil, payment_method: nil, type: nil)
+        @billing_details = billing_details
+        @custom = custom
+        @payment_method = payment_method
+        @type = type
+      end
+    end
+
+    class ShippingDetails < ::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)).
+        attr_accessor :country
+        # Address line 1, such as the street, PO Box, or company name.
+        attr_accessor :line1
+        # Address line 2, such as the apartment, suite, unit, or building.
+        attr_accessor :line2
+        # ZIP or postal code.
+        attr_accessor :postal_code
+        # State, county, province, or region.
+        attr_accessor :state
+
+        def initialize(
+          city: nil,
+          country: nil,
+          line1: nil,
+          line2: nil,
+          postal_code: nil,
+          state: nil
+        )
+          @city = city
+          @country = country
+          @line1 = line1
+          @line2 = line2
+          @postal_code = postal_code
+          @state = state
+        end
+      end
+      # The physical shipping address.
+      attr_accessor :address
+      # The shipping recipient's name.
+      attr_accessor :name
+      # The shipping recipient's phone number.
+      attr_accessor :phone
+
+      def initialize(address: nil, name: nil, phone: nil)
+        @address = address
+        @name = name
+        @phone = phone
+      end
+    end
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # Information about the payment attempt failure.
+    attr_accessor :failed
+    # Information about the payment attempt guarantee.
+    attr_accessor :guaranteed
+    # When the reported payment was initiated. Measured in seconds since the Unix epoch.
+    attr_accessor :initiated_at
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+    # The outcome of the reported payment.
+    attr_accessor :outcome
+    # Information about the Payment Method debited for this payment.
+    attr_accessor :payment_method_details
+    # Shipping information for this payment.
+    attr_accessor :shipping_details
+
+    def initialize(
+      description: nil,
+      expand: nil,
+      failed: nil,
+      guaranteed: nil,
+      initiated_at: nil,
+      metadata: nil,
+      outcome: nil,
+      payment_method_details: nil,
+      shipping_details: nil
+    )
+      @description = description
+      @expand = expand
+      @failed = failed
+      @guaranteed = guaranteed
+      @initiated_at = initiated_at
+      @metadata = metadata
+      @outcome = outcome
+      @payment_method_details = payment_method_details
+      @shipping_details = shipping_details
+    end
+  end
+end

data/lib/stripe/params/payment_record_report_payment_params.rb

@@ -0,0 +1,252 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordReportPaymentParams < ::Stripe::RequestParams
+    class AmountRequested < ::Stripe::RequestParams
+      # 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_accessor :currency
+      # A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
+      attr_accessor :value
+
+      def initialize(currency: nil, value: nil)
+        @currency = currency
+        @value = value
+      end
+    end
+
+    class CustomerDetails < ::Stripe::RequestParams
+      # The customer who made the payment.
+      attr_accessor :customer
+      # The customer's phone number.
+      attr_accessor :email
+      # The customer's name.
+      attr_accessor :name
+      # The customer's phone number.
+      attr_accessor :phone
+
+      def initialize(customer: nil, email: nil, name: nil, phone: nil)
+        @customer = customer
+        @email = email
+        @name = name
+        @phone = phone
+      end
+    end
+
+    class Failed < ::Stripe::RequestParams
+      # When the reported payment failed. Measured in seconds since the Unix epoch.
+      attr_accessor :failed_at
+
+      def initialize(failed_at: nil)
+        @failed_at = failed_at
+      end
+    end
+
+    class Guaranteed < ::Stripe::RequestParams
+      # When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+      attr_accessor :guaranteed_at
+
+      def initialize(guaranteed_at: nil)
+        @guaranteed_at = guaranteed_at
+      end
+    end
+
+    class PaymentMethodDetails < ::Stripe::RequestParams
+      class BillingDetails < ::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)).
+          attr_accessor :country
+          # Address line 1, such as the street, PO Box, or company name.
+          attr_accessor :line1
+          # Address line 2, such as the apartment, suite, unit, or building.
+          attr_accessor :line2
+          # ZIP or postal code.
+          attr_accessor :postal_code
+          # State, county, province, or region.
+          attr_accessor :state
+
+          def initialize(
+            city: nil,
+            country: nil,
+            line1: nil,
+            line2: nil,
+            postal_code: nil,
+            state: nil
+          )
+            @city = city
+            @country = country
+            @line1 = line1
+            @line2 = line2
+            @postal_code = postal_code
+            @state = state
+          end
+        end
+        # The billing address associated with the method of payment.
+        attr_accessor :address
+        # The billing email associated with the method of payment.
+        attr_accessor :email
+        # The billing name associated with the method of payment.
+        attr_accessor :name
+        # The billing phone number associated with the method of payment.
+        attr_accessor :phone
+
+        def initialize(address: nil, email: nil, name: nil, phone: nil)
+          @address = address
+          @email = email
+          @name = name
+          @phone = phone
+        end
+      end
+
+      class Custom < ::Stripe::RequestParams
+        # Display name for the custom (user-defined) payment method type used to make this payment.
+        attr_accessor :display_name
+        # The custom payment method type associated with this payment.
+        attr_accessor :type
+
+        def initialize(display_name: nil, type: nil)
+          @display_name = display_name
+          @type = type
+        end
+      end
+      # The billing details associated with the method of payment.
+      attr_accessor :billing_details
+      # Information about the custom (user-defined) payment method used to make this payment.
+      attr_accessor :custom
+      # ID of the Stripe Payment Method used to make this payment.
+      attr_accessor :payment_method
+      # The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
+      attr_accessor :type
+
+      def initialize(billing_details: nil, custom: nil, payment_method: nil, type: nil)
+        @billing_details = billing_details
+        @custom = custom
+        @payment_method = payment_method
+        @type = type
+      end
+    end
+
+    class ProcessorDetails < ::Stripe::RequestParams
+      class Custom < ::Stripe::RequestParams
+        # An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+        attr_accessor :payment_reference
+
+        def initialize(payment_reference: nil)
+          @payment_reference = payment_reference
+        end
+      end
+      # Information about the custom processor used to make this payment.
+      attr_accessor :custom
+      # The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
+      attr_accessor :type
+
+      def initialize(custom: nil, type: nil)
+        @custom = custom
+        @type = type
+      end
+    end
+
+    class ShippingDetails < ::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)).
+        attr_accessor :country
+        # Address line 1, such as the street, PO Box, or company name.
+        attr_accessor :line1
+        # Address line 2, such as the apartment, suite, unit, or building.
+        attr_accessor :line2
+        # ZIP or postal code.
+        attr_accessor :postal_code
+        # State, county, province, or region.
+        attr_accessor :state
+
+        def initialize(
+          city: nil,
+          country: nil,
+          line1: nil,
+          line2: nil,
+          postal_code: nil,
+          state: nil
+        )
+          @city = city
+          @country = country
+          @line1 = line1
+          @line2 = line2
+          @postal_code = postal_code
+          @state = state
+        end
+      end
+      # The physical shipping address.
+      attr_accessor :address
+      # The shipping recipient's name.
+      attr_accessor :name
+      # The shipping recipient's phone number.
+      attr_accessor :phone
+
+      def initialize(address: nil, name: nil, phone: nil)
+        @address = address
+        @name = name
+        @phone = phone
+      end
+    end
+    # The amount you initially requested for this payment.
+    attr_accessor :amount_requested
+    # Customer information for this payment.
+    attr_accessor :customer_details
+    # Indicates whether the customer was present in your checkout flow during this payment.
+    attr_accessor :customer_presence
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # Information about the payment attempt failure.
+    attr_accessor :failed
+    # Information about the payment attempt guarantee.
+    attr_accessor :guaranteed
+    # When the reported payment was initiated. Measured in seconds since the Unix epoch.
+    attr_accessor :initiated_at
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+    # The outcome of the reported payment.
+    attr_accessor :outcome
+    # Information about the Payment Method debited for this payment.
+    attr_accessor :payment_method_details
+    # Processor information for this payment.
+    attr_accessor :processor_details
+    # Shipping information for this payment.
+    attr_accessor :shipping_details
+
+    def initialize(
+      amount_requested: nil,
+      customer_details: nil,
+      customer_presence: nil,
+      description: nil,
+      expand: nil,
+      failed: nil,
+      guaranteed: nil,
+      initiated_at: nil,
+      metadata: nil,
+      outcome: nil,
+      payment_method_details: nil,
+      processor_details: nil,
+      shipping_details: nil
+    )
+      @amount_requested = amount_requested
+      @customer_details = customer_details
+      @customer_presence = customer_presence
+      @description = description
+      @expand = expand
+      @failed = failed
+      @guaranteed = guaranteed
+      @initiated_at = initiated_at
+      @metadata = metadata
+      @outcome = outcome
+      @payment_method_details = payment_method_details
+      @processor_details = processor_details
+      @shipping_details = shipping_details
+    end
+  end
+end

data/lib/stripe/params/payment_record_report_refund_params.rb

@@ -0,0 +1,79 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordReportRefundParams < ::Stripe::RequestParams
+    class Amount < ::Stripe::RequestParams
+      # 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_accessor :currency
+      # A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
+      attr_accessor :value
+
+      def initialize(currency: nil, value: nil)
+        @currency = currency
+        @value = value
+      end
+    end
+
+    class ProcessorDetails < ::Stripe::RequestParams
+      class Custom < ::Stripe::RequestParams
+        # A reference to the external refund. This field must be unique across all refunds.
+        attr_accessor :refund_reference
+
+        def initialize(refund_reference: nil)
+          @refund_reference = refund_reference
+        end
+      end
+      # Information about the custom processor used to make this refund.
+      attr_accessor :custom
+      # The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
+      attr_accessor :type
+
+      def initialize(custom: nil, type: nil)
+        @custom = custom
+        @type = type
+      end
+    end
+
+    class Refunded < ::Stripe::RequestParams
+      # When the reported refund completed. Measured in seconds since the Unix epoch.
+      attr_accessor :refunded_at
+
+      def initialize(refunded_at: nil)
+        @refunded_at = refunded_at
+      end
+    end
+    # A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing how much of this payment to refund. Can refund only up to the remaining, unrefunded amount of the payment.
+    attr_accessor :amount
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # When the reported refund was initiated. Measured in seconds since the Unix epoch.
+    attr_accessor :initiated_at
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+    # The outcome of the reported refund.
+    attr_accessor :outcome
+    # Processor information for this refund.
+    attr_accessor :processor_details
+    # Information about the payment attempt refund.
+    attr_accessor :refunded
+
+    def initialize(
+      amount: nil,
+      expand: nil,
+      initiated_at: nil,
+      metadata: nil,
+      outcome: nil,
+      processor_details: nil,
+      refunded: nil
+    )
+      @amount = amount
+      @expand = expand
+      @initiated_at = initiated_at
+      @metadata = metadata
+      @outcome = outcome
+      @processor_details = processor_details
+      @refunded = refunded
+    end
+  end
+end

data/lib/stripe/params/payment_record_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordRetrieveParams < ::Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/payout_cancel_params.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PayoutCancelParams < Stripe::RequestParams
+  class PayoutCancelParams < ::Stripe::RequestParams
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
 

data/lib/stripe/params/payout_create_params.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PayoutCreateParams < Stripe::RequestParams
+  class PayoutCreateParams < ::Stripe::RequestParams
     # A positive integer in cents representing how much to payout.
     attr_accessor :amount
     # 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).

data/lib/stripe/params/payout_list_params.rb

@@ -2,8 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PayoutListParams < Stripe::RequestParams
-    class ArrivalDate < Stripe::RequestParams
+  class PayoutListParams < ::Stripe::RequestParams
+    class ArrivalDate < ::Stripe::RequestParams
       # Minimum value to filter by (exclusive)
       attr_accessor :gt
       # Minimum value to filter by (inclusive)
@@ -21,7 +21,7 @@ module Stripe
       end
     end
 
-    class Created < Stripe::RequestParams
+    class Created < ::Stripe::RequestParams
       # Minimum value to filter by (exclusive)
       attr_accessor :gt
       # Minimum value to filter by (inclusive)

data/lib/stripe/params/payout_retrieve_params.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PayoutRetrieveParams < Stripe::RequestParams
+  class PayoutRetrieveParams < ::Stripe::RequestParams
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
 

data/lib/stripe/params/payout_reverse_params.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PayoutReverseParams < Stripe::RequestParams
+  class PayoutReverseParams < ::Stripe::RequestParams
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
     # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

data/lib/stripe/params/payout_update_params.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PayoutUpdateParams < Stripe::RequestParams
+  class PayoutUpdateParams < ::Stripe::RequestParams
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
     # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

data/lib/stripe/params/plan_create_params.rb

@@ -2,8 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PlanCreateParams < Stripe::RequestParams
-    class Product < Stripe::RequestParams
+  class PlanCreateParams < ::Stripe::RequestParams
+    class Product < ::Stripe::RequestParams
       # Whether the product is currently available for purchase. Defaults to `true`.
       attr_accessor :active
       # The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
@@ -40,7 +40,7 @@ module Stripe
       end
     end
 
-    class Tier < Stripe::RequestParams
+    class Tier < ::Stripe::RequestParams
       # The flat billing amount for an entire tier, regardless of the number of units in the tier.
       attr_accessor :flat_amount
       # Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
@@ -67,7 +67,7 @@ module Stripe
       end
     end
 
-    class TransformUsage < Stripe::RequestParams
+    class TransformUsage < ::Stripe::RequestParams
       # Divide usage by this number.
       attr_accessor :divide_by
       # After division, either round the result `up` or `down`.

data/lib/stripe/params/plan_delete_params.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PlanDeleteParams < Stripe::RequestParams; end
+  class PlanDeleteParams < ::Stripe::RequestParams; end
 end

data/lib/stripe/params/plan_list_params.rb

@@ -2,8 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PlanListParams < Stripe::RequestParams
-    class Created < Stripe::RequestParams
+  class PlanListParams < ::Stripe::RequestParams
+    class Created < ::Stripe::RequestParams
       # Minimum value to filter by (exclusive)
       attr_accessor :gt
       # Minimum value to filter by (inclusive)

data/lib/stripe/params/plan_retrieve_params.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PlanRetrieveParams < Stripe::RequestParams
+  class PlanRetrieveParams < ::Stripe::RequestParams
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
 

data/lib/stripe/params/plan_update_params.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class PlanUpdateParams < Stripe::RequestParams
+  class PlanUpdateParams < ::Stripe::RequestParams
     # Whether the plan is currently available for new subscriptions.
     attr_accessor :active
     # Specifies which fields in the response should be expanded.