@workbuddy/cli-vnext 1.0.38 → 1.0.40

package/dist/index.js

@@ -4902,11 +4902,6 @@ var operations = [
         type: "string",
         description: "Display name"
       },
-      {
-        name: "description",
-        type: "string",
-        description: "Detailed description"
-      },
       {
         name: "status",
         type: "object",
@@ -4961,11 +4956,6 @@ var operations = [
         type: "string",
         description: "Finalisation date (ISO 8601 datetime)"
       },
-      {
-        name: "notes",
-        type: "string",
-        description: "Additional notes or comments"
-      },
       {
         name: "tags",
         type: "string",
@@ -5591,15 +5581,6 @@ var operations = [
         required: false,
         description: "Due date (ISO 8601 datetime)"
       },
-      {
-        name: "notes",
-        cliName: "notes",
-        optionKey: "notes",
-        source: "body",
-        type: "string",
-        required: false,
-        description: "Additional notes or comments"
-      },
       {
         name: "customFields",
         cliName: "custom-fields",
@@ -5644,11 +5625,6 @@ var operations = [
         type: "string",
         description: "Display name"
       },
-      {
-        name: "description",
-        type: "string",
-        description: "Detailed description"
-      },
       {
         name: "status",
         type: "object",
@@ -5703,11 +5679,6 @@ var operations = [
         type: "string",
         description: "Finalisation date (ISO 8601 datetime)"
       },
-      {
-        name: "notes",
-        type: "string",
-        description: "Additional notes or comments"
-      },
       {
         name: "tags",
         type: "string",
@@ -5800,15 +5771,6 @@ var operations = [
         required: false,
         description: "Due date (ISO 8601 datetime)"
       },
-      {
-        name: "notes",
-        cliName: "notes",
-        optionKey: "notes",
-        source: "body",
-        type: "string",
-        required: false,
-        description: "Additional notes or comments"
-      },
       {
         name: "tagsSet",
         cliName: "tags-set",
@@ -5913,11 +5875,6 @@ var operations = [
         type: "string",
         description: "Display name"
       },
-      {
-        name: "description",
-        type: "string",
-        description: "Detailed description"
-      },
       {
         name: "status",
         type: "object",
@@ -5972,11 +5929,6 @@ var operations = [
         type: "string",
         description: "Finalisation date (ISO 8601 datetime)"
       },
-      {
-        name: "notes",
-        type: "string",
-        description: "Additional notes or comments"
-      },
       {
         name: "tags",
         type: "string",
@@ -6018,7 +5970,7 @@ var operations = [
   {
     operationId: "PublicJobStageController_delete",
     displayName: "Delete a stage",
-    description: "Permanently delete a stage and all associated items/resources. This action cannot be undone.",
+    description: "Delete a stage. If tenant settings are configured to mark stages and items as cancelled on deletion, the stage is cancelled instead of permanently removed.",
     method: "DELETE",
     path: "/stages/{id}",
     commandPath: ["stages", "delete"],
@@ -6084,11 +6036,6 @@ var operations = [
         type: "string",
         description: "Display name"
       },
-      {
-        name: "description",
-        type: "string",
-        description: "Detailed description"
-      },
       {
         name: "status",
         type: "object",
@@ -6143,11 +6090,6 @@ var operations = [
         type: "string",
         description: "Finalisation date (ISO 8601 datetime)"
       },
-      {
-        name: "notes",
-        type: "string",
-        description: "Additional notes or comments"
-      },
       {
         name: "tags",
         type: "string",
@@ -6257,11 +6199,6 @@ var operations = [
         type: "string",
         description: "Display name"
       },
-      {
-        name: "description",
-        type: "string",
-        description: "Detailed description"
-      },
       {
         name: "status",
         type: "object",
@@ -6316,11 +6253,6 @@ var operations = [
         type: "string",
         description: "Finalisation date (ISO 8601 datetime)"
       },
-      {
-        name: "notes",
-        type: "string",
-        description: "Additional notes or comments"
-      },
       {
         name: "tags",
         type: "string",
@@ -6430,11 +6362,6 @@ var operations = [
         type: "string",
         description: "Display name"
       },
-      {
-        name: "description",
-        type: "string",
-        description: "Detailed description"
-      },
       {
         name: "status",
         type: "object",
@@ -6489,11 +6416,6 @@ var operations = [
         type: "string",
         description: "Finalisation date (ISO 8601 datetime)"
       },
-      {
-        name: "notes",
-        type: "string",
-        description: "Additional notes or comments"
-      },
       {
         name: "tags",
         type: "string",
@@ -6593,11 +6515,6 @@ var operations = [
         type: "string",
         description: "Display name"
       },
-      {
-        name: "description",
-        type: "string",
-        description: "Detailed description"
-      },
       {
         name: "status",
         type: "object",
@@ -6652,11 +6569,6 @@ var operations = [
         type: "string",
         description: "Finalisation date (ISO 8601 datetime)"
       },
-      {
-        name: "notes",
-        type: "string",
-        description: "Additional notes or comments"
-      },
       {
         name: "tags",
         type: "string",
@@ -6766,11 +6678,6 @@ var operations = [
         type: "string",
         description: "Display name"
       },
-      {
-        name: "description",
-        type: "string",
-        description: "Detailed description"
-      },
       {
         name: "status",
         type: "object",
@@ -6825,11 +6732,6 @@ var operations = [
         type: "string",
         description: "Finalisation date (ISO 8601 datetime)"
       },
-      {
-        name: "notes",
-        type: "string",
-        description: "Additional notes or comments"
-      },
       {
         name: "tags",
         type: "string",
@@ -7270,7 +7172,8 @@ var operations = [
         source: "path",
         type: "string",
         required: true,
-        description: "Entity type (customer, contractor, supplier)"
+        description: "Entity type (customer, contractor, supplier)",
+        enumValues: ["customer", "contractor", "supplier"]
       }
     ],
     hasRequestBody: false,
@@ -7404,392 +7307,93 @@ var operations = [
     hasRequestBody: false,
     responseFields: [
       {
-        name: "items",
-        type: "array"
-      }
-    ]
-  },
-  {
-    operationId: "PublicApiTemplateController_listEmailTemplates",
-    displayName: "List email templates for entity type",
-    description: "Retrieve all active email templates for the specified entity type (job or stage).",
-    method: "GET",
-    path: "/settings/templates/{entity}/email",
-    commandPath: ["settings", "templates", "email", "list"],
-    options: [
-      {
-        name: "entity",
-        cliName: "entity",
-        optionKey: "entity",
-        source: "path",
-        type: "string",
-        required: true,
-        description: "Entity type",
-        enumValues: ["job", "stage"]
-      }
-    ],
-    hasRequestBody: false,
-    responseFields: [
-      {
-        name: "items",
-        type: "array"
-      }
-    ]
-  },
-  {
-    operationId: "PublicApiTemplateController_listSmsTemplates",
-    displayName: "List SMS templates for entity type",
-    description: "Retrieve all active SMS templates for the specified entity type (job or stage).",
-    method: "GET",
-    path: "/settings/templates/{entity}/sms",
-    commandPath: ["settings", "templates", "sms", "list"],
-    options: [
-      {
-        name: "entity",
-        cliName: "entity",
-        optionKey: "entity",
-        source: "path",
-        type: "string",
-        required: true,
-        description: "Entity type",
-        enumValues: ["job", "stage"]
-      }
-    ],
-    hasRequestBody: false,
-    responseFields: [
-      {
-        name: "items",
-        type: "array"
-      }
-    ]
-  },
-  {
-    operationId: "PublicApiItemController_list",
-    displayName: "List items",
-    description: "Retrieve paginated editable settings items.",
-    method: "GET",
-    path: "/settings/items",
-    commandPath: ["settings", "items", "list"],
-    options: [],
-    hasRequestBody: false,
-    responseFields: [
-      {
-        name: "items",
-        type: "array"
-      },
-      {
-        name: "pagination",
-        type: "object"
-      }
-    ]
-  },
-  {
-    operationId: "PublicApiItemController_create",
-    displayName: "Create item",
-    description: "Create a settings item. This endpoint does not upsert.",
-    method: "POST",
-    path: "/settings/items",
-    commandPath: ["settings", "items", "create"],
-    options: [
-      {
-        name: "type",
-        cliName: "type",
-        optionKey: "type",
-        source: "body",
-        type: "string",
-        required: true,
-        description: "",
-        enumValues: ["SERVICE", "INVENTORY", "NON-INVENTORY", "LABOUR", "INCENTIVE"]
-      },
-      {
-        name: "name",
-        cliName: "name",
-        optionKey: "name",
-        source: "body",
-        type: "string",
-        required: true,
-        description: "Display name"
-      },
-      {
-        name: "baseUomId",
-        cliName: "base-uom-id",
-        optionKey: "baseUomId",
-        source: "body",
-        type: "string",
-        required: false,
-        description: "base uom ID"
-      },
-      {
-        name: "baseUomName",
-        cliName: "base-uom-name",
-        optionKey: "baseUomName",
-        source: "body",
-        type: "string",
-        required: false,
-        description: ""
-      },
-      {
-        name: "description",
-        cliName: "description",
-        optionKey: "description",
-        source: "body",
-        type: "string",
-        required: true,
-        description: "Detailed description"
-      },
-      {
-        name: "category",
-        cliName: "category",
-        optionKey: "category",
-        source: "body",
-        type: "object",
-        required: true,
-        description: ""
-      },
-      {
-        name: "active",
-        cliName: "active",
-        optionKey: "active",
-        source: "body",
-        type: "boolean",
-        required: false,
-        description: "Whether the entity is active"
-      },
-      {
-        name: "integrationId",
-        cliName: "integration-id",
-        optionKey: "integrationId",
-        source: "body",
-        type: "string",
-        required: false,
-        description: "integration ID"
-      },
-      {
-        name: "canOverrideDesc",
-        cliName: "can-override-desc",
-        optionKey: "canOverrideDesc",
-        source: "body",
-        type: "boolean",
-        required: false,
-        description: ""
-      },
-      {
-        name: "longDescription",
-        cliName: "long-description",
-        optionKey: "longDescription",
-        source: "body",
-        type: "string",
-        required: false,
-        description: ""
-      },
-      {
-        name: "manufacturer",
-        cliName: "manufacturer",
-        optionKey: "manufacturer",
-        source: "body",
-        type: "string",
-        required: false,
-        description: ""
-      },
-      {
-        name: "retailPrice",
-        cliName: "retail-price",
-        optionKey: "retailPrice",
-        source: "body",
-        type: "number",
-        required: false,
-        description: ""
-      },
-      {
-        name: "tradePrice",
-        cliName: "trade-price",
-        optionKey: "tradePrice",
-        source: "body",
-        type: "number",
-        required: false,
-        description: ""
-      },
-      {
-        name: "standardCost",
-        cliName: "standard-cost",
-        optionKey: "standardCost",
-        source: "body",
-        type: "number",
-        required: false,
-        description: ""
-      },
-      {
-        name: "economicOrderQty",
-        cliName: "economic-order-qty",
-        optionKey: "economicOrderQty",
-        source: "body",
-        type: "number",
-        required: false,
-        description: ""
-      },
-      {
-        name: "safetyStockQty",
-        cliName: "safety-stock-qty",
-        optionKey: "safetyStockQty",
-        source: "body",
-        type: "number",
-        required: false,
-        description: ""
-      },
-      {
-        name: "leadTimeDays",
-        cliName: "lead-time-days",
-        optionKey: "leadTimeDays",
-        source: "body",
-        type: "number",
-        required: false,
-        description: ""
-      },
-      {
-        name: "upc",
-        cliName: "upc",
-        optionKey: "upc",
-        source: "body",
-        type: "string",
-        required: false,
-        description: ""
-      },
-      {
-        name: "itemSold",
-        cliName: "item-sold",
-        optionKey: "itemSold",
-        source: "body",
-        type: "boolean",
-        required: false,
-        description: ""
-      },
-      {
-        name: "saleGlCode",
-        cliName: "sale-gl-code",
-        optionKey: "saleGlCode",
-        source: "body",
-        type: "string",
-        required: false,
-        description: ""
-      },
-      {
-        name: "saleTaxRateId",
-        cliName: "sale-tax-rate-id",
-        optionKey: "saleTaxRateId",
-        source: "body",
-        type: "string",
-        required: false,
-        description: "sale tax rate ID"
-      },
-      {
-        name: "saleTaxRateName",
-        cliName: "sale-tax-rate-name",
-        optionKey: "saleTaxRateName",
-        source: "body",
-        type: "string",
-        required: false,
-        description: ""
-      },
-      {
-        name: "itemPurchased",
-        cliName: "item-purchased",
-        optionKey: "itemPurchased",
-        source: "body",
-        type: "boolean",
-        required: false,
-        description: ""
-      },
-      {
-        name: "purchaseGlCode",
-        cliName: "purchase-gl-code",
-        optionKey: "purchaseGlCode",
-        source: "body",
-        type: "string",
-        required: false,
-        description: ""
-      },
-      {
-        name: "purchaseTaxRateId",
-        cliName: "purchase-tax-rate-id",
-        optionKey: "purchaseTaxRateId",
-        source: "body",
-        type: "string",
-        required: false,
-        description: "purchase tax rate ID"
-      },
-      {
-        name: "purchaseTaxRateName",
-        cliName: "purchase-tax-rate-name",
-        optionKey: "purchaseTaxRateName",
-        source: "body",
-        type: "string",
-        required: false,
-        description: ""
-      },
-      {
-        name: "codeInvoicingStatus",
-        cliName: "code-invoicing-status",
-        optionKey: "codeInvoicingStatus",
-        source: "body",
-        type: "string",
-        required: false,
-        description: "",
-        enumValues: ["Billable", "No Charge", "Not Billable"]
-      },
+        name: "items",
+        type: "array"
+      }
+    ]
+  },
+  {
+    operationId: "PublicApiTemplateController_listEmailTemplates",
+    displayName: "List email templates for entity type",
+    description: "Retrieve all active email templates for the specified entity type (job or stage).",
+    method: "GET",
+    path: "/settings/templates/{entity}/email",
+    commandPath: ["settings", "templates", "email", "list"],
+    options: [
       {
-        name: "suppliedBySubcontractor",
-        cliName: "supplied-by-subcontractor",
-        optionKey: "suppliedBySubcontractor",
-        source: "body",
-        type: "boolean",
-        required: false,
-        description: ""
-      },
+        name: "entity",
+        cliName: "entity",
+        optionKey: "entity",
+        source: "path",
+        type: "string",
+        required: true,
+        description: "Entity type",
+        enumValues: ["job", "stage"]
+      }
+    ],
+    hasRequestBody: false,
+    responseFields: [
       {
-        name: "autoCreateTask",
-        cliName: "auto-create-task",
-        optionKey: "autoCreateTask",
-        source: "body",
-        type: "boolean",
-        required: false,
-        description: ""
-      },
+        name: "items",
+        type: "array"
+      }
+    ]
+  },
+  {
+    operationId: "PublicApiTemplateController_listSmsTemplates",
+    displayName: "List SMS templates for entity type",
+    description: "Retrieve all active SMS templates for the specified entity type (job or stage).",
+    method: "GET",
+    path: "/settings/templates/{entity}/sms",
+    commandPath: ["settings", "templates", "sms", "list"],
+    options: [
       {
-        name: "customFields",
-        cliName: "custom-fields",
-        optionKey: "customFields",
-        source: "body",
+        name: "entity",
+        cliName: "entity",
+        optionKey: "entity",
+        source: "path",
         type: "string",
-        required: false,
-        description: "Custom fields as key-value pairs — validated against tenant field definitions"
-      },
+        required: true,
+        description: "Entity type",
+        enumValues: ["job", "stage"]
+      }
+    ],
+    hasRequestBody: false,
+    responseFields: [
       {
-        name: "trackingCategory1",
-        cliName: "tracking-category1",
-        optionKey: "trackingCategory1",
-        source: "body",
-        type: "string",
-        required: false,
-        description: ""
-      },
+        name: "items",
+        type: "array"
+      }
+    ]
+  },
+  {
+    operationId: "PublicApiItemController_list",
+    displayName: "List items",
+    description: "Retrieve paginated editable settings items.",
+    method: "GET",
+    path: "/settings/items",
+    commandPath: ["settings", "items", "list"],
+    options: [],
+    hasRequestBody: false,
+    responseFields: [
       {
-        name: "trackingCategory2",
-        cliName: "tracking-category2",
-        optionKey: "trackingCategory2",
-        source: "body",
-        type: "string",
-        required: false,
-        description: ""
+        name: "items",
+        type: "array"
       },
       {
-        name: "uoms",
-        cliName: "uoms",
-        optionKey: "uoms",
-        source: "body",
-        type: "array",
-        required: false,
-        description: ""
-      },
+        name: "pagination",
+        type: "object"
+      }
+    ]
+  },
+  {
+    operationId: "PublicApiItemController_create",
+    displayName: "Create item",
+    description: "Create a settings item. This endpoint does not upsert.",
+    method: "POST",
+    path: "/settings/items",
+    commandPath: ["settings", "items", "create"],
+    options: [
       {
         name: "raw-body",
         cliName: "raw-body",
@@ -7824,7 +7428,7 @@ var operations = [
         type: "string",
         required: false,
         description: "",
-        enumValues: ["SERVICE", "INVENTORY", "NON-INVENTORY", "LABOUR", "INCENTIVE"]
+        enumValues: ["SERVICE", "INVENTORY", "NON-INVENTORY", "INCENTIVE", "KIT", "BUNDLE"]
       },
       {
         name: "name",
@@ -8184,7 +7788,7 @@ var operations = [
         type: "string",
         required: false,
         description: "",
-        enumValues: ["SERVICE", "INVENTORY", "NON-INVENTORY", "LABOUR", "INCENTIVE"]
+        enumValues: ["SERVICE", "INVENTORY", "NON-INVENTORY", "INCENTIVE", "KIT", "BUNDLE"]
       },
       {
         name: "name",
@@ -8516,11 +8120,39 @@ var operations = [
   {
     operationId: "PublicApiItemCategoryController_list",
     displayName: "List item categories",
-    description: "Retrieve active item categories and sub-categories.",
+    description: "Retrieve active item categories and sub-categories. Use search, name, or id to filter by category/sub-category name or id.",
     method: "GET",
     path: "/settings/item-categories",
     commandPath: ["settings", "items", "item-categories", "list"],
-    options: [],
+    options: [
+      {
+        name: "id",
+        cliName: "id",
+        optionKey: "id",
+        source: "query",
+        type: "string",
+        required: false,
+        description: "Alias for search"
+      },
+      {
+        name: "name",
+        cliName: "name",
+        optionKey: "name",
+        source: "query",
+        type: "string",
+        required: false,
+        description: "Alias for search"
+      },
+      {
+        name: "search",
+        cliName: "search",
+        optionKey: "search",
+        source: "query",
+        type: "string",
+        required: false,
+        description: "Filter by category/sub-category name or id"
+      }
+    ],
     hasRequestBody: false,
     responseFields: [
       {
@@ -8838,7 +8470,7 @@ var operations = [
         source: "path",
         type: "string",
         required: true,
-        description: "Job ID or job number (e.g. J12345)"
+        description: "Job ID"
       },
       {
         name: "id",
@@ -9175,7 +8807,7 @@ var operations = [
         optionKey: "callDate",
         source: "body",
         type: "string",
-        required: false,
+        required: true,
         description: "call date (ISO 8601 datetime)",
         format: "date-time"
       },
@@ -9431,7 +9063,7 @@ var operations = [
         source: "path",
         type: "string",
         required: true,
-        description: ""
+        description: "Job ID"
       }
     ],
     hasRequestBody: false
@@ -9795,7 +9427,7 @@ var operations = [
         optionKey: "callDate",
         source: "body",
         type: "string",
-        required: false,
+        required: true,
         description: "call date (ISO 8601 datetime)",
         format: "date-time"
       },
@@ -11386,6 +11018,15 @@ var operations = [
         required: true,
         description: "Inline contact object — alternative to contactId"
       },
+      {
+        name: "notes",
+        cliName: "notes",
+        optionKey: "notes",
+        source: "body",
+        type: "string",
+        required: false,
+        description: "Additional notes or comments"
+      },
       {
         name: "customFields",
         cliName: "custom-fields",
@@ -11567,13 +11208,13 @@ var operations = [
         description: ""
       },
       {
-        name: "description",
-        cliName: "description",
-        optionKey: "description",
+        name: "notes",
+        cliName: "notes",
+        optionKey: "notes",
         source: "body",
         type: "string",
         required: false,
-        description: "Detailed description"
+        description: "Additional notes or comments"
       },
       {
         name: "customFields",
@@ -11956,6 +11597,15 @@ var operations = [
         required: true,
         description: "Inline contact object — alternative to contactId"
       },
+      {
+        name: "notes",
+        cliName: "notes",
+        optionKey: "notes",
+        source: "body",
+        type: "string",
+        required: false,
+        description: "Additional notes or comments"
+      },
       {
         name: "customFields",
         cliName: "custom-fields",
@@ -11965,6 +11615,15 @@ var operations = [
         required: false,
         description: "Custom fields as key-value pairs — validated against tenant field definitions"
       },
+      {
+        name: "socialNetwork",
+        cliName: "social-network",
+        optionKey: "socialNetwork",
+        source: "body",
+        type: "object",
+        required: false,
+        description: ""
+      },
       {
         name: "hidePrices",
         cliName: "hide-prices",
@@ -12127,13 +11786,13 @@ var operations = [
         description: ""
       },
       {
-        name: "description",
-        cliName: "description",
-        optionKey: "description",
+        name: "notes",
+        cliName: "notes",
+        optionKey: "notes",
         source: "body",
         type: "string",
         required: false,
-        description: "Detailed description"
+        description: "Additional notes or comments"
       },
       {
         name: "customFields",
@@ -12144,6 +11803,15 @@ var operations = [
         required: false,
         description: "Custom fields as key-value pairs — validated against tenant field definitions"
       },
+      {
+        name: "socialNetwork",
+        cliName: "social-network",
+        optionKey: "socialNetwork",
+        source: "body",
+        type: "object",
+        required: false,
+        description: ""
+      },
       {
         name: "zones",
         cliName: "zones",
@@ -12416,6 +12084,15 @@ var operations = [
         required: true,
         description: "Inline contact object — alternative to contactId"
       },
+      {
+        name: "notes",
+        cliName: "notes",
+        optionKey: "notes",
+        source: "body",
+        type: "string",
+        required: false,
+        description: "Additional notes or comments"
+      },
       {
         name: "customFields",
         cliName: "custom-fields",
@@ -12425,6 +12102,15 @@ var operations = [
         required: false,
         description: "Custom fields as key-value pairs — validated against tenant field definitions"
       },
+      {
+        name: "socialNetwork",
+        cliName: "social-network",
+        optionKey: "socialNetwork",
+        source: "body",
+        type: "object",
+        required: false,
+        description: ""
+      },
       {
         name: "taxId",
         cliName: "tax-id",
@@ -12587,13 +12273,13 @@ var operations = [
         description: ""
       },
       {
-        name: "description",
-        cliName: "description",
-        optionKey: "description",
+        name: "notes",
+        cliName: "notes",
+        optionKey: "notes",
         source: "body",
         type: "string",
         required: false,
-        description: "Detailed description"
+        description: "Additional notes or comments"
       },
       {
         name: "customFields",
@@ -12604,6 +12290,15 @@ var operations = [
         required: false,
         description: "Custom fields as key-value pairs — validated against tenant field definitions"
       },
+      {
+        name: "socialNetwork",
+        cliName: "social-network",
+        optionKey: "socialNetwork",
+        source: "body",
+        type: "object",
+        required: false,
+        description: ""
+      },
       {
         name: "zones",
         cliName: "zones",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workbuddy/cli-vnext",
-  "version": "1.0.38",
+  "version": "1.0.40",
   "description": "WorkBuddy command line interface",
   "license": "MIT",
   "type": "module",