servicem8 0.7.0 → 0.9.0
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/README.md +0 -10
- package/api.json +629 -1076
- package/bin/mcp-server.js +532 -1359
- package/bin/mcp-server.js.map +8 -24
- 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.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/server.js +10 -20
- package/dist/commonjs/mcp-server/server.js.map +1 -1
- package/dist/commonjs/models/components/index.d.ts +0 -1
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +0 -1
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/operations/index.d.ts +0 -5
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +0 -5
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/sdk/jobtemplates.d.ts +0 -54
- package/dist/commonjs/sdk/jobtemplates.d.ts.map +1 -1
- package/dist/commonjs/sdk/jobtemplates.js +0 -68
- package/dist/commonjs/sdk/jobtemplates.js.map +1 -1
- package/dist/commonjs/sdk/sdk.d.ts +4 -4
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +6 -6
- package/dist/commonjs/sdk/sdk.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.d.ts.map +1 -1
- package/dist/esm/mcp-server/server.js +10 -20
- package/dist/esm/mcp-server/server.js.map +1 -1
- package/dist/esm/models/components/index.d.ts +0 -1
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +0 -1
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/operations/index.d.ts +0 -5
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +0 -5
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/sdk/jobtemplates.d.ts +0 -54
- package/dist/esm/sdk/jobtemplates.d.ts.map +1 -1
- package/dist/esm/sdk/jobtemplates.js +0 -68
- package/dist/esm/sdk/jobtemplates.js.map +1 -1
- package/dist/esm/sdk/sdk.d.ts +4 -4
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +6 -6
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/docs/sdks/allocationwindows/README.md +4 -4
- package/docs/sdks/assets/README.md +6 -6
- package/docs/sdks/assettypefields/README.md +8 -8
- package/docs/sdks/assettypes/README.md +4 -4
- package/docs/sdks/attachments/README.md +12 -12
- package/docs/sdks/badges/README.md +12 -12
- package/docs/sdks/bundles/README.md +4 -4
- package/docs/sdks/categories/README.md +4 -4
- package/docs/sdks/clients/README.md +8 -8
- package/docs/sdks/companycontacts/README.md +8 -8
- package/docs/sdks/emailtemplates/README.md +4 -4
- package/docs/sdks/feedback/README.md +8 -8
- package/docs/sdks/formfields/README.md +8 -8
- package/docs/sdks/formresponses/README.md +28 -28
- package/docs/sdks/forms/README.md +8 -8
- package/docs/sdks/jobactivities/README.md +20 -20
- package/docs/sdks/joballocations/README.md +24 -24
- package/docs/sdks/jobchecklists/README.md +32 -32
- package/docs/sdks/jobcontacts/README.md +8 -8
- package/docs/sdks/jobmaterialbundles/README.md +12 -12
- package/docs/sdks/jobmaterials/README.md +20 -20
- package/docs/sdks/jobpayments/README.md +16 -16
- package/docs/sdks/jobqueues/README.md +4 -4
- package/docs/sdks/jobs/README.md +32 -32
- package/docs/sdks/jobtemplates/README.md +0 -431
- package/docs/sdks/knowledgearticles/README.md +4 -4
- package/docs/sdks/locations/README.md +4 -4
- package/docs/sdks/materials/README.md +8 -8
- package/docs/sdks/notes/README.md +12 -12
- package/docs/sdks/securityroles/README.md +4 -4
- package/docs/sdks/smstemplates/README.md +4 -4
- package/docs/sdks/staffmembers/README.md +12 -12
- package/docs/sdks/staffmessages/README.md +16 -16
- package/docs/sdks/tasks/README.md +20 -20
- package/docs/sdks/taxrates/README.md +4 -4
- package/docs/sdks/vendors/README.md +2 -2
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +10 -20
- package/src/models/components/index.ts +0 -1
- package/src/models/operations/index.ts +0 -5
- package/src/sdk/jobtemplates.ts +0 -107
- package/src/sdk/sdk.ts +10 -10
- package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.d.ts +0 -24
- package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.js +0 -138
- package/dist/commonjs/funcs/jobTemplatesCreateJobTemplates.js.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.d.ts +0 -22
- package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.js +0 -136
- package/dist/commonjs/funcs/jobTemplatesDeleteJobTemplates.js.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesGetJobTemplates.d.ts +0 -20
- package/dist/commonjs/funcs/jobTemplatesGetJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesGetJobTemplates.js +0 -134
- package/dist/commonjs/funcs/jobTemplatesGetJobTemplates.js.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesListJobTemplates.d.ts +0 -23
- package/dist/commonjs/funcs/jobTemplatesListJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesListJobTemplates.js +0 -122
- package/dist/commonjs/funcs/jobTemplatesListJobTemplates.js.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.d.ts +0 -20
- package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.js +0 -135
- package/dist/commonjs/funcs/jobTemplatesUpdateJobTemplates.js.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts +0 -8
- package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.js +0 -74
- package/dist/commonjs/mcp-server/tools/jobTemplatesCreateJobTemplates.js.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts +0 -8
- package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.js +0 -73
- package/dist/commonjs/mcp-server/tools/jobTemplatesDeleteJobTemplates.js.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesGetJobTemplates.d.ts +0 -8
- package/dist/commonjs/mcp-server/tools/jobTemplatesGetJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesGetJobTemplates.js +0 -69
- package/dist/commonjs/mcp-server/tools/jobTemplatesGetJobTemplates.js.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesListJobTemplates.d.ts +0 -3
- package/dist/commonjs/mcp-server/tools/jobTemplatesListJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesListJobTemplates.js +0 -35
- package/dist/commonjs/mcp-server/tools/jobTemplatesListJobTemplates.js.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts +0 -8
- package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts.map +0 -1
- package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.js +0 -69
- package/dist/commonjs/mcp-server/tools/jobTemplatesUpdateJobTemplates.js.map +0 -1
- package/dist/commonjs/models/components/jobtemplate.d.ts +0 -111
- package/dist/commonjs/models/components/jobtemplate.d.ts.map +0 -1
- package/dist/commonjs/models/components/jobtemplate.js +0 -137
- package/dist/commonjs/models/components/jobtemplate.js.map +0 -1
- package/dist/commonjs/models/operations/createjobtemplates.d.ts +0 -57
- package/dist/commonjs/models/operations/createjobtemplates.d.ts.map +0 -1
- package/dist/commonjs/models/operations/createjobtemplates.js +0 -115
- package/dist/commonjs/models/operations/createjobtemplates.js.map +0 -1
- package/dist/commonjs/models/operations/deletejobtemplates.d.ts +0 -54
- package/dist/commonjs/models/operations/deletejobtemplates.d.ts.map +0 -1
- package/dist/commonjs/models/operations/deletejobtemplates.js +0 -96
- package/dist/commonjs/models/operations/deletejobtemplates.js.map +0 -1
- package/dist/commonjs/models/operations/getjobtemplates.d.ts +0 -54
- package/dist/commonjs/models/operations/getjobtemplates.d.ts.map +0 -1
- package/dist/commonjs/models/operations/getjobtemplates.js +0 -99
- package/dist/commonjs/models/operations/getjobtemplates.js.map +0 -1
- package/dist/commonjs/models/operations/listjobtemplates.d.ts +0 -26
- package/dist/commonjs/models/operations/listjobtemplates.d.ts.map +0 -1
- package/dist/commonjs/models/operations/listjobtemplates.js +0 -72
- package/dist/commonjs/models/operations/listjobtemplates.js.map +0 -1
- package/dist/commonjs/models/operations/updatejobtemplates.d.ts +0 -59
- package/dist/commonjs/models/operations/updatejobtemplates.d.ts.map +0 -1
- package/dist/commonjs/models/operations/updatejobtemplates.js +0 -107
- package/dist/commonjs/models/operations/updatejobtemplates.js.map +0 -1
- package/dist/esm/funcs/jobTemplatesCreateJobTemplates.d.ts +0 -24
- package/dist/esm/funcs/jobTemplatesCreateJobTemplates.d.ts.map +0 -1
- package/dist/esm/funcs/jobTemplatesCreateJobTemplates.js +0 -102
- package/dist/esm/funcs/jobTemplatesCreateJobTemplates.js.map +0 -1
- package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.d.ts +0 -22
- package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.d.ts.map +0 -1
- package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.js +0 -100
- package/dist/esm/funcs/jobTemplatesDeleteJobTemplates.js.map +0 -1
- package/dist/esm/funcs/jobTemplatesGetJobTemplates.d.ts +0 -20
- package/dist/esm/funcs/jobTemplatesGetJobTemplates.d.ts.map +0 -1
- package/dist/esm/funcs/jobTemplatesGetJobTemplates.js +0 -98
- package/dist/esm/funcs/jobTemplatesGetJobTemplates.js.map +0 -1
- package/dist/esm/funcs/jobTemplatesListJobTemplates.d.ts +0 -23
- package/dist/esm/funcs/jobTemplatesListJobTemplates.d.ts.map +0 -1
- package/dist/esm/funcs/jobTemplatesListJobTemplates.js +0 -86
- package/dist/esm/funcs/jobTemplatesListJobTemplates.js.map +0 -1
- package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.d.ts +0 -20
- package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.d.ts.map +0 -1
- package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.js +0 -99
- package/dist/esm/funcs/jobTemplatesUpdateJobTemplates.js.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts +0 -8
- package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.d.ts.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.js +0 -38
- package/dist/esm/mcp-server/tools/jobTemplatesCreateJobTemplates.js.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts +0 -8
- package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.d.ts.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.js +0 -37
- package/dist/esm/mcp-server/tools/jobTemplatesDeleteJobTemplates.js.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesGetJobTemplates.d.ts +0 -8
- package/dist/esm/mcp-server/tools/jobTemplatesGetJobTemplates.d.ts.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesGetJobTemplates.js +0 -33
- package/dist/esm/mcp-server/tools/jobTemplatesGetJobTemplates.js.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesListJobTemplates.d.ts +0 -3
- package/dist/esm/mcp-server/tools/jobTemplatesListJobTemplates.d.ts.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesListJobTemplates.js +0 -32
- package/dist/esm/mcp-server/tools/jobTemplatesListJobTemplates.js.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts +0 -8
- package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.d.ts.map +0 -1
- package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.js +0 -33
- package/dist/esm/mcp-server/tools/jobTemplatesUpdateJobTemplates.js.map +0 -1
- package/dist/esm/models/components/jobtemplate.d.ts +0 -111
- package/dist/esm/models/components/jobtemplate.d.ts.map +0 -1
- package/dist/esm/models/components/jobtemplate.js +0 -97
- package/dist/esm/models/components/jobtemplate.js.map +0 -1
- package/dist/esm/models/operations/createjobtemplates.d.ts +0 -57
- package/dist/esm/models/operations/createjobtemplates.d.ts.map +0 -1
- package/dist/esm/models/operations/createjobtemplates.js +0 -75
- package/dist/esm/models/operations/createjobtemplates.js.map +0 -1
- package/dist/esm/models/operations/deletejobtemplates.d.ts +0 -54
- package/dist/esm/models/operations/deletejobtemplates.d.ts.map +0 -1
- package/dist/esm/models/operations/deletejobtemplates.js +0 -56
- package/dist/esm/models/operations/deletejobtemplates.js.map +0 -1
- package/dist/esm/models/operations/getjobtemplates.d.ts +0 -54
- package/dist/esm/models/operations/getjobtemplates.d.ts.map +0 -1
- package/dist/esm/models/operations/getjobtemplates.js +0 -59
- package/dist/esm/models/operations/getjobtemplates.js.map +0 -1
- package/dist/esm/models/operations/listjobtemplates.d.ts +0 -26
- package/dist/esm/models/operations/listjobtemplates.d.ts.map +0 -1
- package/dist/esm/models/operations/listjobtemplates.js +0 -34
- package/dist/esm/models/operations/listjobtemplates.js.map +0 -1
- package/dist/esm/models/operations/updatejobtemplates.d.ts +0 -59
- package/dist/esm/models/operations/updatejobtemplates.d.ts.map +0 -1
- package/dist/esm/models/operations/updatejobtemplates.js +0 -67
- package/dist/esm/models/operations/updatejobtemplates.js.map +0 -1
- package/src/funcs/jobTemplatesCreateJobTemplates.ts +0 -190
- package/src/funcs/jobTemplatesDeleteJobTemplates.ts +0 -189
- package/src/funcs/jobTemplatesGetJobTemplates.ts +0 -187
- package/src/funcs/jobTemplatesListJobTemplates.ts +0 -166
- package/src/funcs/jobTemplatesUpdateJobTemplates.ts +0 -188
- package/src/mcp-server/tools/jobTemplatesCreateJobTemplates.ts +0 -48
- package/src/mcp-server/tools/jobTemplatesDeleteJobTemplates.ts +0 -47
- package/src/mcp-server/tools/jobTemplatesGetJobTemplates.ts +0 -42
- package/src/mcp-server/tools/jobTemplatesListJobTemplates.ts +0 -39
- package/src/mcp-server/tools/jobTemplatesUpdateJobTemplates.ts +0 -43
- package/src/models/components/jobtemplate.ts +0 -198
- package/src/models/operations/createjobtemplates.ts +0 -147
- package/src/models/operations/deletejobtemplates.ts +0 -125
- package/src/models/operations/getjobtemplates.ts +0 -130
- package/src/models/operations/listjobtemplates.ts +0 -69
- package/src/models/operations/updatejobtemplates.ts +0 -141
package/docs/sdks/jobs/README.md
CHANGED
|
@@ -121,25 +121,25 @@ const serviceM8 = new ServiceM8({
|
|
|
121
121
|
|
|
122
122
|
async function run() {
|
|
123
123
|
const result = await serviceM8.jobs.createJobs({
|
|
124
|
-
createdByStaffUuid: "123e4567-
|
|
124
|
+
createdByStaffUuid: "123e4567-17ed-499e-b5cc-22fd8922cb5b",
|
|
125
125
|
date: "YYYY-MM-DD",
|
|
126
|
-
companyUuid: "123e4567-
|
|
126
|
+
companyUuid: "123e4567-9737-4bff-bead-22fd8f6ea44b",
|
|
127
127
|
status: "Unsuccessful",
|
|
128
128
|
paymentDate: "2025-07-01 12:00:00",
|
|
129
|
-
paymentActionedByUuid: "123e4567-
|
|
130
|
-
categoryUuid: "123e4567-
|
|
129
|
+
paymentActionedByUuid: "123e4567-5ce8-4ed9-8d01-22fd8715648b",
|
|
130
|
+
categoryUuid: "123e4567-442a-41cd-8595-22fd8ce7341b",
|
|
131
131
|
invoiceSentStamp: "2025-07-01 12:00:00",
|
|
132
|
-
queueUuid: "123e4567-
|
|
132
|
+
queueUuid: "123e4567-d015-4766-9b61-22fd88eedb5b",
|
|
133
133
|
queueExpiryDate: "2025-07-01 12:00:00",
|
|
134
|
-
queueAssignedStaffUuid: "123e4567-
|
|
134
|
+
queueAssignedStaffUuid: "123e4567-ba50-40b3-afd9-22fd87c1ccab",
|
|
135
135
|
quoteDate: "2025-07-01 12:00:00",
|
|
136
136
|
quoteSentStamp: "2025-07-01 12:00:00",
|
|
137
137
|
workOrderDate: "2025-07-01 12:00:00",
|
|
138
|
-
uuid: "123e4567-
|
|
138
|
+
uuid: "123e4567-9ddd-4a1f-a368-22fd8fb2797b",
|
|
139
139
|
paymentProcessedStamp: "2025-07-01 12:00:00",
|
|
140
140
|
paymentReceivedStamp: "2025-07-01 12:00:00",
|
|
141
141
|
completionDate: "2025-07-01 12:00:00",
|
|
142
|
-
completionActionedByUuid: "123e4567-
|
|
142
|
+
completionActionedByUuid: "123e4567-b501-4400-be53-22fd83e6a36b",
|
|
143
143
|
unsuccessfulDate: "2025-07-01 12:00:00",
|
|
144
144
|
jobIsScheduledUntilStamp: "2025-07-01 12:00:00",
|
|
145
145
|
});
|
|
@@ -168,25 +168,25 @@ const serviceM8 = new ServiceM8Core({
|
|
|
168
168
|
|
|
169
169
|
async function run() {
|
|
170
170
|
const res = await jobsCreateJobs(serviceM8, {
|
|
171
|
-
createdByStaffUuid: "123e4567-
|
|
171
|
+
createdByStaffUuid: "123e4567-17ed-499e-b5cc-22fd8922cb5b",
|
|
172
172
|
date: "YYYY-MM-DD",
|
|
173
|
-
companyUuid: "123e4567-
|
|
173
|
+
companyUuid: "123e4567-9737-4bff-bead-22fd8f6ea44b",
|
|
174
174
|
status: "Unsuccessful",
|
|
175
175
|
paymentDate: "2025-07-01 12:00:00",
|
|
176
|
-
paymentActionedByUuid: "123e4567-
|
|
177
|
-
categoryUuid: "123e4567-
|
|
176
|
+
paymentActionedByUuid: "123e4567-5ce8-4ed9-8d01-22fd8715648b",
|
|
177
|
+
categoryUuid: "123e4567-442a-41cd-8595-22fd8ce7341b",
|
|
178
178
|
invoiceSentStamp: "2025-07-01 12:00:00",
|
|
179
|
-
queueUuid: "123e4567-
|
|
179
|
+
queueUuid: "123e4567-d015-4766-9b61-22fd88eedb5b",
|
|
180
180
|
queueExpiryDate: "2025-07-01 12:00:00",
|
|
181
|
-
queueAssignedStaffUuid: "123e4567-
|
|
181
|
+
queueAssignedStaffUuid: "123e4567-ba50-40b3-afd9-22fd87c1ccab",
|
|
182
182
|
quoteDate: "2025-07-01 12:00:00",
|
|
183
183
|
quoteSentStamp: "2025-07-01 12:00:00",
|
|
184
184
|
workOrderDate: "2025-07-01 12:00:00",
|
|
185
|
-
uuid: "123e4567-
|
|
185
|
+
uuid: "123e4567-9ddd-4a1f-a368-22fd8fb2797b",
|
|
186
186
|
paymentProcessedStamp: "2025-07-01 12:00:00",
|
|
187
187
|
paymentReceivedStamp: "2025-07-01 12:00:00",
|
|
188
188
|
completionDate: "2025-07-01 12:00:00",
|
|
189
|
-
completionActionedByUuid: "123e4567-
|
|
189
|
+
completionActionedByUuid: "123e4567-b501-4400-be53-22fd83e6a36b",
|
|
190
190
|
unsuccessfulDate: "2025-07-01 12:00:00",
|
|
191
191
|
jobIsScheduledUntilStamp: "2025-07-01 12:00:00",
|
|
192
192
|
});
|
|
@@ -327,25 +327,25 @@ async function run() {
|
|
|
327
327
|
const result = await serviceM8.jobs.updateJobs({
|
|
328
328
|
uuid: "f751bf5c-f1f2-4a20-8df3-7628082340b1",
|
|
329
329
|
job: {
|
|
330
|
-
createdByStaffUuid: "123e4567-
|
|
330
|
+
createdByStaffUuid: "123e4567-17ed-499e-b5cc-22fd8922cb5b",
|
|
331
331
|
date: "YYYY-MM-DD",
|
|
332
|
-
companyUuid: "123e4567-
|
|
332
|
+
companyUuid: "123e4567-9737-4bff-bead-22fd8f6ea44b",
|
|
333
333
|
status: "Work Order",
|
|
334
334
|
paymentDate: "2025-07-01 12:00:00",
|
|
335
|
-
paymentActionedByUuid: "123e4567-
|
|
336
|
-
categoryUuid: "123e4567-
|
|
335
|
+
paymentActionedByUuid: "123e4567-5ce8-4ed9-8d01-22fd8715648b",
|
|
336
|
+
categoryUuid: "123e4567-442a-41cd-8595-22fd8ce7341b",
|
|
337
337
|
invoiceSentStamp: "2025-07-01 12:00:00",
|
|
338
|
-
queueUuid: "123e4567-
|
|
338
|
+
queueUuid: "123e4567-d015-4766-9b61-22fd88eedb5b",
|
|
339
339
|
queueExpiryDate: "2025-07-01 12:00:00",
|
|
340
|
-
queueAssignedStaffUuid: "123e4567-
|
|
340
|
+
queueAssignedStaffUuid: "123e4567-ba50-40b3-afd9-22fd87c1ccab",
|
|
341
341
|
quoteDate: "2025-07-01 12:00:00",
|
|
342
342
|
quoteSentStamp: "2025-07-01 12:00:00",
|
|
343
343
|
workOrderDate: "2025-07-01 12:00:00",
|
|
344
|
-
uuid: "123e4567-
|
|
344
|
+
uuid: "123e4567-9ddd-4a1f-a368-22fd8fb2797b",
|
|
345
345
|
paymentProcessedStamp: "2025-07-01 12:00:00",
|
|
346
346
|
paymentReceivedStamp: "2025-07-01 12:00:00",
|
|
347
347
|
completionDate: "2025-07-01 12:00:00",
|
|
348
|
-
completionActionedByUuid: "123e4567-
|
|
348
|
+
completionActionedByUuid: "123e4567-b501-4400-be53-22fd83e6a36b",
|
|
349
349
|
unsuccessfulDate: "2025-07-01 12:00:00",
|
|
350
350
|
jobIsScheduledUntilStamp: "2025-07-01 12:00:00",
|
|
351
351
|
},
|
|
@@ -377,25 +377,25 @@ async function run() {
|
|
|
377
377
|
const res = await jobsUpdateJobs(serviceM8, {
|
|
378
378
|
uuid: "f751bf5c-f1f2-4a20-8df3-7628082340b1",
|
|
379
379
|
job: {
|
|
380
|
-
createdByStaffUuid: "123e4567-
|
|
380
|
+
createdByStaffUuid: "123e4567-17ed-499e-b5cc-22fd8922cb5b",
|
|
381
381
|
date: "YYYY-MM-DD",
|
|
382
|
-
companyUuid: "123e4567-
|
|
382
|
+
companyUuid: "123e4567-9737-4bff-bead-22fd8f6ea44b",
|
|
383
383
|
status: "Work Order",
|
|
384
384
|
paymentDate: "2025-07-01 12:00:00",
|
|
385
|
-
paymentActionedByUuid: "123e4567-
|
|
386
|
-
categoryUuid: "123e4567-
|
|
385
|
+
paymentActionedByUuid: "123e4567-5ce8-4ed9-8d01-22fd8715648b",
|
|
386
|
+
categoryUuid: "123e4567-442a-41cd-8595-22fd8ce7341b",
|
|
387
387
|
invoiceSentStamp: "2025-07-01 12:00:00",
|
|
388
|
-
queueUuid: "123e4567-
|
|
388
|
+
queueUuid: "123e4567-d015-4766-9b61-22fd88eedb5b",
|
|
389
389
|
queueExpiryDate: "2025-07-01 12:00:00",
|
|
390
|
-
queueAssignedStaffUuid: "123e4567-
|
|
390
|
+
queueAssignedStaffUuid: "123e4567-ba50-40b3-afd9-22fd87c1ccab",
|
|
391
391
|
quoteDate: "2025-07-01 12:00:00",
|
|
392
392
|
quoteSentStamp: "2025-07-01 12:00:00",
|
|
393
393
|
workOrderDate: "2025-07-01 12:00:00",
|
|
394
|
-
uuid: "123e4567-
|
|
394
|
+
uuid: "123e4567-9ddd-4a1f-a368-22fd8fb2797b",
|
|
395
395
|
paymentProcessedStamp: "2025-07-01 12:00:00",
|
|
396
396
|
paymentReceivedStamp: "2025-07-01 12:00:00",
|
|
397
397
|
completionDate: "2025-07-01 12:00:00",
|
|
398
|
-
completionActionedByUuid: "123e4567-
|
|
398
|
+
completionActionedByUuid: "123e4567-b501-4400-be53-22fd83e6a36b",
|
|
399
399
|
unsuccessfulDate: "2025-07-01 12:00:00",
|
|
400
400
|
jobIsScheduledUntilStamp: "2025-07-01 12:00:00",
|
|
401
401
|
},
|
|
@@ -3,441 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
## Overview
|
|
5
5
|
|
|
6
|
-
Operations related to Job Templates
|
|
7
|
-
|
|
8
6
|
### Available Operations
|
|
9
7
|
|
|
10
|
-
* [listJobTemplates](#listjobtemplates) - List all Job Templates
|
|
11
|
-
* [createJobTemplates](#createjobtemplates) - Create a new Job Template
|
|
12
|
-
* [getJobTemplates](#getjobtemplates) - Retrieve a Job Template
|
|
13
|
-
* [updateJobTemplates](#updatejobtemplates) - Update a Job Template
|
|
14
|
-
* [deleteJobTemplates](#deletejobtemplates) - Delete a Job Template
|
|
15
8
|
* [createJobFromTemplate](#createjobfromtemplate) - Create a job from a template
|
|
16
9
|
|
|
17
|
-
## listJobTemplates
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
#### Filtering
|
|
22
|
-
This endpoint supports result filtering. For more information on how to filter this request, [go here](/docs/filtering).
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
#### OAuth Scope
|
|
26
|
-
This endpoint requires the following OAuth scope **read_jobs**.
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
### Example Usage
|
|
31
|
-
|
|
32
|
-
```typescript
|
|
33
|
-
import { ServiceM8 } from "servicem8";
|
|
34
|
-
|
|
35
|
-
const serviceM8 = new ServiceM8({
|
|
36
|
-
security: {
|
|
37
|
-
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
38
|
-
},
|
|
39
|
-
});
|
|
40
|
-
|
|
41
|
-
async function run() {
|
|
42
|
-
const result = await serviceM8.jobTemplates.listJobTemplates();
|
|
43
|
-
|
|
44
|
-
console.log(result);
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
run();
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### Standalone function
|
|
51
|
-
|
|
52
|
-
The standalone function version of this method:
|
|
53
|
-
|
|
54
|
-
```typescript
|
|
55
|
-
import { ServiceM8Core } from "servicem8/core.js";
|
|
56
|
-
import { jobTemplatesListJobTemplates } from "servicem8/funcs/jobTemplatesListJobTemplates.js";
|
|
57
|
-
|
|
58
|
-
// Use `ServiceM8Core` for best tree-shaking performance.
|
|
59
|
-
// You can create one instance of it to use across an application.
|
|
60
|
-
const serviceM8 = new ServiceM8Core({
|
|
61
|
-
security: {
|
|
62
|
-
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
63
|
-
},
|
|
64
|
-
});
|
|
65
|
-
|
|
66
|
-
async function run() {
|
|
67
|
-
const res = await jobTemplatesListJobTemplates(serviceM8);
|
|
68
|
-
if (res.ok) {
|
|
69
|
-
const { value: result } = res;
|
|
70
|
-
console.log(result);
|
|
71
|
-
} else {
|
|
72
|
-
console.log("jobTemplatesListJobTemplates failed:", res.error);
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
run();
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
### Parameters
|
|
80
|
-
|
|
81
|
-
| Parameter | Type | Required | Description |
|
|
82
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
83
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
84
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
85
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
86
|
-
|
|
87
|
-
### Response
|
|
88
|
-
|
|
89
|
-
**Promise\<[operations.ListJobTemplatesResponse](../../models/operations/listjobtemplatesresponse.md)\>**
|
|
90
|
-
|
|
91
|
-
### Errors
|
|
92
|
-
|
|
93
|
-
| Error Type | Status Code | Content Type |
|
|
94
|
-
| ---------------- | ---------------- | ---------------- |
|
|
95
|
-
| errors.ErrorT | 400 | application/json |
|
|
96
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
97
|
-
|
|
98
|
-
## createJobTemplates
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
#### OAuth Scope
|
|
103
|
-
This endpoint requires the following OAuth scope **manage_jobs**.
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
#### Record UUID
|
|
108
|
-
UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the `x-record-uuid` response header.
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
### Example Usage
|
|
113
|
-
|
|
114
|
-
```typescript
|
|
115
|
-
import { ServiceM8 } from "servicem8";
|
|
116
|
-
|
|
117
|
-
const serviceM8 = new ServiceM8({
|
|
118
|
-
security: {
|
|
119
|
-
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
120
|
-
},
|
|
121
|
-
});
|
|
122
|
-
|
|
123
|
-
async function run() {
|
|
124
|
-
const result = await serviceM8.jobTemplates.createJobTemplates({
|
|
125
|
-
uuid: "123e4567-92df-4f73-b4a2-22fc0bccb61b",
|
|
126
|
-
});
|
|
127
|
-
|
|
128
|
-
console.log(result);
|
|
129
|
-
}
|
|
130
|
-
|
|
131
|
-
run();
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
### Standalone function
|
|
135
|
-
|
|
136
|
-
The standalone function version of this method:
|
|
137
|
-
|
|
138
|
-
```typescript
|
|
139
|
-
import { ServiceM8Core } from "servicem8/core.js";
|
|
140
|
-
import { jobTemplatesCreateJobTemplates } from "servicem8/funcs/jobTemplatesCreateJobTemplates.js";
|
|
141
|
-
|
|
142
|
-
// Use `ServiceM8Core` for best tree-shaking performance.
|
|
143
|
-
// You can create one instance of it to use across an application.
|
|
144
|
-
const serviceM8 = new ServiceM8Core({
|
|
145
|
-
security: {
|
|
146
|
-
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
147
|
-
},
|
|
148
|
-
});
|
|
149
|
-
|
|
150
|
-
async function run() {
|
|
151
|
-
const res = await jobTemplatesCreateJobTemplates(serviceM8, {
|
|
152
|
-
uuid: "123e4567-92df-4f73-b4a2-22fc0bccb61b",
|
|
153
|
-
});
|
|
154
|
-
if (res.ok) {
|
|
155
|
-
const { value: result } = res;
|
|
156
|
-
console.log(result);
|
|
157
|
-
} else {
|
|
158
|
-
console.log("jobTemplatesCreateJobTemplates failed:", res.error);
|
|
159
|
-
}
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
run();
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
### Parameters
|
|
166
|
-
|
|
167
|
-
| Parameter | Type | Required | Description |
|
|
168
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
169
|
-
| `request` | [components.JobTemplateInput](../../models/components/jobtemplateinput.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
170
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
171
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
172
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
173
|
-
|
|
174
|
-
### Response
|
|
175
|
-
|
|
176
|
-
**Promise\<[operations.CreateJobTemplatesResponse](../../models/operations/createjobtemplatesresponse.md)\>**
|
|
177
|
-
|
|
178
|
-
### Errors
|
|
179
|
-
|
|
180
|
-
| Error Type | Status Code | Content Type |
|
|
181
|
-
| ---------------- | ---------------- | ---------------- |
|
|
182
|
-
| errors.ErrorT | 400 | application/json |
|
|
183
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
184
|
-
|
|
185
|
-
## getJobTemplates
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
#### OAuth Scope
|
|
190
|
-
This endpoint requires the following OAuth scope **read_jobs**.
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
### Example Usage
|
|
195
|
-
|
|
196
|
-
```typescript
|
|
197
|
-
import { ServiceM8 } from "servicem8";
|
|
198
|
-
|
|
199
|
-
const serviceM8 = new ServiceM8({
|
|
200
|
-
security: {
|
|
201
|
-
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
202
|
-
},
|
|
203
|
-
});
|
|
204
|
-
|
|
205
|
-
async function run() {
|
|
206
|
-
const result = await serviceM8.jobTemplates.getJobTemplates({
|
|
207
|
-
uuid: "e49a9f4e-3739-4ad4-9990-80e39f58eba8",
|
|
208
|
-
});
|
|
209
|
-
|
|
210
|
-
console.log(result);
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
run();
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
### Standalone function
|
|
217
|
-
|
|
218
|
-
The standalone function version of this method:
|
|
219
|
-
|
|
220
|
-
```typescript
|
|
221
|
-
import { ServiceM8Core } from "servicem8/core.js";
|
|
222
|
-
import { jobTemplatesGetJobTemplates } from "servicem8/funcs/jobTemplatesGetJobTemplates.js";
|
|
223
|
-
|
|
224
|
-
// Use `ServiceM8Core` for best tree-shaking performance.
|
|
225
|
-
// You can create one instance of it to use across an application.
|
|
226
|
-
const serviceM8 = new ServiceM8Core({
|
|
227
|
-
security: {
|
|
228
|
-
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
229
|
-
},
|
|
230
|
-
});
|
|
231
|
-
|
|
232
|
-
async function run() {
|
|
233
|
-
const res = await jobTemplatesGetJobTemplates(serviceM8, {
|
|
234
|
-
uuid: "e49a9f4e-3739-4ad4-9990-80e39f58eba8",
|
|
235
|
-
});
|
|
236
|
-
if (res.ok) {
|
|
237
|
-
const { value: result } = res;
|
|
238
|
-
console.log(result);
|
|
239
|
-
} else {
|
|
240
|
-
console.log("jobTemplatesGetJobTemplates failed:", res.error);
|
|
241
|
-
}
|
|
242
|
-
}
|
|
243
|
-
|
|
244
|
-
run();
|
|
245
|
-
```
|
|
246
|
-
|
|
247
|
-
### Parameters
|
|
248
|
-
|
|
249
|
-
| Parameter | Type | Required | Description |
|
|
250
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
251
|
-
| `request` | [operations.GetJobTemplatesRequest](../../models/operations/getjobtemplatesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
252
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
253
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
254
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
255
|
-
|
|
256
|
-
### Response
|
|
257
|
-
|
|
258
|
-
**Promise\<[operations.GetJobTemplatesResponse](../../models/operations/getjobtemplatesresponse.md)\>**
|
|
259
|
-
|
|
260
|
-
### Errors
|
|
261
|
-
|
|
262
|
-
| Error Type | Status Code | Content Type |
|
|
263
|
-
| ---------------- | ---------------- | ---------------- |
|
|
264
|
-
| errors.ErrorT | 400 | application/json |
|
|
265
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
266
|
-
|
|
267
|
-
## updateJobTemplates
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
#### OAuth Scope
|
|
272
|
-
This endpoint requires the following OAuth scope **manage_jobs**.
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
### Example Usage
|
|
277
|
-
|
|
278
|
-
```typescript
|
|
279
|
-
import { ServiceM8 } from "servicem8";
|
|
280
|
-
|
|
281
|
-
const serviceM8 = new ServiceM8({
|
|
282
|
-
security: {
|
|
283
|
-
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
284
|
-
},
|
|
285
|
-
});
|
|
286
|
-
|
|
287
|
-
async function run() {
|
|
288
|
-
const result = await serviceM8.jobTemplates.updateJobTemplates({
|
|
289
|
-
uuid: "c3cda462-77ac-4f6b-96fc-278f0e8e4121",
|
|
290
|
-
jobTemplate: {
|
|
291
|
-
uuid: "123e4567-92df-4f73-b4a2-22fc0bccb61b",
|
|
292
|
-
},
|
|
293
|
-
});
|
|
294
|
-
|
|
295
|
-
console.log(result);
|
|
296
|
-
}
|
|
297
|
-
|
|
298
|
-
run();
|
|
299
|
-
```
|
|
300
|
-
|
|
301
|
-
### Standalone function
|
|
302
|
-
|
|
303
|
-
The standalone function version of this method:
|
|
304
|
-
|
|
305
|
-
```typescript
|
|
306
|
-
import { ServiceM8Core } from "servicem8/core.js";
|
|
307
|
-
import { jobTemplatesUpdateJobTemplates } from "servicem8/funcs/jobTemplatesUpdateJobTemplates.js";
|
|
308
|
-
|
|
309
|
-
// Use `ServiceM8Core` for best tree-shaking performance.
|
|
310
|
-
// You can create one instance of it to use across an application.
|
|
311
|
-
const serviceM8 = new ServiceM8Core({
|
|
312
|
-
security: {
|
|
313
|
-
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
314
|
-
},
|
|
315
|
-
});
|
|
316
|
-
|
|
317
|
-
async function run() {
|
|
318
|
-
const res = await jobTemplatesUpdateJobTemplates(serviceM8, {
|
|
319
|
-
uuid: "c3cda462-77ac-4f6b-96fc-278f0e8e4121",
|
|
320
|
-
jobTemplate: {
|
|
321
|
-
uuid: "123e4567-92df-4f73-b4a2-22fc0bccb61b",
|
|
322
|
-
},
|
|
323
|
-
});
|
|
324
|
-
if (res.ok) {
|
|
325
|
-
const { value: result } = res;
|
|
326
|
-
console.log(result);
|
|
327
|
-
} else {
|
|
328
|
-
console.log("jobTemplatesUpdateJobTemplates failed:", res.error);
|
|
329
|
-
}
|
|
330
|
-
}
|
|
331
|
-
|
|
332
|
-
run();
|
|
333
|
-
```
|
|
334
|
-
|
|
335
|
-
### Parameters
|
|
336
|
-
|
|
337
|
-
| Parameter | Type | Required | Description |
|
|
338
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
339
|
-
| `request` | [operations.UpdateJobTemplatesRequest](../../models/operations/updatejobtemplatesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
340
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
341
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
342
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
343
|
-
|
|
344
|
-
### Response
|
|
345
|
-
|
|
346
|
-
**Promise\<[operations.UpdateJobTemplatesResponse](../../models/operations/updatejobtemplatesresponse.md)\>**
|
|
347
|
-
|
|
348
|
-
### Errors
|
|
349
|
-
|
|
350
|
-
| Error Type | Status Code | Content Type |
|
|
351
|
-
| ---------------- | ---------------- | ---------------- |
|
|
352
|
-
| errors.ErrorT | 400 | application/json |
|
|
353
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
354
|
-
|
|
355
|
-
## deleteJobTemplates
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
In ServiceM8, deleting a record sets its `active` field to `0`. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their `active` field to `1`.
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
#### OAuth Scope
|
|
364
|
-
This endpoint requires the following OAuth scope **manage_jobs**.
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
### Example Usage
|
|
369
|
-
|
|
370
|
-
```typescript
|
|
371
|
-
import { ServiceM8 } from "servicem8";
|
|
372
|
-
|
|
373
|
-
const serviceM8 = new ServiceM8({
|
|
374
|
-
security: {
|
|
375
|
-
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
376
|
-
},
|
|
377
|
-
});
|
|
378
|
-
|
|
379
|
-
async function run() {
|
|
380
|
-
const result = await serviceM8.jobTemplates.deleteJobTemplates({
|
|
381
|
-
uuid: "5d496bf1-4e89-44b0-bb5d-221123f5cb4f",
|
|
382
|
-
});
|
|
383
|
-
|
|
384
|
-
console.log(result);
|
|
385
|
-
}
|
|
386
|
-
|
|
387
|
-
run();
|
|
388
|
-
```
|
|
389
|
-
|
|
390
|
-
### Standalone function
|
|
391
|
-
|
|
392
|
-
The standalone function version of this method:
|
|
393
|
-
|
|
394
|
-
```typescript
|
|
395
|
-
import { ServiceM8Core } from "servicem8/core.js";
|
|
396
|
-
import { jobTemplatesDeleteJobTemplates } from "servicem8/funcs/jobTemplatesDeleteJobTemplates.js";
|
|
397
|
-
|
|
398
|
-
// Use `ServiceM8Core` for best tree-shaking performance.
|
|
399
|
-
// You can create one instance of it to use across an application.
|
|
400
|
-
const serviceM8 = new ServiceM8Core({
|
|
401
|
-
security: {
|
|
402
|
-
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
403
|
-
},
|
|
404
|
-
});
|
|
405
|
-
|
|
406
|
-
async function run() {
|
|
407
|
-
const res = await jobTemplatesDeleteJobTemplates(serviceM8, {
|
|
408
|
-
uuid: "5d496bf1-4e89-44b0-bb5d-221123f5cb4f",
|
|
409
|
-
});
|
|
410
|
-
if (res.ok) {
|
|
411
|
-
const { value: result } = res;
|
|
412
|
-
console.log(result);
|
|
413
|
-
} else {
|
|
414
|
-
console.log("jobTemplatesDeleteJobTemplates failed:", res.error);
|
|
415
|
-
}
|
|
416
|
-
}
|
|
417
|
-
|
|
418
|
-
run();
|
|
419
|
-
```
|
|
420
|
-
|
|
421
|
-
### Parameters
|
|
422
|
-
|
|
423
|
-
| Parameter | Type | Required | Description |
|
|
424
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
425
|
-
| `request` | [operations.DeleteJobTemplatesRequest](../../models/operations/deletejobtemplatesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
426
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
427
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
428
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
429
|
-
|
|
430
|
-
### Response
|
|
431
|
-
|
|
432
|
-
**Promise\<[operations.DeleteJobTemplatesResponse](../../models/operations/deletejobtemplatesresponse.md)\>**
|
|
433
|
-
|
|
434
|
-
### Errors
|
|
435
|
-
|
|
436
|
-
| Error Type | Status Code | Content Type |
|
|
437
|
-
| ---------------- | ---------------- | ---------------- |
|
|
438
|
-
| errors.ErrorT | 400 | application/json |
|
|
439
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
440
|
-
|
|
441
10
|
## createJobFromTemplate
|
|
442
11
|
|
|
443
12
|
Creates a new job by cloning an existing job template. All template entities (tasks, materials, checklists, quotes, custom fields) are cloned to the new job.
|
|
@@ -121,7 +121,7 @@ const serviceM8 = new ServiceM8({
|
|
|
121
121
|
|
|
122
122
|
async function run() {
|
|
123
123
|
const result = await serviceM8.knowledgeArticles.createKnowledgeArticles({
|
|
124
|
-
uuid: "123e4567-
|
|
124
|
+
uuid: "123e4567-02ce-47cc-a353-22fd851ac5ab",
|
|
125
125
|
name: "<value>",
|
|
126
126
|
});
|
|
127
127
|
|
|
@@ -149,7 +149,7 @@ const serviceM8 = new ServiceM8Core({
|
|
|
149
149
|
|
|
150
150
|
async function run() {
|
|
151
151
|
const res = await knowledgeArticlesCreateKnowledgeArticles(serviceM8, {
|
|
152
|
-
uuid: "123e4567-
|
|
152
|
+
uuid: "123e4567-02ce-47cc-a353-22fd851ac5ab",
|
|
153
153
|
name: "<value>",
|
|
154
154
|
});
|
|
155
155
|
if (res.ok) {
|
|
@@ -289,7 +289,7 @@ async function run() {
|
|
|
289
289
|
const result = await serviceM8.knowledgeArticles.updateKnowledgeArticles({
|
|
290
290
|
uuid: "a643fa14-496b-46a5-88bc-4e67bb92bafd",
|
|
291
291
|
knowledgeArticle: {
|
|
292
|
-
uuid: "123e4567-
|
|
292
|
+
uuid: "123e4567-02ce-47cc-a353-22fd851ac5ab",
|
|
293
293
|
name: "<value>",
|
|
294
294
|
},
|
|
295
295
|
});
|
|
@@ -320,7 +320,7 @@ async function run() {
|
|
|
320
320
|
const res = await knowledgeArticlesUpdateKnowledgeArticles(serviceM8, {
|
|
321
321
|
uuid: "a643fa14-496b-46a5-88bc-4e67bb92bafd",
|
|
322
322
|
knowledgeArticle: {
|
|
323
|
-
uuid: "123e4567-
|
|
323
|
+
uuid: "123e4567-02ce-47cc-a353-22fd851ac5ab",
|
|
324
324
|
name: "<value>",
|
|
325
325
|
},
|
|
326
326
|
});
|