@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
70 lines (69 loc) • 5.32 kB
TypeScript
/**
* 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.20.10
* Contact: support@ory.sh
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Update Verification Flow with Link Method
* @export
* @interface UpdateVerificationFlowWithLinkMethod
*/
export interface UpdateVerificationFlowWithLinkMethod {
/**
* Sending the anti-csrf token is only required for browser login flows.
* @type {string}
* @memberof UpdateVerificationFlowWithLinkMethod
*/
csrf_token?: 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
* @type {string}
* @memberof UpdateVerificationFlowWithLinkMethod
*/
email: string;
/**
* Method is the method that should be used for this verification flow
*
* Allowed values are `link` and `code`
* link VerificationStrategyLink
* code VerificationStrategyCode
* @type {string}
* @memberof UpdateVerificationFlowWithLinkMethod
*/
method: UpdateVerificationFlowWithLinkMethodMethodEnum;
/**
* Transient data to pass along to any webhooks
* @type {object}
* @memberof UpdateVerificationFlowWithLinkMethod
*/
transient_payload?: object;
}
/**
* @export
*/
export declare const UpdateVerificationFlowWithLinkMethodMethodEnum: {
readonly Link: "link";
readonly Code: "code";
readonly UnknownDefaultOpenApi: "11184809";
};
export type UpdateVerificationFlowWithLinkMethodMethodEnum = typeof UpdateVerificationFlowWithLinkMethodMethodEnum[keyof typeof UpdateVerificationFlowWithLinkMethodMethodEnum];
/**
* Check if a given object implements the UpdateVerificationFlowWithLinkMethod interface.
*/
export declare function instanceOfUpdateVerificationFlowWithLinkMethod(value: object): value is UpdateVerificationFlowWithLinkMethod;
export declare function UpdateVerificationFlowWithLinkMethodFromJSON(json: any): UpdateVerificationFlowWithLinkMethod;
export declare function UpdateVerificationFlowWithLinkMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateVerificationFlowWithLinkMethod;
export declare function UpdateVerificationFlowWithLinkMethodToJSON(json: any): UpdateVerificationFlowWithLinkMethod;
export declare function UpdateVerificationFlowWithLinkMethodToJSONTyped(value?: UpdateVerificationFlowWithLinkMethod | null, ignoreDiscriminator?: boolean): any;