stripe 19.2.0 → 19.3.0.pre.alpha.2

data/lib/stripe/params/delegated_checkout/requested_session_confirm_params.rb

@@ -0,0 +1,168 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module DelegatedCheckout
+    class RequestedSessionConfirmParams < ::Stripe::RequestParams
+      class AffiliateAttribution < ::Stripe::RequestParams
+        class Source < ::Stripe::RequestParams
+          # The platform where the attribution originated.
+          attr_accessor :platform
+          # The type of the attribution source.
+          attr_accessor :type
+          # The URL where the attribution originated.
+          attr_accessor :url
+
+          def initialize(platform: nil, type: nil, url: nil)
+            @platform = platform
+            @type = type
+            @url = url
+          end
+        end
+        # Agent-scoped campaign identifier.
+        attr_accessor :campaign_id
+        # Agent-scoped creative identifier.
+        attr_accessor :creative_id
+        # Timestamp when the attribution token expires.
+        attr_accessor :expires_at
+        # Agent-issued secret to validate the legitimacy of the source of this data.
+        attr_accessor :identification_token
+        # Timestamp for when the attribution token was issued.
+        attr_accessor :issued_at
+        # Identifier for the attribution agent / affiliate network namespace.
+        attr_accessor :provider
+        # Agent-scoped affiliate/publisher identifier.
+        attr_accessor :publisher_id
+        # Freeform key/value pairs for additional non-sensitive per-agent data.
+        attr_accessor :shared_metadata
+        # Context about where the attribution originated.
+        attr_accessor :source
+        # Agent-scoped sub-tracking identifier.
+        attr_accessor :sub_id
+        # Whether this is the first or last touchpoint.
+        attr_accessor :touchpoint
+
+        def initialize(
+          campaign_id: nil,
+          creative_id: nil,
+          expires_at: nil,
+          identification_token: nil,
+          issued_at: nil,
+          provider: nil,
+          publisher_id: nil,
+          shared_metadata: nil,
+          source: nil,
+          sub_id: nil,
+          touchpoint: nil
+        )
+          @campaign_id = campaign_id
+          @creative_id = creative_id
+          @expires_at = expires_at
+          @identification_token = identification_token
+          @issued_at = issued_at
+          @provider = provider
+          @publisher_id = publisher_id
+          @shared_metadata = shared_metadata
+          @source = source
+          @sub_id = sub_id
+          @touchpoint = touchpoint
+        end
+      end
+
+      class BuyerConsents < ::Stripe::RequestParams
+        class Marketing < ::Stripe::RequestParams
+          class Consent < ::Stripe::RequestParams
+            # The marketing consent channel.
+            attr_accessor :channel
+            # The consent status. Use 'granted' to indicate the buyer has opted in.
+            attr_accessor :status
+
+            def initialize(channel: nil, status: nil)
+              @channel = channel
+              @status = status
+            end
+          end
+          # The list of marketing consent entries.
+          attr_accessor :consents
+
+          def initialize(consents: nil)
+            @consents = consents
+          end
+        end
+        # The marketing consent data for the buyer.
+        attr_accessor :marketing
+
+        def initialize(marketing: nil)
+          @marketing = marketing
+        end
+      end
+
+      class RiskDetails < ::Stripe::RequestParams
+        class ClientDeviceMetadataDetails < ::Stripe::RequestParams
+          # The radar session.
+          attr_accessor :radar_session
+          # The referrer of the client device.
+          attr_accessor :referrer
+          # The remote IP address of the client device.
+          attr_accessor :remote_ip
+          # The time on page in milliseconds.
+          attr_accessor :time_on_page_ms
+          # The user agent of the client device.
+          attr_accessor :user_agent
+
+          def initialize(
+            radar_session: nil,
+            referrer: nil,
+            remote_ip: nil,
+            time_on_page_ms: nil,
+            user_agent: nil
+          )
+            @radar_session = radar_session
+            @referrer = referrer
+            @remote_ip = remote_ip
+            @time_on_page_ms = time_on_page_ms
+            @user_agent = user_agent
+          end
+        end
+        # The client device metadata details for this requested session.
+        attr_accessor :client_device_metadata_details
+
+        def initialize(client_device_metadata_details: nil)
+          @client_device_metadata_details = client_device_metadata_details
+        end
+      end
+      # Affiliate attribution data associated with this requested session.
+      attr_accessor :affiliate_attribution
+      # The buyer's consent choices for marketing communications.
+      attr_accessor :buyer_consents
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The metadata for this requested session.
+      attr_accessor :metadata
+      # The PaymentMethod to use with the requested session.
+      attr_accessor :payment_method
+      # The URL to redirect your customer back to after they authenticate or complete a payment action. Required for redirect-based payment methods such as Affirm or Klarna.
+      attr_accessor :return_url
+      # Risk details/signals associated with the requested session
+      attr_accessor :risk_details
+
+      def initialize(
+        affiliate_attribution: nil,
+        buyer_consents: nil,
+        expand: nil,
+        metadata: nil,
+        payment_method: nil,
+        return_url: nil,
+        risk_details: nil
+      )
+        @affiliate_attribution = affiliate_attribution
+        @buyer_consents = buyer_consents
+        @expand = expand
+        @metadata = metadata
+        @payment_method = payment_method
+        @return_url = return_url
+        @risk_details = risk_details
+      end
+    end
+  end
+end

