servicem8 0.9.18 → 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.
- package/api.json +312 -318
- package/bin/mcp-server.js +8 -25
- package/bin/mcp-server.js.map +13 -13
- package/dist/commonjs/funcs/jobTemplatesCreateJobFromTemplate.d.ts +1 -1
- package/dist/commonjs/funcs/jobTemplatesCreateJobFromTemplate.js +1 -1
- package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.d.ts +0 -3
- package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.d.ts.map +1 -1
- package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.js +0 -3
- package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.js.map +1 -1
- package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.d.ts +0 -3
- package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.d.ts.map +1 -1
- package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.js +0 -3
- package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.js.map +1 -1
- package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.d.ts +0 -5
- package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.d.ts.map +1 -1
- package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.js +0 -5
- package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/mcp-server/mcp-server.js +1 -1
- package/dist/commonjs/mcp-server/server.js +1 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobFromTemplate.js +1 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.js +0 -5
- package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.js +0 -5
- package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.js +1 -8
- package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.js.map +1 -1
- package/dist/commonjs/sdk/jobtemplates.d.ts +1 -12
- package/dist/commonjs/sdk/jobtemplates.d.ts.map +1 -1
- package/dist/commonjs/sdk/jobtemplates.js +1 -12
- package/dist/commonjs/sdk/jobtemplates.js.map +1 -1
- package/dist/esm/funcs/jobTemplatesCreateJobFromTemplate.d.ts +1 -1
- package/dist/esm/funcs/jobTemplatesCreateJobFromTemplate.js +1 -1
- package/dist/esm/funcs/jobTemplatesCreateJobTemplates.d.ts +0 -3
- package/dist/esm/funcs/jobTemplatesCreateJobTemplates.d.ts.map +1 -1
- package/dist/esm/funcs/jobTemplatesCreateJobTemplates.js +0 -3
- package/dist/esm/funcs/jobTemplatesCreateJobTemplates.js.map +1 -1
- package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.d.ts +0 -3
- package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.d.ts.map +1 -1
- package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.js +0 -3
- package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.js.map +1 -1
- package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.d.ts +0 -5
- package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.d.ts.map +1 -1
- package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.js +0 -5
- package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/mcp-server/mcp-server.js +1 -1
- package/dist/esm/mcp-server/server.js +1 -1
- package/dist/esm/mcp-server/tools/jobTemplatesCreateJobFromTemplate.js +1 -1
- package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts.map +1 -1
- package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.js +0 -5
- package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.js.map +1 -1
- package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts.map +1 -1
- package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.js +0 -5
- package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.js.map +1 -1
- package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts.map +1 -1
- package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.js +1 -8
- package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.js.map +1 -1
- package/dist/esm/sdk/jobtemplates.d.ts +1 -12
- package/dist/esm/sdk/jobtemplates.d.ts.map +1 -1
- package/dist/esm/sdk/jobtemplates.js +1 -12
- package/dist/esm/sdk/jobtemplates.js.map +1 -1
- package/docs/sdks/allocationwindows/README.md +9 -4
- package/docs/sdks/assets/README.md +10 -6
- package/docs/sdks/assettypefields/README.md +13 -8
- package/docs/sdks/assettypes/README.md +9 -4
- package/docs/sdks/attachments/README.md +17 -12
- package/docs/sdks/badges/README.md +17 -12
- package/docs/sdks/bundles/README.md +9 -4
- package/docs/sdks/categories/README.md +9 -4
- package/docs/sdks/clients/README.md +13 -8
- package/docs/sdks/companycontacts/README.md +13 -8
- package/docs/sdks/emailtemplates/README.md +9 -4
- package/docs/sdks/feedback/README.md +13 -8
- package/docs/sdks/formfields/README.md +13 -8
- package/docs/sdks/formresponses/README.md +33 -28
- package/docs/sdks/forms/README.md +13 -8
- package/docs/sdks/inbox/README.md +8 -0
- package/docs/sdks/jobactivities/README.md +25 -20
- package/docs/sdks/joballocations/README.md +29 -24
- package/docs/sdks/jobchecklists/README.md +37 -32
- package/docs/sdks/jobcontacts/README.md +13 -8
- package/docs/sdks/jobmaterialbundles/README.md +17 -12
- package/docs/sdks/jobmaterials/README.md +25 -20
- package/docs/sdks/jobpayments/README.md +21 -16
- package/docs/sdks/jobqueues/README.md +9 -4
- package/docs/sdks/jobs/README.md +37 -32
- package/docs/sdks/jobtemplates/README.md +12 -21
- package/docs/sdks/knowledgearticles/README.md +9 -4
- package/docs/sdks/locations/README.md +9 -4
- package/docs/sdks/materials/README.md +13 -8
- package/docs/sdks/notes/README.md +17 -12
- package/docs/sdks/search/README.md +3 -0
- package/docs/sdks/securityroles/README.md +9 -4
- package/docs/sdks/smstemplates/README.md +9 -4
- package/docs/sdks/staffmembers/README.md +17 -12
- package/docs/sdks/staffmessages/README.md +21 -16
- package/docs/sdks/tasks/README.md +25 -20
- package/docs/sdks/taxrates/README.md +9 -4
- package/docs/sdks/vendors/README.md +5 -2
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/jobTemplatesCreateJobFromTemplate.ts +1 -1
- package/src/funcs/jobTemplatesCreateJobTemplates.ts +0 -3
- package/src/funcs/jobTemplatesDeleteJobTemplates.ts +0 -3
- package/src/funcs/jobTemplatesUpdateJobTemplates.ts +0 -5
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/src/mcp-server/tools/jobTemplatesCreateJobFromTemplate.ts +1 -1
- package/src/mcp-server/tools/jobTemplatesCreateJobTemplates.ts +0 -5
- package/src/mcp-server/tools/jobTemplatesDeleteJobTemplates.ts +0 -5
- package/src/mcp-server/tools/jobTemplatesUpdateJobTemplates.ts +1 -8
- package/src/sdk/jobtemplates.ts +1 -12
|
@@ -28,6 +28,7 @@ This endpoint requires the following OAuth scope **manage_badges**.
|
|
|
28
28
|
|
|
29
29
|
### Example Usage
|
|
30
30
|
|
|
31
|
+
<!-- UsageSnippet language="typescript" operationID="listBadges" method="get" path="/badge.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="createBadges" method="post" path="/badge.json" -->
|
|
113
115
|
```typescript
|
|
114
116
|
import { ServiceM8 } from "servicem8";
|
|
115
117
|
|
|
@@ -121,10 +123,10 @@ const serviceM8 = new ServiceM8({
|
|
|
121
123
|
|
|
122
124
|
async function run() {
|
|
123
125
|
const result = await serviceM8.badges.createBadges({
|
|
124
|
-
uuid: "123e4567-
|
|
126
|
+
uuid: "123e4567-08e6-458b-ba61-230fe33a77bb",
|
|
125
127
|
name: "<value>",
|
|
126
|
-
regardingFormUuid: "123e4567-
|
|
127
|
-
regardingAssetTypeUuid: "123e4567-
|
|
128
|
+
regardingFormUuid: "123e4567-68da-4367-bf55-230fe94c5bfb",
|
|
129
|
+
regardingAssetTypeUuid: "123e4567-36ba-4e01-8120-230fe19fbe6b",
|
|
128
130
|
});
|
|
129
131
|
|
|
130
132
|
console.log(result);
|
|
@@ -151,10 +153,10 @@ const serviceM8 = new ServiceM8Core({
|
|
|
151
153
|
|
|
152
154
|
async function run() {
|
|
153
155
|
const res = await badgesCreateBadges(serviceM8, {
|
|
154
|
-
uuid: "123e4567-
|
|
156
|
+
uuid: "123e4567-08e6-458b-ba61-230fe33a77bb",
|
|
155
157
|
name: "<value>",
|
|
156
|
-
regardingFormUuid: "123e4567-
|
|
157
|
-
regardingAssetTypeUuid: "123e4567-
|
|
158
|
+
regardingFormUuid: "123e4567-68da-4367-bf55-230fe94c5bfb",
|
|
159
|
+
regardingAssetTypeUuid: "123e4567-36ba-4e01-8120-230fe19fbe6b",
|
|
158
160
|
});
|
|
159
161
|
if (res.ok) {
|
|
160
162
|
const { value: result } = res;
|
|
@@ -198,6 +200,7 @@ This endpoint requires the following OAuth scope **manage_badges**.
|
|
|
198
200
|
|
|
199
201
|
### Example Usage
|
|
200
202
|
|
|
203
|
+
<!-- UsageSnippet language="typescript" operationID="getBadges" method="get" path="/badge/{uuid}.json" -->
|
|
201
204
|
```typescript
|
|
202
205
|
import { ServiceM8 } from "servicem8";
|
|
203
206
|
|
|
@@ -280,6 +283,7 @@ This endpoint requires the following OAuth scope **manage_badges**.
|
|
|
280
283
|
|
|
281
284
|
### Example Usage
|
|
282
285
|
|
|
286
|
+
<!-- UsageSnippet language="typescript" operationID="updateBadges" method="post" path="/badge/{uuid}.json" -->
|
|
283
287
|
```typescript
|
|
284
288
|
import { ServiceM8 } from "servicem8";
|
|
285
289
|
|
|
@@ -293,10 +297,10 @@ async function run() {
|
|
|
293
297
|
const result = await serviceM8.badges.updateBadges({
|
|
294
298
|
uuid: "444f2947-b065-4aac-8159-0ffca6278fd2",
|
|
295
299
|
badge: {
|
|
296
|
-
uuid: "123e4567-
|
|
300
|
+
uuid: "123e4567-08e6-458b-ba61-230fe33a77bb",
|
|
297
301
|
name: "<value>",
|
|
298
|
-
regardingFormUuid: "123e4567-
|
|
299
|
-
regardingAssetTypeUuid: "123e4567-
|
|
302
|
+
regardingFormUuid: "123e4567-68da-4367-bf55-230fe94c5bfb",
|
|
303
|
+
regardingAssetTypeUuid: "123e4567-36ba-4e01-8120-230fe19fbe6b",
|
|
300
304
|
},
|
|
301
305
|
});
|
|
302
306
|
|
|
@@ -326,10 +330,10 @@ async function run() {
|
|
|
326
330
|
const res = await badgesUpdateBadges(serviceM8, {
|
|
327
331
|
uuid: "444f2947-b065-4aac-8159-0ffca6278fd2",
|
|
328
332
|
badge: {
|
|
329
|
-
uuid: "123e4567-
|
|
333
|
+
uuid: "123e4567-08e6-458b-ba61-230fe33a77bb",
|
|
330
334
|
name: "<value>",
|
|
331
|
-
regardingFormUuid: "123e4567-
|
|
332
|
-
regardingAssetTypeUuid: "123e4567-
|
|
335
|
+
regardingFormUuid: "123e4567-68da-4367-bf55-230fe94c5bfb",
|
|
336
|
+
regardingAssetTypeUuid: "123e4567-36ba-4e01-8120-230fe19fbe6b",
|
|
333
337
|
},
|
|
334
338
|
});
|
|
335
339
|
if (res.ok) {
|
|
@@ -378,6 +382,7 @@ This endpoint requires the following OAuth scope **manage_badges**.
|
|
|
378
382
|
|
|
379
383
|
### Example Usage
|
|
380
384
|
|
|
385
|
+
<!-- UsageSnippet language="typescript" operationID="deleteBadges" method="delete" path="/badge/{uuid}.json" -->
|
|
381
386
|
```typescript
|
|
382
387
|
import { ServiceM8 } from "servicem8";
|
|
383
388
|
|
|
@@ -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="listBundles" method="get" path="/materialbundle.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="createBundles" method="post" path="/materialbundle.json" -->
|
|
103
105
|
```typescript
|
|
104
106
|
import { ServiceM8 } from "servicem8";
|
|
105
107
|
|
|
@@ -111,7 +113,7 @@ const serviceM8 = new ServiceM8({
|
|
|
111
113
|
|
|
112
114
|
async function run() {
|
|
113
115
|
const result = await serviceM8.bundles.createBundles({
|
|
114
|
-
uuid: "123e4567-
|
|
116
|
+
uuid: "123e4567-4627-4e3a-b9fd-230fef0f550b",
|
|
115
117
|
itemNumber: "<value>",
|
|
116
118
|
});
|
|
117
119
|
|
|
@@ -139,7 +141,7 @@ const serviceM8 = new ServiceM8Core({
|
|
|
139
141
|
|
|
140
142
|
async function run() {
|
|
141
143
|
const res = await bundlesCreateBundles(serviceM8, {
|
|
142
|
-
uuid: "123e4567-
|
|
144
|
+
uuid: "123e4567-4627-4e3a-b9fd-230fef0f550b",
|
|
143
145
|
itemNumber: "<value>",
|
|
144
146
|
});
|
|
145
147
|
if (res.ok) {
|
|
@@ -179,6 +181,7 @@ Retrieve a Bundle
|
|
|
179
181
|
|
|
180
182
|
### Example Usage
|
|
181
183
|
|
|
184
|
+
<!-- UsageSnippet language="typescript" operationID="getBundles" method="get" path="/materialbundle/{uuid}.json" -->
|
|
182
185
|
```typescript
|
|
183
186
|
import { ServiceM8 } from "servicem8";
|
|
184
187
|
|
|
@@ -256,6 +259,7 @@ Update a Bundle
|
|
|
256
259
|
|
|
257
260
|
### Example Usage
|
|
258
261
|
|
|
262
|
+
<!-- UsageSnippet language="typescript" operationID="updateBundles" method="post" path="/materialbundle/{uuid}.json" -->
|
|
259
263
|
```typescript
|
|
260
264
|
import { ServiceM8 } from "servicem8";
|
|
261
265
|
|
|
@@ -269,7 +273,7 @@ async function run() {
|
|
|
269
273
|
const result = await serviceM8.bundles.updateBundles({
|
|
270
274
|
uuid: "92d0296e-677d-4cfc-a0ec-84e1809ff960",
|
|
271
275
|
materialBundle: {
|
|
272
|
-
uuid: "123e4567-
|
|
276
|
+
uuid: "123e4567-4627-4e3a-b9fd-230fef0f550b",
|
|
273
277
|
itemNumber: "<value>",
|
|
274
278
|
},
|
|
275
279
|
});
|
|
@@ -300,7 +304,7 @@ async function run() {
|
|
|
300
304
|
const res = await bundlesUpdateBundles(serviceM8, {
|
|
301
305
|
uuid: "92d0296e-677d-4cfc-a0ec-84e1809ff960",
|
|
302
306
|
materialBundle: {
|
|
303
|
-
uuid: "123e4567-
|
|
307
|
+
uuid: "123e4567-4627-4e3a-b9fd-230fef0f550b",
|
|
304
308
|
itemNumber: "<value>",
|
|
305
309
|
},
|
|
306
310
|
});
|
|
@@ -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="deleteBundles" method="delete" path="/materialbundle/{uuid}.json" -->
|
|
348
353
|
```typescript
|
|
349
354
|
import { ServiceM8 } from "servicem8";
|
|
350
355
|
|
|
@@ -28,6 +28,7 @@ This endpoint requires the following OAuth scope **read_job_categories**.
|
|
|
28
28
|
|
|
29
29
|
### Example Usage
|
|
30
30
|
|
|
31
|
+
<!-- UsageSnippet language="typescript" operationID="listCategories" method="get" path="/category.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="createCategories" method="post" path="/category.json" -->
|
|
113
115
|
```typescript
|
|
114
116
|
import { ServiceM8 } from "servicem8";
|
|
115
117
|
|
|
@@ -122,7 +124,7 @@ const serviceM8 = new ServiceM8({
|
|
|
122
124
|
async function run() {
|
|
123
125
|
const result = await serviceM8.categories.createCategories({
|
|
124
126
|
name: "<value>",
|
|
125
|
-
uuid: "123e4567-
|
|
127
|
+
uuid: "123e4567-6a08-457f-9d99-230fe0ef8efb",
|
|
126
128
|
});
|
|
127
129
|
|
|
128
130
|
console.log(result);
|
|
@@ -150,7 +152,7 @@ const serviceM8 = new ServiceM8Core({
|
|
|
150
152
|
async function run() {
|
|
151
153
|
const res = await categoriesCreateCategories(serviceM8, {
|
|
152
154
|
name: "<value>",
|
|
153
|
-
uuid: "123e4567-
|
|
155
|
+
uuid: "123e4567-6a08-457f-9d99-230fe0ef8efb",
|
|
154
156
|
});
|
|
155
157
|
if (res.ok) {
|
|
156
158
|
const { value: result } = res;
|
|
@@ -194,6 +196,7 @@ This endpoint requires the following OAuth scope **read_job_categories**.
|
|
|
194
196
|
|
|
195
197
|
### Example Usage
|
|
196
198
|
|
|
199
|
+
<!-- UsageSnippet language="typescript" operationID="getCategories" method="get" path="/category/{uuid}.json" -->
|
|
197
200
|
```typescript
|
|
198
201
|
import { ServiceM8 } from "servicem8";
|
|
199
202
|
|
|
@@ -276,6 +279,7 @@ This endpoint requires the following OAuth scope **manage_job_categories**.
|
|
|
276
279
|
|
|
277
280
|
### Example Usage
|
|
278
281
|
|
|
282
|
+
<!-- UsageSnippet language="typescript" operationID="updateCategories" method="post" path="/category/{uuid}.json" -->
|
|
279
283
|
```typescript
|
|
280
284
|
import { ServiceM8 } from "servicem8";
|
|
281
285
|
|
|
@@ -290,7 +294,7 @@ async function run() {
|
|
|
290
294
|
uuid: "c830c901-e3ae-427d-8f08-cf28c94b319f",
|
|
291
295
|
category: {
|
|
292
296
|
name: "<value>",
|
|
293
|
-
uuid: "123e4567-
|
|
297
|
+
uuid: "123e4567-6a08-457f-9d99-230fe0ef8efb",
|
|
294
298
|
},
|
|
295
299
|
});
|
|
296
300
|
|
|
@@ -321,7 +325,7 @@ async function run() {
|
|
|
321
325
|
uuid: "c830c901-e3ae-427d-8f08-cf28c94b319f",
|
|
322
326
|
category: {
|
|
323
327
|
name: "<value>",
|
|
324
|
-
uuid: "123e4567-
|
|
328
|
+
uuid: "123e4567-6a08-457f-9d99-230fe0ef8efb",
|
|
325
329
|
},
|
|
326
330
|
});
|
|
327
331
|
if (res.ok) {
|
|
@@ -370,6 +374,7 @@ This endpoint requires the following OAuth scope **manage_job_categories**.
|
|
|
370
374
|
|
|
371
375
|
### Example Usage
|
|
372
376
|
|
|
377
|
+
<!-- UsageSnippet language="typescript" operationID="deleteCategories" method="delete" path="/category/{uuid}.json" -->
|
|
373
378
|
```typescript
|
|
374
379
|
import { ServiceM8 } from "servicem8";
|
|
375
380
|
|
|
@@ -28,6 +28,7 @@ This endpoint requires the following OAuth scope **read_customers**.
|
|
|
28
28
|
|
|
29
29
|
### Example Usage
|
|
30
30
|
|
|
31
|
+
<!-- UsageSnippet language="typescript" operationID="listClients" method="get" path="/company.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="createClients" method="post" path="/company.json" -->
|
|
113
115
|
```typescript
|
|
114
116
|
import { ServiceM8 } from "servicem8";
|
|
115
117
|
|
|
@@ -122,8 +124,8 @@ const serviceM8 = new ServiceM8({
|
|
|
122
124
|
async function run() {
|
|
123
125
|
const result = await serviceM8.clients.createClients({
|
|
124
126
|
name: "<value>",
|
|
125
|
-
uuid: "123e4567-
|
|
126
|
-
taxRateUuid: "123e4567-
|
|
127
|
+
uuid: "123e4567-69da-435b-98c6-230fe9f0aabb",
|
|
128
|
+
taxRateUuid: "123e4567-8739-443e-9b78-230fe442890b",
|
|
127
129
|
});
|
|
128
130
|
|
|
129
131
|
console.log(result);
|
|
@@ -151,8 +153,8 @@ const serviceM8 = new ServiceM8Core({
|
|
|
151
153
|
async function run() {
|
|
152
154
|
const res = await clientsCreateClients(serviceM8, {
|
|
153
155
|
name: "<value>",
|
|
154
|
-
uuid: "123e4567-
|
|
155
|
-
taxRateUuid: "123e4567-
|
|
156
|
+
uuid: "123e4567-69da-435b-98c6-230fe9f0aabb",
|
|
157
|
+
taxRateUuid: "123e4567-8739-443e-9b78-230fe442890b",
|
|
156
158
|
});
|
|
157
159
|
if (res.ok) {
|
|
158
160
|
const { value: result } = res;
|
|
@@ -196,6 +198,7 @@ This endpoint requires the following OAuth scope **read_customers**.
|
|
|
196
198
|
|
|
197
199
|
### Example Usage
|
|
198
200
|
|
|
201
|
+
<!-- UsageSnippet language="typescript" operationID="getClients" method="get" path="/company/{uuid}.json" -->
|
|
199
202
|
```typescript
|
|
200
203
|
import { ServiceM8 } from "servicem8";
|
|
201
204
|
|
|
@@ -278,6 +281,7 @@ This endpoint requires the following OAuth scope **manage_customers**.
|
|
|
278
281
|
|
|
279
282
|
### Example Usage
|
|
280
283
|
|
|
284
|
+
<!-- UsageSnippet language="typescript" operationID="updateClients" method="post" path="/company/{uuid}.json" -->
|
|
281
285
|
```typescript
|
|
282
286
|
import { ServiceM8 } from "servicem8";
|
|
283
287
|
|
|
@@ -292,8 +296,8 @@ async function run() {
|
|
|
292
296
|
uuid: "55f6bcc0-3bb7-4509-b13b-98c02374f910",
|
|
293
297
|
company: {
|
|
294
298
|
name: "<value>",
|
|
295
|
-
uuid: "123e4567-
|
|
296
|
-
taxRateUuid: "123e4567-
|
|
299
|
+
uuid: "123e4567-69da-435b-98c6-230fe9f0aabb",
|
|
300
|
+
taxRateUuid: "123e4567-8739-443e-9b78-230fe442890b",
|
|
297
301
|
},
|
|
298
302
|
});
|
|
299
303
|
|
|
@@ -324,8 +328,8 @@ async function run() {
|
|
|
324
328
|
uuid: "55f6bcc0-3bb7-4509-b13b-98c02374f910",
|
|
325
329
|
company: {
|
|
326
330
|
name: "<value>",
|
|
327
|
-
uuid: "123e4567-
|
|
328
|
-
taxRateUuid: "123e4567-
|
|
331
|
+
uuid: "123e4567-69da-435b-98c6-230fe9f0aabb",
|
|
332
|
+
taxRateUuid: "123e4567-8739-443e-9b78-230fe442890b",
|
|
329
333
|
},
|
|
330
334
|
});
|
|
331
335
|
if (res.ok) {
|
|
@@ -374,6 +378,7 @@ This endpoint requires the following OAuth scope **manage_customers**.
|
|
|
374
378
|
|
|
375
379
|
### Example Usage
|
|
376
380
|
|
|
381
|
+
<!-- UsageSnippet language="typescript" operationID="deleteClients" method="delete" path="/company/{uuid}.json" -->
|
|
377
382
|
```typescript
|
|
378
383
|
import { ServiceM8 } from "servicem8";
|
|
379
384
|
|
|
@@ -28,6 +28,7 @@ This endpoint requires the following OAuth scope **read_customer_contacts**.
|
|
|
28
28
|
|
|
29
29
|
### Example Usage
|
|
30
30
|
|
|
31
|
+
<!-- UsageSnippet language="typescript" operationID="listCompanyContacts" method="get" path="/companycontact.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="createCompanyContacts" method="post" path="/companycontact.json" -->
|
|
113
115
|
```typescript
|
|
114
116
|
import { ServiceM8 } from "servicem8";
|
|
115
117
|
|
|
@@ -121,8 +123,8 @@ const serviceM8 = new ServiceM8({
|
|
|
121
123
|
|
|
122
124
|
async function run() {
|
|
123
125
|
const result = await serviceM8.companyContacts.createCompanyContacts({
|
|
124
|
-
uuid: "123e4567-
|
|
125
|
-
companyUuid: "123e4567-
|
|
126
|
+
uuid: "123e4567-3b39-404d-9657-230feaf2eb6b",
|
|
127
|
+
companyUuid: "123e4567-b2f3-4c04-9683-230fe89e254b",
|
|
126
128
|
});
|
|
127
129
|
|
|
128
130
|
console.log(result);
|
|
@@ -149,8 +151,8 @@ const serviceM8 = new ServiceM8Core({
|
|
|
149
151
|
|
|
150
152
|
async function run() {
|
|
151
153
|
const res = await companyContactsCreateCompanyContacts(serviceM8, {
|
|
152
|
-
uuid: "123e4567-
|
|
153
|
-
companyUuid: "123e4567-
|
|
154
|
+
uuid: "123e4567-3b39-404d-9657-230feaf2eb6b",
|
|
155
|
+
companyUuid: "123e4567-b2f3-4c04-9683-230fe89e254b",
|
|
154
156
|
});
|
|
155
157
|
if (res.ok) {
|
|
156
158
|
const { value: result } = res;
|
|
@@ -194,6 +196,7 @@ This endpoint requires the following OAuth scope **read_customer_contacts**.
|
|
|
194
196
|
|
|
195
197
|
### Example Usage
|
|
196
198
|
|
|
199
|
+
<!-- UsageSnippet language="typescript" operationID="getCompanyContacts" method="get" path="/companycontact/{uuid}.json" -->
|
|
197
200
|
```typescript
|
|
198
201
|
import { ServiceM8 } from "servicem8";
|
|
199
202
|
|
|
@@ -276,6 +279,7 @@ This endpoint requires the following OAuth scope **manage_customer_contacts**.
|
|
|
276
279
|
|
|
277
280
|
### Example Usage
|
|
278
281
|
|
|
282
|
+
<!-- UsageSnippet language="typescript" operationID="updateCompanyContacts" method="post" path="/companycontact/{uuid}.json" -->
|
|
279
283
|
```typescript
|
|
280
284
|
import { ServiceM8 } from "servicem8";
|
|
281
285
|
|
|
@@ -289,8 +293,8 @@ async function run() {
|
|
|
289
293
|
const result = await serviceM8.companyContacts.updateCompanyContacts({
|
|
290
294
|
uuid: "14a84f05-390e-4d88-ad00-a75bba477a48",
|
|
291
295
|
companyContact: {
|
|
292
|
-
uuid: "123e4567-
|
|
293
|
-
companyUuid: "123e4567-
|
|
296
|
+
uuid: "123e4567-3b39-404d-9657-230feaf2eb6b",
|
|
297
|
+
companyUuid: "123e4567-b2f3-4c04-9683-230fe89e254b",
|
|
294
298
|
},
|
|
295
299
|
});
|
|
296
300
|
|
|
@@ -320,8 +324,8 @@ async function run() {
|
|
|
320
324
|
const res = await companyContactsUpdateCompanyContacts(serviceM8, {
|
|
321
325
|
uuid: "14a84f05-390e-4d88-ad00-a75bba477a48",
|
|
322
326
|
companyContact: {
|
|
323
|
-
uuid: "123e4567-
|
|
324
|
-
companyUuid: "123e4567-
|
|
327
|
+
uuid: "123e4567-3b39-404d-9657-230feaf2eb6b",
|
|
328
|
+
companyUuid: "123e4567-b2f3-4c04-9683-230fe89e254b",
|
|
325
329
|
},
|
|
326
330
|
});
|
|
327
331
|
if (res.ok) {
|
|
@@ -370,6 +374,7 @@ This endpoint requires the following OAuth scope **manage_customer_contacts**.
|
|
|
370
374
|
|
|
371
375
|
### Example Usage
|
|
372
376
|
|
|
377
|
+
<!-- UsageSnippet language="typescript" operationID="deleteCompanyContacts" method="delete" path="/companycontact/{uuid}.json" -->
|
|
373
378
|
```typescript
|
|
374
379
|
import { ServiceM8 } from "servicem8";
|
|
375
380
|
|
|
@@ -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="listEmailTemplates" method="get" path="/emailtemplate.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="createEmailTemplates" method="post" path="/emailtemplate.json" -->
|
|
103
105
|
```typescript
|
|
104
106
|
import { ServiceM8 } from "servicem8";
|
|
105
107
|
|
|
@@ -111,7 +113,7 @@ const serviceM8 = new ServiceM8({
|
|
|
111
113
|
|
|
112
114
|
async function run() {
|
|
113
115
|
const result = await serviceM8.emailTemplates.createEmailTemplates({
|
|
114
|
-
uuid: "123e4567-
|
|
116
|
+
uuid: "123e4567-ecfe-488e-b56c-230fe30c10bb",
|
|
115
117
|
name: "<value>",
|
|
116
118
|
});
|
|
117
119
|
|
|
@@ -139,7 +141,7 @@ const serviceM8 = new ServiceM8Core({
|
|
|
139
141
|
|
|
140
142
|
async function run() {
|
|
141
143
|
const res = await emailTemplatesCreateEmailTemplates(serviceM8, {
|
|
142
|
-
uuid: "123e4567-
|
|
144
|
+
uuid: "123e4567-ecfe-488e-b56c-230fe30c10bb",
|
|
143
145
|
name: "<value>",
|
|
144
146
|
});
|
|
145
147
|
if (res.ok) {
|
|
@@ -179,6 +181,7 @@ Retrieve an Email Template
|
|
|
179
181
|
|
|
180
182
|
### Example Usage
|
|
181
183
|
|
|
184
|
+
<!-- UsageSnippet language="typescript" operationID="getEmailTemplates" method="get" path="/emailtemplate/{uuid}.json" -->
|
|
182
185
|
```typescript
|
|
183
186
|
import { ServiceM8 } from "servicem8";
|
|
184
187
|
|
|
@@ -256,6 +259,7 @@ Update an Email Template
|
|
|
256
259
|
|
|
257
260
|
### Example Usage
|
|
258
261
|
|
|
262
|
+
<!-- UsageSnippet language="typescript" operationID="updateEmailTemplates" method="post" path="/emailtemplate/{uuid}.json" -->
|
|
259
263
|
```typescript
|
|
260
264
|
import { ServiceM8 } from "servicem8";
|
|
261
265
|
|
|
@@ -269,7 +273,7 @@ async function run() {
|
|
|
269
273
|
const result = await serviceM8.emailTemplates.updateEmailTemplates({
|
|
270
274
|
uuid: "a3ce5f33-781a-4062-b068-2e3f8605b008",
|
|
271
275
|
emailTemplate: {
|
|
272
|
-
uuid: "123e4567-
|
|
276
|
+
uuid: "123e4567-ecfe-488e-b56c-230fe30c10bb",
|
|
273
277
|
name: "<value>",
|
|
274
278
|
},
|
|
275
279
|
});
|
|
@@ -300,7 +304,7 @@ async function run() {
|
|
|
300
304
|
const res = await emailTemplatesUpdateEmailTemplates(serviceM8, {
|
|
301
305
|
uuid: "a3ce5f33-781a-4062-b068-2e3f8605b008",
|
|
302
306
|
emailTemplate: {
|
|
303
|
-
uuid: "123e4567-
|
|
307
|
+
uuid: "123e4567-ecfe-488e-b56c-230fe30c10bb",
|
|
304
308
|
name: "<value>",
|
|
305
309
|
},
|
|
306
310
|
});
|
|
@@ -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="deleteEmailTemplates" method="delete" path="/emailtemplate/{uuid}.json" -->
|
|
348
353
|
```typescript
|
|
349
354
|
import { ServiceM8 } from "servicem8";
|
|
350
355
|
|
|
@@ -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="listFeedback" method="get" path="/feedback.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="createFeedback" method="post" path="/feedback.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.feedback.createFeedback({
|
|
114
|
-
uuid: "123e4567-
|
|
115
|
-
relatedObjectUuid: "123e4567-
|
|
116
|
+
uuid: "123e4567-59ff-490e-96c3-230fe4d8f08b",
|
|
117
|
+
relatedObjectUuid: "123e4567-bcac-4403-854b-230fe744c5cb",
|
|
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 feedbackCreateFeedback(serviceM8, {
|
|
142
|
-
uuid: "123e4567-
|
|
143
|
-
relatedObjectUuid: "123e4567-
|
|
144
|
+
uuid: "123e4567-59ff-490e-96c3-230fe4d8f08b",
|
|
145
|
+
relatedObjectUuid: "123e4567-bcac-4403-854b-230fe744c5cb",
|
|
144
146
|
});
|
|
145
147
|
if (res.ok) {
|
|
146
148
|
const { value: result } = res;
|
|
@@ -179,6 +181,7 @@ Retrieve a Feedback
|
|
|
179
181
|
|
|
180
182
|
### Example Usage
|
|
181
183
|
|
|
184
|
+
<!-- UsageSnippet language="typescript" operationID="getFeedback" method="get" path="/feedback/{uuid}.json" -->
|
|
182
185
|
```typescript
|
|
183
186
|
import { ServiceM8 } from "servicem8";
|
|
184
187
|
|
|
@@ -256,6 +259,7 @@ Update a Feedback
|
|
|
256
259
|
|
|
257
260
|
### Example Usage
|
|
258
261
|
|
|
262
|
+
<!-- UsageSnippet language="typescript" operationID="updateFeedback" method="post" path="/feedback/{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.feedback.updateFeedback({
|
|
270
274
|
uuid: "4b9b8627-caa7-402a-94b0-02cb8641823c",
|
|
271
275
|
feedback: {
|
|
272
|
-
uuid: "123e4567-
|
|
273
|
-
relatedObjectUuid: "123e4567-
|
|
276
|
+
uuid: "123e4567-59ff-490e-96c3-230fe4d8f08b",
|
|
277
|
+
relatedObjectUuid: "123e4567-bcac-4403-854b-230fe744c5cb",
|
|
274
278
|
},
|
|
275
279
|
});
|
|
276
280
|
|
|
@@ -300,8 +304,8 @@ async function run() {
|
|
|
300
304
|
const res = await feedbackUpdateFeedback(serviceM8, {
|
|
301
305
|
uuid: "4b9b8627-caa7-402a-94b0-02cb8641823c",
|
|
302
306
|
feedback: {
|
|
303
|
-
uuid: "123e4567-
|
|
304
|
-
relatedObjectUuid: "123e4567-
|
|
307
|
+
uuid: "123e4567-59ff-490e-96c3-230fe4d8f08b",
|
|
308
|
+
relatedObjectUuid: "123e4567-bcac-4403-854b-230fe744c5cb",
|
|
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="deleteFeedback" method="delete" path="/feedback/{uuid}.json" -->
|
|
348
353
|
```typescript
|
|
349
354
|
import { ServiceM8 } from "servicem8";
|
|
350
355
|
|
|
@@ -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="listFormFields" method="get" path="/formfield.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="createFormFields" method="post" path="/formfield.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.formFields.createFormFields({
|
|
114
|
-
uuid: "123e4567-
|
|
115
|
-
formUuid: "123e4567-
|
|
116
|
+
uuid: "123e4567-282e-4ec5-a702-230feb38dcab",
|
|
117
|
+
formUuid: "123e4567-d289-4641-8528-230fed7a7a6b",
|
|
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 formFieldsCreateFormFields(serviceM8, {
|
|
142
|
-
uuid: "123e4567-
|
|
143
|
-
formUuid: "123e4567-
|
|
144
|
+
uuid: "123e4567-282e-4ec5-a702-230feb38dcab",
|
|
145
|
+
formUuid: "123e4567-d289-4641-8528-230fed7a7a6b",
|
|
144
146
|
});
|
|
145
147
|
if (res.ok) {
|
|
146
148
|
const { value: result } = res;
|
|
@@ -179,6 +181,7 @@ Retrieve a Form Field
|
|
|
179
181
|
|
|
180
182
|
### Example Usage
|
|
181
183
|
|
|
184
|
+
<!-- UsageSnippet language="typescript" operationID="getFormFields" method="get" path="/formfield/{uuid}.json" -->
|
|
182
185
|
```typescript
|
|
183
186
|
import { ServiceM8 } from "servicem8";
|
|
184
187
|
|
|
@@ -256,6 +259,7 @@ Update a Form Field
|
|
|
256
259
|
|
|
257
260
|
### Example Usage
|
|
258
261
|
|
|
262
|
+
<!-- UsageSnippet language="typescript" operationID="updateFormFields" method="post" path="/formfield/{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.formFields.updateFormFields({
|
|
270
274
|
uuid: "21a23c6a-1fd9-4be5-84ed-065250f0e6a3",
|
|
271
275
|
formField: {
|
|
272
|
-
uuid: "123e4567-
|
|
273
|
-
formUuid: "123e4567-
|
|
276
|
+
uuid: "123e4567-282e-4ec5-a702-230feb38dcab",
|
|
277
|
+
formUuid: "123e4567-d289-4641-8528-230fed7a7a6b",
|
|
274
278
|
},
|
|
275
279
|
});
|
|
276
280
|
|
|
@@ -300,8 +304,8 @@ async function run() {
|
|
|
300
304
|
const res = await formFieldsUpdateFormFields(serviceM8, {
|
|
301
305
|
uuid: "21a23c6a-1fd9-4be5-84ed-065250f0e6a3",
|
|
302
306
|
formField: {
|
|
303
|
-
uuid: "123e4567-
|
|
304
|
-
formUuid: "123e4567-
|
|
307
|
+
uuid: "123e4567-282e-4ec5-a702-230feb38dcab",
|
|
308
|
+
formUuid: "123e4567-d289-4641-8528-230fed7a7a6b",
|
|
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="deleteFormFields" method="delete" path="/formfield/{uuid}.json" -->
|
|
348
353
|
```typescript
|
|
349
354
|
import { ServiceM8 } from "servicem8";
|
|
350
355
|
|