@unified-api/typescript-sdk 2.12.0 → 2.14.0

package/docs/sdks/task/README.md

@@ -41,6 +41,10 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.task.createTaskComment({
+    taskComment: {
+      taskId: "<id>",
+      text: "<value>",
+    },
     connectionId: "<id>",
   });
 
@@ -69,6 +73,10 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await taskCreateTaskComment(unifiedTo, {
+    taskComment: {
+      taskId: "<id>",
+      text: "<value>",
+    },
     connectionId: "<id>",
   });
 
@@ -121,6 +129,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.task.createTaskProject({
+    taskProject: {},
     connectionId: "<id>",
   });
 
@@ -149,6 +158,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await taskCreateTaskProject(unifiedTo, {
+    taskProject: {},
     connectionId: "<id>",
   });
 
@@ -201,6 +211,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.task.createTaskTask({
+    taskTask: {},
     connectionId: "<id>",
   });
 
@@ -229,6 +240,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await taskCreateTaskTask(unifiedTo, {
+    taskTask: {},
     connectionId: "<id>",
   });
 
@@ -767,6 +779,10 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.task.patchTaskComment({
+    taskComment: {
+      taskId: "<id>",
+      text: "<value>",
+    },
     connectionId: "<id>",
     id: "<id>",
   });
@@ -796,6 +812,10 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await taskPatchTaskComment(unifiedTo, {
+    taskComment: {
+      taskId: "<id>",
+      text: "<value>",
+    },
     connectionId: "<id>",
     id: "<id>",
   });
