authlete_ruby_test 0.0.1.beta

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

@@ -0,0 +1,82 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+
+      class IdtokenReissueRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The value of this parameter should be (a) the value of the
+        # "`jwtAccessToken`" parameter in a response from the
+        # `/auth/token` API when the value is available, or (b)
+        # the value of the "`accessToken`" parameter in the
+        # response from the `/auth/token` API when the value of
+        # the "`jwtAccessToken`" parameter is not available.
+        # 
+        field :access_token, ::String, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('accessToken'), required: true } }
+        # The value of this parameter should be the value of the
+        # "`refreshToken`" parameter in a response from the
+        # `/auth/token` API.
+        # 
+        field :refresh_token, ::String, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('refreshToken'), required: true } }
+        # The value that should be used as the value of the "`sub`"
+        # claim of the ID token.
+        # This parameter is optional. When omitted, the value of the subject
+        # associated with the access token is used.
+        # 
+        field :sub, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('sub') } }
+        # Additional claims that should be embedded in the payload part of
+        # the ID token. The format is a JSON object.
+        # This parameter is optional.
+        # 
+        field :claims, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('claims') } }
+        # Additional parameters that should be embedded in the JWS header of
+        # the ID token. The format is a JSON object.
+        # This parameter is optional.
+        # 
+        field :idt_header_params, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('idtHeaderParams') } }
+        # The type of the "`aud`" claim of the ID token being issued.
+        # Valid values of this parameter are as follows.
+        # > | Value | Description |
+        # > | --- | --- |
+        # > | "`array`" | The type of the `aud` claim becomes an array of strings. |
+        # > | "`string`" | The type of the `aud` claim becomes a single string. |
+        # This parameter is optional, and the default value on omission is
+        # "`array`".
+        # This parameter takes precedence over the `idTokenAudType` property
+        # of {@link Service} (cf. {@link Service#getIdTokenAudType()}).
+        # 
+        field :id_token_aud_type, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('idTokenAudType') } }
+
+        sig { params(access_token: ::String, refresh_token: ::String, sub: T.nilable(::String), claims: T.nilable(::String), idt_header_params: T.nilable(::String), id_token_aud_type: T.nilable(::String)).void }
+        def initialize(access_token:, refresh_token:, sub: nil, claims: nil, idt_header_params: nil, id_token_aud_type: nil)
+          @access_token = access_token
+          @refresh_token = refresh_token
+          @sub = sub
+          @claims = claims
+          @idt_header_params = idt_header_params
+          @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 @access_token == other.access_token
+          return false unless @refresh_token == other.refresh_token
+          return false unless @sub == other.sub
+          return false unless @claims == other.claims
+          return false unless @idt_header_params == other.idt_header_params
+          return false unless @id_token_aud_type == other.id_token_aud_type
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::IdtokenReissueRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::IdtokenReissueRequest
+  def access_token(); end
+  def access_token=(str_); end
+  def refresh_token(); end
+  def refresh_token=(str_); end
+  def sub(); end
+  def sub=(str_); end
+  def claims(); end
+  def claims=(str_); end
+  def idt_header_params(); end
+  def idt_header_params=(str_); end
+  def id_token_aud_type(); end
+  def id_token_aud_type=(str_); end
+end

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

@@ -0,0 +1,52 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+
+      class IdtokenReissueResponse
+        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 implementation of the token endpoint should take.
+        field :action, Crystalline::Nilable.new(Models::Components::IdtokenReissueResponseAction), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('action'), 'decoder': Utils.enum_from_string(Models::Components::IdtokenReissueResponseAction, true) } }
+        # The response content that can be used as the message body of the token response that should
+        # be returned from the token endpoint.
+        # 
+        field :response_content, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('responseContent') } }
+        # The reissued ID token
+        # 
+        field :id_token, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('idToken') } }
+
+        sig { params(result_code: T.nilable(::String), result_message: T.nilable(::String), action: T.nilable(Models::Components::IdtokenReissueResponseAction), response_content: T.nilable(::String), id_token: T.nilable(::String)).void }
+        def initialize(result_code: nil, result_message: nil, action: nil, response_content: nil, id_token: nil)
+          @result_code = result_code
+          @result_message = result_message
+          @action = action
+          @response_content = response_content
+          @id_token = id_token
+        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 @response_content == other.response_content
+          return false unless @id_token == other.id_token
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::IdtokenReissueResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::IdtokenReissueResponse
+  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 response_content(); end
+  def response_content=(str_); end
+  def id_token(); end
+  def id_token=(str_); end
+end

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

