@workbuddy/sdk-js-vnext 1.0.86 → 1.0.88

package/index.d.ts

@@ -1703,6 +1703,41 @@ export interface WorkBuddySettingsStageStatusesListParams extends WorkBuddyReque
 
 export interface WorkBuddySettingsTagsListParams extends WorkBuddyRequestParams {}
 
+export interface WorkBuddySettingsTagsUpsertParams extends WorkBuddyRequestParams {
+  type: 'service-type' | 'service-scope' | 'work-categories';
+  /**
+   * Display name
+   */
+  name: string;
+
+  color?:
+    | '#1abc9c'
+    | '#16a085'
+    | '#f1c40f'
+    | '#f39c12'
+    | '#2ecc71'
+    | '#27ae60'
+    | '#e67e22'
+    | '#d35400'
+    | '#3498db'
+    | '#2980b9'
+    | '#e74c3c'
+    | '#c0392b'
+    | '#9b59b6'
+    | '#8e44ad'
+    | '#bdc3c7'
+    | '#34495e'
+    | '#2c3e50'
+    | '#95a5a6'
+    | '#7f8c8d'
+    | '#ec87bf'
+    | '#d870ad'
+    | '#f69785'
+    | '#9ba37e'
+    | '#b49255'
+    | '#a94136';
+}
+
 export interface WorkBuddySettingsZonesListParams extends WorkBuddyRequestParams {}
 
 export interface WorkBuddySettingsWorkTypesListParams extends WorkBuddyRequestParams {}
@@ -4097,6 +4132,8 @@ export interface WorkBuddyServicePlansLinesTasksPatchParams extends WorkBuddyReq
 
   startsOn?: string;
 
+  lastServiced?: string;
+
   schedule?: string;
 
   exceptions?: {
@@ -5622,7 +5659,37 @@ export type WorkBuddySettingsStageStatusesListResponse = {
     displayOptions: { showInContractorPortal: boolean; showInFieldApp: boolean };
   }[];
 };
