@epilot/message-client 1.4.0 → 1.5.1

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={914:function(e,a,r){var s=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(a,"__esModule",{value:!0});var t=s(r(240));a.default=t.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/message/messages":{"post":{"operationId":"sendMessage","parameters":[{"in":"query","name":"do_not_create_entities"}],"requestBody":{"content":{"application/json":{}}}},"put":{"operationId":"updateMessage"}},"/v1/message/messages/{id}":{"get":{"operationId":"getMessage","parameters":[{"name":"id","in":"path","required":true}]},"delete":{"operationId":"deleteMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/trash":{"post":{"operationId":"trashMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/untrash":{"post":{"operationId":"untrashMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/read":{"post":{"operationId":"markReadMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/unread":{"post":{"operationId":"markUnreadMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads:search":{"post":{"operationId":"searchThreads","requestBody":{"content":{"application/json":{}}}}},"/v1/message/threads":{"put":{"operationId":"updateThread"}},"/v1/message/threads/{id}":{"delete":{"operationId":"deleteThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/trash":{"post":{"operationId":"trashThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/untrash":{"post":{"operationId":"untrashThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/read":{"post":{"operationId":"markReadThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/unread":{"post":{"operationId":"markUnreadThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/assign":{"post":{"operationId":"assignThread","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/message/threads/{id}/assign:users":{"post":{"operationId":"assignUsers","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/message/drafts":{"post":{"operationId":"createDraft","requestBody":{"content":{"application/json":{}}}}},"/v1/message/drafts:send":{"post":{"operationId":"sendDraft"}}},"components":{},"servers":[{"url":"https://message.sls.epilot.io"}]}')}},a={},r=function r(s){var t=a[s];if(void 0!==t)return t.exports;var d=a[s]={exports:{}};return e[s].call(d.exports,d,d.exports,r),d.exports}(914),s=exports;for(var t in r)s[t]=r[t];r.__esModule&&Object.defineProperty(s,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={914:function(e,a,r){var s=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(a,"__esModule",{value:!0});var t=s(r(240));a.default=t.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/message/messages":{"post":{"operationId":"sendMessage","parameters":[{"in":"query","name":"do_not_create_entities"}],"requestBody":{"content":{"application/json":{}}}},"put":{"operationId":"updateMessage"}},"/v1/message/messages/{id}":{"get":{"operationId":"getMessage","parameters":[{"name":"id","in":"path","required":true}]},"delete":{"operationId":"deleteMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/trash":{"post":{"operationId":"trashMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/untrash":{"post":{"operationId":"untrashMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/read":{"post":{"operationId":"markReadMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/messages/{id}/unread":{"post":{"operationId":"markUnreadMessage","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads:search":{"post":{"operationId":"searchThreads","requestBody":{"content":{"application/json":{}}}}},"/v1/message/threads":{"put":{"operationId":"updateThread"}},"/v1/message/threads/{id}":{"delete":{"operationId":"deleteThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/trash":{"post":{"operationId":"trashThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/untrash":{"post":{"operationId":"untrashThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/read":{"post":{"operationId":"markReadThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/unread":{"post":{"operationId":"markUnreadThread","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/message/threads/{id}/assign":{"post":{"operationId":"assignThread","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/message/threads/{id}/assign:users":{"post":{"operationId":"assignUsers","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/message/drafts":{"post":{"operationId":"createDraft","requestBody":{"content":{"application/json":{}}}}},"/v1/message/drafts:send":{"post":{"operationId":"sendDraft"}},"/v2/message/messages/{id}":{"get":{"operationId":"getMessageV2","parameters":[{"name":"id","in":"path","required":true}]}}},"components":{},"servers":[{"url":"https://message.sls.epilot.io"}]}')}},a={},r=function r(s){var t=a[s];if(void 0!==t)return t.exports;var d=a[s]={exports:{}};return e[s].call(d.exports,d,d.exports,r),d.exports}(914),s=exports;for(var t in r)s[t]=r[t];r.__esModule&&Object.defineProperty(s,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -219,6 +219,18 @@
       "post": {
         "operationId": "sendDraft"
       }
+    },
+    "/v2/message/messages/{id}": {
+      "get": {
+        "operationId": "getMessageV2",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true
+          }
+        ]
+      }
     }
   },
   "components": {},

