stripe 13.4.1 → 17.0.1

data/lib/stripe/params/terminal/location_create_params.rb

@@ -0,0 +1,153 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class LocationCreateParams < 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
+
+      class AddressKana < Stripe::RequestParams
+        # City or ward.
+        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
+        # Block or building number.
+        attr_accessor :line1
+        # Building details.
+        attr_accessor :line2
+        # Postal code.
+        attr_accessor :postal_code
+        # Prefecture.
+        attr_accessor :state
+        # Town or cho-me.
+        attr_accessor :town
+
+        def initialize(
+          city: nil,
+          country: nil,
+          line1: nil,
+          line2: nil,
+          postal_code: nil,
+          state: nil,
+          town: nil
+        )
+          @city = city
+          @country = country
+          @line1 = line1
+          @line2 = line2
+          @postal_code = postal_code
+          @state = state
+          @town = town
+        end
+      end
+
+      class AddressKanji < Stripe::RequestParams
+        # City or ward.
+        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
+        # Block or building number.
+        attr_accessor :line1
+        # Building details.
+        attr_accessor :line2
+        # Postal code.
+        attr_accessor :postal_code
+        # Prefecture.
+        attr_accessor :state
+        # Town or cho-me.
+        attr_accessor :town
+
+        def initialize(
+          city: nil,
+          country: nil,
+          line1: nil,
+          line2: nil,
+          postal_code: nil,
+          state: nil,
+          town: nil
+        )
+          @city = city
+          @country = country
+          @line1 = line1
+          @line2 = line2
+          @postal_code = postal_code
+          @state = state
+          @town = town
+        end
+      end
+      # The full address of the location.
+      attr_accessor :address
+      # The Kana variation of the full address of the location (Japan only).
+      attr_accessor :address_kana
+      # The Kanji variation of the full address of the location (Japan only).
+      attr_accessor :address_kanji
+      # The ID of a configuration that will be used to customize all readers in this location.
+      attr_accessor :configuration_overrides
+      # A name for the location. Maximum length is 1000 characters.
+      attr_accessor :display_name
+      # The Kana variation of the name for the location (Japan only). Maximum length is 1000 characters.
+      attr_accessor :display_name_kana
+      # The Kanji variation of the name for the location (Japan only). Maximum length is 1000 characters.
+      attr_accessor :display_name_kanji
+      # 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`.
+      attr_accessor :metadata
+      # The phone number for the location.
+      attr_accessor :phone
+
+      def initialize(
+        address: nil,
+        address_kana: nil,
+        address_kanji: nil,
+        configuration_overrides: nil,
+        display_name: nil,
+        display_name_kana: nil,
+        display_name_kanji: nil,
+        expand: nil,
+        metadata: nil,
+        phone: nil
+      )
+        @address = address
+        @address_kana = address_kana
+        @address_kanji = address_kanji
+        @configuration_overrides = configuration_overrides
+        @display_name = display_name
+        @display_name_kana = display_name_kana
+        @display_name_kanji = display_name_kanji
+        @expand = expand
+        @metadata = metadata
+        @phone = phone
+      end
+    end
+  end
+end

data/lib/stripe/params/terminal/location_delete_params.rb

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class LocationDeleteParams < Stripe::RequestParams; end
+  end
+end

data/lib/stripe/params/terminal/location_list_params.rb

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class LocationListParams < 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/terminal/location_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class LocationRetrieveParams < 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/terminal/location_update_params.rb

