authlete_ruby_test 0.0.1.beta

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

@@ -0,0 +1,51 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::TokenCreateResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::TokenCreateResponse
+  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 access_token(); end
+  def access_token=(str_); end
+  def client_id(); end
+  def client_id=(str_); end
+  def expires_at(); end
+  def expires_at=(str_); end
+  def expires_in(); end
+  def expires_in=(str_); end
+  def grant_type(); end
+  def grant_type=(str_); end
+  def properties(); end
+  def properties=(str_); end
+  def refresh_token(); end
+  def refresh_token=(str_); end
+  def scopes(); end
+  def scopes=(str_); end
+  def subject(); end
+  def subject=(str_); end
+  def token_type(); end
+  def token_type=(str_); end
+  def jwt_access_token(); end
+  def jwt_access_token=(str_); end
+  def authorization_details(); end
+  def authorization_details=(str_); end
+  def for_external_attachment(); end
+  def for_external_attachment=(str_); end
+  def token_id(); end
+  def token_id=(str_); end
+  def refresh_token_scopes(); end
+  def refresh_token_scopes=(str_); end
+  def client_identifier(); end
+  def client_identifier=(str_); end
+  def session_id(); end
+  def session_id=(str_); end
+end

data/lib/authlete/models/components/token_create_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
+    
+      # TokenCreateResponseAction - The next action that the authorization server implementation should take.
+      class TokenCreateResponseAction < T::Enum
+
+
+        enums do
+          INTERNAL_SERVER_ERROR = new('INTERNAL_SERVER_ERROR')
+          BAD_REQUEST = new('BAD_REQUEST')
+          FORBIDDEN = new('FORBIDDEN')
+          OK = new('OK')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,39 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+
+      class TokenFailRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The ticket issued from Authlete `/auth/token` API.
+        # 
+        field :ticket, ::String, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('ticket'), required: true }, 'form': { 'field_name': 'ticket' } }
+        # The reason of the failure of the token request.
+        # 
+        field :reason, Models::Components::TokenFailRequestReason, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('reason'), required: true, 'decoder': Utils.enum_from_string(Models::Components::TokenFailRequestReason, false) }, 'form': { 'field_name': 'reason' } }
+
+        sig { params(ticket: ::String, reason: Models::Components::TokenFailRequestReason).void }
+        def initialize(ticket:, reason:)
+          @ticket = ticket
+          @reason = reason
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @ticket == other.ticket
+          return false unless @reason == other.reason
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::TokenFailRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::TokenFailRequest
+  def ticket(); end
+  def ticket=(str_); end
+  def reason(); end
+  def reason=(str_); end
+end

data/lib/authlete/models/components/token_fail_request_reason.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
+    
+      # TokenFailRequestReason - The reason of the failure of the token request.
+      # 
+      class TokenFailRequestReason < T::Enum
+
+
+        enums do
+          UNKNOWN = new('UNKNOWN')
+          INVALID_RESOURCE_OWNER_CREDENTIALS = new('INVALID_RESOURCE_OWNER_CREDENTIALS')
+          INVALID_TARGET = new('INVALID_TARGET')
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,47 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+
+      class TokenFailResponse
+        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::TokenFailResponseAction), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('action'), 'decoder': Utils.enum_from_string(Models::Components::TokenFailResponseAction, true) } }
+        # The content that the authorization server implementation is to return to the client application.
+        # Its format varies depending on the value of `action` parameter. See description for details.
+        # 
+        field :response_content, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('responseContent') } }
+
+        sig { params(result_code: T.nilable(::String), result_message: T.nilable(::String), action: T.nilable(Models::Components::TokenFailResponseAction), response_content: T.nilable(::String)).void }
+        def initialize(result_code: nil, result_message: nil, action: nil, response_content: nil)
+          @result_code = result_code
+          @result_message = result_message
+          @action = action
+          @response_content = response_content
+        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
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::TokenFailResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::TokenFailResponse
+  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
+end

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

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

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

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

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

@@ -0,0 +1,58 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+
+      class TokenGetListResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Start index of search results (inclusive).
+        # 
+        field :start, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('start') } }
+        # End index of search results (exclusive).
+        # 
+        field :end_, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('end') } }
+        # Unique ID of a client developer.
+        # 
+        field :total_count, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('totalCount') } }
+
+        field :client, Crystalline::Nilable.new(Models::Components::ClientLimited), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('client') } }
+        # Unique user ID of an end-user.
+        # 
+        field :subject, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('subject') } }
+        # An array of access tokens.
+        # 
+        field :access_tokens, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::AccessToken)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('accessTokens') } }
+
+        sig { params(start: T.nilable(::Integer), end_: T.nilable(::Integer), total_count: T.nilable(::Integer), client: T.nilable(Models::Components::ClientLimited), subject: T.nilable(::String), access_tokens: T.nilable(T::Array[Models::Components::AccessToken])).void }
+        def initialize(start: nil, end_: nil, total_count: nil, client: nil, subject: nil, access_tokens: nil)
+          @start = start
+          @end_ = end_
+          @total_count = total_count
+          @client = client
+          @subject = subject
+          @access_tokens = access_tokens
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @start == other.start
+          return false unless @end_ == other.end_
+          return false unless @total_count == other.total_count
+          return false unless @client == other.client
+          return false unless @subject == other.subject
+          return false unless @access_tokens == other.access_tokens
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::TokenGetListResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::TokenGetListResponse
+  def start(); end
+  def start=(str_); end
+  def end_(); end
+  def end_=(str_); end
+  def total_count(); end
+  def total_count=(str_); end
+  def client(); end
+  def client=(str_); end
+  def subject(); end
+  def subject=(str_); end
+  def access_tokens(); end
+  def access_tokens=(str_); end
+end

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

