syllable-sdk 0.0.9
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/.devcontainer/README.md +35 -0
- package/README.md +556 -0
- package/core.d.ts +10 -0
- package/core.d.ts.map +1 -0
- package/core.js +17 -0
- package/core.js.map +1 -0
- package/docs/sdks/agents/README.md +427 -0
- package/docs/sdks/channels/README.md +161 -0
- package/docs/sdks/conversations/README.md +161 -0
- package/docs/sdks/custommessages/README.md +403 -0
- package/docs/sdks/dashboards/README.md +587 -0
- package/docs/sdks/events/README.md +83 -0
- package/docs/sdks/organizations/README.md +81 -0
- package/docs/sdks/prompts/README.md +409 -0
- package/docs/sdks/sessions/README.md +83 -0
- package/docs/sdks/syllablesdk/README.md +22 -0
- package/docs/sdks/targets/README.md +433 -0
- package/docs/sdks/test/README.md +95 -0
- package/docs/sdks/tools/README.md +161 -0
- package/funcs/agentsCreate.d.ts +16 -0
- package/funcs/agentsCreate.d.ts.map +1 -0
- package/funcs/agentsCreate.js +95 -0
- package/funcs/agentsCreate.js.map +1 -0
- package/funcs/agentsDelete.d.ts +16 -0
- package/funcs/agentsDelete.d.ts.map +1 -0
- package/funcs/agentsDelete.js +105 -0
- package/funcs/agentsDelete.js.map +1 -0
- package/funcs/agentsGetById.d.ts +17 -0
- package/funcs/agentsGetById.d.ts.map +1 -0
- package/funcs/agentsGetById.js +101 -0
- package/funcs/agentsGetById.js.map +1 -0
- package/funcs/agentsList.d.ts +17 -0
- package/funcs/agentsList.d.ts.map +1 -0
- package/funcs/agentsList.js +107 -0
- package/funcs/agentsList.js.map +1 -0
- package/funcs/agentsTestSendTestMessage.d.ts +16 -0
- package/funcs/agentsTestSendTestMessage.d.ts.map +1 -0
- package/funcs/agentsTestSendTestMessage.js +95 -0
- package/funcs/agentsTestSendTestMessage.js.map +1 -0
- package/funcs/agentsUpdate.d.ts +16 -0
- package/funcs/agentsUpdate.d.ts.map +1 -0
- package/funcs/agentsUpdate.js +95 -0
- package/funcs/agentsUpdate.js.map +1 -0
- package/funcs/channelsDelete.d.ts +17 -0
- package/funcs/channelsDelete.d.ts.map +1 -0
- package/funcs/channelsDelete.js +101 -0
- package/funcs/channelsDelete.js.map +1 -0
- package/funcs/channelsList.d.ts +14 -0
- package/funcs/channelsList.d.ts.map +1 -0
- package/funcs/channelsList.js +104 -0
- package/funcs/channelsList.js.map +1 -0
- package/funcs/channelsTargetsAvailableTargets.d.ts +17 -0
- package/funcs/channelsTargetsAvailableTargets.d.ts.map +1 -0
- package/funcs/channelsTargetsAvailableTargets.js +107 -0
- package/funcs/channelsTargetsAvailableTargets.js.map +1 -0
- package/funcs/channelsTargetsCreate.d.ts +14 -0
- package/funcs/channelsTargetsCreate.d.ts.map +1 -0
- package/funcs/channelsTargetsCreate.js +101 -0
- package/funcs/channelsTargetsCreate.js.map +1 -0
- package/funcs/channelsTargetsGetById.d.ts +14 -0
- package/funcs/channelsTargetsGetById.d.ts.map +1 -0
- package/funcs/channelsTargetsGetById.js +102 -0
- package/funcs/channelsTargetsGetById.js.map +1 -0
- package/funcs/channelsTargetsList.d.ts +14 -0
- package/funcs/channelsTargetsList.d.ts.map +1 -0
- package/funcs/channelsTargetsList.js +104 -0
- package/funcs/channelsTargetsList.js.map +1 -0
- package/funcs/channelsTargetsUpdate.d.ts +17 -0
- package/funcs/channelsTargetsUpdate.d.ts.map +1 -0
- package/funcs/channelsTargetsUpdate.js +106 -0
- package/funcs/channelsTargetsUpdate.js.map +1 -0
- package/funcs/conversationsGetById.d.ts +14 -0
- package/funcs/conversationsGetById.d.ts.map +1 -0
- package/funcs/conversationsGetById.js +98 -0
- package/funcs/conversationsGetById.js.map +1 -0
- package/funcs/conversationsList.d.ts +14 -0
- package/funcs/conversationsList.d.ts.map +1 -0
- package/funcs/conversationsList.js +104 -0
- package/funcs/conversationsList.js.map +1 -0
- package/funcs/customMessagesCreate.d.ts +16 -0
- package/funcs/customMessagesCreate.d.ts.map +1 -0
- package/funcs/customMessagesCreate.js +95 -0
- package/funcs/customMessagesCreate.js.map +1 -0
- package/funcs/customMessagesDelete.d.ts +16 -0
- package/funcs/customMessagesDelete.d.ts.map +1 -0
- package/funcs/customMessagesDelete.js +102 -0
- package/funcs/customMessagesDelete.js.map +1 -0
- package/funcs/customMessagesGetById.d.ts +17 -0
- package/funcs/customMessagesGetById.d.ts.map +1 -0
- package/funcs/customMessagesGetById.js +98 -0
- package/funcs/customMessagesGetById.js.map +1 -0
- package/funcs/customMessagesList.d.ts +17 -0
- package/funcs/customMessagesList.d.ts.map +1 -0
- package/funcs/customMessagesList.js +107 -0
- package/funcs/customMessagesList.js.map +1 -0
- package/funcs/customMessagesUpdate.d.ts +16 -0
- package/funcs/customMessagesUpdate.d.ts.map +1 -0
- package/funcs/customMessagesUpdate.js +95 -0
- package/funcs/customMessagesUpdate.js.map +1 -0
- package/funcs/dashboardsGetDailyCallVolumeByHour.d.ts +15 -0
- package/funcs/dashboardsGetDailyCallVolumeByHour.d.ts.map +1 -0
- package/funcs/dashboardsGetDailyCallVolumeByHour.js +82 -0
- package/funcs/dashboardsGetDailyCallVolumeByHour.js.map +1 -0
- package/funcs/dashboardsGetMonthlyCallVolumeByDay.d.ts +15 -0
- package/funcs/dashboardsGetMonthlyCallVolumeByDay.d.ts.map +1 -0
- package/funcs/dashboardsGetMonthlyCallVolumeByDay.js +82 -0
- package/funcs/dashboardsGetMonthlyCallVolumeByDay.js.map +1 -0
- package/funcs/dashboardsGetMonthlyCallVolumeByWeek.d.ts +15 -0
- package/funcs/dashboardsGetMonthlyCallVolumeByWeek.d.ts.map +1 -0
- package/funcs/dashboardsGetMonthlyCallVolumeByWeek.js +82 -0
- package/funcs/dashboardsGetMonthlyCallVolumeByWeek.js.map +1 -0
- package/funcs/dashboardsGetSessionAgents.d.ts +15 -0
- package/funcs/dashboardsGetSessionAgents.d.ts.map +1 -0
- package/funcs/dashboardsGetSessionAgents.js +81 -0
- package/funcs/dashboardsGetSessionAgents.js.map +1 -0
- package/funcs/dashboardsGetSessionSummary.d.ts +16 -0
- package/funcs/dashboardsGetSessionSummary.d.ts.map +1 -0
- package/funcs/dashboardsGetSessionSummary.js +103 -0
- package/funcs/dashboardsGetSessionSummary.js.map +1 -0
- package/funcs/dashboardsGetTotalCallVolumeByHour.d.ts +15 -0
- package/funcs/dashboardsGetTotalCallVolumeByHour.d.ts.map +1 -0
- package/funcs/dashboardsGetTotalCallVolumeByHour.js +82 -0
- package/funcs/dashboardsGetTotalCallVolumeByHour.js.map +1 -0
- package/funcs/dashboardsGetWeeklyCallVolumeByWeekday.d.ts +15 -0
- package/funcs/dashboardsGetWeeklyCallVolumeByWeekday.d.ts.map +1 -0
- package/funcs/dashboardsGetWeeklyCallVolumeByWeekday.js +82 -0
- package/funcs/dashboardsGetWeeklyCallVolumeByWeekday.js.map +1 -0
- package/funcs/dashboardsTotalCallVolumeByWeekday.d.ts +15 -0
- package/funcs/dashboardsTotalCallVolumeByWeekday.d.ts.map +1 -0
- package/funcs/dashboardsTotalCallVolumeByWeekday.js +82 -0
- package/funcs/dashboardsTotalCallVolumeByWeekday.js.map +1 -0
- package/funcs/eventsList.d.ts +14 -0
- package/funcs/eventsList.d.ts.map +1 -0
- package/funcs/eventsList.js +104 -0
- package/funcs/eventsList.js.map +1 -0
- package/funcs/organizationsList.d.ts +15 -0
- package/funcs/organizationsList.d.ts.map +1 -0
- package/funcs/organizationsList.js +82 -0
- package/funcs/organizationsList.js.map +1 -0
- package/funcs/promptsCreate.d.ts +16 -0
- package/funcs/promptsCreate.d.ts.map +1 -0
- package/funcs/promptsCreate.js +95 -0
- package/funcs/promptsCreate.js.map +1 -0
- package/funcs/promptsDelete.d.ts +16 -0
- package/funcs/promptsDelete.d.ts.map +1 -0
- package/funcs/promptsDelete.js +105 -0
- package/funcs/promptsDelete.js.map +1 -0
- package/funcs/promptsGetById.d.ts +17 -0
- package/funcs/promptsGetById.d.ts.map +1 -0
- package/funcs/promptsGetById.js +101 -0
- package/funcs/promptsGetById.js.map +1 -0
- package/funcs/promptsList.d.ts +17 -0
- package/funcs/promptsList.d.ts.map +1 -0
- package/funcs/promptsList.js +107 -0
- package/funcs/promptsList.js.map +1 -0
- package/funcs/promptsUpdate.d.ts +16 -0
- package/funcs/promptsUpdate.d.ts.map +1 -0
- package/funcs/promptsUpdate.js +95 -0
- package/funcs/promptsUpdate.js.map +1 -0
- package/funcs/sessionsList.d.ts +14 -0
- package/funcs/sessionsList.d.ts.map +1 -0
- package/funcs/sessionsList.js +104 -0
- package/funcs/sessionsList.js.map +1 -0
- package/funcs/toolsGetByName.d.ts +17 -0
- package/funcs/toolsGetByName.d.ts.map +1 -0
- package/funcs/toolsGetByName.js +101 -0
- package/funcs/toolsGetByName.js.map +1 -0
- package/funcs/toolsList.d.ts +17 -0
- package/funcs/toolsList.d.ts.map +1 -0
- package/funcs/toolsList.js +107 -0
- package/funcs/toolsList.js.map +1 -0
- package/hooks/hooks.d.ts +24 -0
- package/hooks/hooks.d.ts.map +1 -0
- package/hooks/hooks.js +68 -0
- package/hooks/hooks.js.map +1 -0
- package/hooks/index.d.ts +3 -0
- package/hooks/index.d.ts.map +1 -0
- package/hooks/index.js +22 -0
- package/hooks/index.js.map +1 -0
- package/hooks/registration.d.ts +3 -0
- package/hooks/registration.d.ts.map +1 -0
- package/hooks/registration.js +15 -0
- package/hooks/registration.js.map +1 -0
- package/hooks/types.d.ts +72 -0
- package/hooks/types.d.ts.map +1 -0
- package/hooks/types.js +6 -0
- package/hooks/types.js.map +1 -0
- package/index.d.ts +4 -0
- package/index.d.ts.map +1 -0
- package/index.js +36 -0
- package/index.js.map +1 -0
- package/lib/base64.d.ts +10 -0
- package/lib/base64.d.ts.map +1 -0
- package/lib/base64.js +61 -0
- package/lib/base64.js.map +1 -0
- package/lib/config.d.ts +34 -0
- package/lib/config.d.ts.map +1 -0
- package/lib/config.js +36 -0
- package/lib/config.js.map +1 -0
- package/lib/dlv.d.ts +14 -0
- package/lib/dlv.d.ts.map +1 -0
- package/lib/dlv.js +49 -0
- package/lib/dlv.js.map +1 -0
- package/lib/encodings.d.ts +51 -0
- package/lib/encodings.d.ts.map +1 -0
- package/lib/encodings.js +343 -0
- package/lib/encodings.js.map +1 -0
- package/lib/env.d.ts +15 -0
- package/lib/env.d.ts.map +1 -0
- package/lib/env.js +57 -0
- package/lib/env.js.map +1 -0
- package/lib/files.d.ts +8 -0
- package/lib/files.d.ts.map +1 -0
- package/lib/files.js +36 -0
- package/lib/files.js.map +1 -0
- package/lib/http.d.ts +67 -0
- package/lib/http.d.ts.map +1 -0
- package/lib/http.js +218 -0
- package/lib/http.js.map +1 -0
- package/lib/is-plain-object.d.ts +2 -0
- package/lib/is-plain-object.d.ts.map +1 -0
- package/lib/is-plain-object.js +41 -0
- package/lib/is-plain-object.js.map +1 -0
- package/lib/logger.d.ts +6 -0
- package/lib/logger.d.ts.map +1 -0
- package/lib/logger.js +6 -0
- package/lib/logger.js.map +1 -0
- package/lib/matchers.d.ts +64 -0
- package/lib/matchers.d.ts.map +1 -0
- package/lib/matchers.js +205 -0
- package/lib/matchers.js.map +1 -0
- package/lib/primitives.d.ts +16 -0
- package/lib/primitives.d.ts.map +1 -0
- package/lib/primitives.js +29 -0
- package/lib/primitives.js.map +1 -0
- package/lib/retries.d.ts +18 -0
- package/lib/retries.d.ts.map +1 -0
- package/lib/retries.js +130 -0
- package/lib/retries.js.map +1 -0
- package/lib/schemas.d.ts +19 -0
- package/lib/schemas.d.ts.map +1 -0
- package/lib/schemas.js +59 -0
- package/lib/schemas.js.map +1 -0
- package/lib/sdks.d.ts +56 -0
- package/lib/sdks.d.ts.map +1 -0
- package/lib/sdks.js +275 -0
- package/lib/sdks.js.map +1 -0
- package/lib/security.d.ts +63 -0
- package/lib/security.d.ts.map +1 -0
- package/lib/security.js +130 -0
- package/lib/security.js.map +1 -0
- package/lib/url.d.ts +5 -0
- package/lib/url.d.ts.map +1 -0
- package/lib/url.js +25 -0
- package/lib/url.js.map +1 -0
- package/models/components/agent.d.ts +70 -0
- package/models/components/agent.d.ts.map +1 -0
- package/models/components/agent.js +100 -0
- package/models/components/agent.js.map +1 -0
- package/models/components/agentcreate.d.ts +65 -0
- package/models/components/agentcreate.d.ts.map +1 -0
- package/models/components/agentcreate.js +99 -0
- package/models/components/agentcreate.js.map +1 -0
- package/models/components/agentproperties.d.ts +52 -0
- package/models/components/agentproperties.d.ts.map +1 -0
- package/models/components/agentproperties.js +58 -0
- package/models/components/agentproperties.js.map +1 -0
- package/models/components/agenttooldefaults.d.ts +28 -0
- package/models/components/agenttooldefaults.d.ts.map +1 -0
- package/models/components/agenttooldefaults.js +64 -0
- package/models/components/agenttooldefaults.js.map +1 -0
- package/models/components/agenttoolfielddefault.d.ts +27 -0
- package/models/components/agenttoolfielddefault.d.ts.map +1 -0
- package/models/components/agenttoolfielddefault.js +63 -0
- package/models/components/agenttoolfielddefault.js.map +1 -0
- package/models/components/availabletarget.d.ts +29 -0
- package/models/components/availabletarget.d.ts.map +1 -0
- package/models/components/availabletarget.js +65 -0
- package/models/components/availabletarget.js.map +1 -0
- package/models/components/availabletargetproperties.d.ts +31 -0
- package/models/components/availabletargetproperties.d.ts.map +1 -0
- package/models/components/availabletargetproperties.js +51 -0
- package/models/components/availabletargetproperties.js.map +1 -0
- package/models/components/channel.d.ts +31 -0
- package/models/components/channel.d.ts.map +1 -0
- package/models/components/channel.js +67 -0
- package/models/components/channel.js.map +1 -0
- package/models/components/channelproperties.d.ts +34 -0
- package/models/components/channelproperties.d.ts.map +1 -0
- package/models/components/channelproperties.js +52 -0
- package/models/components/channelproperties.js.map +1 -0
- package/models/components/channeltarget.d.ts +39 -0
- package/models/components/channeltarget.d.ts.map +1 -0
- package/models/components/channeltarget.js +83 -0
- package/models/components/channeltarget.js.map +1 -0
- package/models/components/channeltargetcreaterequest.d.ts +37 -0
- package/models/components/channeltargetcreaterequest.d.ts.map +1 -0
- package/models/components/channeltargetcreaterequest.js +81 -0
- package/models/components/channeltargetcreaterequest.js.map +1 -0
- package/models/components/channeltargetproperties.d.ts +46 -0
- package/models/components/channeltargetproperties.d.ts.map +1 -0
- package/models/components/channeltargetproperties.js +56 -0
- package/models/components/channeltargetproperties.js.map +1 -0
- package/models/components/conversation.d.ts +51 -0
- package/models/components/conversation.d.ts.map +1 -0
- package/models/components/conversation.js +105 -0
- package/models/components/conversation.js.map +1 -0
- package/models/components/conversationaction.d.ts +31 -0
- package/models/components/conversationaction.d.ts.map +1 -0
- package/models/components/conversationaction.js +69 -0
- package/models/components/conversationaction.js.map +1 -0
- package/models/components/conversationproperties.d.ts +55 -0
- package/models/components/conversationproperties.d.ts.map +1 -0
- package/models/components/conversationproperties.js +59 -0
- package/models/components/conversationproperties.js.map +1 -0
- package/models/components/conversationtext.d.ts +31 -0
- package/models/components/conversationtext.d.ts.map +1 -0
- package/models/components/conversationtext.js +56 -0
- package/models/components/conversationtext.js.map +1 -0
- package/models/components/conversationtranscriptionresponse.d.ts +31 -0
- package/models/components/conversationtranscriptionresponse.d.ts.map +1 -0
- package/models/components/conversationtranscriptionresponse.js +65 -0
- package/models/components/conversationtranscriptionresponse.js.map +1 -0
- package/models/components/custommessage.d.ts +40 -0
- package/models/components/custommessage.d.ts.map +1 -0
- package/models/components/custommessage.js +56 -0
- package/models/components/custommessage.js.map +1 -0
- package/models/components/custommessagecreate.d.ts +33 -0
- package/models/components/custommessagecreate.d.ts.map +1 -0
- package/models/components/custommessagecreate.js +52 -0
- package/models/components/custommessagecreate.js.map +1 -0
- package/models/components/custommessageproperties.d.ts +31 -0
- package/models/components/custommessageproperties.d.ts.map +1 -0
- package/models/components/custommessageproperties.js +51 -0
- package/models/components/custommessageproperties.js.map +1 -0
- package/models/components/defaults.d.ts +58 -0
- package/models/components/defaults.d.ts.map +1 -0
- package/models/components/defaults.js +87 -0
- package/models/components/defaults.js.map +1 -0
- package/models/components/event.d.ts +62 -0
- package/models/components/event.d.ts.map +1 -0
- package/models/components/event.js +99 -0
- package/models/components/event.js.map +1 -0
- package/models/components/eventproperties.d.ts +52 -0
- package/models/components/eventproperties.d.ts.map +1 -0
- package/models/components/eventproperties.js +58 -0
- package/models/components/eventproperties.js.map +1 -0
- package/models/components/function.d.ts +63 -0
- package/models/components/function.d.ts.map +1 -0
- package/models/components/function.js +69 -0
- package/models/components/function.js.map +1 -0
- package/models/components/httpendpoint.d.ts +41 -0
- package/models/components/httpendpoint.d.ts.map +1 -0
- package/models/components/httpendpoint.js +63 -0
- package/models/components/httpendpoint.js.map +1 -0
- package/models/components/index.d.ts +56 -0
- package/models/components/index.d.ts.map +1 -0
- package/models/components/index.js +75 -0
- package/models/components/index.js.map +1 -0
- package/models/components/listresponseagent.d.ts +34 -0
- package/models/components/listresponseagent.d.ts.map +1 -0
- package/models/components/listresponseagent.js +72 -0
- package/models/components/listresponseagent.js.map +1 -0
- package/models/components/listresponseavailabletarget.d.ts +34 -0
- package/models/components/listresponseavailabletarget.d.ts.map +1 -0
- package/models/components/listresponseavailabletarget.js +72 -0
- package/models/components/listresponseavailabletarget.js.map +1 -0
- package/models/components/listresponsechannel.d.ts +34 -0
- package/models/components/listresponsechannel.d.ts.map +1 -0
- package/models/components/listresponsechannel.js +72 -0
- package/models/components/listresponsechannel.js.map +1 -0
- package/models/components/listresponsechanneltarget.d.ts +34 -0
- package/models/components/listresponsechanneltarget.d.ts.map +1 -0
- package/models/components/listresponsechanneltarget.js +72 -0
- package/models/components/listresponsechanneltarget.js.map +1 -0
- package/models/components/listresponseconversation.d.ts +34 -0
- package/models/components/listresponseconversation.d.ts.map +1 -0
- package/models/components/listresponseconversation.js +72 -0
- package/models/components/listresponseconversation.js.map +1 -0
- package/models/components/listresponsecustommessage.d.ts +34 -0
- package/models/components/listresponsecustommessage.d.ts.map +1 -0
- package/models/components/listresponsecustommessage.js +72 -0
- package/models/components/listresponsecustommessage.js.map +1 -0
- package/models/components/listresponseevent.d.ts +34 -0
- package/models/components/listresponseevent.d.ts.map +1 -0
- package/models/components/listresponseevent.js +72 -0
- package/models/components/listresponseevent.js.map +1 -0
- package/models/components/listresponseprompt.d.ts +34 -0
- package/models/components/listresponseprompt.d.ts.map +1 -0
- package/models/components/listresponseprompt.js +72 -0
- package/models/components/listresponseprompt.js.map +1 -0
- package/models/components/listresponseschemasbubblegumv2toolstool.d.ts +34 -0
- package/models/components/listresponseschemasbubblegumv2toolstool.d.ts.map +1 -0
- package/models/components/listresponseschemasbubblegumv2toolstool.js +72 -0
- package/models/components/listresponseschemasbubblegumv2toolstool.js.map +1 -0
- package/models/components/listresponsesession.d.ts +34 -0
- package/models/components/listresponsesession.d.ts.map +1 -0
- package/models/components/listresponsesession.js +72 -0
- package/models/components/listresponsesession.js.map +1 -0
- package/models/components/llmconfig.d.ts +41 -0
- package/models/components/llmconfig.d.ts.map +1 -0
- package/models/components/llmconfig.js +66 -0
- package/models/components/llmconfig.js.map +1 -0
- package/models/components/organization.d.ts +38 -0
- package/models/components/organization.d.ts.map +1 -0
- package/models/components/organization.js +63 -0
- package/models/components/organization.js.map +1 -0
- package/models/components/prompt.d.ts +56 -0
- package/models/components/prompt.d.ts.map +1 -0
- package/models/components/prompt.js +75 -0
- package/models/components/prompt.js.map +1 -0
- package/models/components/promptcreate.d.ts +49 -0
- package/models/components/promptcreate.d.ts.map +1 -0
- package/models/components/promptcreate.js +68 -0
- package/models/components/promptcreate.js.map +1 -0
- package/models/components/promptproperties.d.ts +37 -0
- package/models/components/promptproperties.d.ts.map +1 -0
- package/models/components/promptproperties.js +53 -0
- package/models/components/promptproperties.js.map +1 -0
- package/models/components/provider.d.ts +34 -0
- package/models/components/provider.d.ts.map +1 -0
- package/models/components/provider.js +54 -0
- package/models/components/provider.js.map +1 -0
- package/models/components/schemasbubblegumv2toolstool.d.ts +49 -0
- package/models/components/schemasbubblegumv2toolstool.d.ts.map +1 -0
- package/models/components/schemasbubblegumv2toolstool.js +70 -0
- package/models/components/schemasbubblegumv2toolstool.js.map +1 -0
- package/models/components/schemascortexv1toolstool.d.ts +37 -0
- package/models/components/schemascortexv1toolstool.d.ts.map +1 -0
- package/models/components/schemascortexv1toolstool.js +53 -0
- package/models/components/schemascortexv1toolstool.js.map +1 -0
- package/models/components/security.d.ts +25 -0
- package/models/components/security.d.ts.map +1 -0
- package/models/components/security.js +59 -0
- package/models/components/security.js.map +1 -0
- package/models/components/session.d.ts +43 -0
- package/models/components/session.d.ts.map +1 -0
- package/models/components/session.js +89 -0
- package/models/components/session.js.map +1 -0
- package/models/components/sessionproperties.d.ts +52 -0
- package/models/components/sessionproperties.d.ts.map +1 -0
- package/models/components/sessionproperties.js +58 -0
- package/models/components/sessionproperties.js.map +1 -0
- package/models/components/testmessage.d.ts +41 -0
- package/models/components/testmessage.d.ts.map +1 -0
- package/models/components/testmessage.js +75 -0
- package/models/components/testmessage.js.map +1 -0
- package/models/components/testmessageresponse.d.ts +50 -0
- package/models/components/testmessageresponse.d.ts.map +1 -0
- package/models/components/testmessageresponse.js +82 -0
- package/models/components/testmessageresponse.js.map +1 -0
- package/models/components/tooldefinition.d.ts +61 -0
- package/models/components/tooldefinition.d.ts.map +1 -0
- package/models/components/tooldefinition.js +77 -0
- package/models/components/tooldefinition.js.map +1 -0
- package/models/components/tooldetailresponse.d.ts +29 -0
- package/models/components/tooldetailresponse.d.ts.map +1 -0
- package/models/components/tooldetailresponse.js +54 -0
- package/models/components/tooldetailresponse.js.map +1 -0
- package/models/components/toolparameterdefault.d.ts +32 -0
- package/models/components/toolparameterdefault.d.ts.map +1 -0
- package/models/components/toolparameterdefault.js +51 -0
- package/models/components/toolparameterdefault.js.map +1 -0
- package/models/components/toolparametertransform.d.ts +36 -0
- package/models/components/toolparametertransform.d.ts.map +1 -0
- package/models/components/toolparametertransform.js +55 -0
- package/models/components/toolparametertransform.js.map +1 -0
- package/models/components/toolparametertransformcondition.d.ts +38 -0
- package/models/components/toolparametertransformcondition.d.ts.map +1 -0
- package/models/components/toolparametertransformcondition.js +54 -0
- package/models/components/toolparametertransformcondition.js.map +1 -0
- package/models/components/toolproperties.d.ts +37 -0
- package/models/components/toolproperties.d.ts.map +1 -0
- package/models/components/toolproperties.js +53 -0
- package/models/components/toolproperties.js.map +1 -0
- package/models/components/validationerror.d.ts +48 -0
- package/models/components/validationerror.d.ts.map +1 -0
- package/models/components/validationerror.js +70 -0
- package/models/components/validationerror.js.map +1 -0
- package/models/errors/httpclienterrors.d.ts +44 -0
- package/models/errors/httpclienterrors.d.ts.map +1 -0
- package/models/errors/httpclienterrors.js +78 -0
- package/models/errors/httpclienterrors.js.map +1 -0
- package/models/errors/httpvalidationerror.d.ts +32 -0
- package/models/errors/httpvalidationerror.d.ts.map +1 -0
- package/models/errors/httpvalidationerror.js +69 -0
- package/models/errors/httpvalidationerror.js.map +1 -0
- package/models/errors/index.d.ts +5 -0
- package/models/errors/index.d.ts.map +1 -0
- package/models/errors/index.js +24 -0
- package/models/errors/index.js.map +1 -0
- package/models/errors/sdkerror.d.ts +8 -0
- package/models/errors/sdkerror.d.ts.map +1 -0
- package/models/errors/sdkerror.js +21 -0
- package/models/errors/sdkerror.js.map +1 -0
- package/models/errors/sdkvalidationerror.d.ts +20 -0
- package/models/errors/sdkvalidationerror.d.ts.map +1 -0
- package/models/errors/sdkvalidationerror.js +105 -0
- package/models/errors/sdkvalidationerror.js.map +1 -0
- package/models/operations/agentdelete.d.ts +27 -0
- package/models/operations/agentdelete.d.ts.map +1 -0
- package/models/operations/agentdelete.js +61 -0
- package/models/operations/agentdelete.js.map +1 -0
- package/models/operations/agentgetbyid.d.ts +25 -0
- package/models/operations/agentgetbyid.d.ts.map +1 -0
- package/models/operations/agentgetbyid.js +59 -0
- package/models/operations/agentgetbyid.js.map +1 -0
- package/models/operations/agentlist.d.ts +117 -0
- package/models/operations/agentlist.d.ts.map +1 -0
- package/models/operations/agentlist.js +135 -0
- package/models/operations/agentlist.js.map +1 -0
- package/models/operations/availabletargets.d.ts +96 -0
- package/models/operations/availabletargets.d.ts.map +1 -0
- package/models/operations/availabletargets.js +127 -0
- package/models/operations/availabletargets.js.map +1 -0
- package/models/operations/channelsdelete.d.ts +25 -0
- package/models/operations/channelsdelete.d.ts.map +1 -0
- package/models/operations/channelsdelete.js +59 -0
- package/models/operations/channelsdelete.js.map +1 -0
- package/models/operations/channelslist.d.ts +99 -0
- package/models/operations/channelslist.d.ts.map +1 -0
- package/models/operations/channelslist.js +130 -0
- package/models/operations/channelslist.js.map +1 -0
- package/models/operations/channelstargetupdate.d.ts +30 -0
- package/models/operations/channelstargetupdate.d.ts.map +1 -0
- package/models/operations/channelstargetupdate.js +68 -0
- package/models/operations/channelstargetupdate.js.map +1 -0
- package/models/operations/channeltargetscreate.d.ts +28 -0
- package/models/operations/channeltargetscreate.d.ts.map +1 -0
- package/models/operations/channeltargetscreate.js +64 -0
- package/models/operations/channeltargetscreate.js.map +1 -0
- package/models/operations/channeltargetsgetbyid.d.ts +27 -0
- package/models/operations/channeltargetsgetbyid.d.ts.map +1 -0
- package/models/operations/channeltargetsgetbyid.js +63 -0
- package/models/operations/channeltargetsgetbyid.js.map +1 -0
- package/models/operations/channeltargetslist.d.ts +111 -0
- package/models/operations/channeltargetslist.d.ts.map +1 -0
- package/models/operations/channeltargetslist.js +137 -0
- package/models/operations/channeltargetslist.js.map +1 -0
- package/models/operations/conversationgetbyid.d.ts +25 -0
- package/models/operations/conversationgetbyid.d.ts.map +1 -0
- package/models/operations/conversationgetbyid.js +59 -0
- package/models/operations/conversationgetbyid.js.map +1 -0
- package/models/operations/conversationslist.d.ts +120 -0
- package/models/operations/conversationslist.d.ts.map +1 -0
- package/models/operations/conversationslist.js +140 -0
- package/models/operations/conversationslist.js.map +1 -0
- package/models/operations/custommessagegetbyid.d.ts +25 -0
- package/models/operations/custommessagegetbyid.d.ts.map +1 -0
- package/models/operations/custommessagegetbyid.js +59 -0
- package/models/operations/custommessagegetbyid.js.map +1 -0
- package/models/operations/custommessagesdelete.d.ts +27 -0
- package/models/operations/custommessagesdelete.d.ts.map +1 -0
- package/models/operations/custommessagesdelete.js +61 -0
- package/models/operations/custommessagesdelete.js.map +1 -0
- package/models/operations/custommessageslist.d.ts +96 -0
- package/models/operations/custommessageslist.d.ts.map +1 -0
- package/models/operations/custommessageslist.js +132 -0
- package/models/operations/custommessageslist.js.map +1 -0
- package/models/operations/eventslist.d.ts +117 -0
- package/models/operations/eventslist.d.ts.map +1 -0
- package/models/operations/eventslist.js +136 -0
- package/models/operations/eventslist.js.map +1 -0
- package/models/operations/getdailycallvolumebyhour.d.ts +24 -0
- package/models/operations/getdailycallvolumebyhour.d.ts.map +1 -0
- package/models/operations/getdailycallvolumebyhour.js +46 -0
- package/models/operations/getdailycallvolumebyhour.js.map +1 -0
- package/models/operations/getmonthlycallvolumebyday.d.ts +24 -0
- package/models/operations/getmonthlycallvolumebyday.d.ts.map +1 -0
- package/models/operations/getmonthlycallvolumebyday.js +46 -0
- package/models/operations/getmonthlycallvolumebyday.js.map +1 -0
- package/models/operations/getmonthlycallvolumebyweek.d.ts +24 -0
- package/models/operations/getmonthlycallvolumebyweek.d.ts.map +1 -0
- package/models/operations/getmonthlycallvolumebyweek.js +46 -0
- package/models/operations/getmonthlycallvolumebyweek.js.map +1 -0
- package/models/operations/getsessionagents.d.ts +24 -0
- package/models/operations/getsessionagents.d.ts.map +1 -0
- package/models/operations/getsessionagents.js +46 -0
- package/models/operations/getsessionagents.js.map +1 -0
- package/models/operations/getsessionsummary.d.ts +57 -0
- package/models/operations/getsessionsummary.d.ts.map +1 -0
- package/models/operations/getsessionsummary.js +90 -0
- package/models/operations/getsessionsummary.js.map +1 -0
- package/models/operations/gettotalcallvolumebyhour.d.ts +24 -0
- package/models/operations/gettotalcallvolumebyhour.d.ts.map +1 -0
- package/models/operations/gettotalcallvolumebyhour.js +46 -0
- package/models/operations/gettotalcallvolumebyhour.js.map +1 -0
- package/models/operations/getweeklycallvolumebyweekday.d.ts +24 -0
- package/models/operations/getweeklycallvolumebyweekday.d.ts.map +1 -0
- package/models/operations/getweeklycallvolumebyweekday.js +46 -0
- package/models/operations/getweeklycallvolumebyweekday.js.map +1 -0
- package/models/operations/index.d.ts +31 -0
- package/models/operations/index.d.ts.map +1 -0
- package/models/operations/index.js +50 -0
- package/models/operations/index.js.map +1 -0
- package/models/operations/promptsdelete.d.ts +27 -0
- package/models/operations/promptsdelete.d.ts.map +1 -0
- package/models/operations/promptsdelete.js +61 -0
- package/models/operations/promptsdelete.js.map +1 -0
- package/models/operations/promptsgetbyid.d.ts +25 -0
- package/models/operations/promptsgetbyid.d.ts.map +1 -0
- package/models/operations/promptsgetbyid.js +59 -0
- package/models/operations/promptsgetbyid.js.map +1 -0
- package/models/operations/promptslist.d.ts +102 -0
- package/models/operations/promptslist.d.ts.map +1 -0
- package/models/operations/promptslist.js +131 -0
- package/models/operations/promptslist.js.map +1 -0
- package/models/operations/sessionslist.d.ts +117 -0
- package/models/operations/sessionslist.d.ts.map +1 -0
- package/models/operations/sessionslist.js +136 -0
- package/models/operations/sessionslist.js.map +1 -0
- package/models/operations/toolgetbyname.d.ts +25 -0
- package/models/operations/toolgetbyname.d.ts.map +1 -0
- package/models/operations/toolgetbyname.js +59 -0
- package/models/operations/toolgetbyname.js.map +1 -0
- package/models/operations/toollist.d.ts +102 -0
- package/models/operations/toollist.d.ts.map +1 -0
- package/models/operations/toollist.js +131 -0
- package/models/operations/toollist.js.map +1 -0
- package/models/operations/totalcallvolumebyweekday.d.ts +24 -0
- package/models/operations/totalcallvolumebyweekday.d.ts.map +1 -0
- package/models/operations/totalcallvolumebyweekday.js +46 -0
- package/models/operations/totalcallvolumebyweekday.js.map +1 -0
- package/package.json +34 -0
- package/sdk/agents.d.ts +44 -0
- package/sdk/agents.d.ts.map +1 -0
- package/sdk/agents.js +67 -0
- package/sdk/agents.js.map +1 -0
- package/sdk/channels.d.ts +20 -0
- package/sdk/channels.d.ts.map +1 -0
- package/sdk/channels.js +34 -0
- package/sdk/channels.js.map +1 -0
- package/sdk/conversations.d.ts +14 -0
- package/sdk/conversations.d.ts.map +1 -0
- package/sdk/conversations.js +26 -0
- package/sdk/conversations.js.map +1 -0
- package/sdk/custommessages.d.ts +41 -0
- package/sdk/custommessages.d.ts.map +1 -0
- package/sdk/custommessages.js +62 -0
- package/sdk/custommessages.js.map +1 -0
- package/sdk/dashboards.d.ts +61 -0
- package/sdk/dashboards.d.ts.map +1 -0
- package/sdk/dashboards.js +92 -0
- package/sdk/dashboards.js.map +1 -0
- package/sdk/events.d.ts +10 -0
- package/sdk/events.d.ts.map +1 -0
- package/sdk/events.js +19 -0
- package/sdk/events.js.map +1 -0
- package/sdk/index.d.ts +2 -0
- package/sdk/index.d.ts.map +1 -0
- package/sdk/index.js +21 -0
- package/sdk/index.js.map +1 -0
- package/sdk/organizations.d.ts +12 -0
- package/sdk/organizations.d.ts.map +1 -0
- package/sdk/organizations.js +22 -0
- package/sdk/organizations.js.map +1 -0
- package/sdk/prompts.d.ts +41 -0
- package/sdk/prompts.d.ts.map +1 -0
- package/sdk/prompts.js +62 -0
- package/sdk/prompts.js.map +1 -0
- package/sdk/sdk.d.ts +34 -0
- package/sdk/sdk.d.ts.map +1 -0
- package/sdk/sdk.js +61 -0
- package/sdk/sdk.js.map +1 -0
- package/sdk/sessions.d.ts +10 -0
- package/sdk/sessions.d.ts.map +1 -0
- package/sdk/sessions.js +19 -0
- package/sdk/sessions.js.map +1 -0
- package/sdk/targets.d.ts +32 -0
- package/sdk/targets.d.ts.map +1 -0
- package/sdk/targets.js +53 -0
- package/sdk/targets.js.map +1 -0
- package/sdk/test.d.ts +12 -0
- package/sdk/test.d.ts.map +1 -0
- package/sdk/test.js +22 -0
- package/sdk/test.js.map +1 -0
- package/sdk/tools.d.ts +20 -0
- package/sdk/tools.d.ts.map +1 -0
- package/sdk/tools.js +32 -0
- package/sdk/tools.js.map +1 -0
- package/src/core.ts +13 -0
- package/src/funcs/agentsCreate.ts +124 -0
- package/src/funcs/agentsDelete.ts +136 -0
- package/src/funcs/agentsGetById.ts +131 -0
- package/src/funcs/agentsList.ts +137 -0
- package/src/funcs/agentsTestSendTestMessage.ts +124 -0
- package/src/funcs/agentsUpdate.ts +124 -0
- package/src/funcs/channelsDelete.ts +131 -0
- package/src/funcs/channelsList.ts +134 -0
- package/src/funcs/channelsTargetsAvailableTargets.ts +137 -0
- package/src/funcs/channelsTargetsCreate.ts +132 -0
- package/src/funcs/channelsTargetsGetById.ts +135 -0
- package/src/funcs/channelsTargetsList.ts +134 -0
- package/src/funcs/channelsTargetsUpdate.ts +139 -0
- package/src/funcs/conversationsGetById.ts +131 -0
- package/src/funcs/conversationsList.ts +134 -0
- package/src/funcs/customMessagesCreate.ts +124 -0
- package/src/funcs/customMessagesDelete.ts +140 -0
- package/src/funcs/customMessagesGetById.ts +135 -0
- package/src/funcs/customMessagesList.ts +137 -0
- package/src/funcs/customMessagesUpdate.ts +124 -0
- package/src/funcs/dashboardsGetDailyCallVolumeByHour.ts +104 -0
- package/src/funcs/dashboardsGetMonthlyCallVolumeByDay.ts +106 -0
- package/src/funcs/dashboardsGetMonthlyCallVolumeByWeek.ts +106 -0
- package/src/funcs/dashboardsGetSessionAgents.ts +103 -0
- package/src/funcs/dashboardsGetSessionSummary.ts +136 -0
- package/src/funcs/dashboardsGetTotalCallVolumeByHour.ts +104 -0
- package/src/funcs/dashboardsGetWeeklyCallVolumeByWeekday.ts +106 -0
- package/src/funcs/dashboardsTotalCallVolumeByWeekday.ts +104 -0
- package/src/funcs/eventsList.ts +134 -0
- package/src/funcs/organizationsList.ts +101 -0
- package/src/funcs/promptsCreate.ts +124 -0
- package/src/funcs/promptsDelete.ts +136 -0
- package/src/funcs/promptsGetById.ts +131 -0
- package/src/funcs/promptsList.ts +137 -0
- package/src/funcs/promptsUpdate.ts +124 -0
- package/src/funcs/sessionsList.ts +134 -0
- package/src/funcs/toolsGetByName.ts +131 -0
- package/src/funcs/toolsList.ts +140 -0
- package/src/hooks/hooks.ts +112 -0
- package/src/hooks/index.ts +6 -0
- package/src/hooks/registration.ts +14 -0
- package/src/hooks/types.ts +98 -0
- package/src/index.ts +7 -0
- package/src/lib/base64.ts +37 -0
- package/src/lib/config.ts +60 -0
- package/src/lib/dlv.ts +53 -0
- package/src/lib/encodings.ts +449 -0
- package/src/lib/env.ts +42 -0
- package/src/lib/files.ts +40 -0
- package/src/lib/http.ts +323 -0
- package/src/lib/is-plain-object.ts +43 -0
- package/src/lib/logger.ts +9 -0
- package/src/lib/matchers.ts +322 -0
- package/src/lib/primitives.ts +40 -0
- package/src/lib/retries.ts +187 -0
- package/src/lib/schemas.ts +86 -0
- package/src/lib/sdks.ts +388 -0
- package/src/lib/security.ts +218 -0
- package/src/lib/url.ts +33 -0
- package/src/models/components/agent.ts +134 -0
- package/src/models/components/agentcreate.ts +132 -0
- package/src/models/components/agentproperties.ts +41 -0
- package/src/models/components/agenttooldefaults.ts +66 -0
- package/src/models/components/agenttoolfielddefault.ts +60 -0
- package/src/models/components/availabletarget.ts +64 -0
- package/src/models/components/availabletargetproperties.ts +36 -0
- package/src/models/components/channel.ts +65 -0
- package/src/models/components/channelproperties.ts +35 -0
- package/src/models/components/channeltarget.ts +92 -0
- package/src/models/components/channeltargetcreaterequest.ts +88 -0
- package/src/models/components/channeltargetproperties.ts +41 -0
- package/src/models/components/conversation.ts +126 -0
- package/src/models/components/conversationaction.ts +70 -0
- package/src/models/components/conversationproperties.ts +42 -0
- package/src/models/components/conversationtext.ts +57 -0
- package/src/models/components/conversationtranscriptionresponse.ts +75 -0
- package/src/models/components/custommessage.ts +66 -0
- package/src/models/components/custommessagecreate.ts +55 -0
- package/src/models/components/custommessageproperties.ts +36 -0
- package/src/models/components/defaults.ts +127 -0
- package/src/models/components/event.ts +127 -0
- package/src/models/components/eventproperties.ts +41 -0
- package/src/models/components/function.ts +100 -0
- package/src/models/components/httpendpoint.ts +74 -0
- package/src/models/components/index.ts +59 -0
- package/src/models/components/listresponseagent.ts +80 -0
- package/src/models/components/listresponseavailabletarget.ts +80 -0
- package/src/models/components/listresponsechannel.ts +80 -0
- package/src/models/components/listresponsechanneltarget.ts +80 -0
- package/src/models/components/listresponseconversation.ts +80 -0
- package/src/models/components/listresponsecustommessage.ts +80 -0
- package/src/models/components/listresponseevent.ts +80 -0
- package/src/models/components/listresponseprompt.ts +80 -0
- package/src/models/components/listresponseschemasbubblegumv2toolstool.ts +82 -0
- package/src/models/components/listresponsesession.ts +80 -0
- package/src/models/components/llmconfig.ts +80 -0
- package/src/models/components/organization.ts +71 -0
- package/src/models/components/prompt.ts +101 -0
- package/src/models/components/promptcreate.ts +91 -0
- package/src/models/components/promptproperties.ts +36 -0
- package/src/models/components/provider.ts +37 -0
- package/src/models/components/schemasbubblegumv2toolstool.ts +93 -0
- package/src/models/components/schemascortexv1toolstool.ts +64 -0
- package/src/models/components/security.ts +54 -0
- package/src/models/components/session.ts +101 -0
- package/src/models/components/sessionproperties.ts +41 -0
- package/src/models/components/testmessage.ts +86 -0
- package/src/models/components/testmessageresponse.ts +100 -0
- package/src/models/components/tooldefinition.ts +114 -0
- package/src/models/components/tooldetailresponse.ts +53 -0
- package/src/models/components/toolparameterdefault.ts +57 -0
- package/src/models/components/toolparametertransform.ts +65 -0
- package/src/models/components/toolparametertransformcondition.ts +62 -0
- package/src/models/components/toolproperties.ts +36 -0
- package/src/models/components/validationerror.ts +80 -0
- package/src/models/errors/httpclienterrors.ts +62 -0
- package/src/models/errors/httpvalidationerror.ts +70 -0
- package/src/models/errors/index.ts +8 -0
- package/src/models/errors/sdkerror.ts +27 -0
- package/src/models/errors/sdkvalidationerror.ts +97 -0
- package/src/models/operations/agentdelete.ts +58 -0
- package/src/models/operations/agentgetbyid.ts +54 -0
- package/src/models/operations/agentlist.ts +160 -0
- package/src/models/operations/availabletargets.ts +161 -0
- package/src/models/operations/channelsdelete.ts +54 -0
- package/src/models/operations/channelslist.ts +165 -0
- package/src/models/operations/channelstargetupdate.ts +67 -0
- package/src/models/operations/channeltargetscreate.ts +63 -0
- package/src/models/operations/channeltargetsgetbyid.ts +60 -0
- package/src/models/operations/channeltargetslist.ts +172 -0
- package/src/models/operations/conversationgetbyid.ts +54 -0
- package/src/models/operations/conversationslist.ts +174 -0
- package/src/models/operations/custommessagegetbyid.ts +54 -0
- package/src/models/operations/custommessagesdelete.ts +58 -0
- package/src/models/operations/custommessageslist.ts +167 -0
- package/src/models/operations/eventslist.ts +171 -0
- package/src/models/operations/getdailycallvolumebyhour.ts +46 -0
- package/src/models/operations/getmonthlycallvolumebyday.ts +46 -0
- package/src/models/operations/getmonthlycallvolumebyweek.ts +46 -0
- package/src/models/operations/getsessionagents.ts +42 -0
- package/src/models/operations/getsessionsummary.ts +116 -0
- package/src/models/operations/gettotalcallvolumebyhour.ts +46 -0
- package/src/models/operations/getweeklycallvolumebyweekday.ts +47 -0
- package/src/models/operations/index.ts +34 -0
- package/src/models/operations/promptsdelete.ts +58 -0
- package/src/models/operations/promptsgetbyid.ts +54 -0
- package/src/models/operations/promptslist.ts +166 -0
- package/src/models/operations/sessionslist.ts +171 -0
- package/src/models/operations/toolgetbyname.ts +54 -0
- package/src/models/operations/toollist.ts +164 -0
- package/src/models/operations/totalcallvolumebyweekday.ts +46 -0
- package/src/sdk/agents.ts +106 -0
- package/src/sdk/channels.ts +49 -0
- package/src/sdk/conversations.ts +40 -0
- package/src/sdk/custommessages.ts +100 -0
- package/src/sdk/dashboards.ts +151 -0
- package/src/sdk/events.ts +25 -0
- package/src/sdk/index.ts +5 -0
- package/src/sdk/organizations.ts +25 -0
- package/src/sdk/prompts.ts +100 -0
- package/src/sdk/sdk.ts +67 -0
- package/src/sdk/sessions.ts +25 -0
- package/src/sdk/targets.ts +91 -0
- package/src/sdk/test.ts +27 -0
- package/src/sdk/tools.ts +46 -0
- package/src/types/blobs.ts +31 -0
- package/src/types/constdatetime.ts +15 -0
- package/src/types/enums.ts +16 -0
- package/src/types/fp.ts +50 -0
- package/src/types/index.ts +11 -0
- package/src/types/operations.ts +99 -0
- package/src/types/rfcdate.ts +54 -0
- package/src/types/streams.ts +21 -0
- package/types/blobs.d.ts +4 -0
- package/types/blobs.d.ts.map +1 -0
- package/types/blobs.js +52 -0
- package/types/blobs.js.map +1 -0
- package/types/constdatetime.d.ts +3 -0
- package/types/constdatetime.d.ts.map +1 -0
- package/types/constdatetime.js +36 -0
- package/types/constdatetime.js.map +1 -0
- package/types/enums.d.ts +12 -0
- package/types/enums.d.ts.map +1 -0
- package/types/enums.js +10 -0
- package/types/enums.js.map +1 -0
- package/types/fp.d.ts +31 -0
- package/types/fp.d.ts.map +1 -0
- package/types/fp.js +37 -0
- package/types/fp.js.map +1 -0
- package/types/index.d.ts +8 -0
- package/types/index.d.ts.map +1 -0
- package/types/index.js +16 -0
- package/types/index.js.map +1 -0
- package/types/operations.d.ts +25 -0
- package/types/operations.d.ts.map +1 -0
- package/types/operations.js +80 -0
- package/types/operations.js.map +1 -0
- package/types/rfcdate.d.ts +21 -0
- package/types/rfcdate.d.ts.map +1 -0
- package/types/rfcdate.js +46 -0
- package/types/rfcdate.js.map +1 -0
- package/types/streams.d.ts +2 -0
- package/types/streams.d.ts.map +1 -0
- package/types/streams.js +18 -0
- package/types/streams.js.map +1 -0
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
|
|
2
|
+
<div align="center">
|
|
3
|
+
<a href="https://codespaces.new/asksyllable/syllable-sdk-typescript.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
|
|
4
|
+
</div>
|
|
5
|
+
<br>
|
|
6
|
+
|
|
7
|
+
> **Remember to shutdown a GitHub Codespace when it is not in use!**
|
|
8
|
+
|
|
9
|
+
# Dev Containers Quick Start
|
|
10
|
+
|
|
11
|
+
The default location for usage snippets is the `samples` directory.
|
|
12
|
+
|
|
13
|
+
## Running a Usage Sample
|
|
14
|
+
|
|
15
|
+
A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
ts-node root.ts
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Generating Additional Usage Samples
|
|
22
|
+
|
|
23
|
+
The speakeasy CLI allows you to generate more usage snippets. Here's how:
|
|
24
|
+
|
|
25
|
+
- To generate a sample for a specific operation by providing an operation ID, use:
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
speakeasy generate usage -s openapi.yaml -l typescript -i {INPUT_OPERATION_ID} -o ./samples
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
- To generate samples for an entire namespace (like a tag or group name), use:
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
speakeasy generate usage -s openapi.yaml -l typescript -n {INPUT_TAG_NAME} -o ./samples
|
|
35
|
+
```
|
package/README.md
ADDED
|
@@ -0,0 +1,556 @@
|
|
|
1
|
+
# syllable-sdk
|
|
2
|
+
|
|
3
|
+
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *syllable-sdk* API.
|
|
4
|
+
|
|
5
|
+
<div align="left">
|
|
6
|
+
<a href="https://www.speakeasy.com/?utm_source=syllable-sdk&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
|
|
7
|
+
<a href="https://opensource.org/licenses/MIT">
|
|
8
|
+
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
|
|
9
|
+
</a>
|
|
10
|
+
</div>
|
|
11
|
+
|
|
12
|
+
<!-- Start Summary [summary] -->
|
|
13
|
+
## Summary
|
|
14
|
+
|
|
15
|
+
SyllableSDK:
|
|
16
|
+
# Syllble Platform SDK
|
|
17
|
+
|
|
18
|
+
Syllble SDK gives you the power of awesome AI agentry. 🚀
|
|
19
|
+
|
|
20
|
+
## Overview
|
|
21
|
+
|
|
22
|
+
The Syllble SDK provides a comprehensive set of tools and APIs to integrate powerful AI capabilities into your applications. Whether you're building chatbots, virtual assistants, or any other AI-driven solutions, Syllble SDK has got you covered.
|
|
23
|
+
|
|
24
|
+
## Features
|
|
25
|
+
|
|
26
|
+
- **Natural Language Processing (NLP)**: Understand and generate human language with ease.
|
|
27
|
+
- **Machine Learning Models**: Leverage pre-trained models or train your own custom models.
|
|
28
|
+
- **Speech Recognition**: Convert speech to text and vice versa.
|
|
29
|
+
- **Image Recognition**: Identify objects, faces, and scenes in images.
|
|
30
|
+
- **Data Analytics**: Analyze and visualize data to gain insights.
|
|
31
|
+
- **Integration**: Seamlessly integrate with other services and platforms.
|
|
32
|
+
<!-- End Summary [summary] -->
|
|
33
|
+
|
|
34
|
+
<!-- Start Table of Contents [toc] -->
|
|
35
|
+
## Table of Contents
|
|
36
|
+
|
|
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
|
+
<!-- End Table of Contents [toc] -->
|
|
49
|
+
|
|
50
|
+
<!-- Start SDK Installation [installation] -->
|
|
51
|
+
## SDK Installation
|
|
52
|
+
|
|
53
|
+
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
|
|
54
|
+
|
|
55
|
+
### NPM
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
npm add https://github.com/asksyllable/syllable-sdk-typescript
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### PNPM
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
pnpm add https://github.com/asksyllable/syllable-sdk-typescript
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Bun
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
bun add https://github.com/asksyllable/syllable-sdk-typescript
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Yarn
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
yarn add https://github.com/asksyllable/syllable-sdk-typescript zod
|
|
77
|
+
|
|
78
|
+
# Note that Yarn does not install peer dependencies automatically. You will need
|
|
79
|
+
# to install zod as shown above.
|
|
80
|
+
```
|
|
81
|
+
<!-- End SDK Installation [installation] -->
|
|
82
|
+
|
|
83
|
+
<!-- Start Requirements [requirements] -->
|
|
84
|
+
## Requirements
|
|
85
|
+
|
|
86
|
+
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
|
87
|
+
<!-- End Requirements [requirements] -->
|
|
88
|
+
|
|
89
|
+
<!-- Start SDK Example Usage [usage] -->
|
|
90
|
+
## SDK Example Usage
|
|
91
|
+
|
|
92
|
+
### Example
|
|
93
|
+
|
|
94
|
+
```typescript
|
|
95
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
96
|
+
|
|
97
|
+
const syllableSDK = new SyllableSDK({
|
|
98
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
async function run() {
|
|
102
|
+
const result = await syllableSDK.agents.list({});
|
|
103
|
+
|
|
104
|
+
// Handle the result
|
|
105
|
+
console.log(result);
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
run();
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
<!-- End SDK Example Usage [usage] -->
|
|
112
|
+
|
|
113
|
+
<!-- Start Available Resources and Operations [operations] -->
|
|
114
|
+
## Available Resources and Operations
|
|
115
|
+
|
|
116
|
+
<details open>
|
|
117
|
+
<summary>Available methods</summary>
|
|
118
|
+
|
|
119
|
+
### [agents](docs/sdks/agents/README.md)
|
|
120
|
+
|
|
121
|
+
* [list](docs/sdks/agents/README.md#list) - Agent List
|
|
122
|
+
* [create](docs/sdks/agents/README.md#create) - Create Agent
|
|
123
|
+
* [update](docs/sdks/agents/README.md#update) - Update Agent
|
|
124
|
+
* [getById](docs/sdks/agents/README.md#getbyid) - Get Agent By Id
|
|
125
|
+
* [delete](docs/sdks/agents/README.md#delete) - Delete Agent
|
|
126
|
+
|
|
127
|
+
#### [agents.test](docs/sdks/test/README.md)
|
|
128
|
+
|
|
129
|
+
* [sendTestMessage](docs/sdks/test/README.md#sendtestmessage) - Send New Message
|
|
130
|
+
|
|
131
|
+
### [channels](docs/sdks/channels/README.md)
|
|
132
|
+
|
|
133
|
+
* [list](docs/sdks/channels/README.md#list) - Get Channels
|
|
134
|
+
* [delete](docs/sdks/channels/README.md#delete) - Delete Channel
|
|
135
|
+
|
|
136
|
+
#### [channels.targets](docs/sdks/targets/README.md)
|
|
137
|
+
|
|
138
|
+
* [availableTargets](docs/sdks/targets/README.md#availabletargets) - Available Targets List
|
|
139
|
+
* [list](docs/sdks/targets/README.md#list) - Get Channel Targets
|
|
140
|
+
* [create](docs/sdks/targets/README.md#create) - Assign A Channel Target
|
|
141
|
+
* [getById](docs/sdks/targets/README.md#getbyid) - Get A Channel Target
|
|
142
|
+
* [update](docs/sdks/targets/README.md#update) - Edit Channel Target
|
|
143
|
+
|
|
144
|
+
### [conversations](docs/sdks/conversations/README.md)
|
|
145
|
+
|
|
146
|
+
* [list](docs/sdks/conversations/README.md#list) - Conversations List
|
|
147
|
+
* [getById](docs/sdks/conversations/README.md#getbyid) - Get Conversation By Id
|
|
148
|
+
|
|
149
|
+
### [customMessages](docs/sdks/custommessages/README.md)
|
|
150
|
+
|
|
151
|
+
* [list](docs/sdks/custommessages/README.md#list) - Custom Messages List
|
|
152
|
+
* [create](docs/sdks/custommessages/README.md#create) - Create Custom Message
|
|
153
|
+
* [update](docs/sdks/custommessages/README.md#update) - Update Custom Message
|
|
154
|
+
* [getById](docs/sdks/custommessages/README.md#getbyid) - Get Custom Message By Id
|
|
155
|
+
* [delete](docs/sdks/custommessages/README.md#delete) - Delete Custom Message
|
|
156
|
+
|
|
157
|
+
### [dashboards](docs/sdks/dashboards/README.md)
|
|
158
|
+
|
|
159
|
+
* [totalCallVolumeByWeekday](docs/sdks/dashboards/README.md#totalcallvolumebyweekday) - Get Total Call Volume By Weekday
|
|
160
|
+
* [getTotalCallVolumeByHour](docs/sdks/dashboards/README.md#gettotalcallvolumebyhour) - Get Total Call Volume By Hour
|
|
161
|
+
* [getWeeklyCallVolumeByWeekday](docs/sdks/dashboards/README.md#getweeklycallvolumebyweekday) - Get Weekly Call Volume By Weekday
|
|
162
|
+
* [getDailyCallVolumeByHour](docs/sdks/dashboards/README.md#getdailycallvolumebyhour) - Get Daily Call Volume By Hour
|
|
163
|
+
* [getMonthlyCallVolumeByWeek](docs/sdks/dashboards/README.md#getmonthlycallvolumebyweek) - Get Monthly Call Volume By Week
|
|
164
|
+
* [getMonthlyCallVolumeByDay](docs/sdks/dashboards/README.md#getmonthlycallvolumebyday) - Get Monthly Call Volume By Day
|
|
165
|
+
* [getSessionSummary](docs/sdks/dashboards/README.md#getsessionsummary) - Get Session Summary
|
|
166
|
+
* [getSessionAgents](docs/sdks/dashboards/README.md#getsessionagents) - Get Agents
|
|
167
|
+
|
|
168
|
+
### [events](docs/sdks/events/README.md)
|
|
169
|
+
|
|
170
|
+
* [list](docs/sdks/events/README.md#list) - Events List
|
|
171
|
+
|
|
172
|
+
### [organizations](docs/sdks/organizations/README.md)
|
|
173
|
+
|
|
174
|
+
* [list](docs/sdks/organizations/README.md#list) - Organizations List
|
|
175
|
+
|
|
176
|
+
### [prompts](docs/sdks/prompts/README.md)
|
|
177
|
+
|
|
178
|
+
* [list](docs/sdks/prompts/README.md#list) - Prompt List
|
|
179
|
+
* [create](docs/sdks/prompts/README.md#create) - Create Prompt
|
|
180
|
+
* [update](docs/sdks/prompts/README.md#update) - Update Prompt
|
|
181
|
+
* [getById](docs/sdks/prompts/README.md#getbyid) - Get Prompt By Id
|
|
182
|
+
* [delete](docs/sdks/prompts/README.md#delete) - Delete Prompt
|
|
183
|
+
|
|
184
|
+
### [sessions](docs/sdks/sessions/README.md)
|
|
185
|
+
|
|
186
|
+
* [list](docs/sdks/sessions/README.md#list) - Sessions List
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
### [tools](docs/sdks/tools/README.md)
|
|
190
|
+
|
|
191
|
+
* [list](docs/sdks/tools/README.md#list) - Tool List
|
|
192
|
+
* [getByName](docs/sdks/tools/README.md#getbyname) - Tool Info
|
|
193
|
+
|
|
194
|
+
</details>
|
|
195
|
+
<!-- End Available Resources and Operations [operations] -->
|
|
196
|
+
|
|
197
|
+
<!-- Start Standalone functions [standalone-funcs] -->
|
|
198
|
+
## Standalone functions
|
|
199
|
+
|
|
200
|
+
All the methods listed above are available as standalone functions. These
|
|
201
|
+
functions are ideal for use in applications running in the browser, serverless
|
|
202
|
+
runtimes or other environments where application bundle size is a primary
|
|
203
|
+
concern. When using a bundler to build your application, all unused
|
|
204
|
+
functionality will be either excluded from the final bundle or tree-shaken away.
|
|
205
|
+
|
|
206
|
+
To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
207
|
+
|
|
208
|
+
<details>
|
|
209
|
+
|
|
210
|
+
<summary>Available standalone functions</summary>
|
|
211
|
+
|
|
212
|
+
- [`agentsCreate`](docs/sdks/agents/README.md#create) - Create Agent
|
|
213
|
+
- [`agentsDelete`](docs/sdks/agents/README.md#delete) - Delete Agent
|
|
214
|
+
- [`agentsGetById`](docs/sdks/agents/README.md#getbyid) - Get Agent By Id
|
|
215
|
+
- [`agentsList`](docs/sdks/agents/README.md#list) - Agent List
|
|
216
|
+
- [`agentsTestSendTestMessage`](docs/sdks/test/README.md#sendtestmessage) - Send New Message
|
|
217
|
+
- [`agentsUpdate`](docs/sdks/agents/README.md#update) - Update Agent
|
|
218
|
+
- [`channelsDelete`](docs/sdks/channels/README.md#delete) - Delete Channel
|
|
219
|
+
- [`channelsList`](docs/sdks/channels/README.md#list) - Get Channels
|
|
220
|
+
- [`channelsTargetsAvailableTargets`](docs/sdks/targets/README.md#availabletargets) - Available Targets List
|
|
221
|
+
- [`channelsTargetsCreate`](docs/sdks/targets/README.md#create) - Assign A Channel Target
|
|
222
|
+
- [`channelsTargetsGetById`](docs/sdks/targets/README.md#getbyid) - Get A Channel Target
|
|
223
|
+
- [`channelsTargetsList`](docs/sdks/targets/README.md#list) - Get Channel Targets
|
|
224
|
+
- [`channelsTargetsUpdate`](docs/sdks/targets/README.md#update) - Edit Channel Target
|
|
225
|
+
- [`conversationsGetById`](docs/sdks/conversations/README.md#getbyid) - Get Conversation By Id
|
|
226
|
+
- [`conversationsList`](docs/sdks/conversations/README.md#list) - Conversations List
|
|
227
|
+
- [`customMessagesCreate`](docs/sdks/custommessages/README.md#create) - Create Custom Message
|
|
228
|
+
- [`customMessagesDelete`](docs/sdks/custommessages/README.md#delete) - Delete Custom Message
|
|
229
|
+
- [`customMessagesGetById`](docs/sdks/custommessages/README.md#getbyid) - Get Custom Message By Id
|
|
230
|
+
- [`customMessagesList`](docs/sdks/custommessages/README.md#list) - Custom Messages List
|
|
231
|
+
- [`customMessagesUpdate`](docs/sdks/custommessages/README.md#update) - Update Custom Message
|
|
232
|
+
- [`dashboardsGetDailyCallVolumeByHour`](docs/sdks/dashboards/README.md#getdailycallvolumebyhour) - Get Daily Call Volume By Hour
|
|
233
|
+
- [`dashboardsGetMonthlyCallVolumeByDay`](docs/sdks/dashboards/README.md#getmonthlycallvolumebyday) - Get Monthly Call Volume By Day
|
|
234
|
+
- [`dashboardsGetMonthlyCallVolumeByWeek`](docs/sdks/dashboards/README.md#getmonthlycallvolumebyweek) - Get Monthly Call Volume By Week
|
|
235
|
+
- [`dashboardsGetSessionAgents`](docs/sdks/dashboards/README.md#getsessionagents) - Get Agents
|
|
236
|
+
- [`dashboardsGetSessionSummary`](docs/sdks/dashboards/README.md#getsessionsummary) - Get Session Summary
|
|
237
|
+
- [`dashboardsGetTotalCallVolumeByHour`](docs/sdks/dashboards/README.md#gettotalcallvolumebyhour) - Get Total Call Volume By Hour
|
|
238
|
+
- [`dashboardsGetWeeklyCallVolumeByWeekday`](docs/sdks/dashboards/README.md#getweeklycallvolumebyweekday) - Get Weekly Call Volume By Weekday
|
|
239
|
+
- [`dashboardsTotalCallVolumeByWeekday`](docs/sdks/dashboards/README.md#totalcallvolumebyweekday) - Get Total Call Volume By Weekday
|
|
240
|
+
- [`eventsList`](docs/sdks/events/README.md#list) - Events List
|
|
241
|
+
- [`organizationsList`](docs/sdks/organizations/README.md#list) - Organizations List
|
|
242
|
+
- [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create Prompt
|
|
243
|
+
- [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete Prompt
|
|
244
|
+
- [`promptsGetById`](docs/sdks/prompts/README.md#getbyid) - Get Prompt By Id
|
|
245
|
+
- [`promptsList`](docs/sdks/prompts/README.md#list) - Prompt List
|
|
246
|
+
- [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update Prompt
|
|
247
|
+
- [`sessionsList`](docs/sdks/sessions/README.md#list) - Sessions List
|
|
248
|
+
- [`toolsGetByName`](docs/sdks/tools/README.md#getbyname) - Tool Info
|
|
249
|
+
- [`toolsList`](docs/sdks/tools/README.md#list) - Tool List
|
|
250
|
+
|
|
251
|
+
</details>
|
|
252
|
+
<!-- End Standalone functions [standalone-funcs] -->
|
|
253
|
+
|
|
254
|
+
<!-- Start Retries [retries] -->
|
|
255
|
+
## Retries
|
|
256
|
+
|
|
257
|
+
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
|
|
258
|
+
|
|
259
|
+
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
|
|
260
|
+
```typescript
|
|
261
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
262
|
+
|
|
263
|
+
const syllableSDK = new SyllableSDK({
|
|
264
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
265
|
+
});
|
|
266
|
+
|
|
267
|
+
async function run() {
|
|
268
|
+
const result = await syllableSDK.agents.list({}, {
|
|
269
|
+
retries: {
|
|
270
|
+
strategy: "backoff",
|
|
271
|
+
backoff: {
|
|
272
|
+
initialInterval: 1,
|
|
273
|
+
maxInterval: 50,
|
|
274
|
+
exponent: 1.1,
|
|
275
|
+
maxElapsedTime: 100,
|
|
276
|
+
},
|
|
277
|
+
retryConnectionErrors: false,
|
|
278
|
+
},
|
|
279
|
+
});
|
|
280
|
+
|
|
281
|
+
// Handle the result
|
|
282
|
+
console.log(result);
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
run();
|
|
286
|
+
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
|
|
290
|
+
```typescript
|
|
291
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
292
|
+
|
|
293
|
+
const syllableSDK = new SyllableSDK({
|
|
294
|
+
retryConfig: {
|
|
295
|
+
strategy: "backoff",
|
|
296
|
+
backoff: {
|
|
297
|
+
initialInterval: 1,
|
|
298
|
+
maxInterval: 50,
|
|
299
|
+
exponent: 1.1,
|
|
300
|
+
maxElapsedTime: 100,
|
|
301
|
+
},
|
|
302
|
+
retryConnectionErrors: false,
|
|
303
|
+
},
|
|
304
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
305
|
+
});
|
|
306
|
+
|
|
307
|
+
async function run() {
|
|
308
|
+
const result = await syllableSDK.agents.list({});
|
|
309
|
+
|
|
310
|
+
// Handle the result
|
|
311
|
+
console.log(result);
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
run();
|
|
315
|
+
|
|
316
|
+
```
|
|
317
|
+
<!-- End Retries [retries] -->
|
|
318
|
+
|
|
319
|
+
<!-- Start Error Handling [errors] -->
|
|
320
|
+
## Error Handling
|
|
321
|
+
|
|
322
|
+
All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
|
|
323
|
+
|
|
324
|
+
If a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:
|
|
325
|
+
|
|
326
|
+
| HTTP Client Error | Description |
|
|
327
|
+
| ---------------------------------------------------- | ---------------------------------------------------- |
|
|
328
|
+
| RequestAbortedError | HTTP request was aborted by the client |
|
|
329
|
+
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
|
|
330
|
+
| ConnectionError | HTTP client was unable to make a request to a server |
|
|
331
|
+
| InvalidRequestError | Any input used to create a request is invalid |
|
|
332
|
+
| UnexpectedClientError | Unrecognised or unexpected error |
|
|
333
|
+
|
|
334
|
+
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `list` method may throw the following errors:
|
|
335
|
+
|
|
336
|
+
| Error Type | Status Code | Content Type |
|
|
337
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
338
|
+
| errors.HTTPValidationError | 422 | application/json |
|
|
339
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
340
|
+
|
|
341
|
+
```typescript
|
|
342
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
343
|
+
import {
|
|
344
|
+
HTTPValidationError,
|
|
345
|
+
SDKValidationError,
|
|
346
|
+
} from "syllable-sdk/models/errors";
|
|
347
|
+
|
|
348
|
+
const syllableSDK = new SyllableSDK({
|
|
349
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
350
|
+
});
|
|
351
|
+
|
|
352
|
+
async function run() {
|
|
353
|
+
let result;
|
|
354
|
+
try {
|
|
355
|
+
result = await syllableSDK.agents.list({});
|
|
356
|
+
|
|
357
|
+
// Handle the result
|
|
358
|
+
console.log(result);
|
|
359
|
+
} catch (err) {
|
|
360
|
+
switch (true) {
|
|
361
|
+
case (err instanceof SDKValidationError): {
|
|
362
|
+
// Validation errors can be pretty-printed
|
|
363
|
+
console.error(err.pretty());
|
|
364
|
+
// Raw value may also be inspected
|
|
365
|
+
console.error(err.rawValue);
|
|
366
|
+
return;
|
|
367
|
+
}
|
|
368
|
+
case (err instanceof HTTPValidationError): {
|
|
369
|
+
// Handle err.data$: HTTPValidationErrorData
|
|
370
|
+
console.error(err);
|
|
371
|
+
return;
|
|
372
|
+
}
|
|
373
|
+
default: {
|
|
374
|
+
throw err;
|
|
375
|
+
}
|
|
376
|
+
}
|
|
377
|
+
}
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
run();
|
|
381
|
+
|
|
382
|
+
```
|
|
383
|
+
|
|
384
|
+
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
|
385
|
+
<!-- End Error Handling [errors] -->
|
|
386
|
+
|
|
387
|
+
<!-- Start Server Selection [server] -->
|
|
388
|
+
## Server Selection
|
|
389
|
+
|
|
390
|
+
### Select Server by Index
|
|
391
|
+
|
|
392
|
+
You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
|
393
|
+
|
|
394
|
+
| # | Server | Variables |
|
|
395
|
+
| - | ------ | --------- |
|
|
396
|
+
| 0 | `http://127.0.0.1:8001` | None |
|
|
397
|
+
|
|
398
|
+
```typescript
|
|
399
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
400
|
+
|
|
401
|
+
const syllableSDK = new SyllableSDK({
|
|
402
|
+
serverIdx: 0,
|
|
403
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
404
|
+
});
|
|
405
|
+
|
|
406
|
+
async function run() {
|
|
407
|
+
const result = await syllableSDK.agents.list({});
|
|
408
|
+
|
|
409
|
+
// Handle the result
|
|
410
|
+
console.log(result);
|
|
411
|
+
}
|
|
412
|
+
|
|
413
|
+
run();
|
|
414
|
+
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
### Override Server URL Per-Client
|
|
419
|
+
|
|
420
|
+
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
|
|
421
|
+
|
|
422
|
+
```typescript
|
|
423
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
424
|
+
|
|
425
|
+
const syllableSDK = new SyllableSDK({
|
|
426
|
+
serverURL: "http://127.0.0.1:8001",
|
|
427
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
428
|
+
});
|
|
429
|
+
|
|
430
|
+
async function run() {
|
|
431
|
+
const result = await syllableSDK.agents.list({});
|
|
432
|
+
|
|
433
|
+
// Handle the result
|
|
434
|
+
console.log(result);
|
|
435
|
+
}
|
|
436
|
+
|
|
437
|
+
run();
|
|
438
|
+
|
|
439
|
+
```
|
|
440
|
+
<!-- End Server Selection [server] -->
|
|
441
|
+
|
|
442
|
+
<!-- Start Custom HTTP Client [http-client] -->
|
|
443
|
+
## Custom HTTP Client
|
|
444
|
+
|
|
445
|
+
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
|
|
446
|
+
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
|
|
447
|
+
client is a thin wrapper around `fetch` and provides the ability to attach hooks
|
|
448
|
+
around the request lifecycle that can be used to modify the request or handle
|
|
449
|
+
errors and response.
|
|
450
|
+
|
|
451
|
+
The `HTTPClient` constructor takes an optional `fetcher` argument that can be
|
|
452
|
+
used to integrate a third-party HTTP client or when writing tests to mock out
|
|
453
|
+
the HTTP client and feed in fixtures.
|
|
454
|
+
|
|
455
|
+
The following example shows how to use the `"beforeRequest"` hook to to add a
|
|
456
|
+
custom header and a timeout to requests and how to use the `"requestError"` hook
|
|
457
|
+
to log errors:
|
|
458
|
+
|
|
459
|
+
```typescript
|
|
460
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
461
|
+
import { HTTPClient } from "syllable-sdk/lib/http";
|
|
462
|
+
|
|
463
|
+
const httpClient = new HTTPClient({
|
|
464
|
+
// fetcher takes a function that has the same signature as native `fetch`.
|
|
465
|
+
fetcher: (request) => {
|
|
466
|
+
return fetch(request);
|
|
467
|
+
}
|
|
468
|
+
});
|
|
469
|
+
|
|
470
|
+
httpClient.addHook("beforeRequest", (request) => {
|
|
471
|
+
const nextRequest = new Request(request, {
|
|
472
|
+
signal: request.signal || AbortSignal.timeout(5000)
|
|
473
|
+
});
|
|
474
|
+
|
|
475
|
+
nextRequest.headers.set("x-custom-header", "custom value");
|
|
476
|
+
|
|
477
|
+
return nextRequest;
|
|
478
|
+
});
|
|
479
|
+
|
|
480
|
+
httpClient.addHook("requestError", (error, request) => {
|
|
481
|
+
console.group("Request Error");
|
|
482
|
+
console.log("Reason:", `${error}`);
|
|
483
|
+
console.log("Endpoint:", `${request.method} ${request.url}`);
|
|
484
|
+
console.groupEnd();
|
|
485
|
+
});
|
|
486
|
+
|
|
487
|
+
const sdk = new SyllableSDK({ httpClient });
|
|
488
|
+
```
|
|
489
|
+
<!-- End Custom HTTP Client [http-client] -->
|
|
490
|
+
|
|
491
|
+
<!-- Start Authentication [security] -->
|
|
492
|
+
## Authentication
|
|
493
|
+
|
|
494
|
+
### Per-Client Security Schemes
|
|
495
|
+
|
|
496
|
+
This SDK supports the following security scheme globally:
|
|
497
|
+
|
|
498
|
+
| Name | Type | Scheme | Environment Variable |
|
|
499
|
+
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
|
|
500
|
+
| `apiKeyHeader` | apiKey | API key | `SYLLABLESDK_API_KEY_HEADER` |
|
|
501
|
+
|
|
502
|
+
To authenticate with the API the `apiKeyHeader` parameter must be set when initializing the SDK client instance. For example:
|
|
503
|
+
```typescript
|
|
504
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
505
|
+
|
|
506
|
+
const syllableSDK = new SyllableSDK({
|
|
507
|
+
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
508
|
+
});
|
|
509
|
+
|
|
510
|
+
async function run() {
|
|
511
|
+
const result = await syllableSDK.agents.list({});
|
|
512
|
+
|
|
513
|
+
// Handle the result
|
|
514
|
+
console.log(result);
|
|
515
|
+
}
|
|
516
|
+
|
|
517
|
+
run();
|
|
518
|
+
|
|
519
|
+
```
|
|
520
|
+
<!-- End Authentication [security] -->
|
|
521
|
+
|
|
522
|
+
<!-- Start Debugging [debug] -->
|
|
523
|
+
## Debugging
|
|
524
|
+
|
|
525
|
+
You can setup your SDK to emit debug logs for SDK requests and responses.
|
|
526
|
+
|
|
527
|
+
You can pass a logger that matches `console`'s interface as an SDK option.
|
|
528
|
+
|
|
529
|
+
> [!WARNING]
|
|
530
|
+
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
|
|
531
|
+
|
|
532
|
+
```typescript
|
|
533
|
+
import { SyllableSDK } from "syllable-sdk";
|
|
534
|
+
|
|
535
|
+
const sdk = new SyllableSDK({ debugLogger: console });
|
|
536
|
+
```
|
|
537
|
+
|
|
538
|
+
You can also enable a default debug logger by setting an environment variable `SYLLABLESDK_DEBUG` to true.
|
|
539
|
+
<!-- End Debugging [debug] -->
|
|
540
|
+
|
|
541
|
+
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
|
542
|
+
|
|
543
|
+
# Development
|
|
544
|
+
|
|
545
|
+
## Maturity
|
|
546
|
+
|
|
547
|
+
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
|
|
548
|
+
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
|
549
|
+
looking for the latest version.
|
|
550
|
+
|
|
551
|
+
## Contributions
|
|
552
|
+
|
|
553
|
+
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
|
|
554
|
+
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
|
|
555
|
+
|
|
556
|
+
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=syllable-sdk&utm_campaign=typescript)
|
package/core.d.ts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { ClientSDK } from "./lib/sdks.js";
|
|
2
|
+
/**
|
|
3
|
+
* A minimal client to use when calling standalone SDK functions. Typically, an
|
|
4
|
+
* instance of this class would be instantiated once at the start of an
|
|
5
|
+
* application and passed around through some dependency injection mechanism to
|
|
6
|
+
* parts of an application that need to make SDK calls.
|
|
7
|
+
*/
|
|
8
|
+
export declare class SyllableSDKCore extends ClientSDK {
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=core.d.ts.map
|
package/core.d.ts.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["src/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,eAAgB,SAAQ,SAAS;CAAG"}
|
package/core.js
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/*
|
|
3
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.SyllableSDKCore = void 0;
|
|
7
|
+
const sdks_js_1 = require("./lib/sdks.js");
|
|
8
|
+
/**
|
|
9
|
+
* A minimal client to use when calling standalone SDK functions. Typically, an
|
|
10
|
+
* instance of this class would be instantiated once at the start of an
|
|
11
|
+
* application and passed around through some dependency injection mechanism to
|
|
12
|
+
* parts of an application that need to make SDK calls.
|
|
13
|
+
*/
|
|
14
|
+
class SyllableSDKCore extends sdks_js_1.ClientSDK {
|
|
15
|
+
}
|
|
16
|
+
exports.SyllableSDKCore = SyllableSDKCore;
|
|
17
|
+
//# sourceMappingURL=core.js.map
|
package/core.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"core.js","sourceRoot":"","sources":["src/core.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAA0C;AAE1C;;;;;GAKG;AACH,MAAa,eAAgB,SAAQ,mBAAS;CAAG;AAAjD,0CAAiD"}
|