@unito/integration-api 4.5.2 → 4.6.0

package/dist/schemas/webhookItem.json

@@ -0,0 +1,30 @@
+{
+  "$id": "https://unito.io/integration_api/webhookItem.schema.json",
+  "title": "WebhookItem",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "parentCanonicalPath": {
+      "type": "string"
+    },
+    "item": {
+      "type": "object",
+      "required": [
+        "canonicalPath"
+      ],
+      "properties": {
+        "canonicalPath": {
+          "type": "string",
+          "nullable": false
+        },
+        "fields": {
+          "type": "object",
+          "additionalProperties": true
+        }
+      }
+    },
+    "date": {
+      "type": "string"
+    }
+  }
+}

package/dist/schemas/webhookParseResponsePayload.json

@@ -12,6 +12,15 @@
       "items": {
         "$ref": "https://unito.io/integration_api/webhookParsedItem.schema.json"
       }
+    },
+    {
+      "$ref": "https://unito.io/integration_api/webhookItem.schema.json"
+    },
+    {
+      "type": "array",
+      "items": {
+        "$ref": "https://unito.io/integration_api/webhookItem.schema.json"
+      }
     }
   ]
 }

package/dist/src/types.d.ts

@@ -541,6 +541,7 @@ export interface WebhookAcknowledgeResponsePayload {
 }
 /**
  * A WebhookParsedItem describes the shape an item found within a webhook's parsed payload.
+ * @deprecated use WebhookParseCanonicalItem instead.
  */
 export interface WebhookParsedItem {
     /**
@@ -572,8 +573,26 @@ export interface WebhookParsedItem {
         impactedItems: WebhookParsedItem[];
     }[];
 }
+export interface WebhookItem {
+    /**
+     * The canonical path of the parent item, if applicable.
+     */
+    parentCanonicalPath: string;
+    /**
+     * The date at which the event took place, expressed as an ISO 8601 string.
+     * e.g 2023-11-05T08:15:30.000-05:00"
+     */
+    date: string;
+    /**
+     * The item impacted by this event.
+     */
+    item: {
+        fields?: Item['fields'];
+        canonicalPath: string;
+    };
+}
 /**
  * A WebhookParseResponsePayload describes the shape of the response on the "parse webhook" endpoint.
  */
-export type WebhookParseResponsePayload = WebhookParsedItem | WebhookParsedItem[];
+export type WebhookParseResponsePayload = WebhookParsedItem | WebhookParsedItem[] | WebhookItem | WebhookItem[];
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-api",
-  "version": "4.5.2",
+  "version": "4.6.0",
   "description": "The Unito Integration API",
   "type": "module",
   "types": "./dist/src/index.d.ts",