ory-kratos-client 0.11.1 → 1.0.0

data/docs/PatchIdentitiesBody.md

@@ -0,0 +1,18 @@
+# OryKratosClient::PatchIdentitiesBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identities** | [**Array<IdentityPatch>**](IdentityPatch.md) | Identities holds the list of patches to apply  required | [optional] |
+
+## Example
+
+```ruby
+require 'ory-kratos-client'
+
+instance = OryKratosClient::PatchIdentitiesBody.new(
+  identities: null
+)
+```
+

data/docs/RegistrationFlow.md

@@ -8,10 +8,12 @@
 | **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 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. |  |
-| **oauth2_login_challenge** | **String** |  | [optional] |
+| **oauth2_login_challenge** | **String** | Ory OAuth 2.0 Login Challenge.  This value is set using the `login_challenge` query parameter of the registration and login endpoints. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider. | [optional] |
 | **oauth2_login_request** | [**OAuth2LoginRequest**](OAuth2LoginRequest.md) |  | [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. |  |
 | **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |
+| **session_token_exchange_code** | **String** | SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the flow has been completed. This is only set if the client has requested a session token exchange code, and if the flow is of type \"api\", and only on creating the flow. | [optional] |
+| **transient_payload** | **Object** | TransientPayload is used to pass data from the registration to a webhook | [optional] |
 | **type** | **String** | The flow type can either be `api` or `browser`. |  |
 | **ui** | [**UiContainer**](UiContainer.md) |  |  |
 
@@ -29,6 +31,8 @@ instance = OryKratosClient::RegistrationFlow.new(
   oauth2_login_request: null,
   request_url: null,
   return_to: null,
+  session_token_exchange_code: null,
+  transient_payload: null,
   type: null,
   ui: null
 )

data/docs/SelfServiceFlowExpiredError.md

@@ -4,16 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | **Integer** | The status code | [optional] |
-| **debug** | **String** | Debug information  This field is often not exposed to protect against leaking sensitive information. | [optional] |
-| **details** | **Hash<String, Object>** | Further error details | [optional] |
+| **error** | [**GenericError**](GenericError.md) |  | [optional] |
 | **expired_at** | **Time** | When the flow has expired | [optional] |
-| **id** | **String** | The error ID  Useful when trying to identify various errors in application logic. | [optional] |
-| **message** | **String** | Error message  The error's message. |  |
-| **reason** | **String** | A human-readable reason for the error | [optional] |
-| **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** | The flow ID that should be used for the new flow as it contains the correct messages. | [optional] |
 
 ## Example
@@ -22,16 +15,9 @@
 require 'ory-kratos-client'
 
 instance = OryKratosClient::SelfServiceFlowExpiredError.new(
-  code: 404,
-  debug: SQL field "foo" is not a bool.,
-  details: null,
+  error: null,
   expired_at: null,
-  id: null,
-  message: The resource could not be found,
-  reason: User with ID 1234 does not exist.,
-  request: d7ef54b1-ec15-46e6-bccb-524b82c035e6,
   since: null,
-  status: Not Found,
   use_flow_id: null
 )
 ```

data/docs/SessionAuthenticationMethod.md

@@ -7,6 +7,7 @@
 | **aal** | [**AuthenticatorAssuranceLevel**](AuthenticatorAssuranceLevel.md) |  | [optional] |
 | **completed_at** | **Time** | When the authentication challenge was completed. | [optional] |
 | **method** | **String** |  | [optional] |
+| **provider** | **String** | OIDC or SAML provider id used for authentication | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'ory-kratos-client'
 instance = OryKratosClient::SessionAuthenticationMethod.new(
   aal: null,
   completed_at: null,
-  method: null
+  method: null,
+  provider: null
 )
 ```
 

data/docs/SettingsFlow.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **active** | **String** | Active, if set, contains the registration method that is being used. It is initially not set. | [optional] |
+| **continue_with** | [**Array<ContinueWith>**](ContinueWith.md) | Contains a list of actions, that could follow this flow  It can, for example, contain a reference to the verification flow, created as part of the user's registration. | [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 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) |  |  |
@@ -22,6 +23,7 @@ require 'ory-kratos-client'
 
 instance = OryKratosClient::SettingsFlow.new(
   active: null,
+  continue_with: null,
   expires_at: null,
   id: null,
   identity: null,

data/docs/SuccessfulCodeExchangeResponse.md

@@ -0,0 +1,20 @@
+# OryKratosClient::SuccessfulCodeExchangeResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session** | [**Session**](Session.md) |  |  |
+| **session_token** | **String** | The Session Token  A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization Header:  Authorization: bearer ${session-token}  The session token is only issued for API flows, not for Browser flows! | [optional] |
+
+## Example
+
+```ruby
+require 'ory-kratos-client'
+
+instance = OryKratosClient::SuccessfulCodeExchangeResponse.new(
+  session: null,
+  session_token: null
+)
+```
+

data/docs/SuccessfulNativeRegistration.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **continue_with** | [**Array<ContinueWith>**](ContinueWith.md) | Contains a list of actions, that could follow this flow  It can, for example, this will contain a reference to the verification flow, created as part of the user's registration or the token of the session. | [optional] |
 | **identity** | [**Identity**](Identity.md) |  |  |
 | **session** | [**Session**](Session.md) |  | [optional] |
 | **session_token** | **String** | The Session Token  This field is only set when the session hook is configured as a post-registration hook.  A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization Header:  Authorization: bearer ${session-token}  The session token is only issued for API flows, not for Browser flows! | [optional] |
@@ -14,6 +15,7 @@
 require 'ory-kratos-client'
 
 instance = OryKratosClient::SuccessfulNativeRegistration.new(
+  continue_with: null,
   identity: null,
   session: null,
   session_token: null

data/docs/UpdateLoginFlowWithOidcMethod.md

@@ -8,6 +8,7 @@
 | **method** | **String** | Method to use  This field must be set to `oidc` when using the oidc method. |  |
 | **provider** | **String** | The provider to register with |  |
 | **traits** | **Object** | The identity traits. This is a placeholder for the registration flow. | [optional] |
+| **upstream_parameters** | **Object** | UpstreamParameters are the parameters that are passed to the upstream identity provider.  These parameters are optional and depend on what the upstream identity provider supports. Supported parameters are: `login_hint` (string): The `login_hint` parameter suppresses the account chooser and either pre-fills the email box on the sign-in form, or selects the proper session. `hd` (string): The `hd` parameter limits the login/registration process to a Google Organization, e.g. `mycollege.edu`. `prompt` (string): The `prompt` specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g. `select_account`. | [optional] |
 
 ## Example
 
@@ -18,7 +19,8 @@ instance = OryKratosClient::UpdateLoginFlowWithOidcMethod.new(
   csrf_token: null,
   method: null,
   provider: null,
-  traits: null
+  traits: null,
+  upstream_parameters: null
 )
 ```
 

data/docs/UpdateRecoveryFlowWithCodeMethod.md

@@ -4,10 +4,10 @@
 
 | 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] |
+| **code** | **String** | Code from the recovery email  If you want to submit a code, use this field, but make sure to _not_ include the email field, as well. | [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. |  |
+| **email** | **String** | The email address of the account to recover  If the email belongs to a valid account, a recovery email will be sent.  If you want to notify the email address if the account does not exist, see the [notify_unknown_recipients flag](https://www.ory.sh/docs/kratos/self-service/flows/account-recovery-password-reset#attempted-recovery-notifications)  If a code was already sent, including this field in the payload will invalidate the sent code and re-send a new code.  format: email | [optional] |
+| **method** | **String** | Method is the method that should be used for this recovery flow  Allowed values are `link` and `code`. link RecoveryStrategyLink code RecoveryStrategyCode |  |
 
 ## Example
 

data/docs/UpdateRecoveryFlowWithLinkMethod.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **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 |  |
-| **method** | **String** | Method supports `link` only right now. |  |
+| **method** | **String** | Method is the method that should be used for this recovery flow  Allowed values are `link` and `code` link RecoveryStrategyLink code RecoveryStrategyCode |  |
 
 ## Example
 

data/docs/UpdateRegistrationFlowWithOidcMethod.md

@@ -8,6 +8,8 @@
 | **method** | **String** | Method to use  This field must be set to `oidc` when using the oidc method. |  |
 | **provider** | **String** | The provider to register with |  |
 | **traits** | **Object** | The identity traits | [optional] |
+| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |
+| **upstream_parameters** | **Object** | UpstreamParameters are the parameters that are passed to the upstream identity provider.  These parameters are optional and depend on what the upstream identity provider supports. Supported parameters are: `login_hint` (string): The `login_hint` parameter suppresses the account chooser and either pre-fills the email box on the sign-in form, or selects the proper session. `hd` (string): The `hd` parameter limits the login/registration process to a Google Organization, e.g. `mycollege.edu`. `prompt` (string): The `prompt` specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g. `select_account`. | [optional] |
 
 ## Example
 
@@ -18,7 +20,9 @@ instance = OryKratosClient::UpdateRegistrationFlowWithOidcMethod.new(
   csrf_token: null,
   method: null,
   provider: null,
-  traits: null
+  traits: null,
+  transient_payload: null,
+  upstream_parameters: null
 )
 ```
 

data/docs/UpdateRegistrationFlowWithPasswordMethod.md

@@ -8,6 +8,7 @@
 | **method** | **String** | Method to use  This field must be set to `password` when using the password method. |  |
 | **password** | **String** | Password to sign the user up with |  |
 | **traits** | **Object** | The identity's traits |  |
+| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |
 
 ## Example
 
@@ -18,7 +19,8 @@ instance = OryKratosClient::UpdateRegistrationFlowWithPasswordMethod.new(
   csrf_token: null,
   method: null,
   password: null,
-  traits: null
+  traits: null,
+  transient_payload: null
 )
 ```
 

data/docs/UpdateRegistrationFlowWithWebAuthnMethod.md

@@ -7,6 +7,7 @@
 | **csrf_token** | **String** | CSRFToken is the anti-CSRF token | [optional] |
 | **method** | **String** | Method  Should be set to \"webauthn\" when trying to add, update, or remove a webAuthn pairing. |  |
 | **traits** | **Object** | The identity's traits |  |
+| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |
 | **webauthn_register** | **String** | Register a WebAuthn Security Key  It is expected that the JSON returned by the WebAuthn registration process is included here. | [optional] |
 | **webauthn_register_displayname** | **String** | Name of the WebAuthn Security Key to be Added  A human-readable name for the security key which will be added. | [optional] |
 
@@ -19,6 +20,7 @@ instance = OryKratosClient::UpdateRegistrationFlowWithWebAuthnMethod.new(
   csrf_token: null,
   method: null,
   traits: null,
+  transient_payload: null,
   webauthn_register: null,
   webauthn_register_displayname: null
 )

data/docs/UpdateSettingsFlowWithOidcMethod.md

@@ -9,6 +9,7 @@
 | **method** | **String** | Method  Should be set to profile when trying to update a profile. |  |
 | **traits** | **Object** | The identity's traits  in: body | [optional] |
 | **unlink** | **String** | Unlink this provider  Either this or `link` must be set.  type: string in: body | [optional] |
+| **upstream_parameters** | **Object** | UpstreamParameters are the parameters that are passed to the upstream identity provider.  These parameters are optional and depend on what the upstream identity provider supports. Supported parameters are: `login_hint` (string): The `login_hint` parameter suppresses the account chooser and either pre-fills the email box on the sign-in form, or selects the proper session. `hd` (string): The `hd` parameter limits the login/registration process to a Google Organization, e.g. `mycollege.edu`. `prompt` (string): The `prompt` specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g. `select_account`. | [optional] |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = OryKratosClient::UpdateSettingsFlowWithOidcMethod.new(
   link: null,
   method: null,
   traits: null,
-  unlink: null
+  unlink: null,
+  upstream_parameters: null
 )
 ```
 

data/docs/UpdateVerificationFlowBody.md

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

data/docs/UpdateVerificationFlowWithCodeMethod.md

@@ -0,0 +1,24 @@
+# OryKratosClient::UpdateVerificationFlowWithCodeMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Code from the recovery email  If you want to submit a code, use this field, but make sure to _not_ include the email field, as well. | [optional] |
+| **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
+| **email** | **String** | The email address to verify  If the email belongs to a valid account, a verifiation email will be sent.  If you want to notify the email address if the account does not exist, see the [notify_unknown_recipients flag](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation#attempted-verification-notifications)  If a code was already sent, including this field in the payload will invalidate the sent code and re-send a new code.  format: email | [optional] |
+| **method** | **String** | Method is the method that should be used for this verification flow  Allowed values are `link` and `code`. link VerificationStrategyLink code VerificationStrategyCode |  |
+
+## Example
+
+```ruby
+require 'ory-kratos-client'
+
+instance = OryKratosClient::UpdateVerificationFlowWithCodeMethod.new(
+  code: null,
+  csrf_token: null,
+  email: null,
+  method: null
+)
+```
+

data/docs/UpdateVerificationFlowWithLinkMethod.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
 | **email** | **String** | Email to Verify  Needs to be set when initiating the flow. If the email is a registered verification email, a verification link will be sent. If the email is not known, a email with details on what happened will be sent instead.  format: email |  |
-| **method** | **String** | Method supports `link` only right now. |  |
+| **method** | **String** | Method is the method that should be used for this verification flow  Allowed values are `link` and `code` link VerificationStrategyLink code VerificationStrategyCode |  |
 
 ## Example
 

data/lib/ory-kratos-client/api/courier_api.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.11.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1