@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
76 lines (75 loc) • 4.91 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.
*/
/**
* MessageDispatch represents an attempt of sending a courier message
* It contains the status of the attempt (failed or successful) and the error if any occured
* @export
* @interface MessageDispatch
*/
export interface MessageDispatch {
/**
* CreatedAt is a helper struct field for gobuffalo.pop.
* @type {Date}
* @memberof MessageDispatch
*/
created_at: Date;
/**
*
* @type {object}
* @memberof MessageDispatch
*/
error?: object;
/**
* The ID of this message dispatch
* @type {string}
* @memberof MessageDispatch
*/
id: string;
/**
* The ID of the message being dispatched
* @type {string}
* @memberof MessageDispatch
*/
message_id: string;
/**
* The status of this dispatch
* Either "failed" or "success"
* failed CourierMessageDispatchStatusFailed
* success CourierMessageDispatchStatusSuccess
* @type {string}
* @memberof MessageDispatch
*/
status: MessageDispatchStatusEnum;
/**
* UpdatedAt is a helper struct field for gobuffalo.pop.
* @type {Date}
* @memberof MessageDispatch
*/
updated_at: Date;
}
/**
* @export
*/
export declare const MessageDispatchStatusEnum: {
readonly Failed: "failed";
readonly Success: "success";
readonly UnknownDefaultOpenApi: "11184809";
};
export type MessageDispatchStatusEnum = typeof MessageDispatchStatusEnum[keyof typeof MessageDispatchStatusEnum];
/**
* Check if a given object implements the MessageDispatch interface.
*/
export declare function instanceOfMessageDispatch(value: object): value is MessageDispatch;
export declare function MessageDispatchFromJSON(json: any): MessageDispatch;
export declare function MessageDispatchFromJSONTyped(json: any, ignoreDiscriminator: boolean): MessageDispatch;
export declare function MessageDispatchToJSON(json: any): MessageDispatch;
export declare function MessageDispatchToJSONTyped(value?: MessageDispatch | null, ignoreDiscriminator?: boolean): any;