authlete_ruby_sdk 0.0.1.beta

data/lib/authlete/models/components/device_complete_request.rb

@@ -0,0 +1,137 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+
+      class DeviceCompleteRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # A user code.
+        # 
+        field :user_code, ::String, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('userCode'), required: true }, 'form': { 'field_name': 'userCode' } }
+        # The result of the end-user authentication and authorization. One of the following. Details are
+        # described in the description.
+        # 
+        field :result, Models::Components::DeviceCompleteRequestResult, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('result'), required: true, 'decoder': Utils.enum_from_string(Models::Components::DeviceCompleteRequestResult, false) }, 'form': { 'field_name': 'result' } }
+        # The subject (= unique identifier) of the end-user.
+        # 
+        field :subject, ::String, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('subject'), required: true }, 'form': { 'field_name': 'subject' } }
+        # The value of the sub claim that should be used in the ID token.
+        # 
+        field :sub, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('sub') }, 'form': { 'field_name': 'sub' } }
+        # The time at which the end-user was authenticated. Its value is the number of seconds from `1970-01-01`.
+        # 
+        field :auth_time, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('authTime') }, 'form': { 'field_name': 'authTime' } }
+        # The reference of the authentication context class which the end-user authentication satisfied.
+        # 
+        field :acr, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('acr') }, 'form': { 'field_name': 'acr' } }
+        # Additional claims which will be embedded in the ID token.
+        # 
+        field :claims, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('claims') }, 'form': { 'field_name': 'claims' } }
+        # The extra properties associated with the access token.
+        # 
+        field :properties, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::Property)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('properties') }, 'form': { 'field_name': 'properties', 'json': true } }
+        # Scopes to replace the scopes specified in the original device authorization request with.
+        # When nothing is specified for this parameter, replacement is not performed.
+        # 
+        field :scopes, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('scopes') }, 'form': { 'field_name': 'scopes' } }
+        # The description of the error. If this optional request parameter is given, its value is used as
+        # the value of the `error_description` property, but it is used only when the result is not `AUTHORIZED`.
+        # To comply with the specification strictly, the description must not include characters outside
+        # the set `%x20-21 / %x23-5B / %x5D-7E`.
+        # 
+        field :error_description, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('errorDescription') }, 'form': { 'field_name': 'errorDescription' } }
+        # The URI of a document which describes the error in detail. This corresponds to the `error_uri`
+        # property in the response to the client.
+        # 
+        field :error_uri, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('errorUri') }, 'form': { 'field_name': 'errorUri' } }
+        # JSON that represents additional JWS header parameters for ID tokens.
+        # 
+        field :idt_header_params, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('idtHeaderParams') }, 'form': { 'field_name': 'idtHeaderParams' } }
+        # the claims that the user has consented for the client application
+        # to know.
+        # 
+        field :consented_claims, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('consentedClaims') }, 'form': { 'field_name': 'consentedClaims' } }
+        # Additional claims that are added to the payload part of the JWT access token.
+        # 
+        field :jwt_at_claims, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('jwtAtClaims') }, 'form': { 'field_name': 'jwtAtClaims' } }
+        # The duration (in seconds) of the access token that may be issued as a result of the Authlete
+        # API call.
+        # 
+        # When this request parameter holds a positive integer, it is used as the duration of the access
+        # token in. In other cases, this request parameter is ignored.
+        # 
+        field :access_token_duration, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('accessTokenDuration') }, 'form': { 'field_name': 'accessTokenDuration' } }
+        # The duration (in seconds) of the refresh token that may be issued as a result of the Authlete
+        # API call.
+        # 
+        # When this request parameter holds a positive integer, it is used as the duration of the refresh
+        # token in. In other cases, this request parameter is ignored.
+        # 
+        field :refresh_token_duration, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('refreshTokenDuration') }, 'form': { 'field_name': 'refreshTokenDuration' } }
+        # The type of the `aud` claim of the ID token being issued. Valid values are as follows.
+        # 
+        # | Value | Description |
+        # | ----- | ----------- |
+        # | "array" | The type of the aud claim is always an array of strings. |
+        # | "string" | The type of the aud claim is always a single string. |
+        # | null | The type of the aud claim remains the same as before. |
+        # 
+        # This request parameter takes precedence over the `idTokenAudType` property of the service.
+        # 
+        field :id_token_aud_type, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('idTokenAudType') }, 'form': { 'field_name': 'idTokenAudType' } }
+
+        sig { params(user_code: ::String, result: Models::Components::DeviceCompleteRequestResult, subject: ::String, sub: T.nilable(::String), auth_time: T.nilable(::Integer), acr: T.nilable(::String), claims: T.nilable(::String), properties: T.nilable(T::Array[Models::Components::Property]), scopes: T.nilable(T::Array[::String]), error_description: T.nilable(::String), error_uri: T.nilable(::String), idt_header_params: T.nilable(::String), consented_claims: T.nilable(T::Array[::String]), jwt_at_claims: T.nilable(::String), access_token_duration: T.nilable(::Integer), refresh_token_duration: T.nilable(::Integer), id_token_aud_type: T.nilable(::String)).void }
+        def initialize(user_code:, result:, subject:, sub: nil, auth_time: nil, acr: nil, claims: nil, properties: nil, scopes: nil, error_description: nil, error_uri: nil, idt_header_params: nil, consented_claims: nil, jwt_at_claims: nil, access_token_duration: nil, refresh_token_duration: nil, id_token_aud_type: nil)
+          @user_code = user_code
+          @result = result
+          @subject = subject
+          @sub = sub
+          @auth_time = auth_time
+          @acr = acr
+          @claims = claims
+          @properties = properties
+          @scopes = scopes
+          @error_description = error_description
+          @error_uri = error_uri
+          @idt_header_params = idt_header_params
+          @consented_claims = consented_claims
+          @jwt_at_claims = jwt_at_claims
+          @access_token_duration = access_token_duration
+          @refresh_token_duration = refresh_token_duration
+          @id_token_aud_type = id_token_aud_type
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @user_code == other.user_code
+          return false unless @result == other.result
+          return false unless @subject == other.subject
+          return false unless @sub == other.sub
+          return false unless @auth_time == other.auth_time
+          return false unless @acr == other.acr
+          return false unless @claims == other.claims
+          return false unless @properties == other.properties
+          return false unless @scopes == other.scopes
+          return false unless @error_description == other.error_description
+          return false unless @error_uri == other.error_uri
+          return false unless @idt_header_params == other.idt_header_params
+          return false unless @consented_claims == other.consented_claims
+          return false unless @jwt_at_claims == other.jwt_at_claims
+          return false unless @access_token_duration == other.access_token_duration
+          return false unless @refresh_token_duration == other.refresh_token_duration
+          return false unless @id_token_aud_type == other.id_token_aud_type
+          true
+        end
+      end
+    end
+  end
+end

