@workbuddy/sdk-js-vnext 1.0.73 → 1.0.75

package/index.js

@@ -87,6 +87,59 @@ export class WorkBuddyClient {
           deleteStageItem: (params = {}, options = {}) =>
             this.request('PublicApiJobController_deleteStageItem', params, options),
         },
+        pendingItems: {
+          status: {
+            /**
+             * Set the dedicated pending-item status. No general item fields are accepted.
+             * Operation: PublicJobStagePendingItemController_updateStatus
+             */
+            updateStatus: (params = {}, options = {}) =>
+              this.request('PublicJobStagePendingItemController_updateStatus', params, options),
+          },
+          approve: {
+            /**
+             * Approve a pending item and promote it to a standard stage item.
+             * Operation: PublicJobStagePendingItemController_approve
+             */
+            approve: (params = {}, options = {}) =>
+              this.request('PublicJobStagePendingItemController_approve', params, options),
+          },
+          /**
+           * List items awaiting approval for a stage.
+           * Operation: PublicJobStagePendingItemController_list
+           */
+          list: (params = {}, options = {}) =>
+            this.request('PublicJobStagePendingItemController_list', params, options),
+          /** Iterate all items by following cursor pagination for list(). */
+          all: (params = {}, options = {}) =>
+            this.paginate('PublicJobStagePendingItemController_list', params, options),
+          /** Iterate raw pages by following cursor pagination for list(). */
+          pages: (params = {}, options = {}) =>
+            this.paginatePages('PublicJobStagePendingItemController_list', params, options),
+          /**
+           * Create one or more items awaiting approval.
+           * Operation: PublicJobStagePendingItemController_create
+           */
+          create: (params = {}, options = {}) =>
+            this.request('PublicJobStagePendingItemController_create', params, options),
+          /**
+           * Get a specific pending item within a stage.
+           * Operation: PublicJobStagePendingItemController_get
+           */
+          get: (params = {}, options = {}) => this.request('PublicJobStagePendingItemController_get', params, options),
+          /**
+           * Update general pending-item fields. Use the status route for itemStatus.
+           * Operation: PublicJobStagePendingItemController_update
+           */
+          update: (params = {}, options = {}) =>
+            this.request('PublicJobStagePendingItemController_update', params, options),
+          /**
+           * Delete or decline a pending item according to tenant deletion settings.
+           * Operation: PublicJobStagePendingItemController_delete
+           */
+          delete: (params = {}, options = {}) =>
+            this.request('PublicJobStagePendingItemController_delete', params, options),
+        },
         resources: {
           reissue: {
             /**
@@ -105,7 +158,7 @@ export class WorkBuddyClient {
               this.request('PublicJobStageResourceController_updateStatus', params, options),
           },
           /**
-           * Get all assigned resources for a stage.
+           * List people assigned to the stage via this API: employees (resource rows) and the stage contractor when set. Contractors assigned with POST .../resources appear here with isContractor=true (same shape as the assign response) (WBS-10448). Login contacts auto-created for contractor dispatch are excluded.
            * Operation: PublicJobStageResourceController_list
            */
           list: (params = {}, options = {}) => this.request('PublicJobStageResourceController_list', params, options),
@@ -115,13 +168,13 @@ export class WorkBuddyClient {
           pages: (params = {}, options = {}) =>
             this.paginatePages('PublicJobStageResourceController_list', params, options),
           /**
-           * Assign a technician or contractor.
+           * Assign an Employee or Subcontractor by contactId. Employee → resource row. Subcontractor → stage contractor (isContractor=true). Both appear on GET list (WBS-10448). contactId is a person Contact id (use /employees for staff), not a CRM Contact from /contacts (WBS-10445 / WBS-10442).
            * Operation: PublicJobStageResourceController_assign
            */
           assign: (params = {}, options = {}) =>
             this.request('PublicJobStageResourceController_assign', params, options),
           /**
-           * Get a specific resource assignment.
+           * Get one assignment by id. Employee rows use the resource/contact id; the stage contractor uses the contractor contact id (same id as POST assign when isContractor=true) (WBS-10448).
            * Operation: PublicJobStageResourceController_get
            */
           get: (params = {}, options = {}) => this.request('PublicJobStageResourceController_get', params, options),
@@ -459,14 +512,29 @@ export class WorkBuddyClient {
       list: (params = {}, options = {}) => this.request('PublicApiJobLineItemController_list', params, options),
     };
 
+    this.pendingItems = {
+      /**
+       * Find a pending stage item by its external integration ID.
+       * Operation: PublicApiPendingItemController_list
+       */
+      list: (params = {}, options = {}) => this.request('PublicApiPendingItemController_list', params, options),
+    };
+
     this.stages = {
       complete: {
         /**
-         * Mark a stage as completed. Field work is done but stage may still need finalisation/billing.
+         * Mark a stage as completed. Field work is done but stage may still need finalisation/billing. Optional statusId selects a tenant Completed status from GET /settings/stage-statuses (systemStatus Completed); omit to use the system Completed status (MAI-2101).
          * Operation: PublicJobStageController_complete
          */
         complete: (params = {}, options = {}) => this.request('PublicJobStageController_complete', params, options),
       },
+      inProgress: {
+        /**
+         * Set the stage to an In Progress status. Pass statusId from GET /settings/stage-statuses with systemStatus In Progress (multiple peer statuses may share that systemStatus) (MAI-2101).
+         * Operation: PublicJobStageController_inProgress
+         */
+        inProgress: (params = {}, options = {}) => this.request('PublicJobStageController_inProgress', params, options),
+      },
       finalise: {
         /**
          * Finalise a completed stage. This typically indicates billing/invoicing is complete.
@@ -527,7 +595,7 @@ export class WorkBuddyClient {
     this.settings = {
       entityStatuses: {
         /**
-         * Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user
+         * Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user, pending-item
          * Operation: PublicApiEntityStatusController_list
          */
         list: (params = {}, options = {}) => this.request('PublicApiEntityStatusController_list', params, options),
@@ -562,12 +630,12 @@ export class WorkBuddyClient {
       },
       pricebooks: {
         /**
-         * Discover tenant pricebooks for a category (customer / contractor / supplier). Use category=customer&status=current&assignableOnly=true for job-create candidates. Optional accountId scopes to a CRM account (includeGlobal defaults true).
+         * Discover tenant pricebooks for a category (customer / contractor / supplier). Use category=customer&status=current&assignableOnly=true for job-create candidates. Optional accountId scopes to a CRM account (includeGlobal defaults true). Each item includes company (owning company) and optional account — both match Settings UI fields.
          * Operation: PublicApiPriceBookController_list
          */
         list: (params = {}, options = {}) => this.request('PublicApiPriceBookController_list', params, options),
         /**
-         * Retrieve a pricebook by id (preferred) or exact name (case-insensitive). Pass category when the name may exist in more than one category.
+         * Retrieve a pricebook by id (preferred) or exact name (case-insensitive). Pass category when the name may exist in more than one category. Response includes company (owning company) and optional account, matching Settings UI.
          * Operation: PublicApiPriceBookController_getByIdOrName
          */
         getByIdOrName: (params = {}, options = {}) =>
@@ -575,9 +643,23 @@ export class WorkBuddyClient {
       },
       stageStatuses: {
         /**
-         * Retrieve all stage statuses configured for the tenant. Stage statuses represent the workflow states a stage (work order) can transition through (e.g., New, Dispatched, En Route, On Site, Completed, Finalised).
-         * Operation: PublicApiStageStatusController_list
-         */
+   * Retrieve all stage statuses configured for the tenant (Settings > Stage Status).
+Each item is a workflow state a stage (work order) can use (e.g. New, Dispatched, En Route, On Site, Completed, Finalised).
+
+Response fields include:
+- identity: id, name, systemName, systemStatus, sortOrder
+- description (nullable)
+- activityOptions: shareWithCustomer, shareWithField (always present; unset = false)
+- displayOptions: showInContractorPortal, showInFieldApp (always present)
+
+Display Options rules (match Settings UI):
+- Only systemStatus On Hold or In Progress support display options; other systemStatus values return both flags as false
+- showInFieldApp is not configurable for In Progress and is always false
+- When supported and not configured, visibility defaults to true (Settings UI default)
+
+Requires scope: settings:read
+   * Operation: PublicApiStageStatusController_list
+   */
         list: (params = {}, options = {}) => this.request('PublicApiStageStatusController_list', params, options),
       },
       tags: {
@@ -983,7 +1065,7 @@ export class WorkBuddyClient {
         pages: (params = {}, options = {}) =>
           this.paginatePages('PublicCrmExternalUserController_list', params, options),
         /**
-         * Get external user by ID
+         * Login Contact (portal user). parents lists active parent accounts only; portal role is parents[].role.
          * Operation: PublicCrmExternalUserController_getById
          */
         get: (params = {}, options = {}) => this.request('PublicCrmExternalUserController_getById', params, options),
@@ -1007,7 +1089,7 @@ export class WorkBuddyClient {
         /** Iterate raw pages by following cursor pagination for list(). */
         pages: (params = {}, options = {}) => this.paginatePages('PublicCrmContactController_list', params, options),
         /**
-         * Get contact by ID
+         * Returns a people contact (basic or Login Contact). parents lists active parent accounts only (inactive/soft-deleted omitted); portal role for Login Contacts is parents[].role.
          * Operation: PublicCrmContactController_getById
          */
         get: (params = {}, options = {}) => this.request('PublicCrmContactController_getById', params, options),
@@ -1034,8 +1116,20 @@ export class WorkBuddyClient {
         get: (params = {}, options = {}) => this.request('PublicCrmInviteController_getById', params, options),
       },
       sites: {
+        contacts: {
+          /**
+           * List contacts linked to this site (same pattern as GET /customers/{id}/contacts). Returns basic contacts and external users parented to the site.
+           * Operation: PublicCrmSiteController_listContacts
+           */
+          list: (params = {}, options = {}) => this.request('PublicCrmSiteController_listContacts', params, options),
+          /** Iterate all items by following cursor pagination for list(). */
+          all: (params = {}, options = {}) => this.paginate('PublicCrmSiteController_listContacts', params, options),
+          /** Iterate raw pages by following cursor pagination for list(). */
+          pages: (params = {}, options = {}) =>
+            this.paginatePages('PublicCrmSiteController_listContacts', params, options),
+        },
         /**
-         * List all sites
+         * List CRM sites for the tenant (Managed and Account only — Adhoc sites are excluded). Each item includes type (Managed | Account), optional primaryContact, and address. Optional search filters by site name/address tokens (space-separated words; all must match).
          * Operation: PublicCrmSiteController_list
          */
         list: (params = {}, options = {}) => this.request('PublicCrmSiteController_list', params, options),
@@ -1044,7 +1138,7 @@ export class WorkBuddyClient {
         /** Iterate raw pages by following cursor pagination for list(). */
         pages: (params = {}, options = {}) => this.paginatePages('PublicCrmSiteController_list', params, options),
         /**
-         * Get site by ID
+         * Retrieve a CRM site by id (Managed or Account only). Adhoc sites are not exposed. Includes primaryContact when set (UI Primary Contact). type is CRM Site Type — not address.type.
          * Operation: PublicCrmSiteController_getById
          */
         get: (params = {}, options = {}) => this.request('PublicCrmSiteController_getById', params, options),
@@ -1597,6 +1691,104 @@ export const operations = [
     queryParams: ['integrationId'],
     hasRequestBody: false,
   },
+  {
+    operationId: 'PublicApiPendingItemController_list',
+    resourcePath: ['pendingItems'],
+    actionName: 'list',
+    displayName: 'Find a pending item',
+    description: 'Find a pending stage item by its external integration ID.',
+    method: 'GET',
+    path: '/pending-items',
+    pathParams: [],
+    queryParams: ['integrationId'],
+    hasRequestBody: false,
+  },
+  {
+    operationId: 'PublicJobStagePendingItemController_list',
+    resourcePath: ['jobs', 'stages', 'pendingItems'],
+    actionName: 'list',
+    paginatedItemsActionName: 'all',
+    paginatedPagesActionName: 'pages',
+    displayName: 'List stage pending items',
+    description: 'List items awaiting approval for a stage.',
+    method: 'GET',
+    path: '/jobs/{id}/stages/{stageId}/pending-items',
+    pathParams: ['id', 'stageId'],
+    queryParams: ['cursor', 'limit'],
+    hasRequestBody: false,
+  },
+  {
+    operationId: 'PublicJobStagePendingItemController_create',
+    resourcePath: ['jobs', 'stages', 'pendingItems'],
+    actionName: 'create',
+    displayName: 'Create stage pending items',
+    description: 'Create one or more items awaiting approval.',
+    method: 'POST',
+    path: '/jobs/{id}/stages/{stageId}/pending-items',
+    pathParams: ['id', 'stageId'],
+    queryParams: [],
+    hasRequestBody: true,
+  },
+  {
+    operationId: 'PublicJobStagePendingItemController_get',
+    resourcePath: ['jobs', 'stages', 'pendingItems'],
+    actionName: 'get',
+    displayName: 'Get stage pending item',
+    description: 'Get a specific pending item within a stage.',
+    method: 'GET',
+    path: '/jobs/{id}/stages/{stageId}/pending-items/{itemId}',
+    pathParams: ['id', 'stageId', 'itemId'],
+    queryParams: [],
+    hasRequestBody: false,
+  },
+  {
+    operationId: 'PublicJobStagePendingItemController_update',
+    resourcePath: ['jobs', 'stages', 'pendingItems'],
+    actionName: 'update',
+    displayName: 'Update stage pending item',
+    description: 'Update general pending-item fields. Use the status route for itemStatus.',
+    method: 'PATCH',
+    path: '/jobs/{id}/stages/{stageId}/pending-items/{itemId}',
+    pathParams: ['id', 'stageId', 'itemId'],
+    queryParams: [],
+    hasRequestBody: true,
+  },
+  {
+    operationId: 'PublicJobStagePendingItemController_delete',
+    resourcePath: ['jobs', 'stages', 'pendingItems'],
+    actionName: 'delete',
+    displayName: 'Delete stage pending item',
+    description: 'Delete or decline a pending item according to tenant deletion settings.',
+    method: 'DELETE',
+    path: '/jobs/{id}/stages/{stageId}/pending-items/{itemId}',
+    pathParams: ['id', 'stageId', 'itemId'],
+    queryParams: [],
+    hasRequestBody: false,
+  },
+  {
+    operationId: 'PublicJobStagePendingItemController_updateStatus',
+    resourcePath: ['jobs', 'stages', 'pendingItems', 'status'],
+    actionName: 'updateStatus',
+    displayName: 'Update pending-item status',
+    description: 'Set the dedicated pending-item status. No general item fields are accepted.',
+    method: 'PATCH',
+    path: '/jobs/{id}/stages/{stageId}/pending-items/{itemId}/status',
+    pathParams: ['id', 'stageId', 'itemId'],
+    queryParams: [],
+    hasRequestBody: true,
+  },
+  {
+    operationId: 'PublicJobStagePendingItemController_approve',
+    resourcePath: ['jobs', 'stages', 'pendingItems', 'approve'],
+    actionName: 'approve',
+    displayName: 'Approve stage pending item',
+    description: 'Approve a pending item and promote it to a standard stage item.',
+    method: 'POST',
+    path: '/jobs/{id}/stages/{stageId}/pending-items/{itemId}/approve',
+    pathParams: ['id', 'stageId', 'itemId'],
+    queryParams: [],
+    hasRequestBody: false,
+  },
   {
     operationId: 'PublicJobStageController_create',
     resourcePath: ['stages'],
@@ -1651,13 +1843,27 @@ export const operations = [
     resourcePath: ['stages', 'complete'],
     actionName: 'complete',
     displayName: 'Complete a stage',
-    description: 'Mark a stage as completed. Field work is done but stage may still need finalisation/billing.',
+    description:
+      'Mark a stage as completed. Field work is done but stage may still need finalisation/billing. Optional statusId selects a tenant Completed status from GET /settings/stage-statuses (systemStatus Completed); omit to use the system Completed status (MAI-2101).',
     method: 'POST',
     path: '/stages/{id}/complete',
     pathParams: ['id'],
     queryParams: [],
     hasRequestBody: true,
   },
+  {
+    operationId: 'PublicJobStageController_inProgress',
+    resourcePath: ['stages', 'inProgress'],
+    actionName: 'inProgress',
+    displayName: 'Mark a stage in progress',
+    description:
+      'Set the stage to an In Progress status. Pass statusId from GET /settings/stage-statuses with systemStatus In Progress (multiple peer statuses may share that systemStatus) (MAI-2101).',
+    method: 'POST',
+    path: '/stages/{id}/in-progress',
+    pathParams: ['id'],
+    queryParams: [],
+    hasRequestBody: true,
+  },
   {
     operationId: 'PublicJobStageController_finalise',
     resourcePath: ['stages', 'finalise'],
@@ -1727,7 +1933,8 @@ export const operations = [
     paginatedItemsActionName: 'all',
     paginatedPagesActionName: 'pages',
     displayName: 'List stage resources',
-    description: 'Get all assigned resources for a stage.',
+    description:
+      'List people assigned to the stage via this API: employees (resource rows) and the stage contractor when set. Contractors assigned with POST .../resources appear here with isContractor=true (same shape as the assign response) (WBS-10448). Login contacts auto-created for contractor dispatch are excluded.',
     method: 'GET',
     path: '/jobs/{jobId}/stages/{stageId}/resources',
     pathParams: ['jobId', 'stageId'],
@@ -1739,7 +1946,8 @@ export const operations = [
     resourcePath: ['jobs', 'stages', 'resources'],
     actionName: 'assign',
     displayName: 'Assign resource to stage',
-    description: 'Assign a technician or contractor.',
+    description:
+      'Assign an Employee or Subcontractor by contactId. Employee → resource row. Subcontractor → stage contractor (isContractor=true). Both appear on GET list (WBS-10448). contactId is a person Contact id (use /employees for staff), not a CRM Contact from /contacts (WBS-10445 / WBS-10442).',
     method: 'POST',
     path: '/jobs/{jobId}/stages/{stageId}/resources',
     pathParams: ['jobId', 'stageId'],
@@ -1751,7 +1959,8 @@ export const operations = [
     resourcePath: ['jobs', 'stages', 'resources'],
     actionName: 'get',
     displayName: 'Get stage resource',
-    description: 'Get a specific resource assignment.',
+    description:
+      'Get one assignment by id. Employee rows use the resource/contact id; the stage contractor uses the contractor contact id (same id as POST assign when isContractor=true) (WBS-10448).',
     method: 'GET',
     path: '/jobs/{jobId}/stages/{stageId}/resources/{resourceId}',
     pathParams: ['jobId', 'stageId', 'resourceId'],
@@ -1800,7 +2009,7 @@ export const operations = [
     actionName: 'list',
     displayName: 'List entity statuses',
     description:
-      'Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user',
+      'Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user, pending-item',
     method: 'GET',
     path: '/settings/entity-statuses/{entity}',
     pathParams: ['entity'],
@@ -1865,7 +2074,7 @@ export const operations = [
     actionName: 'list',
     displayName: 'List pricebooks',
     description:
-      'Discover tenant pricebooks for a category (customer / contractor / supplier). Use category=customer&status=current&assignableOnly=true for job-create candidates. Optional accountId scopes to a CRM account (includeGlobal defaults true).',
+      'Discover tenant pricebooks for a category (customer / contractor / supplier). Use category=customer&status=current&assignableOnly=true for job-create candidates. Optional accountId scopes to a CRM account (includeGlobal defaults true). Each item includes company (owning company) and optional account — both match Settings UI fields.',
     method: 'GET',
     path: '/settings/pricebooks',
     pathParams: [],
@@ -1878,7 +2087,7 @@ export const operations = [
     actionName: 'getByIdOrName',
     displayName: 'Get pricebook',
     description:
-      'Retrieve a pricebook by id (preferred) or exact name (case-insensitive). Pass category when the name may exist in more than one category.',
+      'Retrieve a pricebook by id (preferred) or exact name (case-insensitive). Pass category when the name may exist in more than one category. Response includes company (owning company) and optional account, matching Settings UI.',
     method: 'GET',
     path: '/settings/pricebooks/{idOrName}',
     pathParams: ['idOrName'],
@@ -1891,7 +2100,7 @@ export const operations = [
     actionName: 'list',
     displayName: 'List stage statuses',
     description:
-      'Retrieve all stage statuses configured for the tenant. Stage statuses represent the workflow states a stage (work order) can transition through (e.g., New, Dispatched, En Route, On Site, Completed, Finalised).',
+      'Retrieve all stage statuses configured for the tenant (Settings > Stage Status).\nEach item is a workflow state a stage (work order) can use (e.g. New, Dispatched, En Route, On Site, Completed, Finalised).\n\nResponse fields include:\n- identity: id, name, systemName, systemStatus, sortOrder\n- description (nullable)\n- activityOptions: shareWithCustomer, shareWithField (always present; unset = false)\n- displayOptions: showInContractorPortal, showInFieldApp (always present)\n\nDisplay Options rules (match Settings UI):\n- Only systemStatus On Hold or In Progress support display options; other systemStatus values return both flags as false\n- showInFieldApp is not configurable for In Progress and is always false\n- When supported and not configured, visibility defaults to true (Settings UI default)\n\nRequires scope: settings:read',
     method: 'GET',
     path: '/settings/stage-statuses',
     pathParams: [],
@@ -3046,7 +3255,8 @@ export const operations = [
     resourcePath: ['crm', 'externalUsers'],
     actionName: 'get',
     displayName: 'Get external user by ID',
-    description: 'Get external user by ID',
+    description:
+      'Login Contact (portal user). parents lists active parent accounts only; portal role is parents[].role.',
     method: 'GET',
     path: '/external-users/{id}',
     pathParams: ['id'],
@@ -3072,7 +3282,8 @@ export const operations = [
     resourcePath: ['crm', 'contacts'],
     actionName: 'get',
     displayName: 'Get contact by ID',
-    description: 'Get contact by ID',
+    description:
+      'Returns a people contact (basic or Login Contact). parents lists active parent accounts only (inactive/soft-deleted omitted); portal role for Login Contacts is parents[].role.',
     method: 'GET',
     path: '/contacts/{id}',
     pathParams: ['id'],
@@ -3136,11 +3347,12 @@ export const operations = [
     paginatedItemsActionName: 'all',
     paginatedPagesActionName: 'pages',
     displayName: 'List all sites',
-    description: 'List all sites',
+    description:
+      'List CRM sites for the tenant (Managed and Account only — Adhoc sites are excluded). Each item includes type (Managed | Account), optional primaryContact, and address. Optional search filters by site name/address tokens (space-separated words; all must match).',
     method: 'GET',
     path: '/sites',
     pathParams: [],
-    queryParams: ['status', 'cursor', 'limit'],
+    queryParams: ['search', 'status', 'cursor', 'limit'],
     hasRequestBody: false,
   },
   {
@@ -3148,13 +3360,29 @@ export const operations = [
     resourcePath: ['crm', 'sites'],
     actionName: 'get',
     displayName: 'Get site by ID',
-    description: 'Get site by ID',
+    description:
+      'Retrieve a CRM site by id (Managed or Account only). Adhoc sites are not exposed. Includes primaryContact when set (UI Primary Contact). type is CRM Site Type — not address.type.',
     method: 'GET',
     path: '/sites/{id}',
     pathParams: ['id'],
     queryParams: [],
     hasRequestBody: false,
   },
+  {
+    operationId: 'PublicCrmSiteController_listContacts',
+    resourcePath: ['crm', 'sites', 'contacts'],
+    actionName: 'list',
+    paginatedItemsActionName: 'all',
+    paginatedPagesActionName: 'pages',
+    displayName: 'List contacts for site',
+    description:
+      'List contacts linked to this site (same pattern as GET /customers/{id}/contacts). Returns basic contacts and external users parented to the site.',
+    method: 'GET',
+    path: '/sites/{id}/contacts',
+    pathParams: ['id'],
+    queryParams: ['cursor', 'limit'],
+    hasRequestBody: false,
+  },
   {
     operationId: 'PublicApiWebhookV2Controller_listEntities',
     resourcePath: ['webhooks', 'entities'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workbuddy/sdk-js-vnext",
-  "version": "1.0.73",
+  "version": "1.0.75",
   "description": "WorkBuddy Public API JavaScript client",
   "license": "MIT",
   "type": "module",