@epilot/sdk 2.1.0-rc.1 → 2.1.1

package/dist/email-template-M2VVL4TI.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/email-template.json
+var email_template_default = '# Email template API\n\n- **Base URL:** `https://email-template.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/email-template](https://docs.epilot.io/api/email-template)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.emailTemplate.saveTemplate(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/email-template\'\n\nconst emailTemplateClient = getClient()\nauthorize(emailTemplateClient, () => \'<token>\')\nconst { data } = await emailTemplateClient.saveTemplate(...)\n```\n\n## Operations\n\n**Email templates**\n- [`saveTemplate`](#savetemplate)\n- [`getTemplateDetail`](#gettemplatedetail)\n- [`updateTemplateDetail`](#updatetemplatedetail)\n- [`bulkSendMessage`](#bulksendmessage)\n- [`revertToOriginalTemplate`](#reverttooriginaltemplate)\n\n**Variables**\n- [`replaceVariablesAsync`](#replacevariablesasync)\n\n**Schemas**\n- [`BaseEntity`](#baseentity)\n- [`EmailTemplateRequest`](#emailtemplaterequest)\n- [`EmailTemplateEntity`](#emailtemplateentity)\n- [`Attachment`](#attachment)\n- [`From`](#from)\n- [`To`](#to)\n- [`PresignedRequest`](#presignedrequest)\n- [`PresignedResponse`](#presignedresponse)\n- [`AttachmentResponse`](#attachmentresponse)\n- [`UserResponse`](#userresponse)\n- [`VariableParameters`](#variableparameters)\n- [`TemplateType`](#templatetype)\n- [`EmailTemplateResponse`](#emailtemplateresponse)\n- [`AsyncEmailTemplateResponse`](#asyncemailtemplateresponse)\n- [`SkipCreatingEntities`](#skipcreatingentities)\n- [`CompleteThread`](#completethread)\n- [`BulkSendMessageRequest`](#bulksendmessagerequest)\n- [`BulkSendMessageRequestWithQuery`](#bulksendmessagerequestwithquery)\n- [`CustomVariables`](#customvariables)\n- [`BulkSendMessageJob`](#bulksendmessagejob)\n- [`CreateSystemTemplatesReq`](#createsystemtemplatesreq)\n- [`CreateSystemTemplatesResp`](#createsystemtemplatesresp)\n- [`OrgId`](#orgid)\n- [`CreatedBy`](#createdby)\n- [`CreatedAt`](#createdat)\n- [`UpdatedAt`](#updatedat)\n- [`ApprovedAt`](#approvedat)\n- [`ApproveAction`](#approveaction)\n- [`TaskToken`](#tasktoken)\n\n### `saveTemplate`\n\nCreate or update a template. If `id` is provided, it will update the template.\n\n`POST /v1/email-template/templates`\n\n```ts\nconst { data } = await client.saveTemplate(\n  null,\n  {\n    _id: \'cd7809ba-a111-4dd9-8d15-18eb4de0faed\',\n    _tags: [\'template\'],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n    _purpose: [\'a0ec23ac-12f8-4d89-9a63-91cba3787f2a\', \'310cd388-2f15-4b5b-8f98-ca14c1e03304\'],\n    name: \'Order confirmation\',\n    brand_id: 0,\n    from: {\n      name: \'epilot\',\n      email: \'no-reply@epilot.cloud\'\n    },\n    to: [\n      {\n        name: \'Ny Huynh\',\n        email: \'ny.huynh@axonactive.com\'\n      }\n    ],\n    cc: [\n      {\n        name: \'Ny Huynh\',\n        email: \'ny.huynh@axonactive.com\'\n      }\n    ],\n    bcc: [\n      {\n        name: \'Ny Huynh\',\n        email: \'ny.huynh@axonactive.com\'\n      }\n    ],\n    subject: \'We have received your order!\',\n    body: \'Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly\',\n    attachments: [\n      {\n        cid: \'f820ce3b-07b0-45ae-bcc6-babb2f53f79f\',\n        filename: \'Produktinformationen_epilot360_Double_Opt_in.pdf\',\n        size: 451349,\n        content_type: \'application/pdf\',\n        url: \'https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf\',\n        bucket: \'893487340562-message-attachment\',\n        object_key: \'attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf\',\n        inline: false,\n        send_as_link: false,\n        type: \'Document template\',\n        copy_to_message: true\n      }\n    ],\n    file: {\n      $relation: [\n        {}\n      ]\n    },\n    system_template: false,\n    created_by: 1234,\n    updated_by: 1234,\n    json_template: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["automatic email template"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "_purpose": ["a0ec23ac-12f8-4d89-9a63-91cba3787f2a", "310cd388-2f15-4b5b-8f98-ca14c1e03304"],\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "name": "Order confirmation",\n  "brand_id": 0,\n  "from": {\n    "name": "epilot",\n    "email": "no-reply@epilot.cloud"\n  },\n  "to": [\n    {\n      "name": "Ny Huynh",\n      "email": "ny.huynh@axonactive.com"\n    }\n  ],\n  "cc": [\n    {\n      "name": "Ny Huynh",\n      "email": "ny.huynh@axonactive.com"\n    }\n  ],\n  "bcc": [\n    {\n      "name": "Ny Huynh",\n      "email": "ny.huynh@axonactive.com"\n    }\n  ],\n  "subject": "We have received your order!",\n  "body": "Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly",\n  "attachments": [\n    {\n      "cid": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n      "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n      "size": 451349,\n      "content_type": "application/pdf",\n      "url": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n      "bucket": "893487340562-message-attachment",\n      "object_key": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n      "inline": false,\n      "send_as_link": false,\n      "type": "Document template",\n      "copy_to_message": true\n    }\n  ],\n  "file": {\n    "$relation": [\n      {}\n    ]\n  },\n  "created_by": 1234,\n  "updated_by": 1234,\n  "json_template": "string",\n  "system_template": false\n}\n```\n\n</details>\n\n---\n\n### `getTemplateDetail`\n\nGet email template by ID\n\n`GET /v1/email-template/templates/{id}`\n\n```ts\nconst { data } = await client.getTemplateDetail({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity": {\n    "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "_title": "string",\n    "_org": "206801",\n    "_schema": "message",\n    "_tags": ["automatic email template"],\n    "_created_at": "2021-02-09T12:41:43.662Z",\n    "_updated_at": "2021-02-10T09:14:31.990Z",\n    "_purpose": ["a0ec23ac-12f8-4d89-9a63-91cba3787f2a", "310cd388-2f15-4b5b-8f98-ca14c1e03304"],\n    "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n    "name": "Order confirmation",\n    "brand_id": 0,\n    "from": {\n      "name": "epilot",\n      "email": "no-reply@epilot.cloud"\n    },\n    "to": [\n      {\n        "name": "Ny Huynh",\n        "email": "ny.huynh@axonactive.com"\n      }\n    ],\n    "cc": [\n      {\n        "name": "Ny Huynh",\n        "email": "ny.huynh@axonactive.com"\n      }\n    ],\n    "bcc": [\n      {\n        "name": "Ny Huynh",\n        "email": "ny.huynh@axonactive.com"\n      }\n    ],\n    "subject": "We have received your order!",\n    "body": "Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly",\n    "attachments": [\n      {\n        "cid": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "size": 451349,\n        "content_type": "application/pdf",\n        "url": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "bucket": "893487340562-message-attachment",\n        "object_key": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "inline": false,\n        "send_as_link": false,\n        "type": "Document template",\n        "copy_to_message": true\n      }\n    ],\n    "file": {\n      "$relation": [\n        {}\n      ]\n    },\n    "created_by": 1234,\n    "updated_by": 1234,\n    "json_template": "string",\n    "system_template": false\n  },\n  "relations": [\n    {}\n  ]\n}\n```\n\n</details>\n\n---\n\n### `updateTemplateDetail`\n\nUpdate email template by ID\n\n`PUT /v1/email-template/templates/{id}`\n\n```ts\nconst { data } = await client.updateTemplateDetail(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    _id: \'cd7809ba-a111-4dd9-8d15-18eb4de0faed\',\n    _tags: [\'template\'],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n    _purpose: [\'a0ec23ac-12f8-4d89-9a63-91cba3787f2a\', \'310cd388-2f15-4b5b-8f98-ca14c1e03304\'],\n    name: \'Order confirmation\',\n    brand_id: 0,\n    from: {\n      name: \'epilot\',\n      email: \'no-reply@epilot.cloud\'\n    },\n    to: [\n      {\n        name: \'Ny Huynh\',\n        email: \'ny.huynh@axonactive.com\'\n      }\n    ],\n    cc: [\n      {\n        name: \'Ny Huynh\',\n        email: \'ny.huynh@axonactive.com\'\n      }\n    ],\n    bcc: [\n      {\n        name: \'Ny Huynh\',\n        email: \'ny.huynh@axonactive.com\'\n      }\n    ],\n    subject: \'We have received your order!\',\n    body: \'Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly\',\n    attachments: [\n      {\n        cid: \'f820ce3b-07b0-45ae-bcc6-babb2f53f79f\',\n        filename: \'Produktinformationen_epilot360_Double_Opt_in.pdf\',\n        size: 451349,\n        content_type: \'application/pdf\',\n        url: \'https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf\',\n        bucket: \'893487340562-message-attachment\',\n        object_key: \'attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf\',\n        inline: false,\n        send_as_link: false,\n        type: \'Document template\',\n        copy_to_message: true\n      }\n    ],\n    file: {\n      $relation: [\n        {}\n      ]\n    },\n    system_template: false,\n    created_by: 1234,\n    updated_by: 1234,\n    json_template: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["automatic email template"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "_purpose": ["a0ec23ac-12f8-4d89-9a63-91cba3787f2a", "310cd388-2f15-4b5b-8f98-ca14c1e03304"],\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "name": "Order confirmation",\n  "brand_id": 0,\n  "from": {\n    "name": "epilot",\n    "email": "no-reply@epilot.cloud"\n  },\n  "to": [\n    {\n      "name": "Ny Huynh",\n      "email": "ny.huynh@axonactive.com"\n    }\n  ],\n  "cc": [\n    {\n      "name": "Ny Huynh",\n      "email": "ny.huynh@axonactive.com"\n    }\n  ],\n  "bcc": [\n    {\n      "name": "Ny Huynh",\n      "email": "ny.huynh@axonactive.com"\n    }\n  ],\n  "subject": "We have received your order!",\n  "body": "Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly",\n  "attachments": [\n    {\n      "cid": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n      "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n      "size": 451349,\n      "content_type": "application/pdf",\n      "url": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n      "bucket": "893487340562-message-attachment",\n      "object_key": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n      "inline": false,\n      "send_as_link": false,\n      "type": "Document template",\n      "copy_to_message": true\n    }\n  ],\n  "file": {\n    "$relation": [\n      {}\n    ]\n  },\n  "created_by": 1234,\n  "updated_by": 1234,\n  "json_template": "string",\n  "system_template": false\n}\n```\n\n</details>\n\n---\n\n### `replaceVariablesAsync`\n\nThis endpoint allows to initiate an asynchronous process in replacing the template details & generating the documents.\nOn initial request, a jobId and STARTED status are returned. Subsequent requests \n\n`POST /v1/email-template/templates:replaceAsync`\n\n```ts\nconst { data } = await client.replaceVariablesAsync(\n  {\n    job_id: \'example\',\n  },\n  {\n    email_template_id: \'511ceb90-f738-47aa-8b1e-915ace0ae13c\',\n    variable_parameters: {\n      template_type: \'email\',\n      language: \'en\',\n      main_entity_id: \'63753437-c9e2-4e83-82bb-b1c666514561\',\n      user_id: \'123452\',\n      custom_variables: [\n        {\n          variable: \'{{abc.xyz}}\',\n          value: \'ReplacedValue\'\n        }\n      ]\n    },\n    must_include_unsubscribe_link: false,\n    skip_document_generation: false\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "job_id": "8c086140-f33e-4bb7-a993-50c0f2402c7b",\n  "status": "STARTED",\n  "message": "string",\n  "doc_progress_count": {\n    "total": 10,\n    "completed": 5\n  },\n  "result": {\n    "entity": {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "string",\n      "_org": "206801",\n      "_schema": "message",\n      "_tags": ["automatic email template"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-10T09:14:31.990Z",\n      "_purpose": ["a0ec23ac-12f8-4d89-9a63-91cba3787f2a", "310cd388-2f15-4b5b-8f98-ca14c1e03304"],\n      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n      "name": "Order confirmation",\n      "brand_id": 0,\n      "from": {\n        "name": "epilot",\n        "email": "no-reply@epilot.cloud"\n      },\n      "to": [\n        {\n          "name": "Ny Huynh",\n          "email": "ny.huynh@axonactive.com"\n        }\n      ],\n      "cc": [\n        {\n          "name": "Ny Huynh",\n          "email": "ny.huynh@axonactive.com"\n        }\n      ],\n      "bcc": [\n        {\n          "name": "Ny Huynh",\n          "email": "ny.huynh@axonactive.com"\n        }\n      ],\n      "subject": "We have received your order!",\n      "body": "Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly",\n      "attachments": [\n        {\n          "cid": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n          "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n          "size": 451349,\n          "content_type": "application/pdf",\n          "url": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n          "bucket": "893487340562-message-attachment",\n          "object_key": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n          "inline": false,\n          "send_as_link": false,\n          "type": "Document template",\n          "copy_to_message": true\n        }\n      ],\n      "file": {\n        "$relation": [\n          {}\n        ]\n      },\n      "created_by": 1234,\n      "updated_by": 1234,\n      "json_template": "string",\n      "system_template": false\n    },\n    "relations": [\n      {}\n    ]\n  }\n}\n```\n\n</details>\n\n---\n\n### `bulkSendMessage`\n\nSend emails to multiple recipients using a template\n\n`POST /v1/email-template/templates:bulkSendMessage`\n\n```ts\nconst { data } = await client.bulkSendMessage(\n  null,\n  {\n    skip_creating_entities: true,\n    complete_thread: false,\n    email_template_id: \'511ceb90-f738-47aa-8b1e-915ace0ae13c\',\n    must_include_unsubscribe_link: false,\n    recipient_query: \'_schema:contact AND consent_email_marketing:active\',\n    custom_variables: [\n      {\n        variable: \'{{abc.xyz}}\',\n        value: \'ReplacedValue\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "org_id": "206801",\n  "job_id": "8c086140-f33e-4bb7-a993-50c0f2402c7b",\n  "skip_creating_entities": true,\n  "complete_thread": false,\n  "status": "PROCESSING",\n  "request": {\n    "skip_creating_entities": true,\n    "complete_thread": false,\n    "email_template_id": "511ceb90-f738-47aa-8b1e-915ace0ae13c",\n    "must_include_unsubscribe_link": false,\n    "recipient_ids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7", "3fa85f64-5717-4562-b3fc-2c963f66afa8"],\n    "custom_variables": [\n      {\n        "variable": "{{abc.xyz}}",\n        "value": "ReplacedValue"\n      }\n    ]\n  },\n  "created_by": "1234",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "approved_at": "1970-01-01T00:00:00.000Z",\n  "approve_action": "APPROVE_WITH_CONSENT",\n  "task_token": "8c086140-f33e-4bb7-a993-50c0f2402c7b",\n  "total_queued": 100,\n  "queued": [\n    {\n      "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "email_to": ["recipient@example.com"],\n      "email_with_consent": ["recipient@example.com"]\n    }\n  ],\n  "sent": [\n    {\n      "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "email_to": ["recipient@example.com"]\n    }\n  ],\n  "failed": [\n    {\n      "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "error": "string",\n      "email_to": ["recipient@example.com"]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `revertToOriginalTemplate`\n\nRevert to the original system generated email template\n\n`POST /v1/email-template/templates:revert`\n\n```ts\nconst { data } = await client.revertToOriginalTemplate(\n  null,\n  {\n    email_template_id: \'511ceb90-f738-47aa-8b1e-915ace0ae13c\'\n  },\n)\n```\n\n---\n\n## Schemas\n\n### `BaseEntity`\n\n```ts\ntype BaseEntity = {\n  _id: string\n  _title: string\n  _org: string\n  _schema: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n}\n```\n\n### `EmailTemplateRequest`\n\n```ts\ntype EmailTemplateRequest = {\n  _id?: string\n  _tags?: string[]\n  _manifest?: string // uuid[]\n  _purpose?: string[]\n  name: string\n  brand_id?: number\n  from?: {\n    name?: string\n    email: string\n  }\n  to?: Array<{\n    name?: string\n    email: string\n  }>\n  cc?: Array<{\n    name?: string\n    email: string\n  }>\n  bcc?: Array<{\n    name?: string\n    email: string\n  }>\n  subject: string\n  body?: string\n  attachments?: Array<{\n    cid?: string\n    filename: string\n    size: number\n    content_type: string\n    url?: string\n    bucket: string\n    object_key: string\n    inline?: boolean\n    send_as_link?: boolean\n    type?: string\n    copy_to_message?: boolean\n  }>\n  file?: {\n    $relation?: object[]\n  }\n  system_template?: boolean\n  created_by?: string\n  updated_by?: string\n  json_template?: string\n}\n```\n\n### `EmailTemplateEntity`\n\n```ts\ntype EmailTemplateEntity = {\n  _id: string\n  _title: string\n  _org: string\n  _schema: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  name: string\n  brand_id?: number\n  from?: {\n    name?: string\n    email: string\n  }\n  to?: Array<{\n    name?: string\n    email: string\n  }>\n  cc?: Array<{\n    name?: string\n    email: string\n  }>\n  bcc?: Array<{\n    name?: string\n    email: string\n  }>\n  subject?: string\n  body?: string\n  attachments?: Array<{\n    cid?: string\n    filename: string\n    size: number\n    content_type: string\n    url?: string\n    bucket: string\n    object_key: string\n    inline?: boolean\n    send_as_link?: boolean\n    type?: string\n    copy_to_message?: boolean\n  }>\n  file?: {\n    $relation?: object[]\n  }\n  created_by?: string\n  updated_by?: string\n  json_template?: string\n  system_template?: boolean\n}\n```\n\n### `Attachment`\n\n```ts\ntype Attachment = {\n  cid?: string\n  filename: string\n  size: number\n  content_type: string\n  url?: string\n  bucket: string\n  object_key: string\n  inline?: boolean\n  send_as_link?: boolean\n  type?: string\n  copy_to_message?: boolean\n}\n```\n\n### `From`\n\n```ts\ntype From = {\n  name?: string\n  email: string\n}\n```\n\n### `To`\n\n```ts\ntype To = {\n  name?: string\n  email: string\n}\n```\n\n### `PresignedRequest`\n\n```ts\ntype PresignedRequest = {\n  id: string\n  filename: string\n  content_type: string\n}\n```\n\n### `PresignedResponse`\n\n```ts\ntype PresignedResponse = {\n  download_url: string\n  upload_url: {\n    url: number\n    fields: object\n  }\n}\n```\n\n### `AttachmentResponse`\n\n```ts\ntype AttachmentResponse = {\n  total?: number\n  attachments?: Array<{\n    filename?: string\n    bucket?: string\n    object_key?: string\n    url?: string\n    document_type?: number\n  }>\n}\n```\n\n### `UserResponse`\n\n```ts\ntype UserResponse = {\n  id?: string\n  organization_id?: string\n  display_name?: string\n  email?: string // email\n  phone?: string\n  preferred_language?: string\n  image_uri?: {\n    original?: string // uri\n    thumbnail_32?: string // uri\n  }\n  properties?: Array<{\n    name: string\n    value: string\n  }>\n}\n```\n\n### `VariableParameters`\n\n```ts\ntype VariableParameters = {\n  template_type: "email" | "document"\n  language?: "en" | "de"\n  main_entity_id?: string\n  user_id?: string\n  custom_variables?: Array<{\n    variable?: string\n    value?: string\n  }>\n}\n```\n\n### `TemplateType`\n\n```ts\ntype TemplateType = "email" | "document"\n```\n\n### `EmailTemplateResponse`\n\n```ts\ntype EmailTemplateResponse = {\n  entity?: {\n    _id: string\n    _title: string\n    _org: string\n    _schema: string\n    _tags?: string[]\n    _created_at: string // date-time\n    _updated_at: string // date-time\n    _purpose?: string[]\n    _manifest?: string // uuid[]\n    name: string\n    brand_id?: number\n    from?: {\n      name?: { ... }\n      email: { ... }\n    }\n    to?: Array<{\n      name?: { ... }\n      email: { ... }\n    }>\n    cc?: Array<{\n      name?: { ... }\n      email: { ... }\n    }>\n    bcc?: Array<{\n      name?: { ... }\n      email: { ... }\n    }>\n    subject?: string\n    body?: string\n    attachments?: Array<{\n      cid?: { ... }\n      filename: { ... }\n      size: { ... }\n      content_type: { ... }\n      url?: { ... }\n      bucket: { ... }\n      object_key: { ... }\n      inline?: { ... }\n      send_as_link?: { ... }\n      type?: { ... }\n      copy_to_message?: { ... }\n    }>\n    file?: {\n      $relation?: { ... }\n    }\n    created_by?: string\n    updated_by?: string\n    json_template?: string\n    system_template?: boolean\n  }\n  relations?: object[]\n}\n```\n\n### `AsyncEmailTemplateResponse`\n\n```ts\ntype AsyncEmailTemplateResponse = {\n  job_id: string\n  status: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED"\n  message?: string\n  doc_progress_count?: {\n    total: number\n    completed: number\n  }\n  result?: {\n    entity?: {\n      _id: { ... }\n      _title: { ... }\n      _org: { ... }\n      _schema: { ... }\n      _tags?: { ... }\n      _created_at: { ... }\n      _updated_at: { ... }\n      _purpose?: { ... }\n      _manifest?: { ... }\n      name: { ... }\n      brand_id?: { ... }\n      from?: { ... }\n      to?: { ... }\n      cc?: { ... }\n      bcc?: { ... }\n      subject?: { ... }\n      body?: { ... }\n      attachments?: { ... }\n      file?: { ... }\n      created_by?: { ... }\n      updated_by?: { ... }\n      json_template?: { ... }\n      system_template?: { ... }\n    }\n    relations?: object[]\n  }\n}\n```\n\n### `SkipCreatingEntities`\n\nWhen true, it lets to send only the email by skip creating the thread & message entities.\n\n```ts\ntype SkipCreatingEntities = boolean\n```\n\n### `CompleteThread`\n\nWhether the thread is marked as Done immediately after sending the message\n\n```ts\ntype CompleteThread = boolean\n```\n\n### `BulkSendMessageRequest`\n\nIt takes a list of entity ids, treating each as a separate mainEntity to construct individual messages.\nFor e.g; if there some opportunityIds are provided, then each opportunityId is treated as a separate mainEntity to construct individual messages.\n\n\n```ts\ntype BulkSendMessageRequest = {\n  skip_creating_entities?: boolean\n  complete_thread?: boolean\n  email_template_id: string\n  must_include_unsubscribe_link?: boolean\n  recipient_ids: string[]\n  custom_variables?: Array<{\n    variable?: string\n    value?: string\n  }>\n}\n```\n\n### `BulkSendMessageRequestWithQuery`\n\nIt takes an entity query to derive recipient_ids, treating each as a separate mainEntity to construct individual messages.\nFor e.g; if the query is provided as `_schema:opportunity AND status:PENDING`,\n  then all the opportunity Ids with status PENDING are treated as separate mainEntity to construct\n\n```ts\ntype BulkSendMessageRequestWithQuery = {\n  skip_creating_entities?: boolean\n  complete_thread?: boolean\n  email_template_id: string\n  must_include_unsubscribe_link?: boolean\n  recipient_query: string\n  custom_variables?: Array<{\n    variable?: string\n    value?: string\n  }>\n}\n```\n\n### `CustomVariables`\n\nCustom variables to be replaced in the email template\n\n```ts\ntype CustomVariables = Array<{\n  variable?: string\n  value?: string\n}>\n```\n\n### `BulkSendMessageJob`\n\n```ts\ntype BulkSendMessageJob = {\n  org_id?: string\n  job_id: string\n  skip_creating_entities?: boolean\n  complete_thread?: boolean\n  status: "PROCESSING" | "QUEUEING" | "APPROVAL" | "SENDING" | "SUCCESS" | "FAILED" | "CANCELLED"\n  request: {\n    skip_creating_entities?: boolean\n    complete_thread?: boolean\n    email_template_id: string\n    must_include_unsubscribe_link?: boolean\n    recipient_ids: string[]\n    custom_variables?: Array<{\n      variable?: { ... }\n      value?: { ... }\n    }>\n  } | {\n    skip_creating_entities?: boolean\n    complete_thread?: boolean\n    email_template_id: string\n    must_include_unsubscribe_link?: boolean\n    recipient_query: string\n    custom_variables?: Array<{\n      variable?: { ... }\n      value?: { ... }\n    }>\n  }\n  created_by?: string\n  created_at?: string // date-time\n  updated_at?: string // date-time\n  approved_at?: string // date-time\n  approve_action?: "APPROVE_WITH_CONSENT" | "APPROVE_ALL"\n  task_token?: string\n  total_queued?: number\n  queued?: Array<{\n    entity_id: string\n    email_to: string[]\n    email_with_consent: string[]\n  }>\n  sent?: Array<{\n    entity_id: string\n    message_id: string\n    email_to?: string[]\n  }>\n  failed?: Array<{\n    entity_id: string\n    error: string\n    email_to?: string[]\n  }>\n}\n```\n\n### `CreateSystemTemplatesReq`\n\n```ts\ntype CreateSystemTemplatesReq = {\n  template_names: string[]\n}\n```\n\n### `CreateSystemTemplatesResp`\n\n```ts\ntype CreateSystemTemplatesResp = Array<{\n  _id: string\n  _title: string\n  _org: string\n  _schema: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n}>\n```\n\n### `OrgId`\n\nOrganization ID\n\n```ts\ntype OrgId = string\n```\n\n### `CreatedBy`\n\nUser ID who created the bulk message action\n\n```ts\ntype CreatedBy = string\n```\n\n### `CreatedAt`\n\nTime when the bulk message action was created\n\n```ts\ntype CreatedAt = string // date-time\n```\n\n### `UpdatedAt`\n\nTime when the bulk message action was last updated\n\n```ts\ntype UpdatedAt = string // date-time\n```\n\n### `ApprovedAt`\n\nTime when the bulk message action was last approved\n\n```ts\ntype ApprovedAt = string // date-time\n```\n\n### `ApproveAction`\n\nType of approval action for the bulk message request.\n* APPROVE_WITH_CONSENT: Approve the bulk message request and send emails to queued recipients with consent\n* APPROVE_ALL: Approve the bulk message request and send emails to all queued recipients, including those without consent\n\n\n```ts\ntype ApproveAction = "APPROVE_WITH_CONSENT" | "APPROVE_ALL"\n```\n\n### `TaskToken`\n\nTask token to approve or cancel the bulk message action\n\n```ts\ntype TaskToken = string\n```\n';
+
+
+exports.default = email_template_default;

