authlete_ruby_sdk 0.0.3.pre.beta → 1.0.0

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

@@ -13,14 +13,14 @@ module Authlete
         include Crystalline::MetadataFields
 
         # The ticket issued from Authlete `/auth/authorization` 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 authorization request.
         # For more details, see [NO_INTERACTION] in the description of `/auth/authorization` API.
-        # 
-        field :reason, Models::Components::AuthorizationFailRequestReason, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('reason'), required: true, 'decoder': Utils.enum_from_string(Models::Components::AuthorizationFailRequestReason, false) }, 'form': { 'field_name': 'reason' } }
+        #
+        field :reason, Models::Components::AuthorizationFailRequestReason, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('reason'), required: true, 'decoder': ::Authlete::Utils.enum_from_string(Models::Components::AuthorizationFailRequestReason, false) }, 'form': { 'field_name': 'reason' } }
         # The custom description about the authorization failure.
-        # 
+        #
         field :description, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('description') }, 'form': { 'field_name': 'description' } }
 
         sig { params(ticket: ::String, reason: Models::Components::AuthorizationFailRequestReason, description: T.nilable(::String)).void }

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

@@ -14,4 +14,4 @@ class Authlete::Models::Components::AuthorizationFailRequest
   def reason=(str_); end
   def description(); end
   def description=(str_); end
-end
+end

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

@@ -9,7 +9,7 @@ module Authlete
     module Components
       # AuthorizationFailRequestReason - The reason of the failure of the authorization request.
       # For more details, see [NO_INTERACTION] in the description of `/auth/authorization` API.
-      # 
+      #
       class AuthorizationFailRequestReason < T::Enum
         enums do
           UNKNOWN = new('UNKNOWN')

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

@@ -8,4 +8,4 @@ end
 
 
 class Authlete::Models::Components::AuthorizationFailRequestReason
-end
+end

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

@@ -17,10 +17,10 @@ module Authlete
         # 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::AuthorizationFailResponseAction), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('action'), 'decoder': Utils.enum_from_string(Models::Components::AuthorizationFailResponseAction, true) } }
+        field :action, Crystalline::Nilable.new(Models::Components::AuthorizationFailResponseAction), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('action'), 'decoder': ::Authlete::Utils.enum_from_string(Models::Components::AuthorizationFailResponseAction, 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.
-        # 
+        #
         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::AuthorizationFailResponseAction), response_content: T.nilable(::String)).void }

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

@@ -16,4 +16,4 @@ class Authlete::Models::Components::AuthorizationFailResponse
   def action=(str_); end
   def response_content(); end
   def response_content=(str_); end
-end
+end

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

@@ -8,4 +8,4 @@ end
 
 
 class Authlete::Models::Components::AuthorizationFailResponseAction
-end
+end

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

@@ -13,143 +13,79 @@ module Authlete
         include Crystalline::MetadataFields
 
         # The ticket issued from Authlete `/auth/authorization` API.
-        # 
+        #
         field :ticket, ::String, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('ticket'), required: true }, 'form': { 'field_name': 'ticket' } }
         # The subject (= a user account managed by the service) who has granted authorization to the client application.
-        # 
+        #
         field :subject, ::String, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('subject'), required: true }, 'form': { 'field_name': 'subject' } }
         # The time when the authentication of the end-user occurred. 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 Authentication Context Class Reference performed for the end-user authentication.
         field :acr, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('acr') }, 'form': { 'field_name': 'acr' } }
         # The claims of the end-user (= pieces of information about the end-user) in JSON format.
         # See [OpenID Connect Core 1.0, 5.1. Standard Claims](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims) for details about the format.
-        # 
+        #
         field :claims, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('claims') }, 'form': { 'field_name': 'claims' } }
         # Extra properties to associate with an access token and/or an authorization code.
         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 associate with an access token and/or an authorization code.
         # If a non-empty string array is given, it replaces the scopes specified by the original authorization request.
-        # 
+        #
         field :scopes, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('scopes') }, 'form': { 'field_name': 'scopes' } }
         # The value of the `sub` claim to embed in an ID token. If this request parameter is `null` or empty,
         # the value of the `subject` request parameter is used as the value of the `sub` claim.
-        # 
+        #
         field :sub, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('sub') }, 'form': { 'field_name': 'sub' } }
         # JSON that represents additional JWS header parameters for ID tokens that may be issued based on
         # the authorization request.
