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,8 +127,8 @@ const serviceM8 = new ServiceM8({
|
|
|
127
127
|
|
|
128
128
|
async function run() {
|
|
129
129
|
const result = await serviceM8.feedback.createFeedback({
|
|
130
|
-
uuid: "123e4567-
|
|
131
|
-
relatedObjectUuid: "123e4567-
|
|
130
|
+
uuid: "123e4567-8ac5-4f6d-9518-2329bac131eb",
|
|
131
|
+
relatedObjectUuid: "123e4567-8099-4fdd-8e90-2329b76eab3b",
|
|
132
132
|
});
|
|
133
133
|
|
|
134
134
|
console.log(result);
|
|
@@ -155,8 +155,8 @@ const serviceM8 = new ServiceM8Core({
|
|
|
155
155
|
|
|
156
156
|
async function run() {
|
|
157
157
|
const res = await feedbackCreateFeedback(serviceM8, {
|
|
158
|
-
uuid: "123e4567-
|
|
159
|
-
relatedObjectUuid: "123e4567-
|
|
158
|
+
uuid: "123e4567-8ac5-4f6d-9518-2329bac131eb",
|
|
159
|
+
relatedObjectUuid: "123e4567-8099-4fdd-8e90-2329b76eab3b",
|
|
160
160
|
});
|
|
161
161
|
if (res.ok) {
|
|
162
162
|
const { value: result } = res;
|
|
@@ -306,8 +306,8 @@ async function run() {
|
|
|
306
306
|
const result = await serviceM8.feedback.updateFeedback({
|
|
307
307
|
uuid: "4b9b8627-caa7-402a-94b0-02cb8641823c",
|
|
308
308
|
feedback: {
|
|
309
|
-
uuid: "123e4567-
|
|
310
|
-
relatedObjectUuid: "123e4567-
|
|
309
|
+
uuid: "123e4567-8ac5-4f6d-9518-2329bac131eb",
|
|
310
|
+
relatedObjectUuid: "123e4567-8099-4fdd-8e90-2329b76eab3b",
|
|
311
311
|
},
|
|
312
312
|
});
|
|
313
313
|
|
|
@@ -337,8 +337,8 @@ async function run() {
|
|
|
337
337
|
const res = await feedbackUpdateFeedback(serviceM8, {
|
|
338
338
|
uuid: "4b9b8627-caa7-402a-94b0-02cb8641823c",
|
|
339
339
|
feedback: {
|
|
340
|
-
uuid: "123e4567-
|
|
341
|
-
relatedObjectUuid: "123e4567-
|
|
340
|
+
uuid: "123e4567-8ac5-4f6d-9518-2329bac131eb",
|
|
341
|
+
relatedObjectUuid: "123e4567-8099-4fdd-8e90-2329b76eab3b",
|
|
342
342
|
},
|
|
343
343
|
});
|
|
344
344
|
if (res.ok) {
|
|
@@ -127,8 +127,8 @@ const serviceM8 = new ServiceM8({
|
|
|
127
127
|
|
|
128
128
|
async function run() {
|
|
129
129
|
const result = await serviceM8.formFields.createFormFields({
|
|
130
|
-
uuid: "123e4567-
|
|
131
|
-
formUuid: "123e4567-
|
|
130
|
+
uuid: "123e4567-4839-4c1b-b5c8-2329bc0989bb",
|
|
131
|
+
formUuid: "123e4567-5996-45d9-9804-2329ba56fcdb",
|
|
132
132
|
});
|
|
133
133
|
|
|
134
134
|
console.log(result);
|
|
@@ -155,8 +155,8 @@ const serviceM8 = new ServiceM8Core({
|
|
|
155
155
|
|
|
156
156
|
async function run() {
|
|
157
157
|
const res = await formFieldsCreateFormFields(serviceM8, {
|
|
158
|
-
uuid: "123e4567-
|
|
159
|
-
formUuid: "123e4567-
|
|
158
|
+
uuid: "123e4567-4839-4c1b-b5c8-2329bc0989bb",
|
|
159
|
+
formUuid: "123e4567-5996-45d9-9804-2329ba56fcdb",
|
|
160
160
|
});
|
|
161
161
|
if (res.ok) {
|
|
162
162
|
const { value: result } = res;
|
|
@@ -306,8 +306,8 @@ async function run() {
|
|
|
306
306
|
const result = await serviceM8.formFields.updateFormFields({
|
|
307
307
|
uuid: "21a23c6a-1fd9-4be5-84ed-065250f0e6a3",
|
|
308
308
|
formField: {
|
|
309
|
-
uuid: "123e4567-
|
|
310
|
-
formUuid: "123e4567-
|
|
309
|
+
uuid: "123e4567-4839-4c1b-b5c8-2329bc0989bb",
|
|
310
|
+
formUuid: "123e4567-5996-45d9-9804-2329ba56fcdb",
|
|
311
311
|
},
|
|
312
312
|
});
|
|
313
313
|
|
|
@@ -337,8 +337,8 @@ async function run() {
|
|
|
337
337
|
const res = await formFieldsUpdateFormFields(serviceM8, {
|
|
338
338
|
uuid: "21a23c6a-1fd9-4be5-84ed-065250f0e6a3",
|
|
339
339
|
formField: {
|
|
340
|
-
uuid: "123e4567-
|
|
341
|
-
formUuid: "123e4567-
|
|
340
|
+
uuid: "123e4567-4839-4c1b-b5c8-2329bc0989bb",
|
|
341
|
+
formUuid: "123e4567-5996-45d9-9804-2329ba56fcdb",
|
|
342
342
|
},
|
|
343
343
|
});
|
|
344
344
|
if (res.ok) {
|
|
@@ -8,7 +8,10 @@ Operations related to Form Responses
|
|
|
8
8
|
### Available Operations
|
|
9
9
|
|
|
10
10
|
* [listFormResponses](#listformresponses) - List all Form Responses
|
|
11
|
+
* [createFormResponses](#createformresponses) - Create a new Form Response
|
|
11
12
|
* [getFormResponses](#getformresponses) - Retrieve a Form Response
|
|
13
|
+
* [updateFormResponses](#updateformresponses) - Update a Form Response
|
|
14
|
+
* [deleteFormResponses](#deleteformresponses) - Delete a Form Response
|
|
12
15
|
|
|
13
16
|
## listFormResponses
|
|
14
17
|
|
|
@@ -96,6 +99,112 @@ run();
|
|
|
96
99
|
| errors.ErrorT | 500 | application/json |
|
|
97
100
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
98
101
|
|
|
102
|
+
## createFormResponses
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
#### OAuth Scope
|
|
107
|
+
This endpoint requires the following OAuth scope **manage_forms**.
|
|
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="createFormResponses" method="post" path="/formresponse.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.formResponses.createFormResponses({
|
|
130
|
+
uuid: "123e4567-178a-4fa4-a1bb-2329bd3bc29b",
|
|
131
|
+
formUuid: "123e4567-0db8-4602-b04f-2329b9b2d90b",
|
|
132
|
+
staffUuid: "123e4567-721a-4295-82dc-2329bfa38f9b",
|
|
133
|
+
regardingObjectUuid: "123e4567-d4a5-4382-94f8-2329bdb8d27b",
|
|
134
|
+
timestamp: "2025-08-01 12:00:00",
|
|
135
|
+
formByStaffUuid: "123e4567-c7eb-4b86-9853-2329bcc0713b",
|
|
136
|
+
documentAttachmentUuid: "123e4567-7e82-42cb-861a-2329b4d22dbb",
|
|
137
|
+
assetUuid: "123e4567-c58c-40cf-8836-2329be5e6fab",
|
|
138
|
+
});
|
|
139
|
+
|
|
140
|
+
console.log(result);
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
run();
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Standalone function
|
|
147
|
+
|
|
148
|
+
The standalone function version of this method:
|
|
149
|
+
|
|
150
|
+
```typescript
|
|
151
|
+
import { ServiceM8Core } from "servicem8/core.js";
|
|
152
|
+
import { formResponsesCreateFormResponses } from "servicem8/funcs/formResponsesCreateFormResponses.js";
|
|
153
|
+
|
|
154
|
+
// Use `ServiceM8Core` for best tree-shaking performance.
|
|
155
|
+
// You can create one instance of it to use across an application.
|
|
156
|
+
const serviceM8 = new ServiceM8Core({
|
|
157
|
+
security: {
|
|
158
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
159
|
+
},
|
|
160
|
+
});
|
|
161
|
+
|
|
162
|
+
async function run() {
|
|
163
|
+
const res = await formResponsesCreateFormResponses(serviceM8, {
|
|
164
|
+
uuid: "123e4567-178a-4fa4-a1bb-2329bd3bc29b",
|
|
165
|
+
formUuid: "123e4567-0db8-4602-b04f-2329b9b2d90b",
|
|
166
|
+
staffUuid: "123e4567-721a-4295-82dc-2329bfa38f9b",
|
|
167
|
+
regardingObjectUuid: "123e4567-d4a5-4382-94f8-2329bdb8d27b",
|
|
168
|
+
timestamp: "2025-08-01 12:00:00",
|
|
169
|
+
formByStaffUuid: "123e4567-c7eb-4b86-9853-2329bcc0713b",
|
|
170
|
+
documentAttachmentUuid: "123e4567-7e82-42cb-861a-2329b4d22dbb",
|
|
171
|
+
assetUuid: "123e4567-c58c-40cf-8836-2329be5e6fab",
|
|
172
|
+
});
|
|
173
|
+
if (res.ok) {
|
|
174
|
+
const { value: result } = res;
|
|
175
|
+
console.log(result);
|
|
176
|
+
} else {
|
|
177
|
+
console.log("formResponsesCreateFormResponses failed:", res.error);
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
run();
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### Parameters
|
|
185
|
+
|
|
186
|
+
| Parameter | Type | Required | Description |
|
|
187
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
188
|
+
| `request` | [components.FormResponseInput](../../models/components/formresponseinput.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
189
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
190
|
+
| `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. |
|
|
191
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
192
|
+
|
|
193
|
+
### Response
|
|
194
|
+
|
|
195
|
+
**Promise\<[operations.CreateFormResponsesResponse](../../models/operations/createformresponsesresponse.md)\>**
|
|
196
|
+
|
|
197
|
+
### Errors
|
|
198
|
+
|
|
199
|
+
| Error Type | Status Code | Content Type |
|
|
200
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
201
|
+
| errors.ErrorT | 400 | application/json |
|
|
202
|
+
| errors.AuthenticationError | 401 | application/json |
|
|
203
|
+
| errors.ForbiddenError | 403 | application/json |
|
|
204
|
+
| errors.RateLimitError | 429 | application/json |
|
|
205
|
+
| errors.ErrorT | 500 | application/json |
|
|
206
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
207
|
+
|
|
99
208
|
## getFormResponses
|
|
100
209
|
|
|
101
210
|
|
|
@@ -174,6 +283,206 @@ run();
|
|
|
174
283
|
|
|
175
284
|
### Errors
|
|
176
285
|
|
|
286
|
+
| Error Type | Status Code | Content Type |
|
|
287
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
288
|
+
| errors.ErrorT | 400 | application/json |
|
|
289
|
+
| errors.AuthenticationError | 401 | application/json |
|
|
290
|
+
| errors.ForbiddenError | 403 | application/json |
|
|
291
|
+
| errors.NotFoundError | 404 | application/json |
|
|
292
|
+
| errors.RateLimitError | 429 | application/json |
|
|
293
|
+
| errors.ErrorT | 500 | application/json |
|
|
294
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
295
|
+
|
|
296
|
+
## updateFormResponses
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
#### OAuth Scope
|
|
301
|
+
This endpoint requires the following OAuth scope **manage_forms**.
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
### Example Usage
|
|
306
|
+
|
|
307
|
+
<!-- UsageSnippet language="typescript" operationID="updateFormResponses" method="post" path="/formresponse/{uuid}.json" -->
|
|
308
|
+
```typescript
|
|
309
|
+
import { ServiceM8 } from "servicem8";
|
|
310
|
+
|
|
311
|
+
const serviceM8 = new ServiceM8({
|
|
312
|
+
security: {
|
|
313
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
314
|
+
},
|
|
315
|
+
});
|
|
316
|
+
|
|
317
|
+
async function run() {
|
|
318
|
+
const result = await serviceM8.formResponses.updateFormResponses({
|
|
319
|
+
uuid: "5f593a3c-772d-4259-856d-86a8df7ae53d",
|
|
320
|
+
formResponse: {
|
|
321
|
+
uuid: "123e4567-178a-4fa4-a1bb-2329bd3bc29b",
|
|
322
|
+
formUuid: "123e4567-0db8-4602-b04f-2329b9b2d90b",
|
|
323
|
+
staffUuid: "123e4567-721a-4295-82dc-2329bfa38f9b",
|
|
324
|
+
regardingObjectUuid: "123e4567-d4a5-4382-94f8-2329bdb8d27b",
|
|
325
|
+
timestamp: "2025-08-01 12:00:00",
|
|
326
|
+
formByStaffUuid: "123e4567-c7eb-4b86-9853-2329bcc0713b",
|
|
327
|
+
documentAttachmentUuid: "123e4567-7e82-42cb-861a-2329b4d22dbb",
|
|
328
|
+
assetUuid: "123e4567-c58c-40cf-8836-2329be5e6fab",
|
|
329
|
+
},
|
|
330
|
+
});
|
|
331
|
+
|
|
332
|
+
console.log(result);
|
|
333
|
+
}
|
|
334
|
+
|
|
335
|
+
run();
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
### Standalone function
|
|
339
|
+
|
|
340
|
+
The standalone function version of this method:
|
|
341
|
+
|
|
342
|
+
```typescript
|
|
343
|
+
import { ServiceM8Core } from "servicem8/core.js";
|
|
344
|
+
import { formResponsesUpdateFormResponses } from "servicem8/funcs/formResponsesUpdateFormResponses.js";
|
|
345
|
+
|
|
346
|
+
// Use `ServiceM8Core` for best tree-shaking performance.
|
|
347
|
+
// You can create one instance of it to use across an application.
|
|
348
|
+
const serviceM8 = new ServiceM8Core({
|
|
349
|
+
security: {
|
|
350
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
351
|
+
},
|
|
352
|
+
});
|
|
353
|
+
|
|
354
|
+
async function run() {
|
|
355
|
+
const res = await formResponsesUpdateFormResponses(serviceM8, {
|
|
356
|
+
uuid: "5f593a3c-772d-4259-856d-86a8df7ae53d",
|
|
357
|
+
formResponse: {
|
|
358
|
+
uuid: "123e4567-178a-4fa4-a1bb-2329bd3bc29b",
|
|
359
|
+
formUuid: "123e4567-0db8-4602-b04f-2329b9b2d90b",
|
|
360
|
+
staffUuid: "123e4567-721a-4295-82dc-2329bfa38f9b",
|
|
361
|
+
regardingObjectUuid: "123e4567-d4a5-4382-94f8-2329bdb8d27b",
|
|
362
|
+
timestamp: "2025-08-01 12:00:00",
|
|
363
|
+
formByStaffUuid: "123e4567-c7eb-4b86-9853-2329bcc0713b",
|
|
364
|
+
documentAttachmentUuid: "123e4567-7e82-42cb-861a-2329b4d22dbb",
|
|
365
|
+
assetUuid: "123e4567-c58c-40cf-8836-2329be5e6fab",
|
|
366
|
+
},
|
|
367
|
+
});
|
|
368
|
+
if (res.ok) {
|
|
369
|
+
const { value: result } = res;
|
|
370
|
+
console.log(result);
|
|
371
|
+
} else {
|
|
372
|
+
console.log("formResponsesUpdateFormResponses failed:", res.error);
|
|
373
|
+
}
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
run();
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
### Parameters
|
|
380
|
+
|
|
381
|
+
| Parameter | Type | Required | Description |
|
|
382
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
383
|
+
| `request` | [operations.UpdateFormResponsesRequest](../../models/operations/updateformresponsesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
384
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
385
|
+
| `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. |
|
|
386
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
387
|
+
|
|
388
|
+
### Response
|
|
389
|
+
|
|
390
|
+
**Promise\<[components.Result](../../models/components/result.md)\>**
|
|
391
|
+
|
|
392
|
+
### Errors
|
|
393
|
+
|
|
394
|
+
| Error Type | Status Code | Content Type |
|
|
395
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
396
|
+
| errors.ErrorT | 400 | application/json |
|
|
397
|
+
| errors.AuthenticationError | 401 | application/json |
|
|
398
|
+
| errors.ForbiddenError | 403 | application/json |
|
|
399
|
+
| errors.NotFoundError | 404 | application/json |
|
|
400
|
+
| errors.RateLimitError | 429 | application/json |
|
|
401
|
+
| errors.ErrorT | 500 | application/json |
|
|
402
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
403
|
+
|
|
404
|
+
## deleteFormResponses
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
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`.
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
#### OAuth Scope
|
|
413
|
+
This endpoint requires the following OAuth scope **manage_forms**.
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
### Example Usage
|
|
418
|
+
|
|
419
|
+
<!-- UsageSnippet language="typescript" operationID="deleteFormResponses" method="delete" path="/formresponse/{uuid}.json" -->
|
|
420
|
+
```typescript
|
|
421
|
+
import { ServiceM8 } from "servicem8";
|
|
422
|
+
|
|
423
|
+
const serviceM8 = new ServiceM8({
|
|
424
|
+
security: {
|
|
425
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
426
|
+
},
|
|
427
|
+
});
|
|
428
|
+
|
|
429
|
+
async function run() {
|
|
430
|
+
const result = await serviceM8.formResponses.deleteFormResponses({
|
|
431
|
+
uuid: "e983658f-a3da-4850-8bb2-90c7866b30cf",
|
|
432
|
+
});
|
|
433
|
+
|
|
434
|
+
console.log(result);
|
|
435
|
+
}
|
|
436
|
+
|
|
437
|
+
run();
|
|
438
|
+
```
|
|
439
|
+
|
|
440
|
+
### Standalone function
|
|
441
|
+
|
|
442
|
+
The standalone function version of this method:
|
|
443
|
+
|
|
444
|
+
```typescript
|
|
445
|
+
import { ServiceM8Core } from "servicem8/core.js";
|
|
446
|
+
import { formResponsesDeleteFormResponses } from "servicem8/funcs/formResponsesDeleteFormResponses.js";
|
|
447
|
+
|
|
448
|
+
// Use `ServiceM8Core` for best tree-shaking performance.
|
|
449
|
+
// You can create one instance of it to use across an application.
|
|
450
|
+
const serviceM8 = new ServiceM8Core({
|
|
451
|
+
security: {
|
|
452
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
453
|
+
},
|
|
454
|
+
});
|
|
455
|
+
|
|
456
|
+
async function run() {
|
|
457
|
+
const res = await formResponsesDeleteFormResponses(serviceM8, {
|
|
458
|
+
uuid: "e983658f-a3da-4850-8bb2-90c7866b30cf",
|
|
459
|
+
});
|
|
460
|
+
if (res.ok) {
|
|
461
|
+
const { value: result } = res;
|
|
462
|
+
console.log(result);
|
|
463
|
+
} else {
|
|
464
|
+
console.log("formResponsesDeleteFormResponses failed:", res.error);
|
|
465
|
+
}
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
run();
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
### Parameters
|
|
472
|
+
|
|
473
|
+
| Parameter | Type | Required | Description |
|
|
474
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
475
|
+
| `request` | [operations.DeleteFormResponsesRequest](../../models/operations/deleteformresponsesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
476
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
477
|
+
| `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. |
|
|
478
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
479
|
+
|
|
480
|
+
### Response
|
|
481
|
+
|
|
482
|
+
**Promise\<[components.Result](../../models/components/result.md)\>**
|
|
483
|
+
|
|
484
|
+
### Errors
|
|
485
|
+
|
|
177
486
|
| Error Type | Status Code | Content Type |
|
|
178
487
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
179
488
|
| errors.ErrorT | 400 | application/json |
|
|
@@ -127,8 +127,8 @@ const serviceM8 = new ServiceM8({
|
|
|
127
127
|
|
|
128
128
|
async function run() {
|
|
129
129
|
const result = await serviceM8.forms.createForms({
|
|
130
|
-
documentTemplateUuid: "123e4567-
|
|
131
|
-
uuid: "123e4567-
|
|
130
|
+
documentTemplateUuid: "123e4567-7f29-4105-bf2a-2329bd1872db",
|
|
131
|
+
uuid: "123e4567-2c64-4d43-aa06-2329b69c933b",
|
|
132
132
|
});
|
|
133
133
|
|
|
134
134
|
console.log(result);
|
|
@@ -155,8 +155,8 @@ const serviceM8 = new ServiceM8Core({
|
|
|
155
155
|
|
|
156
156
|
async function run() {
|
|
157
157
|
const res = await formsCreateForms(serviceM8, {
|
|
158
|
-
documentTemplateUuid: "123e4567-
|
|
159
|
-
uuid: "123e4567-
|
|
158
|
+
documentTemplateUuid: "123e4567-7f29-4105-bf2a-2329bd1872db",
|
|
159
|
+
uuid: "123e4567-2c64-4d43-aa06-2329b69c933b",
|
|
160
160
|
});
|
|
161
161
|
if (res.ok) {
|
|
162
162
|
const { value: result } = res;
|
|
@@ -306,8 +306,8 @@ async function run() {
|
|
|
306
306
|
const result = await serviceM8.forms.updateForms({
|
|
307
307
|
uuid: "2473c622-cde4-4803-b91a-cd7a656f7e3b",
|
|
308
308
|
form: {
|
|
309
|
-
documentTemplateUuid: "123e4567-
|
|
310
|
-
uuid: "123e4567-
|
|
309
|
+
documentTemplateUuid: "123e4567-7f29-4105-bf2a-2329bd1872db",
|
|
310
|
+
uuid: "123e4567-2c64-4d43-aa06-2329b69c933b",
|
|
311
311
|
},
|
|
312
312
|
});
|
|
313
313
|
|
|
@@ -337,8 +337,8 @@ async function run() {
|
|
|
337
337
|
const res = await formsUpdateForms(serviceM8, {
|
|
338
338
|
uuid: "2473c622-cde4-4803-b91a-cd7a656f7e3b",
|
|
339
339
|
form: {
|
|
340
|
-
documentTemplateUuid: "123e4567-
|
|
341
|
-
uuid: "123e4567-
|
|
340
|
+
documentTemplateUuid: "123e4567-7f29-4105-bf2a-2329bd1872db",
|
|
341
|
+
uuid: "123e4567-2c64-4d43-aa06-2329b69c933b",
|
|
342
342
|
},
|
|
343
343
|
});
|
|
344
344
|
if (res.ok) {
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
8
|
* [listInboxMessages](#listinboxmessages) - List inbox messages
|
|
9
|
+
* [createInboxMessage](#createinboxmessage) - Create a new inbox message
|
|
9
10
|
* [getInboxMessage](#getinboxmessage) - Get inbox message details
|
|
10
11
|
* [markInboxMessageAsRead](#markinboxmessageasread) - Mark message as read
|
|
11
12
|
* [archiveInboxMessage](#archiveinboxmessage) - Archive or unarchive message
|
|
@@ -88,6 +89,87 @@ run();
|
|
|
88
89
|
| errors.ErrorT | 400, 403 | application/json |
|
|
89
90
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
90
91
|
|
|
92
|
+
## createInboxMessage
|
|
93
|
+
|
|
94
|
+
Creates a new inbox message that will appear in the inbox
|
|
95
|
+
|
|
96
|
+
### Example Usage
|
|
97
|
+
|
|
98
|
+
<!-- UsageSnippet language="typescript" operationID="createInboxMessage" method="post" path="/inboxmessage.json" -->
|
|
99
|
+
```typescript
|
|
100
|
+
import { ServiceM8 } from "servicem8";
|
|
101
|
+
|
|
102
|
+
const serviceM8 = new ServiceM8({
|
|
103
|
+
security: {
|
|
104
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
105
|
+
},
|
|
106
|
+
});
|
|
107
|
+
|
|
108
|
+
async function run() {
|
|
109
|
+
const result = await serviceM8.inbox.createInboxMessage({
|
|
110
|
+
subject: "<value>",
|
|
111
|
+
messageText: "<value>",
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
console.log(result);
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
run();
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### Standalone function
|
|
121
|
+
|
|
122
|
+
The standalone function version of this method:
|
|
123
|
+
|
|
124
|
+
```typescript
|
|
125
|
+
import { ServiceM8Core } from "servicem8/core.js";
|
|
126
|
+
import { inboxCreateInboxMessage } from "servicem8/funcs/inboxCreateInboxMessage.js";
|
|
127
|
+
|
|
128
|
+
// Use `ServiceM8Core` for best tree-shaking performance.
|
|
129
|
+
// You can create one instance of it to use across an application.
|
|
130
|
+
const serviceM8 = new ServiceM8Core({
|
|
131
|
+
security: {
|
|
132
|
+
apiKey: process.env["SERVICEM8_API_KEY"] ?? "",
|
|
133
|
+
},
|
|
134
|
+
});
|
|
135
|
+
|
|
136
|
+
async function run() {
|
|
137
|
+
const res = await inboxCreateInboxMessage(serviceM8, {
|
|
138
|
+
subject: "<value>",
|
|
139
|
+
messageText: "<value>",
|
|
140
|
+
});
|
|
141
|
+
if (res.ok) {
|
|
142
|
+
const { value: result } = res;
|
|
143
|
+
console.log(result);
|
|
144
|
+
} else {
|
|
145
|
+
console.log("inboxCreateInboxMessage failed:", res.error);
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
run();
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Parameters
|
|
153
|
+
|
|
154
|
+
| Parameter | Type | Required | Description |
|
|
155
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
156
|
+
| `request` | [components.CreateInboxMessageRequest](../../models/components/createinboxmessagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
157
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
158
|
+
| `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. |
|
|
159
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
160
|
+
|
|
161
|
+
### Response
|
|
162
|
+
|
|
163
|
+
**Promise\<[components.InboxMessageDetail](../../models/components/inboxmessagedetail.md)\>**
|
|
164
|
+
|
|
165
|
+
### Errors
|
|
166
|
+
|
|
167
|
+
| Error Type | Status Code | Content Type |
|
|
168
|
+
| ---------------- | ---------------- | ---------------- |
|
|
169
|
+
| errors.ErrorT | 400, 403, 404 | application/json |
|
|
170
|
+
| errors.ErrorT | 500 | application/json |
|
|
171
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
172
|
+
|
|
91
173
|
## getInboxMessage
|
|
92
174
|
|
|
93
175
|
Retrieves detailed information about a specific inbox message including attachments and conversation history
|
|
@@ -127,15 +127,15 @@ const serviceM8 = new ServiceM8({
|
|
|
127
127
|
|
|
128
128
|
async function run() {
|
|
129
129
|
const result = await serviceM8.jobActivities.createJobActivities({
|
|
130
|
-
uuid: "123e4567-
|
|
131
|
-
jobUuid: "123e4567-
|
|
132
|
-
staffUuid: "123e4567-
|
|
130
|
+
uuid: "123e4567-825b-459e-b123-2329b922c33b",
|
|
131
|
+
jobUuid: "123e4567-5903-4e68-b94c-2329b9cf1b1b",
|
|
132
|
+
staffUuid: "123e4567-705d-406e-97dd-2329be0fdccb",
|
|
133
133
|
startDate: "2025-08-01 12:00:00",
|
|
134
134
|
endDate: "2025-08-01 12:00:00",
|
|
135
135
|
hasBeenOpenedTimestamp: "2025-08-01 12:00:00",
|
|
136
|
-
allocatedByStaffUuid: "123e4567-
|
|
136
|
+
allocatedByStaffUuid: "123e4567-d0fa-431e-b556-2329ba5b886b",
|
|
137
137
|
allocatedTimestamp: "2025-08-01 12:00:00",
|
|
138
|
-
materialUuid: "123e4567-
|
|
138
|
+
materialUuid: "123e4567-a899-4f07-a251-2329b60a7a8b",
|
|
139
139
|
});
|
|
140
140
|
|
|
141
141
|
console.log(result);
|
|
@@ -162,15 +162,15 @@ const serviceM8 = new ServiceM8Core({
|
|
|
162
162
|
|
|
163
163
|
async function run() {
|
|
164
164
|
const res = await jobActivitiesCreateJobActivities(serviceM8, {
|
|
165
|
-
uuid: "123e4567-
|
|
166
|
-
jobUuid: "123e4567-
|
|
167
|
-
staffUuid: "123e4567-
|
|
165
|
+
uuid: "123e4567-825b-459e-b123-2329b922c33b",
|
|
166
|
+
jobUuid: "123e4567-5903-4e68-b94c-2329b9cf1b1b",
|
|
167
|
+
staffUuid: "123e4567-705d-406e-97dd-2329be0fdccb",
|
|
168
168
|
startDate: "2025-08-01 12:00:00",
|
|
169
169
|
endDate: "2025-08-01 12:00:00",
|
|
170
170
|
hasBeenOpenedTimestamp: "2025-08-01 12:00:00",
|
|
171
|
-
allocatedByStaffUuid: "123e4567-
|
|
171
|
+
allocatedByStaffUuid: "123e4567-d0fa-431e-b556-2329ba5b886b",
|
|
172
172
|
allocatedTimestamp: "2025-08-01 12:00:00",
|
|
173
|
-
materialUuid: "123e4567-
|
|
173
|
+
materialUuid: "123e4567-a899-4f07-a251-2329b60a7a8b",
|
|
174
174
|
});
|
|
175
175
|
if (res.ok) {
|
|
176
176
|
const { value: result } = res;
|
|
@@ -320,15 +320,15 @@ async function run() {
|
|
|
320
320
|
const result = await serviceM8.jobActivities.updateJobActivities({
|
|
321
321
|
uuid: "5ccaaaf0-ee37-4a96-a41a-cc701c3f1a65",
|
|
322
322
|
jobActivity: {
|
|
323
|
-
uuid: "123e4567-
|
|
324
|
-
jobUuid: "123e4567-
|
|
325
|
-
staffUuid: "123e4567-
|
|
323
|
+
uuid: "123e4567-825b-459e-b123-2329b922c33b",
|
|
324
|
+
jobUuid: "123e4567-5903-4e68-b94c-2329b9cf1b1b",
|
|
325
|
+
staffUuid: "123e4567-705d-406e-97dd-2329be0fdccb",
|
|
326
326
|
startDate: "2025-08-01 12:00:00",
|
|
327
327
|
endDate: "2025-08-01 12:00:00",
|
|
328
328
|
hasBeenOpenedTimestamp: "2025-08-01 12:00:00",
|
|
329
|
-
allocatedByStaffUuid: "123e4567-
|
|
329
|
+
allocatedByStaffUuid: "123e4567-d0fa-431e-b556-2329ba5b886b",
|
|
330
330
|
allocatedTimestamp: "2025-08-01 12:00:00",
|
|
331
|
-
materialUuid: "123e4567-
|
|
331
|
+
materialUuid: "123e4567-a899-4f07-a251-2329b60a7a8b",
|
|
332
332
|
},
|
|
333
333
|
});
|
|
334
334
|
|
|
@@ -358,15 +358,15 @@ async function run() {
|
|
|
358
358
|
const res = await jobActivitiesUpdateJobActivities(serviceM8, {
|
|
359
359
|
uuid: "5ccaaaf0-ee37-4a96-a41a-cc701c3f1a65",
|
|
360
360
|
jobActivity: {
|
|
361
|
-
uuid: "123e4567-
|
|
362
|
-
jobUuid: "123e4567-
|
|
363
|
-
staffUuid: "123e4567-
|
|
361
|
+
uuid: "123e4567-825b-459e-b123-2329b922c33b",
|
|
362
|
+
jobUuid: "123e4567-5903-4e68-b94c-2329b9cf1b1b",
|
|
363
|
+
staffUuid: "123e4567-705d-406e-97dd-2329be0fdccb",
|
|
364
364
|
startDate: "2025-08-01 12:00:00",
|
|
365
365
|
endDate: "2025-08-01 12:00:00",
|
|
366
366
|
hasBeenOpenedTimestamp: "2025-08-01 12:00:00",
|
|
367
|
-
allocatedByStaffUuid: "123e4567-
|
|
367
|
+
allocatedByStaffUuid: "123e4567-d0fa-431e-b556-2329ba5b886b",
|
|
368
368
|
allocatedTimestamp: "2025-08-01 12:00:00",
|
|
369
|
-
materialUuid: "123e4567-
|
|
369
|
+
materialUuid: "123e4567-a899-4f07-a251-2329b60a7a8b",
|
|
370
370
|
},
|
|
371
371
|
});
|
|
372
372
|
if (res.ok) {
|