package/dist/email-template-WYROV3UG.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/email-template.json
+var email_template_default = '# Email template API\n\n- **Base URL:** `https://email-template.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/email-template](https://docs.epilot.io/api/email-template)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.emailTemplate.saveTemplate(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/email-template\'\n\nconst emailTemplateClient = getClient()\nauthorize(emailTemplateClient, () => \'<token>\')\nconst { data } = await emailTemplateClient.saveTemplate(...)\n```\n\n## Operations\n\n**Email templates**\n- [`saveTemplate`](#savetemplate)\n- [`getTemplateDetail`](#gettemplatedetail)\n- [`updateTemplateDetail`](#updatetemplatedetail)\n- [`bulkSendMessage`](#bulksendmessage)\n- [`revertToOriginalTemplate`](#reverttooriginaltemplate)\n\n**Variables**\n- [`replaceVariablesAsync`](#replacevariablesasync)\n\n**Schemas**\n- [`BaseEntity`](#baseentity)\n- [`EmailTemplateRequest`](#emailtemplaterequest)\n- [`EmailTemplateEntity`](#emailtemplateentity)\n- [`Attachment`](#attachment)\n- [`From`](#from)\n- [`To`](#to)\n- [`PresignedRequest`](#presignedrequest)\n- [`PresignedResponse`](#presignedresponse)\n- [`AttachmentResponse`](#attachmentresponse)\n- [`UserResponse`](#userresponse)\n- [`VariableParameters`](#variableparameters)\n- [`TemplateType`](#templatetype)\n- [`EmailTemplateResponse`](#emailtemplateresponse)\n- [`AsyncEmailTemplateResponse`](#asyncemailtemplateresponse)\n- [`SkipCreatingEntities`](#skipcreatingentities)\n- [`CompleteThread`](#completethread)\n- [`BulkSendMessageRequest`](#bulksendmessagerequest)\n- [`BulkSendMessageRequestWithQuery`](#bulksendmessagerequestwithquery)\n- [`CustomVariables`](#customvariables)\n- [`BulkSendMessageJob`](#bulksendmessagejob)\n- [`CreateSystemTemplatesReq`](#createsystemtemplatesreq)\n- [`CreateSystemTemplatesResp`](#createsystemtemplatesresp)\n- [`OrgId`](#orgid)\n- [`CreatedBy`](#createdby)\n- [`CreatedAt`](#createdat)\n- [`UpdatedAt`](#updatedat)\n- [`ApprovedAt`](#approvedat)\n- [`ApproveAction`](#approveaction)\n- [`TaskToken`](#tasktoken)\n\n### `saveTemplate`\n\nCreate or update a template. If `id` is provided, it will update the template.\n\n`POST /v1/email-template/templates`\n\n```ts\nconst { data } = await client.saveTemplate(\n  null,\n  {\n    _id: \'cd7809ba-a111-4dd9-8d15-18eb4de0faed\',\n    _tags: [\'template\'],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n    _purpose: [\'a0ec23ac-12f8-4d89-9a63-91cba3787f2a\', \'310cd388-2f15-4b5b-8f98-ca14c1e03304\'],\n    name: \'Order confirmation\',\n    brand_id: 0,\n    from: {\n      name: \'epilot\',\n      email: \'no-reply@epilot.cloud\'\n    },\n    to: [\n      {\n        name: \'Ny Huynh\',\n        email: \'ny.huynh@axonactive.com\'\n      }\n    ],\n    cc: [\n      {\n        name: \'Ny Huynh\',\n        email: \'ny.huynh@axonactive.com\'\n      }\n    ],\n    bcc: [\n      {\n        name: \'Ny Huynh\',\n        email: \'ny.huynh@axonactive.com\'\n      }\n    ],\n    subject: \'We have received your order!\',\n    body: \'Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly\',\n    attachments: [\n      {\n        cid: \'f820ce3b-07b0-45ae-bcc6-babb2f53f79f\',\n        filename: \'Produktinformationen_epilot360_Double_Opt_in.pdf\',\n        size: 451349,\n        content_type: \'application/pdf\',\n        url: \'https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf\',\n        bucket: \'893487340562-message-attachment\',\n        object_key: \'attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf\',\n        inline: false,\n        send_as_link: false,\n        type: \'Document template\',\n        copy_to_message: true\n      }\n    ],\n    file: {\n      $relation: [\n        {}\n      ]\n    },\n    system_template: false,\n    created_by: 1234,\n    updated_by: 1234,\n    json_template: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["automatic email template"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "_purpose": ["a0ec23ac-12f8-4d89-9a63-91cba3787f2a", "310cd388-2f15-4b5b-8f98-ca14c1e03304"],\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "name": "Order confirmation",\n  "brand_id": 0,\n  "from": {\n    "name": "epilot",\n    "email": "no-reply@epilot.cloud"\n  },\n  "to": [\n    {\n      "name": "Ny Huynh",\n      "email": "ny.huynh@axonactive.com"\n    }\n  ],\n  "cc": [\n    {\n      "name": "Ny Huynh",\n      "email": "ny.huynh@axonactive.com"\n    }\n  ],\n  "bcc": [\n    {\n      "name": "Ny Huynh",\n      "email": "ny.huynh@axonactive.com"\n    }\n  ],\n  "subject": "We have received your order!",\n  "body": "Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly",\n  "attachments": [\n    {\n      "cid": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n      "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n      "size": 451349,\n      "content_type": "application/pdf",\n      "url": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n      "bucket": "893487340562-message-attachment",\n      "object_key": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n      "inline": false,\n      "send_as_link": false,\n      "type": "Document template",\n      "copy_to_message": true\n    }\n  ],\n  "file": {\n    "$relation": [\n      {}\n    ]\n  },\n  "created_by": 1234,\n  "updated_by": 1234,\n  "json_template": "string",\n  "system_template": false\n}\n```\n\n</details>\n\n---\n\n### `getTemplateDetail`\n\nGet email template by ID\n\n`GET /v1/email-template/templates/{id}`\n\n```ts\nconst { data } = await client.getTemplateDetail({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity": {\n    "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "_title": "string",\n    "_org": "206801",\n    "_schema": "message",\n    "_tags": ["automatic email template"],\n    "_created_at": "2021-02-09T12:41:43.662Z",\n    "_updated_at": "2021-02-10T09:14:31.990Z",\n    "_purpose": ["a0ec23ac-12f8-4d89-9a63-91cba3787f2a", "310cd388-2f15-4b5b-8f98-ca14c1e03304"],\n    "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n    "name": "Order confirmation",\n    "brand_id": 0,\n    "from": {\n      "name": "epilot",\n      "email": "no-reply@epilot.cloud"\n    },\n    "to": [\n      {\n        "name": "Ny Huynh",\n        "email": "ny.huynh@axonactive.com"\n      }\n    ],\n    "cc": [\n      {\n        "name": "Ny Huynh",\n        "email": "ny.huynh@axonactive.com"\n      }\n    ],\n    "bcc": [\n      {\n        "name": "Ny Huynh",\n        "email": "ny.huynh@axonactive.com"\n      }\n    ],\n    "subject": "We have received your order!",\n    "body": "Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly",\n    "attachments": [\n      {\n        "cid": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "size": 451349,\n        "content_type": "application/pdf",\n        "url": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "bucket": "893487340562-message-attachment",\n        "object_key": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n        "inline": false,\n        "send_as_link": false,\n        "type": "Document template",\n        "copy_to_message": true\n      }\n    ],\n    "file": {\n      "$relation": [\n        {}\n      ]\n    },\n    "created_by": 1234,\n    "updated_by": 1234,\n    "json_template": "string",\n    "system_template": false\n  },\n  "relations": [\n    {}\n  ]\n}\n```\n\n</details>\n\n---\n\n### `updateTemplateDetail`\n\nUpdate email template by ID\n\n`PUT /v1/email-template/templates/{id}`\n\n```ts\nconst { data } = await client.updateTemplateDetail(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    _id: \'cd7809ba-a111-4dd9-8d15-18eb4de0faed\',\n    _tags: [\'template\'],\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n    _purpose: [\'a0ec23ac-12f8-4d89-9a63-91cba3787f2a\', \'310cd388-2f15-4b5b-8f98-ca14c1e03304\'],\n    name: \'Order confirmation\',\n    brand_id: 0,\n    from: {\n      name: \'epilot\',\n      email: \'no-reply@epilot.cloud\'\n    },\n    to: [\n      {\n        name: \'Ny Huynh\',\n        email: \'ny.huynh@axonactive.com\'\n      }\n    ],\n    cc: [\n      {\n        name: \'Ny Huynh\',\n        email: \'ny.huynh@axonactive.com\'\n      }\n    ],\n    bcc: [\n      {\n        name: \'Ny Huynh\',\n        email: \'ny.huynh@axonactive.com\'\n      }\n    ],\n    subject: \'We have received your order!\',\n    body: \'Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly\',\n    attachments: [\n      {\n        cid: \'f820ce3b-07b0-45ae-bcc6-babb2f53f79f\',\n        filename: \'Produktinformationen_epilot360_Double_Opt_in.pdf\',\n        size: 451349,\n        content_type: \'application/pdf\',\n        url: \'https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf\',\n        bucket: \'893487340562-message-attachment\',\n        object_key: \'attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf\',\n        inline: false,\n        send_as_link: false,\n        type: \'Document template\',\n        copy_to_message: true\n      }\n    ],\n    file: {\n      $relation: [\n        {}\n      ]\n    },\n    system_template: false,\n    created_by: 1234,\n    updated_by: 1234,\n    json_template: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "_title": "string",\n  "_org": "206801",\n  "_schema": "message",\n  "_tags": ["automatic email template"],\n  "_created_at": "2021-02-09T12:41:43.662Z",\n  "_updated_at": "2021-02-10T09:14:31.990Z",\n  "_purpose": ["a0ec23ac-12f8-4d89-9a63-91cba3787f2a", "310cd388-2f15-4b5b-8f98-ca14c1e03304"],\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "name": "Order confirmation",\n  "brand_id": 0,\n  "from": {\n    "name": "epilot",\n    "email": "no-reply@epilot.cloud"\n  },\n  "to": [\n    {\n      "name": "Ny Huynh",\n      "email": "ny.huynh@axonactive.com"\n    }\n  ],\n  "cc": [\n    {\n      "name": "Ny Huynh",\n      "email": "ny.huynh@axonactive.com"\n    }\n  ],\n  "bcc": [\n    {\n      "name": "Ny Huynh",\n      "email": "ny.huynh@axonactive.com"\n    }\n  ],\n  "subject": "We have received your order!",\n  "body": "Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly",\n  "attachments": [\n    {\n      "cid": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n      "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n      "size": 451349,\n      "content_type": "application/pdf",\n      "url": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n      "bucket": "893487340562-message-attachment",\n      "object_key": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n      "inline": false,\n      "send_as_link": false,\n      "type": "Document template",\n      "copy_to_message": true\n    }\n  ],\n  "file": {\n    "$relation": [\n      {}\n    ]\n  },\n  "created_by": 1234,\n  "updated_by": 1234,\n  "json_template": "string",\n  "system_template": false\n}\n```\n\n</details>\n\n---\n\n### `replaceVariablesAsync`\n\nThis endpoint allows to initiate an asynchronous process in replacing the template details & generating the documents.\nOn initial request, a jobId and STARTED status are returned. Subsequent requests \n\n`POST /v1/email-template/templates:replaceAsync`\n\n```ts\nconst { data } = await client.replaceVariablesAsync(\n  {\n    job_id: \'example\',\n  },\n  {\n    email_template_id: \'511ceb90-f738-47aa-8b1e-915ace0ae13c\',\n    variable_parameters: {\n      template_type: \'email\',\n      language: \'en\',\n      main_entity_id: \'63753437-c9e2-4e83-82bb-b1c666514561\',\n      user_id: \'123452\',\n      custom_variables: [\n        {\n          variable: \'{{abc.xyz}}\',\n          value: \'ReplacedValue\'\n        }\n      ]\n    },\n    must_include_unsubscribe_link: false,\n    skip_document_generation: false\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "job_id": "8c086140-f33e-4bb7-a993-50c0f2402c7b",\n  "status": "STARTED",\n  "message": "string",\n  "doc_progress_count": {\n    "total": 10,\n    "completed": 5\n  },\n  "result": {\n    "entity": {\n      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "_title": "string",\n      "_org": "206801",\n      "_schema": "message",\n      "_tags": ["automatic email template"],\n      "_created_at": "2021-02-09T12:41:43.662Z",\n      "_updated_at": "2021-02-10T09:14:31.990Z",\n      "_purpose": ["a0ec23ac-12f8-4d89-9a63-91cba3787f2a", "310cd388-2f15-4b5b-8f98-ca14c1e03304"],\n      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n      "name": "Order confirmation",\n      "brand_id": 0,\n      "from": {\n        "name": "epilot",\n        "email": "no-reply@epilot.cloud"\n      },\n      "to": [\n        {\n          "name": "Ny Huynh",\n          "email": "ny.huynh@axonactive.com"\n        }\n      ],\n      "cc": [\n        {\n          "name": "Ny Huynh",\n          "email": "ny.huynh@axonactive.com"\n        }\n      ],\n      "bcc": [\n        {\n          "name": "Ny Huynh",\n          "email": "ny.huynh@axonactive.com"\n        }\n      ],\n      "subject": "We have received your order!",\n      "body": "Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly",\n      "attachments": [\n        {\n          "cid": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",\n          "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",\n          "size": 451349,\n          "content_type": "application/pdf",\n          "url": "https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n          "bucket": "893487340562-message-attachment",\n          "object_key": "attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf",\n          "inline": false,\n          "send_as_link": false,\n          "type": "Document template",\n          "copy_to_message": true\n        }\n      ],\n      "file": {\n        "$relation": [\n          {}\n        ]\n      },\n      "created_by": 1234,\n      "updated_by": 1234,\n      "json_template": "string",\n      "system_template": false\n    },\n    "relations": [\n      {}\n    ]\n  }\n}\n```\n\n</details>\n\n---\n\n### `bulkSendMessage`\n\nSend emails to multiple recipients using a template\n\n`POST /v1/email-template/templates:bulkSendMessage`\n\n```ts\nconst { data } = await client.bulkSendMessage(\n  null,\n  {\n    skip_creating_entities: true,\n    complete_thread: false,\n    email_template_id: \'511ceb90-f738-47aa-8b1e-915ace0ae13c\',\n    must_include_unsubscribe_link: false,\n    recipient_query: \'_schema:contact AND consent_email_marketing:active\',\n    custom_variables: [\n      {\n        variable: \'{{abc.xyz}}\',\n        value: \'ReplacedValue\'\n      }\n    ]\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "org_id": "206801",\n  "job_id": "8c086140-f33e-4bb7-a993-50c0f2402c7b",\n  "skip_creating_entities": true,\n  "complete_thread": false,\n  "status": "PROCESSING",\n  "request": {\n    "skip_creating_entities": true,\n    "complete_thread": false,\n    "email_template_id": "511ceb90-f738-47aa-8b1e-915ace0ae13c",\n    "must_include_unsubscribe_link": false,\n    "recipient_ids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7", "3fa85f64-5717-4562-b3fc-2c963f66afa8"],\n    "custom_variables": [\n      {\n        "variable": "{{abc.xyz}}",\n        "value": "ReplacedValue"\n      }\n    ]\n  },\n  "created_by": "1234",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z",\n  "approved_at": "1970-01-01T00:00:00.000Z",\n  "approve_action": "APPROVE_WITH_CONSENT",\n  "task_token": "8c086140-f33e-4bb7-a993-50c0f2402c7b",\n  "total_queued": 100,\n  "queued": [\n    {\n      "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "email_to": ["recipient@example.com"],\n      "email_with_consent": ["recipient@example.com"]\n    }\n  ],\n  "sent": [\n    {\n      "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "email_to": ["recipient@example.com"]\n    }\n  ],\n  "failed": [\n    {\n      "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "error": "string",\n      "email_to": ["recipient@example.com"]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `revertToOriginalTemplate`\n\nRevert to the original system generated email template\n\n`POST /v1/email-template/templates:revert`\n\n```ts\nconst { data } = await client.revertToOriginalTemplate(\n  null,\n  {\n    email_template_id: \'511ceb90-f738-47aa-8b1e-915ace0ae13c\'\n  },\n)\n```\n\n---\n\n## Schemas\n\n### `BaseEntity`\n\n```ts\ntype BaseEntity = {\n  _id: string\n  _title: string\n  _org: string\n  _schema: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n}\n```\n\n### `EmailTemplateRequest`\n\n```ts\ntype EmailTemplateRequest = {\n  _id?: string\n  _tags?: string[]\n  _manifest?: string // uuid[]\n  _purpose?: string[]\n  name: string\n  brand_id?: number\n  from?: {\n    name?: string\n    email: string\n  }\n  to?: Array<{\n    name?: string\n    email: string\n  }>\n  cc?: Array<{\n    name?: string\n    email: string\n  }>\n  bcc?: Array<{\n    name?: string\n    email: string\n  }>\n  subject: string\n  body?: string\n  attachments?: Array<{\n    cid?: string\n    filename: string\n    size: number\n    content_type: string\n    url?: string\n    bucket: string\n    object_key: string\n    inline?: boolean\n    send_as_link?: boolean\n    type?: string\n    copy_to_message?: boolean\n  }>\n  file?: {\n    $relation?: object[]\n  }\n  system_template?: boolean\n  created_by?: string\n  updated_by?: string\n  json_template?: string\n}\n```\n\n### `EmailTemplateEntity`\n\n```ts\ntype EmailTemplateEntity = {\n  _id: string\n  _title: string\n  _org: string\n  _schema: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n  name: string\n  brand_id?: number\n  from?: {\n    name?: string\n    email: string\n  }\n  to?: Array<{\n    name?: string\n    email: string\n  }>\n  cc?: Array<{\n    name?: string\n    email: string\n  }>\n  bcc?: Array<{\n    name?: string\n    email: string\n  }>\n  subject?: string\n  body?: string\n  attachments?: Array<{\n    cid?: string\n    filename: string\n    size: number\n    content_type: string\n    url?: string\n    bucket: string\n    object_key: string\n    inline?: boolean\n    send_as_link?: boolean\n    type?: string\n    copy_to_message?: boolean\n  }>\n  file?: {\n    $relation?: object[]\n  }\n  created_by?: string\n  updated_by?: string\n  json_template?: string\n  system_template?: boolean\n}\n```\n\n### `Attachment`\n\n```ts\ntype Attachment = {\n  cid?: string\n  filename: string\n  size: number\n  content_type: string\n  url?: string\n  bucket: string\n  object_key: string\n  inline?: boolean\n  send_as_link?: boolean\n  type?: string\n  copy_to_message?: boolean\n}\n```\n\n### `From`\n\n```ts\ntype From = {\n  name?: string\n  email: string\n}\n```\n\n### `To`\n\n```ts\ntype To = {\n  name?: string\n  email: string\n}\n```\n\n### `PresignedRequest`\n\n```ts\ntype PresignedRequest = {\n  id: string\n  filename: string\n  content_type: string\n}\n```\n\n### `PresignedResponse`\n\n```ts\ntype PresignedResponse = {\n  download_url: string\n  upload_url: {\n    url: number\n    fields: object\n  }\n}\n```\n\n### `AttachmentResponse`\n\n```ts\ntype AttachmentResponse = {\n  total?: number\n  attachments?: Array<{\n    filename?: string\n    bucket?: string\n    object_key?: string\n    url?: string\n    document_type?: number\n  }>\n}\n```\n\n### `UserResponse`\n\n```ts\ntype UserResponse = {\n  id?: string\n  organization_id?: string\n  display_name?: string\n  email?: string // email\n  phone?: string\n  preferred_language?: string\n  image_uri?: {\n    original?: string // uri\n    thumbnail_32?: string // uri\n  }\n  properties?: Array<{\n    name: string\n    value: string\n  }>\n}\n```\n\n### `VariableParameters`\n\n```ts\ntype VariableParameters = {\n  template_type: "email" | "document"\n  language?: "en" | "de"\n  main_entity_id?: string\n  user_id?: string\n  custom_variables?: Array<{\n    variable?: string\n    value?: string\n  }>\n}\n```\n\n### `TemplateType`\n\n```ts\ntype TemplateType = "email" | "document"\n```\n\n### `EmailTemplateResponse`\n\n```ts\ntype EmailTemplateResponse = {\n  entity?: {\n    _id: string\n    _title: string\n    _org: string\n    _schema: string\n    _tags?: string[]\n    _created_at: string // date-time\n    _updated_at: string // date-time\n    _purpose?: string[]\n    _manifest?: string // uuid[]\n    name: string\n    brand_id?: number\n    from?: {\n      name?: { ... }\n      email: { ... }\n    }\n    to?: Array<{\n      name?: { ... }\n      email: { ... }\n    }>\n    cc?: Array<{\n      name?: { ... }\n      email: { ... }\n    }>\n    bcc?: Array<{\n      name?: { ... }\n      email: { ... }\n    }>\n    subject?: string\n    body?: string\n    attachments?: Array<{\n      cid?: { ... }\n      filename: { ... }\n      size: { ... }\n      content_type: { ... }\n      url?: { ... }\n      bucket: { ... }\n      object_key: { ... }\n      inline?: { ... }\n      send_as_link?: { ... }\n      type?: { ... }\n      copy_to_message?: { ... }\n    }>\n    file?: {\n      $relation?: { ... }\n    }\n    created_by?: string\n    updated_by?: string\n    json_template?: string\n    system_template?: boolean\n  }\n  relations?: object[]\n}\n```\n\n### `AsyncEmailTemplateResponse`\n\n```ts\ntype AsyncEmailTemplateResponse = {\n  job_id: string\n  status: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED"\n  message?: string\n  doc_progress_count?: {\n    total: number\n    completed: number\n  }\n  result?: {\n    entity?: {\n      _id: { ... }\n      _title: { ... }\n      _org: { ... }\n      _schema: { ... }\n      _tags?: { ... }\n      _created_at: { ... }\n      _updated_at: { ... }\n      _purpose?: { ... }\n      _manifest?: { ... }\n      name: { ... }\n      brand_id?: { ... }\n      from?: { ... }\n      to?: { ... }\n      cc?: { ... }\n      bcc?: { ... }\n      subject?: { ... }\n      body?: { ... }\n      attachments?: { ... }\n      file?: { ... }\n      created_by?: { ... }\n      updated_by?: { ... }\n      json_template?: { ... }\n      system_template?: { ... }\n    }\n    relations?: object[]\n  }\n}\n```\n\n### `SkipCreatingEntities`\n\nWhen true, it lets to send only the email by skip creating the thread & message entities.\n\n```ts\ntype SkipCreatingEntities = boolean\n```\n\n### `CompleteThread`\n\nWhether the thread is marked as Done immediately after sending the message\n\n```ts\ntype CompleteThread = boolean\n```\n\n### `BulkSendMessageRequest`\n\nIt takes a list of entity ids, treating each as a separate mainEntity to construct individual messages.\nFor e.g; if there some opportunityIds are provided, then each opportunityId is treated as a separate mainEntity to construct individual messages.\n\n\n```ts\ntype BulkSendMessageRequest = {\n  skip_creating_entities?: boolean\n  complete_thread?: boolean\n  email_template_id: string\n  must_include_unsubscribe_link?: boolean\n  recipient_ids: string[]\n  custom_variables?: Array<{\n    variable?: string\n    value?: string\n  }>\n}\n```\n\n### `BulkSendMessageRequestWithQuery`\n\nIt takes an entity query to derive recipient_ids, treating each as a separate mainEntity to construct individual messages.\nFor e.g; if the query is provided as `_schema:opportunity AND status:PENDING`,\n  then all the opportunity Ids with status PENDING are treated as separate mainEntity to construct\n\n```ts\ntype BulkSendMessageRequestWithQuery = {\n  skip_creating_entities?: boolean\n  complete_thread?: boolean\n  email_template_id: string\n  must_include_unsubscribe_link?: boolean\n  recipient_query: string\n  custom_variables?: Array<{\n    variable?: string\n    value?: string\n  }>\n}\n```\n\n### `CustomVariables`\n\nCustom variables to be replaced in the email template\n\n```ts\ntype CustomVariables = Array<{\n  variable?: string\n  value?: string\n}>\n```\n\n### `BulkSendMessageJob`\n\n```ts\ntype BulkSendMessageJob = {\n  org_id?: string\n  job_id: string\n  skip_creating_entities?: boolean\n  complete_thread?: boolean\n  status: "PROCESSING" | "QUEUEING" | "APPROVAL" | "SENDING" | "SUCCESS" | "FAILED" | "CANCELLED"\n  request: {\n    skip_creating_entities?: boolean\n    complete_thread?: boolean\n    email_template_id: string\n    must_include_unsubscribe_link?: boolean\n    recipient_ids: string[]\n    custom_variables?: Array<{\n      variable?: { ... }\n      value?: { ... }\n    }>\n  } | {\n    skip_creating_entities?: boolean\n    complete_thread?: boolean\n    email_template_id: string\n    must_include_unsubscribe_link?: boolean\n    recipient_query: string\n    custom_variables?: Array<{\n      variable?: { ... }\n      value?: { ... }\n    }>\n  }\n  created_by?: string\n  created_at?: string // date-time\n  updated_at?: string // date-time\n  approved_at?: string // date-time\n  approve_action?: "APPROVE_WITH_CONSENT" | "APPROVE_ALL"\n  task_token?: string\n  total_queued?: number\n  queued?: Array<{\n    entity_id: string\n    email_to: string[]\n    email_with_consent: string[]\n  }>\n  sent?: Array<{\n    entity_id: string\n    message_id: string\n    email_to?: string[]\n  }>\n  failed?: Array<{\n    entity_id: string\n    error: string\n    email_to?: string[]\n  }>\n}\n```\n\n### `CreateSystemTemplatesReq`\n\n```ts\ntype CreateSystemTemplatesReq = {\n  template_names: string[]\n}\n```\n\n### `CreateSystemTemplatesResp`\n\n```ts\ntype CreateSystemTemplatesResp = Array<{\n  _id: string\n  _title: string\n  _org: string\n  _schema: string\n  _tags?: string[]\n  _created_at: string // date-time\n  _updated_at: string // date-time\n  _purpose?: string[]\n  _manifest?: string // uuid[]\n}>\n```\n\n### `OrgId`\n\nOrganization ID\n\n```ts\ntype OrgId = string\n```\n\n### `CreatedBy`\n\nUser ID who created the bulk message action\n\n```ts\ntype CreatedBy = string\n```\n\n### `CreatedAt`\n\nTime when the bulk message action was created\n\n```ts\ntype CreatedAt = string // date-time\n```\n\n### `UpdatedAt`\n\nTime when the bulk message action was last updated\n\n```ts\ntype UpdatedAt = string // date-time\n```\n\n### `ApprovedAt`\n\nTime when the bulk message action was last approved\n\n```ts\ntype ApprovedAt = string // date-time\n```\n\n### `ApproveAction`\n\nType of approval action for the bulk message request.\n* APPROVE_WITH_CONSENT: Approve the bulk message request and send emails to queued recipients with consent\n* APPROVE_ALL: Approve the bulk message request and send emails to all queued recipients, including those without consent\n\n\n```ts\ntype ApproveAction = "APPROVE_WITH_CONSENT" | "APPROVE_ALL"\n```\n\n### `TaskToken`\n\nTask token to approve or cancel the bulk message action\n\n```ts\ntype TaskToken = string\n```\n';
+export {
+  email_template_default as default
+};

package/dist/email-template-runtime-QBB64BJQ.js

@@ -0,0 +1,5 @@
+import {
+  require_email_template_runtime
+} from "./chunk-JJWJLY42.js";
+import "./chunk-YPSWSI3M.js";
+export default require_email_template_runtime();

package/dist/email-template-runtime-UI2FS4H5.cjs

@@ -0,0 +1,5 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkK2UZPY6Ucjs = require('./chunk-K2UZPY6U.cjs');
+require('./chunk-NJK5F5TF.cjs');
+exports. default = _chunkK2UZPY6Ucjs.require_email_template_runtime.call(void 0, );