@@ -0,0 +1,153 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class LocationUpdateParams < 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
+
+      class AddressKana < Stripe::RequestParams
+        # City or ward.
+        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
+        # Block or building number.
+        attr_accessor :line1
+        # Building details.
+        attr_accessor :line2
+        # Postal code.
+        attr_accessor :postal_code
+        # Prefecture.
+        attr_accessor :state
+        # Town or cho-me.
+        attr_accessor :town
+
+        def initialize(
+          city: nil,
+          country: nil,
+          line1: nil,
+          line2: nil,
+          postal_code: nil,
+          state: nil,
+          town: nil
+        )
+          @city = city
+          @country = country
+          @line1 = line1
+          @line2 = line2
+          @postal_code = postal_code
+          @state = state
+          @town = town
+        end
+      end
+
+      class AddressKanji < Stripe::RequestParams
+        # City or ward.
+        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
+        # Block or building number.
+        attr_accessor :line1
+        # Building details.
+        attr_accessor :line2
+        # Postal code.
+        attr_accessor :postal_code
+        # Prefecture.
+        attr_accessor :state
+        # Town or cho-me.
+        attr_accessor :town
+
+        def initialize(
+          city: nil,
+          country: nil,
+          line1: nil,
+          line2: nil,
+          postal_code: nil,
+          state: nil,
+          town: nil
+        )
+          @city = city
+          @country = country
+          @line1 = line1
+          @line2 = line2
+          @postal_code = postal_code
+          @state = state
+          @town = town
+        end
+      end
+      # The full address of the location. You can't change the location's `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location.
+      attr_accessor :address
+      # The Kana variation of the full address of the location (Japan only).
+      attr_accessor :address_kana
+      # The Kanji variation of the full address of the location (Japan only).
+      attr_accessor :address_kanji
+      # The ID of a configuration that will be used to customize all readers in this location.
+      attr_accessor :configuration_overrides
+      # A name for the location.
+      attr_accessor :display_name
+      # The Kana variation of the name for the location (Japan only).
+      attr_accessor :display_name_kana
+      # The Kanji variation of the name for the location (Japan only).
+      attr_accessor :display_name_kanji
+      # 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`.
+      attr_accessor :metadata
+      # The phone number for the location.
+      attr_accessor :phone
+
+      def initialize(
+        address: nil,
+        address_kana: nil,
+        address_kanji: nil,
+        configuration_overrides: nil,
+        display_name: nil,
+        display_name_kana: nil,
+        display_name_kanji: nil,
+        expand: nil,
+        metadata: nil,
+        phone: nil
+      )
+        @address = address
+        @address_kana = address_kana
+        @address_kanji = address_kanji
+        @configuration_overrides = configuration_overrides
+        @display_name = display_name
+        @display_name_kana = display_name_kana
+        @display_name_kanji = display_name_kanji
+        @expand = expand
+        @metadata = metadata
+        @phone = phone
+      end
+    end
+  end
+end

data/lib/stripe/params/terminal/reader_cancel_action_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderCancelActionParams < 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/terminal/reader_collect_inputs_params.rb

@@ -0,0 +1,96 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderCollectInputsParams < Stripe::RequestParams
+      class Input < Stripe::RequestParams
+        class CustomText < Stripe::RequestParams
+          # The description which will be displayed when collecting this input
+          attr_accessor :description
+          # The skip button text
+          attr_accessor :skip_button
+          # The submit button text
+          attr_accessor :submit_button
+          # The title which will be displayed when collecting this input
+          attr_accessor :title
+
+          def initialize(description: nil, skip_button: nil, submit_button: nil, title: nil)
+            @description = description
+            @skip_button = skip_button
+            @submit_button = submit_button
+            @title = title
+          end
+        end
+
+        class Selection < Stripe::RequestParams
+          class Choice < Stripe::RequestParams
+            # The unique identifier for this choice
+            attr_accessor :id
+            # The style of the button which will be shown for this choice
+            attr_accessor :style
+            # The text which will be shown on the button for this choice
+            attr_accessor :text
+
+            def initialize(id: nil, style: nil, text: nil)
+              @id = id
+              @style = style
+              @text = text
+            end
+          end
+          # List of choices for the `selection` input
+          attr_accessor :choices
+
+          def initialize(choices: nil)
+            @choices = choices
+          end
+        end
+
+        class Toggle < Stripe::RequestParams
+          # The default value of the toggle
+          attr_accessor :default_value
+          # The description which will be displayed for the toggle
+          attr_accessor :description
+          # The title which will be displayed for the toggle
+          attr_accessor :title
+
+          def initialize(default_value: nil, description: nil, title: nil)
+            @default_value = default_value
+            @description = description
+            @title = title
+          end
+        end
+        # Customize the text which will be displayed while collecting this input
+        attr_accessor :custom_text
+        # Indicate that this input is required, disabling the skip button
+        attr_accessor :required
+        # Options for the `selection` input
+        attr_accessor :selection
+        # List of toggles to be displayed and customization for the toggles
+        attr_accessor :toggles
+        # The type of input to collect
+        attr_accessor :type
+
+        def initialize(custom_text: nil, required: nil, selection: nil, toggles: nil, type: nil)
+          @custom_text = custom_text
+          @required = required
+          @selection = selection
+          @toggles = toggles
+          @type = type
+        end
+      end
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # List of inputs to be collected using the Reader
+      attr_accessor :inputs
+      # 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
+
+      def initialize(expand: nil, inputs: nil, metadata: nil)
+        @expand = expand
+        @inputs = inputs
+        @metadata = metadata
+      end
+    end
+  end
+end

