ory-client 0.2.0.alpha48 → 0.2.0.alpha60

data/docs/SelfServiceFlowExpiredError.md

@@ -13,7 +13,7 @@
 | **request** | **String** | The request ID  The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID. | [optional] |
 | **since** | **Integer** | A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. | [optional] |
 | **status** | **String** | The status description | [optional] |
-| **use_flow_id** | **String** |  | [optional] |
+| **use_flow_id** | **String** | The flow ID that should be used for the new flow as it contains the correct messages. | [optional] |
 
 ## Example
 

data/docs/SelfServiceLoginFlow.md

@@ -7,7 +7,7 @@
 | **active** | [**IdentityCredentialsType**](IdentityCredentialsType.md) |  | [optional] |
 | **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
 | **expires_at** | **Time** | ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated. |  |
-| **id** | **String** |  |  |
+| **id** | **String** | ID represents the flow's unique ID. When performing the login flow, this represents the id in the login UI's query parameter: http://<selfservice.flows.login.ui_url>/?flow=<flow_id> |  |
 | **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow started. |  |
 | **refresh** | **Boolean** | Refresh stores whether this login flow should enforce re-authentication. | [optional] |
 | **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |  |

data/docs/SelfServiceRecoveryCode.md

@@ -0,0 +1,22 @@
+# OryClient::SelfServiceRecoveryCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_at** | **Time** | Expires At is the timestamp of when the recovery flow expires  The timestamp when the recovery link expires. | [optional] |
+| **recovery_code** | **String** | RecoveryCode is the code that can be used to recover the account |  |
+| **recovery_link** | **String** | RecoveryLink with flow  This link opens the recovery UI with an empty `code` field. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SelfServiceRecoveryCode.new(
+  expires_at: null,
+  recovery_code: null,
+  recovery_link: null
+)
+```
+

data/docs/SelfServiceRecoveryFlow.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **active** | **String** | Active, if set, contains the registration method that is being used. It is initially not set. | [optional] |
+| **active** | **String** | Active, if set, contains the recovery method that is being used. It is initially not set. | [optional] |
 | **expires_at** | **Time** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting, a new request has to be initiated. |  |
-| **id** | **String** |  |  |
+| **id** | **String** | ID represents the request's unique ID. When performing the recovery flow, this represents the id in the recovery ui's query parameter: http://<selfservice.flows.recovery.ui_url>?request=<id> |  |
 | **issued_at** | **Time** | IssuedAt is the time (UTC) when the request occurred. |  |
 | **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |  |
 | **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |

data/docs/SelfServiceRegistrationFlow.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **active** | [**IdentityCredentialsType**](IdentityCredentialsType.md) |  | [optional] |
 | **expires_at** | **Time** | ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated. |  |
-| **id** | **String** |  |  |
+| **id** | **String** | ID represents the flow's unique ID. When performing the registration flow, this represents the id in the registration ui's query parameter: http://<selfservice.flows.registration.ui_url>/?flow=<id> |  |
 | **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow occurred. |  |
 | **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |  |
 | **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |

data/docs/SelfServiceSettingsFlow.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **active** | **String** | Active, if set, contains the registration method that is being used. It is initially not set. | [optional] |
 | **expires_at** | **Time** | ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to update the setting, a new flow has to be initiated. |  |
-| **id** | **String** |  |  |
+| **id** | **String** | ID represents the flow's unique ID. When performing the settings flow, this represents the id in the settings ui's query parameter: http://<selfservice.flows.settings.ui_url>?flow=<id> |  |
 | **identity** | [**Identity**](Identity.md) |  |  |
 | **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow occurred. |  |
 | **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |  |

data/docs/SelfServiceVerificationFlow.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **active** | **String** | Active, if set, contains the registration method that is being used. It is initially not set. | [optional] |
 | **expires_at** | **Time** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address, a new request has to be initiated. | [optional] |
-| **id** | **String** |  |  |
+| **id** | **String** | ID represents the request's unique ID. When performing the verification flow, this represents the id in the verify ui's query parameter: http://<selfservice.flows.verification.ui_url>?request=<id>  type: string format: uuid |  |
 | **issued_at** | **Time** | IssuedAt is the time (UTC) when the request occurred. | [optional] |
 | **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. | [optional] |
 | **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |

data/docs/Session.md

@@ -8,8 +8,9 @@
 | **authenticated_at** | **Time** | The Session Authentication Timestamp  When this session was authenticated at. If multi-factor authentication was used this is the time when the last factor was authenticated (e.g. the TOTP code challenge was completed). | [optional] |
 | **authentication_methods** | [**Array<SessionAuthenticationMethod>**](SessionAuthenticationMethod.md) | A list of authenticators which were used to authenticate the session. | [optional] |
 | **authenticator_assurance_level** | [**AuthenticatorAssuranceLevel**](AuthenticatorAssuranceLevel.md) |  | [optional] |
+| **devices** | [**Array<SessionDevice>**](SessionDevice.md) | Devices has history of all endpoints where the session was used | [optional] |
 | **expires_at** | **Time** | The Session Expiry  When this session expires at. | [optional] |
-| **id** | **String** |  |  |
+| **id** | **String** | Session ID |  |
 | **identity** | [**Identity**](Identity.md) |  |  |
 | **issued_at** | **Time** | The Session Issuance Timestamp  When this session was issued at. Usually equal or close to `authenticated_at`. | [optional] |
 
@@ -23,6 +24,7 @@ instance = OryClient::Session.new(
   authenticated_at: null,
   authentication_methods: null,
   authenticator_assurance_level: null,
+  devices: null,
   expires_at: null,
   id: null,
   identity: null,

data/docs/SessionDevice.md

@@ -4,7 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_agent** | **String** | UserAgent of this device | [optional] |
+| **id** | **String** | Device record ID |  |
+| **ip_address** | **String** | IPAddress of the client | [optional] |
+| **location** | **String** | Geo Location corresponding to the IP Address | [optional] |
+| **user_agent** | **String** | UserAgent of the client | [optional] |
 
 ## Example
 
@@ -12,6 +15,9 @@
 require 'ory-client'
 
 instance = OryClient::SessionDevice.new(
+  id: null,
+  ip_address: null,
+  location: null,
   user_agent: null
 )
 ```