data/lib/authlete/models/components/device_complete_request.rbi

@@ -0,0 +1,45 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::DeviceCompleteRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::DeviceCompleteRequest
+  def user_code(); end
+  def user_code=(str_); end
+  def result(); end
+  def result=(str_); end
+  def subject(); end
+  def subject=(str_); end
+  def sub(); end
+  def sub=(str_); end
+  def auth_time(); end
+  def auth_time=(str_); end
+  def acr(); end
+  def acr=(str_); end
+  def claims(); end
+  def claims=(str_); end
+  def properties(); end
+  def properties=(str_); end
+  def scopes(); end
+  def scopes=(str_); end
+  def error_description(); end
+  def error_description=(str_); end
+  def error_uri(); end
+  def error_uri=(str_); end
+  def idt_header_params(); end
+  def idt_header_params=(str_); end
+  def consented_claims(); end
+  def consented_claims=(str_); end
+  def jwt_at_claims(); end
+  def jwt_at_claims=(str_); end
+  def access_token_duration(); end
+  def access_token_duration=(str_); end
+  def refresh_token_duration(); end
+  def refresh_token_duration=(str_); end
+  def id_token_aud_type(); end
+  def id_token_aud_type=(str_); end
+end

data/lib/authlete/models/components/device_complete_request_result.rb

