/*
* Ory APIs
*
* # Introduction Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages: | Language | Download SDK | Documentation | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart | [pub.dev](https://pub.dev/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md) | | .NET | [nuget.org](https://www.nuget.org/packages/Ory.Client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md) | | Elixir | [hex.pm](https://hex.pm/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md) | | Go | [github.com](https://github.com/ory/client-go) | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md) | | Java | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md) | | JavaScript | [npmjs.com](https://www.npmjs.com/package/@ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) | | PHP | [packagist.org](https://packagist.org/packages/ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md) | | Python | [pypi.org](https://pypi.org/project/ory-client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md) | | Ruby | [rubygems.org](https://rubygems.org/gems/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md) | | Rust | [crates.io](https://crates.io/crates/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md) |
*
* The version of the OpenAPI document: v1.22.41
* Contact: support@ory.sh
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// RecoveryFlow : This request is used when an identity wants to recover their account. We recommend reading the [Account Recovery Documentation](../self-service/flows/password-reset-account-recovery)
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct RecoveryFlow {
/// Active, if set, contains the recovery method that is being used. It is initially not set.
#[serde(rename = "active", skip_serializing_if = "Option::is_none")]
pub active: Option<String>,
/// Contains possible actions that could follow this flow
#[serde(rename = "continue_with", skip_serializing_if = "Option::is_none")]
pub continue_with: Option<Vec<models::ContinueWith>>,
/// 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.
#[serde(rename = "expires_at")]
pub expires_at: 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>
#[serde(rename = "id")]
pub id: String,
/// IssuedAt is the time (UTC) when the request occurred.
#[serde(rename = "issued_at")]
pub issued_at: 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.
#[serde(rename = "request_url")]
pub request_url: String,
/// ReturnTo contains the requested return_to URL.
#[serde(rename = "return_to", skip_serializing_if = "Option::is_none")]
pub return_to: Option<String>,
/// State represents the state of this request: choose_method: ask the user to choose a method (e.g. recover account via email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the recovery challenge was passed.
#[serde(rename = "state", deserialize_with = "Option::deserialize")]
pub state: Option<serde_json::Value>,
/// TransientPayload is used to pass data from the recovery flow to hooks and email templates
#[serde(rename = "transient_payload", skip_serializing_if = "Option::is_none")]
pub transient_payload: Option<serde_json::Value>,
/// The flow type can either be `api` or `browser`.
#[serde(rename = "type")]
pub r#type: String,
#[serde(rename = "ui")]
pub ui: Box<models::UiContainer>,
}
impl RecoveryFlow {
/// This request is used when an identity wants to recover their account. We recommend reading the [Account Recovery Documentation](../self-service/flows/password-reset-account-recovery)
pub fn new(expires_at: String, id: String, issued_at: String, request_url: String, state: Option<serde_json::Value>, r#type: String, ui: models::UiContainer) -> RecoveryFlow {
RecoveryFlow {
active: None,
continue_with: None,
expires_at,
id,
issued_at,
request_url,
return_to: None,
state,
transient_payload: None,
r#type,
ui: Box::new(ui),
}
}
}