package/dist/openapi.d.ts

@@ -276,6 +276,140 @@ declare namespace Components {
             bcc?: Address[];
             file?: /* Message attachments */ AttachmentsRelation;
         }
+        export interface MessageV2 {
+            /**
+             * Entity ID
+             * example:
+             * 3fa85f64-5717-4562-b3fc-2c963f66afa6
+             */
+            _id: string;
+            /**
+             * Entity title
+             */
+            _title: string;
+            /**
+             * Ivy Organization ID the entity belongs to
+             * example:
+             * 206801
+             */
+            _org: string;
+            /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * message
+             */
+            _schema: string;
+            /**
+             * Entity tags
+             * example:
+             * [
+             *   "pricing",
+             *   "INBOX"
+             * ]
+             */
+            _tags?: string[];
+            /**
+             * Created date
+             * example:
+             * 2021-02-09T12:41:43.662Z
+             */
+            _created_at: string; // date-time
+            /**
+             * Updated date
+             * example:
+             * 2021-02-10T09:14:31.990Z
+             */
+            _updated_at: string; // date-time
+            /**
+             * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
+             * example:
+             * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
+             */
+            message_id?: string;
+            /**
+             * Ivy User ID of user sends the message.
+             * example:
+             * 206801
+             */
+            sender?: string;
+            /**
+             * Subject
+             * example:
+             * Request for solar panel price
+             */
+            subject: string;
+            /**
+             * HTML body
+             * example:
+             * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
+             */
+            html?: string;
+            /**
+             * Text body
+             * example:
+             * We at ABC GmbH would like to request a price quote for the solar panel.
+             */
+            text?: string;
+            from: Address;
+            reply_to?: Address;
+            /**
+             * To email addresses
+             */
+            to?: Address[];
+            /**
+             * Cc email addresses
+             */
+            cc?: Address[];
+            /**
+             * Bcc email addresses
+             */
+            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.
+             *
+             * example:
+             * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
+             */
+            references?: string;
+            /**
+             * In-Reply-To header. Value is the `message_id` of parent message.
+             *
+             * example:
+             * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
+             */
+            in_reply_to?: string;
+            /**
+             * Ivy User ID of user read the message.
+             */
+            user_read_message?: string[];
+            /**
+             * Ivy Organization ID of organization read the message.
+             */
+            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 <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
+             *
+             */
+            send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
+            /**
+             * Message type
+             */
+            type?: "SENT" | "RECEIVED";
+            /**
+             * If true then html is not provided and must be downloaded using the html_download_url
+             */
+            html_omitted?: boolean;
+            /**
+             * HTML body download URL
+             * example:
+             * https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html
+             */
+            html_download_url?: string;
+        }
         export interface SearchParams {
             /**
              * Lucene query syntax supported with ElasticSearch
@@ -537,13 +671,21 @@ declare namespace Paths {
     }
     namespace GetMessage {
         namespace Parameters {
+            /**
+             * example:
+             * 4d74976d-fb64-47fd-85e2-65eea140f5eb
+             */
             export type Id = string;
         }
         export interface PathParameters {
-            id: Parameters.Id;
+            id: /**
+             * example:
+             * 4d74976d-fb64-47fd-85e2-65eea140f5eb
+             */
+            Parameters.Id;
         }
         namespace Responses {
-            export interface $201 {
+            export interface $200 {
                 /**
                  * Entity ID
                  * example:
@@ -667,6 +809,162 @@ declare namespace Paths {
                  */
                 type?: "SENT" | "RECEIVED";
             }
+            export interface $302 {
+            }
+            export interface $403 {
+            }
+        }
+    }
+    namespace GetMessageV2 {
+        namespace Parameters {
+            /**
+             * example:
+             * 4d74976d-fb64-47fd-85e2-65eea140f5eb
+             */
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: /**
+             * example:
+             * 4d74976d-fb64-47fd-85e2-65eea140f5eb
+             */
+            Parameters.Id;
+        }
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * Entity ID
+                 * example:
+                 * 3fa85f64-5717-4562-b3fc-2c963f66afa6
+                 */
+                _id: string;
+                /**
+                 * Entity title
+                 */
+                _title: string;
+                /**
+                 * Ivy Organization ID the entity belongs to
+                 * example:
+                 * 206801
+                 */
+                _org: string;
+                /**
+                 * URL-friendly identifier for the entity schema
+                 * example:
+                 * message
+                 */
+                _schema: string;
+                /**
+                 * Entity tags
+                 * example:
+                 * [
+                 *   "pricing",
+                 *   "INBOX"
+                 * ]
+                 */
+                _tags?: string[];
+                /**
+                 * Created date
+                 * example:
+                 * 2021-02-09T12:41:43.662Z
+                 */
+                _created_at: string; // date-time
+                /**
+                 * Updated date
+                 * example:
+                 * 2021-02-10T09:14:31.990Z
+                 */
+                _updated_at: string; // date-time
+                /**
+                 * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
+                 * example:
+                 * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
+                 */
+                message_id?: string;
+                /**
+                 * Ivy User ID of user sends the message.
+                 * example:
+                 * 206801
+                 */
+                sender?: string;
+                /**
+                 * Subject
+                 * example:
+                 * Request for solar panel price
+                 */
+                subject: string;
+                /**
+                 * HTML body
+                 * example:
+                 * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
+                 */
+                html?: string;
+                /**
+                 * Text body
+                 * example:
+                 * We at ABC GmbH would like to request a price quote for the solar panel.
+                 */
+                text?: string;
+                from: Components.Schemas.Address;
+                reply_to?: Components.Schemas.Address;
+                /**
+                 * To email addresses
+                 */
+                to?: Components.Schemas.Address[];
+                /**
+                 * Cc email addresses
+                 */
+                cc?: Components.Schemas.Address[];
+                /**
+                 * Bcc email addresses
+                 */
+                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.
+                 *
+                 * example:
+                 * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
+                 */
+                references?: string;
+                /**
+                 * In-Reply-To header. Value is the `message_id` of parent message.
+                 *
+                 * example:
+                 * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
+                 */
+                in_reply_to?: string;
+                /**
+                 * Ivy User ID of user read the message.
+                 */
+                user_read_message?: string[];
+                /**
+                 * Ivy Organization ID of organization read the message.
+                 */
+                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 <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
+                 *
+                 */
+                send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
+                /**
+                 * Message type
+                 */
+                type?: "SENT" | "RECEIVED";
+                /**
+                 * If true then html is not provided and must be downloaded using the html_download_url
+                 */
+                html_omitted?: boolean;
+                /**
+                 * HTML body download URL
+                 * example:
+                 * https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html
+                 */
+                html_download_url?: string;
+            }
             export interface $403 {
             }
         }