@@ -0,0 +1,23 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+      # IdtokenReissueResponseAction - The next action that the implementation of the token endpoint should take.
+      class IdtokenReissueResponseAction < T::Enum
+
+
+        enums do
+          OK = new('OK')
+          INTERNAL_SERVER_ERROR = new('INTERNAL_SERVER_ERROR')
+          CALLER_ERROR = new('CALLER_ERROR')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,166 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+
+      class IntrospectionRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # An access token to introspect.
+        field :token, ::String, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('token'), required: true }, 'form': { 'field_name': 'token' } }
+        # A string array listing names of scopes which the caller (= a protected resource endpoint of the
+        # service) requires. When the content type of the request from the service is `application/x-www-form-urlencoded`,
+        # the format of `scopes` is a space-separated list of scope names.
+        # 
+        # If this parameter is a non-empty array and if it contains a scope which is not covered by the
+        # access token,`action=FORBIDDEN` with `error=insufficient_scope` is returned from Authlete.
+        # 
+        field :scopes, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('scopes') }, 'form': { 'field_name': 'scopes' } }
+        # A subject (= a user account managed by the service) whom the caller (= a protected resource
+        # endpoint of the service) requires.
+        # 
+        # If this parameter is not `null` and if the value does not match the subject who is associated
+        # with the access token, `action=FORBIDDEN` with `error=invalid_request` is returned from Authlete.
+        # 
+        field :subject, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('subject') }, 'form': { 'field_name': 'subject' } }
+        # Client certificate in PEM format, used to validate binding against access tokens using the TLS
+        # client certificate confirmation method.
+        # 
+        field :client_certificate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('clientCertificate') }, 'form': { 'field_name': 'clientCertificate' } }
+        # `DPoP` header presented by the client during the request to the resource server.
+        # 
+        # The header contains a signed JWT which includes the public key that is paired with the private
+        # key used to sign the JWT. See [OAuth 2.0 Demonstration of Proof-of-Possession at the Application
+        # Layer (DPoP)](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-dpop) for details.
+        # 
+        field :dpop, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('dpop') }, 'form': { 'field_name': 'dpop' } }
+        # HTTP method of the request from the client to the protected resource endpoint. This field is
+        # used to validate the `DPoP` header.
+        # 
+        # See [OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-dpop)
+        # for details.
+        # 
+        field :htm, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('htm') }, 'form': { 'field_name': 'htm' } }
+        # URL of the protected resource endpoint. This field is used to validate the `DPoP` header.
+        # 
+        # See [OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-dpop)
+        # for details.
+        # 
+        field :htu, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('htu') }, 'form': { 'field_name': 'htu' } }
+        # The resources specified by the `resource` request parameters in the token request. 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') }, 'form': { 'field_name': 'resources' } }
+        # Authentication Context Class Reference values one of which the user authentication performed during the course
+        # of issuing the access token must satisfy.
+        # 
+        field :acr_values, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('acrValues') }, 'form': { 'field_name': 'acrValues' } }
+        # The maximum authentication age which is the maximum allowable elapsed time since the user authentication
+        # was performed during the course of issuing the access token.
+        # 
+        field :max_age, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('maxAge') }, 'form': { 'field_name': 'maxAge' } }
+        # HTTP Message Components required to be in the signature. If absent, defaults to [ "@method", "@target-uri", "authorization" ].
+        # 
+        field :required_components, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('requiredComponents') }, 'form': { 'field_name': 'requiredComponents' } }
+        # The full URL of the userinfo endpoint.
+        # 
+        field :uri, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('uri') }, 'form': { 'field_name': 'uri' } }
+        # The HTTP message body of the request, if present.
+        # 
+        field :message, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('message') }, 'form': { 'field_name': 'message' } }
+        # HTTP headers to be included in processing the signature. If this is a signed request, this must include the
+        # Signature and Signature-Input headers, as well as any additional headers covered by the signature.
+        # 
+        field :headers, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::Pair)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('headers') }, 'form': { 'field_name': 'headers', 'json': true } }
+        # The target URI of the resource request, including the query part, if any.
+        # 
+        # This parameter is used as the value of the @target-uri derived component for HTTP message signatures
+        # [RFC 9421 HTTP Message Signatures, Section 2.2.2. Target URI](https://www.rfc-editor.org/rfc/rfc9421.html#section-2.2.2)).
+        # Additionally, other derived components such as `@authority`, `@scheme`, `@path`, `@query` and
+        # `@query-param` are computed from this parameter.
+        # 
+        # When this parameter is omitted, the value of the `htu` parameter is used. The `htu` parameter
+        # represents the URL of the resource endpoint, which is identical to the target URI of the resource
+        # request as long as the request does not include a query component. Conversely, if the resource
+        # request includes a query component, the value of the `htu` parameter will not match the target
+        # URI, and in that case, the HTTP message signature verification will fail.
+        # 
+        # If neither this `targetUri` parameter nor the `htu` parameter is specified, the target URI is
+        # considered unavailable. If HTTP message signing requires the target-uri derived component or
+        # other derived components computed based on the target URI, the HTTP message signature verification
+        # will fail.
+        # 
+        field :target_uri, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('targetUri') }, 'form': { 'field_name': 'targetUri' } }
+        # The flag indicating whether to check if the DPoP proof JWT includes the expected `nonce` value.
+        # 
+        # If this request parameter is set to `true` or if the service's `dpopNonceRequired` property is
+        # set to `true`, the `/auth/introspection` API checks if the DPoP proof JWT includes the expected
+        # `nonce` value. In this case, the response from the `/auth/introspection` API will include the
+        # `dpopNonce` response parameter, which should be used as the value of the DPoP-Nonce HTTP header.
+        # 
+        field :dpop_nonce_required, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('dpopNonceRequired') }, 'form': { 'field_name': 'dpopNonceRequired' } }
+        # The flag indicating whether the resource request contains a request body.
+        # 
+        # When the resource request must comply with the HTTP message signing requirements defined in the
+        # FAPI 2.0 Message Signing specification, the `"content-digest"` component identifier must be included
+        # in the signature base of the HTTP message signature (see [RFC 9421 HTTP Message Signatures](https://www.rfc-editor.org/rfc/rfc9421.html))
+        # if the resource request contains a request body.
+        # 
+        # When this `requestBodyContained` parameter is set to `true`, Authlete checks whether `"content-digest"`
+        # is included in the signature base, if the FAPI profile applies to the resource request.
+        # 
+        field :request_body_contained, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('requestBodyContained') }, 'form': { 'field_name': 'requestBodyContained' } }
+
+        sig { params(token: ::String, scopes: T.nilable(T::Array[::String]), subject: T.nilable(::String), client_certificate: T.nilable(::String), dpop: T.nilable(::String), htm: T.nilable(::String), htu: T.nilable(::String), resources: T.nilable(T::Array[::String]), acr_values: T.nilable(T::Array[::String]), max_age: T.nilable(::Integer), required_components: T.nilable(T::Array[::String]), uri: T.nilable(::String), message: T.nilable(::String), headers: T.nilable(T::Array[Models::Components::Pair]), target_uri: T.nilable(::String), dpop_nonce_required: T.nilable(T::Boolean), request_body_contained: T.nilable(T::Boolean)).void }
+        def initialize(token:, scopes: nil, subject: nil, client_certificate: nil, dpop: nil, htm: nil, htu: nil, resources: nil, acr_values: nil, max_age: nil, required_components: nil, uri: nil, message: nil, headers: nil, target_uri: nil, dpop_nonce_required: nil, request_body_contained: nil)
+          @token = token
+          @scopes = scopes
+          @subject = subject
+          @client_certificate = client_certificate
+          @dpop = dpop
+          @htm = htm
+          @htu = htu
+          @resources = resources
+          @acr_values = acr_values
+          @max_age = max_age
+          @required_components = required_components
+          @uri = uri
+          @message = message
+          @headers = headers
+          @target_uri = target_uri
+          @dpop_nonce_required = dpop_nonce_required
+          @request_body_contained = request_body_contained
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @token == other.token
+          return false unless @scopes == other.scopes
+          return false unless @subject == other.subject
+          return false unless @client_certificate == other.client_certificate
+          return false unless @dpop == other.dpop
+          return false unless @htm == other.htm
+          return false unless @htu == other.htu
+          return false unless @resources == other.resources
+          return false unless @acr_values == other.acr_values
+          return false unless @max_age == other.max_age
+          return false unless @required_components == other.required_components
+          return false unless @uri == other.uri
+          return false unless @message == other.message
+          return false unless @headers == other.headers
+          return false unless @target_uri == other.target_uri
+          return false unless @dpop_nonce_required == other.dpop_nonce_required
+          return false unless @request_body_contained == other.request_body_contained
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::IntrospectionRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::IntrospectionRequest
+  def token(); end
+  def token=(str_); end
+  def scopes(); end
+  def scopes=(str_); end
+  def subject(); end
+  def subject=(str_); end
+  def client_certificate(); end
+  def client_certificate=(str_); end
+  def dpop(); end
+  def dpop=(str_); end
+  def htm(); end
+  def htm=(str_); end
+  def htu(); end
+  def htu=(str_); end
+  def resources(); end
+  def resources=(str_); end
+  def acr_values(); end
+  def acr_values=(str_); end
+  def max_age(); end
+  def max_age=(str_); end
+  def required_components(); end
+  def required_components=(str_); end
+  def uri(); end
+  def uri=(str_); end
+  def message(); end
+  def message=(str_); end
+  def headers(); end
+  def headers=(str_); end
+  def target_uri(); end
+  def target_uri=(str_); end
+  def dpop_nonce_required(); end
+  def dpop_nonce_required=(str_); end
+  def request_body_contained(); end
+  def request_body_contained=(str_); end
+end