syllable-sdk 0.1.0-alpha.6 → 0.1.0-alpha.61
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/devcontainer.json +45 -0
- package/FUNCTIONS.md +114 -0
- package/README.md +217 -84
- package/RUNTIMES.md +48 -0
- package/api-reference/openapi.json +4398 -0
- package/api-reference/sdks/agents/README.md +224 -0
- package/api-reference/sdks/availabletargets/README.md +49 -0
- package/api-reference/sdks/channels/README.md +92 -0
- package/api-reference/sdks/chats/README.md +55 -0
- package/api-reference/sdks/conversations/README.md +91 -0
- package/api-reference/sdks/dashboards/README.md +321 -0
- package/api-reference/sdks/events/README.md +50 -0
- package/api-reference/sdks/greetings/README.md +223 -0
- package/api-reference/sdks/organizations/README.md +48 -0
- package/api-reference/sdks/prompts/README.md +225 -0
- package/api-reference/sdks/sessions/README.md +50 -0
- package/api-reference/sdks/syllable/README.md +22 -0
- package/api-reference/sdks/targets/README.md +194 -0
- package/api-reference/sdks/tools/README.md +92 -0
- package/docs/openapi.json +1 -0
- package/docs/sdks/agents/README.md +159 -23
- package/docs/sdks/channels/README.md +25 -5
- package/docs/sdks/conversations/README.md +23 -3
- package/docs/sdks/custommessages/README.md +193 -15
- package/docs/sdks/dashboards/README.md +105 -193
- package/docs/sdks/datasources/README.md +449 -0
- package/docs/sdks/events/README.md +23 -3
- package/docs/sdks/fullsummary/README.md +85 -0
- package/docs/sdks/insights/README.md +6 -0
- package/docs/sdks/languagegroups/README.md +485 -0
- package/docs/sdks/prompts/README.md +30 -20
- package/docs/sdks/services/README.md +189 -11
- package/docs/sdks/sessiondebug/README.md +245 -0
- package/docs/sdks/sessionlabels/README.md +34 -6
- package/docs/sdks/sessions/README.md +23 -3
- package/docs/sdks/summary/README.md +85 -0
- package/docs/sdks/syllablesdk/README.md +7 -4
- package/docs/sdks/syllablesdktools/README.md +431 -0
- package/docs/sdks/targets/README.md +63 -33
- package/docs/sdks/test/README.md +1 -1
- package/docs/sdks/tools/README.md +186 -18
- package/docs/sdks/transcript/README.md +0 -2
- package/docs/sdks/v1/README.md +497 -0
- package/docs/sdks/workflows/README.md +449 -0
- package/funcs/agentsAgentGetAvailableVoices.d.ts +15 -0
- package/funcs/agentsAgentGetAvailableVoices.d.ts.map +1 -0
- package/funcs/{dashboardsGetSessionAgents.js → agentsAgentGetAvailableVoices.js} +18 -14
- package/funcs/agentsAgentGetAvailableVoices.js.map +1 -0
- package/funcs/agentsCreate.d.ts +1 -1
- package/funcs/agentsCreate.d.ts.map +1 -1
- package/funcs/agentsCreate.js +10 -7
- package/funcs/agentsCreate.js.map +1 -1
- package/funcs/agentsDelete.d.ts.map +1 -1
- package/funcs/agentsDelete.js +10 -7
- 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 +9 -6
- 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 +9 -6
- package/funcs/agentsList.js.map +1 -1
- package/funcs/agentsTestSendTestMessage.d.ts.map +1 -1
- package/funcs/agentsTestSendTestMessage.js +9 -6
- package/funcs/agentsTestSendTestMessage.js.map +1 -1
- package/funcs/agentsUpdate.d.ts +1 -1
- package/funcs/agentsUpdate.d.ts.map +1 -1
- package/funcs/agentsUpdate.js +11 -8
- package/funcs/agentsUpdate.js.map +1 -1
- package/funcs/channelsDelete.d.ts +4 -2
- package/funcs/channelsDelete.d.ts.map +1 -1
- package/funcs/channelsDelete.js +13 -7
- package/funcs/channelsDelete.js.map +1 -1
- package/funcs/channelsList.d.ts.map +1 -1
- package/funcs/channelsList.js +9 -6
- package/funcs/channelsList.js.map +1 -1
- package/funcs/channelsTargetsAvailableTargets.d.ts.map +1 -1
- package/funcs/channelsTargetsAvailableTargets.js +9 -6
- package/funcs/channelsTargetsAvailableTargets.js.map +1 -1
- package/funcs/channelsTargetsCreate.d.ts +1 -1
- package/funcs/channelsTargetsCreate.d.ts.map +1 -1
- package/funcs/channelsTargetsCreate.js +9 -6
- package/funcs/channelsTargetsCreate.js.map +1 -1
- package/funcs/channelsTargetsGetById.d.ts +1 -1
- package/funcs/channelsTargetsGetById.d.ts.map +1 -1
- package/funcs/channelsTargetsGetById.js +9 -6
- package/funcs/channelsTargetsGetById.js.map +1 -1
- package/funcs/channelsTargetsList.d.ts +1 -1
- package/funcs/channelsTargetsList.d.ts.map +1 -1
- package/funcs/channelsTargetsList.js +9 -6
- package/funcs/channelsTargetsList.js.map +1 -1
- package/funcs/channelsTargetsUpdate.d.ts +1 -1
- package/funcs/channelsTargetsUpdate.d.ts.map +1 -1
- package/funcs/channelsTargetsUpdate.js +12 -7
- package/funcs/channelsTargetsUpdate.js.map +1 -1
- package/funcs/conversationsList.d.ts.map +1 -1
- package/funcs/conversationsList.js +9 -6
- package/funcs/conversationsList.js.map +1 -1
- package/funcs/customMessagesCreate.d.ts +2 -2
- package/funcs/customMessagesCreate.d.ts.map +1 -1
- package/funcs/customMessagesCreate.js +11 -8
- package/funcs/customMessagesCreate.js.map +1 -1
- package/funcs/customMessagesDelete.d.ts +1 -1
- package/funcs/customMessagesDelete.d.ts.map +1 -1
- package/funcs/customMessagesDelete.js +10 -7
- package/funcs/customMessagesDelete.js.map +1 -1
- package/funcs/customMessagesGetById.d.ts +2 -2
- package/funcs/customMessagesGetById.d.ts.map +1 -1
- package/funcs/customMessagesGetById.js +10 -7
- 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 +9 -6
- package/funcs/customMessagesList.js.map +1 -1
- package/funcs/customMessagesUpdate.d.ts +2 -2
- package/funcs/customMessagesUpdate.d.ts.map +1 -1
- package/funcs/customMessagesUpdate.js +11 -8
- package/funcs/customMessagesUpdate.js.map +1 -1
- package/funcs/dashboardsPostGetDashboard.d.ts +20 -0
- package/funcs/dashboardsPostGetDashboard.d.ts.map +1 -0
- package/funcs/dashboardsPostGetDashboard.js +109 -0
- package/funcs/dashboardsPostGetDashboard.js.map +1 -0
- package/funcs/dashboardsPostListDashboard.d.ts +20 -0
- package/funcs/dashboardsPostListDashboard.d.ts.map +1 -0
- package/funcs/dashboardsPostListDashboard.js +117 -0
- package/funcs/dashboardsPostListDashboard.js.map +1 -0
- package/funcs/dashboardsPostSessionEventsDashboard.d.ts +21 -0
- package/funcs/dashboardsPostSessionEventsDashboard.d.ts.map +1 -0
- package/funcs/dashboardsPostSessionEventsDashboard.js +94 -0
- package/funcs/dashboardsPostSessionEventsDashboard.js.map +1 -0
- package/funcs/dashboardsPostSessionSummaryDashboard.d.ts +21 -0
- package/funcs/dashboardsPostSessionSummaryDashboard.d.ts.map +1 -0
- package/funcs/dashboardsPostSessionSummaryDashboard.js +94 -0
- package/funcs/dashboardsPostSessionSummaryDashboard.js.map +1 -0
- package/funcs/dashboardsPostSessionTransfersDashboard.d.ts +21 -0
- package/funcs/dashboardsPostSessionTransfersDashboard.d.ts.map +1 -0
- package/funcs/dashboardsPostSessionTransfersDashboard.js +94 -0
- package/funcs/dashboardsPostSessionTransfersDashboard.js.map +1 -0
- package/funcs/dashboardsPostSessionsDashboard.d.ts +21 -0
- package/funcs/dashboardsPostSessionsDashboard.d.ts.map +1 -0
- package/funcs/{dashboardsGetDailyCallVolumeByHour.js → dashboardsPostSessionsDashboard.js} +24 -16
- package/funcs/dashboardsPostSessionsDashboard.js.map +1 -0
- package/funcs/dataSourcesCreate.d.ts +16 -0
- package/funcs/dataSourcesCreate.d.ts.map +1 -0
- package/funcs/dataSourcesCreate.js +102 -0
- package/funcs/dataSourcesCreate.js.map +1 -0
- package/funcs/{dashboardsGetSessionSummary.d.ts → dataSourcesDelete.d.ts} +4 -4
- package/funcs/dataSourcesDelete.d.ts.map +1 -0
- package/funcs/{dashboardsGetSessionSummary.js → dataSourcesDelete.js} +26 -21
- package/funcs/dataSourcesDelete.js.map +1 -0
- package/funcs/dataSourcesGetById.d.ts +17 -0
- package/funcs/dataSourcesGetById.d.ts.map +1 -0
- package/funcs/dataSourcesGetById.js +108 -0
- package/funcs/dataSourcesGetById.js.map +1 -0
- package/funcs/dataSourcesList.d.ts +17 -0
- package/funcs/dataSourcesList.d.ts.map +1 -0
- package/funcs/dataSourcesList.js +114 -0
- package/funcs/dataSourcesList.js.map +1 -0
- package/funcs/dataSourcesUpdate.d.ts +16 -0
- package/funcs/dataSourcesUpdate.d.ts.map +1 -0
- package/funcs/dataSourcesUpdate.js +102 -0
- package/funcs/dataSourcesUpdate.js.map +1 -0
- package/funcs/eventsList.d.ts.map +1 -1
- package/funcs/eventsList.js +9 -6
- package/funcs/eventsList.js.map +1 -1
- package/funcs/insightsToolsCreate.d.ts +16 -0
- package/funcs/insightsToolsCreate.d.ts.map +1 -0
- package/funcs/insightsToolsCreate.js +102 -0
- package/funcs/insightsToolsCreate.js.map +1 -0
- package/funcs/insightsToolsGetById.d.ts +17 -0
- package/funcs/insightsToolsGetById.d.ts.map +1 -0
- package/funcs/insightsToolsGetById.js +108 -0
- package/funcs/insightsToolsGetById.js.map +1 -0
- package/funcs/{dashboardsGetSessionAgents.d.ts → insightsToolsInsightToolGetDefinitions.d.ts} +5 -5
- package/funcs/insightsToolsInsightToolGetDefinitions.d.ts.map +1 -0
- package/funcs/{dashboardsGetMonthlyCallVolumeByDay.js → insightsToolsInsightToolGetDefinitions.js} +18 -15
- package/funcs/insightsToolsInsightToolGetDefinitions.js.map +1 -0
- package/funcs/insightsToolsList.d.ts +17 -0
- package/funcs/insightsToolsList.d.ts.map +1 -0
- package/funcs/insightsToolsList.js +114 -0
- package/funcs/insightsToolsList.js.map +1 -0
- package/funcs/insightsToolsUpdate.d.ts +17 -0
- package/funcs/insightsToolsUpdate.d.ts.map +1 -0
- package/funcs/insightsToolsUpdate.js +109 -0
- package/funcs/insightsToolsUpdate.js.map +1 -0
- package/funcs/insightsWorkflowsCreate.d.ts +16 -0
- package/funcs/insightsWorkflowsCreate.d.ts.map +1 -0
- package/funcs/insightsWorkflowsCreate.js +102 -0
- package/funcs/insightsWorkflowsCreate.js.map +1 -0
- package/funcs/insightsWorkflowsDelete.d.ts +16 -0
- package/funcs/insightsWorkflowsDelete.d.ts.map +1 -0
- package/funcs/insightsWorkflowsDelete.js +108 -0
- package/funcs/insightsWorkflowsDelete.js.map +1 -0
- package/funcs/insightsWorkflowsGetById.d.ts +17 -0
- package/funcs/insightsWorkflowsGetById.d.ts.map +1 -0
- package/funcs/insightsWorkflowsGetById.js +108 -0
- package/funcs/insightsWorkflowsGetById.js.map +1 -0
- package/funcs/insightsWorkflowsList.d.ts +17 -0
- package/funcs/insightsWorkflowsList.d.ts.map +1 -0
- package/funcs/insightsWorkflowsList.js +114 -0
- package/funcs/insightsWorkflowsList.js.map +1 -0
- package/funcs/insightsWorkflowsUpdate.d.ts +17 -0
- package/funcs/insightsWorkflowsUpdate.d.ts.map +1 -0
- package/funcs/insightsWorkflowsUpdate.js +111 -0
- package/funcs/insightsWorkflowsUpdate.js.map +1 -0
- package/funcs/languageGroupsCreate.d.ts +16 -0
- package/funcs/languageGroupsCreate.d.ts.map +1 -0
- package/funcs/languageGroupsCreate.js +102 -0
- package/funcs/languageGroupsCreate.js.map +1 -0
- package/funcs/{dashboardsGetDailyCallVolumeByHour.d.ts → languageGroupsDelete.d.ts} +5 -4
- package/funcs/languageGroupsDelete.d.ts.map +1 -0
- package/funcs/languageGroupsDelete.js +109 -0
- package/funcs/languageGroupsDelete.js.map +1 -0
- package/funcs/languageGroupsGetById.d.ts +17 -0
- package/funcs/languageGroupsGetById.d.ts.map +1 -0
- package/funcs/languageGroupsGetById.js +105 -0
- package/funcs/languageGroupsGetById.js.map +1 -0
- package/funcs/languageGroupsList.d.ts +17 -0
- package/funcs/languageGroupsList.d.ts.map +1 -0
- package/funcs/languageGroupsList.js +114 -0
- package/funcs/languageGroupsList.js.map +1 -0
- package/funcs/languageGroupsUpdate.d.ts +16 -0
- package/funcs/languageGroupsUpdate.d.ts.map +1 -0
- package/funcs/languageGroupsUpdate.js +102 -0
- package/funcs/languageGroupsUpdate.js.map +1 -0
- package/funcs/promptsCreate.d.ts +1 -1
- package/funcs/promptsCreate.d.ts.map +1 -1
- package/funcs/promptsCreate.js +10 -7
- package/funcs/promptsCreate.js.map +1 -1
- package/funcs/promptsDelete.d.ts +3 -0
- package/funcs/promptsDelete.d.ts.map +1 -1
- package/funcs/promptsDelete.js +12 -6
- package/funcs/promptsDelete.js.map +1 -1
- package/funcs/promptsGetById.d.ts +1 -1
- package/funcs/promptsGetById.d.ts.map +1 -1
- package/funcs/promptsGetById.js +9 -6
- package/funcs/promptsGetById.js.map +1 -1
- package/funcs/promptsList.d.ts +1 -1
- package/funcs/promptsList.d.ts.map +1 -1
- package/funcs/promptsList.js +9 -6
- package/funcs/promptsList.js.map +1 -1
- package/funcs/promptsPromptsHistory.d.ts.map +1 -1
- package/funcs/promptsPromptsHistory.js +9 -6
- package/funcs/promptsPromptsHistory.js.map +1 -1
- package/funcs/promptsUpdate.d.ts +1 -1
- package/funcs/promptsUpdate.d.ts.map +1 -1
- package/funcs/promptsUpdate.js +10 -7
- package/funcs/promptsUpdate.js.map +1 -1
- package/funcs/servicesCreate.d.ts +4 -1
- package/funcs/servicesCreate.d.ts.map +1 -1
- package/funcs/servicesCreate.js +13 -7
- package/funcs/servicesCreate.js.map +1 -1
- package/funcs/{dashboardsGetMonthlyCallVolumeByDay.d.ts → servicesDelete.d.ts} +5 -4
- package/funcs/servicesDelete.d.ts.map +1 -0
- package/funcs/servicesDelete.js +112 -0
- package/funcs/servicesDelete.js.map +1 -0
- package/funcs/servicesGetById.d.ts +17 -0
- package/funcs/servicesGetById.d.ts.map +1 -0
- package/funcs/servicesGetById.js +108 -0
- package/funcs/servicesGetById.js.map +1 -0
- package/funcs/servicesList.d.ts +2 -2
- package/funcs/servicesList.d.ts.map +1 -1
- package/funcs/servicesList.js +10 -7
- package/funcs/servicesList.js.map +1 -1
- package/funcs/servicesUpdate.d.ts +4 -1
- package/funcs/servicesUpdate.d.ts.map +1 -1
- package/funcs/servicesUpdate.js +13 -7
- package/funcs/servicesUpdate.js.map +1 -1
- package/funcs/sessionDebugGetSessionDataBySessionId.d.ts +14 -0
- package/funcs/sessionDebugGetSessionDataBySessionId.d.ts.map +1 -0
- package/funcs/sessionDebugGetSessionDataBySessionId.js +105 -0
- package/funcs/sessionDebugGetSessionDataBySessionId.js.map +1 -0
- package/funcs/sessionDebugGetSessionDataBySid.d.ts +14 -0
- package/funcs/sessionDebugGetSessionDataBySid.d.ts.map +1 -0
- package/funcs/sessionDebugGetSessionDataBySid.js +103 -0
- package/funcs/sessionDebugGetSessionDataBySid.js.map +1 -0
- package/funcs/sessionDebugGetSessionToolCallResultById.d.ts +14 -0
- package/funcs/sessionDebugGetSessionToolCallResultById.d.ts.map +1 -0
- package/funcs/sessionDebugGetSessionToolCallResultById.js +109 -0
- package/funcs/sessionDebugGetSessionToolCallResultById.js.map +1 -0
- package/funcs/sessionLabelsCreate.d.ts.map +1 -1
- package/funcs/sessionLabelsCreate.js +9 -6
- package/funcs/sessionLabelsCreate.js.map +1 -1
- package/funcs/sessionLabelsGetById.d.ts.map +1 -1
- package/funcs/sessionLabelsGetById.js +9 -6
- package/funcs/sessionLabelsGetById.js.map +1 -1
- package/funcs/sessionLabelsList.d.ts.map +1 -1
- package/funcs/sessionLabelsList.js +9 -6
- package/funcs/sessionLabelsList.js.map +1 -1
- package/funcs/sessionsFullSummaryGetById.d.ts +14 -0
- package/funcs/sessionsFullSummaryGetById.d.ts.map +1 -0
- package/funcs/sessionsFullSummaryGetById.js +105 -0
- package/funcs/sessionsFullSummaryGetById.js.map +1 -0
- package/funcs/sessionsGenerateSessionRecordingUrls.d.ts.map +1 -1
- package/funcs/sessionsGenerateSessionRecordingUrls.js +9 -6
- package/funcs/sessionsGenerateSessionRecordingUrls.js.map +1 -1
- package/funcs/sessionsGetById.d.ts.map +1 -1
- package/funcs/sessionsGetById.js +9 -6
- package/funcs/sessionsGetById.js.map +1 -1
- package/funcs/sessionsList.d.ts.map +1 -1
- package/funcs/sessionsList.js +9 -6
- package/funcs/sessionsList.js.map +1 -1
- package/funcs/sessionsSessionRecordingStream.d.ts.map +1 -1
- package/funcs/sessionsSessionRecordingStream.js +9 -6
- package/funcs/sessionsSessionRecordingStream.js.map +1 -1
- package/funcs/{dashboardsGetMonthlyCallVolumeByWeek.d.ts → sessionsSummaryGetById.d.ts} +4 -6
- package/funcs/sessionsSummaryGetById.d.ts.map +1 -0
- package/funcs/sessionsSummaryGetById.js +105 -0
- package/funcs/sessionsSummaryGetById.js.map +1 -0
- package/funcs/sessionsTranscriptGetById.d.ts.map +1 -1
- package/funcs/sessionsTranscriptGetById.js +9 -6
- package/funcs/sessionsTranscriptGetById.js.map +1 -1
- package/funcs/toolsCreate.d.ts +1 -1
- package/funcs/toolsCreate.d.ts.map +1 -1
- package/funcs/toolsCreate.js +10 -7
- package/funcs/toolsCreate.js.map +1 -1
- package/funcs/{dashboardsGetTotalCallVolumeByHour.d.ts → toolsDelete.d.ts} +5 -4
- package/funcs/toolsDelete.d.ts.map +1 -0
- package/funcs/toolsDelete.js +112 -0
- package/funcs/toolsDelete.js.map +1 -0
- package/funcs/toolsGetByName.d.ts.map +1 -1
- package/funcs/toolsGetByName.js +9 -6
- package/funcs/toolsGetByName.js.map +1 -1
- package/funcs/toolsList.d.ts +1 -1
- package/funcs/toolsList.d.ts.map +1 -1
- package/funcs/toolsList.js +9 -6
- package/funcs/toolsList.js.map +1 -1
- package/funcs/toolsUpdate.d.ts +1 -1
- package/funcs/toolsUpdate.d.ts.map +1 -1
- package/funcs/toolsUpdate.js +10 -7
- package/funcs/toolsUpdate.js.map +1 -1
- package/funcs/v1PostGetDashboard.d.ts +20 -0
- package/funcs/v1PostGetDashboard.d.ts.map +1 -0
- package/funcs/v1PostGetDashboard.js +109 -0
- package/funcs/v1PostGetDashboard.js.map +1 -0
- package/funcs/v1PostListDashboard.d.ts +20 -0
- package/funcs/v1PostListDashboard.d.ts.map +1 -0
- package/funcs/v1PostListDashboard.js +117 -0
- package/funcs/v1PostListDashboard.js.map +1 -0
- package/funcs/v1PostSessionEventsDashboard.d.ts +21 -0
- package/funcs/v1PostSessionEventsDashboard.d.ts.map +1 -0
- package/funcs/v1PostSessionEventsDashboard.js +94 -0
- package/funcs/v1PostSessionEventsDashboard.js.map +1 -0
- package/funcs/v1PostSessionSummaryDashboard.d.ts +21 -0
- package/funcs/v1PostSessionSummaryDashboard.d.ts.map +1 -0
- package/funcs/v1PostSessionSummaryDashboard.js +94 -0
- package/funcs/v1PostSessionSummaryDashboard.js.map +1 -0
- package/funcs/v1PostSessionTransfersDashboard.d.ts +21 -0
- package/funcs/v1PostSessionTransfersDashboard.d.ts.map +1 -0
- package/funcs/v1PostSessionTransfersDashboard.js +94 -0
- package/funcs/v1PostSessionTransfersDashboard.js.map +1 -0
- package/funcs/v1PostSessionsDashboard.d.ts +21 -0
- package/funcs/v1PostSessionsDashboard.d.ts.map +1 -0
- package/funcs/{dashboardsGetMonthlyCallVolumeByWeek.js → v1PostSessionsDashboard.js} +24 -16
- package/funcs/v1PostSessionsDashboard.js.map +1 -0
- package/hooks/hooks.d.ts.map +1 -1
- package/hooks/hooks.js +20 -0
- package/hooks/hooks.js.map +1 -1
- package/hooks/types.d.ts +2 -0
- package/hooks/types.d.ts.map +1 -1
- package/jsr.json +27 -0
- package/lib/config.d.ts +4 -4
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +6 -11
- package/lib/config.js.map +1 -1
- package/lib/encodings.d.ts +10 -9
- package/lib/encodings.d.ts.map +1 -1
- package/lib/encodings.js +91 -66
- package/lib/encodings.js.map +1 -1
- package/lib/env.js +1 -2
- package/lib/env.js.map +1 -1
- package/lib/http.js +1 -2
- package/lib/http.js.map +1 -1
- package/lib/matchers.js +5 -6
- package/lib/matchers.js.map +1 -1
- package/lib/primitives.d.ts +3 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +64 -1
- package/lib/primitives.js.map +1 -1
- package/lib/retries.js +3 -5
- package/lib/retries.js.map +1 -1
- package/lib/schemas.d.ts +1 -1
- package/lib/schemas.d.ts.map +1 -1
- package/lib/schemas.js +4 -1
- package/lib/schemas.js.map +1 -1
- package/lib/sdks.d.ts +5 -1
- package/lib/sdks.d.ts.map +1 -1
- package/lib/sdks.js +20 -17
- package/lib/sdks.js.map +1 -1
- package/lib/security.d.ts.map +1 -1
- package/lib/security.js +2 -3
- package/lib/security.js.map +1 -1
- package/lib/url.js +1 -1
- package/lib/url.js.map +1 -1
- package/mintlify/mint-backup.json +290 -0
- package/mintlify/mint.json +623 -0
- package/mintlify/scripts/create-md-script.js +46 -0
- package/mintlify/scripts/generate-mintlify-sdk-docs.js +117 -0
- package/models/components/agentcreate.d.ts +77 -33
- package/models/components/agentcreate.d.ts.map +1 -1
- package/models/components/agentcreate.js +33 -36
- package/models/components/agentcreate.js.map +1 -1
- package/models/components/agentlanguage.d.ts +41 -0
- package/models/components/agentlanguage.d.ts.map +1 -0
- package/models/components/{custommessage.js → agentlanguage.js} +20 -23
- package/models/components/agentlanguage.js.map +1 -0
- package/models/components/agentproperties.d.ts +21 -0
- package/models/components/agentproperties.d.ts.map +1 -1
- package/models/components/agentproperties.js +7 -0
- package/models/components/agentproperties.js.map +1 -1
- package/models/components/agentresponse.d.ts +166 -0
- package/models/components/agentresponse.d.ts.map +1 -0
- package/models/components/agentresponse.js +142 -0
- package/models/components/agentresponse.js.map +1 -0
- package/models/components/agentsttprovider.d.ts +37 -0
- package/models/components/agentsttprovider.d.ts.map +1 -0
- package/models/components/agentsttprovider.js +54 -0
- package/models/components/agentsttprovider.js.map +1 -0
- package/models/components/agenttooldefaults.d.ts +9 -0
- package/models/components/agenttooldefaults.d.ts.map +1 -1
- package/models/components/agenttooldefaults.js.map +1 -1
- package/models/components/agenttoolfielddefault.d.ts +9 -0
- package/models/components/agenttoolfielddefault.d.ts.map +1 -1
- package/models/components/agenttoolfielddefault.js.map +1 -1
- package/models/components/agentupdate.d.ts +120 -0
- package/models/components/agentupdate.d.ts.map +1 -0
- package/models/components/{agent.js → agentupdate.js} +49 -51
- package/models/components/agentupdate.js.map +1 -0
- package/models/components/agentvoice.d.ts +71 -0
- package/models/components/agentvoice.d.ts.map +1 -0
- package/models/components/agentvoice.js +90 -0
- package/models/components/agentvoice.js.map +1 -0
- package/models/components/agentvoicedisplayname.d.ts +142 -0
- package/models/components/agentvoicedisplayname.d.ts.map +1 -0
- package/models/components/agentvoicedisplayname.js +89 -0
- package/models/components/agentvoicedisplayname.js.map +1 -0
- package/models/components/agentvoicegender.d.ts +34 -0
- package/models/components/agentvoicegender.d.ts.map +1 -0
- package/models/components/agentvoicegender.js +53 -0
- package/models/components/agentvoicegender.js.map +1 -0
- package/models/components/agentvoicemodel.d.ts +46 -0
- package/models/components/agentvoicemodel.d.ts.map +1 -0
- package/models/components/agentvoicemodel.js +57 -0
- package/models/components/agentvoicemodel.js.map +1 -0
- package/models/components/agentvoicevarname.d.ts +142 -0
- package/models/components/agentvoicevarname.d.ts.map +1 -0
- package/models/components/agentvoicevarname.js +89 -0
- package/models/components/agentvoicevarname.js.map +1 -0
- package/models/components/agentwaitsound.d.ts +40 -0
- package/models/components/agentwaitsound.d.ts.map +1 -0
- package/models/components/agentwaitsound.js +55 -0
- package/models/components/agentwaitsound.js.map +1 -0
- package/models/components/channel.d.ts +2 -2
- package/models/components/channelservices.d.ts +6 -0
- package/models/components/channelservices.d.ts.map +1 -1
- package/models/components/channelservices.js +3 -0
- package/models/components/channelservices.js.map +1 -1
- package/models/components/channeltargetcreaterequest.d.ts +31 -12
- package/models/components/channeltargetcreaterequest.d.ts.map +1 -1
- package/models/components/channeltargetcreaterequest.js +15 -14
- package/models/components/channeltargetcreaterequest.js.map +1 -1
- package/models/components/channeltargetproperties.d.ts +3 -0
- package/models/components/channeltargetproperties.d.ts.map +1 -1
- package/models/components/channeltargetproperties.js +1 -0
- package/models/components/channeltargetproperties.js.map +1 -1
- package/models/components/channeltargetresponse.d.ts +91 -0
- package/models/components/channeltargetresponse.d.ts.map +1 -0
- package/models/components/channeltargetresponse.js +104 -0
- package/models/components/channeltargetresponse.js.map +1 -0
- package/models/components/channeltargetupdaterequest.d.ts +63 -0
- package/models/components/channeltargetupdaterequest.d.ts.map +1 -0
- package/models/components/{channeltarget.js → channeltargetupdaterequest.js} +32 -35
- package/models/components/channeltargetupdaterequest.js.map +1 -0
- package/models/components/conversation.d.ts +42 -0
- package/models/components/conversation.d.ts.map +1 -1
- package/models/components/conversation.js.map +1 -1
- package/models/components/custommessagecreaterequest.d.ts +50 -0
- package/models/components/custommessagecreaterequest.d.ts.map +1 -0
- package/models/components/custommessagecreaterequest.js +68 -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 +79 -0
- package/models/components/custommessageresponse.d.ts.map +1 -0
- package/models/components/custommessageresponse.js +89 -0
- package/models/components/custommessageresponse.js.map +1 -0
- package/models/components/custommessagerule.d.ts +63 -0
- package/models/components/custommessagerule.d.ts.map +1 -0
- package/models/components/custommessagerule.js +85 -0
- package/models/components/custommessagerule.js.map +1 -0
- package/models/components/custommessageupdaterequest.d.ts +55 -0
- package/models/components/custommessageupdaterequest.d.ts.map +1 -0
- package/models/components/custommessageupdaterequest.js +70 -0
- package/models/components/custommessageupdaterequest.js.map +1 -0
- package/models/components/dashboard.d.ts +53 -0
- package/models/components/dashboard.d.ts.map +1 -0
- package/models/components/{promptcreate.js → dashboard.js} +29 -28
- package/models/components/dashboard.js.map +1 -0
- package/models/components/dashboardproperties.d.ts +37 -0
- package/models/components/dashboardproperties.d.ts.map +1 -0
- package/models/components/dashboardproperties.js +53 -0
- package/models/components/dashboardproperties.js.map +1 -0
- package/models/components/dashboardresponse.d.ts +50 -0
- package/models/components/dashboardresponse.d.ts.map +1 -0
- package/models/components/dashboardresponse.js +74 -0
- package/models/components/dashboardresponse.js.map +1 -0
- package/models/components/dashboardtokenresponse.d.ts +65 -0
- package/models/components/dashboardtokenresponse.d.ts.map +1 -0
- package/models/components/dashboardtokenresponse.js +86 -0
- package/models/components/dashboardtokenresponse.js.map +1 -0
- package/models/components/datasourcecreaterequest.d.ts +57 -0
- package/models/components/datasourcecreaterequest.d.ts.map +1 -0
- package/models/components/datasourcecreaterequest.js +78 -0
- package/models/components/datasourcecreaterequest.js.map +1 -0
- package/models/components/datasourcedetailresponse.d.ts +85 -0
- package/models/components/datasourcedetailresponse.d.ts.map +1 -0
- package/models/components/datasourcedetailresponse.js +92 -0
- package/models/components/datasourcedetailresponse.js.map +1 -0
- package/models/components/datasourcemetadataresponse.d.ts +80 -0
- package/models/components/datasourcemetadataresponse.d.ts.map +1 -0
- package/models/components/datasourcemetadataresponse.js +90 -0
- package/models/components/datasourcemetadataresponse.js.map +1 -0
- package/models/components/datasourceproperties.d.ts +43 -0
- package/models/components/datasourceproperties.d.ts.map +1 -0
- package/models/components/datasourceproperties.js +55 -0
- package/models/components/datasourceproperties.js.map +1 -0
- package/models/components/datasourceupdaterequest.d.ts +67 -0
- package/models/components/datasourceupdaterequest.d.ts.map +1 -0
- package/models/components/datasourceupdaterequest.js +84 -0
- package/models/components/datasourceupdaterequest.js.map +1 -0
- package/models/components/dayofweek.d.ts +43 -0
- package/models/components/dayofweek.d.ts.map +1 -0
- package/models/components/dayofweek.js +56 -0
- package/models/components/dayofweek.js.map +1 -0
- package/models/components/dialogmessage.d.ts +29 -0
- package/models/components/dialogmessage.d.ts.map +1 -0
- package/models/components/dialogmessage.js +59 -0
- package/models/components/dialogmessage.js.map +1 -0
- package/models/components/dialogrole.d.ts +28 -0
- package/models/components/dialogrole.d.ts.map +1 -0
- package/models/components/dialogrole.js +51 -0
- package/models/components/dialogrole.js.map +1 -0
- package/models/components/dialogtoolcall.d.ts +56 -0
- package/models/components/dialogtoolcall.d.ts.map +1 -0
- package/models/components/dialogtoolcall.js +101 -0
- package/models/components/dialogtoolcall.js.map +1 -0
- package/models/components/event.d.ts +33 -0
- package/models/components/event.d.ts.map +1 -1
- package/models/components/event.js.map +1 -1
- package/models/components/index.d.ts +85 -19
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +85 -19
- package/models/components/index.js.map +1 -1
- package/models/components/insighttooldefinition.d.ts +105 -0
- package/models/components/insighttooldefinition.d.ts.map +1 -0
- package/models/components/insighttooldefinition.js +126 -0
- package/models/components/insighttooldefinition.js.map +1 -0
- package/models/components/insighttoolinput.d.ts +76 -0
- package/models/components/insighttoolinput.d.ts.map +1 -0
- package/models/components/insighttoolinput.js +101 -0
- package/models/components/insighttoolinput.js.map +1 -0
- package/models/components/insighttooloutput.d.ts +102 -0
- package/models/components/insighttooloutput.d.ts.map +1 -0
- package/models/components/insighttooloutput.js +124 -0
- package/models/components/insighttooloutput.js.map +1 -0
- package/models/components/insighttoolproperties.d.ts +40 -0
- package/models/components/insighttoolproperties.d.ts.map +1 -0
- package/models/components/insighttoolproperties.js +54 -0
- package/models/components/insighttoolproperties.js.map +1 -0
- package/models/components/insightworkflowinput.d.ts +76 -0
- package/models/components/insightworkflowinput.d.ts.map +1 -0
- package/models/components/insightworkflowinput.js +99 -0
- package/models/components/insightworkflowinput.js.map +1 -0
- package/models/components/insightworkflowoutput.d.ts +102 -0
- package/models/components/insightworkflowoutput.d.ts.map +1 -0
- package/models/components/insightworkflowoutput.js +120 -0
- package/models/components/insightworkflowoutput.js.map +1 -0
- package/models/components/insightworkflowproperties.d.ts +43 -0
- package/models/components/insightworkflowproperties.d.ts.map +1 -0
- package/models/components/insightworkflowproperties.js +55 -0
- package/models/components/insightworkflowproperties.js.map +1 -0
- package/models/components/internaltool.d.ts +46 -0
- package/models/components/internaltool.d.ts.map +1 -0
- package/models/components/internaltool.js +62 -0
- package/models/components/internaltool.js.map +1 -0
- package/models/components/languagecode.d.ts +49 -0
- package/models/components/languagecode.d.ts.map +1 -0
- package/models/components/languagecode.js +58 -0
- package/models/components/languagecode.js.map +1 -0
- package/models/components/languageconfig.d.ts +56 -0
- package/models/components/languageconfig.d.ts.map +1 -0
- package/models/components/languageconfig.js +83 -0
- package/models/components/languageconfig.js.map +1 -0
- package/models/components/languagegroupagentinfo.d.ts +40 -0
- package/models/components/languagegroupagentinfo.d.ts.map +1 -0
- package/models/components/{custommessagecreate.js → languagegroupagentinfo.js} +19 -21
- package/models/components/languagegroupagentinfo.js.map +1 -0
- package/models/components/languagegroupcreaterequest.d.ts +48 -0
- package/models/components/languagegroupcreaterequest.d.ts.map +1 -0
- package/models/components/languagegroupcreaterequest.js +77 -0
- package/models/components/languagegroupcreaterequest.js.map +1 -0
- package/models/components/languagegroupproperties.d.ts +37 -0
- package/models/components/languagegroupproperties.d.ts.map +1 -0
- package/models/components/languagegroupproperties.js +53 -0
- package/models/components/languagegroupproperties.js.map +1 -0
- package/models/components/languagegroupresponse.d.ts +81 -0
- package/models/components/languagegroupresponse.d.ts.map +1 -0
- package/models/components/languagegroupresponse.js +98 -0
- package/models/components/languagegroupresponse.js.map +1 -0
- package/models/components/languagegroupupdaterequest.d.ts +58 -0
- package/models/components/languagegroupupdaterequest.d.ts.map +1 -0
- package/models/components/languagegroupupdaterequest.js +83 -0
- package/models/components/languagegroupupdaterequest.js.map +1 -0
- package/models/components/listresponseagentresponse.d.ts +38 -0
- package/models/components/{listresponsechanneltarget.d.ts.map → listresponseagentresponse.d.ts.map} +1 -1
- package/models/components/{listresponsechanneltarget.js → listresponseagentresponse.js} +20 -20
- package/models/components/{listresponsechanneltarget.js.map → listresponseagentresponse.js.map} +1 -1
- package/models/components/listresponsechanneltargetresponse.d.ts +38 -0
- package/models/components/listresponsechanneltargetresponse.d.ts.map +1 -0
- package/models/components/listresponsechanneltargetresponse.js +81 -0
- package/models/components/listresponsechanneltargetresponse.js.map +1 -0
- 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/listresponsedashboardresponse.d.ts +38 -0
- package/models/components/listresponsedashboardresponse.d.ts.map +1 -0
- package/models/components/listresponsedashboardresponse.js +81 -0
- package/models/components/listresponsedashboardresponse.js.map +1 -0
- package/models/components/listresponsedatasourcemetadataresponse.d.ts +38 -0
- package/models/components/listresponsedatasourcemetadataresponse.d.ts.map +1 -0
- package/models/components/listresponsedatasourcemetadataresponse.js +81 -0
- package/models/components/listresponsedatasourcemetadataresponse.js.map +1 -0
- package/models/components/listresponseinsighttooloutput.d.ts +38 -0
- package/models/components/listresponseinsighttooloutput.d.ts.map +1 -0
- package/models/components/{listresponsetool.js → listresponseinsighttooloutput.js} +20 -20
- package/models/components/listresponseinsighttooloutput.js.map +1 -0
- package/models/components/listresponseinsightworkflowoutput.d.ts +38 -0
- package/models/components/listresponseinsightworkflowoutput.d.ts.map +1 -0
- package/models/components/listresponseinsightworkflowoutput.js +81 -0
- package/models/components/listresponseinsightworkflowoutput.js.map +1 -0
- package/models/components/listresponselanguagegroupresponse.d.ts +38 -0
- package/models/components/listresponselanguagegroupresponse.d.ts.map +1 -0
- package/models/components/listresponselanguagegroupresponse.js +81 -0
- package/models/components/listresponselanguagegroupresponse.js.map +1 -0
- package/models/components/listresponsepromptresponse.d.ts +38 -0
- package/models/components/listresponsepromptresponse.d.ts.map +1 -0
- package/models/components/{listresponsecustommessage.js → listresponsepromptresponse.js} +20 -20
- package/models/components/listresponsepromptresponse.js.map +1 -0
- package/models/components/listresponseserviceresponse.d.ts +38 -0
- package/models/components/listresponseserviceresponse.d.ts.map +1 -0
- package/models/components/{listresponseprompt.js → listresponseserviceresponse.js} +20 -20
- package/models/components/listresponseserviceresponse.js.map +1 -0
- package/models/components/listresponsetoolresponse.d.ts +38 -0
- package/models/components/listresponsetoolresponse.d.ts.map +1 -0
- package/models/components/{listresponseagent.js → listresponsetoolresponse.js} +20 -20
- package/models/components/listresponsetoolresponse.js.map +1 -0
- package/models/components/orderbydirection.d.ts +28 -0
- package/models/components/orderbydirection.d.ts.map +1 -0
- package/models/components/orderbydirection.js +50 -0
- package/models/components/orderbydirection.js.map +1 -0
- package/models/components/promptcreaterequest.d.ts +60 -0
- package/models/components/promptcreaterequest.d.ts.map +1 -0
- package/models/components/promptcreaterequest.js +83 -0
- package/models/components/promptcreaterequest.js.map +1 -0
- package/models/components/prompthistory.d.ts +37 -8
- package/models/components/prompthistory.d.ts.map +1 -1
- package/models/components/prompthistory.js +12 -8
- package/models/components/prompthistory.js.map +1 -1
- package/models/components/promptllmconfig.d.ts +48 -0
- package/models/components/promptllmconfig.d.ts.map +1 -0
- package/models/components/{llmconfig.js → promptllmconfig.js} +20 -42
- package/models/components/promptllmconfig.js.map +1 -0
- package/models/components/promptllmprovider.d.ts +37 -0
- package/models/components/promptllmprovider.d.ts.map +1 -0
- package/models/components/promptllmprovider.js +54 -0
- package/models/components/promptllmprovider.js.map +1 -0
- package/models/components/promptproperties.d.ts +12 -0
- package/models/components/promptproperties.d.ts.map +1 -1
- package/models/components/promptproperties.js +4 -0
- package/models/components/promptproperties.js.map +1 -1
- package/models/components/promptresponse.d.ts +96 -0
- package/models/components/promptresponse.d.ts.map +1 -0
- package/models/components/{prompt.js → promptresponse.js} +35 -25
- package/models/components/promptresponse.js.map +1 -0
- package/models/components/promptupdaterequest.d.ts +70 -0
- package/models/components/promptupdaterequest.d.ts.map +1 -0
- package/models/components/promptupdaterequest.js +89 -0
- package/models/components/promptupdaterequest.js.map +1 -0
- package/models/components/servicecreaterequest.d.ts +37 -0
- package/models/components/servicecreaterequest.d.ts.map +1 -0
- package/models/components/servicecreaterequest.js +61 -0
- package/models/components/servicecreaterequest.js.map +1 -0
- package/models/components/serviceproperties.d.ts +9 -0
- package/models/components/serviceproperties.d.ts.map +1 -1
- package/models/components/serviceproperties.js +3 -0
- package/models/components/serviceproperties.js.map +1 -1
- package/models/components/serviceresponse.d.ts +65 -0
- package/models/components/serviceresponse.d.ts.map +1 -0
- package/models/components/serviceresponse.js +84 -0
- package/models/components/serviceresponse.js.map +1 -0
- package/models/components/serviceupdaterequest.d.ts +47 -0
- package/models/components/serviceupdaterequest.d.ts.map +1 -0
- package/models/components/serviceupdaterequest.js +74 -0
- package/models/components/serviceupdaterequest.js.map +1 -0
- package/models/components/session.d.ts +64 -0
- package/models/components/session.d.ts.map +1 -1
- package/models/components/session.js +8 -0
- package/models/components/session.js.map +1 -1
- package/models/components/sessionaction.d.ts +20 -0
- package/models/components/sessionaction.d.ts.map +1 -1
- package/models/components/sessionaction.js +4 -0
- package/models/components/sessionaction.js.map +1 -1
- package/models/components/sessiondata.d.ts +38 -0
- package/models/components/sessiondata.d.ts.map +1 -0
- package/models/components/sessiondata.js +79 -0
- package/models/components/sessiondata.js.map +1 -0
- package/models/components/sessionlabel.d.ts +25 -1
- package/models/components/sessionlabel.d.ts.map +1 -1
- package/models/components/sessionlabel.js.map +1 -1
- package/models/components/sessionlabelcreate.d.ts +18 -0
- package/models/components/sessionlabelcreate.d.ts.map +1 -1
- package/models/components/sessionlabelcreate.js.map +1 -1
- package/models/components/sessionmessage.d.ts +38 -0
- package/models/components/sessionmessage.d.ts.map +1 -0
- package/models/components/sessionmessage.js +77 -0
- package/models/components/sessionmessage.js.map +1 -0
- package/models/components/sessionrecordingresponse.d.ts +9 -2
- package/models/components/sessionrecordingresponse.d.ts.map +1 -1
- package/models/components/sessionrecordingresponse.js +0 -2
- package/models/components/sessionrecordingresponse.js.map +1 -1
- package/models/components/sessionsummaryresponse.d.ts +40 -0
- package/models/components/sessionsummaryresponse.d.ts.map +1 -0
- package/models/components/sessionsummaryresponse.js +61 -0
- package/models/components/sessionsummaryresponse.js.map +1 -0
- package/models/components/sessiontext.d.ts +15 -0
- package/models/components/sessiontext.d.ts.map +1 -1
- package/models/components/sessiontext.js.map +1 -1
- package/models/components/sessiontranscriptionresponse.d.ts +15 -0
- package/models/components/sessiontranscriptionresponse.d.ts.map +1 -1
- package/models/components/sessiontranscriptionresponse.js.map +1 -1
- package/models/components/statictoolparameter.d.ts +56 -0
- package/models/components/statictoolparameter.d.ts.map +1 -0
- package/models/components/statictoolparameter.js +68 -0
- package/models/components/statictoolparameter.js.map +1 -0
- package/models/components/statictoolparametertype.d.ts +40 -0
- package/models/components/statictoolparametertype.d.ts.map +1 -0
- package/models/components/statictoolparametertype.js +55 -0
- package/models/components/statictoolparametertype.js.map +1 -0
- package/models/components/targetmodes.d.ts +40 -0
- package/models/components/targetmodes.d.ts.map +1 -0
- package/models/components/targetmodes.js +56 -0
- package/models/components/targetmodes.js.map +1 -0
- package/models/components/testmessage.d.ts +29 -2
- package/models/components/testmessage.d.ts.map +1 -1
- package/models/components/testmessage.js +10 -2
- package/models/components/testmessage.js.map +1 -1
- package/models/components/testmessageresponse.d.ts +19 -2
- package/models/components/testmessageresponse.d.ts.map +1 -1
- package/models/components/testmessageresponse.js +6 -2
- package/models/components/testmessageresponse.js.map +1 -1
- package/models/components/toolagentinfo.d.ts +40 -0
- package/models/components/toolagentinfo.d.ts.map +1 -0
- package/models/components/{service.js → toolagentinfo.js} +19 -23
- package/models/components/toolagentinfo.js.map +1 -0
- package/models/components/toolargumentlocation.d.ts +52 -0
- package/models/components/toolargumentlocation.d.ts.map +1 -0
- package/models/components/toolargumentlocation.js +61 -0
- package/models/components/toolargumentlocation.js.map +1 -0
- package/models/components/toolcreaterequest.d.ts +43 -0
- package/models/components/toolcreaterequest.d.ts.map +1 -0
- package/models/components/toolcreaterequest.js +73 -0
- package/models/components/toolcreaterequest.js.map +1 -0
- package/models/components/tooldefinition.d.ts +128 -0
- package/models/components/tooldefinition.d.ts.map +1 -0
- package/models/components/tooldefinition.js +128 -0
- package/models/components/tooldefinition.js.map +1 -0
- package/models/components/tooldetailresponse.d.ts +62 -2
- package/models/components/tooldetailresponse.d.ts.map +1 -1
- package/models/components/tooldetailresponse.js +42 -2
- package/models/components/tooldetailresponse.js.map +1 -1
- package/models/components/toolfunction.d.ts +50 -0
- package/models/components/toolfunction.d.ts.map +1 -0
- package/models/components/{servicecreate.js → toolfunction.js} +19 -17
- package/models/components/toolfunction.js.map +1 -0
- package/models/components/toolhttpendpoint.d.ts +53 -0
- package/models/components/toolhttpendpoint.d.ts.map +1 -0
- package/models/components/toolhttpendpoint.js +74 -0
- package/models/components/toolhttpendpoint.js.map +1 -0
- package/models/components/toolhttpmethod.d.ts +34 -0
- package/models/components/toolhttpmethod.d.ts.map +1 -0
- package/models/components/toolhttpmethod.js +53 -0
- package/models/components/toolhttpmethod.js.map +1 -0
- package/models/components/toolparameterdefault.d.ts +42 -0
- package/models/components/toolparameterdefault.d.ts.map +1 -0
- package/models/components/toolparameterdefault.js +60 -0
- package/models/components/toolparameterdefault.js.map +1 -0
- package/models/components/toolparametertransform.d.ts +92 -0
- package/models/components/toolparametertransform.d.ts.map +1 -0
- package/models/components/toolparametertransform.js +90 -0
- package/models/components/toolparametertransform.js.map +1 -0
- package/models/components/toolparametertransformcondition.d.ts +45 -0
- package/models/components/toolparametertransformcondition.d.ts.map +1 -0
- package/models/components/toolparametertransformcondition.js +63 -0
- package/models/components/toolparametertransformcondition.js.map +1 -0
- package/models/components/toolpromptinfo.d.ts +40 -0
- package/models/components/toolpromptinfo.d.ts.map +1 -0
- package/models/components/{serviceupdate.js → toolpromptinfo.js} +19 -21
- package/models/components/toolpromptinfo.js.map +1 -0
- package/models/components/toolproperties.d.ts +6 -0
- package/models/components/toolproperties.d.ts.map +1 -1
- package/models/components/toolproperties.js +2 -0
- package/models/components/toolproperties.js.map +1 -1
- package/models/components/toolresponse.d.ts +88 -0
- package/models/components/toolresponse.d.ts.map +1 -0
- package/models/components/toolresponse.js +101 -0
- package/models/components/toolresponse.js.map +1 -0
- package/models/components/toolresultdata.d.ts +52 -0
- package/models/components/toolresultdata.d.ts.map +1 -0
- package/models/components/toolresultdata.js +95 -0
- package/models/components/toolresultdata.js.map +1 -0
- package/models/components/toolupdaterequest.d.ts +53 -0
- package/models/components/toolupdaterequest.d.ts.map +1 -0
- package/models/components/toolupdaterequest.js +79 -0
- package/models/components/toolupdaterequest.js.map +1 -0
- package/models/components/ttsprovider.d.ts +37 -0
- package/models/components/ttsprovider.d.ts.map +1 -0
- package/models/components/ttsprovider.js +55 -0
- package/models/components/ttsprovider.js.map +1 -0
- package/models/errors/httpclienterrors.js +2 -2
- package/models/errors/httpclienterrors.js.map +1 -1
- package/models/operations/agentlist.d.ts +31 -79
- package/models/operations/agentlist.d.ts.map +1 -1
- package/models/operations/agentlist.js +7 -52
- package/models/operations/agentlist.js.map +1 -1
- package/models/operations/availabletargets.d.ts +31 -58
- package/models/operations/availabletargets.d.ts.map +1 -1
- package/models/operations/availabletargets.js +7 -45
- package/models/operations/availabletargets.js.map +1 -1
- package/models/operations/channelslist.d.ts +31 -61
- package/models/operations/channelslist.d.ts.map +1 -1
- package/models/operations/channelslist.js +7 -45
- package/models/operations/channelslist.js.map +1 -1
- package/models/operations/channeltargetslist.d.ts +31 -73
- package/models/operations/channeltargetslist.d.ts.map +1 -1
- package/models/operations/channeltargetslist.js +7 -50
- package/models/operations/channeltargetslist.js.map +1 -1
- package/models/operations/channeltargetsupdate.d.ts +2 -2
- package/models/operations/channeltargetsupdate.d.ts.map +1 -1
- package/models/operations/channeltargetsupdate.js +4 -4
- package/models/operations/channeltargetsupdate.js.map +1 -1
- package/models/operations/conversationslist.d.ts +31 -79
- package/models/operations/conversationslist.d.ts.map +1 -1
- package/models/operations/conversationslist.js +7 -52
- package/models/operations/conversationslist.js.map +1 -1
- package/models/operations/custommessageslist.d.ts +31 -58
- package/models/operations/custommessageslist.d.ts.map +1 -1
- package/models/operations/custommessageslist.js +7 -45
- package/models/operations/custommessageslist.js.map +1 -1
- package/models/operations/datasourcesdelete.d.ts +31 -0
- package/models/operations/datasourcesdelete.d.ts.map +1 -0
- package/models/operations/datasourcesdelete.js +70 -0
- package/models/operations/datasourcesdelete.js.map +1 -0
- package/models/operations/datasourcesgetbyid.d.ts +29 -0
- package/models/operations/datasourcesgetbyid.d.ts.map +1 -0
- package/models/operations/datasourcesgetbyid.js +68 -0
- package/models/operations/datasourcesgetbyid.js.map +1 -0
- package/models/operations/datasourceslist.d.ts +73 -0
- package/models/operations/datasourceslist.d.ts.map +1 -0
- package/models/operations/datasourceslist.js +103 -0
- package/models/operations/datasourceslist.js.map +1 -0
- package/models/operations/directoryworkflowdelete.d.ts +29 -0
- package/models/operations/directoryworkflowdelete.d.ts.map +1 -0
- package/models/operations/directoryworkflowdelete.js +68 -0
- package/models/operations/directoryworkflowdelete.js.map +1 -0
- package/models/operations/eventslist.d.ts +31 -79
- package/models/operations/eventslist.d.ts.map +1 -1
- package/models/operations/eventslist.js +5 -51
- package/models/operations/eventslist.js.map +1 -1
- package/models/operations/getsessiondatabysessionid.d.ts +29 -0
- package/models/operations/getsessiondatabysessionid.d.ts.map +1 -0
- package/models/operations/getsessiondatabysessionid.js +68 -0
- package/models/operations/getsessiondatabysessionid.js.map +1 -0
- package/models/operations/getsessiondatabysid.d.ts +31 -0
- package/models/operations/getsessiondatabysid.d.ts.map +1 -0
- package/models/operations/getsessiondatabysid.js +72 -0
- package/models/operations/getsessiondatabysid.js.map +1 -0
- package/models/operations/getsessiontoolcallresultbyid.d.ts +31 -0
- package/models/operations/getsessiontoolcallresultbyid.d.ts.map +1 -0
- package/models/operations/getsessiontoolcallresultbyid.js +72 -0
- package/models/operations/getsessiontoolcallresultbyid.js.map +1 -0
- package/models/operations/index.d.ts +23 -8
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +23 -8
- package/models/operations/index.js.map +1 -1
- package/models/operations/insightstoolupdate.d.ts +32 -0
- package/models/operations/insightstoolupdate.d.ts.map +1 -0
- package/models/operations/insightstoolupdate.js +73 -0
- package/models/operations/insightstoolupdate.js.map +1 -0
- package/models/operations/insightsworkflowgetbyid.d.ts +29 -0
- package/models/operations/insightsworkflowgetbyid.d.ts.map +1 -0
- package/models/operations/insightsworkflowgetbyid.js +68 -0
- package/models/operations/insightsworkflowgetbyid.js.map +1 -0
- package/models/operations/insightsworkflowlist.d.ts +73 -0
- package/models/operations/insightsworkflowlist.d.ts.map +1 -0
- package/models/operations/insightsworkflowlist.js +101 -0
- package/models/operations/insightsworkflowlist.js.map +1 -0
- package/models/operations/insightsworkflowupdate.d.ts +32 -0
- package/models/operations/insightsworkflowupdate.d.ts.map +1 -0
- package/models/operations/insightsworkflowupdate.js +73 -0
- package/models/operations/insightsworkflowupdate.js.map +1 -0
- package/models/operations/insighttoolgetbyid.d.ts +29 -0
- package/models/operations/insighttoolgetbyid.d.ts.map +1 -0
- package/models/operations/insighttoolgetbyid.js +68 -0
- package/models/operations/insighttoolgetbyid.js.map +1 -0
- package/models/operations/insighttoollist.d.ts +73 -0
- package/models/operations/insighttoollist.d.ts.map +1 -0
- package/models/operations/insighttoollist.js +103 -0
- package/models/operations/insighttoollist.js.map +1 -0
- package/models/operations/languagegroupsdelete.d.ts +31 -0
- package/models/operations/languagegroupsdelete.d.ts.map +1 -0
- package/models/operations/languagegroupsdelete.js +70 -0
- package/models/operations/languagegroupsdelete.js.map +1 -0
- package/models/operations/languagegroupsgetbyid.d.ts +29 -0
- package/models/operations/languagegroupsgetbyid.d.ts.map +1 -0
- package/models/operations/languagegroupsgetbyid.js +68 -0
- package/models/operations/languagegroupsgetbyid.js.map +1 -0
- package/models/operations/languagegroupslist.d.ts +73 -0
- package/models/operations/languagegroupslist.d.ts.map +1 -0
- package/models/operations/languagegroupslist.js +103 -0
- package/models/operations/languagegroupslist.js.map +1 -0
- package/models/operations/postgetdashboard.d.ts +29 -0
- package/models/operations/postgetdashboard.d.ts.map +1 -0
- package/models/operations/postgetdashboard.js +68 -0
- package/models/operations/postgetdashboard.js.map +1 -0
- package/models/operations/postlistdashboard.d.ts +73 -0
- package/models/operations/postlistdashboard.d.ts.map +1 -0
- package/models/operations/postlistdashboard.js +101 -0
- package/models/operations/postlistdashboard.js.map +1 -0
- package/models/operations/promptslist.d.ts +31 -67
- package/models/operations/promptslist.d.ts.map +1 -1
- package/models/operations/promptslist.js +5 -47
- package/models/operations/promptslist.js.map +1 -1
- package/models/operations/servicedelete.d.ts +31 -0
- package/models/operations/servicedelete.d.ts.map +1 -0
- package/models/operations/servicedelete.js +70 -0
- package/models/operations/servicedelete.js.map +1 -0
- package/models/operations/servicelist.d.ts +31 -55
- package/models/operations/servicelist.d.ts.map +1 -1
- package/models/operations/servicelist.js +5 -43
- package/models/operations/servicelist.js.map +1 -1
- package/models/operations/servicesgetbyid.d.ts +29 -0
- package/models/operations/servicesgetbyid.d.ts.map +1 -0
- package/models/operations/servicesgetbyid.js +68 -0
- package/models/operations/servicesgetbyid.js.map +1 -0
- package/models/operations/sessionfullsummarygetbyid.d.ts +29 -0
- package/models/operations/sessionfullsummarygetbyid.d.ts.map +1 -0
- package/models/operations/sessionfullsummarygetbyid.js +68 -0
- package/models/operations/sessionfullsummarygetbyid.js.map +1 -0
- package/models/operations/sessionlabelslist.d.ts +31 -70
- package/models/operations/sessionlabelslist.d.ts.map +1 -1
- package/models/operations/sessionlabelslist.js +7 -49
- package/models/operations/sessionlabelslist.js.map +1 -1
- package/models/operations/sessionslist.d.ts +31 -97
- package/models/operations/sessionslist.d.ts.map +1 -1
- package/models/operations/sessionslist.js +5 -57
- package/models/operations/sessionslist.js.map +1 -1
- package/models/operations/sessionsummarygetbyid.d.ts +29 -0
- package/models/operations/sessionsummarygetbyid.d.ts.map +1 -0
- package/models/operations/sessionsummarygetbyid.js +68 -0
- package/models/operations/sessionsummarygetbyid.js.map +1 -0
- package/models/operations/tooldelete.d.ts +31 -0
- package/models/operations/tooldelete.d.ts.map +1 -0
- package/models/operations/tooldelete.js +70 -0
- package/models/operations/tooldelete.js.map +1 -0
- package/models/operations/toollist.d.ts +31 -64
- package/models/operations/toollist.d.ts.map +1 -1
- package/models/operations/toollist.js +5 -46
- package/models/operations/toollist.js.map +1 -1
- package/openapi-final.json +3083 -0
- package/openapi.json +15175 -0
- package/package.json +6 -7
- package/sdk/agents.d.ts +11 -4
- package/sdk/agents.d.ts.map +1 -1
- package/sdk/agents.js +11 -2
- package/sdk/agents.js.map +1 -1
- package/sdk/channels.d.ts +4 -1
- package/sdk/channels.d.ts.map +1 -1
- package/sdk/channels.js +4 -2
- package/sdk/channels.js.map +1 -1
- package/sdk/custommessages.d.ts +8 -8
- package/sdk/custommessages.d.ts.map +1 -1
- package/sdk/custommessages.js +4 -4
- package/sdk/custommessages.js.map +1 -1
- package/sdk/dashboards.d.ts +47 -30
- package/sdk/dashboards.d.ts.map +1 -1
- package/sdk/dashboards.js +58 -48
- package/sdk/dashboards.js.map +1 -1
- package/sdk/datasources.d.ts +41 -0
- package/sdk/datasources.d.ts.map +1 -0
- package/sdk/datasources.js +62 -0
- package/sdk/datasources.js.map +1 -0
- package/sdk/fullsummary.d.ts +10 -0
- package/sdk/fullsummary.d.ts.map +1 -0
- package/sdk/fullsummary.js +19 -0
- package/sdk/fullsummary.js.map +1 -0
- package/sdk/insights.d.ts +10 -0
- package/sdk/insights.d.ts.map +1 -0
- package/sdk/insights.js +19 -0
- package/sdk/insights.js.map +1 -0
- package/sdk/languagegroups.d.ts +41 -0
- package/sdk/languagegroups.d.ts.map +1 -0
- package/sdk/languagegroups.js +62 -0
- package/sdk/languagegroups.js.map +1 -0
- package/sdk/prompts.d.ts +7 -4
- package/sdk/prompts.d.ts.map +1 -1
- package/sdk/prompts.js +3 -0
- package/sdk/prompts.js.map +1 -1
- package/sdk/sdk.d.ts +17 -2
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +32 -23
- package/sdk/sdk.js.map +1 -1
- package/sdk/services.d.ts +24 -4
- package/sdk/services.d.ts.map +1 -1
- package/sdk/services.js +27 -1
- package/sdk/services.js.map +1 -1
- package/sdk/sessiondebug.d.ts +18 -0
- package/sdk/sessiondebug.d.ts.map +1 -0
- package/sdk/sessiondebug.js +33 -0
- package/sdk/sessiondebug.js.map +1 -0
- package/sdk/sessions.d.ts +6 -0
- package/sdk/sessions.d.ts.map +1 -1
- package/sdk/sessions.js +9 -2
- package/sdk/sessions.js.map +1 -1
- package/sdk/summary.d.ts +9 -0
- package/sdk/summary.d.ts.map +1 -0
- package/sdk/summary.js +19 -0
- package/sdk/summary.js.map +1 -0
- package/sdk/syllablesdktools.d.ts +41 -0
- package/sdk/syllablesdktools.d.ts.map +1 -0
- package/sdk/syllablesdktools.js +62 -0
- package/sdk/syllablesdktools.js.map +1 -0
- package/sdk/targets.d.ts +4 -4
- package/sdk/targets.d.ts.map +1 -1
- package/sdk/tools.d.ts +10 -3
- package/sdk/tools.d.ts.map +1 -1
- package/sdk/tools.js +10 -0
- package/sdk/tools.js.map +1 -1
- package/sdk/v1.d.ts +78 -0
- package/sdk/v1.d.ts.map +1 -0
- package/sdk/v1.js +102 -0
- package/sdk/v1.js.map +1 -0
- package/sdk/workflows.d.ts +41 -0
- package/sdk/workflows.d.ts.map +1 -0
- package/sdk/workflows.js +62 -0
- package/sdk/workflows.js.map +1 -0
- package/src/funcs/{dashboardsGetSessionAgents.ts → agentsAgentGetAvailableVoices.ts} +17 -15
- package/src/funcs/agentsCreate.ts +11 -7
- package/src/funcs/agentsDelete.ts +8 -4
- package/src/funcs/agentsGetById.ts +10 -6
- package/src/funcs/agentsList.ts +10 -6
- package/src/funcs/agentsTestSendTestMessage.ts +7 -3
- package/src/funcs/agentsUpdate.ts +13 -9
- package/src/funcs/channelsDelete.ts +14 -7
- package/src/funcs/channelsList.ts +7 -3
- package/src/funcs/channelsTargetsAvailableTargets.ts +7 -3
- package/src/funcs/channelsTargetsCreate.ts +10 -6
- package/src/funcs/channelsTargetsGetById.ts +10 -6
- package/src/funcs/channelsTargetsList.ts +10 -6
- package/src/funcs/channelsTargetsUpdate.ts +13 -7
- package/src/funcs/conversationsList.ts +7 -3
- package/src/funcs/customMessagesCreate.ts +14 -9
- package/src/funcs/customMessagesDelete.ts +8 -4
- package/src/funcs/customMessagesGetById.ts +11 -7
- package/src/funcs/customMessagesList.ts +10 -6
- package/src/funcs/customMessagesUpdate.ts +14 -9
- package/src/funcs/dashboardsPostGetDashboard.ts +143 -0
- package/src/funcs/dashboardsPostListDashboard.ts +151 -0
- package/src/funcs/dashboardsPostSessionEventsDashboard.ts +117 -0
- package/src/funcs/dashboardsPostSessionSummaryDashboard.ts +117 -0
- package/src/funcs/dashboardsPostSessionTransfersDashboard.ts +117 -0
- package/src/funcs/{dashboardsGetMonthlyCallVolumeByWeek.ts → dashboardsPostSessionsDashboard.ts} +23 -19
- package/src/funcs/dataSourcesCreate.ts +135 -0
- package/src/funcs/dataSourcesDelete.ts +147 -0
- package/src/funcs/dataSourcesGetById.ts +142 -0
- package/src/funcs/dataSourcesList.ts +151 -0
- package/src/funcs/dataSourcesUpdate.ts +135 -0
- package/src/funcs/eventsList.ts +7 -3
- package/src/funcs/insightsToolsCreate.ts +135 -0
- package/src/funcs/insightsToolsGetById.ts +142 -0
- package/src/funcs/{dashboardsGetDailyCallVolumeByHour.ts → insightsToolsInsightToolGetDefinitions.ts} +17 -16
- package/src/funcs/insightsToolsList.ts +148 -0
- package/src/funcs/insightsToolsUpdate.ts +143 -0
- package/src/funcs/insightsWorkflowsCreate.ts +135 -0
- package/src/funcs/insightsWorkflowsDelete.ts +145 -0
- package/src/funcs/insightsWorkflowsGetById.ts +145 -0
- package/src/funcs/insightsWorkflowsList.ts +149 -0
- package/src/funcs/insightsWorkflowsUpdate.ts +148 -0
- package/src/funcs/languageGroupsCreate.ts +136 -0
- package/src/funcs/languageGroupsDelete.ts +151 -0
- package/src/funcs/languageGroupsGetById.ts +146 -0
- package/src/funcs/languageGroupsList.ts +148 -0
- package/src/funcs/languageGroupsUpdate.ts +136 -0
- package/src/funcs/promptsCreate.ts +12 -8
- package/src/funcs/promptsDelete.ts +10 -3
- package/src/funcs/promptsGetById.ts +10 -6
- package/src/funcs/promptsList.ts +10 -6
- package/src/funcs/promptsPromptsHistory.ts +7 -3
- package/src/funcs/promptsUpdate.ts +12 -8
- package/src/funcs/servicesCreate.ts +15 -8
- package/src/funcs/servicesDelete.ts +147 -0
- package/src/funcs/servicesGetById.ts +142 -0
- package/src/funcs/servicesList.ts +11 -7
- package/src/funcs/servicesUpdate.ts +15 -8
- package/src/funcs/sessionDebugGetSessionDataBySessionId.ts +142 -0
- package/src/funcs/sessionDebugGetSessionDataBySid.ts +148 -0
- package/src/funcs/{dashboardsGetWeeklyCallVolumeByWeekday.ts → sessionDebugGetSessionToolCallResultById.ts} +55 -20
- package/src/funcs/sessionLabelsCreate.ts +7 -3
- package/src/funcs/sessionLabelsGetById.ts +7 -3
- package/src/funcs/sessionLabelsList.ts +7 -3
- package/src/funcs/sessionsFullSummaryGetById.ts +142 -0
- package/src/funcs/sessionsGenerateSessionRecordingUrls.ts +7 -3
- package/src/funcs/sessionsGetById.ts +7 -3
- package/src/funcs/sessionsList.ts +7 -3
- package/src/funcs/sessionsSessionRecordingStream.ts +7 -3
- package/src/funcs/sessionsSummaryGetById.ts +140 -0
- package/src/funcs/sessionsTranscriptGetById.ts +7 -3
- package/src/funcs/toolsCreate.ts +12 -8
- package/src/funcs/toolsDelete.ts +147 -0
- package/src/funcs/toolsGetByName.ts +7 -3
- package/src/funcs/toolsList.ts +10 -6
- package/src/funcs/toolsUpdate.ts +12 -8
- package/src/funcs/{dashboardsGetSessionSummary.ts → v1PostGetDashboard.ts} +23 -23
- package/src/funcs/v1PostListDashboard.ts +151 -0
- package/src/funcs/v1PostSessionEventsDashboard.ts +117 -0
- package/src/funcs/v1PostSessionSummaryDashboard.ts +117 -0
- package/src/funcs/v1PostSessionTransfersDashboard.ts +117 -0
- package/src/funcs/{dashboardsGetMonthlyCallVolumeByDay.ts → v1PostSessionsDashboard.ts} +23 -19
- package/src/hooks/hooks.ts +23 -0
- package/src/hooks/types.ts +8 -0
- package/src/lib/config.ts +5 -9
- package/src/lib/encodings.ts +95 -61
- package/src/lib/primitives.ts +76 -0
- package/src/lib/retries.ts +0 -1
- package/src/lib/schemas.ts +5 -0
- package/src/lib/sdks.ts +10 -2
- package/src/lib/security.ts +1 -2
- package/src/models/components/agentcreate.ts +109 -72
- package/src/models/components/agentlanguage.ts +80 -0
- package/src/models/components/agentproperties.ts +7 -0
- package/src/models/components/agentresponse.ts +302 -0
- package/src/models/components/agentsttprovider.ts +40 -0
- package/src/models/components/agenttooldefaults.ts +9 -0
- package/src/models/components/agenttoolfielddefault.ts +9 -0
- package/src/models/components/agentupdate.ts +211 -0
- package/src/models/components/agentvoice.ts +154 -0
- package/src/models/components/agentvoicedisplayname.ts +75 -0
- package/src/models/components/agentvoicegender.ts +39 -0
- package/src/models/components/agentvoicemodel.ts +43 -0
- package/src/models/components/agentvoicevarname.ts +75 -0
- package/src/models/components/agentwaitsound.ts +41 -0
- package/src/models/components/channel.ts +2 -2
- package/src/models/components/channelservices.ts +6 -0
- package/src/models/components/channeltargetcreaterequest.ts +49 -26
- package/src/models/components/channeltargetproperties.ts +1 -0
- package/src/models/components/channeltargetresponse.ts +180 -0
- package/src/models/components/channeltargetupdaterequest.ts +133 -0
- package/src/models/components/conversation.ts +42 -0
- package/src/models/components/custommessagecreaterequest.ts +100 -0
- package/src/models/components/custommessageproperties.ts +2 -0
- package/src/models/components/custommessageresponse.ts +150 -0
- package/src/models/components/custommessagerule.ts +129 -0
- package/src/models/components/custommessageupdaterequest.ts +107 -0
- package/src/models/components/dashboard.ts +105 -0
- package/src/models/components/dashboardproperties.ts +36 -0
- package/src/models/components/dashboardresponse.ts +102 -0
- package/src/models/components/dashboardtokenresponse.ts +129 -0
- package/src/models/components/datasourcecreaterequest.ts +113 -0
- package/src/models/components/datasourcedetailresponse.ts +155 -0
- package/src/models/components/datasourcemetadataresponse.ts +148 -0
- package/src/models/components/datasourceproperties.ts +38 -0
- package/src/models/components/datasourceupdaterequest.ts +129 -0
- package/src/models/components/dayofweek.ts +36 -0
- package/src/models/components/dialogmessage.ts +62 -0
- package/src/models/components/dialogrole.ts +31 -0
- package/src/models/components/dialogtoolcall.ts +139 -0
- package/src/models/components/event.ts +33 -0
- package/src/models/components/index.ts +85 -19
- package/src/models/components/insighttooldefinition.ts +213 -0
- package/src/models/components/insighttoolinput.ts +163 -0
- package/src/models/components/insighttooloutput.ts +210 -0
- package/src/models/components/insighttoolproperties.ts +37 -0
- package/src/models/components/insightworkflowinput.ts +161 -0
- package/src/models/components/insightworkflowoutput.ts +206 -0
- package/src/models/components/insightworkflowproperties.ts +40 -0
- package/src/models/components/internaltool.ts +86 -0
- package/src/models/components/languagecode.ts +42 -0
- package/src/models/components/languageconfig.ts +122 -0
- package/src/models/components/languagegroupagentinfo.ts +79 -0
- package/src/models/components/languagegroupcreaterequest.ts +107 -0
- package/src/models/components/languagegroupproperties.ts +38 -0
- package/src/models/components/languagegroupresponse.ts +165 -0
- package/src/models/components/languagegroupupdaterequest.ts +123 -0
- package/src/models/components/{listresponsechanneltarget.ts → listresponseagentresponse.ts} +30 -30
- package/src/models/components/listresponsechanneltargetresponse.ts +104 -0
- package/src/models/components/listresponsecustommessageresponse.ts +104 -0
- package/src/models/components/listresponsedashboardresponse.ts +103 -0
- package/src/models/components/listresponsedatasourcemetadataresponse.ts +107 -0
- package/src/models/components/listresponseinsighttooloutput.ts +103 -0
- package/src/models/components/listresponseinsightworkflowoutput.ts +104 -0
- package/src/models/components/listresponselanguagegroupresponse.ts +104 -0
- package/src/models/components/{listresponsecustommessage.ts → listresponsepromptresponse.ts} +30 -30
- package/src/models/components/{listresponseprompt.ts → listresponseserviceresponse.ts} +32 -30
- package/src/models/components/{listresponseservice.ts → listresponsetoolresponse.ts} +30 -30
- package/src/models/components/orderbydirection.ts +33 -0
- package/src/models/components/promptcreaterequest.ts +125 -0
- package/src/models/components/prompthistory.ts +49 -16
- package/src/models/components/promptllmconfig.ts +102 -0
- package/src/models/components/promptllmprovider.ts +40 -0
- package/src/models/components/promptproperties.ts +4 -0
- package/src/models/components/promptresponse.ts +180 -0
- package/src/models/components/promptupdaterequest.ts +141 -0
- package/src/models/components/servicecreaterequest.ts +76 -0
- package/src/models/components/serviceproperties.ts +3 -0
- package/src/models/components/serviceresponse.ts +127 -0
- package/src/models/components/serviceupdaterequest.ts +99 -0
- package/src/models/components/session.ts +72 -0
- package/src/models/components/sessionaction.ts +24 -0
- package/src/models/components/sessiondata.ts +95 -0
- package/src/models/components/sessionlabel.ts +25 -1
- package/src/models/components/sessionlabelcreate.ts +18 -0
- package/src/models/components/sessionmessage.ts +100 -0
- package/src/models/components/sessionrecordingresponse.ts +9 -4
- package/src/models/components/sessionsummaryresponse.ts +79 -0
- package/src/models/components/sessiontext.ts +15 -0
- package/src/models/components/sessiontranscriptionresponse.ts +15 -0
- package/src/models/components/statictoolparameter.ts +105 -0
- package/src/models/components/statictoolparametertype.ts +43 -0
- package/src/models/components/targetmodes.ts +39 -0
- package/src/models/components/testmessage.ts +39 -4
- package/src/models/components/testmessageresponse.ts +25 -4
- package/src/models/components/toolagentinfo.ts +75 -0
- package/src/models/components/toolargumentlocation.ts +53 -0
- package/src/models/components/toolcreaterequest.ts +98 -0
- package/src/models/components/tooldefinition.ts +226 -0
- package/src/models/components/tooldetailresponse.ts +118 -4
- package/src/models/components/toolfunction.ts +87 -0
- package/src/models/components/toolhttpendpoint.ts +111 -0
- package/src/models/components/toolhttpmethod.ts +39 -0
- package/src/models/components/toolparameterdefault.ts +84 -0
- package/src/models/components/toolparametertransform.ts +138 -0
- package/src/models/components/toolparametertransformcondition.ts +88 -0
- package/src/models/components/toolpromptinfo.ts +75 -0
- package/src/models/components/toolproperties.ts +2 -0
- package/src/models/components/toolresponse.ts +177 -0
- package/src/models/components/toolresultdata.ts +123 -0
- package/src/models/components/toolupdaterequest.ts +114 -0
- package/src/models/components/ttsprovider.ts +38 -0
- package/src/models/operations/agentlist.ts +37 -69
- package/src/models/operations/availabletargets.ts +37 -71
- package/src/models/operations/channelslist.ts +37 -67
- package/src/models/operations/channeltargetslist.ts +37 -77
- package/src/models/operations/channeltargetsupdate.ts +8 -6
- package/src/models/operations/conversationslist.ts +37 -78
- package/src/models/operations/custommessageslist.ts +37 -72
- package/src/models/operations/datasourcesdelete.ts +79 -0
- package/src/models/operations/datasourcesgetbyid.ts +75 -0
- package/src/models/operations/datasourceslist.ts +153 -0
- package/src/models/operations/directoryworkflowdelete.ts +77 -0
- package/src/models/operations/eventslist.ts +35 -78
- package/src/models/operations/getsessiondatabysessionid.ts +77 -0
- package/src/models/operations/getsessiondatabysid.ts +81 -0
- package/src/models/operations/getsessiontoolcallresultbyid.ts +86 -0
- package/src/models/operations/index.ts +23 -8
- package/src/models/operations/insightstoolupdate.ts +82 -0
- package/src/models/operations/insightsworkflowgetbyid.ts +77 -0
- package/src/models/operations/insightsworkflowlist.ts +157 -0
- package/src/models/operations/insightsworkflowupdate.ts +84 -0
- package/src/models/operations/insighttoolgetbyid.ts +75 -0
- package/src/models/operations/insighttoollist.ts +153 -0
- package/src/models/operations/languagegroupsdelete.ts +81 -0
- package/src/models/operations/languagegroupsgetbyid.ts +77 -0
- package/src/models/operations/languagegroupslist.ts +153 -0
- package/src/models/operations/postgetdashboard.ts +75 -0
- package/src/models/operations/postlistdashboard.ts +151 -0
- package/src/models/operations/promptslist.ts +35 -74
- package/src/models/operations/servicedelete.ts +79 -0
- package/src/models/operations/servicelist.ts +35 -70
- package/src/models/operations/servicesgetbyid.ts +75 -0
- package/src/models/operations/sessionfullsummarygetbyid.ts +77 -0
- package/src/models/operations/sessionlabelslist.ts +37 -75
- package/src/models/operations/sessionslist.ts +35 -84
- package/src/models/operations/sessionsummarygetbyid.ts +77 -0
- package/src/models/operations/tooldelete.ts +79 -0
- package/src/models/operations/toollist.ts +35 -71
- package/src/sdk/agents.ts +21 -5
- package/src/sdk/channels.ts +4 -1
- package/src/sdk/custommessages.ts +10 -10
- package/src/sdk/dashboards.ts +69 -80
- package/src/sdk/datasources.ts +100 -0
- package/src/sdk/fullsummary.ts +25 -0
- package/src/sdk/insights.ts +19 -0
- package/src/sdk/languagegroups.ts +100 -0
- package/src/sdk/prompts.ts +9 -6
- package/src/sdk/sdk.ts +33 -3
- package/src/sdk/services.ts +48 -6
- package/src/sdk/sessiondebug.ts +55 -0
- package/src/sdk/sessions.ts +12 -0
- package/src/sdk/summary.ts +24 -0
- package/src/sdk/syllablesdktools.ts +98 -0
- package/src/sdk/targets.ts +4 -4
- package/src/sdk/tools.ts +23 -5
- package/src/sdk/v1.ts +140 -0
- package/src/sdk/workflows.ts +100 -0
- package/src/types/operations.ts +11 -5
- package/test/sdk/contract/agents.test.ts +113 -0
- package/test/sdk/contract/custommessages.test.ts +109 -0
- package/test/sdk/contract/helper.ts +190 -0
- package/test/sdk/contract/prompts.test.ts +70 -0
- package/tsconfig.json +41 -0
- 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/funcs/dashboardsGetDailyCallVolumeByHour.d.ts.map +0 -1
- package/funcs/dashboardsGetDailyCallVolumeByHour.js.map +0 -1
- package/funcs/dashboardsGetMonthlyCallVolumeByDay.d.ts.map +0 -1
- package/funcs/dashboardsGetMonthlyCallVolumeByDay.js.map +0 -1
- package/funcs/dashboardsGetMonthlyCallVolumeByWeek.d.ts.map +0 -1
- package/funcs/dashboardsGetMonthlyCallVolumeByWeek.js.map +0 -1
- package/funcs/dashboardsGetSessionAgents.d.ts.map +0 -1
- package/funcs/dashboardsGetSessionAgents.js.map +0 -1
- package/funcs/dashboardsGetSessionSummary.d.ts.map +0 -1
- package/funcs/dashboardsGetSessionSummary.js.map +0 -1
- package/funcs/dashboardsGetTotalCallVolumeByHour.d.ts.map +0 -1
- package/funcs/dashboardsGetTotalCallVolumeByHour.js +0 -86
- package/funcs/dashboardsGetTotalCallVolumeByHour.js.map +0 -1
- package/funcs/dashboardsGetWeeklyCallVolumeByWeekday.d.ts +0 -15
- package/funcs/dashboardsGetWeeklyCallVolumeByWeekday.d.ts.map +0 -1
- package/funcs/dashboardsGetWeeklyCallVolumeByWeekday.js +0 -86
- package/funcs/dashboardsGetWeeklyCallVolumeByWeekday.js.map +0 -1
- package/funcs/dashboardsTotalCallVolumeByWeekday.d.ts +0 -15
- package/funcs/dashboardsTotalCallVolumeByWeekday.d.ts.map +0 -1
- package/funcs/dashboardsTotalCallVolumeByWeekday.js +0 -86
- package/funcs/dashboardsTotalCallVolumeByWeekday.js.map +0 -1
- package/models/components/agent.d.ts +0 -76
- package/models/components/agent.d.ts.map +0 -1
- package/models/components/agent.js.map +0 -1
- package/models/components/channeltarget.d.ts +0 -43
- package/models/components/channeltarget.d.ts.map +0 -1
- package/models/components/channeltarget.js.map +0 -1
- package/models/components/custommessage.d.ts +0 -44
- package/models/components/custommessage.d.ts.map +0 -1
- package/models/components/custommessage.js.map +0 -1
- package/models/components/custommessagecreate.d.ts +0 -39
- package/models/components/custommessagecreate.d.ts.map +0 -1
- package/models/components/custommessagecreate.js.map +0 -1
- package/models/components/listresponseagent.d.ts +0 -38
- package/models/components/listresponseagent.d.ts.map +0 -1
- package/models/components/listresponseagent.js.map +0 -1
- package/models/components/listresponsechanneltarget.d.ts +0 -38
- package/models/components/listresponsecustommessage.d.ts +0 -38
- package/models/components/listresponsecustommessage.d.ts.map +0 -1
- package/models/components/listresponsecustommessage.js.map +0 -1
- package/models/components/listresponseprompt.d.ts +0 -38
- package/models/components/listresponseprompt.d.ts.map +0 -1
- package/models/components/listresponseprompt.js.map +0 -1
- package/models/components/listresponseservice.d.ts +0 -38
- package/models/components/listresponseservice.d.ts.map +0 -1
- package/models/components/listresponseservice.js +0 -81
- package/models/components/listresponseservice.js.map +0 -1
- package/models/components/listresponsetool.d.ts +0 -38
- package/models/components/listresponsetool.d.ts.map +0 -1
- package/models/components/listresponsetool.js.map +0 -1
- package/models/components/llmconfig.d.ts +0 -79
- package/models/components/llmconfig.d.ts.map +0 -1
- package/models/components/llmconfig.js.map +0 -1
- package/models/components/prompt.d.ts +0 -73
- package/models/components/prompt.d.ts.map +0 -1
- package/models/components/prompt.js.map +0 -1
- package/models/components/promptcreate.d.ts +0 -53
- package/models/components/promptcreate.d.ts.map +0 -1
- package/models/components/promptcreate.js.map +0 -1
- package/models/components/service.d.ts +0 -47
- package/models/components/service.d.ts.map +0 -1
- package/models/components/service.js.map +0 -1
- package/models/components/servicecreate.d.ts +0 -37
- package/models/components/servicecreate.d.ts.map +0 -1
- package/models/components/servicecreate.js.map +0 -1
- package/models/components/serviceupdate.d.ts +0 -42
- package/models/components/serviceupdate.d.ts.map +0 -1
- package/models/components/serviceupdate.js.map +0 -1
- package/models/components/tool.d.ts +0 -76
- package/models/components/tool.d.ts.map +0 -1
- package/models/components/tool.js +0 -102
- package/models/components/tool.js.map +0 -1
- package/models/components/toolcreate.d.ts +0 -66
- package/models/components/toolcreate.d.ts.map +0 -1
- package/models/components/toolcreate.js +0 -95
- package/models/components/toolcreate.js.map +0 -1
- package/models/components/toolupdate.d.ts +0 -71
- package/models/components/toolupdate.d.ts.map +0 -1
- package/models/components/toolupdate.js +0 -97
- package/models/components/toolupdate.js.map +0 -1
- package/models/operations/getdailycallvolumebyhour.d.ts +0 -28
- package/models/operations/getdailycallvolumebyhour.d.ts.map +0 -1
- package/models/operations/getdailycallvolumebyhour.js +0 -57
- package/models/operations/getdailycallvolumebyhour.js.map +0 -1
- package/models/operations/getmonthlycallvolumebyday.d.ts +0 -28
- package/models/operations/getmonthlycallvolumebyday.d.ts.map +0 -1
- package/models/operations/getmonthlycallvolumebyday.js +0 -57
- package/models/operations/getmonthlycallvolumebyday.js.map +0 -1
- package/models/operations/getmonthlycallvolumebyweek.d.ts +0 -28
- package/models/operations/getmonthlycallvolumebyweek.d.ts.map +0 -1
- package/models/operations/getmonthlycallvolumebyweek.js +0 -57
- package/models/operations/getmonthlycallvolumebyweek.js.map +0 -1
- package/models/operations/getsessionagents.d.ts +0 -28
- package/models/operations/getsessionagents.d.ts.map +0 -1
- package/models/operations/getsessionagents.js +0 -55
- package/models/operations/getsessionagents.js.map +0 -1
- package/models/operations/getsessionsummary.d.ts +0 -63
- package/models/operations/getsessionsummary.d.ts.map +0 -1
- package/models/operations/getsessionsummary.js +0 -107
- package/models/operations/getsessionsummary.js.map +0 -1
- package/models/operations/gettotalcallvolumebyhour.d.ts +0 -28
- package/models/operations/gettotalcallvolumebyhour.d.ts.map +0 -1
- package/models/operations/gettotalcallvolumebyhour.js +0 -57
- package/models/operations/gettotalcallvolumebyhour.js.map +0 -1
- package/models/operations/getweeklycallvolumebyweekday.d.ts +0 -28
- package/models/operations/getweeklycallvolumebyweekday.d.ts.map +0 -1
- package/models/operations/getweeklycallvolumebyweekday.js +0 -57
- package/models/operations/getweeklycallvolumebyweekday.js.map +0 -1
- package/models/operations/totalcallvolumebyweekday.d.ts +0 -28
- package/models/operations/totalcallvolumebyweekday.d.ts.map +0 -1
- package/models/operations/totalcallvolumebyweekday.js +0 -57
- package/models/operations/totalcallvolumebyweekday.js.map +0 -1
- package/src/funcs/dashboardsGetTotalCallVolumeByHour.ts +0 -111
- package/src/funcs/dashboardsTotalCallVolumeByWeekday.ts +0 -111
- package/src/models/components/agent.ts +0 -165
- package/src/models/components/channeltarget.ts +0 -109
- package/src/models/components/custommessage.ts +0 -83
- package/src/models/components/custommessagecreate.ts +0 -80
- package/src/models/components/listresponseagent.ts +0 -101
- package/src/models/components/listresponsetool.ts +0 -101
- package/src/models/components/llmconfig.ts +0 -127
- package/src/models/components/prompt.ts +0 -139
- package/src/models/components/promptcreate.ts +0 -108
- package/src/models/components/service.ts +0 -83
- package/src/models/components/servicecreate.ts +0 -72
- package/src/models/components/serviceupdate.ts +0 -79
- package/src/models/components/tool.ts +0 -147
- package/src/models/components/toolcreate.ts +0 -141
- package/src/models/components/toolupdate.ts +0 -148
- package/src/models/operations/getdailycallvolumebyhour.ts +0 -74
- package/src/models/operations/getmonthlycallvolumebyday.ts +0 -74
- package/src/models/operations/getmonthlycallvolumebyweek.ts +0 -74
- package/src/models/operations/getsessionagents.ts +0 -72
- package/src/models/operations/getsessionsummary.ts +0 -164
- package/src/models/operations/gettotalcallvolumebyhour.ts +0 -74
- package/src/models/operations/getweeklycallvolumebyweekday.ts +0 -75
- package/src/models/operations/totalcallvolumebyweekday.ts +0 -74
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
|
|
2
|
+
// README at: https://github.com/devcontainers/images/tree/main/src/typescript-node
|
|
3
|
+
{
|
|
4
|
+
"name": "TypeScript",
|
|
5
|
+
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
|
|
6
|
+
// Features to add to the dev container. More info: https://containers.dev/features.
|
|
7
|
+
// "features": {},
|
|
8
|
+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
|
9
|
+
// "forwardPorts": [],
|
|
10
|
+
// Use 'postCreateCommand' to run commands after the container is created.
|
|
11
|
+
"postCreateCommand": "sudo chmod +x ./.devcontainer/setup.sh && ./.devcontainer/setup.sh",
|
|
12
|
+
"customizations": {
|
|
13
|
+
"vscode": {
|
|
14
|
+
"extensions": [
|
|
15
|
+
"ms-vscode.vscode-typescript-tslint-plugin",
|
|
16
|
+
"esbenp.prettier-vscode",
|
|
17
|
+
"github.vscode-pull-request-github"
|
|
18
|
+
],
|
|
19
|
+
"settings": {
|
|
20
|
+
"files.eol": "\n",
|
|
21
|
+
"editor.formatOnSave": true,
|
|
22
|
+
"typescript.tsc.autoDetect": "on",
|
|
23
|
+
"typescript.updateImportsOnFileMove.enabled": "always",
|
|
24
|
+
"typescript.preferences.importModuleSpecifier": "relative",
|
|
25
|
+
"[typescript]": {
|
|
26
|
+
"editor.codeActionsOnSave": {
|
|
27
|
+
"source.organizeImports": true
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
"[typescriptreact]": {
|
|
31
|
+
"editor.codeActionsOnSave": {
|
|
32
|
+
"source.organizeImports": true
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
},
|
|
37
|
+
"codespaces": {
|
|
38
|
+
"openFiles": [
|
|
39
|
+
".devcontainer/README.md"
|
|
40
|
+
]
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
|
|
44
|
+
// "remoteUser": "root"
|
|
45
|
+
}
|
package/FUNCTIONS.md
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
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
|
+
page: 0,
|
|
35
|
+
searchFields: [
|
|
36
|
+
"name",
|
|
37
|
+
],
|
|
38
|
+
searchFieldValues: [
|
|
39
|
+
"Some Object Name",
|
|
40
|
+
],
|
|
41
|
+
startDatetime: "2023-01-01T00:00:00Z",
|
|
42
|
+
endDatetime: "2024-01-01T00:00:00Z",
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
switch (true) {
|
|
46
|
+
case res.ok:
|
|
47
|
+
// The success case will be handled outside of the switch block
|
|
48
|
+
break;
|
|
49
|
+
case res.error instanceof SDKValidationError:
|
|
50
|
+
// Pretty-print validation errors.
|
|
51
|
+
return console.log(res.error.pretty());
|
|
52
|
+
case res.error instanceof Error:
|
|
53
|
+
return console.log(res.error);
|
|
54
|
+
default:
|
|
55
|
+
// TypeScript's type checking will fail on the following line if the above
|
|
56
|
+
// cases were not exhaustive.
|
|
57
|
+
res.error satisfies never;
|
|
58
|
+
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
const { value: result } = res;
|
|
63
|
+
|
|
64
|
+
// Handle the result
|
|
65
|
+
console.log(result);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
run();
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Result types
|
|
72
|
+
|
|
73
|
+
Standalone functions differ from SDK methods in that they return a
|
|
74
|
+
`Result<Value, Error>` type to capture _known errors_ and document them using
|
|
75
|
+
the type system. By avoiding throwing errors, application code maintains clear
|
|
76
|
+
control flow and error-handling become part of the regular flow of application
|
|
77
|
+
code.
|
|
78
|
+
|
|
79
|
+
> We use the term "known errors" because standalone functions, and JavaScript
|
|
80
|
+
> code in general, can still throw unexpected errors such as `TypeError`s,
|
|
81
|
+
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
|
|
82
|
+
> something this SDK addresses in the future. Nevertheless, there is still a lot
|
|
83
|
+
> of benefit from capturing most errors and turning them into values.
|
|
84
|
+
|
|
85
|
+
The second reason for this style of programming is because these functions will
|
|
86
|
+
typically be used in front-end applications where exception throwing is
|
|
87
|
+
sometimes discouraged or considered unidiomatic. React and similar ecosystems
|
|
88
|
+
and libraries tend to promote this style of programming so that components
|
|
89
|
+
render useful content under all states (loading, success, error and so on).
|
|
90
|
+
|
|
91
|
+
The general pattern when calling standalone functions looks like this:
|
|
92
|
+
|
|
93
|
+
```typescript
|
|
94
|
+
import { Core } from "<sdk-package-name>";
|
|
95
|
+
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
|
|
96
|
+
|
|
97
|
+
const client = new Core();
|
|
98
|
+
|
|
99
|
+
async function run() {
|
|
100
|
+
const result = await fetchSomething(client, { id: "123" });
|
|
101
|
+
if (!result.ok) {
|
|
102
|
+
// You can throw the error or handle it. It's your choice now.
|
|
103
|
+
throw result.error;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
console.log(result.value);
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
run();
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
Notably, `result.error` above will have an explicit type compared to a try-catch
|
|
113
|
+
variation where the error in the catch block can only be of type `unknown` (or
|
|
114
|
+
`any` depending on your TypeScript settings).
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# syllable-sdk
|
|
2
2
|
|
|
3
|
-
Developer-friendly & type-safe
|
|
3
|
+
Developer-friendly & type-safe TypeScript SDK specifically catered to leverage *syllable-sdk* API.
|
|
4
4
|
|
|
5
5
|
<div align="left">
|
|
6
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>
|
|
@@ -13,15 +13,15 @@ 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
23
|
capabilities into your communication applications. Whether you're building chatbots, virtual
|
|
24
|
-
assistants, or any other AI-driven solutions,
|
|
24
|
+
assistants, or any other AI-driven solutions, Syllable SDK has got you covered.
|
|
25
25
|
|
|
26
26
|
## Features
|
|
27
27
|
|
|
@@ -34,18 +34,26 @@ assistants, or any other AI-driven solutions, Syllble SDK has got you covered.
|
|
|
34
34
|
|
|
35
35
|
<!-- Start Table of Contents [toc] -->
|
|
36
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
|
+
* [Retries](#retries)
|
|
48
|
+
* [Error Handling](#error-handling)
|
|
49
|
+
* [Server Selection](#server-selection)
|
|
50
|
+
* [Custom HTTP Client](#custom-http-client)
|
|
51
|
+
* [Authentication](#authentication)
|
|
52
|
+
* [Debugging](#debugging)
|
|
53
|
+
* [Development](#development)
|
|
54
|
+
* [Maturity](#maturity)
|
|
55
|
+
* [Contributions](#contributions)
|
|
37
56
|
|
|
38
|
-
* [SDK Installation](#sdk-installation)
|
|
39
|
-
* [Requirements](#requirements)
|
|
40
|
-
* [SDK Example Usage](#sdk-example-usage)
|
|
41
|
-
* [Available Resources and Operations](#available-resources-and-operations)
|
|
42
|
-
* [Standalone functions](#standalone-functions)
|
|
43
|
-
* [Retries](#retries)
|
|
44
|
-
* [Error Handling](#error-handling)
|
|
45
|
-
* [Server Selection](#server-selection)
|
|
46
|
-
* [Custom HTTP Client](#custom-http-client)
|
|
47
|
-
* [Authentication](#authentication)
|
|
48
|
-
* [Debugging](#debugging)
|
|
49
57
|
<!-- End Table of Contents [toc] -->
|
|
50
58
|
|
|
51
59
|
<!-- Start SDK Installation [installation] -->
|
|
@@ -100,7 +108,17 @@ const syllableSDK = new SyllableSDK({
|
|
|
100
108
|
});
|
|
101
109
|
|
|
102
110
|
async function run() {
|
|
103
|
-
const result = await syllableSDK.agents.list({
|
|
111
|
+
const result = await syllableSDK.agents.list({
|
|
112
|
+
page: 0,
|
|
113
|
+
searchFields: [
|
|
114
|
+
"name",
|
|
115
|
+
],
|
|
116
|
+
searchFieldValues: [
|
|
117
|
+
"Some Object Name",
|
|
118
|
+
],
|
|
119
|
+
startDatetime: "2023-01-01T00:00:00Z",
|
|
120
|
+
endDatetime: "2024-01-01T00:00:00Z",
|
|
121
|
+
});
|
|
104
122
|
|
|
105
123
|
// Handle the result
|
|
106
124
|
console.log(result);
|
|
@@ -124,6 +142,7 @@ run();
|
|
|
124
142
|
* [update](docs/sdks/agents/README.md#update) - Update Agent
|
|
125
143
|
* [getById](docs/sdks/agents/README.md#getbyid) - Get Agent By Id
|
|
126
144
|
* [delete](docs/sdks/agents/README.md#delete) - Delete Agent
|
|
145
|
+
* [agentGetAvailableVoices](docs/sdks/agents/README.md#agentgetavailablevoices) - Get Available Agent Voices
|
|
127
146
|
|
|
128
147
|
#### [agents.test](docs/sdks/test/README.md)
|
|
129
148
|
|
|
@@ -156,19 +175,52 @@ run();
|
|
|
156
175
|
|
|
157
176
|
### [dashboards](docs/sdks/dashboards/README.md)
|
|
158
177
|
|
|
159
|
-
* [
|
|
160
|
-
* [
|
|
161
|
-
* [
|
|
162
|
-
* [
|
|
163
|
-
* [
|
|
164
|
-
* [
|
|
165
|
-
|
|
166
|
-
|
|
178
|
+
* [postListDashboard](docs/sdks/dashboards/README.md#postlistdashboard) - Post List Dashboards
|
|
179
|
+
* [postGetDashboard](docs/sdks/dashboards/README.md#postgetdashboard) - Post Fetch Info
|
|
180
|
+
* [~~postSessionEventsDashboard~~](docs/sdks/dashboards/README.md#postsessioneventsdashboard) - Post Session Events :warning: **Deprecated**
|
|
181
|
+
* [~~postSessionSummaryDashboard~~](docs/sdks/dashboards/README.md#postsessionsummarydashboard) - Post Session Summary :warning: **Deprecated**
|
|
182
|
+
* [~~postSessionTransfersDashboard~~](docs/sdks/dashboards/README.md#postsessiontransfersdashboard) - Post Session Transfers :warning: **Deprecated**
|
|
183
|
+
* [~~postSessionsDashboard~~](docs/sdks/dashboards/README.md#postsessionsdashboard) - Post Sessions :warning: **Deprecated**
|
|
184
|
+
|
|
185
|
+
### [dataSources](docs/sdks/datasources/README.md)
|
|
186
|
+
|
|
187
|
+
* [list](docs/sdks/datasources/README.md#list) - List Data Sources
|
|
188
|
+
* [create](docs/sdks/datasources/README.md#create) - Create Data Source
|
|
189
|
+
* [update](docs/sdks/datasources/README.md#update) - Update Data Source
|
|
190
|
+
* [getById](docs/sdks/datasources/README.md#getbyid) - Get Data Source
|
|
191
|
+
* [delete](docs/sdks/datasources/README.md#delete) - Delete Data Source
|
|
167
192
|
|
|
168
193
|
### [events](docs/sdks/events/README.md)
|
|
169
194
|
|
|
170
195
|
* [list](docs/sdks/events/README.md#list) - Events List
|
|
171
196
|
|
|
197
|
+
### [insights](docs/sdks/insights/README.md)
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
#### [insights.tools](docs/sdks/syllablesdktools/README.md)
|
|
201
|
+
|
|
202
|
+
* [list](docs/sdks/syllablesdktools/README.md#list) - Insight Tool List
|
|
203
|
+
* [create](docs/sdks/syllablesdktools/README.md#create) - Create Insight Tool
|
|
204
|
+
* [getById](docs/sdks/syllablesdktools/README.md#getbyid) - Get Insight Tool By Id
|
|
205
|
+
* [update](docs/sdks/syllablesdktools/README.md#update) - Update Insights Tool
|
|
206
|
+
* [insightToolGetDefinitions](docs/sdks/syllablesdktools/README.md#insighttoolgetdefinitions) - Get Insight Tool Definitions
|
|
207
|
+
|
|
208
|
+
#### [insights.workflows](docs/sdks/workflows/README.md)
|
|
209
|
+
|
|
210
|
+
* [list](docs/sdks/workflows/README.md#list) - Insight Workflow List
|
|
211
|
+
* [create](docs/sdks/workflows/README.md#create) - Create Insight Workflow
|
|
212
|
+
* [getById](docs/sdks/workflows/README.md#getbyid) - Get Insight Workflow By Id
|
|
213
|
+
* [update](docs/sdks/workflows/README.md#update) - Update Insights Workflow
|
|
214
|
+
* [delete](docs/sdks/workflows/README.md#delete) - Delete Insights Workflow
|
|
215
|
+
|
|
216
|
+
### [languageGroups](docs/sdks/languagegroups/README.md)
|
|
217
|
+
|
|
218
|
+
* [list](docs/sdks/languagegroups/README.md#list) - List Language Groups
|
|
219
|
+
* [create](docs/sdks/languagegroups/README.md#create) - Create Language Group
|
|
220
|
+
* [update](docs/sdks/languagegroups/README.md#update) - Update Language Group
|
|
221
|
+
* [getById](docs/sdks/languagegroups/README.md#getbyid) - Get Language Group
|
|
222
|
+
* [delete](docs/sdks/languagegroups/README.md#delete) - Delete Language Group
|
|
223
|
+
|
|
172
224
|
### [prompts](docs/sdks/prompts/README.md)
|
|
173
225
|
|
|
174
226
|
* [list](docs/sdks/prompts/README.md#list) - Prompt List
|
|
@@ -183,6 +235,14 @@ run();
|
|
|
183
235
|
* [list](docs/sdks/services/README.md#list) - Service List
|
|
184
236
|
* [create](docs/sdks/services/README.md#create) - Create Service
|
|
185
237
|
* [update](docs/sdks/services/README.md#update) - Update Service
|
|
238
|
+
* [getById](docs/sdks/services/README.md#getbyid) - Get Service By Id
|
|
239
|
+
* [delete](docs/sdks/services/README.md#delete) - Delete Service
|
|
240
|
+
|
|
241
|
+
### [sessionDebug](docs/sdks/sessiondebug/README.md)
|
|
242
|
+
|
|
243
|
+
* [getSessionDataBySid](docs/sdks/sessiondebug/README.md#getsessiondatabysid) - Get Session Data By Sid
|
|
244
|
+
* [getSessionDataBySessionId](docs/sdks/sessiondebug/README.md#getsessiondatabysessionid) - Get Session Data By Session Id
|
|
245
|
+
* [getSessionToolCallResultById](docs/sdks/sessiondebug/README.md#getsessiontoolcallresultbyid) - Get Session Tool Call Result By Id
|
|
186
246
|
|
|
187
247
|
### [sessionLabels](docs/sdks/sessionlabels/README.md)
|
|
188
248
|
|
|
@@ -197,6 +257,14 @@ run();
|
|
|
197
257
|
* [generateSessionRecordingUrls](docs/sdks/sessions/README.md#generatesessionrecordingurls) - Generate Recording Urls
|
|
198
258
|
* [sessionRecordingStream](docs/sdks/sessions/README.md#sessionrecordingstream) - Stream Recording
|
|
199
259
|
|
|
260
|
+
#### [sessions.fullSummary](docs/sdks/fullsummary/README.md)
|
|
261
|
+
|
|
262
|
+
* [getById](docs/sdks/fullsummary/README.md#getbyid) - Get Full Session Summary By Id
|
|
263
|
+
|
|
264
|
+
#### [sessions.summary](docs/sdks/summary/README.md)
|
|
265
|
+
|
|
266
|
+
* [getById](docs/sdks/summary/README.md#getbyid) - Get Session Summary By Id
|
|
267
|
+
|
|
200
268
|
#### [sessions.transcript](docs/sdks/transcript/README.md)
|
|
201
269
|
|
|
202
270
|
* [getById](docs/sdks/transcript/README.md#getbyid) - Get Session Transcript By Id
|
|
@@ -208,6 +276,16 @@ run();
|
|
|
208
276
|
* [create](docs/sdks/tools/README.md#create) - Create Tool
|
|
209
277
|
* [update](docs/sdks/tools/README.md#update) - Update Tool
|
|
210
278
|
* [getByName](docs/sdks/tools/README.md#getbyname) - Tool Info
|
|
279
|
+
* [delete](docs/sdks/tools/README.md#delete) - Delete Tool
|
|
280
|
+
|
|
281
|
+
### [v1](docs/sdks/v1/README.md)
|
|
282
|
+
|
|
283
|
+
* [postListDashboard](docs/sdks/v1/README.md#postlistdashboard) - Post List Dashboards
|
|
284
|
+
* [postGetDashboard](docs/sdks/v1/README.md#postgetdashboard) - Post Fetch Info
|
|
285
|
+
* [~~postSessionEventsDashboard~~](docs/sdks/v1/README.md#postsessioneventsdashboard) - Post Session Events :warning: **Deprecated**
|
|
286
|
+
* [~~postSessionSummaryDashboard~~](docs/sdks/v1/README.md#postsessionsummarydashboard) - Post Session Summary :warning: **Deprecated**
|
|
287
|
+
* [~~postSessionTransfersDashboard~~](docs/sdks/v1/README.md#postsessiontransfersdashboard) - Post Session Transfers :warning: **Deprecated**
|
|
288
|
+
* [~~postSessionsDashboard~~](docs/sdks/v1/README.md#postsessionsdashboard) - Post Sessions :warning: **Deprecated**
|
|
211
289
|
|
|
212
290
|
</details>
|
|
213
291
|
<!-- End Available Resources and Operations [operations] -->
|
|
@@ -227,6 +305,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
227
305
|
|
|
228
306
|
<summary>Available standalone functions</summary>
|
|
229
307
|
|
|
308
|
+
- [`agentsAgentGetAvailableVoices`](docs/sdks/agents/README.md#agentgetavailablevoices) - Get Available Agent Voices
|
|
230
309
|
- [`agentsCreate`](docs/sdks/agents/README.md#create) - Create Agent
|
|
231
310
|
- [`agentsDelete`](docs/sdks/agents/README.md#delete) - Delete Agent
|
|
232
311
|
- [`agentsGetById`](docs/sdks/agents/README.md#getbyid) - Get Agent By Id
|
|
@@ -246,15 +325,29 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
246
325
|
- [`customMessagesGetById`](docs/sdks/custommessages/README.md#getbyid) - Get Custom Message By Id
|
|
247
326
|
- [`customMessagesList`](docs/sdks/custommessages/README.md#list) - Custom Messages List
|
|
248
327
|
- [`customMessagesUpdate`](docs/sdks/custommessages/README.md#update) - Update Custom Message
|
|
249
|
-
- [`
|
|
250
|
-
- [`
|
|
251
|
-
- [`
|
|
252
|
-
- [`
|
|
253
|
-
- [`
|
|
254
|
-
- [`
|
|
255
|
-
- [`
|
|
256
|
-
- [`dashboardsTotalCallVolumeByWeekday`](docs/sdks/dashboards/README.md#totalcallvolumebyweekday) - Get Total Call Volume By Weekday
|
|
328
|
+
- [`dashboardsPostGetDashboard`](docs/sdks/dashboards/README.md#postgetdashboard) - Post Fetch Info
|
|
329
|
+
- [`dashboardsPostListDashboard`](docs/sdks/dashboards/README.md#postlistdashboard) - Post List Dashboards
|
|
330
|
+
- [`dataSourcesCreate`](docs/sdks/datasources/README.md#create) - Create Data Source
|
|
331
|
+
- [`dataSourcesDelete`](docs/sdks/datasources/README.md#delete) - Delete Data Source
|
|
332
|
+
- [`dataSourcesGetById`](docs/sdks/datasources/README.md#getbyid) - Get Data Source
|
|
333
|
+
- [`dataSourcesList`](docs/sdks/datasources/README.md#list) - List Data Sources
|
|
334
|
+
- [`dataSourcesUpdate`](docs/sdks/datasources/README.md#update) - Update Data Source
|
|
257
335
|
- [`eventsList`](docs/sdks/events/README.md#list) - Events List
|
|
336
|
+
- [`insightsToolsCreate`](docs/sdks/syllablesdktools/README.md#create) - Create Insight Tool
|
|
337
|
+
- [`insightsToolsGetById`](docs/sdks/syllablesdktools/README.md#getbyid) - Get Insight Tool By Id
|
|
338
|
+
- [`insightsToolsInsightToolGetDefinitions`](docs/sdks/syllablesdktools/README.md#insighttoolgetdefinitions) - Get Insight Tool Definitions
|
|
339
|
+
- [`insightsToolsList`](docs/sdks/syllablesdktools/README.md#list) - Insight Tool List
|
|
340
|
+
- [`insightsToolsUpdate`](docs/sdks/syllablesdktools/README.md#update) - Update Insights Tool
|
|
341
|
+
- [`insightsWorkflowsCreate`](docs/sdks/workflows/README.md#create) - Create Insight Workflow
|
|
342
|
+
- [`insightsWorkflowsDelete`](docs/sdks/workflows/README.md#delete) - Delete Insights Workflow
|
|
343
|
+
- [`insightsWorkflowsGetById`](docs/sdks/workflows/README.md#getbyid) - Get Insight Workflow By Id
|
|
344
|
+
- [`insightsWorkflowsList`](docs/sdks/workflows/README.md#list) - Insight Workflow List
|
|
345
|
+
- [`insightsWorkflowsUpdate`](docs/sdks/workflows/README.md#update) - Update Insights Workflow
|
|
346
|
+
- [`languageGroupsCreate`](docs/sdks/languagegroups/README.md#create) - Create Language Group
|
|
347
|
+
- [`languageGroupsDelete`](docs/sdks/languagegroups/README.md#delete) - Delete Language Group
|
|
348
|
+
- [`languageGroupsGetById`](docs/sdks/languagegroups/README.md#getbyid) - Get Language Group
|
|
349
|
+
- [`languageGroupsList`](docs/sdks/languagegroups/README.md#list) - List Language Groups
|
|
350
|
+
- [`languageGroupsUpdate`](docs/sdks/languagegroups/README.md#update) - Update Language Group
|
|
258
351
|
- [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create Prompt
|
|
259
352
|
- [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete Prompt
|
|
260
353
|
- [`promptsGetById`](docs/sdks/prompts/README.md#getbyid) - Get Prompt By Id
|
|
@@ -262,20 +355,38 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
262
355
|
- [`promptsPromptsHistory`](docs/sdks/prompts/README.md#promptshistory) - Get Prompt History
|
|
263
356
|
- [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update Prompt
|
|
264
357
|
- [`servicesCreate`](docs/sdks/services/README.md#create) - Create Service
|
|
358
|
+
- [`servicesDelete`](docs/sdks/services/README.md#delete) - Delete Service
|
|
359
|
+
- [`servicesGetById`](docs/sdks/services/README.md#getbyid) - Get Service By Id
|
|
265
360
|
- [`servicesList`](docs/sdks/services/README.md#list) - Service List
|
|
266
361
|
- [`servicesUpdate`](docs/sdks/services/README.md#update) - Update Service
|
|
362
|
+
- [`sessionDebugGetSessionDataBySessionId`](docs/sdks/sessiondebug/README.md#getsessiondatabysessionid) - Get Session Data By Session Id
|
|
363
|
+
- [`sessionDebugGetSessionDataBySid`](docs/sdks/sessiondebug/README.md#getsessiondatabysid) - Get Session Data By Sid
|
|
364
|
+
- [`sessionDebugGetSessionToolCallResultById`](docs/sdks/sessiondebug/README.md#getsessiontoolcallresultbyid) - Get Session Tool Call Result By Id
|
|
267
365
|
- [`sessionLabelsCreate`](docs/sdks/sessionlabels/README.md#create) - Create Label
|
|
268
366
|
- [`sessionLabelsGetById`](docs/sdks/sessionlabels/README.md#getbyid) - Get Label By Id
|
|
269
367
|
- [`sessionLabelsList`](docs/sdks/sessionlabels/README.md#list) - Session Labels List
|
|
368
|
+
- [`sessionsFullSummaryGetById`](docs/sdks/fullsummary/README.md#getbyid) - Get Full Session Summary By Id
|
|
270
369
|
- [`sessionsGenerateSessionRecordingUrls`](docs/sdks/sessions/README.md#generatesessionrecordingurls) - Generate Recording Urls
|
|
271
370
|
- [`sessionsGetById`](docs/sdks/sessions/README.md#getbyid) - Get A Single Session By Id
|
|
272
371
|
- [`sessionsList`](docs/sdks/sessions/README.md#list) - Sessions List
|
|
273
372
|
- [`sessionsSessionRecordingStream`](docs/sdks/sessions/README.md#sessionrecordingstream) - Stream Recording
|
|
373
|
+
- [`sessionsSummaryGetById`](docs/sdks/summary/README.md#getbyid) - Get Session Summary By Id
|
|
274
374
|
- [`sessionsTranscriptGetById`](docs/sdks/transcript/README.md#getbyid) - Get Session Transcript By Id
|
|
275
375
|
- [`toolsCreate`](docs/sdks/tools/README.md#create) - Create Tool
|
|
376
|
+
- [`toolsDelete`](docs/sdks/tools/README.md#delete) - Delete Tool
|
|
276
377
|
- [`toolsGetByName`](docs/sdks/tools/README.md#getbyname) - Tool Info
|
|
277
378
|
- [`toolsList`](docs/sdks/tools/README.md#list) - Tool List
|
|
278
379
|
- [`toolsUpdate`](docs/sdks/tools/README.md#update) - Update Tool
|
|
380
|
+
- [`v1PostGetDashboard`](docs/sdks/v1/README.md#postgetdashboard) - Post Fetch Info
|
|
381
|
+
- [`v1PostListDashboard`](docs/sdks/v1/README.md#postlistdashboard) - Post List Dashboards
|
|
382
|
+
- ~~[`dashboardsPostSessionEventsDashboard`](docs/sdks/dashboards/README.md#postsessioneventsdashboard)~~ - Post Session Events :warning: **Deprecated**
|
|
383
|
+
- ~~[`dashboardsPostSessionsDashboard`](docs/sdks/dashboards/README.md#postsessionsdashboard)~~ - Post Sessions :warning: **Deprecated**
|
|
384
|
+
- ~~[`dashboardsPostSessionSummaryDashboard`](docs/sdks/dashboards/README.md#postsessionsummarydashboard)~~ - Post Session Summary :warning: **Deprecated**
|
|
385
|
+
- ~~[`dashboardsPostSessionTransfersDashboard`](docs/sdks/dashboards/README.md#postsessiontransfersdashboard)~~ - Post Session Transfers :warning: **Deprecated**
|
|
386
|
+
- ~~[`v1PostSessionEventsDashboard`](docs/sdks/v1/README.md#postsessioneventsdashboard)~~ - Post Session Events :warning: **Deprecated**
|
|
387
|
+
- ~~[`v1PostSessionsDashboard`](docs/sdks/v1/README.md#postsessionsdashboard)~~ - Post Sessions :warning: **Deprecated**
|
|
388
|
+
- ~~[`v1PostSessionSummaryDashboard`](docs/sdks/v1/README.md#postsessionsummarydashboard)~~ - Post Session Summary :warning: **Deprecated**
|
|
389
|
+
- ~~[`v1PostSessionTransfersDashboard`](docs/sdks/v1/README.md#postsessiontransfersdashboard)~~ - Post Session Transfers :warning: **Deprecated**
|
|
279
390
|
|
|
280
391
|
</details>
|
|
281
392
|
<!-- End Standalone functions [standalone-funcs] -->
|
|
@@ -294,7 +405,17 @@ const syllableSDK = new SyllableSDK({
|
|
|
294
405
|
});
|
|
295
406
|
|
|
296
407
|
async function run() {
|
|
297
|
-
const result = await syllableSDK.agents.list({
|
|
408
|
+
const result = await syllableSDK.agents.list({
|
|
409
|
+
page: 0,
|
|
410
|
+
searchFields: [
|
|
411
|
+
"name",
|
|
412
|
+
],
|
|
413
|
+
searchFieldValues: [
|
|
414
|
+
"Some Object Name",
|
|
415
|
+
],
|
|
416
|
+
startDatetime: "2023-01-01T00:00:00Z",
|
|
417
|
+
endDatetime: "2024-01-01T00:00:00Z",
|
|
418
|
+
}, {
|
|
298
419
|
retries: {
|
|
299
420
|
strategy: "backoff",
|
|
300
421
|
backoff: {
|
|
@@ -334,7 +455,17 @@ const syllableSDK = new SyllableSDK({
|
|
|
334
455
|
});
|
|
335
456
|
|
|
336
457
|
async function run() {
|
|
337
|
-
const result = await syllableSDK.agents.list({
|
|
458
|
+
const result = await syllableSDK.agents.list({
|
|
459
|
+
page: 0,
|
|
460
|
+
searchFields: [
|
|
461
|
+
"name",
|
|
462
|
+
],
|
|
463
|
+
searchFieldValues: [
|
|
464
|
+
"Some Object Name",
|
|
465
|
+
],
|
|
466
|
+
startDatetime: "2023-01-01T00:00:00Z",
|
|
467
|
+
endDatetime: "2024-01-01T00:00:00Z",
|
|
468
|
+
});
|
|
338
469
|
|
|
339
470
|
// Handle the result
|
|
340
471
|
console.log(result);
|
|
@@ -348,25 +479,15 @@ run();
|
|
|
348
479
|
<!-- Start Error Handling [errors] -->
|
|
349
480
|
## Error Handling
|
|
350
481
|
|
|
351
|
-
All
|
|
352
|
-
|
|
353
|
-
If a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:
|
|
354
|
-
|
|
355
|
-
| HTTP Client Error | Description |
|
|
356
|
-
| ---------------------------------------------------- | ---------------------------------------------------- |
|
|
357
|
-
| RequestAbortedError | HTTP request was aborted by the client |
|
|
358
|
-
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
|
|
359
|
-
| ConnectionError | HTTP client was unable to make a request to a server |
|
|
360
|
-
| InvalidRequestError | Any input used to create a request is invalid |
|
|
361
|
-
| UnexpectedClientError | Unrecognised or unexpected error |
|
|
362
|
-
|
|
363
|
-
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:
|
|
482
|
+
Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `list` method may throw the following errors:
|
|
364
483
|
|
|
365
484
|
| Error Type | Status Code | Content Type |
|
|
366
485
|
| -------------------------- | ----------- | ---------------- |
|
|
367
486
|
| errors.HTTPValidationError | 422 | application/json |
|
|
368
487
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
369
488
|
|
|
489
|
+
If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.
|
|
490
|
+
|
|
370
491
|
```typescript
|
|
371
492
|
import { SyllableSDK } from "syllable-sdk";
|
|
372
493
|
import {
|
|
@@ -381,14 +502,25 @@ const syllableSDK = new SyllableSDK({
|
|
|
381
502
|
async function run() {
|
|
382
503
|
let result;
|
|
383
504
|
try {
|
|
384
|
-
result = await syllableSDK.agents.list({
|
|
505
|
+
result = await syllableSDK.agents.list({
|
|
506
|
+
page: 0,
|
|
507
|
+
searchFields: [
|
|
508
|
+
"name",
|
|
509
|
+
],
|
|
510
|
+
searchFieldValues: [
|
|
511
|
+
"Some Object Name",
|
|
512
|
+
],
|
|
513
|
+
startDatetime: "2023-01-01T00:00:00Z",
|
|
514
|
+
endDatetime: "2024-01-01T00:00:00Z",
|
|
515
|
+
});
|
|
385
516
|
|
|
386
517
|
// Handle the result
|
|
387
518
|
console.log(result);
|
|
388
519
|
} catch (err) {
|
|
389
520
|
switch (true) {
|
|
521
|
+
// The server response does not match the expected SDK schema
|
|
390
522
|
case (err instanceof SDKValidationError): {
|
|
391
|
-
//
|
|
523
|
+
// Pretty-print will provide a human-readable multi-line error message
|
|
392
524
|
console.error(err.pretty());
|
|
393
525
|
// Raw value may also be inspected
|
|
394
526
|
console.error(err.rawValue);
|
|
@@ -400,6 +532,7 @@ async function run() {
|
|
|
400
532
|
return;
|
|
401
533
|
}
|
|
402
534
|
default: {
|
|
535
|
+
// Other errors such as network errors, see HTTPClientErrors for more details
|
|
403
536
|
throw err;
|
|
404
537
|
}
|
|
405
538
|
}
|
|
@@ -410,42 +543,22 @@ run();
|
|
|
410
543
|
|
|
411
544
|
```
|
|
412
545
|
|
|
413
|
-
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.
|
|
546
|
+
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 multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
|
547
|
+
|
|
548
|
+
In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
|
|
549
|
+
|
|
550
|
+
| HTTP Client Error | Description |
|
|
551
|
+
| ---------------------------------------------------- | ---------------------------------------------------- |
|
|
552
|
+
| RequestAbortedError | HTTP request was aborted by the client |
|
|
553
|
+
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
|
|
554
|
+
| ConnectionError | HTTP client was unable to make a request to a server |
|
|
555
|
+
| InvalidRequestError | Any input used to create a request is invalid |
|
|
556
|
+
| UnexpectedClientError | Unrecognised or unexpected error |
|
|
414
557
|
<!-- End Error Handling [errors] -->
|
|
415
558
|
|
|
416
559
|
<!-- Start Server Selection [server] -->
|
|
417
560
|
## Server Selection
|
|
418
561
|
|
|
419
|
-
### Select Server by Index
|
|
420
|
-
|
|
421
|
-
You can override the default server globally by passing a server index to the `serverIdx: number` 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:
|
|
422
|
-
|
|
423
|
-
| # | Server |
|
|
424
|
-
| --- | ----------------------- |
|
|
425
|
-
| 0 | `http://localhost:8001` |
|
|
426
|
-
| 1 | `http://localhost:8001` |
|
|
427
|
-
|
|
428
|
-
#### Example
|
|
429
|
-
|
|
430
|
-
```typescript
|
|
431
|
-
import { SyllableSDK } from "syllable-sdk";
|
|
432
|
-
|
|
433
|
-
const syllableSDK = new SyllableSDK({
|
|
434
|
-
serverIdx: 1,
|
|
435
|
-
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
436
|
-
});
|
|
437
|
-
|
|
438
|
-
async function run() {
|
|
439
|
-
const result = await syllableSDK.agents.list({});
|
|
440
|
-
|
|
441
|
-
// Handle the result
|
|
442
|
-
console.log(result);
|
|
443
|
-
}
|
|
444
|
-
|
|
445
|
-
run();
|
|
446
|
-
|
|
447
|
-
```
|
|
448
|
-
|
|
449
562
|
### Override Server URL Per-Client
|
|
450
563
|
|
|
451
564
|
The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
|
@@ -453,12 +566,22 @@ The default server can also be overridden globally by passing a URL to the `serv
|
|
|
453
566
|
import { SyllableSDK } from "syllable-sdk";
|
|
454
567
|
|
|
455
568
|
const syllableSDK = new SyllableSDK({
|
|
456
|
-
serverURL: "
|
|
569
|
+
serverURL: "https://api.syllable.cloud",
|
|
457
570
|
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
|
|
458
571
|
});
|
|
459
572
|
|
|
460
573
|
async function run() {
|
|
461
|
-
const result = await syllableSDK.agents.list({
|
|
574
|
+
const result = await syllableSDK.agents.list({
|
|
575
|
+
page: 0,
|
|
576
|
+
searchFields: [
|
|
577
|
+
"name",
|
|
578
|
+
],
|
|
579
|
+
searchFieldValues: [
|
|
580
|
+
"Some Object Name",
|
|
581
|
+
],
|
|
582
|
+
startDatetime: "2023-01-01T00:00:00Z",
|
|
583
|
+
endDatetime: "2024-01-01T00:00:00Z",
|
|
584
|
+
});
|
|
462
585
|
|
|
463
586
|
// Handle the result
|
|
464
587
|
console.log(result);
|
|
@@ -538,7 +661,17 @@ const syllableSDK = new SyllableSDK({
|
|
|
538
661
|
});
|
|
539
662
|
|
|
540
663
|
async function run() {
|
|
541
|
-
const result = await syllableSDK.agents.list({
|
|
664
|
+
const result = await syllableSDK.agents.list({
|
|
665
|
+
page: 0,
|
|
666
|
+
searchFields: [
|
|
667
|
+
"name",
|
|
668
|
+
],
|
|
669
|
+
searchFieldValues: [
|
|
670
|
+
"Some Object Name",
|
|
671
|
+
],
|
|
672
|
+
startDatetime: "2023-01-01T00:00:00Z",
|
|
673
|
+
endDatetime: "2024-01-01T00:00:00Z",
|
|
674
|
+
});
|
|
542
675
|
|
|
543
676
|
// Handle the result
|
|
544
677
|
console.log(result);
|