@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
132 lines (131 loc) • 6.38 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.
*/
import type { CourierMessageStatus } from './CourierMessageStatus';
import type { MessageDispatch } from './MessageDispatch';
import type { CourierMessageType } from './CourierMessageType';
/**
*
* @export
* @interface Message
*/
export interface Message {
/**
*
* @type {string}
* @memberof Message
*/
body: string;
/**
*
* @type {string}
* @memberof Message
*/
channel?: string;
/**
* CreatedAt is a helper struct field for gobuffalo.pop.
* @type {Date}
* @memberof Message
*/
created_at: Date;
/**
* Dispatches store information about the attempts of delivering a message
* May contain an error if any happened, or just the `success` state.
* @type {Array<MessageDispatch>}
* @memberof Message
*/
dispatches?: Array<MessageDispatch>;
/**
*
* @type {string}
* @memberof Message
*/
id: string;
/**
*
* @type {string}
* @memberof Message
*/
recipient: string;
/**
*
* @type {number}
* @memberof Message
*/
send_count: number;
/**
*
* @type {CourierMessageStatus}
* @memberof Message
*/
status: CourierMessageStatus;
/**
*
* @type {string}
* @memberof Message
*/
subject: string;
/**
*
* recovery_invalid TypeRecoveryInvalid
* recovery_valid TypeRecoveryValid
* recovery_code_invalid TypeRecoveryCodeInvalid
* recovery_code_valid TypeRecoveryCodeValid
* verification_invalid TypeVerificationInvalid
* verification_valid TypeVerificationValid
* verification_code_invalid TypeVerificationCodeInvalid
* verification_code_valid TypeVerificationCodeValid
* stub TypeTestStub
* login_code_valid TypeLoginCodeValid
* registration_code_valid TypeRegistrationCodeValid
* @type {string}
* @memberof Message
*/
template_type: MessageTemplateTypeEnum;
/**
*
* @type {CourierMessageType}
* @memberof Message
*/
type: CourierMessageType;
/**
* UpdatedAt is a helper struct field for gobuffalo.pop.
* @type {Date}
* @memberof Message
*/
updated_at: Date;
}
/**
* @export
*/
export declare const MessageTemplateTypeEnum: {
readonly RecoveryInvalid: "recovery_invalid";
readonly RecoveryValid: "recovery_valid";
readonly RecoveryCodeInvalid: "recovery_code_invalid";
readonly RecoveryCodeValid: "recovery_code_valid";
readonly VerificationInvalid: "verification_invalid";
readonly VerificationValid: "verification_valid";
readonly VerificationCodeInvalid: "verification_code_invalid";
readonly VerificationCodeValid: "verification_code_valid";
readonly Stub: "stub";
readonly LoginCodeValid: "login_code_valid";
readonly RegistrationCodeValid: "registration_code_valid";
readonly UnknownDefaultOpenApi: "11184809";
};
export type MessageTemplateTypeEnum = typeof MessageTemplateTypeEnum[keyof typeof MessageTemplateTypeEnum];
/**
* Check if a given object implements the Message interface.
*/
export declare function instanceOfMessage(value: object): value is Message;
export declare function MessageFromJSON(json: any): Message;
export declare function MessageFromJSONTyped(json: any, ignoreDiscriminator: boolean): Message;
export declare function MessageToJSON(json: any): Message;
export declare function MessageToJSONTyped(value?: Message | null, ignoreDiscriminator?: boolean): any;