diff --git a/clients/message-client/package-lock.json b/clients/message-client/package-lock.json index 403fa4c8..bc35ef15 100644 --- a/clients/message-client/package-lock.json +++ b/clients/message-client/package-lock.json @@ -1,12 +1,12 @@ { "name": "@epilot/message-client", - "version": "1.7.0", + "version": "1.12.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@epilot/message-client", - "version": "1.7.0", + "version": "1.12.0", "license": "UNLICENSED", "dependencies": { "@dazn/lambda-powertools-correlation-ids": "^1.28.1", @@ -17776,4 +17776,4 @@ } } } -} +} \ No newline at end of file diff --git a/clients/message-client/package.json b/clients/message-client/package.json index 0a1d0cef..2d645abe 100644 --- a/clients/message-client/package.json +++ b/clients/message-client/package.json @@ -1,6 +1,6 @@ { "name": "@epilot/message-client", - "version": "1.7.0", + "version": "1.12.0", "description": "API Client for epilot Message API", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/clients/message-client/src/openapi.d.ts b/clients/message-client/src/openapi.d.ts index 273b1c8e..95402431 100644 --- a/clients/message-client/src/openapi.d.ts +++ b/clients/message-client/src/openapi.d.ts @@ -23,14 +23,17 @@ declare namespace Components { */ address: string; /** - * Sent message status regarding to this recipient.\ - * Reference at + * Type of the email, Internal (360 Agents), Partners, External users(Customers) + * + */ + email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER"; + /** + * Sent message status regarding to this recipient. Reference at * */ send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR"; /** - * Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\ - * JSON object is defined by AWS SES. Reference at + * Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR. JSON object is defined by AWS SES. Reference at * */ send_error?: { @@ -115,14 +118,12 @@ declare namespace Components { */ cid?: string; /** - * If true then this attachment should not be offered for download (at least not in the main attachments list).\ - * The usecase is CID embedded image (aka inline image). + * If true then this attachment should not be offered for download (at least not in the main attachments list). The usecase is CID embedded image (aka inline image). * */ inline?: boolean; /** - * If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\ - * In this case, service doesn't process this attachment. + * If true then this attachment is sent via link. The link have to be inserted to email body by API caller. In this case, service doesn't process this attachment. * */ send_as_link?: boolean; @@ -174,9 +175,7 @@ declare namespace Components { bcc?: Address[]; file?: /* Message attachments */ AttachmentsRelation; /** - * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\ - * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\ - * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. + * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. * * example: * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> @@ -198,8 +197,7 @@ declare namespace Components { */ org_read_message?: string[]; /** - * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\ - * Reference at + * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at * */ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[]; @@ -211,9 +209,7 @@ declare namespace Components { export interface MessageRequestParams { [name: string]: any; /** - * Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...).\ - * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.\ - * `thread` or `parent_id` must be provided either. + * Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...). Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing. `thread` or `parent_id` must be provided either. * * example: * { @@ -236,8 +232,7 @@ declare namespace Components { assigned_to?: string[]; }; /** - * Entity ID of parent message which this message replies to or forwards from.\ - * If both `parent_id` and `thread` are provided, `thread` is discarded. + * Entity ID of parent message which this message replies to or forwards from. If both `parent_id` and `thread` are provided, `thread` is discarded. * * example: * 44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2 @@ -367,9 +362,7 @@ declare namespace Components { bcc?: Address[]; file?: /* Message attachments */ AttachmentsRelation; /** - * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\ - * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\ - * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. + * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. * * example: * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> @@ -391,8 +384,7 @@ declare namespace Components { */ org_read_message?: string[]; /** - * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\ - * Reference at + * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at * */ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[]; @@ -610,9 +602,7 @@ declare namespace Paths { bcc?: Components.Schemas.Address[]; file?: /* Message attachments */ Components.Schemas.AttachmentsRelation; /** - * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\ - * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\ - * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. + * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. * * example: * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> @@ -634,8 +624,7 @@ declare namespace Paths { */ org_read_message?: string[]; /** - * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\ - * Reference at + * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at * */ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[]; @@ -782,9 +771,7 @@ declare namespace Paths { bcc?: Components.Schemas.Address[]; file?: /* Message attachments */ Components.Schemas.AttachmentsRelation; /** - * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\ - * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\ - * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. + * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. * * example: * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> @@ -806,8 +793,7 @@ declare namespace Paths { */ org_read_message?: string[]; /** - * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\ - * Reference at + * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at * */ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[]; @@ -928,9 +914,7 @@ declare namespace Paths { bcc?: Components.Schemas.Address[]; file?: /* Message attachments */ Components.Schemas.AttachmentsRelation; /** - * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\ - * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\ - * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. + * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. * * example: * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> @@ -952,8 +936,7 @@ declare namespace Paths { */ org_read_message?: string[]; /** - * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\ - * Reference at + * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at * */ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[]; @@ -1209,9 +1192,7 @@ declare namespace Paths { bcc?: Components.Schemas.Address[]; file?: /* Message attachments */ Components.Schemas.AttachmentsRelation; /** - * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\ - * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\ - * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. + * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. * * example: * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> @@ -1233,8 +1214,7 @@ declare namespace Paths { */ org_read_message?: string[]; /** - * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\ - * Reference at + * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at * */ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[]; @@ -1409,9 +1389,7 @@ declare namespace Paths { bcc?: Components.Schemas.Address[]; file?: /* Message attachments */ Components.Schemas.AttachmentsRelation; /** - * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\ - * The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\ - * The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. + * References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying. * * example: * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> @@ -1433,8 +1411,7 @@ declare namespace Paths { */ org_read_message?: string[]; /** - * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\ - * Reference at + * Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at * */ send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[]; @@ -1694,7 +1671,7 @@ export interface OperationMethods { /** * assignUsers - assignUsers * - * Assign users to thread for receiving notifications. + * Assign users to thread for receiving notifications. * The operation replaces all existing assigned users in thread. * */ @@ -1943,7 +1920,7 @@ export interface PathsDictionary { /** * assignUsers - assignUsers * - * Assign users to thread for receiving notifications. + * Assign users to thread for receiving notifications. * The operation replaces all existing assigned users in thread. * */ diff --git a/clients/message-client/src/openapi.json b/clients/message-client/src/openapi.json index 7105f454..be853faf 100644 --- a/clients/message-client/src/openapi.json +++ b/clients/message-client/src/openapi.json @@ -599,7 +599,7 @@ "post": { "operationId": "assignUsers", "summary": "assignUsers", - "description": "Assign users to thread for receiving notifications. \nThe operation replaces all existing assigned users in thread.\n", + "description": "Assign users to thread for receiving notifications.\nThe operation replaces all existing assigned users in thread.\n", "tags": [ "Threads" ], @@ -945,7 +945,7 @@ }, "references": { "type": "string", - "description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent.\\\nThe last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread.\\\nThe basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n", + "description": "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n", "example": "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> " }, "in_reply_to": { @@ -977,7 +977,7 @@ }, "send_status": { "type": "array", - "description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc`\\\nReference at \n", + "description": "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at \n", "items": { "type": "string", "enum": [ @@ -1038,9 +1038,19 @@ "description": "Email address", "example": "messaging@epilot.cloud" }, + "email_type": { + "type": "string", + "description": "Type of the email, Internal (360 Agents), Partners, External users(Customers)\n", + "nullable": true, + "enum": [ + "INTERNAL", + "EXTERNAL", + "PARTNER" + ] + }, "send_status": { "type": "string", - "description": "Sent message status regarding to this recipient.\\\nReference at \n", + "description": "Sent message status regarding to this recipient. Reference at \n", "enum": [ "SEND", "DELIVERY", @@ -1052,7 +1062,7 @@ }, "send_error": { "type": "object", - "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR.\\\nJSON object is defined by AWS SES. Reference at \n" + "description": "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR. JSON object is defined by AWS SES. Reference at \n" } } }, @@ -1096,12 +1106,12 @@ }, "inline": { "type": "boolean", - "description": "If true then this attachment should not be offered for download (at least not in the main attachments list).\\\nThe usecase is CID embedded image (aka inline image).\n", + "description": "If true then this attachment should not be offered for download (at least not in the main attachments list). The usecase is CID embedded image (aka inline image).\n", "default": false }, "send_as_link": { "type": "boolean", - "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller.\\\nIn this case, service doesn't process this attachment.\n", + "description": "If true then this attachment is sent via link. The link have to be inserted to email body by API caller. In this case, service doesn't process this attachment.\n", "default": false } } @@ -1118,7 +1128,7 @@ "required": [ "topic" ], - "description": "Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...).\\\nThread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.\\\n`thread` or `parent_id` must be provided either.\n", + "description": "Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...). Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing. `thread` or `parent_id` must be provided either.\n", "properties": { "topic": { "type": "string", @@ -1143,7 +1153,7 @@ }, "parent_id": { "type": "string", - "description": "Entity ID of parent message which this message replies to or forwards from.\\\nIf both `parent_id` and `thread` are provided, `thread` is discarded.\n", + "description": "Entity ID of parent message which this message replies to or forwards from. If both `parent_id` and `thread` are provided, `thread` is discarded.\n", "example": "44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2" }, "subject": {