-        # 
+        #
         field :idt_header_params, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('idtHeaderParams') }, 'form': { 'field_name': 'idtHeaderParams' } }
         # Claim key-value pairs that are used to compute transformed claims.
-        # 
+        #
         field :claims_for_tx, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('claimsForTx') }, 'form': { 'field_name': 'claimsForTx' } }
         # 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' } }
         # 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') }, 'form': { 'field_name': 'authorizationDetails', '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 session ID of the user's authentication session. The specified value will be embedded in the
         # ID token as the value of the `sid` claim. This parameter needs to be provided only if you want
         # to support the [OpenID Connect Native SSO for Mobile Apps 1.0](https://openid.net/specs/openid-connect-native-sso-1_0.html)
         # specification (a.k.a. "Native SSO"). To enable support for the Native SSO specification, the
         # `nativeSsoSupported` property of your service must be set to `true`.
-        # 
-        # NOTE: When the response from the `/auth/authorization` API contains the `nativeSsoRequested`
-        # property with a value of `true`, the `sessionId` request parameter must be provided to the
-        # `/auth/authorization/issue` API.
-        # 
+        #
         field :session_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('sessionId') }, 'form': { 'field_name': 'sessionId' } }
         # 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' } }
         # Values of verified claims requested indirectly by "transformed claims".
-        # 
-        # A client application may request "transformed claims". Each of transformed claims uses an existing
-        # claim as input. As a result, to compute the value of a transformed claim, the value of the referenced
-        # existing claim is needed. This `verifiedClaimsForTx` request parameter has to be used to provide
-        # values of existing claims for computation of transformed claims.
-        # 
-        # A response from the `/auth/authorization` API may include the `requestedVerifiedClaimsForTx` response
-        # parameter which is a list of verified claims that are referenced indirectly by transformed claims
-        # (cf. `requestedVerifiedClaimsForTx` in `/auth/authorization` API response). The authorization
-        # server implementation should prepare values of the verified claims listed in `requestedVerifiedClaimsForTx`
-        # and pass them as the value of this `verifiedClaimsForTx` request parameter.
-        # 
-        # The following is an example of the value of this request parameter.
-        # 
-        # ```
-        # [
-        #   "{\"birthdate\":\"1970-01-23\",\"nationalities\":[\"DEU\",\"USA\"]}"
-        # ]
-        # ```
-        # 
-        # The reason that this `verifiedClaimsForTx` property is an array is that the `"verified_claims"`
-        # property in the claims request parameter of an authorization request can be an array like below.
-        # 
-        # ```
-        # {
-        #   "transformed_claims": {
-        #     "nationality_usa": {
-        #       "claim": "nationalities",
-        #       "fn": [
-        #         [ "eq", "USA" ],
-        #         "any"
-        #       ]
-        #     }
-        #   },
-        #   "id_token": {
-        #     "verified_claims": [
-        #       {
-        #         "verification": { "trust_framework": { "value": "gold" } },
-        #         "claims": { "::18_or_above": null }
-        #       },
-        #       {
-        #         "verification": { "trust_framework": { "value": "silver" } },
-        #         "claims": { ":nationality_usa": null }
-        #       }
-        #     ]
-        #   }
-        # }
-        # ```
-        # 
-        # For the example above, the value of this `verifiedClaimsForTx` property should be an array of
-        # size 2 and look like below. The first element is JSON including claims which have been verified
-        # under the trust framework `"gold"`, and the second element is JSON including claims which have
-        # been verified under the trust framework `"silver"`.
-        # 
-        # ```
-        # [
-        #   "{\"birthdate\":\"1970-01-23\"}",
-        #   "{\"nationalities\":[\"DEU\",\"USA\"]}"
-        # ]
-        # ```
-        # 
+        #
         field :verified_claims_for_tx, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('verifiedClaimsForTx') }, 'form': { 'field_name': 'verifiedClaimsForTx' } }
 
         sig { params(ticket: ::String, subject: ::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]), sub: T.nilable(::String), idt_header_params: T.nilable(::String), claims_for_tx: T.nilable(::String), consented_claims: T.nilable(T::Array[::String]), authorization_details: T.nilable(Models::Components::AuthzDetails), jwt_at_claims: T.nilable(::String), access_token: T.nilable(::String), access_token_duration: T.nilable(::Integer), session_id: T.nilable(::String), id_token_aud_type: T.nilable(::String), verified_claims_for_tx: T.nilable(T::Array[::String])).void }

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