data/lib/stripe/params/delegated_checkout/requested_session_create_params.rb

@@ -0,0 +1,230 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module DelegatedCheckout
+    class RequestedSessionCreateParams < ::Stripe::RequestParams
+      class AffiliateAttribution < ::Stripe::RequestParams
+        class Source < ::Stripe::RequestParams
+          # The platform where the attribution originated.
+          attr_accessor :platform
+          # The type of the attribution source.
+          attr_accessor :type
+          # The URL where the attribution originated.
+          attr_accessor :url
+
+          def initialize(platform: nil, type: nil, url: nil)
+            @platform = platform
+            @type = type
+            @url = url
+          end
+        end
+        # Agent-scoped campaign identifier.
+        attr_accessor :campaign_id
+        # Agent-scoped creative identifier.
+        attr_accessor :creative_id
+        # Timestamp when the attribution token expires.
+        attr_accessor :expires_at
+        # Agent-issued secret to validate the legitimacy of the source of this data.
+        attr_accessor :identification_token
+        # Timestamp for when the attribution token was issued.
+        attr_accessor :issued_at
+        # Identifier for the attribution agent / affiliate network namespace.
+        attr_accessor :provider
+        # Agent-scoped affiliate/publisher identifier.
+        attr_accessor :publisher_id
+        # Freeform key/value pairs for additional non-sensitive per-agent data.
+        attr_accessor :shared_metadata
+        # Context about where the attribution originated.
+        attr_accessor :source
+        # Agent-scoped sub-tracking identifier.
+        attr_accessor :sub_id
+        # Whether this is the first or last touchpoint.
+        attr_accessor :touchpoint
+
+        def initialize(
+          campaign_id: nil,
+          creative_id: nil,
+          expires_at: nil,
+          identification_token: nil,
+          issued_at: nil,
+          provider: nil,
+          publisher_id: nil,
+          shared_metadata: nil,
+          source: nil,
+          sub_id: nil,
+          touchpoint: nil
+        )
+          @campaign_id = campaign_id
+          @creative_id = creative_id
+          @expires_at = expires_at
+          @identification_token = identification_token
+          @issued_at = issued_at
+          @provider = provider
+          @publisher_id = publisher_id
+          @shared_metadata = shared_metadata
+          @source = source
+          @sub_id = sub_id
+          @touchpoint = touchpoint
+        end
+      end
+
+      class Discounts < ::Stripe::RequestParams
+        # Array of discount codes to apply.
+        attr_accessor :codes
+        # Whether to enforce strict eligibility for discount codes. Defaults to true. When false, invalid codes are returned in the discounts.invalid array instead of raising an error.
+        attr_accessor :enforce_strict_eligibility
+
+        def initialize(codes: nil, enforce_strict_eligibility: nil)
+          @codes = codes
+          @enforce_strict_eligibility = enforce_strict_eligibility
+        end
+      end
+
+      class FulfillmentDetails < ::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 ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
+          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 customer's address.
+        attr_accessor :address
+        # The customer's email address.
+        attr_accessor :email
+        # The customer's name.
+        attr_accessor :name
+        # The customer's phone number.
+        attr_accessor :phone
+
+        def initialize(address: nil, email: nil, name: nil, phone: nil)
+          @address = address
+          @email = email
+          @name = name
+          @phone = phone
+        end
+      end
+
+      class LineItemDetail < ::Stripe::RequestParams
+        # The quantity of the line item.
+        attr_accessor :quantity
+        # The SKU ID of the line item.
+        attr_accessor :sku_id
+
+        def initialize(quantity: nil, sku_id: nil)
+          @quantity = quantity
+          @sku_id = sku_id
+        end
+      end
+
+      class PaymentMethodOptions < ::Stripe::RequestParams
+        class Card < ::Stripe::RequestParams
+          # The card brands to exclude from the session.
+          attr_accessor :brands_blocked
+
+          def initialize(brands_blocked: nil)
+            @brands_blocked = brands_blocked
+          end
+        end
+        # Card-specific payment method options.
+        attr_accessor :card
+        # The payment method types to exclude from the session.
+        attr_accessor :excluded_payment_method_types
+
+        def initialize(card: nil, excluded_payment_method_types: nil)
+          @card = card
+          @excluded_payment_method_types = excluded_payment_method_types
+        end
+      end
+
+      class SellerDetails < ::Stripe::RequestParams
+        # The network profile for the seller.
+        attr_accessor :network_profile
+
+        def initialize(network_profile: nil)
+          @network_profile = network_profile
+        end
+      end
+      # Affiliate attribution data associated with this requested session.
+      attr_accessor :affiliate_attribution
+      # The currency for this requested session.
+      attr_accessor :currency
+      # The customer for this requested session.
+      attr_accessor :customer
+      # The discount codes to apply to this requested session.
+      attr_accessor :discounts
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The details of the fulfillment.
+      attr_accessor :fulfillment_details
+      # The details of the line items.
+      attr_accessor :line_item_details
+      # The metadata for this requested session.
+      attr_accessor :metadata
+      # The payment method for this requested session.
+      attr_accessor :payment_method
+      # The payment method options for this requested session.
+      attr_accessor :payment_method_options
+      # The details of the seller.
+      attr_accessor :seller_details
+      # The setup future usage for this requested session.
+      attr_accessor :setup_future_usage
+      # The shared metadata for this requested session.
+      attr_accessor :shared_metadata
+
+      def initialize(
+        affiliate_attribution: nil,
+        currency: nil,
+        customer: nil,
+        discounts: nil,
+        expand: nil,
+        fulfillment_details: nil,
+        line_item_details: nil,
+        metadata: nil,
+        payment_method: nil,
+        payment_method_options: nil,
+        seller_details: nil,
+        setup_future_usage: nil,
+        shared_metadata: nil
+      )
+        @affiliate_attribution = affiliate_attribution
+        @currency = currency
+        @customer = customer
+        @discounts = discounts
+        @expand = expand
+        @fulfillment_details = fulfillment_details
+        @line_item_details = line_item_details
+        @metadata = metadata
+        @payment_method = payment_method
+        @payment_method_options = payment_method_options
+        @seller_details = seller_details
+        @setup_future_usage = setup_future_usage
+        @shared_metadata = shared_metadata
+      end
+    end
+  end
+end

