@workbuddy/sdk-js-vnext 1.0.6 → 1.0.8

package/index.d.ts

@@ -738,6 +738,8 @@ export interface WorkBuddyJobsCreateParams extends WorkBuddyRequestParams {
    * integration ID
    */
   integrationId?: string;
+
+  jobNumber?: string;
   /**
    * Detailed description
    */
@@ -810,9 +812,119 @@ export interface WorkBuddyJobsCreateParams extends WorkBuddyRequestParams {
    */
   customerPO?: string;
   /**
-   * Template ID to pre-populate fields from a template
+   * Start date (ISO 8601 datetime)
    */
-  templateId?: string;
+  startDate?: string;
+  /**
+   * Due date (ISO 8601 datetime)
+   */
+  dueDate?: string;
+  /**
+   * Custom fields as key-value pairs — validated against tenant field definitions
+   */
+  customFields?: Record<string, unknown>;
+
+  items?: {
+    integrationId?: string;
+    code: string;
+    description?: string;
+    longDescription?: string;
+    quantity: number;
+    location?: string;
+    note?: string;
+    buyPrice?: number;
+    sellPrice?: number;
+    invoicingStatus?: 'Billable' | 'No Charge' | 'Not Billable';
+    suppliedBySubcontractor?: boolean;
+  }[];
+}
+
+export interface WorkBuddyJobsTemplateCreateFromTemplateParams extends WorkBuddyRequestParams {
+  /**
+   * Job template ID
+   */
+  templateId: string;
+  /**
+   * Display name
+   */
+  name?: string;
+  /**
+   * integration ID
+   */
+  integrationId?: string;
+
+  jobNumber?: string;
+  /**
+   * Detailed description
+   */
+  description?: string;
+  /**
+   * Customer ID — use /crm/customers to look up
+   */
+  customerId: string;
+  /**
+   * Site ID — use /crm/sites to look up
+   */
+  siteId?: string;
+  /**
+   * Inline site object — alternative to siteId
+   */
+  site?: {
+    name?: string;
+    address: { street?: string; city?: string; state?: string; postcode?: string; country?: string };
+  };
+  /**
+   * Contact ID — use /crm/contacts to look up
+   */
+  contactId?: string;
+  /**
+   * Inline contact object — alternative to contactId
+   */
+  contact?: { name: string; phone?: string; email?: string };
+  /**
+   * Job type ID — use /settings/job-types to look up
+   */
+  typeId?: string;
+  /**
+   * Priority ID — use /settings/priorities to look up
+   */
+  priorityId?: string;
+  /**
+   * Price book ID for job pricing
+   */
+  priceBookId?: string;
+  /**
+   * Owner (employee) ID — use /crm/employees to look up
+   */
+  ownerId?: string;
+  /**
+   * Field supervisor (employee) ID — use /crm/employees to look up
+   */
+  fieldSupervisorId?: string;
+  /**
+   * Zone ID — use /settings/zones to look up
+   */
+  zoneId?: string;
+  /**
+   * Array of tag IDs (comma-separated, e.g. "id1,id2") — use /settings/tags to look up
+   */
+  tagIds?: string[];
+  /**
+   * Additional notes or comments
+   */
+  notes?: string;
+  /**
+   * External reference number
+   */
+  reference?: string;
+  /**
+   * Customer work order reference
+   */
+  customerWO?: string;
+  /**
+   * Customer purchase order reference
+   */
+  customerPO?: string;
   /**
    * Start date (ISO 8601 datetime)
    */
@@ -3522,6 +3634,87 @@ export type WorkBuddyJobsCreateResponse = {
   createdAt: string;
   updatedAt: string;
 };
+export type WorkBuddyJobsTemplateCreateFromTemplateResponse = {
+  id: string;
+  integrationId?: string;
+  jobNumber: string;
+  name?: string;
+  description: string;
+  status: { id?: string; name?: string; systemStatus: string };
+  customer: { id: string; name: string };
+  site?: string;
+  contact?: string;
+  customerSupervisor?: string;
+  type?: string;
+  priority?: string;
+  owner?: string;
+  fieldSupervisor?: string;
+  zones?: { id: string; name: string }[];
+  tags?: { id: string; name: string; color?: string }[];
+  systemTags?: { id: string; name: string; color?: string }[];
+  notes?: string;
+  reference?: string;
+  customerWO?: string;
+  customerPO?: string;
+  priceBook?: string;
+  billingCompany?: string;
+  policy?: string;
+  thresholds?: string;
+  stages?: {
+    id: string;
+    stageNumber: string;
+    jobId: string;
+    job?: { id: string; jobNumber: string; description?: string };
+    name?: string;
+    description?: string;
+    status: { id?: string; name?: string; systemStatus: string };
+    sequence?: number;
+    owner?: string;
+    contractor?: string;
+    technician?: string;
+    resources?: string;
+    startDate?: string;
+    dueDate?: string;
+    completedDate?: string;
+    completedBy?: string;
+    completedNote?: string;
+    finalisedDate?: string;
+    notes?: 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;
+  }[];
+  totals?: { sellTotal: number; buyTotal: number };
+  customFields?: string;
+  dueDate?: string;
+  startDate?: string;
+  createdAt: string;
+  updatedAt: string;
+};
 export type WorkBuddyJobsStatusUpdateStatusResponse = {
   id: string;
   integrationId?: string;
@@ -5256,6 +5449,8 @@ export type WorkBuddyMcpCreateResponse = unknown;
 export type WorkBuddyMcpDeleteResponse = unknown;
 
 export interface WorkBuddyJobsResource {
+  /** Template API operations. */
+  template: WorkBuddyJobsTemplateResource;
   /** Status API operations. */
   status: WorkBuddyJobsStatusResource;
   /** Stages API operations. */
@@ -5332,6 +5527,17 @@ export interface WorkBuddyJobsResource {
   ): Promise<TResponse>;
 }
 
+export interface WorkBuddyJobsTemplateResource {
+  /**
+   * Create a job using a job template. Template-owned fields win over request values before final job validation.
+   * Operation: PublicApiJobController_createFromTemplate
+   */
+  createFromTemplate<TResponse = WorkBuddyJobsTemplateCreateFromTemplateResponse>(
+    params: WorkBuddyJobsTemplateCreateFromTemplateParams,
+    options?: WorkBuddyRequestOptions
+  ): Promise<TResponse>;
+}
+
 export interface WorkBuddyJobsStatusResource {
   /**
    * Change an existing job status and cascade the change to stages through the job domain command.
@@ -6248,7 +6454,7 @@ export interface WorkBuddySettingsItemsResource {
   ): Promise<TResponse>;
 
   /**
-   * Retrieve a settings item by ID.
+   * Retrieve a settings item by ID, name, or integration ID.
    * Operation: PublicApiItemController_getById
    */
   get<TResponse = WorkBuddySettingsItemsGetResponse>(

package/index.js

@@ -34,6 +34,14 @@ export class WorkBuddyClient {
     }
 
     this.jobs = {
+      template: {
+        /**
+         * Create a job using a job template. Template-owned fields win over request values before final job validation.
+         * Operation: PublicApiJobController_createFromTemplate
+         */
+        createFromTemplate: (params = {}, options = {}) =>
+          this.request('PublicApiJobController_createFromTemplate', params, options),
+      },
       status: {
         /**
          * Change an existing job status and cascade the change to stages through the job domain command.
@@ -601,7 +609,7 @@ export class WorkBuddyClient {
          */
         upsert: (params = {}, options = {}) => this.request('PublicApiItemController_upsert', params, options),
         /**
-         * Retrieve a settings item by ID.
+         * Retrieve a settings item by ID, name, or integration ID.
          * Operation: PublicApiItemController_getById
          */
         get: (params = {}, options = {}) => this.request('PublicApiItemController_getById', params, options),
@@ -1328,6 +1336,19 @@ export const operations = [
     queryParams: [],
     hasRequestBody: true,
   },
+  {
+    operationId: 'PublicApiJobController_createFromTemplate',
+    resourcePath: ['jobs', 'template'],
+    actionName: 'createFromTemplate',
+    displayName: 'Create a new job from template',
+    description:
+      'Create a job using a job template. Template-owned fields win over request values before final job validation.',
+    method: 'POST',
+    path: '/jobs/template/{templateId}',
+    pathParams: ['templateId'],
+    queryParams: [],
+    hasRequestBody: true,
+  },
   {
     operationId: 'PublicApiJobController_updateStatus',
     resourcePath: ['jobs', 'status'],
@@ -1817,7 +1838,7 @@ export const operations = [
     resourcePath: ['settings', 'items'],
     actionName: 'get',
     displayName: 'Get item',
-    description: 'Retrieve a settings item by ID.',
+    description: 'Retrieve a settings item by ID, name, or integration ID.',
     method: 'GET',
     path: '/settings/items/{id}',
     pathParams: ['id'],

package/package.json

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