servicem8 0.9.17 → 0.9.19

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 (120) hide show
  1. package/api.json +312 -318
  2. package/bin/mcp-server.js +8 -25
  3. package/bin/mcp-server.js.map +13 -13
  4. package/dist/commonjs/funcs/jobTemplatesCreateJobFromTemplate.d.ts +1 -1
  5. package/dist/commonjs/funcs/jobTemplatesCreateJobFromTemplate.js +1 -1
  6. package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.d.ts +0 -3
  7. package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.d.ts.map +1 -1
  8. package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.js +0 -3
  9. package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.js.map +1 -1
  10. package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.d.ts +0 -3
  11. package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.d.ts.map +1 -1
  12. package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.js +0 -3
  13. package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.js.map +1 -1
  14. package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.d.ts +0 -5
  15. package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.d.ts.map +1 -1
  16. package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.js +0 -5
  17. package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.js.map +1 -1
  18. package/dist/commonjs/lib/config.d.ts +3 -3
  19. package/dist/commonjs/lib/config.js +3 -3
  20. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  21. package/dist/commonjs/mcp-server/server.js +1 -1
  22. package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobFromTemplate.js +1 -1
  23. package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts.map +1 -1
  24. package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.js +0 -5
  25. package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.js.map +1 -1
  26. package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts.map +1 -1
  27. package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.js +0 -5
  28. package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.js.map +1 -1
  29. package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts.map +1 -1
  30. package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.js +1 -8
  31. package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.js.map +1 -1
  32. package/dist/commonjs/sdk/jobtemplates.d.ts +1 -12
  33. package/dist/commonjs/sdk/jobtemplates.d.ts.map +1 -1
  34. package/dist/commonjs/sdk/jobtemplates.js +1 -12
  35. package/dist/commonjs/sdk/jobtemplates.js.map +1 -1
  36. package/dist/esm/funcs/jobTemplatesCreateJobFromTemplate.d.ts +1 -1
  37. package/dist/esm/funcs/jobTemplatesCreateJobFromTemplate.js +1 -1
  38. package/dist/esm/funcs/jobTemplatesCreateJobTemplates.d.ts +0 -3
  39. package/dist/esm/funcs/jobTemplatesCreateJobTemplates.d.ts.map +1 -1
  40. package/dist/esm/funcs/jobTemplatesCreateJobTemplates.js +0 -3
  41. package/dist/esm/funcs/jobTemplatesCreateJobTemplates.js.map +1 -1
  42. package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.d.ts +0 -3
  43. package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.d.ts.map +1 -1
  44. package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.js +0 -3
  45. package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.js.map +1 -1
  46. package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.d.ts +0 -5
  47. package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.d.ts.map +1 -1
  48. package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.js +0 -5
  49. package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.js.map +1 -1
  50. package/dist/esm/lib/config.d.ts +3 -3
  51. package/dist/esm/lib/config.js +3 -3
  52. package/dist/esm/mcp-server/mcp-server.js +1 -1
  53. package/dist/esm/mcp-server/server.js +1 -1
  54. package/dist/esm/mcp-server/tools/jobTemplatesCreateJobFromTemplate.js +1 -1
  55. package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts.map +1 -1
  56. package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.js +0 -5
  57. package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.js.map +1 -1
  58. package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts.map +1 -1
  59. package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.js +0 -5
  60. package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.js.map +1 -1
  61. package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts.map +1 -1
  62. package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.js +1 -8
  63. package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.js.map +1 -1
  64. package/dist/esm/sdk/jobtemplates.d.ts +1 -12
  65. package/dist/esm/sdk/jobtemplates.d.ts.map +1 -1
  66. package/dist/esm/sdk/jobtemplates.js +1 -12
  67. package/dist/esm/sdk/jobtemplates.js.map +1 -1
  68. package/docs/sdks/allocationwindows/README.md +9 -4
  69. package/docs/sdks/assets/README.md +10 -6
  70. package/docs/sdks/assettypefields/README.md +13 -8
  71. package/docs/sdks/assettypes/README.md +9 -4
  72. package/docs/sdks/attachments/README.md +17 -12
  73. package/docs/sdks/badges/README.md +17 -12
  74. package/docs/sdks/bundles/README.md +9 -4
  75. package/docs/sdks/categories/README.md +9 -4
  76. package/docs/sdks/clients/README.md +13 -8
  77. package/docs/sdks/companycontacts/README.md +13 -8
  78. package/docs/sdks/emailtemplates/README.md +9 -4
  79. package/docs/sdks/feedback/README.md +13 -8
  80. package/docs/sdks/formfields/README.md +13 -8
  81. package/docs/sdks/formresponses/README.md +33 -28
  82. package/docs/sdks/forms/README.md +13 -8
  83. package/docs/sdks/inbox/README.md +8 -0
  84. package/docs/sdks/jobactivities/README.md +25 -20
  85. package/docs/sdks/joballocations/README.md +29 -24
  86. package/docs/sdks/jobchecklists/README.md +37 -32
  87. package/docs/sdks/jobcontacts/README.md +13 -8
  88. package/docs/sdks/jobmaterialbundles/README.md +17 -12
  89. package/docs/sdks/jobmaterials/README.md +25 -20
  90. package/docs/sdks/jobpayments/README.md +21 -16
  91. package/docs/sdks/jobqueues/README.md +9 -4
  92. package/docs/sdks/jobs/README.md +37 -32
  93. package/docs/sdks/jobtemplates/README.md +12 -21
  94. package/docs/sdks/knowledgearticles/README.md +9 -4
  95. package/docs/sdks/locations/README.md +9 -4
  96. package/docs/sdks/materials/README.md +13 -8
  97. package/docs/sdks/notes/README.md +17 -12
  98. package/docs/sdks/search/README.md +3 -0
  99. package/docs/sdks/securityroles/README.md +9 -4
  100. package/docs/sdks/smstemplates/README.md +9 -4
  101. package/docs/sdks/staffmembers/README.md +17 -12
  102. package/docs/sdks/staffmessages/README.md +21 -16
  103. package/docs/sdks/tasks/README.md +25 -20
  104. package/docs/sdks/taxrates/README.md +9 -4
  105. package/docs/sdks/vendors/README.md +5 -2
  106. package/examples/package-lock.json +1 -1
  107. package/jsr.json +1 -1
  108. package/package.json +1 -1
  109. package/src/funcs/jobTemplatesCreateJobFromTemplate.ts +1 -1
  110. package/src/funcs/jobTemplatesCreateJobTemplates.ts +0 -3
  111. package/src/funcs/jobTemplatesDeleteJobTemplates.ts +0 -3
  112. package/src/funcs/jobTemplatesUpdateJobTemplates.ts +0 -5
  113. package/src/lib/config.ts +3 -3
  114. package/src/mcp-server/mcp-server.ts +1 -1
  115. package/src/mcp-server/server.ts +1 -1
  116. package/src/mcp-server/tools/jobTemplatesCreateJobFromTemplate.ts +1 -1
  117. package/src/mcp-server/tools/jobTemplatesCreateJobTemplates.ts +0 -5
  118. package/src/mcp-server/tools/jobTemplatesDeleteJobTemplates.ts +0 -5
  119. package/src/mcp-server/tools/jobTemplatesUpdateJobTemplates.ts +1 -8
  120. package/src/sdk/jobtemplates.ts +1 -12
