@leancodepl/kratos
Version:
Headless React components library for building Ory Kratos authentication flows
121 lines • 3.54 kB
TypeScript
import { CourierMessageStatus } from './CourierMessageStatus';
import { MessageDispatch } from './MessageDispatch';
import { 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;
//# sourceMappingURL=Message.d.ts.map