-export type WorkBuddySettingsTagsListResponse = { items: { id: string; name: string; color?: string }[] };
+export type WorkBuddySettingsTagsListResponse = {
+  items: { id: string; name: string; color?: string; type?: string }[];
+  colors: (
+    | '#1abc9c'
+    | '#16a085'
+    | '#f1c40f'
+    | '#f39c12'
+    | '#2ecc71'
+    | '#27ae60'
+    | '#e67e22'
+    | '#d35400'
+    | '#3498db'
+    | '#2980b9'
+    | '#e74c3c'
+    | '#c0392b'
+    | '#9b59b6'
+    | '#8e44ad'
+    | '#bdc3c7'
+    | '#34495e'
+    | '#2c3e50'
+    | '#95a5a6'
+    | '#7f8c8d'
+    | '#ec87bf'
+    | '#d870ad'
+    | '#f69785'
+    | '#9ba37e'
+    | '#b49255'
+    | '#a94136'
+  )[];
+};
+export type WorkBuddySettingsTagsUpsertResponse = { item: { id: string; name: string; color?: string; type?: string } };
 export type WorkBuddySettingsZonesListResponse = { items: { id: string; name: string }[] };
 export type WorkBuddySettingsWorkTypesListResponse = { items: { id: string; name: string }[] };
 export type WorkBuddySettingsTemplatesEmailListEmailTemplatesResponse = {
@@ -7103,6 +7170,7 @@ export type WorkBuddyServicePlansLinesTasksListResponse = {
     name: string;
     description: string;
     startsOn: string;
+    lastServiced: string;
     schedule: string;
     exceptions: string;
     mandatory: boolean;
@@ -7134,6 +7202,7 @@ export type WorkBuddyServicePlansLinesTasksCreateResponse = {
       name: string;
       description: string;
       startsOn: string;
+      lastServiced: string;
       schedule: string;
       exceptions: string;
       mandatory: boolean;
@@ -7165,6 +7234,7 @@ export type WorkBuddyServicePlansLinesTasksGetResponse = {
     name: string;
     description: string;
     startsOn: string;
+    lastServiced: string;
     schedule: string;
     exceptions: string;
     mandatory: boolean;
@@ -7191,6 +7261,7 @@ export type WorkBuddyServicePlansLinesTasksPatchResponse = {
     name: string;
     description: string;
     startsOn: string;
+    lastServiced: string;
     schedule: string;
     exceptions: string;
     mandatory: boolean;
@@ -8403,13 +8474,22 @@ Requires scope: settings:read
 
 export interface WorkBuddySettingsTagsResource {
   /**
-   * Retrieve all active tags (labels) configured. Use the optional `type` query parameter to filter by label type. Defaults to `job` if not specified. Supported types: job, scheduling, quote, customer, user, overheads, form, finance, system, work-order-system, account, contact, zone, work-categories, lead-source, lead, opportunity, opportunity-lost, project, project-type, payment-type, file, asset, item-location, task, phase, site, service-type, subscriptions, agreement, work, integration-types, flag-category.
+   * Retrieve all active tags (labels) configured. Use the optional `type` query parameter to filter by label type. Defaults to `job` if not specified. `colors` is the Settings label-picker palette used by PUT /settings/tags. Supported types: job, scheduling, quote, customer, user, overheads, form, finance, system, work-order-system, account, contact, zone, work-categories, lead-source, lead, opportunity, opportunity-lost, project, project-type, payment-type, file, asset, item-location, task, phase, site, service-type, service-scope, subscriptions, agreement, work, integration-types, flag-category.
    * Operation: PublicApiTagController_list
    */
   list<TResponse = WorkBuddySettingsTagsListResponse>(
     params?: WorkBuddySettingsTagsListParams,
     options?: WorkBuddyRequestOptions
   ): Promise<TResponse>;
+
+  /**
+   * Create a tag, or return the existing active tag with the same type and name (case-insensitive). Limited to service-type, service-scope, and work-categories. Optional color must be a Settings label-picker hex; omitted color is chosen from that palette. Does not change color on an existing tag. Requires settings:tags:write — not settings:write.
+   * Operation: PublicApiTagController_upsert
+   */
+  upsert<TResponse = WorkBuddySettingsTagsUpsertResponse>(
+    params: WorkBuddySettingsTagsUpsertParams,
+    options?: WorkBuddyRequestOptions
+  ): Promise<TResponse>;
 }
 
 export interface WorkBuddySettingsZonesResource {
@@ -9485,7 +9565,7 @@ export interface WorkBuddyServicePlansResource {
 
 export interface WorkBuddyServicePlansActivateResource {
   /**
-   * Validates and publishes a fully assembled Service Plan.
+   * Validates and starts a fully assembled Service Plan.
    * Operation: PublicServicePlanController_activate
    */
   activate<TResponse = WorkBuddyServicePlansActivateActivateResponse>(
@@ -9507,7 +9587,7 @@ export interface WorkBuddyServicePlansSuspendResource {
 
 export interface WorkBuddyServicePlansArchiveResource {
   /**
-   * Archives a suspended Service Plan and reconciles future scheduled work.
+   * Archives a paused Service Plan and reconciles future scheduled work.
    * Operation: PublicServicePlanController_archive
    */
   archive<TResponse = WorkBuddyServicePlansArchiveArchiveResponse>(

package/index.js

@@ -664,10 +664,15 @@ Requires scope: settings:read
       },
       tags: {
         /**
-         * Retrieve all active tags (labels) configured. Use the optional `type` query parameter to filter by label type. Defaults to `job` if not specified. Supported types: job, scheduling, quote, customer, user, overheads, form, finance, system, work-order-system, account, contact, zone, work-categories, lead-source, lead, opportunity, opportunity-lost, project, project-type, payment-type, file, asset, item-location, task, phase, site, service-type, subscriptions, agreement, work, integration-types, flag-category.
+         * Retrieve all active tags (labels) configured. Use the optional `type` query parameter to filter by label type. Defaults to `job` if not specified. `colors` is the Settings label-picker palette used by PUT /settings/tags. Supported types: job, scheduling, quote, customer, user, overheads, form, finance, system, work-order-system, account, contact, zone, work-categories, lead-source, lead, opportunity, opportunity-lost, project, project-type, payment-type, file, asset, item-location, task, phase, site, service-type, service-scope, subscriptions, agreement, work, integration-types, flag-category.
          * Operation: PublicApiTagController_list
          */
         list: (params = {}, options = {}) => this.request('PublicApiTagController_list', params, options),
+        /**
+         * Create a tag, or return the existing active tag with the same type and name (case-insensitive). Limited to service-type, service-scope, and work-categories. Optional color must be a Settings label-picker hex; omitted color is chosen from that palette. Does not change color on an existing tag. Requires settings:tags:write — not settings:write.
+         * Operation: PublicApiTagController_upsert
+         */
+        upsert: (params = {}, options = {}) => this.request('PublicApiTagController_upsert', params, options),
       },
       zones: {
         /**
@@ -1288,7 +1293,7 @@ Requires scope: settings:read
     this.servicePlans = {
       activate: {
         /**
-         * Validates and publishes a fully assembled Service Plan.
+         * Validates and starts a fully assembled Service Plan.
          * Operation: PublicServicePlanController_activate
          */
         activate: (params = {}, options = {}) => this.request('PublicServicePlanController_activate', params, options),
@@ -1302,7 +1307,7 @@ Requires scope: settings:read
       },
       archive: {
         /**
-         * Archives a suspended Service Plan and reconciles future scheduled work.
+         * Archives a paused Service Plan and reconciles future scheduled work.
          * Operation: PublicServicePlanController_archive
          */
         archive: (params = {}, options = {}) => this.request('PublicServicePlanController_archive', params, options),
@@ -2232,13 +2237,26 @@ export const operations = [
     actionName: 'list',
     displayName: 'List tags',
     description:
-      'Retrieve all active tags (labels) configured. Use the optional `type` query parameter to filter by label type. Defaults to `job` if not specified. Supported types: job, scheduling, quote, customer, user, overheads, form, finance, system, work-order-system, account, contact, zone, work-categories, lead-source, lead, opportunity, opportunity-lost, project, project-type, payment-type, file, asset, item-location, task, phase, site, service-type, subscriptions, agreement, work, integration-types, flag-category.',
+      'Retrieve all active tags (labels) configured. Use the optional `type` query parameter to filter by label type. Defaults to `job` if not specified. `colors` is the Settings label-picker palette used by PUT /settings/tags. Supported types: job, scheduling, quote, customer, user, overheads, form, finance, system, work-order-system, account, contact, zone, work-categories, lead-source, lead, opportunity, opportunity-lost, project, project-type, payment-type, file, asset, item-location, task, phase, site, service-type, service-scope, subscriptions, agreement, work, integration-types, flag-category.',
     method: 'GET',
     path: '/settings/tags',
     pathParams: [],
     queryParams: [],
     hasRequestBody: false,
   },
+  {
+    operationId: 'PublicApiTagController_upsert',
+    resourcePath: ['settings', 'tags'],
+    actionName: 'upsert',
+    displayName: 'Upsert a tag',
+    description:
+      'Create a tag, or return the existing active tag with the same type and name (case-insensitive). Limited to service-type, service-scope, and work-categories. Optional color must be a Settings label-picker hex; omitted color is chosen from that palette. Does not change color on an existing tag. Requires settings:tags:write — not settings:write.',
+    method: 'PUT',
+    path: '/settings/tags',
+    pathParams: [],
+    queryParams: [],
+    hasRequestBody: true,
+  },
   {
     operationId: 'PublicApiZoneController_list',
     resourcePath: ['settings', 'zones'],
@@ -3774,8 +3792,8 @@ export const operations = [
     operationId: 'PublicServicePlanController_activate',
     resourcePath: ['servicePlans', 'activate'],
     actionName: 'activate',
-    displayName: 'Activate a Service Plan',
-    description: 'Validates and publishes a fully assembled Service Plan.',
+    displayName: 'Start a Service Plan',
+    description: 'Validates and starts a fully assembled Service Plan.',
     method: 'POST',
     path: '/service-plans/{identifier}/activate',
     pathParams: ['identifier'],
@@ -3786,7 +3804,7 @@ export const operations = [
     operationId: 'PublicServicePlanController_suspend',
     resourcePath: ['servicePlans', 'suspend'],
     actionName: 'suspend',
-    displayName: 'Suspend a Service Plan',
+    displayName: 'Pause a Service Plan',
     description: 'Stops future scheduled work while preserving history.',
     method: 'POST',
     path: '/service-plans/{identifier}/suspend',
@@ -3799,7 +3817,7 @@ export const operations = [
     resourcePath: ['servicePlans', 'archive'],
     actionName: 'archive',
     displayName: 'Archive a Service Plan',
-    description: 'Archives a suspended Service Plan and reconciles future scheduled work.',
+    description: 'Archives a paused Service Plan and reconciles future scheduled work.',
     method: 'POST',
     path: '/service-plans/{identifier}/archive',
     pathParams: ['identifier'],

package/package.json

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