@workbuddy/sdk-js-vnext 1.0.95 → 1.0.97

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +5667 -9
  2. package/index.js +12 -6
  3. package/package.json +1 -1
package/index.js CHANGED
@@ -452,6 +452,10 @@ export class WorkBuddyClient {
452
452
  * Operation: PublicJobContactsController_list
453
453
  */
454
454
  list: (params = {}, options = {}) => this.request('PublicJobContactsController_list', params, options),
455
+ /** Iterate all items by following cursor pagination for list(). */
456
+ all: (params = {}, options = {}) => this.paginate('PublicJobContactsController_list', params, options),
457
+ /** Iterate raw pages by following cursor pagination for list(). */
458
+ pages: (params = {}, options = {}) => this.paginatePages('PublicJobContactsController_list', params, options),
455
459
  /**
456
460
  * Create contact link
457
461
  * Operation: PublicJobContactsController_create
@@ -664,12 +668,12 @@ Requires scope: settings:read
664
668
  },
665
669
  tags: {
666
670
  /**
667
- * 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.
671
+ * 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 for non-service-type tags. `icons` is the Settings icon-picker names used by PUT /settings/tags for service-type. 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.
668
672
  * Operation: PublicApiTagController_list
669
673
  */
670
674
  list: (params = {}, options = {}) => this.request('PublicApiTagController_list', params, options),
671
675
  /**
672
- * 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.
676
+ * 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. service-type uses icon (Settings icon-picker name; omitted on create → tag) and rejects color. Other types use color (Settings palette hex; omitted on create → hashed from the name) and reject icon. A sent icon or color is written onto an existing match; omitted leaves the stored visual. Invalid palette hex or icon name → 400. Requires settings:tags:write — not settings:write.
673
677
  * Operation: PublicApiTagController_upsert
674
678
  */
675
679
  upsert: (params = {}, options = {}) => this.request('PublicApiTagController_upsert', params, options),
@@ -2237,7 +2241,7 @@ export const operations = [
2237
2241
  actionName: 'list',
2238
2242
  displayName: 'List tags',
2239
2243
  description:
2240
- '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.',
2244
+ '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 for non-service-type tags. `icons` is the Settings icon-picker names used by PUT /settings/tags for service-type. 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.',
2241
2245
  method: 'GET',
2242
2246
  path: '/settings/tags',
2243
2247
  pathParams: [],
@@ -2250,7 +2254,7 @@ export const operations = [
2250
2254
  actionName: 'upsert',
2251
2255
  displayName: 'Upsert a tag',
2252
2256
  description:
2253
- '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.',
2257
+ '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. service-type uses icon (Settings icon-picker name; omitted on create → tag) and rejects color. Other types use color (Settings palette hex; omitted on create → hashed from the name) and reject icon. A sent icon or color is written onto an existing match; omitted leaves the stored visual. Invalid palette hex or icon name → 400. Requires settings:tags:write — not settings:write.',
2254
2258
  method: 'PUT',
2255
2259
  path: '/settings/tags',
2256
2260
  pathParams: [],
@@ -2977,12 +2981,14 @@ export const operations = [
2977
2981
  operationId: 'PublicJobContactsController_list',
2978
2982
  resourcePath: ['jobs', 'contacts'],
2979
2983
  actionName: 'list',
2984
+ paginatedItemsActionName: 'all',
2985
+ paginatedPagesActionName: 'pages',
2980
2986
  displayName: 'List contact links',
2981
2987
  description: 'List contact links',
2982
2988
  method: 'GET',
2983
2989
  path: '/jobs/{jobId}/contacts',
2984
2990
  pathParams: ['jobId'],
2985
- queryParams: [],
2991
+ queryParams: ['contactType', 'type', 'cursor', 'limit'],
2986
2992
  hasRequestBody: false,
2987
2993
  },
2988
2994
  {
@@ -2995,7 +3001,7 @@ export const operations = [
2995
3001
  path: '/jobs/{jobId}/contacts',
2996
3002
  pathParams: ['jobId'],
2997
3003
  queryParams: [],
2998
- hasRequestBody: false,
3004
+ hasRequestBody: true,
2999
3005
  },
3000
3006
  {
3001
3007
  operationId: 'PublicJobContactsController_getById',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workbuddy/sdk-js-vnext",
3
- "version": "1.0.95",
3
+ "version": "1.0.97",
4
4
  "description": "WorkBuddy Public API JavaScript client",
5
5
  "license": "MIT",
6
6
  "type": "module",