Type Alias EmailTemplate

Type declaration

• EMAIL_TEMPLATE_TYPE: string

  Email template type key used to build the IDM id: 'emailTemplate/'

• createEmailTemplate:function

  • createEmailTemplate(
        templateId: string,
        templateData: EmailTemplateSkeleton,
    ): Promise<EmailTemplateSkeleton>

    Create email template

    Parameters

    • templateId: string

      id/name of the email template without the type prefix
    • templateData: EmailTemplateSkeleton

      email template object

    Returns Promise<EmailTemplateSkeleton>

    a promise that resolves to an email template object

• createEmailTemplateExportTemplate:function

  • createEmailTemplateExportTemplate(): EmailTemplateExportInterface

    Create an empty email template export template

    Returns EmailTemplateExportInterface

    an empty email template export template

• deleteEmailTemplate:function

  • deleteEmailTemplate(templateId: string): Promise<EmailTemplateSkeleton>

    Delete email template

    Parameters

    • templateId: string

      id/name of the email template without the type prefix 'emailTemplate/'

    Returns Promise<EmailTemplateSkeleton>

    a promise that resolves an email template object

• deleteEmailTemplates:function

  • deleteEmailTemplates(): Promise<EmailTemplateSkeleton[]>

    Delete all email templates

    Returns Promise<EmailTemplateSkeleton[]>

    a promise that resolves to an array of email template objects

• exportEmailTemplates:function

  • exportEmailTemplates(): Promise<EmailTemplateExportInterface>

    Export all email templates. The response can be saved to file as is.

    Returns Promise<EmailTemplateExportInterface>

    Promise resolving to a EmailTemplateExportInterface object.

• getEmailTemplate:function

  • getEmailTemplate(templateId: string): Promise<EmailTemplateSkeleton>

    Get email template

    Parameters

    • templateId: string

      id/name of the email template without the type prefix

    Returns Promise<EmailTemplateSkeleton>

    a promise that resolves an email template object

    Deprecated

    since v2.0.0 use readEmailTemplate instead

    readEmailTemplate(templateId: string): Promise<EmailTemplateSkeleton>
    Copy

• getEmailTemplates:function

  • getEmailTemplates(): Promise<EmailTemplateSkeleton[]>

    Get all email templates

    Returns Promise<EmailTemplateSkeleton[]>

    a promise that resolves to an array of email template objects

    Deprecated

    since v2.0.0 use readEmailTemplates instead

    readEmailTemplates(): Promise<EmailTemplateSkeleton[]>
    Copy

• importEmailTemplates:function

  • importEmailTemplates(
        importData: EmailTemplateExportInterface,
    ): Promise<EmailTemplateSkeleton[]>

    Import all email templates

    Parameters

    • importData: EmailTemplateExportInterface

      import data

    Returns Promise<EmailTemplateSkeleton[]>

    a promise resolving to an array of email template objects

• putEmailTemplate:function

  • putEmailTemplate(
        templateId: string,
        templateData: EmailTemplateSkeleton,
    ): Promise<EmailTemplateSkeleton>

    Put email template

    Parameters

    • templateId: string

      id/name of the email template without the type prefix
    • templateData: EmailTemplateSkeleton

      email template object

    Returns Promise<EmailTemplateSkeleton>

    a promise that resolves to an email template object

    Deprecated

    since v2.0.0 use updateEmailTemplate or createEmailTemplate instead

    updateEmailTemplate(templateId: string, templateData: EmailTemplateSkeleton): Promise<EmailTemplateSkeleton>
    createEmailTemplate(templateId: string, templateData: EmailTemplateSkeleton): Promise<EmailTemplateSkeleton>
    Copy

• readEmailTemplate:function

  • readEmailTemplate(templateId: string): Promise<EmailTemplateSkeleton>

    Get email template

    Parameters

    • templateId: string

      id/name of the email template without the type prefix

    Returns Promise<EmailTemplateSkeleton>

    a promise that resolves an email template object

• readEmailTemplates:function

  • readEmailTemplates(): Promise<EmailTemplateSkeleton[]>

    Get all email templates

    Returns Promise<EmailTemplateSkeleton[]>

    a promise that resolves to an array of email template objects

• updateEmailTemplate:function

  • updateEmailTemplate(
        templateId: string,
        templateData: EmailTemplateSkeleton,
    ): Promise<EmailTemplateSkeleton>

    Update or create email template

    Parameters

    • templateId: string

      id/name of the email template without the type prefix
    • templateData: EmailTemplateSkeleton

      email template object

    Returns Promise<EmailTemplateSkeleton>

    a promise that resolves to an email template object