data/lib/stripe/params/delegated_checkout/requested_session_expire_params.rb

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

data/lib/stripe/params/delegated_checkout/requested_session_list_orders_params.rb

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module DelegatedCheckout
+    class RequestedSessionListOrdersParams < ::Stripe::RequestParams
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+  end
+end

data/lib/stripe/params/delegated_checkout/requested_session_order_list_params.rb

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module DelegatedCheckout
+    class RequestedSessionOrderListParams < ::Stripe::RequestParams
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+  end
+end

data/lib/stripe/params/delegated_checkout/requested_session_retrieve_params.rb

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

data/lib/stripe/params/delegated_checkout/requested_session_update_params.rb

@@ -0,0 +1,216 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module DelegatedCheckout
+    class RequestedSessionUpdateParams < ::Stripe::RequestParams
+      class Discounts < ::Stripe::RequestParams
+        # Array of discount codes to apply. Pass an empty value to remove all applied discounts.
+        attr_accessor :codes
+        # Whether to enforce strict eligibility for discount codes. Defaults to true. When false, invalid codes are returned in the discounts.invalid array instead of raising an error.
+        attr_accessor :enforce_strict_eligibility
+
+        def initialize(codes: nil, enforce_strict_eligibility: nil)
+          @codes = codes
+          @enforce_strict_eligibility = enforce_strict_eligibility
+        end
+      end
+
+      class FulfillmentDetails < ::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 ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
+          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
+
+        class SelectedFulfillmentOption < ::Stripe::RequestParams
+          class Digital < ::Stripe::RequestParams
+            # The digital option identifier.
+            attr_accessor :digital_option
+
+            def initialize(digital_option: nil)
+              @digital_option = digital_option
+            end
+          end
+
+          class Shipping < ::Stripe::RequestParams
+            # The shipping option identifier.
+            attr_accessor :shipping_option
+
+            def initialize(shipping_option: nil)
+              @shipping_option = shipping_option
+            end
+          end
+          # The digital fulfillment option.
+          attr_accessor :digital
+          # The shipping fulfillment option.
+          attr_accessor :shipping
+          # The type of fulfillment option.
+          attr_accessor :type
+
+          def initialize(digital: nil, shipping: nil, type: nil)
+            @digital = digital
+            @shipping = shipping
+            @type = type
+          end
+        end
+
+        class SelectedFulfillmentOptionOverride < ::Stripe::RequestParams
+          class Digital < ::Stripe::RequestParams
+            # The digital option identifier.
+            attr_accessor :digital_option
+
+            def initialize(digital_option: nil)
+              @digital_option = digital_option
+            end
+          end
+
+          class Shipping < ::Stripe::RequestParams
+            # The shipping option identifier.
+            attr_accessor :shipping_option
+
+            def initialize(shipping_option: nil)
+              @shipping_option = shipping_option
+            end
+          end
+          # The digital fulfillment option.
+          attr_accessor :digital
+          # The line item keys that this fulfillment option override applies to.
+          attr_accessor :line_item_keys
+          # The shipping fulfillment option.
+          attr_accessor :shipping
+          # The type of fulfillment option.
+          attr_accessor :type
+
+          def initialize(digital: nil, line_item_keys: nil, shipping: nil, type: nil)
+            @digital = digital
+            @line_item_keys = line_item_keys
+            @shipping = shipping
+            @type = type
+          end
+        end
+        # The customer's address.
+        attr_accessor :address
+        # The customer's email address.
+        attr_accessor :email
+        # The customer's name.
+        attr_accessor :name
+        # The customer's phone number.
+        attr_accessor :phone
+        # The fulfillment option to select.
+        attr_accessor :selected_fulfillment_option
+        # The fulfillment option overrides for specific line items.
+        attr_accessor :selected_fulfillment_option_overrides
+
+        def initialize(
+          address: nil,
+          email: nil,
+          name: nil,
+          phone: nil,
+          selected_fulfillment_option: nil,
+          selected_fulfillment_option_overrides: nil
+        )
+          @address = address
+          @email = email
+          @name = name
+          @phone = phone
+          @selected_fulfillment_option = selected_fulfillment_option
+          @selected_fulfillment_option_overrides = selected_fulfillment_option_overrides
+        end
+      end
+
+      class LineItemDetail < ::Stripe::RequestParams
+        # The key of the line item.
+        attr_accessor :key
+        # The quantity of the line item.
+        attr_accessor :quantity
+
+        def initialize(key: nil, quantity: nil)
+          @key = key
+          @quantity = quantity
+        end
+      end
+
+      class PaymentMethodOptions < ::Stripe::RequestParams
+        class Card < ::Stripe::RequestParams
+          # The card brands to exclude from the session.
+          attr_accessor :brands_blocked
+
+          def initialize(brands_blocked: nil)
+            @brands_blocked = brands_blocked
+          end
+        end
+        # Card-specific payment method options.
+        attr_accessor :card
+        # The payment method types to exclude from the session.
+        attr_accessor :excluded_payment_method_types
+
+        def initialize(card: nil, excluded_payment_method_types: nil)
+          @card = card
+          @excluded_payment_method_types = excluded_payment_method_types
+        end
+      end
+      # The discount codes to apply to this requested session. Pass an empty value to remove all applied discounts.
+      attr_accessor :discounts
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The details of the fulfillment.
+      attr_accessor :fulfillment_details
+      # The details of the line items.
+      attr_accessor :line_item_details
+      # The metadata for this requested session.
+      attr_accessor :metadata
+      # The payment method for this requested session.
+      attr_accessor :payment_method
+      # The payment method options for this requested session.
+      attr_accessor :payment_method_options
+      # The shared metadata for this requested session.
+      attr_accessor :shared_metadata
+
+      def initialize(
+        discounts: nil,
+        expand: nil,
+        fulfillment_details: nil,
+        line_item_details: nil,
+        metadata: nil,
+        payment_method: nil,
+        payment_method_options: nil,
+        shared_metadata: nil
+      )
+        @discounts = discounts
+        @expand = expand
+        @fulfillment_details = fulfillment_details
+        @line_item_details = line_item_details
+        @metadata = metadata
+        @payment_method = payment_method
+        @payment_method_options = payment_method_options
+        @shared_metadata = shared_metadata
+      end
+    end
+  end
+end