servicem8 0.9.43 → 0.9.44
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 +15 -1
- package/api.json +4076 -2898
- package/bin/mcp-server.js +1965 -718
- package/bin/mcp-server.js.map +32 -11
- package/dist/commonjs/funcs/formResponsesCreateFormResponses.d.ts +24 -0
- package/dist/commonjs/funcs/formResponsesCreateFormResponses.d.ts.map +1 -0
- package/dist/commonjs/funcs/formResponsesCreateFormResponses.js +136 -0
- package/dist/commonjs/funcs/formResponsesCreateFormResponses.js.map +1 -0
- package/dist/commonjs/funcs/formResponsesDeleteFormResponses.d.ts +23 -0
- package/dist/commonjs/funcs/formResponsesDeleteFormResponses.d.ts.map +1 -0
- package/dist/commonjs/funcs/formResponsesDeleteFormResponses.js +137 -0
- package/dist/commonjs/funcs/formResponsesDeleteFormResponses.js.map +1 -0
- package/dist/commonjs/funcs/formResponsesUpdateFormResponses.d.ts +21 -0
- package/dist/commonjs/funcs/formResponsesUpdateFormResponses.d.ts.map +1 -0
- package/dist/commonjs/funcs/formResponsesUpdateFormResponses.js +136 -0
- package/dist/commonjs/funcs/formResponsesUpdateFormResponses.js.map +1 -0
- package/dist/commonjs/funcs/inboxCreateInboxMessage.d.ts +18 -0
- package/dist/commonjs/funcs/inboxCreateInboxMessage.d.ts.map +1 -0
- package/dist/commonjs/funcs/inboxCreateInboxMessage.js +127 -0
- package/dist/commonjs/funcs/inboxCreateInboxMessage.js.map +1 -0
- package/dist/commonjs/funcs/staffMessagesCreateStaffMessages.d.ts +24 -0
- package/dist/commonjs/funcs/staffMessagesCreateStaffMessages.d.ts.map +1 -0
- package/dist/commonjs/funcs/staffMessagesCreateStaffMessages.js +136 -0
- package/dist/commonjs/funcs/staffMessagesCreateStaffMessages.js.map +1 -0
- package/dist/commonjs/funcs/staffMessagesDeleteStaffMessages.d.ts +23 -0
- package/dist/commonjs/funcs/staffMessagesDeleteStaffMessages.d.ts.map +1 -0
- package/dist/commonjs/funcs/staffMessagesDeleteStaffMessages.js +137 -0
- package/dist/commonjs/funcs/staffMessagesDeleteStaffMessages.js.map +1 -0
- package/dist/commonjs/funcs/staffMessagesUpdateStaffMessages.d.ts +21 -0
- package/dist/commonjs/funcs/staffMessagesUpdateStaffMessages.d.ts.map +1 -0
- package/dist/commonjs/funcs/staffMessagesUpdateStaffMessages.js +136 -0
- package/dist/commonjs/funcs/staffMessagesUpdateStaffMessages.js.map +1 -0
- 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 +15 -1
- package/dist/commonjs/mcp-server/server.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/formResponsesCreateFormResponses.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/formResponsesCreateFormResponses.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/formResponsesCreateFormResponses.js +74 -0
- package/dist/commonjs/mcp-server/tools/formResponsesCreateFormResponses.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/formResponsesDeleteFormResponses.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/formResponsesDeleteFormResponses.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/formResponsesDeleteFormResponses.js +73 -0
- package/dist/commonjs/mcp-server/tools/formResponsesDeleteFormResponses.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/formResponsesUpdateFormResponses.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/formResponsesUpdateFormResponses.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/formResponsesUpdateFormResponses.js +69 -0
- package/dist/commonjs/mcp-server/tools/formResponsesUpdateFormResponses.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/inboxCreateInboxMessage.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/inboxCreateInboxMessage.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/inboxCreateInboxMessage.js +64 -0
- package/dist/commonjs/mcp-server/tools/inboxCreateInboxMessage.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/staffMessagesCreateStaffMessages.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/staffMessagesCreateStaffMessages.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/staffMessagesCreateStaffMessages.js +74 -0
- package/dist/commonjs/mcp-server/tools/staffMessagesCreateStaffMessages.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/staffMessagesDeleteStaffMessages.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/staffMessagesDeleteStaffMessages.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/staffMessagesDeleteStaffMessages.js +73 -0
- package/dist/commonjs/mcp-server/tools/staffMessagesDeleteStaffMessages.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/staffMessagesUpdateStaffMessages.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/staffMessagesUpdateStaffMessages.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/staffMessagesUpdateStaffMessages.js +69 -0
- package/dist/commonjs/mcp-server/tools/staffMessagesUpdateStaffMessages.js.map +1 -0
- package/dist/commonjs/models/components/createinboxmessagerequest.d.ts +172 -0
- package/dist/commonjs/models/components/createinboxmessagerequest.d.ts.map +1 -0
- package/dist/commonjs/models/components/createinboxmessagerequest.js +189 -0
- package/dist/commonjs/models/components/createinboxmessagerequest.js.map +1 -0
- package/dist/commonjs/models/components/formresponse.d.ts +57 -0
- package/dist/commonjs/models/components/formresponse.d.ts.map +1 -1
- package/dist/commonjs/models/components/formresponse.js +70 -1
- package/dist/commonjs/models/components/formresponse.js.map +1 -1
- package/dist/commonjs/models/components/index.d.ts +1 -0
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +1 -0
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/job.d.ts +22 -22
- package/dist/commonjs/models/components/job.js +2 -2
- package/dist/commonjs/models/components/staffmessage.d.ts +49 -0
- package/dist/commonjs/models/components/staffmessage.d.ts.map +1 -1
- package/dist/commonjs/models/components/staffmessage.js +66 -1
- package/dist/commonjs/models/components/staffmessage.js.map +1 -1
- package/dist/commonjs/models/operations/createformresponses.d.ts +36 -0
- package/dist/commonjs/models/operations/createformresponses.d.ts.map +1 -0
- package/dist/commonjs/models/operations/createformresponses.js +83 -0
- package/dist/commonjs/models/operations/createformresponses.js.map +1 -0
- package/dist/commonjs/models/operations/createstaffmessages.d.ts +36 -0
- package/dist/commonjs/models/operations/createstaffmessages.d.ts.map +1 -0
- package/dist/commonjs/models/operations/createstaffmessages.js +83 -0
- package/dist/commonjs/models/operations/createstaffmessages.js.map +1 -0
- package/dist/commonjs/models/operations/deleteformresponses.d.ts +32 -0
- package/dist/commonjs/models/operations/deleteformresponses.d.ts.map +1 -0
- package/dist/commonjs/models/operations/deleteformresponses.js +69 -0
- package/dist/commonjs/models/operations/deleteformresponses.js.map +1 -0
- package/dist/commonjs/models/operations/deletestaffmessages.d.ts +32 -0
- package/dist/commonjs/models/operations/deletestaffmessages.d.ts.map +1 -0
- package/dist/commonjs/models/operations/deletestaffmessages.js +69 -0
- package/dist/commonjs/models/operations/deletestaffmessages.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +6 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +6 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/updateformresponses.d.ts +38 -0
- package/dist/commonjs/models/operations/updateformresponses.d.ts.map +1 -0
- package/dist/commonjs/models/operations/updateformresponses.js +81 -0
- package/dist/commonjs/models/operations/updateformresponses.js.map +1 -0
- package/dist/commonjs/models/operations/updatestaffmessages.d.ts +38 -0
- package/dist/commonjs/models/operations/updatestaffmessages.d.ts.map +1 -0
- package/dist/commonjs/models/operations/updatestaffmessages.js +81 -0
- package/dist/commonjs/models/operations/updatestaffmessages.js.map +1 -0
- package/dist/commonjs/sdk/formresponses.d.ts +32 -0
- package/dist/commonjs/sdk/formresponses.d.ts.map +1 -1
- package/dist/commonjs/sdk/formresponses.js +41 -0
- package/dist/commonjs/sdk/formresponses.js.map +1 -1
- package/dist/commonjs/sdk/inbox.d.ts +7 -0
- package/dist/commonjs/sdk/inbox.d.ts.map +1 -1
- package/dist/commonjs/sdk/inbox.js +10 -0
- package/dist/commonjs/sdk/inbox.js.map +1 -1
- package/dist/commonjs/sdk/staffmessages.d.ts +32 -0
- package/dist/commonjs/sdk/staffmessages.d.ts.map +1 -1
- package/dist/commonjs/sdk/staffmessages.js +41 -0
- package/dist/commonjs/sdk/staffmessages.js.map +1 -1
- package/dist/esm/funcs/formResponsesCreateFormResponses.d.ts +24 -0
- package/dist/esm/funcs/formResponsesCreateFormResponses.d.ts.map +1 -0
- package/dist/esm/funcs/formResponsesCreateFormResponses.js +100 -0
- package/dist/esm/funcs/formResponsesCreateFormResponses.js.map +1 -0
- package/dist/esm/funcs/formResponsesDeleteFormResponses.d.ts +23 -0
- package/dist/esm/funcs/formResponsesDeleteFormResponses.d.ts.map +1 -0
- package/dist/esm/funcs/formResponsesDeleteFormResponses.js +101 -0
- package/dist/esm/funcs/formResponsesDeleteFormResponses.js.map +1 -0
- package/dist/esm/funcs/formResponsesUpdateFormResponses.d.ts +21 -0
- package/dist/esm/funcs/formResponsesUpdateFormResponses.d.ts.map +1 -0
- package/dist/esm/funcs/formResponsesUpdateFormResponses.js +100 -0
- package/dist/esm/funcs/formResponsesUpdateFormResponses.js.map +1 -0
- package/dist/esm/funcs/inboxCreateInboxMessage.d.ts +18 -0
- package/dist/esm/funcs/inboxCreateInboxMessage.d.ts.map +1 -0
- package/dist/esm/funcs/inboxCreateInboxMessage.js +91 -0
- package/dist/esm/funcs/inboxCreateInboxMessage.js.map +1 -0
- package/dist/esm/funcs/staffMessagesCreateStaffMessages.d.ts +24 -0
- package/dist/esm/funcs/staffMessagesCreateStaffMessages.d.ts.map +1 -0
- package/dist/esm/funcs/staffMessagesCreateStaffMessages.js +100 -0
- package/dist/esm/funcs/staffMessagesCreateStaffMessages.js.map +1 -0
- package/dist/esm/funcs/staffMessagesDeleteStaffMessages.d.ts +23 -0
- package/dist/esm/funcs/staffMessagesDeleteStaffMessages.d.ts.map +1 -0
- package/dist/esm/funcs/staffMessagesDeleteStaffMessages.js +101 -0
- package/dist/esm/funcs/staffMessagesDeleteStaffMessages.js.map +1 -0
- package/dist/esm/funcs/staffMessagesUpdateStaffMessages.d.ts +21 -0
- package/dist/esm/funcs/staffMessagesUpdateStaffMessages.d.ts.map +1 -0
- package/dist/esm/funcs/staffMessagesUpdateStaffMessages.js +100 -0
- package/dist/esm/funcs/staffMessagesUpdateStaffMessages.js.map +1 -0
- 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 +15 -1
- package/dist/esm/mcp-server/server.js.map +1 -1
- package/dist/esm/mcp-server/tools/formResponsesCreateFormResponses.d.ts +8 -0
- package/dist/esm/mcp-server/tools/formResponsesCreateFormResponses.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/formResponsesCreateFormResponses.js +38 -0
- package/dist/esm/mcp-server/tools/formResponsesCreateFormResponses.js.map +1 -0
- package/dist/esm/mcp-server/tools/formResponsesDeleteFormResponses.d.ts +8 -0
- package/dist/esm/mcp-server/tools/formResponsesDeleteFormResponses.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/formResponsesDeleteFormResponses.js +37 -0
- package/dist/esm/mcp-server/tools/formResponsesDeleteFormResponses.js.map +1 -0
- package/dist/esm/mcp-server/tools/formResponsesUpdateFormResponses.d.ts +8 -0
- package/dist/esm/mcp-server/tools/formResponsesUpdateFormResponses.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/formResponsesUpdateFormResponses.js +33 -0
- package/dist/esm/mcp-server/tools/formResponsesUpdateFormResponses.js.map +1 -0
- package/dist/esm/mcp-server/tools/inboxCreateInboxMessage.d.ts +8 -0
- package/dist/esm/mcp-server/tools/inboxCreateInboxMessage.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/inboxCreateInboxMessage.js +28 -0
- package/dist/esm/mcp-server/tools/inboxCreateInboxMessage.js.map +1 -0
- package/dist/esm/mcp-server/tools/staffMessagesCreateStaffMessages.d.ts +8 -0
- package/dist/esm/mcp-server/tools/staffMessagesCreateStaffMessages.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/staffMessagesCreateStaffMessages.js +38 -0
- package/dist/esm/mcp-server/tools/staffMessagesCreateStaffMessages.js.map +1 -0
- package/dist/esm/mcp-server/tools/staffMessagesDeleteStaffMessages.d.ts +8 -0
- package/dist/esm/mcp-server/tools/staffMessagesDeleteStaffMessages.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/staffMessagesDeleteStaffMessages.js +37 -0
- package/dist/esm/mcp-server/tools/staffMessagesDeleteStaffMessages.js.map +1 -0
- package/dist/esm/mcp-server/tools/staffMessagesUpdateStaffMessages.d.ts +8 -0
- package/dist/esm/mcp-server/tools/staffMessagesUpdateStaffMessages.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/staffMessagesUpdateStaffMessages.js +33 -0
- package/dist/esm/mcp-server/tools/staffMessagesUpdateStaffMessages.js.map +1 -0
- package/dist/esm/models/components/createinboxmessagerequest.d.ts +172 -0
- package/dist/esm/models/components/createinboxmessagerequest.d.ts.map +1 -0
- package/dist/esm/models/components/createinboxmessagerequest.js +149 -0
- package/dist/esm/models/components/createinboxmessagerequest.js.map +1 -0
- package/dist/esm/models/components/formresponse.d.ts +57 -0
- package/dist/esm/models/components/formresponse.d.ts.map +1 -1
- package/dist/esm/models/components/formresponse.js +67 -0
- package/dist/esm/models/components/formresponse.js.map +1 -1
- package/dist/esm/models/components/index.d.ts +1 -0
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +1 -0
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/job.d.ts +22 -22
- package/dist/esm/models/components/job.js +2 -2
- package/dist/esm/models/components/staffmessage.d.ts +49 -0
- package/dist/esm/models/components/staffmessage.d.ts.map +1 -1
- package/dist/esm/models/components/staffmessage.js +63 -0
- package/dist/esm/models/components/staffmessage.js.map +1 -1
- package/dist/esm/models/operations/createformresponses.d.ts +36 -0
- package/dist/esm/models/operations/createformresponses.d.ts.map +1 -0
- package/dist/esm/models/operations/createformresponses.js +45 -0
- package/dist/esm/models/operations/createformresponses.js.map +1 -0
- package/dist/esm/models/operations/createstaffmessages.d.ts +36 -0
- package/dist/esm/models/operations/createstaffmessages.d.ts.map +1 -0
- package/dist/esm/models/operations/createstaffmessages.js +45 -0
- package/dist/esm/models/operations/createstaffmessages.js.map +1 -0
- package/dist/esm/models/operations/deleteformresponses.d.ts +32 -0
- package/dist/esm/models/operations/deleteformresponses.d.ts.map +1 -0
- package/dist/esm/models/operations/deleteformresponses.js +31 -0
- package/dist/esm/models/operations/deleteformresponses.js.map +1 -0
- package/dist/esm/models/operations/deletestaffmessages.d.ts +32 -0
- package/dist/esm/models/operations/deletestaffmessages.d.ts.map +1 -0
- package/dist/esm/models/operations/deletestaffmessages.js +31 -0
- package/dist/esm/models/operations/deletestaffmessages.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +6 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +6 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/updateformresponses.d.ts +38 -0
- package/dist/esm/models/operations/updateformresponses.d.ts.map +1 -0
- package/dist/esm/models/operations/updateformresponses.js +43 -0
- package/dist/esm/models/operations/updateformresponses.js.map +1 -0
- package/dist/esm/models/operations/updatestaffmessages.d.ts +38 -0
- package/dist/esm/models/operations/updatestaffmessages.d.ts.map +1 -0
- package/dist/esm/models/operations/updatestaffmessages.js +43 -0
- package/dist/esm/models/operations/updatestaffmessages.js.map +1 -0
- package/dist/esm/sdk/formresponses.d.ts +32 -0
- package/dist/esm/sdk/formresponses.d.ts.map +1 -1
- package/dist/esm/sdk/formresponses.js +41 -0
- package/dist/esm/sdk/formresponses.js.map +1 -1
- package/dist/esm/sdk/inbox.d.ts +7 -0
- package/dist/esm/sdk/inbox.d.ts.map +1 -1
- package/dist/esm/sdk/inbox.js +10 -0
- package/dist/esm/sdk/inbox.js.map +1 -1
- package/dist/esm/sdk/staffmessages.d.ts +32 -0
- package/dist/esm/sdk/staffmessages.d.ts.map +1 -1
- package/dist/esm/sdk/staffmessages.js +41 -0
- package/dist/esm/sdk/staffmessages.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/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/documenttemplates/README.md +4 -4
- 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 +309 -0
- package/docs/sdks/forms/README.md +8 -8
- package/docs/sdks/inbox/README.md +82 -0
- 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/knowledgearticles/README.md +4 -4
- package/docs/sdks/locations/README.md +4 -4
- package/docs/sdks/materials/README.md +8 -8
- package/docs/sdks/smstemplates/README.md +4 -4
- package/docs/sdks/staffmembers/README.md +12 -12
- package/docs/sdks/staffmessages/README.md +305 -0
- package/docs/sdks/tasks/README.md +20 -20
- package/docs/sdks/taxrates/README.md +4 -4
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/formResponsesCreateFormResponses.ts +200 -0
- package/src/funcs/formResponsesDeleteFormResponses.ts +207 -0
- package/src/funcs/formResponsesUpdateFormResponses.ts +206 -0
- package/src/funcs/inboxCreateInboxMessage.ts +179 -0
- package/src/funcs/staffMessagesCreateStaffMessages.ts +200 -0
- package/src/funcs/staffMessagesDeleteStaffMessages.ts +207 -0
- package/src/funcs/staffMessagesUpdateStaffMessages.ts +206 -0
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +15 -1
- package/src/mcp-server/tools/formResponsesCreateFormResponses.ts +49 -0
- package/src/mcp-server/tools/formResponsesDeleteFormResponses.ts +48 -0
- package/src/mcp-server/tools/formResponsesUpdateFormResponses.ts +44 -0
- package/src/mcp-server/tools/inboxCreateInboxMessage.ts +37 -0
- package/src/mcp-server/tools/staffMessagesCreateStaffMessages.ts +49 -0
- package/src/mcp-server/tools/staffMessagesDeleteStaffMessages.ts +48 -0
- package/src/mcp-server/tools/staffMessagesUpdateStaffMessages.ts +44 -0
- package/src/models/components/createinboxmessagerequest.ts +324 -0
- package/src/models/components/formresponse.ts +132 -0
- package/src/models/components/index.ts +1 -0
- package/src/models/components/job.ts +22 -22
- package/src/models/components/staffmessage.ts +120 -0
- package/src/models/operations/createformresponses.ts +84 -0
- package/src/models/operations/createstaffmessages.ts +84 -0
- package/src/models/operations/deleteformresponses.ts +69 -0
- package/src/models/operations/deletestaffmessages.ts +69 -0
- package/src/models/operations/index.ts +6 -0
- package/src/models/operations/updateformresponses.ts +86 -0
- package/src/models/operations/updatestaffmessages.ts +86 -0
- package/src/sdk/formresponses.ts +65 -0
- package/src/sdk/inbox.ts +18 -0
- package/src/sdk/staffmessages.ts +65 -0
|
@@ -127,7 +127,7 @@ const serviceM8 = new ServiceM8({
|
|
|
127
127
|
|
|
128
128
|
async function run() {
|
|
129
129
|
const result = await serviceM8.knowledgeArticles.createKnowledgeArticles({
|
|
130
|
-
uuid: "123e4567-
|
|
130
|
+
uuid: "123e4567-b8ce-457f-ae2a-2329be48795b",
|
|
131
131
|
name: "<value>",
|
|
132
132
|
});
|
|
133
133
|
|
|
@@ -155,7 +155,7 @@ const serviceM8 = new ServiceM8Core({
|
|
|
155
155
|
|
|
156
156
|
async function run() {
|
|
157
157
|
const res = await knowledgeArticlesCreateKnowledgeArticles(serviceM8, {
|
|
158
|
-
uuid: "123e4567-
|
|
158
|
+
uuid: "123e4567-b8ce-457f-ae2a-2329be48795b",
|
|
159
159
|
name: "<value>",
|
|
160
160
|
});
|
|
161
161
|
if (res.ok) {
|
|
@@ -306,7 +306,7 @@ async function run() {
|
|
|
306
306
|
const result = await serviceM8.knowledgeArticles.updateKnowledgeArticles({
|
|
307
307
|
uuid: "a643fa14-496b-46a5-88bc-4e67bb92bafd",
|
|
308
308
|
knowledgeArticle: {
|
|
309
|
-
uuid: "123e4567-
|
|
309
|
+
uuid: "123e4567-b8ce-457f-ae2a-2329be48795b",
|
|
310
310
|
name: "<value>",
|
|
311
311
|
},
|
|
312
312
|
});
|
|
@@ -337,7 +337,7 @@ async function run() {
|
|
|
337
337
|
const res = await knowledgeArticlesUpdateKnowledgeArticles(serviceM8, {
|
|
338
338
|
uuid: "a643fa14-496b-46a5-88bc-4e67bb92bafd",
|
|
339
339
|
knowledgeArticle: {
|
|
340
|
-
uuid: "123e4567-
|
|
340
|
+
uuid: "123e4567-b8ce-457f-ae2a-2329be48795b",
|
|
341
341
|
name: "<value>",
|
|
342
342
|
},
|
|
343
343
|
});
|
|
@@ -128,7 +128,7 @@ const serviceM8 = new ServiceM8({
|
|
|
128
128
|
async function run() {
|
|
129
129
|
const result = await serviceM8.locations.createLocations({
|
|
130
130
|
name: "<value>",
|
|
131
|
-
uuid: "123e4567-
|
|
131
|
+
uuid: "123e4567-dc72-4615-8d97-2329b25f170b",
|
|
132
132
|
});
|
|
133
133
|
|
|
134
134
|
console.log(result);
|
|
@@ -156,7 +156,7 @@ const serviceM8 = new ServiceM8Core({
|
|
|
156
156
|
async function run() {
|
|
157
157
|
const res = await locationsCreateLocations(serviceM8, {
|
|
158
158
|
name: "<value>",
|
|
159
|
-
uuid: "123e4567-
|
|
159
|
+
uuid: "123e4567-dc72-4615-8d97-2329b25f170b",
|
|
160
160
|
});
|
|
161
161
|
if (res.ok) {
|
|
162
162
|
const { value: result } = res;
|
|
@@ -307,7 +307,7 @@ async function run() {
|
|
|
307
307
|
uuid: "fee3b1fa-ab4e-4094-823d-0885a2f7b69f",
|
|
308
308
|
location: {
|
|
309
309
|
name: "<value>",
|
|
310
|
-
uuid: "123e4567-
|
|
310
|
+
uuid: "123e4567-dc72-4615-8d97-2329b25f170b",
|
|
311
311
|
},
|
|
312
312
|
});
|
|
313
313
|
|
|
@@ -338,7 +338,7 @@ async function run() {
|
|
|
338
338
|
uuid: "fee3b1fa-ab4e-4094-823d-0885a2f7b69f",
|
|
339
339
|
location: {
|
|
340
340
|
name: "<value>",
|
|
341
|
-
uuid: "123e4567-
|
|
341
|
+
uuid: "123e4567-dc72-4615-8d97-2329b25f170b",
|
|
342
342
|
},
|
|
343
343
|
});
|
|
344
344
|
if (res.ok) {
|
|
@@ -128,8 +128,8 @@ const serviceM8 = new ServiceM8({
|
|
|
128
128
|
async function run() {
|
|
129
129
|
const result = await serviceM8.materials.createMaterials({
|
|
130
130
|
name: "<value>",
|
|
131
|
-
uuid: "123e4567-
|
|
132
|
-
taxRateUuid: "123e4567-
|
|
131
|
+
uuid: "123e4567-4b23-46d7-b432-2329b80bf5cb",
|
|
132
|
+
taxRateUuid: "123e4567-2d86-4737-8cb2-2329bd1983ab",
|
|
133
133
|
});
|
|
134
134
|
|
|
135
135
|
console.log(result);
|
|
@@ -157,8 +157,8 @@ const serviceM8 = new ServiceM8Core({
|
|
|
157
157
|
async function run() {
|
|
158
158
|
const res = await materialsCreateMaterials(serviceM8, {
|
|
159
159
|
name: "<value>",
|
|
160
|
-
uuid: "123e4567-
|
|
161
|
-
taxRateUuid: "123e4567-
|
|
160
|
+
uuid: "123e4567-4b23-46d7-b432-2329b80bf5cb",
|
|
161
|
+
taxRateUuid: "123e4567-2d86-4737-8cb2-2329bd1983ab",
|
|
162
162
|
});
|
|
163
163
|
if (res.ok) {
|
|
164
164
|
const { value: result } = res;
|
|
@@ -309,8 +309,8 @@ async function run() {
|
|
|
309
309
|
uuid: "8a4aa688-8b41-4ab3-b862-24327504b606",
|
|
310
310
|
material: {
|
|
311
311
|
name: "<value>",
|
|
312
|
-
uuid: "123e4567-
|
|
313
|
-
taxRateUuid: "123e4567-
|
|
312
|
+
uuid: "123e4567-4b23-46d7-b432-2329b80bf5cb",
|
|
313
|
+
taxRateUuid: "123e4567-2d86-4737-8cb2-2329bd1983ab",
|
|
314
314
|
},
|
|
315
315
|
});
|
|
316
316
|
|
|
@@ -341,8 +341,8 @@ async function run() {
|
|
|
341
341
|
uuid: "8a4aa688-8b41-4ab3-b862-24327504b606",
|
|
342
342
|
material: {
|
|
343
343
|
name: "<value>",
|
|
344
|
-
uuid: "123e4567-
|
|
345
|
-
taxRateUuid: "123e4567-
|
|
344
|
+
uuid: "123e4567-4b23-46d7-b432-2329b80bf5cb",
|
|
345
|
+
taxRateUuid: "123e4567-2d86-4737-8cb2-2329bd1983ab",
|
|
346
346
|
},
|
|
347
347
|
});
|
|
348
348
|
if (res.ok) {
|
|
@@ -127,7 +127,7 @@ const serviceM8 = new ServiceM8({
|
|
|
127
127
|
|
|
128
128
|
async function run() {
|
|
129
129
|
const result = await serviceM8.smsTemplates.createSMSTemplates({
|
|
130
|
-
uuid: "123e4567-
|
|
130
|
+
uuid: "123e4567-e469-4e2a-b8ac-2329bac51ebb",
|
|
131
131
|
name: "<value>",
|
|
132
132
|
});
|
|
133
133
|
|
|
@@ -155,7 +155,7 @@ const serviceM8 = new ServiceM8Core({
|
|
|
155
155
|
|
|
156
156
|
async function run() {
|
|
157
157
|
const res = await smsTemplatesCreateSMSTemplates(serviceM8, {
|
|
158
|
-
uuid: "123e4567-
|
|
158
|
+
uuid: "123e4567-e469-4e2a-b8ac-2329bac51ebb",
|
|
159
159
|
name: "<value>",
|
|
160
160
|
});
|
|
161
161
|
if (res.ok) {
|
|
@@ -306,7 +306,7 @@ async function run() {
|
|
|
306
306
|
const result = await serviceM8.smsTemplates.updateSMSTemplates({
|
|
307
307
|
uuid: "2ea183b5-88e4-4168-a975-1820b2711ae4",
|
|
308
308
|
smsTemplate: {
|
|
309
|
-
uuid: "123e4567-
|
|
309
|
+
uuid: "123e4567-e469-4e2a-b8ac-2329bac51ebb",
|
|
310
310
|
name: "<value>",
|
|
311
311
|
},
|
|
312
312
|
});
|
|
@@ -337,7 +337,7 @@ async function run() {
|
|
|
337
337
|
const res = await smsTemplatesUpdateSMSTemplates(serviceM8, {
|
|
338
338
|
uuid: "2ea183b5-88e4-4168-a975-1820b2711ae4",
|
|
339
339
|
smsTemplate: {
|
|
340
|
-
uuid: "123e4567-
|
|
340
|
+
uuid: "123e4567-e469-4e2a-b8ac-2329bac51ebb",
|
|
341
341
|
name: "<value>",
|
|
342
342
|
},
|
|
343
343
|
});
|
|
@@ -131,12 +131,12 @@ async function run() {
|
|
|
131
131
|
last: "<value>",
|
|
132
132
|
email: "Larissa_Pfannerstill75@hotmail.com",
|
|
133
133
|
geoTimestamp: "2025-08-01 12:00:00",
|
|
134
|
-
navigatingToJobUuid: "123e4567-
|
|
134
|
+
navigatingToJobUuid: "123e4567-ed72-41c2-bb03-2329b822212b",
|
|
135
135
|
navigatingTimestamp: "2025-08-01 12:00:00",
|
|
136
136
|
navigatingExpiryTimestamp: "2025-08-01 12:00:00",
|
|
137
137
|
statusMessageTimestamp: "2025-08-01 12:00:00",
|
|
138
|
-
securityRoleUuid: "123e4567-
|
|
139
|
-
uuid: "123e4567-
|
|
138
|
+
securityRoleUuid: "123e4567-daf1-46ec-a1c9-2329bbda5a5b",
|
|
139
|
+
uuid: "123e4567-35c9-467a-8f72-2329b2dadceb",
|
|
140
140
|
});
|
|
141
141
|
|
|
142
142
|
console.log(result);
|
|
@@ -167,12 +167,12 @@ async function run() {
|
|
|
167
167
|
last: "<value>",
|
|
168
168
|
email: "Larissa_Pfannerstill75@hotmail.com",
|
|
169
169
|
geoTimestamp: "2025-08-01 12:00:00",
|
|
170
|
-
navigatingToJobUuid: "123e4567-
|
|
170
|
+
navigatingToJobUuid: "123e4567-ed72-41c2-bb03-2329b822212b",
|
|
171
171
|
navigatingTimestamp: "2025-08-01 12:00:00",
|
|
172
172
|
navigatingExpiryTimestamp: "2025-08-01 12:00:00",
|
|
173
173
|
statusMessageTimestamp: "2025-08-01 12:00:00",
|
|
174
|
-
securityRoleUuid: "123e4567-
|
|
175
|
-
uuid: "123e4567-
|
|
174
|
+
securityRoleUuid: "123e4567-daf1-46ec-a1c9-2329bbda5a5b",
|
|
175
|
+
uuid: "123e4567-35c9-467a-8f72-2329b2dadceb",
|
|
176
176
|
});
|
|
177
177
|
if (res.ok) {
|
|
178
178
|
const { value: result } = res;
|
|
@@ -326,12 +326,12 @@ async function run() {
|
|
|
326
326
|
last: "<value>",
|
|
327
327
|
email: "Mckenna_Yundt@hotmail.com",
|
|
328
328
|
geoTimestamp: "2025-08-01 12:00:00",
|
|
329
|
-
navigatingToJobUuid: "123e4567-
|
|
329
|
+
navigatingToJobUuid: "123e4567-ed72-41c2-bb03-2329b822212b",
|
|
330
330
|
navigatingTimestamp: "2025-08-01 12:00:00",
|
|
331
331
|
navigatingExpiryTimestamp: "2025-08-01 12:00:00",
|
|
332
332
|
statusMessageTimestamp: "2025-08-01 12:00:00",
|
|
333
|
-
securityRoleUuid: "123e4567-
|
|
334
|
-
uuid: "123e4567-
|
|
333
|
+
securityRoleUuid: "123e4567-daf1-46ec-a1c9-2329bbda5a5b",
|
|
334
|
+
uuid: "123e4567-35c9-467a-8f72-2329b2dadceb",
|
|
335
335
|
},
|
|
336
336
|
});
|
|
337
337
|
|
|
@@ -365,12 +365,12 @@ async function run() {
|
|
|
365
365
|
last: "<value>",
|
|
366
366
|
email: "Mckenna_Yundt@hotmail.com",
|
|
367
367
|
geoTimestamp: "2025-08-01 12:00:00",
|
|
368
|
-
navigatingToJobUuid: "123e4567-
|
|
368
|
+
navigatingToJobUuid: "123e4567-ed72-41c2-bb03-2329b822212b",
|
|
369
369
|
navigatingTimestamp: "2025-08-01 12:00:00",
|
|
370
370
|
navigatingExpiryTimestamp: "2025-08-01 12:00:00",
|
|
371
371
|
statusMessageTimestamp: "2025-08-01 12:00:00",
|
|
372
|
-
securityRoleUuid: "123e4567-
|
|
373
|
-
uuid: "123e4567-
|
|
372
|
+
securityRoleUuid: "123e4567-daf1-46ec-a1c9-2329bbda5a5b",
|
|
373
|
+
uuid: "123e4567-35c9-467a-8f72-2329b2dadceb",
|
|
374
374
|
},
|
|
375
375
|
});
|
|
376
376
|
if (res.ok) {
|
|
@@ -8,7 +8,10 @@ Operations related to Staff Messages
|
|
|
8
8
|
### Available Operations
|
|
9
9
|
|
|
10
10
|
* [listStaffMessages](#liststaffmessages) - List all Staff Messages
|
|
11
|
+
* [createStaffMessages](#createstaffmessages) - Create a new Staff Message
|
|
11
12
|
* [getStaffMessages](#getstaffmessages) - Retrieve a Staff Message
|
|
13
|
+
* [updateStaffMessages](#updatestaffmessages) - Update a Staff Message
|
|
14
|
+
* [deleteStaffMessages](#deletestaffmessages) - Delete a Staff Message
|
|
12
15
|
|
|
13
16
|
## listStaffMessages
|
|
14
17
|
|
|
@@ -96,6 +99,110 @@ run();
|
|
|
96
99
|
| errors.ErrorT | 500 | application/json |
|
|
97
100
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
98
101
|
|
|
102
|
+
## createStaffMessages
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
#### OAuth Scope
|
|
107
|
+
This endpoint requires the following OAuth scope **publish_messages**.
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
#### Record UUID
|
|
112
|
+
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.
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
### Example Usage
|
|
117
|
+
|
|
118
|
+
<!-- UsageSnippet language="typescript" operationID="createStaffMessages" method="post" path="/staffmessage.json" -->
|
|
119
|
+
```typescript
|
|
120
|
+
import { ServiceM8 } from "servicem8";
|
|
121
|
+
|
|
122
|
+
const serviceM8 = new ServiceM8({
|
|
123
|
+
security: {
|
|
124
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
125
|
+
},
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
async function run() {
|
|
129
|
+
const result = await serviceM8.staffMessages.createStaffMessages({
|
|
130
|
+
uuid: "123e4567-abdb-4322-a8df-2329b5ae407b",
|
|
131
|
+
fromStaffUuid: "123e4567-b98e-4778-9bb6-2329bbb2e71b",
|
|
132
|
+
toStaffUuid: "123e4567-3660-4750-950f-2329ba6dacab",
|
|
133
|
+
sentTimestamp: "2025-08-01 12:00:00",
|
|
134
|
+
deliveredTimestamp: "2025-08-01 12:00:00",
|
|
135
|
+
readTimestamp: "2025-08-01 12:00:00",
|
|
136
|
+
regardingJobUuid: "123e4567-33ad-4fc3-81e6-2329b4763b1b",
|
|
137
|
+
});
|
|
138
|
+
|
|
139
|
+
console.log(result);
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
run();
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### Standalone function
|
|
146
|
+
|
|
147
|
+
The standalone function version of this method:
|
|
148
|
+
|
|
149
|
+
```typescript
|
|
150
|
+
import { ServiceM8Core } from "servicem8/core.js";
|
|
151
|
+
import { staffMessagesCreateStaffMessages } from "servicem8/funcs/staffMessagesCreateStaffMessages.js";
|
|
152
|
+
|
|
153
|
+
// Use `ServiceM8Core` for best tree-shaking performance.
|
|
154
|
+
// You can create one instance of it to use across an application.
|
|
155
|
+
const serviceM8 = new ServiceM8Core({
|
|
156
|
+
security: {
|
|
157
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
158
|
+
},
|
|
159
|
+
});
|
|
160
|
+
|
|
161
|
+
async function run() {
|
|
162
|
+
const res = await staffMessagesCreateStaffMessages(serviceM8, {
|
|
163
|
+
uuid: "123e4567-abdb-4322-a8df-2329b5ae407b",
|
|
164
|
+
fromStaffUuid: "123e4567-b98e-4778-9bb6-2329bbb2e71b",
|
|
165
|
+
toStaffUuid: "123e4567-3660-4750-950f-2329ba6dacab",
|
|
166
|
+
sentTimestamp: "2025-08-01 12:00:00",
|
|
167
|
+
deliveredTimestamp: "2025-08-01 12:00:00",
|
|
168
|
+
readTimestamp: "2025-08-01 12:00:00",
|
|
169
|
+
regardingJobUuid: "123e4567-33ad-4fc3-81e6-2329b4763b1b",
|
|
170
|
+
});
|
|
171
|
+
if (res.ok) {
|
|
172
|
+
const { value: result } = res;
|
|
173
|
+
console.log(result);
|
|
174
|
+
} else {
|
|
175
|
+
console.log("staffMessagesCreateStaffMessages failed:", res.error);
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
run();
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
### Parameters
|
|
183
|
+
|
|
184
|
+
| Parameter | Type | Required | Description |
|
|
185
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
186
|
+
| `request` | [components.StaffMessageInput](../../models/components/staffmessageinput.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
187
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
188
|
+
| `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. |
|
|
189
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
190
|
+
|
|
191
|
+
### Response
|
|
192
|
+
|
|
193
|
+
**Promise\<[operations.CreateStaffMessagesResponse](../../models/operations/createstaffmessagesresponse.md)\>**
|
|
194
|
+
|
|
195
|
+
### Errors
|
|
196
|
+
|
|
197
|
+
| Error Type | Status Code | Content Type |
|
|
198
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
199
|
+
| errors.ErrorT | 400 | application/json |
|
|
200
|
+
| errors.AuthenticationError | 401 | application/json |
|
|
201
|
+
| errors.ForbiddenError | 403 | application/json |
|
|
202
|
+
| errors.RateLimitError | 429 | application/json |
|
|
203
|
+
| errors.ErrorT | 500 | application/json |
|
|
204
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
205
|
+
|
|
99
206
|
## getStaffMessages
|
|
100
207
|
|
|
101
208
|
|
|
@@ -174,6 +281,204 @@ run();
|
|
|
174
281
|
|
|
175
282
|
### Errors
|
|
176
283
|
|
|
284
|
+
| Error Type | Status Code | Content Type |
|
|
285
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
286
|
+
| errors.ErrorT | 400 | application/json |
|
|
287
|
+
| errors.AuthenticationError | 401 | application/json |
|
|
288
|
+
| errors.ForbiddenError | 403 | application/json |
|
|
289
|
+
| errors.NotFoundError | 404 | application/json |
|
|
290
|
+
| errors.RateLimitError | 429 | application/json |
|
|
291
|
+
| errors.ErrorT | 500 | application/json |
|
|
292
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
293
|
+
|
|
294
|
+
## updateStaffMessages
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
#### OAuth Scope
|
|
299
|
+
This endpoint requires the following OAuth scope **publish_messages**.
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
### Example Usage
|
|
304
|
+
|
|
305
|
+
<!-- UsageSnippet language="typescript" operationID="updateStaffMessages" method="post" path="/staffmessage/{uuid}.json" -->
|
|
306
|
+
```typescript
|
|
307
|
+
import { ServiceM8 } from "servicem8";
|
|
308
|
+
|
|
309
|
+
const serviceM8 = new ServiceM8({
|
|
310
|
+
security: {
|
|
311
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
312
|
+
},
|
|
313
|
+
});
|
|
314
|
+
|
|
315
|
+
async function run() {
|
|
316
|
+
const result = await serviceM8.staffMessages.updateStaffMessages({
|
|
317
|
+
uuid: "b5fd0f7a-6810-4261-acdb-e8e543cf4e72",
|
|
318
|
+
staffMessage: {
|
|
319
|
+
uuid: "123e4567-abdb-4322-a8df-2329b5ae407b",
|
|
320
|
+
fromStaffUuid: "123e4567-b98e-4778-9bb6-2329bbb2e71b",
|
|
321
|
+
toStaffUuid: "123e4567-3660-4750-950f-2329ba6dacab",
|
|
322
|
+
sentTimestamp: "2025-08-01 12:00:00",
|
|
323
|
+
deliveredTimestamp: "2025-08-01 12:00:00",
|
|
324
|
+
readTimestamp: "2025-08-01 12:00:00",
|
|
325
|
+
regardingJobUuid: "123e4567-33ad-4fc3-81e6-2329b4763b1b",
|
|
326
|
+
},
|
|
327
|
+
});
|
|
328
|
+
|
|
329
|
+
console.log(result);
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
run();
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
### Standalone function
|
|
336
|
+
|
|
337
|
+
The standalone function version of this method:
|
|
338
|
+
|
|
339
|
+
```typescript
|
|
340
|
+
import { ServiceM8Core } from "servicem8/core.js";
|
|
341
|
+
import { staffMessagesUpdateStaffMessages } from "servicem8/funcs/staffMessagesUpdateStaffMessages.js";
|
|
342
|
+
|
|
343
|
+
// Use `ServiceM8Core` for best tree-shaking performance.
|
|
344
|
+
// You can create one instance of it to use across an application.
|
|
345
|
+
const serviceM8 = new ServiceM8Core({
|
|
346
|
+
security: {
|
|
347
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
348
|
+
},
|
|
349
|
+
});
|
|
350
|
+
|
|
351
|
+
async function run() {
|
|
352
|
+
const res = await staffMessagesUpdateStaffMessages(serviceM8, {
|
|
353
|
+
uuid: "b5fd0f7a-6810-4261-acdb-e8e543cf4e72",
|
|
354
|
+
staffMessage: {
|
|
355
|
+
uuid: "123e4567-abdb-4322-a8df-2329b5ae407b",
|
|
356
|
+
fromStaffUuid: "123e4567-b98e-4778-9bb6-2329bbb2e71b",
|
|
357
|
+
toStaffUuid: "123e4567-3660-4750-950f-2329ba6dacab",
|
|
358
|
+
sentTimestamp: "2025-08-01 12:00:00",
|
|
359
|
+
deliveredTimestamp: "2025-08-01 12:00:00",
|
|
360
|
+
readTimestamp: "2025-08-01 12:00:00",
|
|
361
|
+
regardingJobUuid: "123e4567-33ad-4fc3-81e6-2329b4763b1b",
|
|
362
|
+
},
|
|
363
|
+
});
|
|
364
|
+
if (res.ok) {
|
|
365
|
+
const { value: result } = res;
|
|
366
|
+
console.log(result);
|
|
367
|
+
} else {
|
|
368
|
+
console.log("staffMessagesUpdateStaffMessages failed:", res.error);
|
|
369
|
+
}
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
run();
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
### Parameters
|
|
376
|
+
|
|
377
|
+
| Parameter | Type | Required | Description |
|
|
378
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
379
|
+
| `request` | [operations.UpdateStaffMessagesRequest](../../models/operations/updatestaffmessagesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
380
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
381
|
+
| `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. |
|
|
382
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
383
|
+
|
|
384
|
+
### Response
|
|
385
|
+
|
|
386
|
+
**Promise\<[components.Result](../../models/components/result.md)\>**
|
|
387
|
+
|
|
388
|
+
### Errors
|
|
389
|
+
|
|
390
|
+
| Error Type | Status Code | Content Type |
|
|
391
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
392
|
+
| errors.ErrorT | 400 | application/json |
|
|
393
|
+
| errors.AuthenticationError | 401 | application/json |
|
|
394
|
+
| errors.ForbiddenError | 403 | application/json |
|
|
395
|
+
| errors.NotFoundError | 404 | application/json |
|
|
396
|
+
| errors.RateLimitError | 429 | application/json |
|
|
397
|
+
| errors.ErrorT | 500 | application/json |
|
|
398
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
399
|
+
|
|
400
|
+
## deleteStaffMessages
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
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`.
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
#### OAuth Scope
|
|
409
|
+
This endpoint requires the following OAuth scope **publish_messages**.
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
### Example Usage
|
|
414
|
+
|
|
415
|
+
<!-- UsageSnippet language="typescript" operationID="deleteStaffMessages" method="delete" path="/staffmessage/{uuid}.json" -->
|
|
416
|
+
```typescript
|
|
417
|
+
import { ServiceM8 } from "servicem8";
|
|
418
|
+
|
|
419
|
+
const serviceM8 = new ServiceM8({
|
|
420
|
+
security: {
|
|
421
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
422
|
+
},
|
|
423
|
+
});
|
|
424
|
+
|
|
425
|
+
async function run() {
|
|
426
|
+
const result = await serviceM8.staffMessages.deleteStaffMessages({
|
|
427
|
+
uuid: "f09dd42b-85e0-454a-8494-c181a7fff788",
|
|
428
|
+
});
|
|
429
|
+
|
|
430
|
+
console.log(result);
|
|
431
|
+
}
|
|
432
|
+
|
|
433
|
+
run();
|
|
434
|
+
```
|
|
435
|
+
|
|
436
|
+
### Standalone function
|
|
437
|
+
|
|
438
|
+
The standalone function version of this method:
|
|
439
|
+
|
|
440
|
+
```typescript
|
|
441
|
+
import { ServiceM8Core } from "servicem8/core.js";
|
|
442
|
+
import { staffMessagesDeleteStaffMessages } from "servicem8/funcs/staffMessagesDeleteStaffMessages.js";
|
|
443
|
+
|
|
444
|
+
// Use `ServiceM8Core` for best tree-shaking performance.
|
|
445
|
+
// You can create one instance of it to use across an application.
|
|
446
|
+
const serviceM8 = new ServiceM8Core({
|
|
447
|
+
security: {
|
|
448
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
449
|
+
},
|
|
450
|
+
});
|
|
451
|
+
|
|
452
|
+
async function run() {
|
|
453
|
+
const res = await staffMessagesDeleteStaffMessages(serviceM8, {
|
|
454
|
+
uuid: "f09dd42b-85e0-454a-8494-c181a7fff788",
|
|
455
|
+
});
|
|
456
|
+
if (res.ok) {
|
|
457
|
+
const { value: result } = res;
|
|
458
|
+
console.log(result);
|
|
459
|
+
} else {
|
|
460
|
+
console.log("staffMessagesDeleteStaffMessages failed:", res.error);
|
|
461
|
+
}
|
|
462
|
+
}
|
|
463
|
+
|
|
464
|
+
run();
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
### Parameters
|
|
468
|
+
|
|
469
|
+
| Parameter | Type | Required | Description |
|
|
470
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
471
|
+
| `request` | [operations.DeleteStaffMessagesRequest](../../models/operations/deletestaffmessagesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
472
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
473
|
+
| `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. |
|
|
474
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
475
|
+
|
|
476
|
+
### Response
|
|
477
|
+
|
|
478
|
+
**Promise\<[components.Result](../../models/components/result.md)\>**
|
|
479
|
+
|
|
480
|
+
### Errors
|
|
481
|
+
|
|
177
482
|
| Error Type | Status Code | Content Type |
|
|
178
483
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
179
484
|
| errors.ErrorT | 400 | application/json |
|
|
@@ -129,12 +129,12 @@ async function run() {
|
|
|
129
129
|
const result = await serviceM8.tasks.createTasks({
|
|
130
130
|
dueDate: "YYYY-MM-DD",
|
|
131
131
|
name: "<value>",
|
|
132
|
-
relatedObjectUuid: "123e4567-
|
|
132
|
+
relatedObjectUuid: "123e4567-8c04-40d6-9f92-2329bd805b5b",
|
|
133
133
|
completedTimestamp: "2025-08-01 12:00:00",
|
|
134
|
-
completedByStaffUuid: "123e4567-
|
|
135
|
-
assignedToStaffUuid: "123e4567-
|
|
136
|
-
uuid: "123e4567-
|
|
137
|
-
createdByStaffUuid: "123e4567-
|
|
134
|
+
completedByStaffUuid: "123e4567-28af-4e1d-886d-2329b5ddbbeb",
|
|
135
|
+
assignedToStaffUuid: "123e4567-59a9-468b-98ae-2329baeb389b",
|
|
136
|
+
uuid: "123e4567-bd10-40e1-adb9-2329bef06c0b",
|
|
137
|
+
createdByStaffUuid: "123e4567-40c6-4555-9c38-2329b2bfe28b",
|
|
138
138
|
createDate: "2025-08-01 12:00:00",
|
|
139
139
|
});
|
|
140
140
|
|
|
@@ -164,12 +164,12 @@ async function run() {
|
|
|
164
164
|
const res = await tasksCreateTasks(serviceM8, {
|
|
165
165
|
dueDate: "YYYY-MM-DD",
|
|
166
166
|
name: "<value>",
|
|
167
|
-
relatedObjectUuid: "123e4567-
|
|
167
|
+
relatedObjectUuid: "123e4567-8c04-40d6-9f92-2329bd805b5b",
|
|
168
168
|
completedTimestamp: "2025-08-01 12:00:00",
|
|
169
|
-
completedByStaffUuid: "123e4567-
|
|
170
|
-
assignedToStaffUuid: "123e4567-
|
|
171
|
-
uuid: "123e4567-
|
|
172
|
-
createdByStaffUuid: "123e4567-
|
|
169
|
+
completedByStaffUuid: "123e4567-28af-4e1d-886d-2329b5ddbbeb",
|
|
170
|
+
assignedToStaffUuid: "123e4567-59a9-468b-98ae-2329baeb389b",
|
|
171
|
+
uuid: "123e4567-bd10-40e1-adb9-2329bef06c0b",
|
|
172
|
+
createdByStaffUuid: "123e4567-40c6-4555-9c38-2329b2bfe28b",
|
|
173
173
|
createDate: "2025-08-01 12:00:00",
|
|
174
174
|
});
|
|
175
175
|
if (res.ok) {
|
|
@@ -322,12 +322,12 @@ async function run() {
|
|
|
322
322
|
task: {
|
|
323
323
|
dueDate: "YYYY-MM-DD",
|
|
324
324
|
name: "<value>",
|
|
325
|
-
relatedObjectUuid: "123e4567-
|
|
325
|
+
relatedObjectUuid: "123e4567-8c04-40d6-9f92-2329bd805b5b",
|
|
326
326
|
completedTimestamp: "2025-08-01 12:00:00",
|
|
327
|
-
completedByStaffUuid: "123e4567-
|
|
328
|
-
assignedToStaffUuid: "123e4567-
|
|
329
|
-
uuid: "123e4567-
|
|
330
|
-
createdByStaffUuid: "123e4567-
|
|
327
|
+
completedByStaffUuid: "123e4567-28af-4e1d-886d-2329b5ddbbeb",
|
|
328
|
+
assignedToStaffUuid: "123e4567-59a9-468b-98ae-2329baeb389b",
|
|
329
|
+
uuid: "123e4567-bd10-40e1-adb9-2329bef06c0b",
|
|
330
|
+
createdByStaffUuid: "123e4567-40c6-4555-9c38-2329b2bfe28b",
|
|
331
331
|
createDate: "2025-08-01 12:00:00",
|
|
332
332
|
},
|
|
333
333
|
});
|
|
@@ -360,12 +360,12 @@ async function run() {
|
|
|
360
360
|
task: {
|
|
361
361
|
dueDate: "YYYY-MM-DD",
|
|
362
362
|
name: "<value>",
|
|
363
|
-
relatedObjectUuid: "123e4567-
|
|
363
|
+
relatedObjectUuid: "123e4567-8c04-40d6-9f92-2329bd805b5b",
|
|
364
364
|
completedTimestamp: "2025-08-01 12:00:00",
|
|
365
|
-
completedByStaffUuid: "123e4567-
|
|
366
|
-
assignedToStaffUuid: "123e4567-
|
|
367
|
-
uuid: "123e4567-
|
|
368
|
-
createdByStaffUuid: "123e4567-
|
|
365
|
+
completedByStaffUuid: "123e4567-28af-4e1d-886d-2329b5ddbbeb",
|
|
366
|
+
assignedToStaffUuid: "123e4567-59a9-468b-98ae-2329baeb389b",
|
|
367
|
+
uuid: "123e4567-bd10-40e1-adb9-2329bef06c0b",
|
|
368
|
+
createdByStaffUuid: "123e4567-40c6-4555-9c38-2329b2bfe28b",
|
|
369
369
|
createDate: "2025-08-01 12:00:00",
|
|
370
370
|
},
|
|
371
371
|
});
|