@@ -1361,7 +1659,7 @@ export interface OperationMethods {
     parameters?: Parameters<Paths.GetMessage.PathParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.GetMessage.Responses.$201>
+  ): OperationResponse<Paths.GetMessage.Responses.$200>
   /**
    * deleteMessage - deleteMessage
    * 
@@ -1529,6 +1827,26 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.SendDraft.Responses.$201>
+  /**
+   * getMessageV2 - getMessageV2
+   * 
+   * - Fetches message by ID
+   * - If the message html is omitted on the entity, then it keeps the content on the message as a signed url
+   *   {
+   *     ...
+   *     _id: "4d74976d-fb64-47fd-85e2-65eea140f5eb",
+   *     _schema: "message",
+   *     _org: "org-123",
+   *     html_omitted: true,
+   *     html_download_url: "https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html"
+   *   }
+   * 
+   */
+  'getMessageV2'(
+    parameters?: Parameters<Paths.GetMessageV2.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetMessageV2.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -1564,7 +1882,7 @@ export interface PathsDictionary {
       parameters?: Parameters<Paths.GetMessage.PathParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.GetMessage.Responses.$201>
+    ): OperationResponse<Paths.GetMessage.Responses.$200>
     /**
      * deleteMessage - deleteMessage
      * 
@@ -1763,6 +2081,28 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.SendDraft.Responses.$201>
   }
+  ['/v2/message/messages/{id}']: {
+    /**
+     * getMessageV2 - getMessageV2
+     * 
+     * - Fetches message by ID
+     * - If the message html is omitted on the entity, then it keeps the content on the message as a signed url
+     *   {
+     *     ...
+     *     _id: "4d74976d-fb64-47fd-85e2-65eea140f5eb",
+     *     _schema: "message",
+     *     _org: "org-123",
+     *     html_omitted: true,
+     *     html_download_url: "https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html"
+     *   }
+     * 
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetMessageV2.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetMessageV2.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/dist/openapi.json

@@ -30,7 +30,9 @@
         "operationId": "sendMessage",
         "summary": "sendMessage",
         "description": "Send an email message",
-        "tags": null,
+        "tags": [
+          "Messages"
+        ],
         "parameters": [
           {
             "in": "query",
@@ -120,12 +122,13 @@
             "in": "path",
             "required": true,
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "4d74976d-fb64-47fd-85e2-65eea140f5eb"
             }
           }
         ],
         "responses": {
-          "201": {
+          "200": {
             "description": "Success",
             "content": {
               "application/json": {
@@ -142,6 +145,18 @@
               }
             }
           },
+          "302": {
+            "description": "Redirect to V2 API to fetch the download URL",
+            "headers": {
+              "Location": {
+                "description": "V2 API",
+                "schema": {
+                  "type": "string",
+                  "example": "https://message.sls.epilot.io/v2/messages/4d74976d-fb64-47fd-85e2-65eea140f5eb"
+                }
+              }
+            }
+          },
           "403": {
             "description": "Forbidden"
           }
@@ -709,6 +724,47 @@
           }
         }
       }
+    },
+    "/v2/message/messages/{id}": {
+      "get": {
+        "operationId": "getMessageV2",
+        "summary": "getMessageV2",
+        "description": "- Fetches message by ID\n- If the message html is omitted on the entity, then it keeps the content on the message as a signed url\n  {\n    ...\n    _id: \"4d74976d-fb64-47fd-85e2-65eea140f5eb\",\n    _schema: \"message\",\n    _org: \"org-123\",\n    html_omitted: true,\n    html_download_url: \"https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html\"\n  }\n",
+        "tags": [
+          "Messages"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "description": "Message ID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "4d74976d-fb64-47fd-85e2-65eea140f5eb"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "allOf": [
+                    {
+                      "$ref": "#/components/schemas/MessageV2"
+                    }
+                  ]
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        }
+      }
     }
   },
   "components": {
@@ -946,6 +1002,28 @@
           }
         }
       },
+      "MessageV2": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseEntity"
+          },
+          {
+            "$ref": "#/components/schemas/Message"
+          }
+        ],
+        "properties": {
+          "html_omitted": {
+            "type": "boolean",
+            "description": "If true then html is not provided and must be downloaded using the html_download_url",
+            "default": false
+          },
+          "html_download_url": {
+            "type": "string",
+            "description": "HTML body download URL",
+            "example": "https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html"
+          }
+        }
+      },
       "Address": {
         "type": "object",
         "required": [
@@ -1142,9 +1220,6 @@
     }
   },
   "servers": [
-    {
-      "url": "https://message.sls.epilot.io"
-    },
     {
       "url": "https://message.sls.epilot.io"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/message-client",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "description": "API Client for epilot Message API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",