@@ -44,4 +44,4 @@ class Authlete::Models::Components::AuthorizationIssueRequest
   def id_token_aud_type=(str_); end
   def verified_claims_for_tx(); end
   def verified_claims_for_tx=(str_); end
-end
+end

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

@@ -17,33 +17,33 @@ module Authlete
         # 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::AuthorizationIssueResponseAction), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('action'), 'decoder': Utils.enum_from_string(Models::Components::AuthorizationIssueResponseAction, true) } }
+        field :action, Crystalline::Nilable.new(Models::Components::AuthorizationIssueResponseAction), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('action'), 'decoder': ::Authlete::Utils.enum_from_string(Models::Components::AuthorizationIssueResponseAction, 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.
-        # 
+        #
         field :response_content, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('responseContent') } }
         # The newly issued access token. Note that an access token is issued from an authorization endpoint only
         # when `response_type` contains token.
-        # 
+        #
         field :access_token, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('accessToken') } }
         # The datetime at which the newly issued access token will expire. The value is represented in milliseconds
         # since the Unix epoch (1970-01-01).
-        # 
+        #
         field :access_token_expires_at, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('accessTokenExpiresAt') } }
         # The duration of the newly issued access token in seconds.
-        # 
+        #
         field :access_token_duration, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('accessTokenDuration') } }
         # The newly issued ID token. Note that an ID token is issued from an authorization endpoint only
         # when `response_type` contains `id_token`.
-        # 
+        #
         field :id_token, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('idToken') } }
         # The newly issued authorization code. Note that an authorization code is issued only
         # when `response_type` contains code.
-        # 
+        #
         field :authorization_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('authorizationCode') } }
         # The newly issued access token in JWT format. If the service is not configured to issue JWT-based access tokens,
         # this property is always set to `null`.
-        # 
+        #
         field :jwt_access_token, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('jwtAccessToken') } }
 
         field :ticket_info, Crystalline::Nilable.new(Models::Components::AuthorizationTicketInfo), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('ticketInfo') } }

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

@@ -30,4 +30,4 @@ class Authlete::Models::Components::AuthorizationIssueResponse
   def jwt_access_token=(str_); end
   def ticket_info(); end
   def ticket_info=(str_); end
-end
+end

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

@@ -8,4 +8,4 @@ end
 
 
 class Authlete::Models::Components::AuthorizationIssueResponseAction
-end
+end

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

@@ -14,25 +14,25 @@ module Authlete
 
         # OAuth 2.0 authorization request parameters which are the request parameters that the OAuth 2.0 authorization endpoint of
         # the authorization server implementation received from the client application.
-        # 
+        #
         # The value of parameters is either (1) the entire query string when the HTTP method of the request from the client application is `GET`
         # or (2) the entire entity body (which is formatted in `application/x-www-form-urlencoded`) when the HTTP method of the request from
         # the client application is `POST`.
-        # 
+        #
         field :parameters, ::String, { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('parameters'), required: true }, 'form': { 'field_name': 'parameters' } }
         # The arbitrary text to be attached to the ticket that will be issued from the `/auth/authorization`
         # API.
-        # 
+        #
         # The text can be retrieved later by the `/auth/authorization/ticket/info` API and can be updated
         # by the `/auth/authorization/ticket/update` API.
-        # 
+        #
         # The text will be compressed and encrypted when it is saved in the Authlete database.
-        # 
+        #
         field :context, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('context') }, 'form': { 'field_name': 'context' } }
         # Options for [OAuth Client ID Metadata Document](https://datatracker.ietf.org/doc/draft-ietf-oauth-client-id-metadata-document/) (CIMD).
-        # 
+        #
         # These options allow per-request control over CIMD behavior, taking precedence over service-level configuration when provided.
-        # 
+        #
         field :cimd_options, Crystalline::Nilable.new(Models::Components::CimdOptions), { 'format_json': { 'letter_case': ::Authlete::Utils.field_name('cimdOptions') }, 'form': { 'field_name': 'cimdOptions', 'json': true } }
 
         sig { params(parameters: ::String, context: T.nilable(::String), cimd_options: T.nilable(Models::Components::CimdOptions)).void }

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

@@ -14,4 +14,4 @@ class Authlete::Models::Components::AuthorizationRequest
   def context=(str_); end
   def cimd_options(); end
   def cimd_options=(str_); end
-end
+end