data/lib/stripe/params/terminal/reader_collect_payment_method_params.rb

@@ -0,0 +1,51 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderCollectPaymentMethodParams < Stripe::RequestParams
+      class CollectConfig < Stripe::RequestParams
+        class Tipping < Stripe::RequestParams
+          # Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).
+          attr_accessor :amount_eligible
+
+          def initialize(amount_eligible: nil)
+            @amount_eligible = amount_eligible
+          end
+        end
+        # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
+        attr_accessor :allow_redisplay
+        # Enables cancel button on transaction screens.
+        attr_accessor :enable_customer_cancellation
+        # Override showing a tipping selection screen on this transaction.
+        attr_accessor :skip_tipping
+        # Tipping configuration for this transaction.
+        attr_accessor :tipping
+
+        def initialize(
+          allow_redisplay: nil,
+          enable_customer_cancellation: nil,
+          skip_tipping: nil,
+          tipping: nil
+        )
+          @allow_redisplay = allow_redisplay
+          @enable_customer_cancellation = enable_customer_cancellation
+          @skip_tipping = skip_tipping
+          @tipping = tipping
+        end
+      end
+      # Configuration overrides.
+      attr_accessor :collect_config
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # PaymentIntent ID.
+      attr_accessor :payment_intent
+
+      def initialize(collect_config: nil, expand: nil, payment_intent: nil)
+        @collect_config = collect_config
+        @expand = expand
+        @payment_intent = payment_intent
+      end
+    end
+  end
+end

data/lib/stripe/params/terminal/reader_confirm_payment_intent_params.rb

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderConfirmPaymentIntentParams < Stripe::RequestParams
+      class ConfirmConfig < Stripe::RequestParams
+        # The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
+        attr_accessor :return_url
+
+        def initialize(return_url: nil)
+          @return_url = return_url
+        end
+      end
+      # Configuration overrides.
+      attr_accessor :confirm_config
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # PaymentIntent ID.
+      attr_accessor :payment_intent
+
+      def initialize(confirm_config: nil, expand: nil, payment_intent: nil)
+        @confirm_config = confirm_config
+        @expand = expand
+        @payment_intent = payment_intent
+      end
+    end
+  end
+end

data/lib/stripe/params/terminal/reader_create_params.rb

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderCreateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.
+      attr_accessor :label
+      # The location to assign the reader to.
+      attr_accessor :location
+      # 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
+      # A code generated by the reader used for registering to an account.
+      attr_accessor :registration_code
+
+      def initialize(expand: nil, label: nil, location: nil, metadata: nil, registration_code: nil)
+        @expand = expand
+        @label = label
+        @location = location
+        @metadata = metadata
+        @registration_code = registration_code
+      end
+    end
+  end
+end

data/lib/stripe/params/terminal/reader_delete_params.rb

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderDeleteParams < Stripe::RequestParams; end
+  end
+end

data/lib/stripe/params/terminal/reader_list_params.rb

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderListParams < Stripe::RequestParams
+      # Filters readers by device type
+      attr_accessor :device_type
+      # 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 location ID to filter the response list to only readers at the specific location
+      attr_accessor :location
+      # Filters readers by serial number
+      attr_accessor :serial_number
+      # 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
+      # A status filter to filter readers to only offline or online readers
+      attr_accessor :status
+
+      def initialize(
+        device_type: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        location: nil,
+        serial_number: nil,
+        starting_after: nil,
+        status: nil
+      )
+        @device_type = device_type
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @location = location
+        @serial_number = serial_number
+        @starting_after = starting_after
+        @status = status
+      end
+    end
+  end
+end