data/docs/SourcePosition.md

@@ -0,0 +1,20 @@
+# OryClient::SourcePosition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **line** | **Integer** |  | [optional] |
+| **column** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SourcePosition.new(
+  line: null,
+  column: null
+)
+```
+

data/docs/SubmitSelfServiceRecoveryFlowBody.md

@@ -14,6 +14,7 @@ require 'ory-client'
 OryClient::SubmitSelfServiceRecoveryFlowBody.openapi_one_of
 # =>
 # [
+#   :'SubmitSelfServiceRecoveryFlowWithCodeMethodBody',
 #   :'SubmitSelfServiceRecoveryFlowWithLinkMethodBody'
 # ]
 ```
@@ -43,6 +44,7 @@ require 'ory-client'
 OryClient::SubmitSelfServiceRecoveryFlowBody.openapi_discriminator_mapping
 # =>
 # {
+#   :'code' => :'SubmitSelfServiceRecoveryFlowWithCodeMethodBody',
 #   :'link' => :'SubmitSelfServiceRecoveryFlowWithLinkMethodBody'
 # }
 
@@ -56,7 +58,7 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
 require 'ory-client'
 
 OryClient::SubmitSelfServiceRecoveryFlowBody.build(data)
-# => #<SubmitSelfServiceRecoveryFlowWithLinkMethodBody:0x00007fdd4aab02a0>
+# => #<SubmitSelfServiceRecoveryFlowWithCodeMethodBody:0x00007fdd4aab02a0>
 
 OryClient::SubmitSelfServiceRecoveryFlowBody.build(data_that_doesnt_match)
 # => nil
@@ -70,6 +72,7 @@ OryClient::SubmitSelfServiceRecoveryFlowBody.build(data_that_doesnt_match)
 
 #### Return type
 
+- `SubmitSelfServiceRecoveryFlowWithCodeMethodBody`
 - `SubmitSelfServiceRecoveryFlowWithLinkMethodBody`
 - `nil` (if no type matches)
 

data/docs/SubmitSelfServiceRecoveryFlowWithCodeMethodBody.md

