@telstra/messaging/dist/schemas/Schemas.d.ts

Telstra SDK Messaging

export declare abstract class Schemas {
    static readonly SEND_MESSAGE: {
        properties: {
            to: {
                oneOf: ({
                    type: string;
                    minLength: number;
                    maxLength: number;
                    minItems?: undefined;
                    maxItems?: undefined;
                    uniqueItems?: undefined;
                    items?: undefined;
                } | {
                    type: string;
                    minItems: number;
                    maxItems: number;
                    uniqueItems: boolean;
                    items: {
                        type: string;
                        minLength: number;
                        maxLength: number;
                    };
                    minLength?: undefined;
                    maxLength?: undefined;
                })[];
            };
            from: {
                type: string;
                minLength: number;
                maxLength: number;
            };
            messageContent: {
                type: string;
                minLength: number;
                maxLength: number;
            };
            multimedia: {
                type: string;
                minItems: number;
                maxItems: number;
                items: {
                    type: string;
                    required: string[];
                    properties: {
                        type: {
                            type: string;
                            minLength: number;
                            maxLength: number;
                            enum: string[];
                        };
                        fileName: {
                            type: string;
                            minLength: number;
                            maxLength: number;
                        };
                        payload: {
                            type: string;
                            minLength: number;
                            maxLength: number;
                        };
                    };
                };
            };
            retryTimeout: {
                type: string;
                minimum: number;
                maximum: number;
            };
            scheduleSend: {
                type: string;
            };
            deliveryNotification: {
                type: string;
            };
            statusCallbackUrl: {
                type: string;
            };
            queuePriority: {
                type: string;
                minimum: number;
                maximum: number;
            };
            tags: {
                type: string;
                minItems: number;
                maxItems: number;
                items: {
                    type: string;
                    minLength: number;
                    maxLength: number;
                };
            };
        };
        required: string[];
        oneOf: {
            required: string[];
        }[];
    };
    static readonly UPDATE_MESSAGE: {
        properties: {
            messageId: {
                type: string;
                minLength: number;
                maxLength: number;
                format: string;
            };
            to: {
                type: string;
                minLength: number;
                maxLength: number;
            };
            from: {
                type: string;
                minLength: number;
                maxLength: number;
            };
            messageContent: {
                type: string;
                minLength: number;
                maxLength: number;
            };
            multimedia: {
                type: string;
                minItems: number;
                maxItems: number;
                items: {
                    type: string;
                    required: string[];
                    properties: {
                        type: {
                            type: string;
                            minLength: number;
                            maxLength: number;
                            enum: string[];
                        };
                        fileName: {
                            type: string;
                            minLength: number;
                            maxLength: number;
                        };
                        payload: {
                            type: string;
                            minLength: number;
                            maxLength: number;
                        };
                    };
                };
            };
            retryTimeout: {
                type: string;
                minimum: number;
                maximum: number;
            };
            scheduleSend: {
                type: string;
            };
            deliveryNotification: {
                type: string;
            };
            statusCallbackUrl: {
                type: string;
            };
            queuePriority: {
                type: string;
                minimum: number;
                maximum: number;
            };
            tags: {
                type: string;
                minItems: number;
                maxItems: number;
                items: {
                    type: string;
                    minLength: number;
                    maxLength: number;
                };
            };
        };
        required: string[];
        oneOf: {
            required: string[];
        }[];
        nullable: boolean;
    };
    static readonly UPDATE_MESSAGE_TAGS: {
        properties: {
            messageId: {
                type: string;
                minLength: number;
                maxLength: number;
                format: string;
            };
            tags: {
                type: string;
                minItems: number;
                maxItems: number;
                items: {
                    type: string;
                    minLength: number;
                    maxLength: number;
                };
            };
        };
        required: string[];
    };
    static readonly GET_ALL: {
        properties: {
            limit: {
                type: string;
                minimum: number;
                maximum: number;
            };
            offset: {
                type: string;
                minimum: number;
                maximum: number;
            };
            filter: {
                type: string;
            };
        };
    };
    static readonly CREATE_FREETRIAL_NUMBER: {
        properties: {
            freeTrialNumbers: {
                type: string;
                items: {
                    type: string;
                    minLength: number;
                    maxLength: number;
                };
                minItems: number;
                maxItems: number;
                uniqueItems: boolean;
            };
        };
        additionalProperties: boolean;
    };
    static readonly CREATE_MESSAGES_REPORT: {
        properties: {
            startDate: {
                type: string;
                format: string;
                minLength: number;
                maxLength: number;
            };
            endDate: {
                type: string;
                format: string;
                minLength: number;
                maxLength: number;
            };
            reportCallbackUrl: {
                type: string;
            };
            filter: {
                type: string;
            };
        };
        required: string[];
    };
}