@@ -0,0 +1,89 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+
+      class TokenInfo
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The client id.
+        field :client_id, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('clientId') } }
+        # The alias of the client.
+        field :client_id_alias, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('clientIdAlias') } }
+        # Flag specifying if the alias was used to identify the client
+        field :client_id_alias_used, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('clientIdAliasUsed') } }
+        # the resource owner unique id
+        field :subject, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('subject') } }
+        # The scopes granted on the token
+        field :scopes, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('scopes') } }
+        # time which the token expires.
+        field :expires_at, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('expiresAt') } }
+        # Extra properties associated with the token
+        field :properties, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::Property)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('properties') } }
+        # The array of the resources of the token.
+        field :resources, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('resources') } }
+
+        field :authorization_details, Crystalline::Nilable.new(Models::Components::AuthorizationDetailsElement), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('authorizationDetails') } }
+        # 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(client_id: T.nilable(::Integer), client_id_alias: T.nilable(::String), client_id_alias_used: T.nilable(T::Boolean), subject: T.nilable(::String), scopes: T.nilable(T::Array[::String]), expires_at: T.nilable(::Integer), properties: T.nilable(T::Array[Models::Components::Property]), resources: T.nilable(T::Array[::String]), authorization_details: T.nilable(Models::Components::AuthorizationDetailsElement), 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(client_id: nil, client_id_alias: nil, client_id_alias_used: nil, subject: nil, scopes: nil, expires_at: nil, properties: nil, resources: nil, authorization_details: nil, client_entity_id: nil, client_entity_id_used: nil, metadata_document_location: nil, metadata_document_used: nil)
+          @client_id = client_id
+          @client_id_alias = client_id_alias
+          @client_id_alias_used = client_id_alias_used
+          @subject = subject
+          @scopes = scopes
+          @expires_at = expires_at
+          @properties = properties
+          @resources = resources
+          @authorization_details = authorization_details
+          @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 @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 @subject == other.subject
+          return false unless @scopes == other.scopes
+          return false unless @expires_at == other.expires_at
+          return false unless @properties == other.properties
+          return false unless @resources == other.resources
+          return false unless @authorization_details == other.authorization_details
+          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/token_info.rbi

@@ -0,0 +1,37 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::TokenInfo
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::TokenInfo
+  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 subject(); end
+  def subject=(str_); end
+  def scopes(); end
+  def scopes=(str_); end
+  def expires_at(); end
+  def expires_at=(str_); end
+  def properties(); end
+  def properties=(str_); end
+  def resources(); end
+  def resources=(str_); end
+  def authorization_details(); end
+  def authorization_details=(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/token_issue_request.rb

@@ -0,0 +1,74 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Authlete
+  module Models
+    module Components
+    
+
+      class TokenIssueRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The ticket issued from Authlete `/auth/token` API.
+        # 
+        field :ticket, ::String, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('ticket'), required: true }, 'form': { 'field_name': 'ticket' } }
+        # The subject (= unique identifier) of the authenticated user.
+        # 
+        field :subject, ::String, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('subject'), required: true }, 'form': { 'field_name': 'subject' } }
+        # Extra properties to associate with a newly created access token. Note that properties parameter is accepted only
+        # when `Content-Type` of the request is `application/json`, so don't use `application/x-www-form-urlencoded`
+        # if you want to specify properties.
+        # 
+        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 } }
+        # 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 representation of an access token that may be issued as a result of the Authlete API call.
+        # 
+        field :access_token, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('accessToken') }, 'form': { 'field_name': 'accessToken' } }
+        # 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' } }
+
+        sig { params(ticket: ::String, subject: ::String, properties: T.nilable(T::Array[Models::Components::Property]), jwt_at_claims: T.nilable(::String), access_token: T.nilable(::String), access_token_duration: T.nilable(::Integer), refresh_token_duration: T.nilable(::Integer)).void }
+        def initialize(ticket:, subject:, properties: nil, jwt_at_claims: nil, access_token: nil, access_token_duration: nil, refresh_token_duration: nil)
+          @ticket = ticket
+          @subject = subject
+          @properties = properties
+          @jwt_at_claims = jwt_at_claims
+          @access_token = access_token
+          @access_token_duration = access_token_duration
+          @refresh_token_duration = refresh_token_duration
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @ticket == other.ticket
+          return false unless @subject == other.subject
+          return false unless @properties == other.properties
+          return false unless @jwt_at_claims == other.jwt_at_claims
+          return false unless @access_token == other.access_token
+          return false unless @access_token_duration == other.access_token_duration
+          return false unless @refresh_token_duration == other.refresh_token_duration
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Authlete::Models::Components::TokenIssueRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Authlete::Models::Components::TokenIssueRequest
+  def ticket(); end
+  def ticket=(str_); end
+  def subject(); end
+  def subject=(str_); end
+  def properties(); end
+  def properties=(str_); end
+  def jwt_at_claims(); end
+  def jwt_at_claims=(str_); end
+  def access_token(); end
+  def access_token=(str_); end
+  def access_token_duration(); end
+  def access_token_duration=(str_); end
+  def refresh_token_duration(); end
+  def refresh_token_duration=(str_); end
+end