@@ -0,0 +1,25 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+      # DeviceCompleteRequestResult - The result of the end-user authentication and authorization. One of the following. Details are
+      # described in the description.
+      # 
+      class DeviceCompleteRequestResult < T::Enum
+
+
+        enums do
+          TRANSACTION_FAILED = new('TRANSACTION_FAILED')
+          ACCESS_DENIED = new('ACCESS_DENIED')
+          AUTHORIZED = new('AUTHORIZED')
+        end
+      end
+    end
+  end
+end

data/lib/authlete/models/components/device_complete_request_result.rbi

@@ -0,0 +1,11 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::DeviceCompleteRequestResult
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::DeviceCompleteRequestResult
+end

data/lib/authlete/models/components/device_complete_response.rb

@@ -0,0 +1,42 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+
+      class DeviceCompleteResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The code which represents the result of the API call.
+        field :result_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('resultCode') } }
+        # A short message which explains the result of the API call.
+        field :result_message, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('resultMessage') } }
+        # The next action that the authorization server implementation should take.
+        # 
+        field :action, Crystalline::Nilable.new(Models::Components::DeviceCompleteResponseAction), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('action'), 'decoder': Utils.enum_from_string(Models::Components::DeviceCompleteResponseAction, true) } }
+
+        sig { params(result_code: T.nilable(::String), result_message: T.nilable(::String), action: T.nilable(Models::Components::DeviceCompleteResponseAction)).void }
+        def initialize(result_code: nil, result_message: nil, action: nil)
+          @result_code = result_code
+          @result_message = result_message
+          @action = action
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @result_code == other.result_code
+          return false unless @result_message == other.result_message
+          return false unless @action == other.action
+          true
+        end
+      end
+    end
+  end
+end

data/lib/authlete/models/components/device_complete_response.rbi

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::DeviceCompleteResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::DeviceCompleteResponse
+  def result_code(); end
+  def result_code=(str_); end
+  def result_message(); end
+  def result_message=(str_); end
+  def action(); end
+  def action=(str_); end
+end

data/lib/authlete/models/components/device_complete_response_action.rb

@@ -0,0 +1,26 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+      # DeviceCompleteResponseAction - The next action that the authorization server implementation should take.
+      # 
+      class DeviceCompleteResponseAction < T::Enum
+
+
+        enums do
+          SERVER_ERROR = new('SERVER_ERROR')
+          USER_CODE_NOT_EXIST = new('USER_CODE_NOT_EXIST')
+          USER_CODE_EXPIRED = new('USER_CODE_EXPIRED')
+          INVALID_REQUEST = new('INVALID_REQUEST')
+          SUCCESS = new('SUCCESS')
+        end
+      end
+    end
+  end
+end

data/lib/authlete/models/components/device_complete_response_action.rbi

@@ -0,0 +1,11 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::DeviceCompleteResponseAction
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::DeviceCompleteResponseAction
+end

data/lib/authlete/models/components/device_verification_request.rb

@@ -0,0 +1,34 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+
+      class DeviceVerificationRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # A user code.
+        # 
+        field :user_code, ::String, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('userCode'), required: true }, 'form': { 'field_name': 'userCode' } }
+
+        sig { params(user_code: ::String).void }
+        def initialize(user_code:)
+          @user_code = user_code
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @user_code == other.user_code
+          true
+        end
+      end
+    end
+  end
+end

data/lib/authlete/models/components/device_verification_request.rbi

@@ -0,0 +1,13 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::DeviceVerificationRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::DeviceVerificationRequest
+  def user_code(); end
+  def user_code=(str_); end
+end

data/lib/authlete/models/components/device_verification_response.rb

