@epilot/sdk 2.2.7 → 2.3.1

package/definitions/{erp-integration.json → integration-toolkit.json}

@@ -1,9 +1,9 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "title": "ERP Integration API",
-    "version": "0.56.0",
-    "description": "API for integrating with ERP systems, handling tracking acknowledgments, triggering ERP processes, and processing ERP updates."
+    "title": "Integration Toolkit API",
+    "version": "1.0.3",
+    "description": "API for integrating with external systems in a standardised way."
   },
   "tags": [
     {
@@ -33,7 +33,7 @@
   ],
   "servers": [
     {
-      "url": "https://erp-integration-api.sls.epilot.io"
+      "url": "https://integration-toolkit.sls.epilot.io"
     }
   ],
   "security": [
@@ -3196,6 +3196,13 @@
           "protected": {
             "type": "boolean",
             "description": "If true, integration is displayed in read-only mode in the UI to discourage changes"
+          },
+          "_manifest": {
+            "type": "array",
+            "description": "The manifest IDs associated with this integration",
+            "items": {
+              "type": "string"
+            }
           }
         }
       },
@@ -5097,12 +5104,14 @@
           },
           "headers": {
             "type": "object",
+            "description": "Custom HTTP headers for the request. Values support {{variable}} interpolation from the request payload and {{env.VAR}} references for environment variables.",
             "additionalProperties": {
               "type": "string"
             }
           },
           "query_params": {
             "type": "object",
+            "description": "Query parameters for the request. Values support {{variable}} interpolation from the request payload.",
             "additionalProperties": {
               "type": "string"
             }
@@ -7154,7 +7163,7 @@
         "properties": {
           "use_case_id": {
             "type": "string",
-            "description": "Filter by use case ID (UUID). Empty string matches \"General\" events."
+            "description": "Filter by use case ID (UUID). Empty string matches \"General\" events. Special value \"__unknown__\" matches events whose use_case_id does not belong to any currently configured use case for this integration (excludes \"General\" events).\n"
           },
           "use_case_type": {
             "type": "string",
@@ -7440,6 +7449,61 @@
               "secure_proxy"
             ],
             "description": "Filter by use case type"
+          },
+          "group_by": {
+            "type": "string",
+            "enum": [
+              "use_case_type",
+              "use_case"
+            ],
+            "description": "Field to group the bucket breakdown by"
+          }
+        }
+      },
+      "TimeSeriesBreakdownItemV2": {
+        "type": "object",
+        "required": [
+          "success_count",
+          "error_count",
+          "warning_count",
+          "skipped_count",
+          "total_count"
+        ],
+        "properties": {
+          "use_case_type": {
+            "type": "string",
+            "enum": [
+              "inbound",
+              "outbound",
+              "file_proxy",
+              "managed_call",
+              "secure_proxy"
+            ],
+            "description": "Present when grouping by use_case_type"
+          },
+          "use_case_id": {
+            "type": "string",
+            "description": "Present when grouping by use_case. Unknown historical IDs are collapsed into \"__unknown__\""
+          },
+          "success_count": {
+            "type": "integer",
+            "description": "Number of successful events in the breakdown item"
+          },
+          "error_count": {
+            "type": "integer",
+            "description": "Number of error events in the breakdown item"
+          },
+          "warning_count": {
+            "type": "integer",
+            "description": "Number of warning events in the breakdown item"
+          },
+          "skipped_count": {
+            "type": "integer",
+            "description": "Number of skipped events in the breakdown item"
+          },
+          "total_count": {
+            "type": "integer",
+            "description": "Total events in the breakdown item"
           }
         }
       },
@@ -7474,6 +7538,13 @@
           "total_count": {
             "type": "integer",
             "description": "Total events in the bucket"
+          },
+          "breakdown": {
+            "type": "array",
+            "description": "Statistics breakdown by the requested group_by field for this bucket",
+            "items": {
+              "$ref": "#/components/schemas/TimeSeriesBreakdownItemV2"
+            }
           }
         }
       }

package/definitions/journey.json

@@ -1493,6 +1493,15 @@
           "validationRules": {
             "$ref": "#/components/schemas/ValidationRuleRef"
           },
+          "_manifest": {
+            "type": "array",
+            "description": "Manifest/Blueprint ID used to create/update the entity",
+            "items": {
+              "type": "string",
+              "format": "uuid",
+              "example": "123e4567-e89b-12d3-a456-426614174000"
+            }
+          },
           "createdBy": {
             "type": "string"
           },

