@workbuddy/sdk-js-vnext 1.0.70 → 1.0.71

package/index.d.ts

@@ -1335,6 +1335,19 @@ export interface WorkBuddyStagesCancelCancelParams extends WorkBuddyRequestParam
   note: string;
 }
 
+export interface WorkBuddyStagesOnHoldOnHoldParams extends WorkBuddyRequestParams {
+  /**
+   * Stage ID
+   */
+  id: string;
+  /**
+   * status ID
+   */
+  statusId: string;
+
+  note?: string;
+}
+
 export interface WorkBuddyStagesReverseReverseParams extends WorkBuddyRequestParams {
   /**
    * Stage ID
@@ -1476,6 +1489,37 @@ export interface WorkBuddySettingsJobTemplatesListParams extends WorkBuddyReques
 
 export interface WorkBuddySettingsPrioritiesListParams extends WorkBuddyRequestParams {}
 
+export interface WorkBuddySettingsPricebooksListParams extends WorkBuddyRequestParams {
+  limit?: number;
+
+  assignableOnly?: boolean;
+
+  mode?: 'static' | 'dynamic';
+  /**
+   * Name contains or exact id
+   */
+  search?: string;
+
+  includeGlobal?: boolean;
+  /**
+   * account ID
+   */
+  accountId?: string;
+
+  status?: 'current' | 'expired' | 'future' | 'all';
+
+  category: 'customer' | 'contractor' | 'supplier';
+}
+
+export interface WorkBuddySettingsPricebooksGetByIdOrNameParams extends WorkBuddyRequestParams {
+  /**
+   * Pricebook id or exact name
+   */
+  idOrName: string;
+
+  category?: 'customer' | 'contractor' | 'supplier';
+}
+
 export interface WorkBuddySettingsStageStatusesListParams extends WorkBuddyRequestParams {}
 
 export interface WorkBuddySettingsTagsListParams extends WorkBuddyRequestParams {}
@@ -4614,6 +4658,52 @@ export type WorkBuddyStagesCancelCancelResponse = {
   createdAt: string;
   updatedAt: string;
 };