@@ -0,0 +1,188 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+
+      class DeviceVerificationResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The code which represents the result of the API call.
+        field :result_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('resultCode') } }
+        # A short message which explains the result of the API call.
+        field :result_message, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('resultMessage') } }
+        # The next action that the authorization server implementation should take.
+        field :action, Crystalline::Nilable.new(Models::Components::DeviceVerificationResponseAction), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('action'), 'decoder': Utils.enum_from_string(Models::Components::DeviceVerificationResponseAction, true) } }
+        # The client ID of the client application to which the user code has been issued.
+        # 
+        field :client_id, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('clientId') } }
+        # The client ID alias of the client application to which the user code has been issued.
+        # 
+        field :client_id_alias, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('clientIdAlias') } }
+        # `true` if the value of the `client_id` request parameter included in the device authorization
+        # request is the client ID alias. `false` if the value is the original numeric client ID.
+        # 
+        field :client_id_alias_used, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('clientIdAliasUsed') } }
+        # The name of the client application to which the user code has been issued.
+        # 
+        field :client_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('clientName') } }
+        # The scopes requested by the device authorization request.
+        # 
+        # Note that `description` property and `descriptions` property of each scope object in
+        # the array contained in this property is always null even if descriptions of the scopes
+        # are registered.
+        # 
+        field :scopes, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::Scope)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('scopes') } }
+        # The names of the claims which were requested indirectly via some special scopes.
+        # See [5.4. Requesting Claims using Scope Values](https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims)
+        # in OpenID Connect Core 1.0 for details.
+        # 
+        # This property is always `null` if the `scope` request parameter of the device authorization
+        # request does not include the `openid` scope even if special scopes (such as `profile`)
+        # are included in the request (unless the openid scope is included in the default set
+        # of scopes which is used when the `scope` request parameter is omitted).
+        # 
+        field :claim_names, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('claimNames') } }
+        # The list of ACR values requested by the device authorization request.
+        # 
+        field :acrs, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('acrs') } }
+        # The resources specified by the `resource` request parameters or by the `resource` property
+        # in the request object. If both are given, the values in the request object should be
+        # set. See "Resource Indicators for OAuth 2.0" for details.
+        # 
+        field :resources, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('resources') } }
+        # The authorization details. This represents the value of the `authorization_details`
+        # request parameter in the preceding device authorization request which is defined in
+        # "OAuth 2.0 Rich Authorization Requests".
+        # 
+        field :authorization_details, Crystalline::Nilable.new(Models::Components::AuthzDetails), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('authorizationDetails') } }
+        # The attributes of this service that the client application belongs to.
+        # 
+        field :service_attributes, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::Pair)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('serviceAttributes') } }
+        # The attributes of the client.
+        # 
+        field :client_attributes, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::Pair)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('clientAttributes') } }
+        # The dynamic scopes which the client application requested by the scope request parameter.
+        # 
+        field :dynamic_scopes, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::DynamicScope)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('dynamicScopes') } }
+        # Get the date in milliseconds since the Unix epoch (1970-01-01) at which the user code will expire.
+        # 
+        field :expires_at, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('expiresAt') } }
+        # The grant management action of the device authorization request.
+        # 
+        # The `grant_management_action` request parameter is defined in
+        # [Grant Management for OAuth 2.0](https://openid.net/specs/fapi-grant-management.html).
+        # 
+        field :gm_action, Crystalline::Nilable.new(Models::Components::GrantManagementAction), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('gmAction'), 'decoder': Utils.enum_from_string(Models::Components::GrantManagementAction, true) } }
+        # the value of the `grant_id` request parameter of the device authorization request.
+        # 
+        # The `grant_id` request parameter is defined in
+        # [Grant Management for OAuth 2.0](https://openid.net/specs/fapi-grant-management.html)
+        # , which is supported by Authlete 2.3 and newer versions.
+        # 
+        field :grant_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('grantId') } }
+
+        field :grant, Crystalline::Nilable.new(Models::Components::Grant), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('grant') } }
+        # The subject identifying the user who has given the grant identified
+        # by the `grant\_id` request parameter of the device authorization
+        # request.
+        # Authlete 2.3 and newer versions support [Grant Management
+        # for OAuth 2.0](https://openid.net/specs/fapi-grant-management.html). An authorization request may contain a `grant\_id`
+        # request parameter which is defined in the specification. If the value of
+        # the request parameter is valid, {@link #getGrantSubject()} will return
+        # the subject of the user who has given the grant to the client application.
+        # Authorization server implementations may use the value returned from
+        # {@link #getGrantSubject()} in order to determine the user to authenticate.
+        # The user your system will authenticate during the authorization process
+        # (or has already authenticated) may be different from the user of the
+        # grant. The first implementer's draft of "Grant Management for OAuth 2.0"
+        # does not mention anything about the case, so the behavior in the case is
+        # left to implementations. Authlete will not perform the grant management
+        # action when the `subject` passed to Authlete does not match the
+        # user of the grant.
+        # 
+        field :grant_subject, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('grantSubject') } }
+        # The entity ID of the client.
+        # 
+        field :client_entity_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('clientEntityId') } }
+        # Flag which indicates whether the entity ID of the client was used when the request for the access token was made.
+        # 
+        field :client_entity_id_used, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('clientEntityIdUsed') } }
+        # The location of the client's metadata document that was used to resolve client metadata.
+        # 
+        # This property is set when client metadata was retrieved via the [OAuth Client ID Metadata Document](https://datatracker.ietf.org/doc/draft-ietf-oauth-client-id-metadata-document/) (CIMD) mechanism.
+        # 
+        field :metadata_document_location, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('metadataDocumentLocation') } }
+        # Flag indicating whether a metadata document was used to resolve client metadata for this request.
+        # 
+        # When `true`, the client metadata was retrieved via the CIMD mechanism rather than from the Authlete database.
+        # 
+        field :metadata_document_used, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('metadataDocumentUsed') } }
+
+        sig { params(result_code: T.nilable(::String), result_message: T.nilable(::String), action: T.nilable(Models::Components::DeviceVerificationResponseAction), client_id: T.nilable(::Integer), client_id_alias: T.nilable(::String), client_id_alias_used: T.nilable(T::Boolean), client_name: T.nilable(::String), scopes: T.nilable(T::Array[Models::Components::Scope]), claim_names: T.nilable(T::Array[::String]), acrs: T.nilable(T::Array[::String]), resources: T.nilable(T::Array[::String]), authorization_details: T.nilable(Models::Components::AuthzDetails), service_attributes: T.nilable(T::Array[Models::Components::Pair]), client_attributes: T.nilable(T::Array[Models::Components::Pair]), dynamic_scopes: T.nilable(T::Array[Models::Components::DynamicScope]), expires_at: T.nilable(::Integer), gm_action: T.nilable(Models::Components::GrantManagementAction), grant_id: T.nilable(::String), grant: T.nilable(Models::Components::Grant), grant_subject: T.nilable(::String), client_entity_id: T.nilable(::String), client_entity_id_used: T.nilable(T::Boolean), metadata_document_location: T.nilable(::String), metadata_document_used: T.nilable(T::Boolean)).void }
+        def initialize(result_code: nil, result_message: nil, action: nil, client_id: nil, client_id_alias: nil, client_id_alias_used: nil, client_name: nil, scopes: nil, claim_names: nil, acrs: nil, resources: nil, authorization_details: nil, service_attributes: nil, client_attributes: nil, dynamic_scopes: nil, expires_at: nil, gm_action: nil, grant_id: nil, grant: nil, grant_subject: nil, client_entity_id: nil, client_entity_id_used: nil, metadata_document_location: nil, metadata_document_used: nil)
+          @result_code = result_code
+          @result_message = result_message
+          @action = action
+          @client_id = client_id
+          @client_id_alias = client_id_alias
+          @client_id_alias_used = client_id_alias_used
+          @client_name = client_name
+          @scopes = scopes
+          @claim_names = claim_names
+          @acrs = acrs
+          @resources = resources
+          @authorization_details = authorization_details
+          @service_attributes = service_attributes
+          @client_attributes = client_attributes
+          @dynamic_scopes = dynamic_scopes
+          @expires_at = expires_at
+          @gm_action = gm_action
+          @grant_id = grant_id
+          @grant = grant
+          @grant_subject = grant_subject
+          @client_entity_id = client_entity_id
+          @client_entity_id_used = client_entity_id_used
+          @metadata_document_location = metadata_document_location
+          @metadata_document_used = metadata_document_used
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @result_code == other.result_code
+          return false unless @result_message == other.result_message
+          return false unless @action == other.action
+          return false unless @client_id == other.client_id
+          return false unless @client_id_alias == other.client_id_alias
+          return false unless @client_id_alias_used == other.client_id_alias_used
+          return false unless @client_name == other.client_name
+          return false unless @scopes == other.scopes
+          return false unless @claim_names == other.claim_names
+          return false unless @acrs == other.acrs
+          return false unless @resources == other.resources
+          return false unless @authorization_details == other.authorization_details
+          return false unless @service_attributes == other.service_attributes
+          return false unless @client_attributes == other.client_attributes
+          return false unless @dynamic_scopes == other.dynamic_scopes
+          return false unless @expires_at == other.expires_at
+          return false unless @gm_action == other.gm_action
+          return false unless @grant_id == other.grant_id
+          return false unless @grant == other.grant
+          return false unless @grant_subject == other.grant_subject
+          return false unless @client_entity_id == other.client_entity_id
+          return false unless @client_entity_id_used == other.client_entity_id_used
+          return false unless @metadata_document_location == other.metadata_document_location
+          return false unless @metadata_document_used == other.metadata_document_used
+          true
+        end
+      end
+    end
+  end
+end

