import { APILink } from '@vonage/server-client';

/**
 * Represents the response when retrieving a template fragment.
 */
type TemplateFragmentResponse = {
    /**
     * Unique identifier for the template fragment.
     * @example "c70f446e-997a-4313-a081-60a02a31dc19"
     */
    template_fragment_id: string;
    /**
     * The communication channel for the fragment (e.g., sms, voice, email).
     * @example "sms"
     */
    channel: 'sms' | 'voice';
    /**
     * Locale in IETF BCP 47 format.
     * @example "en-us"
     */
    locale: string;
    /**
     * Text content of the template fragment.
     * @example "Text content of the template. May contain 4 reserved variables: `${code}`, `${brand}`, `${time-limit}` and `${time-limit-unit}`"
     */
    text: string;
    /**
     * The date when the template fragment was last updated, in ISO 8601 format.
     * @example "2023-08-30T15:20:15.17865735Z"
     */
    date_updated: string;
    /**
     * The date when the template fragment was created, in ISO 8601 format.
     * @example "2021-08-30T20:12:15.17865735Z"
     */
    date_created: string;
    /**
     * HAL format links related to the template fragment.
     */
    _links: {
        /**
         * A link to the template fragment itself.
         */
        self: APILink;
        /**
         * A link to the parent template this fragment belongs to.
         */
        template: APILink;
    };
};

export type { TemplateFragmentResponse };