package/definitions/message-runtime.json

@@ -1 +1 @@
-{"s":"https://message.sls.epilot.io","o":[["sendMessage","post","/v1/message/messages",[["do_not_create_entities","q"]],1],["updateMessage","put","/v1/message/messages"],["getMessage","get","/v1/message/messages/{id}",[["id","p",true]]],["deleteMessage","delete","/v1/message/messages/{id}",[["id","p",true]]],["getMessageEml","get","/v1/message/messages/{id}/eml",[["id","p",true]]],["searchMessages","post","/v1/message/messages:search",null,1],["trashMessage","post","/v1/message/messages/{id}/trash",[["id","p",true]]],["untrashMessage","post","/v1/message/messages/{id}/untrash",[["id","p",true]]],["markReadMessage","post","/v1/message/messages/{id}/read",[["id","p",true]]],["markReadMessageV2","post","/v2/message/messages/{id}/read",[["id","p",true]],1],["markUnreadMessage","post","/v1/message/messages/{id}/unread",[["id","p",true]]],["getUnread","get","/v1/message/messages/unread/{actor}",[["actor","p",true],["email_filter","q"]]],["markUnreadMessageV2","post","/v2/message/messages/{id}/unread",[["id","p",true]],1],["searchThreads","post","/v1/message/threads:search",null,1],["searchThreadsV2","post","/v2/message/threads:search",null,1],["searchIds","post","/v1/message/threads:searchIds",null,1],["updateThread","put","/v1/message/threads"],["deleteThread","delete","/v1/message/threads/{id}",[["id","p",true]]],["moveThread","post","/v1/message/threads/{id}:move",[["id","p",true]],1],["markThreadAsDone","post","/v1/message/threads/{id}:markAsDone",[["id","p",true]]],["markThreadAsOpen","post","/v1/message/threads/{id}:markAsOpen",[["id","p",true]]],["getThreadTimeline","get","/v1/message/threads/{id}/timeline",[["id","p",true]]],["trashThread","post","/v1/message/threads/{id}/trash",[["id","p",true]]],["untrashThread","post","/v1/message/threads/{id}/untrash",[["id","p",true]]],["threadBulkActionsRead","post","/v1/message/threads/bulk:read",null,1],["threadBulkActionsUnread","post","/v1/message/threads/bulk:unread",null,1],["threadBulkActionsFavorite","post","/v1/message/threads/bulk:favorite",null,1],["threadBulkActionsUnfavorite","post","/v1/message/threads/bulk:unfavorite",null,1],["threadBulkActionsTrash","post","/v1/message/threads/bulk:trash",null,1],["threadBulkActionsUntrash","post","/v1/message/threads/bulk:untrash",null,1],["threadBulkActionsDelete","post","/v1/message/threads/bulk:delete",null,1],["threadBulkActionsDone","post","/v1/message/threads/bulk:done",null,1],["threadBulkActionsOpen","post","/v1/message/threads/bulk:open",null,1],["markReadThread","post","/v1/message/threads/{id}/read",[["id","p",true]]],["markReadThreadV2","post","/v2/message/threads/{id}/read",[["id","p",true]],1],["markUnreadThread","post","/v1/message/threads/{id}/unread",[["id","p",true]]],["markUnreadThreadV2","post","/v2/message/threads/{id}/unread",[["id","p",true]],1],["assignThread","post","/v1/message/threads/{id}/assign",[["id","p",true]],1],["unassignThread","post","/v1/message/threads/{id}/unassign",[["id","p",true]],1],["assignUsers","post","/v1/message/threads/{id}/assign:users",[["id","p",true]],1],["assignUsersV2","post","/v2/message/threads/{id}/assign:users",[["id","p",true]],1],["pinThread","post","/v1/message/threads/{id}:pin",[["id","p",true]]],["unpinThread","delete","/v1/message/threads/{id}:pin",[["id","p",true]]],["createDraft","post","/v1/message/drafts",null,1],["sendDraft","post","/v1/message/drafts:send"],["getMessageV2","get","/v2/message/messages/{id}",[["id","p",true]]]]}
+{"s":"https://message.sls.epilot.io","o":[["sendMessage","post","/v1/message/messages",[["do_not_create_entities","q"]],1],["updateMessage","put","/v1/message/messages"],["getMessage","get","/v1/message/messages/{id}",[["id","p",true]]],["deleteMessage","delete","/v1/message/messages/{id}",[["id","p",true]]],["getMessageEml","get","/v1/message/messages/{id}/eml",[["id","p",true]]],["searchMessages","post","/v1/message/messages:search",null,1],["trashMessage","post","/v1/message/messages/{id}/trash",[["id","p",true]]],["untrashMessage","post","/v1/message/messages/{id}/untrash",[["id","p",true]]],["markReadMessage","post","/v1/message/messages/{id}/read",[["id","p",true]]],["markReadMessageV2","post","/v2/message/messages/{id}/read",[["id","p",true]],1],["markUnreadMessage","post","/v1/message/messages/{id}/unread",[["id","p",true]]],["getUnread","get","/v1/message/messages/unread/{actor}",[["actor","p",true],["email_filter","q"]]],["markUnreadMessageV2","post","/v2/message/messages/{id}/unread",[["id","p",true]],1],["searchThreads","post","/v1/message/threads:search",null,1],["searchThreadsV2","post","/v2/message/threads:search",null,1],["searchIds","post","/v1/message/threads:searchIds",null,1],["updateThread","put","/v1/message/threads"],["deleteThread","delete","/v1/message/threads/{id}",[["id","p",true]]],["moveThread","post","/v1/message/threads/{id}:move",[["id","p",true]],1],["markThreadAsDone","post","/v1/message/threads/{id}:markAsDone",[["id","p",true]]],["markThreadAsOpen","post","/v1/message/threads/{id}:markAsOpen",[["id","p",true]]],["getThreadTimeline","get","/v1/message/threads/{id}/timeline",[["id","p",true]]],["trashThread","post","/v1/message/threads/{id}/trash",[["id","p",true]]],["untrashThread","post","/v1/message/threads/{id}/untrash",[["id","p",true]]],["spamThread","post","/v1/message/threads/{id}/spam",[["id","p",true]]],["unspamThread","post","/v1/message/threads/{id}/unspam",[["id","p",true]]],["spamMessage","post","/v1/message/messages/{id}/spam",[["id","p",true]]],["unspamMessage","post","/v1/message/messages/{id}/unspam",[["id","p",true]]],["bulkMoveThreads","post","/v1/message/threads/bulk:move",null,1],["bulkAssignThreads","post","/v1/message/threads/bulk:assign",null,1],["threadBulkActionsRead","post","/v1/message/threads/bulk:read",null,1],["threadBulkActionsUnread","post","/v1/message/threads/bulk:unread",null,1],["threadBulkActionsFavorite","post","/v1/message/threads/bulk:favorite",null,1],["threadBulkActionsUnfavorite","post","/v1/message/threads/bulk:unfavorite",null,1],["threadBulkActionsTrash","post","/v1/message/threads/bulk:trash",null,1],["threadBulkActionsUntrash","post","/v1/message/threads/bulk:untrash",null,1],["threadBulkActionsDelete","post","/v1/message/threads/bulk:delete",null,1],["threadBulkActionsDone","post","/v1/message/threads/bulk:done",null,1],["threadBulkActionsOpen","post","/v1/message/threads/bulk:open",null,1],["markReadThread","post","/v1/message/threads/{id}/read",[["id","p",true]]],["markReadThreadV2","post","/v2/message/threads/{id}/read",[["id","p",true]],1],["markUnreadThread","post","/v1/message/threads/{id}/unread",[["id","p",true]]],["markUnreadThreadV2","post","/v2/message/threads/{id}/unread",[["id","p",true]],1],["assignThread","post","/v1/message/threads/{id}/assign",[["id","p",true]],1],["unassignThread","post","/v1/message/threads/{id}/unassign",[["id","p",true]],1],["assignUsers","post","/v1/message/threads/{id}/assign:users",[["id","p",true]],1],["assignUsersV2","post","/v2/message/threads/{id}/assign:users",[["id","p",true]],1],["pinThread","post","/v1/message/threads/{id}:pin",[["id","p",true]]],["unpinThread","delete","/v1/message/threads/{id}:pin",[["id","p",true]]],["createDraft","post","/v1/message/drafts",null,1],["sendDraft","post","/v1/message/drafts:send"],["getMessageV2","get","/v2/message/messages/{id}",[["id","p",true]]]]}