@@ -849,6 +869,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.task.patchTaskProject({
+    taskProject: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -878,6 +899,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await taskPatchTaskProject(unifiedTo, {
+    taskProject: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -931,6 +953,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.task.patchTaskTask({
+    taskTask: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -960,6 +983,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await taskPatchTaskTask(unifiedTo, {
+    taskTask: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -1259,6 +1283,10 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.task.updateTaskComment({
+    taskComment: {
+      taskId: "<id>",
+      text: "<value>",
+    },
     connectionId: "<id>",
     id: "<id>",
   });
@@ -1288,6 +1316,10 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await taskUpdateTaskComment(unifiedTo, {
+    taskComment: {
+      taskId: "<id>",
+      text: "<value>",
+    },
     connectionId: "<id>",
     id: "<id>",
   });
@@ -1341,6 +1373,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.task.updateTaskProject({
+    taskProject: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -1370,6 +1403,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await taskUpdateTaskProject(unifiedTo, {
+    taskProject: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -1423,6 +1457,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.task.updateTaskTask({
+    taskTask: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -1452,6 +1487,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await taskUpdateTaskTask(unifiedTo, {
+    taskTask: {},
     connectionId: "<id>",
     id: "<id>",
   });

package/docs/sdks/taxrate/README.md

@@ -29,6 +29,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.taxrate.createAccountingTaxrate({
+    accountingTaxrate: {},
     connectionId: "<id>",
   });
 
@@ -57,6 +58,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await taxrateCreateAccountingTaxrate(unifiedTo, {
+    accountingTaxrate: {},
     connectionId: "<id>",
   });
 
@@ -271,6 +273,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.taxrate.patchAccountingTaxrate({
+    accountingTaxrate: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -300,6 +303,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await taxratePatchAccountingTaxrate(unifiedTo, {
+    accountingTaxrate: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -435,6 +439,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.taxrate.updateAccountingTaxrate({
+    accountingTaxrate: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -464,6 +469,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await taxrateUpdateAccountingTaxrate(unifiedTo, {
+    accountingTaxrate: {},
     connectionId: "<id>",
     id: "<id>",
   });

package/docs/sdks/ticket/README.md

@@ -29,6 +29,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.ticket.createTicketingTicket({
+    ticketingTicket: {},
     connectionId: "<id>",
   });
 
@@ -57,6 +58,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ticketCreateTicketingTicket(unifiedTo, {
+    ticketingTicket: {},
     connectionId: "<id>",
   });
 
@@ -271,6 +273,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.ticket.patchTicketingTicket({
+    ticketingTicket: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -300,6 +303,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ticketPatchTicketingTicket(unifiedTo, {
+    ticketingTicket: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -435,6 +439,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.ticket.updateTicketingTicket({
+    ticketingTicket: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -464,6 +469,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ticketUpdateTicketingTicket(unifiedTo, {
+    ticketingTicket: {},
     connectionId: "<id>",
     id: "<id>",
   });

package/docs/sdks/ticketing/README.md

@@ -41,6 +41,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.ticketing.createTicketingCustomer({
+    ticketingCustomer: {},
     connectionId: "<id>",
   });
 
@@ -69,6 +70,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ticketingCreateTicketingCustomer(unifiedTo, {
+    ticketingCustomer: {},
     connectionId: "<id>",
   });
 
@@ -121,6 +123,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.ticketing.createTicketingNote({
+    ticketingNote: {},
     connectionId: "<id>",
   });
 
@@ -149,6 +152,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ticketingCreateTicketingNote(unifiedTo, {
+    ticketingNote: {},
     connectionId: "<id>",
   });
 
@@ -201,6 +205,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.ticketing.createTicketingTicket({
+    ticketingTicket: {},
     connectionId: "<id>",
   });
 
@@ -229,6 +234,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ticketingCreateTicketingTicket(unifiedTo, {
+    ticketingTicket: {},
     connectionId: "<id>",
   });
 
@@ -767,6 +773,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.ticketing.patchTicketingCustomer({
+    ticketingCustomer: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -796,6 +803,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ticketingPatchTicketingCustomer(unifiedTo, {
+    ticketingCustomer: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -849,6 +857,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.ticketing.patchTicketingNote({
+    ticketingNote: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -878,6 +887,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ticketingPatchTicketingNote(unifiedTo, {
+    ticketingNote: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -931,6 +941,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.ticketing.patchTicketingTicket({
+    ticketingTicket: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -960,6 +971,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ticketingPatchTicketingTicket(unifiedTo, {
+    ticketingTicket: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -1259,6 +1271,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.ticketing.updateTicketingCustomer({
+    ticketingCustomer: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -1288,6 +1301,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ticketingUpdateTicketingCustomer(unifiedTo, {
+    ticketingCustomer: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -1341,6 +1355,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.ticketing.updateTicketingNote({
+    ticketingNote: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -1370,6 +1385,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ticketingUpdateTicketingNote(unifiedTo, {
+    ticketingNote: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -1423,6 +1439,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.ticketing.updateTicketingTicket({
+    ticketingTicket: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -1452,6 +1469,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ticketingUpdateTicketingTicket(unifiedTo, {
+    ticketingTicket: {},
     connectionId: "<id>",
     id: "<id>",
   });

package/docs/sdks/transaction/README.md

@@ -29,6 +29,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.transaction.createAccountingTransaction({
+    accountingTransaction: {},
     connectionId: "<id>",
   });
 
@@ -57,6 +58,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await transactionCreateAccountingTransaction(unifiedTo, {
+    accountingTransaction: {},
     connectionId: "<id>",
   });
 
@@ -271,6 +273,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.transaction.patchAccountingTransaction({
+    accountingTransaction: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -300,6 +303,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await transactionPatchAccountingTransaction(unifiedTo, {
+    accountingTransaction: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -435,6 +439,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.transaction.updateAccountingTransaction({
+    accountingTransaction: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -464,6 +469,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await transactionUpdateAccountingTransaction(unifiedTo, {
+    accountingTransaction: {},
     connectionId: "<id>",
     id: "<id>",
   });

package/docs/sdks/uc/README.md

@@ -30,6 +30,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.uc.createUcContact({
+    ucContact: {},
     connectionId: "<id>",
   });
 
@@ -58,6 +59,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ucCreateUcContact(unifiedTo, {
+    ucContact: {},
     connectionId: "<id>",
   });
 
@@ -352,6 +354,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.uc.patchUcContact({
+    ucContact: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -381,6 +384,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ucPatchUcContact(unifiedTo, {
+    ucContact: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -516,6 +520,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.uc.updateUcContact({
+    ucContact: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -545,6 +550,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await ucUpdateUcContact(unifiedTo, {
+    ucContact: {},
     connectionId: "<id>",
     id: "<id>",
   });

package/docs/sdks/unified/README.md

@@ -42,7 +42,18 @@ const unifiedTo = new UnifiedTo({
 });
 
 async function run() {
-  const result = await unifiedTo.unified.createUnifiedConnection();
+  const result = await unifiedTo.unified.createUnifiedConnection({
+    categories: [
+      "accounting",
+      "martech",
+      "martech",
+    ],
+    integrationType: "<value>",
+    permissions: [
+      "lms_course_read",
+      "scim_users_read",
+    ],
+  });
 
   // Handle the result
   console.log(result);
@@ -68,7 +79,18 @@ const unifiedTo = new UnifiedToCore({
 });
 
 async function run() {
-  const res = await unifiedCreateUnifiedConnection(unifiedTo);
+  const res = await unifiedCreateUnifiedConnection(unifiedTo, {
+    categories: [
+      "accounting",
+      "martech",
+      "martech",
+    ],
+    integrationType: "<value>",
+    permissions: [
+      "lms_course_read",
+      "scim_users_read",
+    ],
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -118,7 +140,13 @@ const unifiedTo = new UnifiedTo({
 });
 
 async function run() {
-  const result = await unifiedTo.unified.createUnifiedWebhook({});
+  const result = await unifiedTo.unified.createUnifiedWebhook({
+    webhook: {
+      connectionId: "<id>",
+      event: "created",
+      objectType: "hris_employee",
+    },
+  });
 
   // Handle the result
   console.log(result);
@@ -144,7 +172,13 @@ const unifiedTo = new UnifiedToCore({
 });
 
 async function run() {
-  const res = await unifiedCreateUnifiedWebhook(unifiedTo, {});
+  const res = await unifiedCreateUnifiedWebhook(unifiedTo, {
+    webhook: {
+      connectionId: "<id>",
+      event: "created",
+      objectType: "hris_employee",
+    },
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -977,6 +1011,16 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.unified.patchUnifiedConnection({
+    connection: {
+      categories: [
+        "metadata",
+        "crm",
+      ],
+      integrationType: "<value>",
+      permissions: [
+
+      ],
+    },
     id: "<id>",
   });
 
@@ -1005,6 +1049,16 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await unifiedPatchUnifiedConnection(unifiedTo, {
+    connection: {
+      categories: [
+        "metadata",
+        "crm",
+      ],
+      integrationType: "<value>",
+      permissions: [
+  
+      ],
+    },
     id: "<id>",
   });
 
@@ -1057,6 +1111,11 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.unified.patchUnifiedWebhook({
+    webhook: {
+      connectionId: "<id>",
+      event: "deleted",
+      objectType: "crm_deal",
+    },
     id: "<id>",
   });
 
@@ -1085,6 +1144,11 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await unifiedPatchUnifiedWebhook(unifiedTo, {
+    webhook: {
+      connectionId: "<id>",
+      event: "deleted",
+      objectType: "crm_deal",
+    },
     id: "<id>",
   });
 
@@ -1377,6 +1441,17 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.unified.updateUnifiedConnection({
+    connection: {
+      categories: [
+        "metadata",
+        "accounting",
+        "metadata",
+      ],
+      integrationType: "<value>",
+      permissions: [
+
+      ],
+    },
     id: "<id>",
   });
 
@@ -1405,6 +1480,17 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await unifiedUpdateUnifiedConnection(unifiedTo, {
+    connection: {
+      categories: [
+        "metadata",
+        "accounting",
+        "metadata",
+      ],
+      integrationType: "<value>",
+      permissions: [
+  
+      ],
+    },
     id: "<id>",
   });
 
@@ -1457,6 +1543,11 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.unified.updateUnifiedWebhook({
+    webhook: {
+      connectionId: "<id>",
+      event: "created",
+      objectType: "payment_link",
+    },
     id: "<id>",
   });
 
@@ -1485,6 +1576,11 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await unifiedUpdateUnifiedWebhook(unifiedTo, {
+    webhook: {
+      connectionId: "<id>",
+      event: "created",
+      objectType: "payment_link",
+    },
     id: "<id>",
   });
 

package/docs/sdks/user/README.md

@@ -29,6 +29,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.user.createScimUsers({
+    scimUser: {},
     connectionId: "<id>",
   });
 
@@ -57,6 +58,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await userCreateScimUsers(unifiedTo, {
+    scimUser: {},
     connectionId: "<id>",
   });
 
@@ -271,6 +273,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.user.patchScimUsers({
+    scimUser: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -300,6 +303,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await userPatchScimUsers(unifiedTo, {
+    scimUser: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -435,6 +439,7 @@ const unifiedTo = new UnifiedTo({
 
 async function run() {
   const result = await unifiedTo.user.updateScimUsers({
+    scimUser: {},
     connectionId: "<id>",
     id: "<id>",
   });
@@ -464,6 +469,7 @@ const unifiedTo = new UnifiedToCore({
 
 async function run() {
   const res = await userUpdateScimUsers(unifiedTo, {
+    scimUser: {},
     connectionId: "<id>",
     id: "<id>",
   });