@@ -23,6 +23,7 @@ This endpoint supports result filtering. For more information on how to filter t
23
23
 
24
24
  ### Example Usage
25
25
 
26
+ <!-- UsageSnippet language="typescript" operationID="listFormResponses" method="get" path="/formresponse.json" -->
26
27
  ```typescript
27
28
  import { ServiceM8 } from "servicem8";
28
29
 
@@ -100,6 +101,7 @@ UUID is optional for record creation. If no UUID is supplied, a UUID will be aut
100
101
 
101
102
  ### Example Usage
102
103
 
104
+ <!-- UsageSnippet language="typescript" operationID="createFormResponses" method="post" path="/formresponse.json" -->
103
105
  ```typescript
104
106
  import { ServiceM8 } from "servicem8";
105
107
 
@@ -111,14 +113,14 @@ const serviceM8 = new ServiceM8({
111
113
 
112
114
  async function run() {
113
115
  const result = await serviceM8.formResponses.createFormResponses({
114
- uuid: "123e4567-a4f5-47df-b0cd-230c474d41cb",
115
- formUuid: "123e4567-9ab7-4cdd-8aac-230c40b4669b",
116
- staffUuid: "123e4567-9441-4af3-a7db-230c4cdf44db",
117
- regardingObjectUuid: "123e4567-cc84-456b-b412-230c43de148b",
116
+ uuid: "123e4567-a6a1-4594-bcf5-230fe759e42b",
117
+ formUuid: "123e4567-083b-4d6d-be57-230fe5dedb7b",
118
+ staffUuid: "123e4567-6dcf-465e-b21d-230fe95a108b",
119
+ regardingObjectUuid: "123e4567-e1f8-44f5-8e6b-230fe48e5f5b",
118
120
  timestamp: "2025-07-01 12:00:00",
119
- formByStaffUuid: "123e4567-08cb-4f6c-95a3-230c499270bb",
120
- documentAttachmentUuid: "123e4567-d76a-4eff-a36f-230c4cb4865b",
121
- assetUuid: "123e4567-acb4-4dc3-ad75-230c4c63287b",
121
+ formByStaffUuid: "123e4567-f321-48b3-a9b6-230fe516ed8b",
122
+ documentAttachmentUuid: "123e4567-12ce-4fd6-93c7-230fee727f6b",
123
+ assetUuid: "123e4567-5f1c-4fa5-8b58-230fe37d912b",
122
124
  });
123
125
 
124
126
  console.log(result);
@@ -145,14 +147,14 @@ const serviceM8 = new ServiceM8Core({
145
147
 
146
148
  async function run() {
147
149
  const res = await formResponsesCreateFormResponses(serviceM8, {
148
- uuid: "123e4567-a4f5-47df-b0cd-230c474d41cb",
149
- formUuid: "123e4567-9ab7-4cdd-8aac-230c40b4669b",
150
- staffUuid: "123e4567-9441-4af3-a7db-230c4cdf44db",
151
- regardingObjectUuid: "123e4567-cc84-456b-b412-230c43de148b",
150
+ uuid: "123e4567-a6a1-4594-bcf5-230fe759e42b",
151
+ formUuid: "123e4567-083b-4d6d-be57-230fe5dedb7b",
152
+ staffUuid: "123e4567-6dcf-465e-b21d-230fe95a108b",
153
+ regardingObjectUuid: "123e4567-e1f8-44f5-8e6b-230fe48e5f5b",
152
154
  timestamp: "2025-07-01 12:00:00",
153
- formByStaffUuid: "123e4567-08cb-4f6c-95a3-230c499270bb",
154
- documentAttachmentUuid: "123e4567-d76a-4eff-a36f-230c4cb4865b",
155
- assetUuid: "123e4567-acb4-4dc3-ad75-230c4c63287b",
155
+ formByStaffUuid: "123e4567-f321-48b3-a9b6-230fe516ed8b",
156
+ documentAttachmentUuid: "123e4567-12ce-4fd6-93c7-230fee727f6b",
157
+ assetUuid: "123e4567-5f1c-4fa5-8b58-230fe37d912b",
156
158
  });
157
159
  if (res.ok) {
158
160
  const { value: result } = res;
@@ -191,6 +193,7 @@ Retrieve a Form Response
191
193
 
192
194
  ### Example Usage
193
195
 
196
+ <!-- UsageSnippet language="typescript" operationID="getFormResponses" method="get" path="/formresponse/{uuid}.json" -->
194
197
  ```typescript
195
198
  import { ServiceM8 } from "servicem8";
196
199
 
@@ -268,6 +271,7 @@ Update a Form Response
268
271
 
269
272
  ### Example Usage
270
273
 
274
+ <!-- UsageSnippet language="typescript" operationID="updateFormResponses" method="post" path="/formresponse/{uuid}.json" -->
271
275
  ```typescript
272
276
  import { ServiceM8 } from "servicem8";
273
277
 
@@ -281,14 +285,14 @@ async function run() {
281
285
  const result = await serviceM8.formResponses.updateFormResponses({
282
286
  uuid: "5f593a3c-772d-4259-856d-86a8df7ae53d",
283
287
  formResponse: {
284
- uuid: "123e4567-a4f5-47df-b0cd-230c474d41cb",
285
- formUuid: "123e4567-9ab7-4cdd-8aac-230c40b4669b",
286
- staffUuid: "123e4567-9441-4af3-a7db-230c4cdf44db",
287
- regardingObjectUuid: "123e4567-cc84-456b-b412-230c43de148b",
288
+ uuid: "123e4567-a6a1-4594-bcf5-230fe759e42b",
289
+ formUuid: "123e4567-083b-4d6d-be57-230fe5dedb7b",
290
+ staffUuid: "123e4567-6dcf-465e-b21d-230fe95a108b",
291
+ regardingObjectUuid: "123e4567-e1f8-44f5-8e6b-230fe48e5f5b",
288
292
  timestamp: "2025-07-01 12:00:00",
289
- formByStaffUuid: "123e4567-08cb-4f6c-95a3-230c499270bb",
290
- documentAttachmentUuid: "123e4567-d76a-4eff-a36f-230c4cb4865b",
291
- assetUuid: "123e4567-acb4-4dc3-ad75-230c4c63287b",
293
+ formByStaffUuid: "123e4567-f321-48b3-a9b6-230fe516ed8b",
294
+ documentAttachmentUuid: "123e4567-12ce-4fd6-93c7-230fee727f6b",
295
+ assetUuid: "123e4567-5f1c-4fa5-8b58-230fe37d912b",
292
296
  },
293
297
  });
294
298
 
@@ -318,14 +322,14 @@ async function run() {
318
322
  const res = await formResponsesUpdateFormResponses(serviceM8, {
319
323
  uuid: "5f593a3c-772d-4259-856d-86a8df7ae53d",
320
324
  formResponse: {
321
- uuid: "123e4567-a4f5-47df-b0cd-230c474d41cb",
322
- formUuid: "123e4567-9ab7-4cdd-8aac-230c40b4669b",
323
- staffUuid: "123e4567-9441-4af3-a7db-230c4cdf44db",
324
- regardingObjectUuid: "123e4567-cc84-456b-b412-230c43de148b",
325
+ uuid: "123e4567-a6a1-4594-bcf5-230fe759e42b",
326
+ formUuid: "123e4567-083b-4d6d-be57-230fe5dedb7b",
327
+ staffUuid: "123e4567-6dcf-465e-b21d-230fe95a108b",
328
+ regardingObjectUuid: "123e4567-e1f8-44f5-8e6b-230fe48e5f5b",
325
329
  timestamp: "2025-07-01 12:00:00",
326
- formByStaffUuid: "123e4567-08cb-4f6c-95a3-230c499270bb",
327
- documentAttachmentUuid: "123e4567-d76a-4eff-a36f-230c4cb4865b",
328
- assetUuid: "123e4567-acb4-4dc3-ad75-230c4c63287b",
330
+ formByStaffUuid: "123e4567-f321-48b3-a9b6-230fe516ed8b",
331
+ documentAttachmentUuid: "123e4567-12ce-4fd6-93c7-230fee727f6b",
332
+ assetUuid: "123e4567-5f1c-4fa5-8b58-230fe37d912b",
329
333
  },
330
334
  });
331
335
  if (res.ok) {
@@ -369,6 +373,7 @@ In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records
369
373
 
370
374
  ### Example Usage
371
375
 
376
+ <!-- UsageSnippet language="typescript" operationID="deleteFormResponses" method="delete" path="/formresponse/{uuid}.json" -->
372
377
  ```typescript
373
378
  import { ServiceM8 } from "servicem8";
374
379
 
@@ -23,6 +23,7 @@ This endpoint supports result filtering. For more information on how to filter t
23
23
 
24
24
  ### Example Usage
25
25
 
26
+ <!-- UsageSnippet language="typescript" operationID="listForms" method="get" path="/form.json" -->
26
27
  ```typescript
27
28
  import { ServiceM8 } from "servicem8";
28
29
 
@@ -100,6 +101,7 @@ UUID is optional for record creation. If no UUID is supplied, a UUID will be aut
100
101
 
101
102
  ### Example Usage
102
103
 
104
+ <!-- UsageSnippet language="typescript" operationID="createForms" method="post" path="/form.json" -->
103
105
  ```typescript
104
106
  import { ServiceM8 } from "servicem8";
105
107
 
@@ -111,8 +113,8 @@ const serviceM8 = new ServiceM8({
111
113
 
112
114
  async function run() {
113
115
  const result = await serviceM8.forms.createForms({
114
- documentTemplateUuid: "123e4567-1a18-40a7-9bd1-230c463fd56b",
115
- uuid: "123e4567-800a-4f6b-993f-230c4adcf1eb",
116
+ documentTemplateUuid: "123e4567-d7a1-46c4-b7eb-230fef542abb",
117
+ uuid: "123e4567-6b21-4e60-8d67-230fee61e19b",
116
118
  });
117
119
 
118
120
  console.log(result);
@@ -139,8 +141,8 @@ const serviceM8 = new ServiceM8Core({
139
141
 
140
142
  async function run() {
141
143
  const res = await formsCreateForms(serviceM8, {
142
- documentTemplateUuid: "123e4567-1a18-40a7-9bd1-230c463fd56b",
143
- uuid: "123e4567-800a-4f6b-993f-230c4adcf1eb",
144
+ documentTemplateUuid: "123e4567-d7a1-46c4-b7eb-230fef542abb",
145
+ uuid: "123e4567-6b21-4e60-8d67-230fee61e19b",
144
146
  });
145
147
  if (res.ok) {
146
148
  const { value: result } = res;
@@ -179,6 +181,7 @@ Retrieve a Form
179
181
 
180
182
  ### Example Usage
181
183
 
184
+ <!-- UsageSnippet language="typescript" operationID="getForms" method="get" path="/form/{uuid}.json" -->
182
185
  ```typescript
183
186
  import { ServiceM8 } from "servicem8";
184
187
 
@@ -256,6 +259,7 @@ Update a Form
256
259
 
257
260
  ### Example Usage
258
261
 
262
+ <!-- UsageSnippet language="typescript" operationID="updateForms" method="post" path="/form/{uuid}.json" -->
259
263
  ```typescript
260
264
  import { ServiceM8 } from "servicem8";
261
265
 
@@ -269,8 +273,8 @@ async function run() {
269
273
  const result = await serviceM8.forms.updateForms({
270
274
  uuid: "2473c622-cde4-4803-b91a-cd7a656f7e3b",
271
275
  form: {
272
- documentTemplateUuid: "123e4567-1a18-40a7-9bd1-230c463fd56b",
273
- uuid: "123e4567-800a-4f6b-993f-230c4adcf1eb",
276
+ documentTemplateUuid: "123e4567-d7a1-46c4-b7eb-230fef542abb",
277
+ uuid: "123e4567-6b21-4e60-8d67-230fee61e19b",
274
278
  },
275
279
  });
276
280
 
@@ -300,8 +304,8 @@ async function run() {
300
304
  const res = await formsUpdateForms(serviceM8, {
301
305
  uuid: "2473c622-cde4-4803-b91a-cd7a656f7e3b",
302
306
  form: {
303
- documentTemplateUuid: "123e4567-1a18-40a7-9bd1-230c463fd56b",
304
- uuid: "123e4567-800a-4f6b-993f-230c4adcf1eb",
307
+ documentTemplateUuid: "123e4567-d7a1-46c4-b7eb-230fef542abb",
308
+ uuid: "123e4567-6b21-4e60-8d67-230fee61e19b",
305
309
  },
306
310
  });
307
311
  if (res.ok) {
@@ -345,6 +349,7 @@ In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records
345
349
 
346
350
  ### Example Usage
347
351
 
352
+ <!-- UsageSnippet language="typescript" operationID="deleteForms" method="delete" path="/form/{uuid}.json" -->
348
353
  ```typescript
349
354
  import { ServiceM8 } from "servicem8";
350
355
 
@@ -20,6 +20,7 @@ Retrieves a paginated list of inbox messages with optional filtering
20
20
 
21
21
  ### Example Usage
22
22
 
23
+ <!-- UsageSnippet language="typescript" operationID="listInboxMessages" method="get" path="/inboxmessage.json" -->
23
24
  ```typescript
24
25
  import { ServiceM8 } from "servicem8";
25
26
 
@@ -93,6 +94,7 @@ Retrieves detailed information about a specific inbox message including attachme
93
94
 
94
95
  ### Example Usage
95
96
 
97
+ <!-- UsageSnippet language="typescript" operationID="getInboxMessage" method="get" path="/inboxmessage/{uuid}.json" -->
96
98
  ```typescript
97
99
  import { ServiceM8 } from "servicem8";
98
100
 
@@ -170,6 +172,7 @@ Marks an inbox message as read
170
172
 
171
173
  ### Example Usage
172
174
 
175
+ <!-- UsageSnippet language="typescript" operationID="markInboxMessageAsRead" method="put" path="/inboxmessage/{uuid}/read.json" -->
173
176
  ```typescript
174
177
  import { ServiceM8 } from "servicem8";
175
178
 
@@ -247,6 +250,7 @@ Archives or unarchives an inbox message
247
250
 
248
251
  ### Example Usage
249
252
 
253
+ <!-- UsageSnippet language="typescript" operationID="archiveInboxMessage" method="put" path="/inboxmessage/{uuid}/archive.json" -->
250
254
  ```typescript
251
255
  import { ServiceM8 } from "servicem8";
252
256
 
@@ -325,6 +329,7 @@ Snoozes a message until a specified date/time or unsnoozes it
325
329
 
326
330
  ### Example Usage
327
331
 
332
+ <!-- UsageSnippet language="typescript" operationID="snoozeInboxMessage" method="put" path="/inboxmessage/{uuid}/snooze.json" -->
328
333
  ```typescript
329
334
  import { ServiceM8 } from "servicem8";
330
335
 
@@ -404,6 +409,7 @@ Converts an inbox message into a new job, optionally using a job template
404
409
 
405
410
  ### Example Usage
406
411
 
412
+ <!-- UsageSnippet language="typescript" operationID="convertInboxMessageToJob" method="post" path="/inboxmessage/{uuid}/convert-to-job.json" -->
407
413
  ```typescript
408
414
  import { ServiceM8 } from "servicem8";
409
415
 
@@ -480,6 +486,7 @@ Attaches an inbox message to an existing job
480
486
 
481
487
  ### Example Usage
482
488
 
489
+ <!-- UsageSnippet language="typescript" operationID="attachInboxMessageToJob" method="post" path="/inboxmessage/{uuid}/attach-to-job.json" -->
483
490
  ```typescript
484
491
  import { ServiceM8 } from "servicem8";
485
492
 
@@ -563,6 +570,7 @@ Adds a note to an inbox message
563
570
 
564
571
  ### Example Usage
565
572
 
573
+ <!-- UsageSnippet language="typescript" operationID="addNoteToInboxMessage" method="post" path="/inboxmessage/{uuid}/notes.json" -->
566
574
  ```typescript
567
575
  import { ServiceM8 } from "servicem8";
568
576
 
@@ -28,6 +28,7 @@ This endpoint requires the following OAuth scope **read_schedule**.
28
28
 
29
29
  ### Example Usage
30
30
 
31
+ <!-- UsageSnippet language="typescript" operationID="listJobActivities" method="get" path="/jobactivity.json" -->
31
32
  ```typescript
32
33
  import { ServiceM8 } from "servicem8";
33
34
 
@@ -110,6 +111,7 @@ UUID is optional for record creation. If no UUID is supplied, a UUID will be aut
110
111
 
111
112
  ### Example Usage
112
113
 
114
+ <!-- UsageSnippet language="typescript" operationID="createJobActivities" method="post" path="/jobactivity.json" -->
113
115
  ```typescript
114
116
  import { ServiceM8 } from "servicem8";
115
117
 
@@ -121,15 +123,15 @@ const serviceM8 = new ServiceM8({
121
123
 
122
124
  async function run() {
123
125
  const result = await serviceM8.jobActivities.createJobActivities({
124
- uuid: "123e4567-b9c1-452c-93f4-230c4cc92ceb",
125
- jobUuid: "123e4567-bac7-48a3-bc9a-230c4ed8b4cb",
126
- staffUuid: "123e4567-0b66-4137-a3b3-230c4e9e480b",
126
+ uuid: "123e4567-e225-4228-be15-230fefb4211b",
127
+ jobUuid: "123e4567-45ee-4ebb-b348-230fedad62eb",
128
+ staffUuid: "123e4567-9978-4abb-b907-230fe074266b",
127
129
  startDate: "2025-07-01 12:00:00",
128
130
  endDate: "2025-07-01 12:00:00",
129
131
  hasBeenOpenedTimestamp: "2025-07-01 12:00:00",
130
- allocatedByStaffUuid: "123e4567-7b5b-480e-bb40-230c46e7827b",
132
+ allocatedByStaffUuid: "123e4567-c53b-49ae-85f1-230fe52b786b",
131
133
  allocatedTimestamp: "2025-07-01 12:00:00",
132
- materialUuid: "123e4567-5fcd-4681-9f33-230c4813949b",
134
+ materialUuid: "123e4567-3acb-44ac-89b5-230fee45bedb",
133
135
  });
134
136
 
135
137
  console.log(result);
@@ -156,15 +158,15 @@ const serviceM8 = new ServiceM8Core({
156
158
 
157
159
  async function run() {
158
160
  const res = await jobActivitiesCreateJobActivities(serviceM8, {
159
- uuid: "123e4567-b9c1-452c-93f4-230c4cc92ceb",
160
- jobUuid: "123e4567-bac7-48a3-bc9a-230c4ed8b4cb",
161
- staffUuid: "123e4567-0b66-4137-a3b3-230c4e9e480b",
161
+ uuid: "123e4567-e225-4228-be15-230fefb4211b",
162
+ jobUuid: "123e4567-45ee-4ebb-b348-230fedad62eb",
163
+ staffUuid: "123e4567-9978-4abb-b907-230fe074266b",
162
164
  startDate: "2025-07-01 12:00:00",
163
165
  endDate: "2025-07-01 12:00:00",
164
166
  hasBeenOpenedTimestamp: "2025-07-01 12:00:00",
165
- allocatedByStaffUuid: "123e4567-7b5b-480e-bb40-230c46e7827b",
167
+ allocatedByStaffUuid: "123e4567-c53b-49ae-85f1-230fe52b786b",
166
168
  allocatedTimestamp: "2025-07-01 12:00:00",
167
- materialUuid: "123e4567-5fcd-4681-9f33-230c4813949b",
169
+ materialUuid: "123e4567-3acb-44ac-89b5-230fee45bedb",
168
170
  });
169
171
  if (res.ok) {
170
172
  const { value: result } = res;
@@ -208,6 +210,7 @@ This endpoint requires the following OAuth scope **read_schedule**.
208
210
 
209
211
  ### Example Usage
210
212
 
213
+ <!-- UsageSnippet language="typescript" operationID="getJobActivities" method="get" path="/jobactivity/{uuid}.json" -->
211
214
  ```typescript
212
215
  import { ServiceM8 } from "servicem8";
213
216
 
@@ -290,6 +293,7 @@ This endpoint requires the following OAuth scope **manage_schedule**.
290
293
 
291
294
  ### Example Usage
292
295
 
296
+ <!-- UsageSnippet language="typescript" operationID="updateJobActivities" method="post" path="/jobactivity/{uuid}.json" -->
293
297
  ```typescript
294
298
  import { ServiceM8 } from "servicem8";
295
299
 
@@ -303,15 +307,15 @@ async function run() {
303
307
  const result = await serviceM8.jobActivities.updateJobActivities({
304
308
  uuid: "5ccaaaf0-ee37-4a96-a41a-cc701c3f1a65",
305
309
  jobActivity: {
306
- uuid: "123e4567-b9c1-452c-93f4-230c4cc92ceb",
307
- jobUuid: "123e4567-bac7-48a3-bc9a-230c4ed8b4cb",
308
- staffUuid: "123e4567-0b66-4137-a3b3-230c4e9e480b",
310
+ uuid: "123e4567-e225-4228-be15-230fefb4211b",
311
+ jobUuid: "123e4567-45ee-4ebb-b348-230fedad62eb",
312
+ staffUuid: "123e4567-9978-4abb-b907-230fe074266b",
309
313
  startDate: "2025-07-01 12:00:00",
310
314
  endDate: "2025-07-01 12:00:00",
311
315
  hasBeenOpenedTimestamp: "2025-07-01 12:00:00",
312
- allocatedByStaffUuid: "123e4567-7b5b-480e-bb40-230c46e7827b",
316
+ allocatedByStaffUuid: "123e4567-c53b-49ae-85f1-230fe52b786b",
313
317
  allocatedTimestamp: "2025-07-01 12:00:00",
314
- materialUuid: "123e4567-5fcd-4681-9f33-230c4813949b",
318
+ materialUuid: "123e4567-3acb-44ac-89b5-230fee45bedb",
315
319
  },
316
320
  });
317
321
 
@@ -341,15 +345,15 @@ async function run() {
341
345
  const res = await jobActivitiesUpdateJobActivities(serviceM8, {
342
346
  uuid: "5ccaaaf0-ee37-4a96-a41a-cc701c3f1a65",
343
347
  jobActivity: {
344
- uuid: "123e4567-b9c1-452c-93f4-230c4cc92ceb",
345
- jobUuid: "123e4567-bac7-48a3-bc9a-230c4ed8b4cb",
346
- staffUuid: "123e4567-0b66-4137-a3b3-230c4e9e480b",
348
+ uuid: "123e4567-e225-4228-be15-230fefb4211b",
349
+ jobUuid: "123e4567-45ee-4ebb-b348-230fedad62eb",
350
+ staffUuid: "123e4567-9978-4abb-b907-230fe074266b",
347
351
  startDate: "2025-07-01 12:00:00",
348
352
  endDate: "2025-07-01 12:00:00",
349
353
  hasBeenOpenedTimestamp: "2025-07-01 12:00:00",
350
- allocatedByStaffUuid: "123e4567-7b5b-480e-bb40-230c46e7827b",
354
+ allocatedByStaffUuid: "123e4567-c53b-49ae-85f1-230fe52b786b",
351
355
  allocatedTimestamp: "2025-07-01 12:00:00",
352
- materialUuid: "123e4567-5fcd-4681-9f33-230c4813949b",
356
+ materialUuid: "123e4567-3acb-44ac-89b5-230fee45bedb",
353
357
  },
354
358
  });
355
359
  if (res.ok) {
@@ -398,6 +402,7 @@ This endpoint requires the following OAuth scope **manage_schedule**.
398
402
 
399
403
  ### Example Usage
400
404
 
405
+ <!-- UsageSnippet language="typescript" operationID="deleteJobActivities" method="delete" path="/jobactivity/{uuid}.json" -->
401
406
  ```typescript
402
407
  import { ServiceM8 } from "servicem8";
403
408
 
@@ -28,6 +28,7 @@ This endpoint requires the following OAuth scope **read_schedule**.
28
28
 
29
29
  ### Example Usage
30
30
 
31
+ <!-- UsageSnippet language="typescript" operationID="listJobAllocations" method="get" path="/joballocation.json" -->
31
32
  ```typescript
32
33
  import { ServiceM8 } from "servicem8";
33
34
 
@@ -110,6 +111,7 @@ UUID is optional for record creation. If no UUID is supplied, a UUID will be aut
110
111
 
111
112
  ### Example Usage
112
113
 
114
+ <!-- UsageSnippet language="typescript" operationID="createJobAllocations" method="post" path="/joballocation.json" -->
113
115
  ```typescript
114
116
  import { ServiceM8 } from "servicem8";
115
117
 
@@ -121,13 +123,13 @@ const serviceM8 = new ServiceM8({
121
123
 
122
124
  async function run() {
123
125
  const result = await serviceM8.jobAllocations.createJobAllocations({
124
- uuid: "123e4567-edfc-4bd7-a497-230c4fe1161b",
125
- jobUuid: "123e4567-992b-4b43-8a69-230c46b2b7db",
126
- queueUuid: "123e4567-de04-4301-bce4-230c4bdfb36b",
127
- staffUuid: "123e4567-26ee-4b67-a67e-230c450f61fb",
126
+ uuid: "123e4567-ada3-4826-9e93-230fe287e58b",
127
+ jobUuid: "123e4567-f7ce-4af4-b139-230fe2c16f4b",
128
+ queueUuid: "123e4567-e232-413b-a159-230fe281098b",
129
+ staffUuid: "123e4567-bd37-4c23-be2a-230fefa81ccb",
128
130
  allocationDate: "2025-07-01 12:00:00",
129
- allocationWindowUuid: "123e4567-0abb-456a-b9fa-230c49cf914b",
130
- allocatedByStaffUuid: "123e4567-ca1d-42bd-ad4a-230c47bbe23b",
131
+ allocationWindowUuid: "123e4567-e1be-414b-8c19-230fe736d52b",
132
+ allocatedByStaffUuid: "123e4567-06af-4be2-8621-230fe2981abb",
131
133
  allocatedTimestamp: "2025-07-01 12:00:00",
132
134
  expiryTimestamp: "2025-07-01 12:00:00",
133
135
  readTimestamp: "2025-07-01 12:00:00",
@@ -159,13 +161,13 @@ const serviceM8 = new ServiceM8Core({
159
161
 
160
162
  async function run() {
161
163
  const res = await jobAllocationsCreateJobAllocations(serviceM8, {
162
- uuid: "123e4567-edfc-4bd7-a497-230c4fe1161b",
163
- jobUuid: "123e4567-992b-4b43-8a69-230c46b2b7db",
164
- queueUuid: "123e4567-de04-4301-bce4-230c4bdfb36b",
165
- staffUuid: "123e4567-26ee-4b67-a67e-230c450f61fb",
164
+ uuid: "123e4567-ada3-4826-9e93-230fe287e58b",
165
+ jobUuid: "123e4567-f7ce-4af4-b139-230fe2c16f4b",
166
+ queueUuid: "123e4567-e232-413b-a159-230fe281098b",
167
+ staffUuid: "123e4567-bd37-4c23-be2a-230fefa81ccb",
166
168
  allocationDate: "2025-07-01 12:00:00",
167
- allocationWindowUuid: "123e4567-0abb-456a-b9fa-230c49cf914b",
168
- allocatedByStaffUuid: "123e4567-ca1d-42bd-ad4a-230c47bbe23b",
169
+ allocationWindowUuid: "123e4567-e1be-414b-8c19-230fe736d52b",
170
+ allocatedByStaffUuid: "123e4567-06af-4be2-8621-230fe2981abb",
169
171
  allocatedTimestamp: "2025-07-01 12:00:00",
170
172
  expiryTimestamp: "2025-07-01 12:00:00",
171
173
  readTimestamp: "2025-07-01 12:00:00",
@@ -214,6 +216,7 @@ This endpoint requires the following OAuth scope **read_schedule**.
214
216
 
215
217
  ### Example Usage
216
218
 
219
+ <!-- UsageSnippet language="typescript" operationID="getJobAllocations" method="get" path="/joballocation/{uuid}.json" -->
217
220
  ```typescript
218
221
  import { ServiceM8 } from "servicem8";
219
222
 
@@ -296,6 +299,7 @@ This endpoint requires the following OAuth scope **manage_schedule**.
296
299
 
297
300
  ### Example Usage
298
301
 
302
+ <!-- UsageSnippet language="typescript" operationID="updateJobAllocations" method="post" path="/joballocation/{uuid}.json" -->
299
303
  ```typescript
300
304
  import { ServiceM8 } from "servicem8";
301
305
 
@@ -309,13 +313,13 @@ async function run() {
309
313
  const result = await serviceM8.jobAllocations.updateJobAllocations({
310
314
  uuid: "583058ca-b387-4a2b-86cf-ca46e5b89aba",
311
315
  jobAllocation: {
312
- uuid: "123e4567-edfc-4bd7-a497-230c4fe1161b",
313
- jobUuid: "123e4567-992b-4b43-8a69-230c46b2b7db",
314
- queueUuid: "123e4567-de04-4301-bce4-230c4bdfb36b",
315
- staffUuid: "123e4567-26ee-4b67-a67e-230c450f61fb",
316
+ uuid: "123e4567-ada3-4826-9e93-230fe287e58b",
317
+ jobUuid: "123e4567-f7ce-4af4-b139-230fe2c16f4b",
318
+ queueUuid: "123e4567-e232-413b-a159-230fe281098b",
319
+ staffUuid: "123e4567-bd37-4c23-be2a-230fefa81ccb",
316
320
  allocationDate: "2025-07-01 12:00:00",
317
- allocationWindowUuid: "123e4567-0abb-456a-b9fa-230c49cf914b",
318
- allocatedByStaffUuid: "123e4567-ca1d-42bd-ad4a-230c47bbe23b",
321
+ allocationWindowUuid: "123e4567-e1be-414b-8c19-230fe736d52b",
322
+ allocatedByStaffUuid: "123e4567-06af-4be2-8621-230fe2981abb",
319
323
  allocatedTimestamp: "2025-07-01 12:00:00",
320
324
  expiryTimestamp: "2025-07-01 12:00:00",
321
325
  readTimestamp: "2025-07-01 12:00:00",
@@ -350,13 +354,13 @@ async function run() {
350
354
  const res = await jobAllocationsUpdateJobAllocations(serviceM8, {
351
355
  uuid: "583058ca-b387-4a2b-86cf-ca46e5b89aba",
352
356
  jobAllocation: {
353
- uuid: "123e4567-edfc-4bd7-a497-230c4fe1161b",
354
- jobUuid: "123e4567-992b-4b43-8a69-230c46b2b7db",
355
- queueUuid: "123e4567-de04-4301-bce4-230c4bdfb36b",
356
- staffUuid: "123e4567-26ee-4b67-a67e-230c450f61fb",
357
+ uuid: "123e4567-ada3-4826-9e93-230fe287e58b",
358
+ jobUuid: "123e4567-f7ce-4af4-b139-230fe2c16f4b",
359
+ queueUuid: "123e4567-e232-413b-a159-230fe281098b",
360
+ staffUuid: "123e4567-bd37-4c23-be2a-230fefa81ccb",
357
361
  allocationDate: "2025-07-01 12:00:00",
358
- allocationWindowUuid: "123e4567-0abb-456a-b9fa-230c49cf914b",
359
- allocatedByStaffUuid: "123e4567-ca1d-42bd-ad4a-230c47bbe23b",
362
+ allocationWindowUuid: "123e4567-e1be-414b-8c19-230fe736d52b",
363
+ allocatedByStaffUuid: "123e4567-06af-4be2-8621-230fe2981abb",
360
364
  allocatedTimestamp: "2025-07-01 12:00:00",
361
365
  expiryTimestamp: "2025-07-01 12:00:00",
362
366
  readTimestamp: "2025-07-01 12:00:00",
@@ -410,6 +414,7 @@ This endpoint requires the following OAuth scope **manage_schedule**.
410
414
 
411
415
  ### Example Usage
412
416
 
417
+ <!-- UsageSnippet language="typescript" operationID="deleteJobAllocations" method="delete" path="/joballocation/{uuid}.json" -->
413
418
  ```typescript
414
419
  import { ServiceM8 } from "servicem8";
415
420