package/definitions/message.json

@@ -536,6 +536,11 @@
                       "type": "number",
                       "description": "Total of unassigned messages",
                       "example": 1
+                    },
+                    "spam": {
+                      "type": "number",
+                      "description": "Total of spam messages",
+                      "example": 3
                     }
                   }
                 }
@@ -1021,6 +1026,190 @@
         }
       }
     },
+    "/v1/message/threads/{id}/spam": {
+      "post": {
+        "operationId": "spamThread",
+        "summary": "spamThread",
+        "description": "Mark a thread as spam",
+        "tags": [
+          "Threads"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "description": "Thread ID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "404": {
+            "description": "Not Found"
+          }
+        }
+      }
+    },
+    "/v1/message/threads/{id}/unspam": {
+      "post": {
+        "operationId": "unspamThread",
+        "summary": "unspamThread",
+        "description": "Remove spam marking from a thread",
+        "tags": [
+          "Threads"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "description": "Thread ID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "404": {
+            "description": "Not Found"
+          }
+        }
+      }
+    },
+    "/v1/message/messages/{id}/spam": {
+      "post": {
+        "operationId": "spamMessage",
+        "summary": "spamMessage",
+        "description": "Mark a single message as spam. Also marks the parent thread as spam if all messages in the thread are spam.",
+        "tags": [
+          "Messages"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "description": "Message ID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Success"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "404": {
+            "description": "Not Found"
+          }
+        }
+      }
+    },
+    "/v1/message/messages/{id}/unspam": {
+      "post": {
+        "operationId": "unspamMessage",
+        "summary": "unspamMessage",
+        "description": "Remove spam marking from a single message. Also removes spam from the parent thread if no other messages are spam.",
+        "tags": [
+          "Messages"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "description": "Message ID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Success"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "404": {
+            "description": "Not Found"
+          }
+        }
+      }
+    },
+    "/v1/message/threads/bulk:move": {
+      "post": {
+        "operationId": "bulkMoveThreads",
+        "summary": "bulkMoveThreads",
+        "description": "Move many threads to a different inbox",
+        "tags": [
+          "Threads"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/BulkActionsPayloadWithScopes"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success"
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        }
+      }
+    },
+    "/v1/message/threads/bulk:assign": {
+      "post": {
+        "operationId": "bulkAssignThreads",
+        "summary": "bulkAssignThreads",
+        "description": "Assign many threads",
+        "tags": [
+          "Threads"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/BulkActionsPayloadWithScopes"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success"
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        }
+      }
+    },
     "/v1/message/threads/bulk:read": {
       "post": {
         "operationId": "threadBulkActionsRead",
@@ -2598,6 +2787,19 @@
           {
             "type": "object",
             "properties": {
+              "assign_to": {
+                "description": "Assignable IDs to assign the threads to",
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "example": "206801"
+                }
+              },
+              "inbox_id": {
+                "description": "Inbox ID to move the threads to",
+                "type": "string",
+                "example": "3f34ce73-089c-4d45-a5ee-c161234e41c3"
+              },
               "scopes": {
                 "description": "The scopes to be used when marking an item as read or unread. The read status will be synced for all provided scopes.",
                 "example": [

package/definitions/sharing-runtime.json

@@ -0,0 +1 @@
+{"s":"https://sharing-api.sls.epilot.io","o":[["getSharingConfiguration","get","/v1/sharing/configurations/{partner_org_id}",[["PartnerOrgIdPath"]]],["updateSharingConfiguration","patch","/v1/sharing/configurations/{partner_org_id}",[["PartnerOrgIdPath"]],1],["deleteSharingConfiguration","delete","/v1/sharing/configurations/{partner_org_id}",[["PartnerOrgIdPath"]]],["assignRoleToConfiguration","put","/v1/sharing/configurations/{partner_org_id}/role",[["PartnerOrgIdPath"]],1],["getSharingConfigurations","get","/v1/sharing/configurations",[["partner_org_ids","q",true,"form",false]]],["searchPartnerSharingConfigurations","post","/v1/sharing/configurations:search",null,1],["getConfigurationsByTemplateRole","get","/v1/sharing/configurations/by-role/{template_role_id}",[["template_role_id","p",true]]],["shareEntityWithPartners","post","/v1/sharing/entities:share",null,1],["shareChildEntityWithPartners","post","/v1/sharing/entities:share-child",null,1],["offerEntityToPartners","post","/v1/sharing/entities:offer",null,1],["getOfferStatus","get","/v1/sharing/offers/status",[["partner_org_id","q",true],["sharing_org_id","q",true],["entity_id","q",true]]],["acceptOffer","post","/v1/sharing/offers:accept",null,1]],"v":"3.0.3","cp":{"PartnerOrgIdPath":["partner_org_id","p",true]}}