stripe 15.4.0.pre.beta.2 → 15.4.0

data/rbi/stripe/resources/terminal/connection_token.rbi

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Terminal
+    # A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
+    #
+    # Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)
+    class ConnectionToken < APIResource
+      # The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).
+      sig { returns(String) }
+      attr_reader :location
+      # String representing the object's type. Objects of the same type share the same value.
+      sig { returns(String) }
+      attr_reader :object
+      # Your application should pass this token to the Stripe Terminal SDK.
+      sig { returns(String) }
+      attr_reader :secret
+      class CreateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :expand
+        # The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).
+        sig { returns(T.nilable(String)) }
+        attr_accessor :location
+        sig { params(expand: T.nilable(T::Array[String]), location: T.nilable(String)).void }
+        def initialize(expand: nil, location: nil); end
+      end
+      # To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.
+      sig {
+        params(params: T.any(::Stripe::Terminal::ConnectionToken::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::ConnectionToken)
+       }
+      def self.create(params = {}, opts = {}); end
+    end
+  end
+end

data/rbi/stripe/resources/terminal/location.rbi

@@ -0,0 +1,222 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Terminal
+    # A Location represents a grouping of readers.
+    #
+    # Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)
+    class Location < APIResource
+      class Address < Stripe::StripeObject
+        # City, district, suburb, town, or village.
+        sig { returns(T.nilable(String)) }
+        attr_reader :city
+        # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+        sig { returns(T.nilable(String)) }
+        attr_reader :country
+        # Address line 1 (e.g., street, PO Box, or company name).
+        sig { returns(T.nilable(String)) }
+        attr_reader :line1
+        # Address line 2 (e.g., apartment, suite, unit, or building).
+        sig { returns(T.nilable(String)) }
+        attr_reader :line2
+        # ZIP or postal code.
+        sig { returns(T.nilable(String)) }
+        attr_reader :postal_code
+        # State, county, province, or region.
+        sig { returns(T.nilable(String)) }
+        attr_reader :state
+      end
+      # Attribute for field address
+      sig { returns(Address) }
+      attr_reader :address
+      # The ID of a configuration that will be used to customize all readers in this location.
+      sig { returns(String) }
+      attr_reader :configuration_overrides
+      # The display name of the location.
+      sig { returns(String) }
+      attr_reader :display_name
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_reader :id
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      sig { returns(T::Boolean) }
+      attr_reader :livemode
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+      sig { returns(T::Hash[String, String]) }
+      attr_reader :metadata
+      # String representing the object's type. Objects of the same type share the same value.
+      sig { returns(String) }
+      attr_reader :object
+      # Always true for a deleted object
+      sig { returns(T::Boolean) }
+      attr_reader :deleted
+      class DeleteParams < Stripe::RequestParams; end
+      class UpdateParams < Stripe::RequestParams
+        class Address < Stripe::RequestParams
+          # City, district, suburb, town, or village.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :city
+          # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          sig { returns(T.nilable(String)) }
+          attr_accessor :country
+          # Address line 1 (e.g., street, PO Box, or company name).
+          sig { returns(T.nilable(String)) }
+          attr_accessor :line1
+          # Address line 2 (e.g., apartment, suite, unit, or building).
+          sig { returns(T.nilable(String)) }
+          attr_accessor :line2
+          # ZIP or postal code.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :postal_code
+          # State, county, province, or region.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :state
+          sig {
+            params(city: T.nilable(String), country: T.nilable(String), line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
+           }
+          def initialize(
+            city: nil,
+            country: nil,
+            line1: nil,
+            line2: nil,
+            postal_code: nil,
+            state: nil
+          ); 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.
+        sig { returns(T.nilable(::Stripe::Terminal::Location::UpdateParams::Address)) }
+        attr_accessor :address
+        # The ID of a configuration that will be used to customize all readers in this location.
+        sig { returns(T.nilable(T.nilable(String))) }
+        attr_accessor :configuration_overrides
+        # A name for the location.
+        sig { returns(T.nilable(T.nilable(String))) }
+        attr_accessor :display_name
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T.nilable(T::Array[String])) }
+        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`.
+        sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
+        attr_accessor :metadata
+        sig {
+          params(address: T.nilable(::Stripe::Terminal::Location::UpdateParams::Address), configuration_overrides: T.nilable(T.nilable(String)), display_name: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
+         }
+        def initialize(
+          address: nil,
+          configuration_overrides: nil,
+          display_name: nil,
+          expand: nil,
+          metadata: nil
+        ); end
+      end
+      class ListParams < 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.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T.nilable(T::Array[String])) }
+        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.
+        sig { returns(T.nilable(Integer)) }
+        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.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :starting_after
+        sig {
+          params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
+         }
+        def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
+      end
+      class CreateParams < Stripe::RequestParams
+        class Address < Stripe::RequestParams
+          # City, district, suburb, town, or village.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :city
+          # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          sig { returns(String) }
+          attr_accessor :country
+          # Address line 1 (e.g., street, PO Box, or company name).
+          sig { returns(T.nilable(String)) }
+          attr_accessor :line1
+          # Address line 2 (e.g., apartment, suite, unit, or building).
+          sig { returns(T.nilable(String)) }
+          attr_accessor :line2
+          # ZIP or postal code.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :postal_code
+          # State, county, province, or region.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :state
+          sig {
+            params(city: T.nilable(String), country: String, line1: T.nilable(String), line2: T.nilable(String), postal_code: T.nilable(String), state: T.nilable(String)).void
+           }
+          def initialize(
+            city: nil,
+            country: nil,
+            line1: nil,
+            line2: nil,
+            postal_code: nil,
+            state: nil
+          ); end
+        end
+        # The full address of the location.
+        sig { returns(::Stripe::Terminal::Location::CreateParams::Address) }
+        attr_accessor :address
+        # The ID of a configuration that will be used to customize all readers in this location.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :configuration_overrides
+        # A name for the location. Maximum length is 1000 characters.
+        sig { returns(String) }
+        attr_accessor :display_name
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T.nilable(T::Array[String])) }
+        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`.
+        sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
+        attr_accessor :metadata
+        sig {
+          params(address: ::Stripe::Terminal::Location::CreateParams::Address, configuration_overrides: T.nilable(String), display_name: String, expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
+         }
+        def initialize(
+          address: nil,
+          configuration_overrides: nil,
+          display_name: nil,
+          expand: nil,
+          metadata: nil
+        ); end
+      end
+      # Creates a new Location object.
+      # For further details, including which address fields are required in each country, see the [Manage locations](https://docs.stripe.com/docs/terminal/fleet/locations) guide.
+      sig {
+        params(params: T.any(::Stripe::Terminal::Location::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
+       }
+      def self.create(params = {}, opts = {}); end
+
+      # Deletes a Location object.
+      sig {
+        params(location: String, params: T.any(::Stripe::Terminal::Location::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
+       }
+      def self.delete(location, params = {}, opts = {}); end
+
+      # Deletes a Location object.
+      sig {
+        params(params: T.any(::Stripe::Terminal::Location::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
+       }
+      def delete(params = {}, opts = {}); end
+
+      # Returns a list of Location objects.
+      sig {
+        params(params: T.any(::Stripe::Terminal::Location::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+       }
+      def self.list(params = {}, opts = {}); end
+
+      # Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+      sig {
+        params(location: String, params: T.any(::Stripe::Terminal::Location::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location)
+       }
+      def self.update(location, params = {}, opts = {}); end
+    end
+  end
+end