data/lib/authlete/models/components/device_verification_response.rbi

@@ -0,0 +1,59 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::DeviceVerificationResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::DeviceVerificationResponse
+  def result_code(); end
+  def result_code=(str_); end
+  def result_message(); end
+  def result_message=(str_); end
+  def action(); end
+  def action=(str_); end
+  def client_id(); end
+  def client_id=(str_); end
+  def client_id_alias(); end
+  def client_id_alias=(str_); end
+  def client_id_alias_used(); end
+  def client_id_alias_used=(str_); end
+  def client_name(); end
+  def client_name=(str_); end
+  def scopes(); end
+  def scopes=(str_); end
+  def claim_names(); end
+  def claim_names=(str_); end
+  def acrs(); end
+  def acrs=(str_); end
+  def resources(); end
+  def resources=(str_); end
+  def authorization_details(); end
+  def authorization_details=(str_); end
+  def service_attributes(); end
+  def service_attributes=(str_); end
+  def client_attributes(); end
+  def client_attributes=(str_); end
+  def dynamic_scopes(); end
+  def dynamic_scopes=(str_); end
+  def expires_at(); end
+  def expires_at=(str_); end
+  def gm_action(); end
+  def gm_action=(str_); end
+  def grant_id(); end
+  def grant_id=(str_); end
+  def grant(); end
+  def grant=(str_); end
+  def grant_subject(); end
+  def grant_subject=(str_); end
+  def client_entity_id(); end
+  def client_entity_id=(str_); end
+  def client_entity_id_used(); end
+  def client_entity_id_used=(str_); end
+  def metadata_document_location(); end
+  def metadata_document_location=(str_); end
+  def metadata_document_used(); end
+  def metadata_document_used=(str_); end
+end

data/lib/authlete/models/components/device_verification_response_action.rb

@@ -0,0 +1,24 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+      # DeviceVerificationResponseAction - The next action that the authorization server implementation should take.
+      class DeviceVerificationResponseAction < T::Enum
+
+
+        enums do
+          INTERNAL_SERVER_ERROR = new('INTERNAL_SERVER_ERROR')
+          NOT_EXIST = new('NOT_EXIST')
+          EXPIRED = new('EXPIRED')
+          VALID = new('VALID')
+        end
+      end
+    end
+  end
+end

data/lib/authlete/models/components/device_verification_response_action.rbi

@@ -0,0 +1,11 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::DeviceVerificationResponseAction
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::DeviceVerificationResponseAction
+end