+export type WorkBuddyStagesOnHoldOnHoldResponse = {
+  id: string;
+  stageNumber: string;
+  jobId: string;
+  job?: { id: string; jobNumber: string; description?: string };
+  name?: string;
+  status: { id?: string; name?: string; systemStatus: string };
+  sequence?: string;
+  owner?: string;
+  contractor?: string;
+  technician?: string;
+  resources?: string;
+  startDate?: string;
+  dueDate?: string;
+  completedDate?: string;
+  completedBy?: string;
+  completedNote?: string;
+  finalisedDate?: string;
+  tags?: string;
+  systemTags?: string;
+  schedulingTags?: string;
+  items?: {
+    id: string;
+    jobId: string;
+    stageId: string;
+    integrationId?: string;
+    code?: string;
+    description: string;
+    type?: string;
+    quantity: number;
+    unit?: string;
+    location?: string;
+    note?: string;
+    status?: string;
+    buyPrice?: number;
+    sellPrice?: number;
+    invoicingStatus?: string;
+    suppliedBySubcontractor: boolean;
+    createdAt: string;
+    updatedAt: string;
+  }[];
+  totals?: { sellTotal: number; buyTotal: number };
+  customFields?: string;
+  createdAt: string;
+  updatedAt: string;
+};
 export type WorkBuddyStagesReverseReverseResponse = {
   id: string;
   stageNumber: string;
@@ -4700,6 +4790,34 @@ export type WorkBuddySettingsJobTemplatesListResponse = { items: { id: string; n
 export type WorkBuddySettingsPrioritiesListResponse = {
   items: { id: string; name: string; sortOrder?: number; color?: string }[];
 };
+export type WorkBuddySettingsPricebooksListResponse = {
+  items: {
+    id: string;
+    name: string;
+    description?: string;
+    category: 'customer' | 'contractor' | 'supplier';
+    mode?: string;
+    status: 'current' | 'expired' | 'future';
+    parentOnly: boolean;
+    isGlobal: boolean;
+    account?: string;
+    dateStart?: string;
+    dateEnd?: string;
+  }[];
+};
+export type WorkBuddySettingsPricebooksGetByIdOrNameResponse = {
+  id: string;
+  name: string;
+  description?: string;
+  category: 'customer' | 'contractor' | 'supplier';
+  mode?: string;
+  status: 'current' | 'expired' | 'future';
+  parentOnly: boolean;
+  isGlobal: boolean;
+  account?: string;
+  dateStart?: string;
+  dateEnd?: string;
+};
 export type WorkBuddySettingsStageStatusesListResponse = {
   items: { id: string; name: string; systemName: string; systemStatus: string; sortOrder?: number }[];
 };
@@ -6662,6 +6780,8 @@ export interface WorkBuddyStagesResource {
   finalise: WorkBuddyStagesFinaliseResource;
   /** Cancel API operations. */
   cancel: WorkBuddyStagesCancelResource;
+  /** On Hold API operations. */
+  onHold: WorkBuddyStagesOnHoldResource;
   /** Reverse API operations. */
   reverse: WorkBuddyStagesReverseResource;
   /** Reissue API operations. */
@@ -6736,6 +6856,17 @@ export interface WorkBuddyStagesCancelResource {
   ): Promise<TResponse>;
 }
 
+export interface WorkBuddyStagesOnHoldResource {
+  /**
+   * Set the stage to an On Hold status. Pass statusId from GET /settings/stage-statuses with systemStatus On Hold (multiple peer statuses may share that systemStatus). Blocked from Completed, Closed, or Finalised.
+   * Operation: PublicJobStageController_onHold
+   */
+  onHold<TResponse = WorkBuddyStagesOnHoldOnHoldResponse>(
+    params: WorkBuddyStagesOnHoldOnHoldParams,
+    options?: WorkBuddyRequestOptions
+  ): Promise<TResponse>;
+}
+
 export interface WorkBuddyStagesReverseResource {
   /**
    * Reverse (reopen) a stage to a previous status. This is an admin action that bypasses normal transition rules and clears fields appropriate to the target status.
@@ -6769,6 +6900,8 @@ export interface WorkBuddySettingsResource {
   jobTemplates: WorkBuddySettingsJobTemplatesResource;
   /** Priorities API operations. */
   priorities: WorkBuddySettingsPrioritiesResource;
+  /** Pricebooks API operations. */
+  pricebooks: WorkBuddySettingsPricebooksResource;
   /** Stage Statuses API operations. */
   stageStatuses: WorkBuddySettingsStageStatusesResource;
   /** Tags API operations. */
@@ -6846,6 +6979,26 @@ export interface WorkBuddySettingsPrioritiesResource {
   ): Promise<TResponse>;
 }
 
+export interface WorkBuddySettingsPricebooksResource {
+  /**
+   * 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).
+   * Operation: PublicApiPriceBookController_list
+   */
+  list<TResponse = WorkBuddySettingsPricebooksListResponse>(
+    params: WorkBuddySettingsPricebooksListParams,
+    options?: WorkBuddyRequestOptions
+  ): Promise<TResponse>;
+
+  /**
+   * Retrieve a pricebook by id (preferred) or exact name (case-insensitive). Pass category when the name may exist in more than one category.
+   * Operation: PublicApiPriceBookController_getByIdOrName
+   */
+  getByIdOrName<TResponse = WorkBuddySettingsPricebooksGetByIdOrNameResponse>(
+    params: WorkBuddySettingsPricebooksGetByIdOrNameParams,
+    options?: WorkBuddyRequestOptions
+  ): Promise<TResponse>;
+}
+
 export interface WorkBuddySettingsStageStatusesResource {
   /**
    * 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).

package/index.js

@@ -481,6 +481,13 @@ export class WorkBuddyClient {
          */
         cancel: (params = {}, options = {}) => this.request('PublicJobStageController_cancel', params, options),
       },
+      onHold: {
+        /**
+         * Set the stage to an On Hold status. Pass statusId from GET /settings/stage-statuses with systemStatus On Hold (multiple peer statuses may share that systemStatus). Blocked from Completed, Closed, or Finalised.
+         * Operation: PublicJobStageController_onHold
+         */
+        onHold: (params = {}, options = {}) => this.request('PublicJobStageController_onHold', params, options),
+      },
       reverse: {
         /**
          * Reverse (reopen) a stage to a previous status. This is an admin action that bypasses normal transition rules and clears fields appropriate to the target status.
@@ -553,6 +560,19 @@ export class WorkBuddyClient {
          */
         list: (params = {}, options = {}) => this.request('PublicApiPriorityController_list', params, options),
       },
+      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).
+         * 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.
+         * Operation: PublicApiPriceBookController_getByIdOrName
+         */
+        getByIdOrName: (params = {}, options = {}) =>
+          this.request('PublicApiPriceBookController_getByIdOrName', params, options),
+      },
       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).
@@ -1662,6 +1682,19 @@ export const operations = [
     queryParams: [],
     hasRequestBody: true,
   },
+  {
+    operationId: 'PublicJobStageController_onHold',
+    resourcePath: ['stages', 'onHold'],
+    actionName: 'onHold',
+    displayName: 'Put a stage on hold',
+    description:
+      'Set the stage to an On Hold status. Pass statusId from GET /settings/stage-statuses with systemStatus On Hold (multiple peer statuses may share that systemStatus). Blocked from Completed, Closed, or Finalised.',
+    method: 'POST',
+    path: '/stages/{id}/on-hold',
+    pathParams: ['id'],
+    queryParams: [],
+    hasRequestBody: true,
+  },
   {
     operationId: 'PublicJobStageController_reverse',
     resourcePath: ['stages', 'reverse'],
@@ -1826,6 +1859,32 @@ export const operations = [
     queryParams: [],
     hasRequestBody: false,
   },
+  {
+    operationId: 'PublicApiPriceBookController_list',
+    resourcePath: ['settings', 'pricebooks'],
+    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).',
+    method: 'GET',
+    path: '/settings/pricebooks',
+    pathParams: [],
+    queryParams: ['limit', 'assignableOnly', 'mode', 'search', 'includeGlobal', 'accountId', 'status', 'category'],
+    hasRequestBody: false,
+  },
+  {
+    operationId: 'PublicApiPriceBookController_getByIdOrName',
+    resourcePath: ['settings', 'pricebooks'],
+    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.',
+    method: 'GET',
+    path: '/settings/pricebooks/{idOrName}',
+    pathParams: ['idOrName'],
+    queryParams: ['category'],
+    hasRequestBody: false,
+  },
   {
     operationId: 'PublicApiStageStatusController_list',
     resourcePath: ['settings', 'stageStatuses'],

package/package.json

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