syllable-sdk 0.1.0-alpha.2 → 0.1.0-alpha.20
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/FUNCTIONS.md +104 -0
- package/README.md +117 -21
- package/RUNTIMES.md +22 -0
- package/docs/sdks/agents/README.md +76 -4
- package/docs/sdks/custommessages/README.md +6 -6
- package/docs/sdks/directory/README.md +559 -0
- package/docs/sdks/prompts/README.md +80 -4
- package/docs/sdks/services/README.md +245 -0
- package/docs/sdks/sessions/README.md +234 -0
- package/docs/sdks/syllablesdk/README.md +8 -4
- package/docs/sdks/tools/README.md +163 -1
- package/docs/sdks/transcript/README.md +2 -0
- package/docs/sdks/v1/README.md +417 -31
- package/funcs/agentsAgentGetAvailableVoices.d.ts +15 -0
- package/funcs/agentsAgentGetAvailableVoices.d.ts.map +1 -0
- package/funcs/agentsAgentGetAvailableVoices.js +86 -0
- package/funcs/agentsAgentGetAvailableVoices.js.map +1 -0
- package/funcs/agentsCreate.js +2 -2
- package/funcs/agentsCreate.js.map +1 -1
- package/funcs/agentsDelete.js +2 -2
- package/funcs/agentsDelete.js.map +1 -1
- package/funcs/agentsGetById.d.ts +1 -1
- package/funcs/agentsGetById.d.ts.map +1 -1
- package/funcs/agentsGetById.js +1 -1
- package/funcs/agentsGetById.js.map +1 -1
- package/funcs/agentsList.d.ts +1 -1
- package/funcs/agentsList.d.ts.map +1 -1
- package/funcs/agentsList.js +1 -1
- package/funcs/agentsList.js.map +1 -1
- package/funcs/agentsUpdate.d.ts +1 -1
- package/funcs/agentsUpdate.d.ts.map +1 -1
- package/funcs/agentsUpdate.js +3 -3
- package/funcs/agentsUpdate.js.map +1 -1
- package/funcs/customMessagesCreate.d.ts +1 -1
- package/funcs/customMessagesCreate.d.ts.map +1 -1
- package/funcs/customMessagesCreate.js +2 -2
- package/funcs/customMessagesCreate.js.map +1 -1
- package/funcs/customMessagesGetById.d.ts +1 -1
- package/funcs/customMessagesGetById.d.ts.map +1 -1
- package/funcs/customMessagesGetById.js +1 -1
- package/funcs/customMessagesGetById.js.map +1 -1
- package/funcs/customMessagesList.d.ts +1 -1
- package/funcs/customMessagesList.d.ts.map +1 -1
- package/funcs/customMessagesList.js +1 -1
- package/funcs/customMessagesList.js.map +1 -1
- package/funcs/customMessagesUpdate.d.ts +1 -1
- package/funcs/customMessagesUpdate.d.ts.map +1 -1
- package/funcs/customMessagesUpdate.js +2 -2
- package/funcs/customMessagesUpdate.js.map +1 -1
- package/funcs/directoryCreate.d.ts +16 -0
- package/funcs/directoryCreate.d.ts.map +1 -0
- package/funcs/directoryCreate.js +99 -0
- package/funcs/directoryCreate.js.map +1 -0
- package/funcs/directoryDelete.d.ts +16 -0
- package/funcs/directoryDelete.d.ts.map +1 -0
- package/funcs/directoryDelete.js +105 -0
- package/funcs/directoryDelete.js.map +1 -0
- package/funcs/directoryDirectoryMemberBulkLoad.d.ts +16 -0
- package/funcs/directoryDirectoryMemberBulkLoad.d.ts.map +1 -0
- package/funcs/directoryDirectoryMemberBulkLoad.js +112 -0
- package/funcs/directoryDirectoryMemberBulkLoad.js.map +1 -0
- package/funcs/directoryDirectoryMemberDownload.d.ts +14 -0
- package/funcs/directoryDirectoryMemberDownload.d.ts.map +1 -0
- package/funcs/directoryDirectoryMemberDownload.js +85 -0
- package/funcs/directoryDirectoryMemberDownload.js.map +1 -0
- package/funcs/directoryGetById.d.ts +17 -0
- package/funcs/directoryGetById.d.ts.map +1 -0
- package/funcs/directoryGetById.js +105 -0
- package/funcs/directoryGetById.js.map +1 -0
- package/funcs/directoryList.d.ts +17 -0
- package/funcs/directoryList.d.ts.map +1 -0
- package/funcs/directoryList.js +111 -0
- package/funcs/directoryList.js.map +1 -0
- package/funcs/directoryUpdate.d.ts +17 -0
- package/funcs/directoryUpdate.d.ts.map +1 -0
- package/funcs/directoryUpdate.js +106 -0
- package/funcs/directoryUpdate.js.map +1 -0
- package/funcs/promptsDelete.d.ts +3 -0
- package/funcs/promptsDelete.d.ts.map +1 -1
- package/funcs/promptsDelete.js +3 -0
- package/funcs/promptsDelete.js.map +1 -1
- package/funcs/promptsPromptsHistory.d.ts +17 -0
- package/funcs/promptsPromptsHistory.d.ts.map +1 -0
- package/funcs/promptsPromptsHistory.js +106 -0
- package/funcs/promptsPromptsHistory.js.map +1 -0
- package/funcs/promptsUpdate.d.ts +1 -1
- package/funcs/promptsUpdate.d.ts.map +1 -1
- package/funcs/promptsUpdate.js +1 -1
- package/funcs/promptsUpdate.js.map +1 -1
- package/funcs/servicesCreate.d.ts +13 -0
- package/funcs/servicesCreate.d.ts.map +1 -0
- package/funcs/servicesCreate.js +96 -0
- package/funcs/servicesCreate.js.map +1 -0
- package/funcs/servicesList.d.ts +17 -0
- package/funcs/servicesList.d.ts.map +1 -0
- package/funcs/servicesList.js +111 -0
- package/funcs/servicesList.js.map +1 -0
- package/funcs/servicesUpdate.d.ts +13 -0
- package/funcs/servicesUpdate.d.ts.map +1 -0
- package/funcs/servicesUpdate.js +96 -0
- package/funcs/servicesUpdate.js.map +1 -0
- package/funcs/sessionsGenerateSessionRecordingUrls.d.ts +14 -0
- package/funcs/sessionsGenerateSessionRecordingUrls.d.ts.map +1 -0
- package/funcs/sessionsGenerateSessionRecordingUrls.js +102 -0
- package/funcs/sessionsGenerateSessionRecordingUrls.js.map +1 -0
- package/funcs/sessionsGetById.d.ts +14 -0
- package/funcs/sessionsGetById.d.ts.map +1 -0
- package/funcs/sessionsGetById.js +102 -0
- package/funcs/sessionsGetById.js.map +1 -0
- package/funcs/sessionsSessionRecordingStream.d.ts +13 -0
- package/funcs/sessionsSessionRecordingStream.d.ts.map +1 -0
- package/funcs/sessionsSessionRecordingStream.js +100 -0
- package/funcs/sessionsSessionRecordingStream.js.map +1 -0
- package/funcs/toolsCreate.d.ts +16 -0
- package/funcs/toolsCreate.d.ts.map +1 -0
- package/funcs/toolsCreate.js +99 -0
- package/funcs/toolsCreate.js.map +1 -0
- package/funcs/toolsList.d.ts +1 -1
- package/funcs/toolsList.js +1 -1
- package/funcs/toolsUpdate.d.ts +16 -0
- package/funcs/toolsUpdate.d.ts.map +1 -0
- package/funcs/toolsUpdate.js +99 -0
- package/funcs/toolsUpdate.js.map +1 -0
- package/funcs/v1AgentGetAvailableVoices.d.ts +15 -0
- package/funcs/v1AgentGetAvailableVoices.d.ts.map +1 -0
- package/funcs/v1AgentGetAvailableVoices.js +86 -0
- package/funcs/v1AgentGetAvailableVoices.js.map +1 -0
- package/funcs/v1Create.d.ts +3 -3
- package/funcs/v1Create.d.ts.map +1 -1
- package/funcs/v1Create.js +6 -6
- package/funcs/v1Create.js.map +1 -1
- package/funcs/v1Delete.d.ts +16 -0
- package/funcs/v1Delete.d.ts.map +1 -0
- package/funcs/v1Delete.js +105 -0
- package/funcs/v1Delete.js.map +1 -0
- package/funcs/v1DirectoryMemberBulkLoad.d.ts +16 -0
- package/funcs/v1DirectoryMemberBulkLoad.d.ts.map +1 -0
- package/funcs/v1DirectoryMemberBulkLoad.js +112 -0
- package/funcs/v1DirectoryMemberBulkLoad.js.map +1 -0
- package/funcs/v1DirectoryMemberDownload.d.ts +14 -0
- package/funcs/v1DirectoryMemberDownload.d.ts.map +1 -0
- package/funcs/v1DirectoryMemberDownload.js +85 -0
- package/funcs/v1DirectoryMemberDownload.js.map +1 -0
- package/funcs/v1GetById.d.ts +5 -2
- package/funcs/v1GetById.d.ts.map +1 -1
- package/funcs/v1GetById.js +12 -6
- package/funcs/v1GetById.js.map +1 -1
- package/funcs/v1List.d.ts +5 -2
- package/funcs/v1List.d.ts.map +1 -1
- package/funcs/v1List.js +8 -5
- package/funcs/v1List.js.map +1 -1
- package/funcs/v1Update.d.ts +17 -0
- package/funcs/v1Update.d.ts.map +1 -0
- package/funcs/v1Update.js +106 -0
- package/funcs/v1Update.js.map +1 -0
- package/hooks/hooks.d.ts.map +1 -1
- package/hooks/hooks.js +18 -0
- package/hooks/hooks.js.map +1 -1
- package/hooks/types.d.ts +1 -0
- package/hooks/types.d.ts.map +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/lib/matchers.js +1 -1
- package/lib/matchers.js.map +1 -1
- package/lib/primitives.d.ts +2 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +53 -0
- package/lib/primitives.js.map +1 -1
- package/models/components/agent.d.ts +21 -21
- package/models/components/agent.d.ts.map +1 -1
- package/models/components/agent.js +29 -18
- package/models/components/agent.js.map +1 -1
- package/models/components/agentcreate.d.ts +14 -21
- package/models/components/agentcreate.d.ts.map +1 -1
- package/models/components/agentcreate.js +16 -20
- package/models/components/agentcreate.js.map +1 -1
- package/models/components/agentproperties.d.ts +18 -0
- package/models/components/agentproperties.d.ts.map +1 -1
- package/models/components/agentproperties.js +6 -0
- package/models/components/agentproperties.js.map +1 -1
- package/models/components/agentresponse.d.ts +115 -0
- package/models/components/agentresponse.d.ts.map +1 -0
- package/models/components/agentresponse.js +118 -0
- package/models/components/agentresponse.js.map +1 -0
- package/models/components/agenttooldefaults.d.ts +4 -0
- package/models/components/agenttooldefaults.d.ts.map +1 -1
- package/models/components/agenttooldefaults.js +9 -0
- package/models/components/agenttooldefaults.js.map +1 -1
- package/models/components/agenttoolfielddefault.d.ts +4 -0
- package/models/components/agenttoolfielddefault.d.ts.map +1 -1
- package/models/components/agenttoolfielddefault.js +9 -0
- package/models/components/agenttoolfielddefault.js.map +1 -1
- package/models/components/agentupdate.d.ts +63 -0
- package/models/components/agentupdate.d.ts.map +1 -0
- package/models/components/agentupdate.js +97 -0
- package/models/components/agentupdate.js.map +1 -0
- package/models/components/agentvoice.d.ts +35 -0
- package/models/components/agentvoice.d.ts.map +1 -0
- package/models/components/agentvoice.js +76 -0
- package/models/components/agentvoice.js.map +1 -0
- package/models/components/agentvoicevarname.d.ts +106 -0
- package/models/components/agentvoicevarname.d.ts.map +1 -0
- package/models/components/agentvoicevarname.js +76 -0
- package/models/components/agentvoicevarname.js.map +1 -0
- package/models/components/availabletarget.d.ts +4 -0
- package/models/components/availabletarget.d.ts.map +1 -1
- package/models/components/availabletarget.js +9 -0
- package/models/components/availabletarget.js.map +1 -1
- package/models/components/bodydirectorymemberbulkload.d.ts +56 -0
- package/models/components/bodydirectorymemberbulkload.d.ts.map +1 -0
- package/models/components/bodydirectorymemberbulkload.js +100 -0
- package/models/components/bodydirectorymemberbulkload.js.map +1 -0
- package/models/components/channel.d.ts +4 -0
- package/models/components/channel.d.ts.map +1 -1
- package/models/components/channel.js +9 -0
- package/models/components/channel.js.map +1 -1
- package/models/components/channeltarget.d.ts +4 -0
- package/models/components/channeltarget.d.ts.map +1 -1
- package/models/components/channeltarget.js +9 -0
- package/models/components/channeltarget.js.map +1 -1
- package/models/components/channeltargetcreaterequest.d.ts +4 -0
- package/models/components/channeltargetcreaterequest.d.ts.map +1 -1
- package/models/components/channeltargetcreaterequest.js +9 -0
- package/models/components/channeltargetcreaterequest.js.map +1 -1
- package/models/components/conversation.d.ts +4 -0
- package/models/components/conversation.d.ts.map +1 -1
- package/models/components/conversation.js +9 -0
- package/models/components/conversation.js.map +1 -1
- package/models/components/custommessage.d.ts +7 -5
- package/models/components/custommessage.d.ts.map +1 -1
- package/models/components/custommessage.js +9 -2
- package/models/components/custommessage.js.map +1 -1
- package/models/components/custommessagecreaterequest.d.ts +44 -0
- package/models/components/custommessagecreaterequest.d.ts.map +1 -0
- package/models/components/custommessagecreaterequest.js +65 -0
- package/models/components/custommessagecreaterequest.js.map +1 -0
- package/models/components/custommessageproperties.d.ts +6 -0
- package/models/components/custommessageproperties.d.ts.map +1 -1
- package/models/components/custommessageproperties.js +2 -0
- package/models/components/custommessageproperties.js.map +1 -1
- package/models/components/custommessageresponse.d.ts +64 -0
- package/models/components/custommessageresponse.d.ts.map +1 -0
- package/models/components/custommessageresponse.js +86 -0
- package/models/components/custommessageresponse.js.map +1 -0
- package/models/components/custommessageupdaterequest.d.ts +49 -0
- package/models/components/custommessageupdaterequest.d.ts.map +1 -0
- package/models/components/custommessageupdaterequest.js +67 -0
- package/models/components/custommessageupdaterequest.js.map +1 -0
- package/models/components/directoryextension.d.ts +52 -0
- package/models/components/directoryextension.d.ts.map +1 -0
- package/models/components/directoryextension.js +84 -0
- package/models/components/directoryextension.js.map +1 -0
- package/models/components/directorymember.d.ts +63 -0
- package/models/components/directorymember.d.ts.map +1 -0
- package/models/components/directorymember.js +108 -0
- package/models/components/directorymember.js.map +1 -0
- package/models/components/directorymembercreate.d.ts +61 -0
- package/models/components/directorymembercreate.d.ts.map +1 -0
- package/models/components/directorymembercreate.js +106 -0
- package/models/components/directorymembercreate.js.map +1 -0
- package/models/components/directorymemberproperties.d.ts +40 -0
- package/models/components/directorymemberproperties.d.ts.map +1 -0
- package/models/components/directorymemberproperties.js +54 -0
- package/models/components/directorymemberproperties.js.map +1 -0
- package/models/components/event.d.ts +6 -0
- package/models/components/event.d.ts.map +1 -1
- package/models/components/event.js +17 -0
- package/models/components/event.js.map +1 -1
- package/models/components/index.d.ts +28 -3
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +28 -3
- package/models/components/index.js.map +1 -1
- package/models/components/listresponseagentresponse.d.ts +38 -0
- package/models/components/listresponseagentresponse.d.ts.map +1 -0
- package/models/components/{listresponsecustommessage.js → listresponseagentresponse.js} +23 -14
- package/models/components/listresponseagentresponse.js.map +1 -0
- package/models/components/listresponseavailabletarget.d.ts +4 -0
- package/models/components/listresponseavailabletarget.d.ts.map +1 -1
- package/models/components/listresponseavailabletarget.js +9 -0
- package/models/components/listresponseavailabletarget.js.map +1 -1
- package/models/components/listresponsechannel.d.ts +4 -0
- package/models/components/listresponsechannel.d.ts.map +1 -1
- package/models/components/listresponsechannel.js +9 -0
- package/models/components/listresponsechannel.js.map +1 -1
- package/models/components/listresponsechanneltarget.d.ts +4 -0
- package/models/components/listresponsechanneltarget.d.ts.map +1 -1
- package/models/components/listresponsechanneltarget.js +9 -0
- package/models/components/listresponsechanneltarget.js.map +1 -1
- package/models/components/listresponseconversation.d.ts +4 -0
- package/models/components/listresponseconversation.d.ts.map +1 -1
- package/models/components/listresponseconversation.js +9 -0
- package/models/components/listresponseconversation.js.map +1 -1
- package/models/components/listresponsecustommessageresponse.d.ts +38 -0
- package/models/components/listresponsecustommessageresponse.d.ts.map +1 -0
- package/models/components/listresponsecustommessageresponse.js +81 -0
- package/models/components/listresponsecustommessageresponse.js.map +1 -0
- package/models/components/listresponsedirectorymember.d.ts +38 -0
- package/models/components/listresponsedirectorymember.d.ts.map +1 -0
- package/models/components/listresponsedirectorymember.js +81 -0
- package/models/components/listresponsedirectorymember.js.map +1 -0
- package/models/components/listresponseevent.d.ts +4 -0
- package/models/components/listresponseevent.d.ts.map +1 -1
- package/models/components/listresponseevent.js +9 -0
- package/models/components/listresponseevent.js.map +1 -1
- package/models/components/listresponseprompt.d.ts +4 -0
- package/models/components/listresponseprompt.d.ts.map +1 -1
- package/models/components/listresponseprompt.js +9 -0
- package/models/components/listresponseprompt.js.map +1 -1
- package/models/components/listresponseservice.d.ts +38 -0
- package/models/components/listresponseservice.d.ts.map +1 -0
- package/models/components/{listresponseagent.js → listresponseservice.js} +23 -14
- package/models/components/listresponseservice.js.map +1 -0
- package/models/components/listresponsesession.d.ts +4 -0
- package/models/components/listresponsesession.d.ts.map +1 -1
- package/models/components/listresponsesession.js +9 -0
- package/models/components/listresponsesession.js.map +1 -1
- package/models/components/listresponsesessionlabel.d.ts +4 -0
- package/models/components/listresponsesessionlabel.d.ts.map +1 -1
- package/models/components/listresponsesessionlabel.js +9 -0
- package/models/components/listresponsesessionlabel.js.map +1 -1
- package/models/components/listresponsetool.d.ts +4 -0
- package/models/components/listresponsetool.d.ts.map +1 -1
- package/models/components/listresponsetool.js +9 -0
- package/models/components/listresponsetool.js.map +1 -1
- package/models/components/llmconfig.d.ts +4 -0
- package/models/components/llmconfig.d.ts.map +1 -1
- package/models/components/llmconfig.js +9 -0
- package/models/components/llmconfig.js.map +1 -1
- package/models/components/prompt.d.ts +24 -0
- package/models/components/prompt.d.ts.map +1 -1
- package/models/components/prompt.js +23 -0
- package/models/components/prompt.js.map +1 -1
- package/models/components/promptcreate.d.ts +9 -0
- package/models/components/promptcreate.d.ts.map +1 -1
- package/models/components/promptcreate.js +11 -0
- package/models/components/promptcreate.js.map +1 -1
- package/models/components/prompthistory.d.ts +43 -0
- package/models/components/prompthistory.d.ts.map +1 -0
- package/models/components/prompthistory.js +92 -0
- package/models/components/prompthistory.js.map +1 -0
- package/models/components/promptproperties.d.ts +15 -0
- package/models/components/promptproperties.d.ts.map +1 -1
- package/models/components/promptproperties.js +5 -0
- package/models/components/promptproperties.js.map +1 -1
- package/models/components/promptupdate.d.ts +65 -0
- package/models/components/promptupdate.d.ts.map +1 -0
- package/models/components/promptupdate.js +85 -0
- package/models/components/promptupdate.js.map +1 -0
- package/models/components/security.d.ts +4 -0
- package/models/components/security.d.ts.map +1 -1
- package/models/components/security.js +9 -0
- package/models/components/security.js.map +1 -1
- package/models/components/service.d.ts +47 -0
- package/models/components/service.d.ts.map +1 -0
- package/models/components/service.js +65 -0
- package/models/components/service.js.map +1 -0
- package/models/components/servicecreate.d.ts +37 -0
- package/models/components/servicecreate.d.ts.map +1 -0
- package/models/components/servicecreate.js +61 -0
- package/models/components/servicecreate.js.map +1 -0
- package/models/components/serviceproperties.d.ts +28 -0
- package/models/components/serviceproperties.d.ts.map +1 -0
- package/models/components/{custommessagecreate.js → serviceproperties.js} +15 -19
- package/models/components/serviceproperties.js.map +1 -0
- package/models/components/serviceupdate.d.ts +42 -0
- package/models/components/serviceupdate.d.ts.map +1 -0
- package/models/components/serviceupdate.js +63 -0
- package/models/components/serviceupdate.js.map +1 -0
- package/models/components/session.d.ts +8 -0
- package/models/components/session.d.ts.map +1 -1
- package/models/components/session.js +17 -0
- package/models/components/session.js.map +1 -1
- package/models/components/sessionaction.d.ts +4 -0
- package/models/components/sessionaction.d.ts.map +1 -1
- package/models/components/sessionaction.js +9 -0
- package/models/components/sessionaction.js.map +1 -1
- package/models/components/sessionlabel.d.ts +4 -0
- package/models/components/sessionlabel.d.ts.map +1 -1
- package/models/components/sessionlabel.js +9 -0
- package/models/components/sessionlabel.js.map +1 -1
- package/models/components/sessionlabelcreate.d.ts +4 -0
- package/models/components/sessionlabelcreate.d.ts.map +1 -1
- package/models/components/sessionlabelcreate.js +9 -0
- package/models/components/sessionlabelcreate.js.map +1 -1
- package/models/components/sessionproperties.d.ts +3 -0
- package/models/components/sessionproperties.d.ts.map +1 -1
- package/models/components/sessionproperties.js +1 -0
- package/models/components/sessionproperties.js.map +1 -1
- package/models/components/sessionrecordingresponse.d.ts +33 -0
- package/models/components/sessionrecordingresponse.d.ts.map +1 -0
- package/models/components/sessionrecordingresponse.js +72 -0
- package/models/components/sessionrecordingresponse.js.map +1 -0
- package/models/components/sessiontext.d.ts +4 -0
- package/models/components/sessiontext.d.ts.map +1 -1
- package/models/components/sessiontext.js +9 -0
- package/models/components/sessiontext.js.map +1 -1
- package/models/components/sessiontranscriptionresponse.d.ts +4 -0
- package/models/components/sessiontranscriptionresponse.d.ts.map +1 -1
- package/models/components/sessiontranscriptionresponse.js +9 -0
- package/models/components/sessiontranscriptionresponse.js.map +1 -1
- package/models/components/sttprovider.d.ts +31 -0
- package/models/components/sttprovider.d.ts.map +1 -0
- package/models/components/sttprovider.js +52 -0
- package/models/components/sttprovider.js.map +1 -0
- package/models/components/target.d.ts +65 -0
- package/models/components/target.d.ts.map +1 -0
- package/models/components/target.js +94 -0
- package/models/components/target.js.map +1 -0
- package/models/components/targetmodes.d.ts +34 -0
- package/models/components/targetmodes.d.ts.map +1 -0
- package/models/components/targetmodes.js +53 -0
- package/models/components/targetmodes.js.map +1 -0
- package/models/components/testmessage.d.ts +4 -0
- package/models/components/testmessage.d.ts.map +1 -1
- package/models/components/testmessage.js +9 -0
- package/models/components/testmessage.js.map +1 -1
- package/models/components/testmessageresponse.d.ts +8 -0
- package/models/components/testmessageresponse.d.ts.map +1 -1
- package/models/components/testmessageresponse.js +21 -0
- package/models/components/testmessageresponse.js.map +1 -1
- package/models/components/tool.d.ts +6 -0
- package/models/components/tool.d.ts.map +1 -1
- package/models/components/tool.js +17 -0
- package/models/components/tool.js.map +1 -1
- package/models/components/toolcreate.d.ts +66 -0
- package/models/components/toolcreate.d.ts.map +1 -0
- package/models/components/toolcreate.js +95 -0
- package/models/components/toolcreate.js.map +1 -0
- package/models/components/tooldetailresponse.d.ts +4 -0
- package/models/components/tooldetailresponse.d.ts.map +1 -1
- package/models/components/tooldetailresponse.js +9 -0
- package/models/components/tooldetailresponse.js.map +1 -1
- package/models/components/toolupdate.d.ts +71 -0
- package/models/components/toolupdate.d.ts.map +1 -0
- package/models/components/toolupdate.js +97 -0
- package/models/components/toolupdate.js.map +1 -0
- package/models/components/validationerror.d.ts +6 -0
- package/models/components/validationerror.d.ts.map +1 -1
- package/models/components/validationerror.js +17 -0
- package/models/components/validationerror.js.map +1 -1
- package/models/operations/agentdelete.d.ts +4 -0
- package/models/operations/agentdelete.d.ts.map +1 -1
- package/models/operations/agentdelete.js +9 -0
- package/models/operations/agentdelete.js.map +1 -1
- package/models/operations/agentgetbyid.d.ts +4 -0
- package/models/operations/agentgetbyid.d.ts.map +1 -1
- package/models/operations/agentgetbyid.js +9 -0
- package/models/operations/agentgetbyid.js.map +1 -1
- package/models/operations/agentlist.d.ts +8 -4
- package/models/operations/agentlist.d.ts.map +1 -1
- package/models/operations/agentlist.js +15 -4
- package/models/operations/agentlist.js.map +1 -1
- package/models/operations/availabletargets.d.ts +8 -4
- package/models/operations/availabletargets.d.ts.map +1 -1
- package/models/operations/availabletargets.js +17 -4
- package/models/operations/availabletargets.js.map +1 -1
- package/models/operations/channelslist.d.ts +8 -4
- package/models/operations/channelslist.d.ts.map +1 -1
- package/models/operations/channelslist.js +15 -4
- package/models/operations/channelslist.js.map +1 -1
- package/models/operations/channeltargetscreate.d.ts +4 -0
- package/models/operations/channeltargetscreate.d.ts.map +1 -1
- package/models/operations/channeltargetscreate.js +9 -0
- package/models/operations/channeltargetscreate.js.map +1 -1
- package/models/operations/channeltargetsdelete.d.ts +4 -0
- package/models/operations/channeltargetsdelete.d.ts.map +1 -1
- package/models/operations/channeltargetsdelete.js +9 -0
- package/models/operations/channeltargetsdelete.js.map +1 -1
- package/models/operations/channeltargetsgetbyid.d.ts +4 -0
- package/models/operations/channeltargetsgetbyid.d.ts.map +1 -1
- package/models/operations/channeltargetsgetbyid.js +9 -0
- package/models/operations/channeltargetsgetbyid.js.map +1 -1
- package/models/operations/channeltargetslist.d.ts +8 -4
- package/models/operations/channeltargetslist.d.ts.map +1 -1
- package/models/operations/channeltargetslist.js +17 -4
- package/models/operations/channeltargetslist.js.map +1 -1
- package/models/operations/channeltargetsupdate.d.ts +4 -0
- package/models/operations/channeltargetsupdate.d.ts.map +1 -1
- package/models/operations/channeltargetsupdate.js +9 -0
- package/models/operations/channeltargetsupdate.js.map +1 -1
- package/models/operations/conversationslist.d.ts +8 -4
- package/models/operations/conversationslist.d.ts.map +1 -1
- package/models/operations/conversationslist.js +17 -4
- package/models/operations/conversationslist.js.map +1 -1
- package/models/operations/custommessagegetbyid.d.ts +4 -0
- package/models/operations/custommessagegetbyid.d.ts.map +1 -1
- package/models/operations/custommessagegetbyid.js +9 -0
- package/models/operations/custommessagegetbyid.js.map +1 -1
- package/models/operations/custommessagesdelete.d.ts +4 -0
- package/models/operations/custommessagesdelete.d.ts.map +1 -1
- package/models/operations/custommessagesdelete.js +9 -0
- package/models/operations/custommessagesdelete.js.map +1 -1
- package/models/operations/custommessageslist.d.ts +8 -4
- package/models/operations/custommessageslist.d.ts.map +1 -1
- package/models/operations/custommessageslist.js +17 -4
- package/models/operations/custommessageslist.js.map +1 -1
- package/models/operations/directorymemberdelete.d.ts +29 -0
- package/models/operations/directorymemberdelete.d.ts.map +1 -0
- package/models/operations/directorymemberdelete.js +68 -0
- package/models/operations/directorymemberdelete.js.map +1 -0
- package/models/operations/directorymembergetbyid.d.ts +29 -0
- package/models/operations/directorymembergetbyid.d.ts.map +1 -0
- package/models/operations/directorymembergetbyid.js +68 -0
- package/models/operations/directorymembergetbyid.js.map +1 -0
- package/models/operations/directorymemberlist.d.ts +46 -0
- package/models/operations/directorymemberlist.d.ts.map +1 -0
- package/models/operations/directorymemberlist.js +101 -0
- package/models/operations/directorymemberlist.js.map +1 -0
- package/models/operations/directorymemberupdate.d.ts +32 -0
- package/models/operations/directorymemberupdate.d.ts.map +1 -0
- package/models/operations/directorymemberupdate.js +73 -0
- package/models/operations/directorymemberupdate.js.map +1 -0
- package/models/operations/eventslist.d.ts +8 -4
- package/models/operations/eventslist.d.ts.map +1 -1
- package/models/operations/eventslist.js +15 -4
- package/models/operations/eventslist.js.map +1 -1
- package/models/operations/generatesessionrecordingurls.d.ts +29 -0
- package/models/operations/generatesessionrecordingurls.d.ts.map +1 -0
- package/models/operations/generatesessionrecordingurls.js +68 -0
- package/models/operations/generatesessionrecordingurls.js.map +1 -0
- package/models/operations/getdailycallvolumebyhour.d.ts +4 -0
- package/models/operations/getdailycallvolumebyhour.d.ts.map +1 -1
- package/models/operations/getdailycallvolumebyhour.js +11 -0
- package/models/operations/getdailycallvolumebyhour.js.map +1 -1
- package/models/operations/getmonthlycallvolumebyday.d.ts +4 -0
- package/models/operations/getmonthlycallvolumebyday.d.ts.map +1 -1
- package/models/operations/getmonthlycallvolumebyday.js +11 -0
- package/models/operations/getmonthlycallvolumebyday.js.map +1 -1
- package/models/operations/getmonthlycallvolumebyweek.d.ts +4 -0
- package/models/operations/getmonthlycallvolumebyweek.d.ts.map +1 -1
- package/models/operations/getmonthlycallvolumebyweek.js +11 -0
- package/models/operations/getmonthlycallvolumebyweek.js.map +1 -1
- package/models/operations/getsessionagents.d.ts +4 -0
- package/models/operations/getsessionagents.d.ts.map +1 -1
- package/models/operations/getsessionagents.js +9 -0
- package/models/operations/getsessionagents.js.map +1 -1
- package/models/operations/getsessionsummary.d.ts +6 -0
- package/models/operations/getsessionsummary.d.ts.map +1 -1
- package/models/operations/getsessionsummary.js +17 -0
- package/models/operations/getsessionsummary.js.map +1 -1
- package/models/operations/gettotalcallvolumebyhour.d.ts +4 -0
- package/models/operations/gettotalcallvolumebyhour.d.ts.map +1 -1
- package/models/operations/gettotalcallvolumebyhour.js +11 -0
- package/models/operations/gettotalcallvolumebyhour.js.map +1 -1
- package/models/operations/getweeklycallvolumebyweekday.d.ts +4 -0
- package/models/operations/getweeklycallvolumebyweekday.d.ts.map +1 -1
- package/models/operations/getweeklycallvolumebyweekday.js +11 -0
- package/models/operations/getweeklycallvolumebyweekday.js.map +1 -1
- package/models/operations/index.d.ts +9 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +9 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/promptsdelete.d.ts +4 -0
- package/models/operations/promptsdelete.d.ts.map +1 -1
- package/models/operations/promptsdelete.js +9 -0
- package/models/operations/promptsdelete.js.map +1 -1
- package/models/operations/promptsgetbyid.d.ts +4 -0
- package/models/operations/promptsgetbyid.d.ts.map +1 -1
- package/models/operations/promptsgetbyid.js +9 -0
- package/models/operations/promptsgetbyid.js.map +1 -1
- package/models/operations/promptshistory.d.ts +29 -0
- package/models/operations/promptshistory.d.ts.map +1 -0
- package/models/operations/promptshistory.js +68 -0
- package/models/operations/promptshistory.js.map +1 -0
- package/models/operations/promptslist.d.ts +8 -4
- package/models/operations/promptslist.d.ts.map +1 -1
- package/models/operations/promptslist.js +15 -4
- package/models/operations/promptslist.js.map +1 -1
- package/models/operations/servicelist.d.ts +46 -0
- package/models/operations/servicelist.d.ts.map +1 -0
- package/models/operations/servicelist.js +99 -0
- package/models/operations/servicelist.js.map +1 -0
- package/models/operations/sessiongetbyid.d.ts +29 -0
- package/models/operations/sessiongetbyid.d.ts.map +1 -0
- package/models/operations/sessiongetbyid.js +68 -0
- package/models/operations/sessiongetbyid.js.map +1 -0
- package/models/operations/sessionlabelgetbyid.d.ts +4 -0
- package/models/operations/sessionlabelgetbyid.d.ts.map +1 -1
- package/models/operations/sessionlabelgetbyid.js +9 -0
- package/models/operations/sessionlabelgetbyid.js.map +1 -1
- package/models/operations/sessionlabelslist.d.ts +8 -4
- package/models/operations/sessionlabelslist.d.ts.map +1 -1
- package/models/operations/sessionlabelslist.js +17 -4
- package/models/operations/sessionlabelslist.js.map +1 -1
- package/models/operations/sessionrecordingstream.d.ts +29 -0
- package/models/operations/sessionrecordingstream.d.ts.map +1 -0
- package/models/operations/sessionrecordingstream.js +59 -0
- package/models/operations/sessionrecordingstream.js.map +1 -0
- package/models/operations/sessionslist.d.ts +8 -4
- package/models/operations/sessionslist.d.ts.map +1 -1
- package/models/operations/sessionslist.js +15 -4
- package/models/operations/sessionslist.js.map +1 -1
- package/models/operations/sessiontranscriptgetbyid.d.ts +4 -0
- package/models/operations/sessiontranscriptgetbyid.d.ts.map +1 -1
- package/models/operations/sessiontranscriptgetbyid.js +9 -0
- package/models/operations/sessiontranscriptgetbyid.js.map +1 -1
- package/models/operations/toolgetbyname.d.ts +4 -0
- package/models/operations/toolgetbyname.d.ts.map +1 -1
- package/models/operations/toolgetbyname.js +9 -0
- package/models/operations/toolgetbyname.js.map +1 -1
- package/models/operations/toollist.d.ts +8 -4
- package/models/operations/toollist.d.ts.map +1 -1
- package/models/operations/toollist.js +15 -4
- package/models/operations/toollist.js.map +1 -1
- package/models/operations/totalcallvolumebyweekday.d.ts +4 -0
- package/models/operations/totalcallvolumebyweekday.d.ts.map +1 -1
- package/models/operations/totalcallvolumebyweekday.js +11 -0
- package/models/operations/totalcallvolumebyweekday.js.map +1 -1
- package/package.json +1 -1
- package/sdk/agents.d.ts +10 -3
- package/sdk/agents.d.ts.map +1 -1
- package/sdk/agents.js +10 -0
- package/sdk/agents.js.map +1 -1
- package/sdk/custommessages.d.ts +4 -4
- package/sdk/custommessages.d.ts.map +1 -1
- package/sdk/custommessages.js.map +1 -1
- package/sdk/directory.d.ts +55 -0
- package/sdk/directory.d.ts.map +1 -0
- package/sdk/directory.js +82 -0
- package/sdk/directory.js.map +1 -0
- package/sdk/prompts.d.ts +11 -1
- package/sdk/prompts.d.ts.map +1 -1
- package/sdk/prompts.js +13 -0
- package/sdk/prompts.js.map +1 -1
- package/sdk/sdk.d.ts +8 -2
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +14 -4
- package/sdk/sdk.js.map +1 -1
- package/sdk/services.d.ts +21 -0
- package/sdk/services.d.ts.map +1 -0
- package/sdk/services.js +36 -0
- package/sdk/services.js.map +1 -0
- package/sdk/sessions.d.ts +12 -0
- package/sdk/sessions.d.ts.map +1 -1
- package/sdk/sessions.js +21 -0
- package/sdk/sessions.js.map +1 -1
- package/sdk/tools.d.ts +15 -1
- package/sdk/tools.d.ts.map +1 -1
- package/sdk/tools.js +21 -1
- package/sdk/tools.js.map +1 -1
- package/sdk/v1.d.ts +48 -7
- package/sdk/v1.d.ts.map +1 -1
- package/sdk/v1.js +64 -8
- package/sdk/v1.js.map +1 -1
- package/src/funcs/agentsAgentGetAvailableVoices.ts +108 -0
- package/src/funcs/agentsCreate.ts +2 -2
- package/src/funcs/agentsDelete.ts +2 -2
- package/src/funcs/agentsGetById.ts +3 -3
- package/src/funcs/agentsList.ts +3 -3
- package/src/funcs/agentsUpdate.ts +4 -4
- package/src/funcs/customMessagesCreate.ts +6 -5
- package/src/funcs/customMessagesGetById.ts +3 -3
- package/src/funcs/customMessagesList.ts +3 -3
- package/src/funcs/customMessagesUpdate.ts +6 -5
- package/src/funcs/directoryCreate.ts +131 -0
- package/src/funcs/directoryDelete.ts +139 -0
- package/src/funcs/directoryDirectoryMemberBulkLoad.ts +148 -0
- package/src/funcs/directoryDirectoryMemberDownload.ts +107 -0
- package/src/funcs/directoryGetById.ts +139 -0
- package/src/funcs/directoryList.ts +145 -0
- package/src/funcs/directoryUpdate.ts +140 -0
- package/src/funcs/promptsDelete.ts +3 -0
- package/src/funcs/promptsPromptsHistory.ts +139 -0
- package/src/funcs/promptsUpdate.ts +2 -2
- package/src/funcs/servicesCreate.ts +128 -0
- package/src/funcs/servicesList.ts +144 -0
- package/src/funcs/servicesUpdate.ts +128 -0
- package/src/funcs/sessionsGenerateSessionRecordingUrls.ts +140 -0
- package/src/funcs/sessionsGetById.ts +135 -0
- package/src/funcs/sessionsSessionRecordingStream.ts +134 -0
- package/src/funcs/toolsCreate.ts +131 -0
- package/src/funcs/toolsList.ts +1 -1
- package/src/funcs/toolsUpdate.ts +131 -0
- package/src/funcs/v1AgentGetAvailableVoices.ts +108 -0
- package/src/funcs/v1Create.ts +9 -9
- package/src/funcs/v1Delete.ts +139 -0
- package/src/funcs/v1DirectoryMemberBulkLoad.ts +148 -0
- package/src/funcs/v1DirectoryMemberDownload.ts +107 -0
- package/src/funcs/v1GetById.ts +15 -15
- package/src/funcs/v1List.ts +12 -8
- package/src/funcs/v1Update.ts +140 -0
- package/src/hooks/hooks.ts +20 -0
- package/src/hooks/types.ts +7 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/matchers.ts +1 -1
- package/src/lib/primitives.ts +62 -0
- package/src/models/components/agent.ts +55 -36
- package/src/models/components/agentcreate.ts +29 -38
- package/src/models/components/agentproperties.ts +6 -0
- package/src/models/components/agentresponse.ts +215 -0
- package/src/models/components/agenttooldefaults.ts +21 -0
- package/src/models/components/agenttoolfielddefault.ts +21 -0
- package/src/models/components/agentupdate.ts +130 -0
- package/src/models/components/agentvoice.ts +91 -0
- package/src/models/components/agentvoicevarname.ts +59 -0
- package/src/models/components/availabletarget.ts +19 -0
- package/src/models/components/bodydirectorymemberbulkload.ts +134 -0
- package/src/models/components/channel.ts +17 -0
- package/src/models/components/channeltarget.ts +17 -0
- package/src/models/components/channeltargetcreaterequest.ts +21 -0
- package/src/models/components/conversation.ts +17 -0
- package/src/models/components/custommessage.ts +20 -7
- package/src/models/components/custommessagecreaterequest.ts +87 -0
- package/src/models/components/custommessageproperties.ts +2 -0
- package/src/models/components/custommessageresponse.ts +128 -0
- package/src/models/components/custommessageupdaterequest.ts +94 -0
- package/src/models/components/directoryextension.ts +113 -0
- package/src/models/components/directorymember.ts +155 -0
- package/src/models/components/directorymembercreate.ts +163 -0
- package/src/models/components/directorymemberproperties.ts +39 -0
- package/src/models/components/event.ts +31 -0
- package/src/models/components/index.ts +28 -3
- package/src/models/components/listresponseagentresponse.ts +101 -0
- package/src/models/components/listresponseavailabletarget.ts +23 -0
- package/src/models/components/listresponsechannel.ts +21 -0
- package/src/models/components/listresponsechanneltarget.ts +21 -0
- package/src/models/components/listresponseconversation.ts +21 -0
- package/src/models/components/listresponsecustommessageresponse.ts +104 -0
- package/src/models/components/listresponsedirectorymember.ts +103 -0
- package/src/models/components/listresponseevent.ts +21 -0
- package/src/models/components/listresponseprompt.ts +21 -0
- package/src/models/components/listresponseservice.ts +101 -0
- package/src/models/components/listresponsesession.ts +21 -0
- package/src/models/components/listresponsesessionlabel.ts +21 -0
- package/src/models/components/listresponsetool.ts +21 -0
- package/src/models/components/llmconfig.ts +17 -0
- package/src/models/components/prompt.ts +51 -0
- package/src/models/components/promptcreate.ts +24 -0
- package/src/models/components/prompthistory.ts +109 -0
- package/src/models/components/promptproperties.ts +5 -0
- package/src/models/components/promptupdate.ts +128 -0
- package/src/models/components/security.ts +17 -0
- package/src/models/components/service.ts +83 -0
- package/src/models/components/servicecreate.ts +72 -0
- package/src/models/components/serviceproperties.ts +33 -0
- package/src/models/components/serviceupdate.ts +79 -0
- package/src/models/components/session.ts +29 -0
- package/src/models/components/sessionaction.ts +17 -0
- package/src/models/components/sessionlabel.ts +17 -0
- package/src/models/components/sessionlabelcreate.ts +21 -0
- package/src/models/components/sessionproperties.ts +1 -0
- package/src/models/components/sessionrecordingresponse.ts +83 -0
- package/src/models/components/sessiontext.ts +17 -0
- package/src/models/components/sessiontranscriptionresponse.ts +23 -0
- package/src/models/components/sttprovider.ts +32 -0
- package/src/models/components/target.ts +132 -0
- package/src/models/components/targetmodes.ts +33 -0
- package/src/models/components/testmessage.ts +17 -0
- package/src/models/components/testmessageresponse.ts +41 -0
- package/src/models/components/tool.ts +31 -0
- package/src/models/components/toolcreate.ts +141 -0
- package/src/models/components/tooldetailresponse.ts +21 -0
- package/src/models/components/toolupdate.ts +148 -0
- package/src/models/components/validationerror.ts +33 -0
- package/src/models/operations/agentdelete.ts +21 -0
- package/src/models/operations/agentgetbyid.ts +21 -0
- package/src/models/operations/agentlist.ts +31 -8
- package/src/models/operations/availabletargets.ts +33 -8
- package/src/models/operations/channelslist.ts +31 -8
- package/src/models/operations/channeltargetscreate.ts +23 -0
- package/src/models/operations/channeltargetsdelete.ts +23 -0
- package/src/models/operations/channeltargetsgetbyid.ts +23 -0
- package/src/models/operations/channeltargetslist.ts +33 -8
- package/src/models/operations/channeltargetsupdate.ts +23 -0
- package/src/models/operations/conversationslist.ts +33 -8
- package/src/models/operations/custommessagegetbyid.ts +23 -0
- package/src/models/operations/custommessagesdelete.ts +23 -0
- package/src/models/operations/custommessageslist.ts +33 -8
- package/src/models/operations/directorymemberdelete.ts +77 -0
- package/src/models/operations/directorymembergetbyid.ts +77 -0
- package/src/models/operations/directorymemberlist.ts +128 -0
- package/src/models/operations/directorymemberupdate.ts +84 -0
- package/src/models/operations/eventslist.ts +31 -8
- package/src/models/operations/generatesessionrecordingurls.ts +80 -0
- package/src/models/operations/getdailycallvolumebyhour.ts +28 -0
- package/src/models/operations/getmonthlycallvolumebyday.ts +28 -0
- package/src/models/operations/getmonthlycallvolumebyweek.ts +28 -0
- package/src/models/operations/getsessionagents.ts +30 -0
- package/src/models/operations/getsessionsummary.ts +48 -0
- package/src/models/operations/gettotalcallvolumebyhour.ts +28 -0
- package/src/models/operations/getweeklycallvolumebyweekday.ts +28 -0
- package/src/models/operations/index.ts +9 -0
- package/src/models/operations/promptsdelete.ts +21 -0
- package/src/models/operations/promptsgetbyid.ts +21 -0
- package/src/models/operations/promptshistory.ts +75 -0
- package/src/models/operations/promptslist.ts +31 -8
- package/src/models/operations/servicelist.ts +122 -0
- package/src/models/operations/sessiongetbyid.ts +75 -0
- package/src/models/operations/sessionlabelgetbyid.ts +21 -0
- package/src/models/operations/sessionlabelslist.ts +33 -8
- package/src/models/operations/sessionrecordingstream.ts +68 -0
- package/src/models/operations/sessionslist.ts +31 -8
- package/src/models/operations/sessiontranscriptgetbyid.ts +23 -0
- package/src/models/operations/toolgetbyname.ts +21 -0
- package/src/models/operations/toollist.ts +29 -8
- package/src/models/operations/totalcallvolumebyweekday.ts +28 -0
- package/src/sdk/agents.ts +19 -3
- package/src/sdk/custommessages.ts +6 -6
- package/src/sdk/directory.ts +134 -0
- package/src/sdk/prompts.ts +22 -1
- package/src/sdk/sdk.ts +17 -5
- package/src/sdk/services.ts +58 -0
- package/src/sdk/sessions.ts +45 -0
- package/src/sdk/tools.ts +37 -1
- package/src/sdk/v1.ts +106 -14
- package/src/types/operations.ts +11 -5
- package/types/operations.d.ts +5 -3
- package/types/operations.d.ts.map +1 -1
- package/types/operations.js +3 -0
- package/types/operations.js.map +1 -1
- package/models/components/custommessagecreate.d.ts +0 -35
- package/models/components/custommessagecreate.d.ts.map +0 -1
- package/models/components/custommessagecreate.js.map +0 -1
- package/models/components/listresponseagent.d.ts +0 -34
- package/models/components/listresponseagent.d.ts.map +0 -1
- package/models/components/listresponseagent.js.map +0 -1
- package/models/components/listresponsecustommessage.d.ts +0 -34
- package/models/components/listresponsecustommessage.d.ts.map +0 -1
- package/models/components/listresponsecustommessage.js.map +0 -1
- package/src/models/components/custommessagecreate.ts +0 -59
- package/src/models/components/listresponseagent.ts +0 -80
- package/src/models/components/listresponsecustommessage.ts +0 -80
package/FUNCTIONS.md
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# Standalone Functions
|
|
2
|
+
|
|
3
|
+
> [!NOTE]
|
|
4
|
+
> This section is useful if you are using a bundler and targetting browsers and
|
|
5
|
+
> runtimes where the size of an application affects performance and load times.
|
|
6
|
+
|
|
7
|
+
Every method in this SDK is also available as a standalone function. This
|
|
8
|
+
alternative API is suitable when targetting the browser or serverless runtimes
|
|
9
|
+
and using a bundler to build your application since all unused functionality
|
|
10
|
+
will be tree-shaken away. This includes code for unused methods, Zod schemas,
|
|
11
|
+
encoding helpers and response handlers. The result is dramatically smaller
|
|
12
|
+
impact on the application's final bundle size which grows very slowly as you use
|
|
13
|
+
more and more functionality from this SDK.
|
|
14
|
+
|
|
15
|
+
Calling methods through the main SDK class remains a valid and generally more
|
|
16
|
+
more ergonomic option. Standalone functions represent an optimisation for a
|
|
17
|
+
specific category of applications.
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
23
|
+
import { agentsList } from "syllable-sdk/funcs/agentsList.js";
|
|
24
|
+
import { SDKValidationError } from "syllable-sdk/models/errors/sdkvalidationerror.js";
|
|
25
|
+
|
|
26
|
+
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
27
|
+
// You can create one instance of it to use across an application.
|
|
28
|
+
const syllableSDK = new SyllableSDKCore({
|
|
29
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
async function run() {
|
|
33
|
+
const res = await agentsList(syllableSDK, {});
|
|
34
|
+
|
|
35
|
+
switch (true) {
|
|
36
|
+
case res.ok:
|
|
37
|
+
// The success case will be handled outside of the switch block
|
|
38
|
+
break;
|
|
39
|
+
case res.error instanceof SDKValidationError:
|
|
40
|
+
// Pretty-print validation errors.
|
|
41
|
+
return console.log(res.error.pretty());
|
|
42
|
+
case res.error instanceof Error:
|
|
43
|
+
return console.log(res.error);
|
|
44
|
+
default:
|
|
45
|
+
// TypeScript's type checking will fail on the following line if the above
|
|
46
|
+
// cases were not exhaustive.
|
|
47
|
+
res.error satisfies never;
|
|
48
|
+
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
const { value: result } = res;
|
|
53
|
+
|
|
54
|
+
// Handle the result
|
|
55
|
+
console.log(result);
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
run();
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## Result types
|
|
62
|
+
|
|
63
|
+
Standalone functions differ from SDK methods in that they return a
|
|
64
|
+
`Result<Value, Error>` type to capture _known errors_ and document them using
|
|
65
|
+
the type system. By avoiding throwing errors, application code maintains clear
|
|
66
|
+
control flow and error-handling become part of the regular flow of application
|
|
67
|
+
code.
|
|
68
|
+
|
|
69
|
+
> We use the term "known errors" because standalone functions, and JavaScript
|
|
70
|
+
> code in general, can still throw unexpected errors such as `TypeError`s,
|
|
71
|
+
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
|
|
72
|
+
> something this SDK addresses in the future. Nevertheless, there is still a lot
|
|
73
|
+
> of benefit from capturing most errors and turning them into values.
|
|
74
|
+
|
|
75
|
+
The second reason for this style of programming is because these functions will
|
|
76
|
+
typically be used in front-end applications where exception throwing is
|
|
77
|
+
sometimes discouraged or considered unidiomatic. React and similar ecosystems
|
|
78
|
+
and libraries tend to promote this style of programming so that components
|
|
79
|
+
render useful content under all states (loading, success, error and so on).
|
|
80
|
+
|
|
81
|
+
The general pattern when calling standalone functions looks like this:
|
|
82
|
+
|
|
83
|
+
```typescript
|
|
84
|
+
import { Core } from "<sdk-package-name>";
|
|
85
|
+
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
|
|
86
|
+
|
|
87
|
+
const client = new Core();
|
|
88
|
+
|
|
89
|
+
async function run() {
|
|
90
|
+
const result = await fetchSomething(client, { id: "123" });
|
|
91
|
+
if (!result.ok) {
|
|
92
|
+
// You can throw the error or handle it. It's your choice now.
|
|
93
|
+
throw result.error;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
console.log(result.value);
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
run();
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Notably, `result.error` above will have an explicit type compared to a try-catch
|
|
103
|
+
variation where the error in the catch block can only be of type `unknown` (or
|
|
104
|
+
`any` depending on your TypeScript settings).
|
package/README.md
CHANGED
|
@@ -13,38 +13,48 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
|
|
|
13
13
|
## Summary
|
|
14
14
|
|
|
15
15
|
SyllableSDK:
|
|
16
|
-
#
|
|
16
|
+
# Syllable Platform SDK
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
Syllable SDK gives you the power of awesome AI agentry. 🚀
|
|
19
19
|
|
|
20
20
|
## Overview
|
|
21
21
|
|
|
22
|
-
The
|
|
22
|
+
The Syllable SDK provides a comprehensive set of tools and APIs to integrate powerful AI
|
|
23
|
+
capabilities into your communication applications. Whether you're building chatbots, virtual
|
|
24
|
+
assistants, or any other AI-driven solutions, Syllable SDK has got you covered.
|
|
23
25
|
|
|
24
26
|
## Features
|
|
25
27
|
|
|
26
28
|
- **Natural Language Processing (NLP)**: Understand and generate human language with ease.
|
|
27
29
|
- **Machine Learning Models**: Leverage pre-trained models or train your own custom models.
|
|
28
30
|
- **Speech Recognition**: Convert speech to text and vice versa.
|
|
29
|
-
- **Image Recognition**: Identify objects, faces, and scenes in images.
|
|
30
31
|
- **Data Analytics**: Analyze and visualize data to gain insights.
|
|
31
32
|
- **Integration**: Seamlessly integrate with other services and platforms.
|
|
32
33
|
<!-- End Summary [summary] -->
|
|
33
34
|
|
|
34
35
|
<!-- Start Table of Contents [toc] -->
|
|
35
36
|
## Table of Contents
|
|
37
|
+
<!-- $toc-max-depth=2 -->
|
|
38
|
+
* [syllable-sdk](#syllable-sdk)
|
|
39
|
+
* [Syllable Platform SDK](#syllable-platform-sdk)
|
|
40
|
+
* [Overview](#overview)
|
|
41
|
+
* [Features](#features)
|
|
42
|
+
* [SDK Installation](#sdk-installation)
|
|
43
|
+
* [Requirements](#requirements)
|
|
44
|
+
* [SDK Example Usage](#sdk-example-usage)
|
|
45
|
+
* [Available Resources and Operations](#available-resources-and-operations)
|
|
46
|
+
* [Standalone functions](#standalone-functions)
|
|
47
|
+
* [File uploads](#file-uploads)
|
|
48
|
+
* [Retries](#retries)
|
|
49
|
+
* [Error Handling](#error-handling)
|
|
50
|
+
* [Server Selection](#server-selection)
|
|
51
|
+
* [Custom HTTP Client](#custom-http-client)
|
|
52
|
+
* [Authentication](#authentication)
|
|
53
|
+
* [Debugging](#debugging)
|
|
54
|
+
* [Development](#development)
|
|
55
|
+
* [Maturity](#maturity)
|
|
56
|
+
* [Contributions](#contributions)
|
|
36
57
|
|
|
37
|
-
* [SDK Installation](#sdk-installation)
|
|
38
|
-
* [Requirements](#requirements)
|
|
39
|
-
* [SDK Example Usage](#sdk-example-usage)
|
|
40
|
-
* [Available Resources and Operations](#available-resources-and-operations)
|
|
41
|
-
* [Standalone functions](#standalone-functions)
|
|
42
|
-
* [Retries](#retries)
|
|
43
|
-
* [Error Handling](#error-handling)
|
|
44
|
-
* [Server Selection](#server-selection)
|
|
45
|
-
* [Custom HTTP Client](#custom-http-client)
|
|
46
|
-
* [Authentication](#authentication)
|
|
47
|
-
* [Debugging](#debugging)
|
|
48
58
|
<!-- End Table of Contents [toc] -->
|
|
49
59
|
|
|
50
60
|
<!-- Start SDK Installation [installation] -->
|
|
@@ -123,6 +133,7 @@ run();
|
|
|
123
133
|
* [update](docs/sdks/agents/README.md#update) - Update Agent
|
|
124
134
|
* [getById](docs/sdks/agents/README.md#getbyid) - Get Agent By Id
|
|
125
135
|
* [delete](docs/sdks/agents/README.md#delete) - Delete Agent
|
|
136
|
+
* [agentGetAvailableVoices](docs/sdks/agents/README.md#agentgetavailablevoices) - Get Available Agent Voices
|
|
126
137
|
|
|
127
138
|
#### [agents.test](docs/sdks/test/README.md)
|
|
128
139
|
|
|
@@ -164,6 +175,16 @@ run();
|
|
|
164
175
|
* [getSessionSummary](docs/sdks/dashboards/README.md#getsessionsummary) - Get Session Summary
|
|
165
176
|
* [getSessionAgents](docs/sdks/dashboards/README.md#getsessionagents) - Get Agents
|
|
166
177
|
|
|
178
|
+
### [directory](docs/sdks/directory/README.md)
|
|
179
|
+
|
|
180
|
+
* [list](docs/sdks/directory/README.md#list) - Directory Member List
|
|
181
|
+
* [create](docs/sdks/directory/README.md#create) - Create Directory Member
|
|
182
|
+
* [getById](docs/sdks/directory/README.md#getbyid) - Get Directory Member By Id
|
|
183
|
+
* [update](docs/sdks/directory/README.md#update) - Update Directory Member
|
|
184
|
+
* [delete](docs/sdks/directory/README.md#delete) - Delete Directory Member
|
|
185
|
+
* [directoryMemberBulkLoad](docs/sdks/directory/README.md#directorymemberbulkload) - Bulk Load Directory Members
|
|
186
|
+
* [directoryMemberDownload](docs/sdks/directory/README.md#directorymemberdownload) - Download Directory Members
|
|
187
|
+
|
|
167
188
|
### [events](docs/sdks/events/README.md)
|
|
168
189
|
|
|
169
190
|
* [list](docs/sdks/events/README.md#list) - Events List
|
|
@@ -175,6 +196,13 @@ run();
|
|
|
175
196
|
* [update](docs/sdks/prompts/README.md#update) - Update Prompt
|
|
176
197
|
* [getById](docs/sdks/prompts/README.md#getbyid) - Get Prompt By Id
|
|
177
198
|
* [delete](docs/sdks/prompts/README.md#delete) - Delete Prompt
|
|
199
|
+
* [promptsHistory](docs/sdks/prompts/README.md#promptshistory) - Get Prompt History
|
|
200
|
+
|
|
201
|
+
### [services](docs/sdks/services/README.md)
|
|
202
|
+
|
|
203
|
+
* [list](docs/sdks/services/README.md#list) - Service List
|
|
204
|
+
* [create](docs/sdks/services/README.md#create) - Create Service
|
|
205
|
+
* [update](docs/sdks/services/README.md#update) - Update Service
|
|
178
206
|
|
|
179
207
|
### [sessionLabels](docs/sdks/sessionlabels/README.md)
|
|
180
208
|
|
|
@@ -185,6 +213,9 @@ run();
|
|
|
185
213
|
### [sessions](docs/sdks/sessions/README.md)
|
|
186
214
|
|
|
187
215
|
* [list](docs/sdks/sessions/README.md#list) - Sessions List
|
|
216
|
+
* [getById](docs/sdks/sessions/README.md#getbyid) - Get A Single Session By Id
|
|
217
|
+
* [generateSessionRecordingUrls](docs/sdks/sessions/README.md#generatesessionrecordingurls) - Generate Recording Urls
|
|
218
|
+
* [sessionRecordingStream](docs/sdks/sessions/README.md#sessionrecordingstream) - Stream Recording
|
|
188
219
|
|
|
189
220
|
#### [sessions.transcript](docs/sdks/transcript/README.md)
|
|
190
221
|
|
|
@@ -194,13 +225,20 @@ run();
|
|
|
194
225
|
### [tools](docs/sdks/tools/README.md)
|
|
195
226
|
|
|
196
227
|
* [list](docs/sdks/tools/README.md#list) - Tool List
|
|
228
|
+
* [create](docs/sdks/tools/README.md#create) - Create Tool
|
|
229
|
+
* [update](docs/sdks/tools/README.md#update) - Update Tool
|
|
197
230
|
* [getByName](docs/sdks/tools/README.md#getbyname) - Tool Info
|
|
198
231
|
|
|
199
232
|
### [v1](docs/sdks/v1/README.md)
|
|
200
233
|
|
|
201
|
-
* [
|
|
202
|
-
* [
|
|
203
|
-
* [
|
|
234
|
+
* [agentGetAvailableVoices](docs/sdks/v1/README.md#agentgetavailablevoices) - Get Available Agent Voices
|
|
235
|
+
* [list](docs/sdks/v1/README.md#list) - Directory Member List
|
|
236
|
+
* [create](docs/sdks/v1/README.md#create) - Create Directory Member
|
|
237
|
+
* [getById](docs/sdks/v1/README.md#getbyid) - Get Directory Member By Id
|
|
238
|
+
* [update](docs/sdks/v1/README.md#update) - Update Directory Member
|
|
239
|
+
* [delete](docs/sdks/v1/README.md#delete) - Delete Directory Member
|
|
240
|
+
* [directoryMemberBulkLoad](docs/sdks/v1/README.md#directorymemberbulkload) - Bulk Load Directory Members
|
|
241
|
+
* [directoryMemberDownload](docs/sdks/v1/README.md#directorymemberdownload) - Download Directory Members
|
|
204
242
|
|
|
205
243
|
</details>
|
|
206
244
|
<!-- End Available Resources and Operations [operations] -->
|
|
@@ -220,6 +258,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
220
258
|
|
|
221
259
|
<summary>Available standalone functions</summary>
|
|
222
260
|
|
|
261
|
+
- [`agentsAgentGetAvailableVoices`](docs/sdks/agents/README.md#agentgetavailablevoices) - Get Available Agent Voices
|
|
223
262
|
- [`agentsCreate`](docs/sdks/agents/README.md#create) - Create Agent
|
|
224
263
|
- [`agentsDelete`](docs/sdks/agents/README.md#delete) - Delete Agent
|
|
225
264
|
- [`agentsGetById`](docs/sdks/agents/README.md#getbyid) - Get Agent By Id
|
|
@@ -247,26 +286,83 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
247
286
|
- [`dashboardsGetTotalCallVolumeByHour`](docs/sdks/dashboards/README.md#gettotalcallvolumebyhour) - Get Total Call Volume By Hour
|
|
248
287
|
- [`dashboardsGetWeeklyCallVolumeByWeekday`](docs/sdks/dashboards/README.md#getweeklycallvolumebyweekday) - Get Weekly Call Volume By Weekday
|
|
249
288
|
- [`dashboardsTotalCallVolumeByWeekday`](docs/sdks/dashboards/README.md#totalcallvolumebyweekday) - Get Total Call Volume By Weekday
|
|
289
|
+
- [`directoryCreate`](docs/sdks/directory/README.md#create) - Create Directory Member
|
|
290
|
+
- [`directoryDelete`](docs/sdks/directory/README.md#delete) - Delete Directory Member
|
|
291
|
+
- [`directoryDirectoryMemberBulkLoad`](docs/sdks/directory/README.md#directorymemberbulkload) - Bulk Load Directory Members
|
|
292
|
+
- [`directoryDirectoryMemberDownload`](docs/sdks/directory/README.md#directorymemberdownload) - Download Directory Members
|
|
293
|
+
- [`directoryGetById`](docs/sdks/directory/README.md#getbyid) - Get Directory Member By Id
|
|
294
|
+
- [`directoryList`](docs/sdks/directory/README.md#list) - Directory Member List
|
|
295
|
+
- [`directoryUpdate`](docs/sdks/directory/README.md#update) - Update Directory Member
|
|
250
296
|
- [`eventsList`](docs/sdks/events/README.md#list) - Events List
|
|
251
297
|
- [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create Prompt
|
|
252
298
|
- [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete Prompt
|
|
253
299
|
- [`promptsGetById`](docs/sdks/prompts/README.md#getbyid) - Get Prompt By Id
|
|
254
300
|
- [`promptsList`](docs/sdks/prompts/README.md#list) - Prompt List
|
|
301
|
+
- [`promptsPromptsHistory`](docs/sdks/prompts/README.md#promptshistory) - Get Prompt History
|
|
255
302
|
- [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update Prompt
|
|
303
|
+
- [`servicesCreate`](docs/sdks/services/README.md#create) - Create Service
|
|
304
|
+
- [`servicesList`](docs/sdks/services/README.md#list) - Service List
|
|
305
|
+
- [`servicesUpdate`](docs/sdks/services/README.md#update) - Update Service
|
|
256
306
|
- [`sessionLabelsCreate`](docs/sdks/sessionlabels/README.md#create) - Create Label
|
|
257
307
|
- [`sessionLabelsGetById`](docs/sdks/sessionlabels/README.md#getbyid) - Get Label By Id
|
|
258
308
|
- [`sessionLabelsList`](docs/sdks/sessionlabels/README.md#list) - Session Labels List
|
|
309
|
+
- [`sessionsGenerateSessionRecordingUrls`](docs/sdks/sessions/README.md#generatesessionrecordingurls) - Generate Recording Urls
|
|
310
|
+
- [`sessionsGetById`](docs/sdks/sessions/README.md#getbyid) - Get A Single Session By Id
|
|
259
311
|
- [`sessionsList`](docs/sdks/sessions/README.md#list) - Sessions List
|
|
312
|
+
- [`sessionsSessionRecordingStream`](docs/sdks/sessions/README.md#sessionrecordingstream) - Stream Recording
|
|
260
313
|
- [`sessionsTranscriptGetById`](docs/sdks/transcript/README.md#getbyid) - Get Session Transcript By Id
|
|
314
|
+
- [`toolsCreate`](docs/sdks/tools/README.md#create) - Create Tool
|
|
261
315
|
- [`toolsGetByName`](docs/sdks/tools/README.md#getbyname) - Tool Info
|
|
262
316
|
- [`toolsList`](docs/sdks/tools/README.md#list) - Tool List
|
|
263
|
-
- [`
|
|
264
|
-
- [`
|
|
265
|
-
- [`
|
|
317
|
+
- [`toolsUpdate`](docs/sdks/tools/README.md#update) - Update Tool
|
|
318
|
+
- [`v1AgentGetAvailableVoices`](docs/sdks/v1/README.md#agentgetavailablevoices) - Get Available Agent Voices
|
|
319
|
+
- [`v1Create`](docs/sdks/v1/README.md#create) - Create Directory Member
|
|
320
|
+
- [`v1Delete`](docs/sdks/v1/README.md#delete) - Delete Directory Member
|
|
321
|
+
- [`v1DirectoryMemberBulkLoad`](docs/sdks/v1/README.md#directorymemberbulkload) - Bulk Load Directory Members
|
|
322
|
+
- [`v1DirectoryMemberDownload`](docs/sdks/v1/README.md#directorymemberdownload) - Download Directory Members
|
|
323
|
+
- [`v1GetById`](docs/sdks/v1/README.md#getbyid) - Get Directory Member By Id
|
|
324
|
+
- [`v1List`](docs/sdks/v1/README.md#list) - Directory Member List
|
|
325
|
+
- [`v1Update`](docs/sdks/v1/README.md#update) - Update Directory Member
|
|
266
326
|
|
|
267
327
|
</details>
|
|
268
328
|
<!-- End Standalone functions [standalone-funcs] -->
|
|
269
329
|
|
|
330
|
+
<!-- Start File uploads [file-upload] -->
|
|
331
|
+
## File uploads
|
|
332
|
+
|
|
333
|
+
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
|
|
334
|
+
|
|
335
|
+
> [!TIP]
|
|
336
|
+
>
|
|
337
|
+
> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
|
|
338
|
+
>
|
|
339
|
+
> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
|
|
340
|
+
> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
|
|
341
|
+
> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
|
|
342
|
+
> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
|
|
343
|
+
|
|
344
|
+
```typescript
|
|
345
|
+
import { openAsBlob } from "node:fs";
|
|
346
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
347
|
+
|
|
348
|
+
const syllableSDK = new SyllableSDK({
|
|
349
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
350
|
+
});
|
|
351
|
+
|
|
352
|
+
async function run() {
|
|
353
|
+
const result = await syllableSDK.v1.directoryMemberBulkLoad({
|
|
354
|
+
file: await openAsBlob("example.file"),
|
|
355
|
+
});
|
|
356
|
+
|
|
357
|
+
// Handle the result
|
|
358
|
+
console.log(result);
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
run();
|
|
362
|
+
|
|
363
|
+
```
|
|
364
|
+
<!-- End File uploads [file-upload] -->
|
|
365
|
+
|
|
270
366
|
<!-- Start Retries [retries] -->
|
|
271
367
|
## Retries
|
|
272
368
|
|
package/RUNTIMES.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Supported JavaScript runtimes
|
|
2
|
+
|
|
3
|
+
This SDK is intended to be used in JavaScript runtimes that support the following features:
|
|
4
|
+
|
|
5
|
+
* [Web Fetch API][web-fetch]
|
|
6
|
+
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
|
7
|
+
* [Async iterables][async-iter] using `Symbol.asyncIterator`
|
|
8
|
+
|
|
9
|
+
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
|
|
10
|
+
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
|
11
|
+
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
|
|
12
|
+
|
|
13
|
+
Runtime environments that are explicitly supported are:
|
|
14
|
+
|
|
15
|
+
- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
|
|
16
|
+
- Node.js active and maintenance LTS releases
|
|
17
|
+
- Currently, this is v18 and v20
|
|
18
|
+
- Bun v1 and above
|
|
19
|
+
- Deno v1.39
|
|
20
|
+
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
|
21
|
+
|
|
22
|
+
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
|
@@ -12,6 +12,7 @@ Operations related to agents
|
|
|
12
12
|
* [update](#update) - Update Agent
|
|
13
13
|
* [getById](#getbyid) - Get Agent By Id
|
|
14
14
|
* [delete](#delete) - Delete Agent
|
|
15
|
+
* [agentGetAvailableVoices](#agentgetavailablevoices) - Get Available Agent Voices
|
|
15
16
|
|
|
16
17
|
## list
|
|
17
18
|
|
|
@@ -77,7 +78,7 @@ run();
|
|
|
77
78
|
|
|
78
79
|
### Response
|
|
79
80
|
|
|
80
|
-
**Promise\<[components.
|
|
81
|
+
**Promise\<[components.ListResponseAgentResponse](../../models/components/listresponseagentresponse.md)\>**
|
|
81
82
|
|
|
82
83
|
### Errors
|
|
83
84
|
|
|
@@ -254,7 +255,7 @@ run();
|
|
|
254
255
|
|
|
255
256
|
| Parameter | Type | Required | Description |
|
|
256
257
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
257
|
-
| `request` | [components.
|
|
258
|
+
| `request` | [components.AgentUpdate](../../models/components/agentupdate.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
258
259
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
259
260
|
| `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. |
|
|
260
261
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -338,7 +339,7 @@ run();
|
|
|
338
339
|
|
|
339
340
|
### Response
|
|
340
341
|
|
|
341
|
-
**Promise\<[components.
|
|
342
|
+
**Promise\<[components.AgentResponse](../../models/components/agentresponse.md)\>**
|
|
342
343
|
|
|
343
344
|
### Errors
|
|
344
345
|
|
|
@@ -424,4 +425,75 @@ run();
|
|
|
424
425
|
| Error Type | Status Code | Content Type |
|
|
425
426
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
426
427
|
| errors.HTTPValidationError | 422 | application/json |
|
|
427
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
428
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
429
|
+
|
|
430
|
+
## agentGetAvailableVoices
|
|
431
|
+
|
|
432
|
+
Get available agent voices.
|
|
433
|
+
|
|
434
|
+
### Example Usage
|
|
435
|
+
|
|
436
|
+
```typescript
|
|
437
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
438
|
+
|
|
439
|
+
const syllableSDK = new SyllableSDK({
|
|
440
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
441
|
+
});
|
|
442
|
+
|
|
443
|
+
async function run() {
|
|
444
|
+
const result = await syllableSDK.agents.agentGetAvailableVoices();
|
|
445
|
+
|
|
446
|
+
// Handle the result
|
|
447
|
+
console.log(result);
|
|
448
|
+
}
|
|
449
|
+
|
|
450
|
+
run();
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
### Standalone function
|
|
454
|
+
|
|
455
|
+
The standalone function version of this method:
|
|
456
|
+
|
|
457
|
+
```typescript
|
|
458
|
+
import { SyllableSDKCore } from "syllable-sdk/core.js";
|
|
459
|
+
import { agentsAgentGetAvailableVoices } from "syllable-sdk/funcs/agentsAgentGetAvailableVoices.js";
|
|
460
|
+
|
|
461
|
+
// Use `SyllableSDKCore` for best tree-shaking performance.
|
|
462
|
+
// You can create one instance of it to use across an application.
|
|
463
|
+
const syllableSDK = new SyllableSDKCore({
|
|
464
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
465
|
+
});
|
|
466
|
+
|
|
467
|
+
async function run() {
|
|
468
|
+
const res = await agentsAgentGetAvailableVoices(syllableSDK);
|
|
469
|
+
|
|
470
|
+
if (!res.ok) {
|
|
471
|
+
throw res.error;
|
|
472
|
+
}
|
|
473
|
+
|
|
474
|
+
const { value: result } = res;
|
|
475
|
+
|
|
476
|
+
// Handle the result
|
|
477
|
+
console.log(result);
|
|
478
|
+
}
|
|
479
|
+
|
|
480
|
+
run();
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
### Parameters
|
|
484
|
+
|
|
485
|
+
| Parameter | Type | Required | Description |
|
|
486
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
487
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
488
|
+
| `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. |
|
|
489
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
490
|
+
|
|
491
|
+
### Response
|
|
492
|
+
|
|
493
|
+
**Promise\<[components.AgentVoice[]](../../models/.md)\>**
|
|
494
|
+
|
|
495
|
+
### Errors
|
|
496
|
+
|
|
497
|
+
| Error Type | Status Code | Content Type |
|
|
498
|
+
| --------------- | --------------- | --------------- |
|
|
499
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -77,7 +77,7 @@ run();
|
|
|
77
77
|
|
|
78
78
|
### Response
|
|
79
79
|
|
|
80
|
-
**Promise\<[components.
|
|
80
|
+
**Promise\<[components.ListResponseCustomMessageResponse](../../models/components/listresponsecustommessageresponse.md)\>**
|
|
81
81
|
|
|
82
82
|
### Errors
|
|
83
83
|
|
|
@@ -149,14 +149,14 @@ run();
|
|
|
149
149
|
|
|
150
150
|
| Parameter | Type | Required | Description |
|
|
151
151
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
152
|
-
| `request` | [components.
|
|
152
|
+
| `request` | [components.CustomMessageCreateRequest](../../models/components/custommessagecreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
153
153
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
154
154
|
| `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. |
|
|
155
155
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
156
156
|
|
|
157
157
|
### Response
|
|
158
158
|
|
|
159
|
-
**Promise\<[components.
|
|
159
|
+
**Promise\<[components.CustomMessageResponse](../../models/components/custommessageresponse.md)\>**
|
|
160
160
|
|
|
161
161
|
### Errors
|
|
162
162
|
|
|
@@ -230,14 +230,14 @@ run();
|
|
|
230
230
|
|
|
231
231
|
| Parameter | Type | Required | Description |
|
|
232
232
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
233
|
-
| `request` | [components.
|
|
233
|
+
| `request` | [components.CustomMessageUpdateRequest](../../models/components/custommessageupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
234
234
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
235
235
|
| `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. |
|
|
236
236
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
237
237
|
|
|
238
238
|
### Response
|
|
239
239
|
|
|
240
|
-
**Promise\<[components.
|
|
240
|
+
**Promise\<[components.CustomMessageResponse](../../models/components/custommessageresponse.md)\>**
|
|
241
241
|
|
|
242
242
|
### Errors
|
|
243
243
|
|
|
@@ -314,7 +314,7 @@ run();
|
|
|
314
314
|
|
|
315
315
|
### Response
|
|
316
316
|
|
|
317
|
-
**Promise\<[components.
|
|
317
|
+
**Promise\<[components.CustomMessageResponse](../../models/components/custommessageresponse.md)\>**
|
|
318
318
|
|
|
319
319
|
### Errors
|
|
320
320
|
|