@@ -0,0 +1,24 @@
+# OryClient::SubmitSelfServiceRecoveryFlowWithCodeMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Code from recovery email  Sent to the user once a recovery has been initiated and is used to prove that the user is in possession of the email | [optional] |
+| **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
+| **email** | **String** | Email to Recover  Needs to be set when initiating the flow. If the email is a registered recovery email, a recovery link will be sent. If the email is not known, a email with details on what happened will be sent instead.  format: email | [optional] |
+| **method** | **String** | Method supports `link` and `code` only right now. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceRecoveryFlowWithCodeMethodBody.new(
+  code: null,
+  csrf_token: null,
+  email: null,
+  method: null
+)
+```
+

data/docs/{CompletedRequest.md → SuccessfulOAuth2RequestResponse.md}

@@ -1,4 +1,4 @@
-# OryClient::CompletedRequest
+# OryClient::SuccessfulOAuth2RequestResponse
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryClient::CompletedRequest.new(
+instance = OryClient::SuccessfulOAuth2RequestResponse.new(
   redirect_to: null
 )
 ```

data/docs/SyntaxApi.md

@@ -0,0 +1,77 @@
+# OryClient::SyntaxApi
+
+All URIs are relative to *https://playground.projects.oryapis.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**check_opl_syntax**](SyntaxApi.md#check_opl_syntax) | **POST** /opl/syntax/check | Check the syntax of an OPL file |
+
+
+## check_opl_syntax
+
+> <PostCheckOplSyntaxResponse> check_opl_syntax(body)
+
+Check the syntax of an OPL file
+
+The OPL file is expected in the body of the request.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+# setup authorization
+OryClient.configure do |config|
+  # Configure Bearer authorization: oryAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OryClient::SyntaxApi.new
+body = 'body_example' # String | the OPL content to check
+
+begin
+  # Check the syntax of an OPL file
+  result = api_instance.check_opl_syntax(body)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling SyntaxApi->check_opl_syntax: #{e}"
+end
+```
+
+#### Using the check_opl_syntax_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostCheckOplSyntaxResponse>, Integer, Hash)> check_opl_syntax_with_http_info(body)
+
+```ruby
+begin
+  # Check the syntax of an OPL file
+  data, status_code, headers = api_instance.check_opl_syntax_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostCheckOplSyntaxResponse>
+rescue OryClient::ApiError => e
+  puts "Error when calling SyntaxApi->check_opl_syntax_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | the OPL content to check |  |
+
+### Return type
+
+[**PostCheckOplSyntaxResponse**](PostCheckOplSyntaxResponse.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: text/plain
+- **Accept**: application/json
+

data/docs/{TrustedJwtGrantIssuer.md → TrustedOAuth2JwtGrantIssuer.md}

@@ -1,4 +1,4 @@
-# OryClient::TrustedJwtGrantIssuer
+# OryClient::TrustedOAuth2JwtGrantIssuer
 
 ## Properties
 
@@ -9,7 +9,7 @@
 | **expires_at** | **Time** | The \"expires_at\" indicates, when grant will expire, so we will reject assertion from \"issuer\" targeting \"subject\". | [optional] |
 | **id** | **String** |  | [optional] |
 | **issuer** | **String** | The \"issuer\" identifies the principal that issued the JWT assertion (same as \"iss\" claim in JWT). | [optional] |
-| **public_key** | [**TrustedJsonWebKey**](TrustedJsonWebKey.md) |  | [optional] |
+| **public_key** | [**TrustedOAuth2JwtGrantJsonWebKey**](TrustedOAuth2JwtGrantJsonWebKey.md) |  | [optional] |
 | **scope** | **Array<String>** | The \"scope\" contains list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) | [optional] |
 | **subject** | **String** | The \"subject\" identifies the principal that is the subject of the JWT. | [optional] |
 
@@ -18,7 +18,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryClient::TrustedJwtGrantIssuer.new(
+instance = OryClient::TrustedOAuth2JwtGrantIssuer.new(
   allow_any_subject: null,
   created_at: null,
   expires_at: null,

data/docs/{TrustedJsonWebKey.md → TrustedOAuth2JwtGrantJsonWebKey.md}

@@ -1,4 +1,4 @@
-# OryClient::TrustedJsonWebKey
+# OryClient::TrustedOAuth2JwtGrantJsonWebKey
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryClient::TrustedJsonWebKey.new(
+instance = OryClient::TrustedOAuth2JwtGrantJsonWebKey.new(
   kid: 123e4567-e89b-12d3-a456-426655440000,
   set: https://jwt-idp.example.com
 )

data/docs/UiNode.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **attributes** | [**UiNodeAttributes**](UiNodeAttributes.md) |  |  |
-| **group** | **String** | Group specifies which group (e.g. password authenticator) this node belongs to. |  |
+| **group** | **String** | Group specifies which group (e.g. password authenticator) this node belongs to. default DefaultGroup password PasswordGroup oidc OpenIDConnectGroup profile ProfileGroup link LinkGroup code CodeGroup totp TOTPGroup lookup_secret LookupGroup webauthn WebAuthnGroup |  |
 | **messages** | [**Array<UiText>**](UiText.md) |  |  |
 | **meta** | [**UiNodeMeta**](UiNodeMeta.md) |  |  |
-| **type** | **String** | The node's type |  |
+| **type** | **String** | The node's type text Text input Input img Image a Anchor script Script |  |
 
 ## Example
 

data/docs/UiNodeInputAttributes.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **autocomplete** | **String** | The autocomplete attribute for the input. | [optional] |
+| **autocomplete** | **String** | The autocomplete attribute for the input. email InputAttributeAutocompleteEmail tel InputAttributeAutocompleteTel url InputAttributeAutocompleteUrl current-password InputAttributeAutocompleteCurrentPassword new-password InputAttributeAutocompleteNewPassword one-time-code InputAttributeAutocompleteOneTimeCode | [optional] |
 | **disabled** | **Boolean** | Sets the input's disabled field to true or false. |  |
 | **label** | [**UiText**](UiText.md) |  | [optional] |
 | **name** | **String** | The input's element name. |  |
@@ -12,7 +12,7 @@
 | **onclick** | **String** | OnClick may contain javascript which should be executed on click. This is primarily used for WebAuthn. | [optional] |
 | **pattern** | **String** | The input's pattern. | [optional] |
 | **required** | **Boolean** | Mark this input field as required. | [optional] |
-| **type** | **String** | The input's element type. |  |
+| **type** | **String** | The input's element type. text InputAttributeTypeText password InputAttributeTypePassword number InputAttributeTypeNumber checkbox InputAttributeTypeCheckbox hidden InputAttributeTypeHidden email InputAttributeTypeEmail tel InputAttributeTypeTel submit InputAttributeTypeSubmit button InputAttributeTypeButton datetime-local InputAttributeTypeDateTimeLocal date InputAttributeTypeDate url InputAttributeTypeURI |  |
 | **value** | **Object** | The input's value. | [optional] |
 
 ## Example

data/docs/UpdateOAuth2ClientLifespans.md

@@ -0,0 +1,40 @@
+# OryClient::UpdateOAuth2ClientLifespans
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_code_grant_access_token_lifespan** | **String** |  | [optional] |
+| **authorization_code_grant_id_token_lifespan** | **String** |  | [optional] |
+| **authorization_code_grant_refresh_token_lifespan** | **String** |  | [optional] |
+| **client_credentials_grant_access_token_lifespan** | **String** |  | [optional] |
+| **implicit_grant_access_token_lifespan** | **String** |  | [optional] |
+| **implicit_grant_id_token_lifespan** | **String** |  | [optional] |
+| **jwt_bearer_grant_access_token_lifespan** | **String** |  | [optional] |
+| **password_grant_access_token_lifespan** | **String** |  | [optional] |
+| **password_grant_refresh_token_lifespan** | **String** |  | [optional] |
+| **refresh_token_grant_access_token_lifespan** | **String** |  | [optional] |
+| **refresh_token_grant_id_token_lifespan** | **String** |  | [optional] |
+| **refresh_token_grant_refresh_token_lifespan** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::UpdateOAuth2ClientLifespans.new(
+  authorization_code_grant_access_token_lifespan: null,
+  authorization_code_grant_id_token_lifespan: null,
+  authorization_code_grant_refresh_token_lifespan: null,
+  client_credentials_grant_access_token_lifespan: null,
+  implicit_grant_access_token_lifespan: null,
+  implicit_grant_id_token_lifespan: null,
+  jwt_bearer_grant_access_token_lifespan: null,
+  password_grant_access_token_lifespan: null,
+  password_grant_refresh_token_lifespan: null,
+  refresh_token_grant_access_token_lifespan: null,
+  refresh_token_grant_id_token_lifespan: null,
+  refresh_token_grant_refresh_token_lifespan: null
+)
+```
+