ory_client/models/update_recovery_flow_with_code_method.rs
1/*
2 * Ory APIs
3 *
4 * # 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) |
5 *
6 * The version of the OpenAPI document: v1.22.4
7 * Contact: support@ory.sh
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// UpdateRecoveryFlowWithCodeMethod : Update Recovery Flow with Code Method
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct UpdateRecoveryFlowWithCodeMethod {
17 /// 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.
18 #[serde(rename = "code", skip_serializing_if = "Option::is_none")]
19 pub code: Option<String>,
20 /// Sending the anti-csrf token is only required for browser login flows.
21 #[serde(rename = "csrf_token", skip_serializing_if = "Option::is_none")]
22 pub csrf_token: Option<String>,
23 /// 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
24 #[serde(rename = "email", skip_serializing_if = "Option::is_none")]
25 pub email: Option<String>,
26 /// Method is the method that should be used for this recovery flow Allowed values are `link` and `code`. link RecoveryStrategyLink code RecoveryStrategyCode
27 #[serde(rename = "method")]
28 pub method: MethodEnum,
29 /// A recovery address that is registered for the user. It can be an email, a phone number (to receive the code via SMS), etc. Used in RecoveryV2.
30 #[serde(rename = "recovery_address", skip_serializing_if = "Option::is_none")]
31 pub recovery_address: Option<String>,
32 /// If there are multiple recovery addresses registered for the user, and the initially provided address is different from the address chosen when the choice (of masked addresses) is presented, then we need to make sure that the user actually knows the full address to avoid information exfiltration, so we ask for the full address. Used in RecoveryV2.
33 #[serde(rename = "recovery_confirm_address", skip_serializing_if = "Option::is_none")]
34 pub recovery_confirm_address: Option<String>,
35 /// If there are multiple addresses registered for the user, a choice is presented and this field stores the result of this choice. Addresses are 'masked' (never sent in full to the client and shown partially in the UI) since at this point in the recovery flow, the user has not yet proven that it knows the full address and we want to avoid information exfiltration. So for all intents and purposes, the value of this field should be treated as an opaque identifier. Used in RecoveryV2.
36 #[serde(rename = "recovery_select_address", skip_serializing_if = "Option::is_none")]
37 pub recovery_select_address: Option<String>,
38 /// Set to \"previous\" to go back in the flow, meaningfully. Used in RecoveryV2.
39 #[serde(rename = "screen", skip_serializing_if = "Option::is_none")]
40 pub screen: Option<String>,
41 /// Transient data to pass along to any webhooks
42 #[serde(rename = "transient_payload", skip_serializing_if = "Option::is_none")]
43 pub transient_payload: Option<serde_json::Value>,
44}
45
46impl UpdateRecoveryFlowWithCodeMethod {
47 /// Update Recovery Flow with Code Method
48 pub fn new(method: MethodEnum) -> UpdateRecoveryFlowWithCodeMethod {
49 UpdateRecoveryFlowWithCodeMethod {
50 code: None,
51 csrf_token: None,
52 email: None,
53 method,
54 recovery_address: None,
55 recovery_confirm_address: None,
56 recovery_select_address: None,
57 screen: None,
58 transient_payload: None,
59 }
60 }
61}
62/// Method is the method that should be used for this recovery flow Allowed values are `link` and `code`. link RecoveryStrategyLink code RecoveryStrategyCode
63#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
64pub enum MethodEnum {
65 #[serde(rename = "link")]
66 Link,
67 #[serde(rename = "code")]
68 Code,
69}
70
71impl Default for MethodEnum {
72 fn default() -> MethodEnum {
73 Self::Link
74 }
75}
76