├── .DS_Store ├── .devcontainer ├── README.md ├── devcontainer.json └── setup.sh ├── .gitattributes ├── .github └── workflows │ ├── sdk_generation.yaml │ ├── sdk_generation_merge.yaml │ ├── sdk_generation_test.yaml │ └── sdk_publish.yaml ├── .gitignore ├── .npmignore ├── .speakeasy ├── gen.lock ├── gen.yaml ├── workflow.lock └── workflow.yaml ├── CONTRIBUTING.md ├── FUNCTIONS.md ├── README.md ├── RELEASES.md ├── RUNTIMES.md ├── USAGE.md ├── api-reference ├── introduction.mdx ├── models │ ├── agent.md │ ├── agentcreate.md │ ├── agentcreatetypeextra.md │ ├── agentcreatevariables.md │ ├── agentdeleterequest.md │ ├── agentgetbyidrequest.md │ ├── agentlistrequest.md │ ├── agentlistresponse.md │ ├── anyofschema1validator.md │ ├── attributes.md │ ├── availabletarget.md │ ├── availabletargetslistresponse.md │ ├── availabletargetsrequest.md │ ├── channel.md │ ├── channellistresponse.md │ ├── channelsdeleterequest.md │ ├── channelslistrequest.md │ ├── channelstargetupdaterequest.md │ ├── channeltarget.md │ ├── channeltargetcreaterequest.md │ ├── channeltargetlistresponse.md │ ├── channeltargetscreaterequest.md │ ├── channeltargetsgetbyidrequest.md │ ├── channeltargetslistrequest.md │ ├── chatmessage.md │ ├── chatmessageresponse.md │ ├── conversation.md │ ├── conversationaction.md │ ├── conversationgetbyidrequest.md │ ├── conversationlistresponse.md │ ├── conversationslistrequest.md │ ├── conversationtext.md │ ├── conversationtranscriptionresponse.md │ ├── defaults.md │ ├── event.md │ ├── eventlistresponse.md │ ├── eventslistrequest.md │ ├── function.md │ ├── getdailycallvolumebyhourresponsegetdailycallvolumebyhour.md │ ├── getmonthlycallvolumebydayresponsegetmonthlycallvolumebyday.md │ ├── getmonthlycallvolumebyweekresponsegetmonthlycallvolumebyweek.md │ ├── getsessionagentsresponsegetsessionagents.md │ ├── getsessionsummaryrequest.md │ ├── getsessionsummaryresponsegetsessionsummary.md │ ├── gettotalcallvolumebyhourresponsegettotalcallvolumebyhour.md │ ├── getweeklycallvolumebyweekdayresponsegetweeklycallvolumebyweekday.md │ ├── greeting.md │ ├── greetingcreate.md │ ├── greetinglistresponse.md │ ├── greetingresponse.md │ ├── greetingsdeleterequest.md │ ├── greetingsgetbyidrequest.md │ ├── greetingslistrequest.md │ ├── httpendpoint.md │ ├── httpvalidationerror.md │ ├── llmconfig.md │ ├── loc.md │ ├── organization.md │ ├── parameters.md │ ├── prompt.md │ ├── promptcreate.md │ ├── promptlistresponse.md │ ├── promptsdeleterequest.md │ ├── promptsgetbyidrequest.md │ ├── promptslistrequest.md │ ├── provider.md │ ├── response.md │ ├── result.md │ ├── schemasbubblegumv2toolstool.md │ ├── schemascortexv1toolstool.md │ ├── security.md │ ├── session.md │ ├── sessionlistresponse.md │ ├── sessionslistrequest.md │ ├── tooldetailresponse.md │ ├── toolgetbynamerequest.md │ ├── toollistrequest.md │ ├── toollistresponse.md │ ├── toolparameterdefault.md │ ├── toolparametertransform.md │ ├── toolparametertransformcondition.md │ ├── totalcallvolumebyweekdayresponsetotalcallvolumebyweekday.md │ ├── typeextra.md │ ├── utils │ │ └── retryconfig.md │ ├── validationerror.md │ └── variables.md ├── openapi.json └── sdks │ ├── agents │ └── README.md │ ├── availabletargets │ └── README.md │ ├── channels │ └── README.md │ ├── chats │ └── README.md │ ├── conversations │ └── README.md │ ├── dashboards │ └── README.md │ ├── events │ └── README.md │ ├── greetings │ └── README.md │ ├── organizations │ └── README.md │ ├── prompts │ └── README.md │ ├── sessions │ └── README.md │ ├── syllable │ └── README.md │ ├── targets │ └── README.md │ └── tools │ └── README.md ├── codeSamples.yaml ├── docs ├── lib │ └── utils │ │ └── retryconfig.md ├── models │ ├── components │ │ ├── action.md │ │ ├── agentcreate.md │ │ ├── agentlanguage.md │ │ ├── agentproperties.md │ │ ├── agentresponse.md │ │ ├── agentsttprovider.md │ │ ├── agenttooldefaults.md │ │ ├── agenttoolfielddefault.md │ │ ├── agentupdate.md │ │ ├── agentvoice.md │ │ ├── agentvoicedisplayname.md │ │ ├── agentvoicegender.md │ │ ├── agentvoicemodel.md │ │ ├── agentvoicevarname.md │ │ ├── agentwaitsound.md │ │ ├── attributes.md │ │ ├── availabletarget.md │ │ ├── availabletargetproperties.md │ │ ├── batchdetails.md │ │ ├── batchproperties.md │ │ ├── batchstatus.md │ │ ├── bodyoutboundbatchdelete.md │ │ ├── bodyoutboundbatchupload.md │ │ ├── campaignproperties.md │ │ ├── channel.md │ │ ├── channelproperties.md │ │ ├── channelservices.md │ │ ├── channeltargetcreaterequest.md │ │ ├── channeltargetproperties.md │ │ ├── channeltargetresponse.md │ │ ├── channeltargetupdaterequest.md │ │ ├── communicationbatch.md │ │ ├── communicationbatchinput.md │ │ ├── communicationbatchupdate.md │ │ ├── communicationrequest.md │ │ ├── communicationrequestrequestvariables.md │ │ ├── communicationrequestresult.md │ │ ├── conditions.md │ │ ├── conversation.md │ │ ├── conversationproperties.md │ │ ├── createtakeoutresponse.md │ │ ├── custommessagecreaterequest.md │ │ ├── custommessageproperties.md │ │ ├── custommessageresponse.md │ │ ├── custommessagerule.md │ │ ├── custommessageupdaterequest.md │ │ ├── dashboard.md │ │ ├── dashboardproperties.md │ │ ├── dashboardresponse.md │ │ ├── dashboardtokenresponse.md │ │ ├── datasourcecreaterequest.md │ │ ├── datasourcedetailresponse.md │ │ ├── datasourcemetadataresponse.md │ │ ├── datasourceproperties.md │ │ ├── datasourceupdaterequest.md │ │ ├── dayofweek.md │ │ ├── daysofweek.md │ │ ├── defaults.md │ │ ├── dialogmessage.md │ │ ├── dialogrole.md │ │ ├── dialogtoolcall.md │ │ ├── event.md │ │ ├── eventproperties.md │ │ ├── filet.md │ │ ├── incidentcreaterequest.md │ │ ├── incidentorganizationresponse.md │ │ ├── incidentproperties.md │ │ ├── incidentresponse.md │ │ ├── incidentupdaterequest.md │ │ ├── insights.md │ │ ├── insightsoutput.md │ │ ├── insightsproperties.md │ │ ├── insightsworkflowqueuesession.md │ │ ├── insighttooldefinition.md │ │ ├── insighttoolinput.md │ │ ├── insighttoolinputtoolarguments.md │ │ ├── insighttooloutput.md │ │ ├── insighttoolproperties.md │ │ ├── insighttooltestinput.md │ │ ├── insightworkflowinput.md │ │ ├── insightworkflowinputconditions.md │ │ ├── insightworkflowoutput.md │ │ ├── insightworkflowproperties.md │ │ ├── inspectlatencyresponse.md │ │ ├── internaltool.md │ │ ├── jsonvalue.md │ │ ├── languagecode.md │ │ ├── languageconfig.md │ │ ├── languagegroupagentinfo.md │ │ ├── languagegroupcreaterequest.md │ │ ├── languagegroupproperties.md │ │ ├── languagegroupresponse.md │ │ ├── languagegroupupdaterequest.md │ │ ├── latencycategory.md │ │ ├── latencyentry.md │ │ ├── latencyunittype.md │ │ ├── listresponseagentresponse.md │ │ ├── listresponseavailabletarget.md │ │ ├── listresponsechannel.md │ │ ├── listresponsechanneltargetresponse.md │ │ ├── listresponsecommunicationbatch.md │ │ ├── listresponseconversation.md │ │ ├── listresponsecustommessageresponse.md │ │ ├── listresponsedashboardresponse.md │ │ ├── listresponsedatasourcemetadataresponse.md │ │ ├── listresponseevent.md │ │ ├── listresponseincidentresponse.md │ │ ├── listresponseinsightsoutput.md │ │ ├── listresponseinsighttooloutput.md │ │ ├── listresponseinsightworkflowoutput.md │ │ ├── listresponselanguagegroupresponse.md │ │ ├── listresponseoutboundcampaign.md │ │ ├── listresponsepromptresponse.md │ │ ├── listresponseserviceresponse.md │ │ ├── listresponsesession.md │ │ ├── listresponsesessionlabel.md │ │ ├── listresponsetoolresponse.md │ │ ├── loc.md │ │ ├── orderbydirection.md │ │ ├── outboundcampaign.md │ │ ├── outboundcampaigninput.md │ │ ├── promptcreaterequest.md │ │ ├── prompthistory.md │ │ ├── promptllmconfig.md │ │ ├── promptllmprovider.md │ │ ├── promptproperties.md │ │ ├── promptresponse.md │ │ ├── promptupdaterequest.md │ │ ├── requeststatus.md │ │ ├── requestvariables.md │ │ ├── response.md │ │ ├── security.md │ │ ├── servicecreaterequest.md │ │ ├── serviceproperties.md │ │ ├── serviceresponse.md │ │ ├── serviceupdaterequest.md │ │ ├── session.md │ │ ├── sessionaction.md │ │ ├── sessiondata.md │ │ ├── sessionlabel.md │ │ ├── sessionlabelcreate.md │ │ ├── sessionlabelproperties.md │ │ ├── sessionmessage.md │ │ ├── sessionproperties.md │ │ ├── sessionrecordingresponse.md │ │ ├── sessionsummaryresponse.md │ │ ├── sessiontext.md │ │ ├── sessiontranscriptionresponse.md │ │ ├── statictoolparameter.md │ │ ├── statictoolparametertype.md │ │ ├── summaryentry.md │ │ ├── supportedllm.md │ │ ├── takeoutrequeststatus.md │ │ ├── takeoutstatusresponse.md │ │ ├── targetmodes.md │ │ ├── testmessage.md │ │ ├── testmessageresponse.md │ │ ├── toolagentinfo.md │ │ ├── toolargumentlocation.md │ │ ├── toolarguments.md │ │ ├── toolcreaterequest.md │ │ ├── tooldefinition.md │ │ ├── tooldetailresponse.md │ │ ├── toolfunction.md │ │ ├── toolhttpendpoint.md │ │ ├── toolhttpmethod.md │ │ ├── toolparameterdefault.md │ │ ├── toolparameters.md │ │ ├── toolparametertransform.md │ │ ├── toolparametertransformcondition.md │ │ ├── toolpromptinfo.md │ │ ├── toolproperties.md │ │ ├── toolresponse.md │ │ ├── toolresultdata.md │ │ ├── toolresultset.md │ │ ├── toolupdaterequest.md │ │ ├── ttsprovider.md │ │ ├── type.md │ │ └── validationerror.md │ ├── errors │ │ └── httpvalidationerror.md │ └── operations │ │ ├── agentdeleterequest.md │ │ ├── agentgetbyidrequest.md │ │ ├── agentlistrequest.md │ │ ├── availabletargetsrequest.md │ │ ├── channelslistrequest.md │ │ ├── channeltargetscreaterequest.md │ │ ├── channeltargetsdeleterequest.md │ │ ├── channeltargetsgetbyidrequest.md │ │ ├── channeltargetslistrequest.md │ │ ├── channeltargetsupdaterequest.md │ │ ├── conversationslistrequest.md │ │ ├── custommessagegetbyidrequest.md │ │ ├── custommessagesdeleterequest.md │ │ ├── custommessageslistrequest.md │ │ ├── datasourcesdeleterequest.md │ │ ├── datasourcesgetbyidrequest.md │ │ ├── datasourceslistrequest.md │ │ ├── eventslistrequest.md │ │ ├── generatesessionrecordingurlsrequest.md │ │ ├── getsessiondatabysessionidrequest.md │ │ ├── getsessiondatabysidrequest.md │ │ ├── getsessiontoolcallresultbyidrequest.md │ │ ├── incidentdeleterequest.md │ │ ├── incidentgetbyidrequest.md │ │ ├── incidentlistrequest.md │ │ ├── insightslistrequest.md │ │ ├── insightstoolupdaterequest.md │ │ ├── insightsworkflowdeleterequest.md │ │ ├── insightsworkflowgetbyidrequest.md │ │ ├── insightsworkflowlistrequest.md │ │ ├── insightsworkflowupdaterequest.md │ │ ├── insighttoolgetbyidrequest.md │ │ ├── insighttoollistrequest.md │ │ ├── languagegroupsdeleterequest.md │ │ ├── languagegroupsgetbyidrequest.md │ │ ├── languagegroupslistrequest.md │ │ ├── outboundbatchaddrequest.md │ │ ├── outboundbatchdeleterequest.md │ │ ├── outboundbatchgetbyidrequest.md │ │ ├── outboundbatchlistrequest.md │ │ ├── outboundbatchremoverequest.md │ │ ├── outboundbatchresultsrequest.md │ │ ├── outboundbatchupdaterequest.md │ │ ├── outboundbatchuploadrequest.md │ │ ├── outboundcampaigngetbyidrequest.md │ │ ├── outboundcampaignlistrequest.md │ │ ├── outboundcampaignupdaterequest.md │ │ ├── postgetdashboardrequest.md │ │ ├── postlistdashboardrequest.md │ │ ├── promptsdeleterequest.md │ │ ├── promptsgetbyidrequest.md │ │ ├── promptshistoryrequest.md │ │ ├── promptslistrequest.md │ │ ├── queuesessionsworkflowresponsequeuesessionsworkflow.md │ │ ├── servicedeleterequest.md │ │ ├── servicelistrequest.md │ │ ├── servicesgetbyidrequest.md │ │ ├── sessionfullsummarygetbyidrequest.md │ │ ├── sessiongetbyidrequest.md │ │ ├── sessionlabelgetbyidrequest.md │ │ ├── sessionlabelslistrequest.md │ │ ├── sessionlatencygetbyidrequest.md │ │ ├── sessionrecordingstreamrequest.md │ │ ├── sessionslistrequest.md │ │ ├── sessiontranscriptgetbyidrequest.md │ │ ├── takeoutsgetbyjobidrequest.md │ │ ├── tooldeleterequest.md │ │ ├── toolgetbynamerequest.md │ │ └── toollistrequest.md ├── openapi.json └── sdks │ ├── agents │ └── README.md │ ├── batches │ └── README.md │ ├── campaigns │ └── README.md │ ├── channels │ └── README.md │ ├── conversations │ └── README.md │ ├── custommessages │ └── README.md │ ├── dashboards │ └── README.md │ ├── datasources │ └── README.md │ ├── events │ └── README.md │ ├── fullsummary │ └── README.md │ ├── incidents │ └── README.md │ ├── insights │ └── README.md │ ├── languagegroups │ └── README.md │ ├── latency │ └── README.md │ ├── outbound │ └── README.md │ ├── prompts │ └── README.md │ ├── services │ └── README.md │ ├── sessiondebug │ └── README.md │ ├── sessionlabels │ └── README.md │ ├── sessions │ └── README.md │ ├── syllablesdk │ └── README.md │ ├── syllablesdktools │ └── README.md │ ├── takeouts │ └── README.md │ ├── targets │ └── README.md │ ├── test │ └── README.md │ ├── tools │ └── README.md │ ├── transcript │ └── README.md │ └── workflows │ └── README.md ├── eslint.config.mjs ├── home.mdx ├── jsr.json ├── openapi-final.json ├── openapi.json ├── openapi.yaml ├── overlay-remove-V1.yaml ├── package-lock.json ├── package.json ├── sdk-docs ├── lib │ └── utils │ │ └── retryconfig.md └── models │ └── components │ └── agent.md ├── src ├── core.ts ├── funcs │ ├── agentsAgentGetAvailableVoices.ts │ ├── agentsCreate.ts │ ├── agentsDelete.ts │ ├── agentsGetById.ts │ ├── agentsList.ts │ ├── agentsTestSendTestMessage.ts │ ├── agentsUpdate.ts │ ├── channelsDelete.ts │ ├── channelsList.ts │ ├── channelsTargetsAvailableTargets.ts │ ├── channelsTargetsCreate.ts │ ├── channelsTargetsGetById.ts │ ├── channelsTargetsList.ts │ ├── channelsTargetsUpdate.ts │ ├── conversationsList.ts │ ├── customMessagesCreate.ts │ ├── customMessagesDelete.ts │ ├── customMessagesGetById.ts │ ├── customMessagesList.ts │ ├── customMessagesUpdate.ts │ ├── dashboardsPostGetDashboard.ts │ ├── dashboardsPostListDashboard.ts │ ├── dashboardsPostSessionEventsDashboard.ts │ ├── dashboardsPostSessionSummaryDashboard.ts │ ├── dashboardsPostSessionTransfersDashboard.ts │ ├── dashboardsPostSessionsDashboard.ts │ ├── dataSourcesCreate.ts │ ├── dataSourcesDelete.ts │ ├── dataSourcesGetById.ts │ ├── dataSourcesList.ts │ ├── dataSourcesUpdate.ts │ ├── eventsList.ts │ ├── incidentsCreate.ts │ ├── incidentsDelete.ts │ ├── incidentsGetById.ts │ ├── incidentsIncidentGetOrganizations.ts │ ├── incidentsList.ts │ ├── incidentsUpdate.ts │ ├── insightsList.ts │ ├── insightsToolsCreate.ts │ ├── insightsToolsGetById.ts │ ├── insightsToolsInsightToolGetDefinitions.ts │ ├── insightsToolsInsightsToolTest.ts │ ├── insightsToolsList.ts │ ├── insightsToolsUpdate.ts │ ├── insightsWorkflowsCreate.ts │ ├── insightsWorkflowsDelete.ts │ ├── insightsWorkflowsGetById.ts │ ├── insightsWorkflowsList.ts │ ├── insightsWorkflowsQueueSessionsWorkflow.ts │ ├── insightsWorkflowsUpdate.ts │ ├── languageGroupsCreate.ts │ ├── languageGroupsDelete.ts │ ├── languageGroupsGetById.ts │ ├── languageGroupsList.ts │ ├── languageGroupsUpdate.ts │ ├── outboundBatchesAdd.ts │ ├── outboundBatchesCreate.ts │ ├── outboundBatchesDelete.ts │ ├── outboundBatchesGetById.ts │ ├── outboundBatchesList.ts │ ├── outboundBatchesRemove.ts │ ├── outboundBatchesResults.ts │ ├── outboundBatchesUpdate.ts │ ├── outboundBatchesUpload.ts │ ├── outboundCampaignsCreate.ts │ ├── outboundCampaignsGetById.ts │ ├── outboundCampaignsList.ts │ ├── outboundCampaignsUpdate.ts │ ├── promptsCreate.ts │ ├── promptsDelete.ts │ ├── promptsGetById.ts │ ├── promptsList.ts │ ├── promptsPromptGetSupportedLlms.ts │ ├── promptsPromptsHistory.ts │ ├── promptsUpdate.ts │ ├── servicesCreate.ts │ ├── servicesDelete.ts │ ├── servicesGetById.ts │ ├── servicesList.ts │ ├── servicesUpdate.ts │ ├── sessionDebugGetSessionDataBySessionId.ts │ ├── sessionDebugGetSessionDataBySid.ts │ ├── sessionDebugGetSessionToolCallResultById.ts │ ├── sessionLabelsCreate.ts │ ├── sessionLabelsGetById.ts │ ├── sessionLabelsList.ts │ ├── sessionsFullSummaryGetById.ts │ ├── sessionsGenerateSessionRecordingUrls.ts │ ├── sessionsGetById.ts │ ├── sessionsLatencyGetById.ts │ ├── sessionsList.ts │ ├── sessionsSessionRecordingStream.ts │ ├── sessionsTranscriptGetById.ts │ ├── takeoutsCreate.ts │ ├── takeoutsTakeoutsGetByJobId.ts │ ├── toolsCreate.ts │ ├── toolsDelete.ts │ ├── toolsGetByName.ts │ ├── toolsList.ts │ └── toolsUpdate.ts ├── hooks │ ├── hooks.ts │ ├── index.ts │ ├── registration.ts │ └── types.ts ├── index.ts ├── lib │ ├── base64.ts │ ├── config.ts │ ├── dlv.ts │ ├── encodings.ts │ ├── env.ts │ ├── files.ts │ ├── http.ts │ ├── is-plain-object.ts │ ├── logger.ts │ ├── matchers.ts │ ├── primitives.ts │ ├── retries.ts │ ├── schemas.ts │ ├── sdks.ts │ ├── security.ts │ └── url.ts ├── models │ ├── components │ │ ├── agentcreate.ts │ │ ├── agentlanguage.ts │ │ ├── agentproperties.ts │ │ ├── agentresponse.ts │ │ ├── agentsttprovider.ts │ │ ├── agenttooldefaults.ts │ │ ├── agenttoolfielddefault.ts │ │ ├── agentupdate.ts │ │ ├── agentvoice.ts │ │ ├── agentvoicedisplayname.ts │ │ ├── agentvoicegender.ts │ │ ├── agentvoicemodel.ts │ │ ├── agentvoicevarname.ts │ │ ├── agentwaitsound.ts │ │ ├── availabletarget.ts │ │ ├── availabletargetproperties.ts │ │ ├── batchdetails.ts │ │ ├── batchproperties.ts │ │ ├── batchstatus.ts │ │ ├── bodyoutboundbatchdelete.ts │ │ ├── bodyoutboundbatchupload.ts │ │ ├── campaignproperties.ts │ │ ├── channel.ts │ │ ├── channelproperties.ts │ │ ├── channelservices.ts │ │ ├── channeltargetcreaterequest.ts │ │ ├── channeltargetproperties.ts │ │ ├── channeltargetresponse.ts │ │ ├── channeltargetupdaterequest.ts │ │ ├── communicationbatch.ts │ │ ├── communicationbatchinput.ts │ │ ├── communicationbatchupdate.ts │ │ ├── communicationrequest.ts │ │ ├── communicationrequestresult.ts │ │ ├── conversation.ts │ │ ├── conversationproperties.ts │ │ ├── createtakeoutresponse.ts │ │ ├── custommessagecreaterequest.ts │ │ ├── custommessageproperties.ts │ │ ├── custommessageresponse.ts │ │ ├── custommessagerule.ts │ │ ├── custommessageupdaterequest.ts │ │ ├── dashboard.ts │ │ ├── dashboardproperties.ts │ │ ├── dashboardresponse.ts │ │ ├── dashboardtokenresponse.ts │ │ ├── datasourcecreaterequest.ts │ │ ├── datasourcedetailresponse.ts │ │ ├── datasourcemetadataresponse.ts │ │ ├── datasourceproperties.ts │ │ ├── datasourceupdaterequest.ts │ │ ├── dayofweek.ts │ │ ├── daysofweek.ts │ │ ├── dialogmessage.ts │ │ ├── dialogrole.ts │ │ ├── dialogtoolcall.ts │ │ ├── event.ts │ │ ├── eventproperties.ts │ │ ├── incidentcreaterequest.ts │ │ ├── incidentorganizationresponse.ts │ │ ├── incidentproperties.ts │ │ ├── incidentresponse.ts │ │ ├── incidentupdaterequest.ts │ │ ├── index.ts │ │ ├── insightsoutput.ts │ │ ├── insightsproperties.ts │ │ ├── insightsworkflowqueuesession.ts │ │ ├── insighttooldefinition.ts │ │ ├── insighttoolinput.ts │ │ ├── insighttooloutput.ts │ │ ├── insighttoolproperties.ts │ │ ├── insighttooltestinput.ts │ │ ├── insightworkflowinput.ts │ │ ├── insightworkflowoutput.ts │ │ ├── insightworkflowproperties.ts │ │ ├── inspectlatencyresponse.ts │ │ ├── internaltool.ts │ │ ├── languagecode.ts │ │ ├── languageconfig.ts │ │ ├── languagegroupagentinfo.ts │ │ ├── languagegroupcreaterequest.ts │ │ ├── languagegroupproperties.ts │ │ ├── languagegroupresponse.ts │ │ ├── languagegroupupdaterequest.ts │ │ ├── latencycategory.ts │ │ ├── latencyentry.ts │ │ ├── latencyunittype.ts │ │ ├── listresponseagentresponse.ts │ │ ├── listresponseavailabletarget.ts │ │ ├── listresponsechannel.ts │ │ ├── listresponsechanneltargetresponse.ts │ │ ├── listresponsecommunicationbatch.ts │ │ ├── listresponseconversation.ts │ │ ├── listresponsecustommessageresponse.ts │ │ ├── listresponsedashboardresponse.ts │ │ ├── listresponsedatasourcemetadataresponse.ts │ │ ├── listresponseevent.ts │ │ ├── listresponseincidentresponse.ts │ │ ├── listresponseinsightsoutput.ts │ │ ├── listresponseinsighttooloutput.ts │ │ ├── listresponseinsightworkflowoutput.ts │ │ ├── listresponselanguagegroupresponse.ts │ │ ├── listresponseoutboundcampaign.ts │ │ ├── listresponsepromptresponse.ts │ │ ├── listresponseserviceresponse.ts │ │ ├── listresponsesession.ts │ │ ├── listresponsesessionlabel.ts │ │ ├── listresponsetoolresponse.ts │ │ ├── orderbydirection.ts │ │ ├── outboundcampaign.ts │ │ ├── outboundcampaigninput.ts │ │ ├── promptcreaterequest.ts │ │ ├── prompthistory.ts │ │ ├── promptllmconfig.ts │ │ ├── promptllmprovider.ts │ │ ├── promptproperties.ts │ │ ├── promptresponse.ts │ │ ├── promptupdaterequest.ts │ │ ├── requeststatus.ts │ │ ├── security.ts │ │ ├── servicecreaterequest.ts │ │ ├── serviceproperties.ts │ │ ├── serviceresponse.ts │ │ ├── serviceupdaterequest.ts │ │ ├── session.ts │ │ ├── sessionaction.ts │ │ ├── sessiondata.ts │ │ ├── sessionlabel.ts │ │ ├── sessionlabelcreate.ts │ │ ├── sessionlabelproperties.ts │ │ ├── sessionmessage.ts │ │ ├── sessionproperties.ts │ │ ├── sessionrecordingresponse.ts │ │ ├── sessionsummaryresponse.ts │ │ ├── sessiontext.ts │ │ ├── sessiontranscriptionresponse.ts │ │ ├── statictoolparameter.ts │ │ ├── statictoolparametertype.ts │ │ ├── summaryentry.ts │ │ ├── supportedllm.ts │ │ ├── takeoutrequeststatus.ts │ │ ├── takeoutstatusresponse.ts │ │ ├── targetmodes.ts │ │ ├── testmessage.ts │ │ ├── testmessageresponse.ts │ │ ├── toolagentinfo.ts │ │ ├── toolargumentlocation.ts │ │ ├── toolcreaterequest.ts │ │ ├── tooldefinition.ts │ │ ├── tooldetailresponse.ts │ │ ├── toolfunction.ts │ │ ├── toolhttpendpoint.ts │ │ ├── toolhttpmethod.ts │ │ ├── toolparameterdefault.ts │ │ ├── toolparametertransform.ts │ │ ├── toolparametertransformcondition.ts │ │ ├── toolpromptinfo.ts │ │ ├── toolproperties.ts │ │ ├── toolresponse.ts │ │ ├── toolresultdata.ts │ │ ├── toolupdaterequest.ts │ │ ├── ttsprovider.ts │ │ └── validationerror.ts │ ├── errors │ │ ├── httpclienterrors.ts │ │ ├── httpvalidationerror.ts │ │ ├── index.ts │ │ ├── sdkerror.ts │ │ └── sdkvalidationerror.ts │ └── operations │ │ ├── agentdelete.ts │ │ ├── agentgetbyid.ts │ │ ├── agentlist.ts │ │ ├── availabletargets.ts │ │ ├── channelslist.ts │ │ ├── channeltargetscreate.ts │ │ ├── channeltargetsdelete.ts │ │ ├── channeltargetsgetbyid.ts │ │ ├── channeltargetslist.ts │ │ ├── channeltargetsupdate.ts │ │ ├── conversationslist.ts │ │ ├── custommessagegetbyid.ts │ │ ├── custommessagesdelete.ts │ │ ├── custommessageslist.ts │ │ ├── datasourcesdelete.ts │ │ ├── datasourcesgetbyid.ts │ │ ├── datasourceslist.ts │ │ ├── eventslist.ts │ │ ├── generatesessionrecordingurls.ts │ │ ├── getsessiondatabysessionid.ts │ │ ├── getsessiondatabysid.ts │ │ ├── getsessiontoolcallresultbyid.ts │ │ ├── incidentdelete.ts │ │ ├── incidentgetbyid.ts │ │ ├── incidentlist.ts │ │ ├── index.ts │ │ ├── insightslist.ts │ │ ├── insightstoolupdate.ts │ │ ├── insightsworkflowdelete.ts │ │ ├── insightsworkflowgetbyid.ts │ │ ├── insightsworkflowlist.ts │ │ ├── insightsworkflowupdate.ts │ │ ├── insighttoolgetbyid.ts │ │ ├── insighttoollist.ts │ │ ├── languagegroupsdelete.ts │ │ ├── languagegroupsgetbyid.ts │ │ ├── languagegroupslist.ts │ │ ├── outboundbatchadd.ts │ │ ├── outboundbatchdelete.ts │ │ ├── outboundbatchgetbyid.ts │ │ ├── outboundbatchlist.ts │ │ ├── outboundbatchremove.ts │ │ ├── outboundbatchresults.ts │ │ ├── outboundbatchupdate.ts │ │ ├── outboundbatchupload.ts │ │ ├── outboundcampaigngetbyid.ts │ │ ├── outboundcampaignlist.ts │ │ ├── outboundcampaignupdate.ts │ │ ├── postgetdashboard.ts │ │ ├── postlistdashboard.ts │ │ ├── promptsdelete.ts │ │ ├── promptsgetbyid.ts │ │ ├── promptshistory.ts │ │ ├── promptslist.ts │ │ ├── queuesessionsworkflow.ts │ │ ├── servicedelete.ts │ │ ├── servicelist.ts │ │ ├── servicesgetbyid.ts │ │ ├── sessionfullsummarygetbyid.ts │ │ ├── sessiongetbyid.ts │ │ ├── sessionlabelgetbyid.ts │ │ ├── sessionlabelslist.ts │ │ ├── sessionlatencygetbyid.ts │ │ ├── sessionrecordingstream.ts │ │ ├── sessionslist.ts │ │ ├── sessiontranscriptgetbyid.ts │ │ ├── takeoutsgetbyjobid.ts │ │ ├── tooldelete.ts │ │ ├── toolgetbyname.ts │ │ └── toollist.ts ├── sdk │ ├── agents.ts │ ├── batches.ts │ ├── campaigns.ts │ ├── channels.ts │ ├── conversations.ts │ ├── custommessages.ts │ ├── dashboards.ts │ ├── datasources.ts │ ├── events.ts │ ├── fullsummary.ts │ ├── incidents.ts │ ├── index.ts │ ├── insights.ts │ ├── languagegroups.ts │ ├── latency.ts │ ├── outbound.ts │ ├── prompts.ts │ ├── sdk.ts │ ├── services.ts │ ├── sessiondebug.ts │ ├── sessionlabels.ts │ ├── sessions.ts │ ├── syllablesdktools.ts │ ├── takeouts.ts │ ├── targets.ts │ ├── test.ts │ ├── tools.ts │ ├── transcript.ts │ └── workflows.ts └── types │ ├── blobs.ts │ ├── constdatetime.ts │ ├── enums.ts │ ├── fp.ts │ ├── index.ts │ ├── operations.ts │ ├── rfcdate.ts │ └── streams.ts ├── test └── sdk │ └── contract │ ├── agents.test.ts │ ├── custommessages.test.ts │ ├── helper.ts │ └── prompts.test.ts ├── tools ├── concat_all_docs.sh └── install_docs_op.sh └── tsconfig.json /.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CodeMaster0099/fe_typescript/adf18a9285c1fe3463e52d4440142f6e6d5f2c2b/.DS_Store -------------------------------------------------------------------------------- /.devcontainer/README.md: -------------------------------------------------------------------------------- 1 | 2 |
3 | 4 |
5 |
6 | 7 | > **Remember to shutdown a GitHub Codespace when it is not in use!** 8 | 9 | # Dev Containers Quick Start 10 | 11 | The default location for usage snippets is the `samples` directory. 12 | 13 | ## Running a Usage Sample 14 | 15 | A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below. 16 | 17 | ``` 18 | ts-node root.ts 19 | ``` 20 | 21 | ## Generating Additional Usage Samples 22 | 23 | The speakeasy CLI allows you to generate more usage snippets. Here's how: 24 | 25 | - To generate a sample for a specific operation by providing an operation ID, use: 26 | 27 | ``` 28 | speakeasy generate usage -s openapi.yaml -l typescript -i {INPUT_OPERATION_ID} -o ./samples 29 | ``` 30 | 31 | - To generate samples for an entire namespace (like a tag or group name), use: 32 | 33 | ``` 34 | speakeasy generate usage -s openapi.yaml -l typescript -n {INPUT_TAG_NAME} -o ./samples 35 | ``` 36 | -------------------------------------------------------------------------------- /.devcontainer/setup.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Install the speakeasy CLI 4 | curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/install.sh | sh 5 | 6 | # Setup samples directory 7 | rmdir samples || true 8 | mkdir samples 9 | 10 | npm install 11 | npm install -g ts-node 12 | npm link 13 | npm link syllable-sdk 14 | TS_CONFIG_CONTENT=$(cat < samples/tsconfig.json 28 | 29 | # Generate starter usage sample with speakeasy 30 | speakeasy generate usage -s openapi.yaml -l typescript -o samples/root.ts -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # This allows generated code to be indexed correctly 2 | *.ts linguist-generated=false -------------------------------------------------------------------------------- /.github/workflows/sdk_generation.yaml: -------------------------------------------------------------------------------- 1 | name: Generate 2 | permissions: 3 | checks: write 4 | contents: write 5 | pull-requests: write 6 | statuses: write 7 | "on": 8 | push: 9 | branches: 10 | - main 11 | paths: 12 | - openapi.json 13 | - overlay-remove-V1.yaml 14 | workflow_dispatch: 15 | inputs: 16 | force: 17 | description: Force generation of SDKs 18 | type: boolean 19 | default: false 20 | set_version: 21 | description: optionally set a specific SDK version 22 | type: string 23 | target: 24 | description: 'optionally: set a specific target to generate, default is all' 25 | type: string 26 | jobs: 27 | generate: 28 | uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15 29 | with: 30 | force: ${{ github.event.inputs.force }} 31 | mode: pr 32 | set_version: ${{ github.event.inputs.set_version }} 33 | target: ${{ github.event.inputs.target }} 34 | secrets: 35 | github_access_token: ${{ secrets.GITHUB_TOKEN }} 36 | npm_token: ${{ secrets.NPM_TOKEN }} 37 | speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} 38 | -------------------------------------------------------------------------------- /.github/workflows/sdk_generation_merge.yaml: -------------------------------------------------------------------------------- 1 | name: Auto-merge Speakeasy Bot PR to generate SDK 2 | 3 | on: pull_request 4 | 5 | permissions: 6 | contents: write 7 | pull-requests: write 8 | 9 | jobs: 10 | print-details: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: Print PR details 14 | run: echo "GitHub author ${{ github.actor }}" 15 | - name: Print PR URL 16 | run: echo "PR URL ${{ github.event.pull_request.html_url }}" 17 | 18 | auto-merge: 19 | runs-on: ubuntu-latest 20 | if: ${{ github.actor == 'speakeasy-github[bot]' }} 21 | steps: 22 | - name: Enable Auto-Merge 23 | run: gh pr merge --auto --rebase "$PR_URL" 24 | env: 25 | PR_URL: ${{ github.event.pull_request.html_url }} 26 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 27 | -------------------------------------------------------------------------------- /.github/workflows/sdk_generation_test.yaml: -------------------------------------------------------------------------------- 1 | name: Generate (Test) 2 | permissions: 3 | checks: write 4 | contents: write 5 | pull-requests: write 6 | statuses: write 7 | "on": 8 | workflow_dispatch: 9 | inputs: 10 | force: 11 | description: Force generation of SDKs 12 | type: boolean 13 | default: false 14 | set_version: 15 | description: optionally set a specific SDK version 16 | type: string 17 | target: 18 | description: 'optionally: set a specific target to generate, default is all' 19 | type: string 20 | jobs: 21 | generate: 22 | uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15 23 | with: 24 | force: ${{ github.event.inputs.force }} 25 | mode: pr 26 | set_version: ${{ github.event.inputs.set_version }} 27 | target: ${{ github.event.inputs.target }} 28 | secrets: 29 | github_access_token: ${{ secrets.GITHUB_TOKEN }} 30 | speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} -------------------------------------------------------------------------------- /.github/workflows/sdk_publish.yaml: -------------------------------------------------------------------------------- 1 | name: Publish 2 | permissions: 3 | checks: write 4 | contents: write 5 | pull-requests: write 6 | statuses: write 7 | "on": 8 | workflow_dispatch: {} 9 | jobs: 10 | publish: 11 | uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-publish.yaml@v15 12 | with: 13 | target: syllable-sdk 14 | secrets: 15 | github_access_token: ${{ secrets.GITHUB_TOKEN }} 16 | npm_token: ${{ secrets.NPM_TOKEN }} 17 | speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} 18 | refresh-mintlify-docs: 19 | name: Refresh Mintlify Docs 20 | runs-on: ubuntu-latest 21 | needs: publish 22 | steps: 23 | - name: Call mintlify API 24 | run: | 25 | curl --request POST \ 26 | --url https://api.mintlify.com/v1/project/update/${{ secrets.MINTLIFY_PROJECT_ID}} \ 27 | --header 'Authorization: Bearer ${{ secrets.MINTLIFY_API_TOKEN}}' 28 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.eslintcache 2 | /.speakeasy/reports 3 | /react-query 4 | /models 5 | /models/errors 6 | /types 7 | /node_modules 8 | /lib 9 | /sdk 10 | /funcs 11 | /hooks 12 | /index.* 13 | /core.* 14 | /cjs 15 | /esm 16 | /dist 17 | /.tsbuildinfo 18 | /.tshy 19 | /.tshy-* 20 | /__tests__ 21 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | **/* 2 | !/FUNCTIONS.md 3 | !/RUNTIMES.md 4 | !/REACT_QUERY.md 5 | !/**/*.ts 6 | !/**/*.js 7 | !/**/*.json 8 | !/**/*.map 9 | 10 | /eslint.config.mjs 11 | /cjs 12 | /.tshy 13 | /.tshy-* 14 | /__tests__ 15 | -------------------------------------------------------------------------------- /.speakeasy/gen.yaml: -------------------------------------------------------------------------------- 1 | configVersion: 2.0.0 2 | generation: 3 | devContainers: 4 | enabled: true 5 | schemaPath: openapi.yaml 6 | sdkClassName: SyllableSdk 7 | maintainOpenAPIOrder: true 8 | usageSnippets: 9 | optionalPropertyRendering: withExample 10 | useClassNamesForArrayFields: true 11 | fixes: 12 | nameResolutionDec2023: true 13 | parameterOrderingFeb2024: true 14 | requestResponseComponentNamesFeb2024: true 15 | securityFeb2025: false 16 | auth: 17 | oAuth2ClientCredentialsEnabled: false 18 | oAuth2PasswordEnabled: false 19 | typescript: 20 | version: 0.1.0-alpha.88 21 | additionalDependencies: 22 | dependencies: {} 23 | devDependencies: {} 24 | peerDependencies: {} 25 | additionalPackageJSON: {} 26 | author: Syllable 27 | clientServerStatusCodesAsErrors: true 28 | defaultErrorName: SDKError 29 | enableCustomCodeRegions: false 30 | enableReactQuery: false 31 | enumFormat: union 32 | envVarPrefix: SYLLABLESDK 33 | flattenGlobalSecurity: true 34 | flatteningOrder: parameters-first 35 | imports: 36 | option: openapi 37 | paths: 38 | callbacks: models/callbacks 39 | errors: models/errors 40 | operations: models/operations 41 | shared: models/components 42 | webhooks: models/webhooks 43 | inputModelSuffix: input 44 | maxMethodParams: 0 45 | methodArguments: require-security-and-request 46 | moduleFormat: commonjs 47 | outputModelSuffix: output 48 | packageName: syllable-sdk 49 | responseFormat: flat 50 | templateVersion: v2 51 | useIndexModules: true 52 | -------------------------------------------------------------------------------- /.speakeasy/workflow.yaml: -------------------------------------------------------------------------------- 1 | workflowVersion: 1.0.0 2 | speakeasyVersion: 1.493.2 3 | sources: 4 | SyllableSDK-OAS: 5 | inputs: 6 | - location: ./openapi.json 7 | overlays: 8 | - location: ./overlay-remove-V1.yaml 9 | output: openapi.yaml 10 | registry: 11 | location: registry.speakeasyapi.dev/syllable/syllable/syllable-sdk-oas 12 | targets: 13 | syllable-sdk: 14 | target: typescript 15 | source: SyllableSDK-OAS 16 | publish: 17 | npm: 18 | token: $npm_token 19 | codeSamples: 20 | output: codeSamples.yaml 21 | registry: 22 | location: registry.speakeasyapi.dev/syllable/syllable/code-samples-typescript-sdk-syllable-sdk-oas 23 | labelOverride: 24 | fixedValue: Typescript (SDK) 25 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to This Repository 2 | 3 | Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements. 4 | 5 | ## How to Report Issues 6 | 7 | If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes: 8 | 9 | - A clear and descriptive title 10 | - Steps to reproduce the issue 11 | - Expected and actual behavior 12 | - Any relevant logs, screenshots, or error messages 13 | - Information about your environment (e.g., operating system, software versions) 14 | - For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed 15 | 16 | ## Issue Triage and Upstream Fixes 17 | 18 | We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code. 19 | 20 | ## Contact 21 | 22 | If you have any questions or need further assistance, please feel free to reach out by opening an issue. 23 | 24 | Thank you for your understanding and cooperation! 25 | 26 | The Maintainers 27 | -------------------------------------------------------------------------------- /USAGE.md: -------------------------------------------------------------------------------- 1 | 2 | ```typescript 3 | import { SyllableSDK } from "syllable-sdk"; 4 | 5 | const syllableSDK = new SyllableSDK({ 6 | apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "", 7 | }); 8 | 9 | async function run() { 10 | const result = await syllableSDK.agents.list({ 11 | page: 0, 12 | searchFields: [ 13 | "name", 14 | ], 15 | searchFieldValues: [ 16 | "Some Object Name", 17 | ], 18 | startDatetime: "2023-01-01T00:00:00Z", 19 | endDatetime: "2024-01-01T00:00:00Z", 20 | }); 21 | 22 | // Handle the result 23 | console.log(result); 24 | } 25 | 26 | run(); 27 | 28 | ``` 29 | -------------------------------------------------------------------------------- /api-reference/introduction.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Syllable SDK" 3 | sidebarTitle: "SDK Documentation" 4 | description: "Subtitle (optional)" 5 | --- 6 | 7 | # syllable-sdk 8 | 9 | Developer-friendly & type-safe Typescript SDK specifically catered to leverage *syllable-sdk* API. 10 | 11 |
12 | 13 | 14 | 15 | 16 |
-------------------------------------------------------------------------------- /api-reference/models/agentcreatetypeextra.md: -------------------------------------------------------------------------------- 1 | # AgentCreateTypeExtra 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/agentcreatevariables.md: -------------------------------------------------------------------------------- 1 | # AgentCreateVariables 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/agentdeleterequest.md: -------------------------------------------------------------------------------- 1 | # AgentDeleteRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `agent_id` | *int* | :heavy_check_mark: | N/A | 9 | | `reason` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/agentgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # AgentGetByIDRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `agent_id` | *int* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/agentlistrequest.md: -------------------------------------------------------------------------------- 1 | # AgentListRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `filter_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 9 | | `filter_prompt` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `filter_greeting` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `page` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 12 | | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /api-reference/models/agentlistresponse.md: -------------------------------------------------------------------------------- 1 | # AgentListResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | 8 | | `agents` | List[[models.Agent](../models/agent.md)] | :heavy_check_mark: | N/A | 9 | | `count` | *int* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/anyofschema1validator.md: -------------------------------------------------------------------------------- 1 | # AnyofSchema1Validator 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/attributes.md: -------------------------------------------------------------------------------- 1 | # Attributes 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/availabletarget.md: -------------------------------------------------------------------------------- 1 | # AvailableTarget 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `channel_id` | *int* | :heavy_check_mark: | N/A | 9 | | `channel_name` | *Nullable[str]* | :heavy_check_mark: | N/A | 10 | | `target` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/availabletargetsrequest.md: -------------------------------------------------------------------------------- 1 | # AvailableTargetsRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `page` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 9 | | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /api-reference/models/channel.md: -------------------------------------------------------------------------------- 1 | # Channel 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *str* | :heavy_check_mark: | N/A | 9 | | `name` | *str* | :heavy_check_mark: | N/A | 10 | | `channel_service` | *str* | :heavy_check_mark: | N/A | 11 | | `supported_modes` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/channellistresponse.md: -------------------------------------------------------------------------------- 1 | # ChannelListResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | 8 | | `channels` | List[[models.Channel](../models/channel.md)] | :heavy_check_mark: | N/A | 9 | | `page` | *int* | :heavy_check_mark: | N/A | 10 | | `page_size` | *int* | :heavy_check_mark: | N/A | 11 | | `total_pages` | *int* | :heavy_check_mark: | N/A | 12 | | `total_count` | *int* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/channelsdeleterequest.md: -------------------------------------------------------------------------------- 1 | # ChannelsDeleteRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `channel_id` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/channelslistrequest.md: -------------------------------------------------------------------------------- 1 | # ChannelsListRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `page` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 9 | | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /api-reference/models/channelstargetupdaterequest.md: -------------------------------------------------------------------------------- 1 | # ChannelsTargetUpdateRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | 8 | | `channel_id` | *int* | :heavy_check_mark: | N/A | 9 | | `target_id` | *int* | :heavy_check_mark: | N/A | 10 | | `channel_target` | [models.ChannelTarget](../models/channeltarget.md) | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/channeltarget.md: -------------------------------------------------------------------------------- 1 | # ChannelTarget 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `id` | *int* | :heavy_check_mark: | N/A | 9 | | `channel_id` | *int* | :heavy_check_mark: | N/A | 10 | | `channel_name` | *Nullable[str]* | :heavy_check_mark: | N/A | 11 | | `agent_id` | *Nullable[int]* | :heavy_check_mark: | N/A | 12 | | `target` | *str* | :heavy_check_mark: | N/A | 13 | | `target_mode` | *str* | :heavy_check_mark: | N/A | 14 | | `fallback_target` | *Nullable[str]* | :heavy_check_mark: | N/A | 15 | | `is_test` | *bool* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/channeltargetcreaterequest.md: -------------------------------------------------------------------------------- 1 | # ChannelTargetCreateRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `channel_id` | *int* | :heavy_check_mark: | N/A | 9 | | `channel_name` | *Nullable[str]* | :heavy_check_mark: | N/A | 10 | | `agent_id` | *Nullable[int]* | :heavy_check_mark: | N/A | 11 | | `target` | *str* | :heavy_check_mark: | N/A | 12 | | `target_mode` | *str* | :heavy_check_mark: | N/A | 13 | | `fallback_target` | *Nullable[str]* | :heavy_check_mark: | N/A | 14 | | `is_test` | *bool* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/channeltargetscreaterequest.md: -------------------------------------------------------------------------------- 1 | # ChannelTargetsCreateRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | 8 | | `channel_id` | *int* | :heavy_check_mark: | N/A | 9 | | `channel_target_create_request` | [models.ChannelTargetCreateRequest](../models/channeltargetcreaterequest.md) | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/channeltargetsgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # ChannelTargetsGetByIDRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `channel_id` | *int* | :heavy_check_mark: | N/A | 9 | | `target_id` | *int* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/channeltargetslistrequest.md: -------------------------------------------------------------------------------- 1 | # ChannelTargetsListRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `page` | *Optional[int]* | :heavy_minus_sign: | N/A | 9 | | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A | 10 | | `order_by` | *Optional[str]* | :heavy_minus_sign: | N/A | 11 | | `order_by_direction` | *Optional[str]* | :heavy_minus_sign: | N/A | 12 | | `agent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 13 | | `channel_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 14 | | `target` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 15 | | `fallback_target` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /api-reference/models/chatmessageresponse.md: -------------------------------------------------------------------------------- 1 | # ChatMessageResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | 8 | | `chat_id` | *str* | :heavy_check_mark: | N/A | 9 | | `agent_id` | *str* | :heavy_check_mark: | N/A | 10 | | `text` | *str* | :heavy_check_mark: | N/A | 11 | | `response` | [Optional[models.Response]](../models/response.md) | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /api-reference/models/conversationgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # ConversationGetByIDRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `conversation_id` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/conversationtranscriptionresponse.md: -------------------------------------------------------------------------------- 1 | # ConversationTranscriptionResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | 8 | | `conversation_id` | *str* | :heavy_check_mark: | N/A | 9 | | `transcription` | List[[models.ConversationText](../models/conversationtext.md)] | :heavy_check_mark: | N/A | 10 | | `actions` | List[[models.ConversationAction](../models/conversationaction.md)] | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/eventlistresponse.md: -------------------------------------------------------------------------------- 1 | # EventListResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | 8 | | `events` | List[[models.Event](../models/event.md)] | :heavy_check_mark: | N/A | 9 | | `page` | *int* | :heavy_check_mark: | N/A | 10 | | `page_size` | *int* | :heavy_check_mark: | N/A | 11 | | `total_pages` | *int* | :heavy_check_mark: | N/A | 12 | | `total_count` | *int* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/function.md: -------------------------------------------------------------------------------- 1 | # Function 2 | 3 | A tool definition to be used by the OpenAI API. See: - https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | 10 | | `name` | *str* | :heavy_check_mark: | The name of the function/tool call. | 11 | | `description` | *str* | :heavy_check_mark: | The description of the tool. | 12 | | `parameters` | [models.Parameters](../models/parameters.md) | :heavy_check_mark: | The JSON Schema of parameters of the function/tool call. | -------------------------------------------------------------------------------- /api-reference/models/getdailycallvolumebyhourresponsegetdailycallvolumebyhour.md: -------------------------------------------------------------------------------- 1 | # GetDailyCallVolumeByHourResponseGetDailyCallVolumeByHour 2 | 3 | Successful Response 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/getmonthlycallvolumebydayresponsegetmonthlycallvolumebyday.md: -------------------------------------------------------------------------------- 1 | # GetMonthlyCallVolumeByDayResponseGetMonthlyCallVolumeByDay 2 | 3 | Successful Response 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/getmonthlycallvolumebyweekresponsegetmonthlycallvolumebyweek.md: -------------------------------------------------------------------------------- 1 | # GetMonthlyCallVolumeByWeekResponseGetMonthlyCallVolumeByWeek 2 | 3 | Successful Response 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/getsessionagentsresponsegetsessionagents.md: -------------------------------------------------------------------------------- 1 | # GetSessionAgentsResponseGetSessionAgents 2 | 3 | Successful Response 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/getsessionsummaryrequest.md: -------------------------------------------------------------------------------- 1 | # GetSessionSummaryRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `page` | *Optional[int]* | :heavy_minus_sign: | N/A | 9 | | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A | 10 | | `start_date` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `end_date` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 12 | | `order_by` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 13 | | `agent_id` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /api-reference/models/getsessionsummaryresponsegetsessionsummary.md: -------------------------------------------------------------------------------- 1 | # GetSessionSummaryResponseGetSessionSummary 2 | 3 | Successful Response 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/gettotalcallvolumebyhourresponsegettotalcallvolumebyhour.md: -------------------------------------------------------------------------------- 1 | # GetTotalCallVolumeByHourResponseGetTotalCallVolumeByHour 2 | 3 | Successful Response 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/getweeklycallvolumebyweekdayresponsegetweeklycallvolumebyweekday.md: -------------------------------------------------------------------------------- 1 | # GetWeeklyCallVolumeByWeekdayResponseGetWeeklyCallVolumeByWeekday 2 | 3 | Successful Response 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/greeting.md: -------------------------------------------------------------------------------- 1 | # Greeting 2 | 3 | Greeting 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | 10 | | `name` | *str* | :heavy_check_mark: | The name of the greeting | 11 | | `text` | *str* | :heavy_check_mark: | The text of the greeting | 12 | | `id` | *int* | :heavy_check_mark: | The ID of the greeting | -------------------------------------------------------------------------------- /api-reference/models/greetingcreate.md: -------------------------------------------------------------------------------- 1 | # GreetingCreate 2 | 3 | GreetingCreate 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | 10 | | `name` | *str* | :heavy_check_mark: | The name of the greeting | 11 | | `text` | *str* | :heavy_check_mark: | The text of the greeting | -------------------------------------------------------------------------------- /api-reference/models/greetinglistresponse.md: -------------------------------------------------------------------------------- 1 | # GreetingListResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | 8 | | `greetings` | List[[models.Greeting](../models/greeting.md)] | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/greetingresponse.md: -------------------------------------------------------------------------------- 1 | # GreetingResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | 8 | | `name` | *str* | :heavy_check_mark: | The name of the greeting | 9 | | `text` | *str* | :heavy_check_mark: | The text of the greeting | 10 | | `id` | *int* | :heavy_check_mark: | The ID of the greeting | -------------------------------------------------------------------------------- /api-reference/models/greetingsdeleterequest.md: -------------------------------------------------------------------------------- 1 | # GreetingsDeleteRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `greeting_id` | *int* | :heavy_check_mark: | N/A | 9 | | `reason` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/greetingsgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # GreetingsGetByIDRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `greeting_id` | *int* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/greetingslistrequest.md: -------------------------------------------------------------------------------- 1 | # GreetingsListRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `page` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 9 | | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /api-reference/models/httpendpoint.md: -------------------------------------------------------------------------------- 1 | # HTTPEndpoint 2 | 3 | The configuration for an HTTP API call. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | 10 | | `url` | *str* | :heavy_check_mark: | The endpoint URL of the external service to call. | 11 | | `method` | *str* | :heavy_check_mark: | The HTTP method to use for the service call. | 12 | | `argument_location` | *str* | :heavy_check_mark: | How to pass the arguments to the request. | -------------------------------------------------------------------------------- /api-reference/models/httpvalidationerror.md: -------------------------------------------------------------------------------- 1 | # HTTPValidationError 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | 8 | | `detail` | List[[models.ValidationError](../models/validationerror.md)] | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /api-reference/models/loc.md: -------------------------------------------------------------------------------- 1 | # Loc 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `str` 7 | 8 | ```python 9 | value: str = /* values here */ 10 | ``` 11 | 12 | ### `int` 13 | 14 | ```python 15 | value: int = /* values here */ 16 | ``` 17 | 18 | -------------------------------------------------------------------------------- /api-reference/models/organization.md: -------------------------------------------------------------------------------- 1 | # Organization 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | 8 | | `id` | *int* | :heavy_check_mark: | The organization ID | 9 | | `name` | *str* | :heavy_check_mark: | The organization name | 10 | | `display_name` | *str* | :heavy_check_mark: | The organization display name | -------------------------------------------------------------------------------- /api-reference/models/parameters.md: -------------------------------------------------------------------------------- 1 | # Parameters 2 | 3 | The JSON Schema of parameters of the function/tool call. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/promptlistresponse.md: -------------------------------------------------------------------------------- 1 | # PromptListResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | 8 | | `prompts` | List[[models.Prompt](../models/prompt.md)] | :heavy_check_mark: | N/A | 9 | | `filter_name` | *Nullable[str]* | :heavy_check_mark: | N/A | 10 | | `page` | *int* | :heavy_check_mark: | N/A | 11 | | `page_size` | *int* | :heavy_check_mark: | N/A | 12 | | `total_pages` | *int* | :heavy_check_mark: | N/A | 13 | | `total_count` | *int* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/promptsdeleterequest.md: -------------------------------------------------------------------------------- 1 | # PromptsDeleteRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `prompt_id` | *int* | :heavy_check_mark: | N/A | 9 | | `reason` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/promptsgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # PromptsGetByIDRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `prompt_id` | *int* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/promptslistrequest.md: -------------------------------------------------------------------------------- 1 | # PromptsListRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `filter_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 9 | | `page` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 10 | | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /api-reference/models/provider.md: -------------------------------------------------------------------------------- 1 | # Provider 2 | 3 | LLM API provider. 4 | 5 | 6 | ## Values 7 | 8 | | Name | Value | 9 | | -------------- | -------------- | 10 | | `AZURE_OPENAI` | azure_openai | 11 | | `OPENAI` | openai | -------------------------------------------------------------------------------- /api-reference/models/response.md: -------------------------------------------------------------------------------- 1 | # Response 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/result.md: -------------------------------------------------------------------------------- 1 | # Result 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/schemascortexv1toolstool.md: -------------------------------------------------------------------------------- 1 | # SchemasCortexV1ToolsTool 2 | 3 | A tool definition to be used by the OpenAI API. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | 10 | | `function` | [models.Function](../models/function.md) | :heavy_check_mark: | The tool definition including the JSON Schema of its parameters. | 11 | | `type` | *OptionalNullable[str]* | :heavy_minus_sign: | Always `function`. | -------------------------------------------------------------------------------- /api-reference/models/security.md: -------------------------------------------------------------------------------- 1 | # Security 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `api_key_header` | *Optional[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /api-reference/models/sessionlistresponse.md: -------------------------------------------------------------------------------- 1 | # SessionListResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | 8 | | `sessions` | List[[models.Session](../models/session.md)] | :heavy_check_mark: | N/A | 9 | | `page` | *int* | :heavy_check_mark: | N/A | 10 | | `page_size` | *int* | :heavy_check_mark: | N/A | 11 | | `total_pages` | *int* | :heavy_check_mark: | N/A | 12 | | `total_count` | *int* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/tooldetailresponse.md: -------------------------------------------------------------------------------- 1 | # ToolDetailResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `name` | *str* | :heavy_check_mark: | N/A | 9 | | `description` | *str* | :heavy_check_mark: | N/A | 10 | | `fields` | List[*str*] | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/toolgetbynamerequest.md: -------------------------------------------------------------------------------- 1 | # ToolGetByNameRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `tool_name` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/toollistrequest.md: -------------------------------------------------------------------------------- 1 | # ToolListRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `page` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 9 | | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /api-reference/models/toolparameterdefault.md: -------------------------------------------------------------------------------- 1 | # ToolParameterDefault 2 | 3 | The default value for a parameter of the tool call. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | 10 | | `transform` | [models.ToolParameterTransform](../models/toolparametertransform.md) | :heavy_check_mark: | The transform to apply to the value before using it as the default. | -------------------------------------------------------------------------------- /api-reference/models/toolparametertransformcondition.md: -------------------------------------------------------------------------------- 1 | # ToolParameterTransformCondition 2 | 3 | A condition to be met for a transform to be applied to the value of a parameter. 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | 10 | | `key` | *str* | :heavy_check_mark: | The name of the parameter to check. | 11 | | `value` | *str* | :heavy_check_mark: | The value to check against the parameter. | 12 | | `operator` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /api-reference/models/totalcallvolumebyweekdayresponsetotalcallvolumebyweekday.md: -------------------------------------------------------------------------------- 1 | # TotalCallVolumeByWeekdayResponseTotalCallVolumeByWeekday 2 | 3 | Successful Response 4 | 5 | 6 | ## Fields 7 | 8 | | Field | Type | Required | Description | 9 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/typeextra.md: -------------------------------------------------------------------------------- 1 | # TypeExtra 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/models/utils/retryconfig.md: -------------------------------------------------------------------------------- 1 | # RetryConfig 2 | 3 | Allows customizing the default retry configuration. Only usable with methods that mention they support retries. 4 | 5 | ## Fields 6 | 7 | | Name | Type | Description | Example | 8 | | ------------------------- | ----------------------------------- | --------------------------------------- | --------- | 9 | | `strategy` | `*str*` | The retry strategy to use. | `backoff` | 10 | | `backoff` | [BackoffStrategy](#backoffstrategy) | Configuration for the backoff strategy. | | 11 | | `retry_connection_errors` | `*bool*` | Whether to retry on connection errors. | `true` | 12 | 13 | ## BackoffStrategy 14 | 15 | The backoff strategy allows retrying a request with an exponential backoff between each retry. 16 | 17 | ### Fields 18 | 19 | | Name | Type | Description | Example | 20 | | ------------------ | --------- | ----------------------------------------- | -------- | 21 | | `initial_interval` | `*int*` | The initial interval in milliseconds. | `500` | 22 | | `max_interval` | `*int*` | The maximum interval in milliseconds. | `60000` | 23 | | `exponent` | `*float*` | The exponent to use for the backoff. | `1.5` | 24 | | `max_elapsed_time` | `*int*` | The maximum elapsed time in milliseconds. | `300000` | -------------------------------------------------------------------------------- /api-reference/models/validationerror.md: -------------------------------------------------------------------------------- 1 | # ValidationError 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | 8 | | `loc` | List[[models.Loc](../models/loc.md)] | :heavy_check_mark: | N/A | 9 | | `msg` | *str* | :heavy_check_mark: | N/A | 10 | | `type` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /api-reference/models/variables.md: -------------------------------------------------------------------------------- 1 | # Variables 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /api-reference/sdks/syllable/README.md: -------------------------------------------------------------------------------- 1 | # Syllable SDK 2 | 3 | ## Overview 4 | 5 | SyllableSDK: 6 | # Syllble Platform SDK 7 | 8 | Syllble SDK gives you the power of awesome AI agentry. 🚀 9 | 10 | ## Overview 11 | 12 | The Syllble SDK provides a comprehensive set of tools and APIs to integrate powerful AI capabilities into your applications. Whether you're building chatbots, virtual assistants, or any other AI-driven solutions, Syllble SDK has got you covered. 13 | 14 | ## Features 15 | 16 | - **Natural Language Processing (NLP)**: Understand and generate human language with ease. 17 | - **Machine Learning Models**: Leverage pre-trained models or train your own custom models. 18 | - **Speech Recognition**: Convert speech to text and vice versa. 19 | - **Image Recognition**: Identify objects, faces, and scenes in images. 20 | - **Data Analytics**: Analyze and visualize data to gain insights. 21 | - **Integration**: Seamlessly integrate with other services and platforms. 22 | 23 | -------------------------------------------------------------------------------- /docs/models/components/action.md: -------------------------------------------------------------------------------- 1 | # Action 2 | 3 | The action to perform on the tool parameter value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value," and `remove` means "remove the parameter value." 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { Action } from "syllable-sdk/models/components"; 9 | 10 | let value: Action = "default"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "default" | "override" | "remove" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/agentproperties.md: -------------------------------------------------------------------------------- 1 | # AgentProperties 2 | 3 | Names of agent fields supported for filtering/sorting on list endpoint. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { AgentProperties } from "syllable-sdk/models/components"; 9 | 10 | let value: AgentProperties = "last_updated_by"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "id" | "name" | "name_exact" | "description" | "label" | "name_description" | "type" | "timezone" | "prompt_id" | "prompt_id_list" | "custom_message_id" | "languages" | "variables" | "prompt_tool_defaults" | "tool_headers" | "updated_at" | "last_updated_by" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/agentsttprovider.md: -------------------------------------------------------------------------------- 1 | # AgentSttProvider 2 | 3 | Speech-to-text providers supported by agents. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { AgentSttProvider } from "syllable-sdk/models/components"; 9 | 10 | let value: AgentSttProvider = "Google STT V2"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "Google STT V1" | "Google STT V2" | "Deepgram Nova 2" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/agenttoolfielddefault.md: -------------------------------------------------------------------------------- 1 | # AgentToolFieldDefault 2 | 3 | Agent-level value for a static parameter on a tool, overriding the tool-level default if one 4 | exists. 5 | 6 | ## Example Usage 7 | 8 | ```typescript 9 | import { AgentToolFieldDefault } from "syllable-sdk/models/components"; 10 | 11 | let value: AgentToolFieldDefault = { 12 | fieldName: "temperature_unit", 13 | defaultValue: "fahrenheit", 14 | }; 15 | ``` 16 | 17 | ## Fields 18 | 19 | | Field | Type | Required | Description | Example | 20 | | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | 21 | | `fieldName` | *string* | :heavy_check_mark: | The name of the field | temperature_unit | 22 | | `defaultValue` | *any* | :heavy_check_mark: | The default value for the field | fahrenheit | -------------------------------------------------------------------------------- /docs/models/components/agentvoicedisplayname.md: -------------------------------------------------------------------------------- 1 | # AgentVoiceDisplayName 2 | 3 | Display names of voices that Syllable supports. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { AgentVoiceDisplayName } from "syllable-sdk/models/components"; 9 | 10 | let value: AgentVoiceDisplayName = "Alloy"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "Alejandro" | "Alice" | "Alloy" | "Ash" | "Bill" | "Brian" | "Callum" | "Charlie" | "Charlotte" | "Chris" | "Clara" | "Coral" | "Daniel" | "Echo" | "Eric" | "Fable" | "George" | "Isabella" | "Jerry" | "Jessica" | "Laura" | "Liam" | "Lily" | "Lina" | "Mark" | "Matilda" | "Melanie" | "Mila" | "Nova" | "Onyx" | "River" | "Roger" | "Sarah" | "Sage" | "Shimmer" | "Sienna" | "Tara" | "Will" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/agentvoicegender.md: -------------------------------------------------------------------------------- 1 | # AgentVoiceGender 2 | 3 | Gender for an agent voice. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { AgentVoiceGender } from "syllable-sdk/models/components"; 9 | 10 | let value: AgentVoiceGender = "female"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "female" | "male" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/agentvoicemodel.md: -------------------------------------------------------------------------------- 1 | # AgentVoiceModel 2 | 3 | Model for an agent voice. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { AgentVoiceModel } from "syllable-sdk/models/components"; 9 | 10 | let value: AgentVoiceModel = "Whisper"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "Multilingual_v2" | "Neural2" | "Standard" | "Studio" | "WaveNet" | "Whisper" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/agentvoicevarname.md: -------------------------------------------------------------------------------- 1 | # AgentVoiceVarName 2 | 3 | The variable name of an agent voice (used when procesing messages). 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { AgentVoiceVarName } from "syllable-sdk/models/components"; 9 | 10 | let value: AgentVoiceVarName = "wavenet:female/vi-VN-Neural2-A"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "openai:alloy" | "openai:ash" | "openai:coral" | "openai:echo" | "openai:fable" | "openai:nova" | "openai:onyx" | "openai:sage" | "openai:shimmer" | "elevenlabs:Alice" | "elevenlabs:Bill" | "elevenlabs:Brian" | "elevenlabs:Callum" | "elevenlabs:Charlie" | "elevenlabs:Charlotte" | "elevenlabs:Chris" | "elevenlabs:Daniel" | "elevenlabs:Eric" | "elevenlabs:George" | "elevenlabs:Jessica" | "elevenlabs:Laura" | "elevenlabs:Liam" | "elevenlabs:Lily" | "elevenlabs:Matilda" | "elevenlabs:River" | "elevenlabs:Roger" | "elevenlabs:Sarah" | "elevenlabs:Will" | "wavenet:male/es-US-Neural2-B" | "wavenet:female/en-US-Neural2-F" | "wavenet:female/es-US-Neural2-A" | "wavenet:male/en-US-Neural2-D" | "wavenet:female/cmn-TW-Wavenet-A" | "wavenet:male/en-US-Neural2-J" | "wavenet:female/yue-HK-Standard-C" | "wavenet:female/en-US-Studio-O" | "wavenet:female/ko-KR-Neural2-A" | "wavenet:female/vi-VN-Neural2-A" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/agentwaitsound.md: -------------------------------------------------------------------------------- 1 | # AgentWaitSound 2 | 3 | Wait sounds supported by agents. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { AgentWaitSound } from "syllable-sdk/models/components"; 9 | 10 | let value: AgentWaitSound = "Keyboard 1"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "No Sound" | "Keyboard 1" | "Keyboard 2" | "Call Center" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/attributes.md: -------------------------------------------------------------------------------- 1 | # Attributes 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { Attributes } from "syllable-sdk/models/components"; 7 | 8 | let value: Attributes = {}; 9 | ``` 10 | 11 | ## Fields 12 | 13 | | Field | Type | Required | Description | 14 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/components/availabletargetproperties.md: -------------------------------------------------------------------------------- 1 | # AvailableTargetProperties 2 | 3 | Names of target fields supported for filtering/sorting on available targets list endpoint. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { AvailableTargetProperties } from "syllable-sdk/models/components"; 9 | 10 | let value: AvailableTargetProperties = "channel_id"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "channel_id" | "channel_name" | "target" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/batchproperties.md: -------------------------------------------------------------------------------- 1 | # BatchProperties 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { BatchProperties } from "syllable-sdk/models/components"; 7 | 8 | let value: BatchProperties = "status"; 9 | ``` 10 | 11 | ## Values 12 | 13 | ```typescript 14 | "batch_id" | "campaign_id" | "status" | "expires_on" 15 | ``` -------------------------------------------------------------------------------- /docs/models/components/batchstatus.md: -------------------------------------------------------------------------------- 1 | # BatchStatus 2 | 3 | Status of a communication batch. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { BatchStatus } from "syllable-sdk/models/components"; 9 | 10 | let value: BatchStatus = "EXPIRED"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "PENDING" | "ACTIVE" | "PAUSED" | "FAILED" | "CANCELED" | "EXPIRED" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/bodyoutboundbatchdelete.md: -------------------------------------------------------------------------------- 1 | # BodyOutboundBatchDelete 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { BodyOutboundBatchDelete } from "syllable-sdk/models/components"; 7 | 8 | let value: BodyOutboundBatchDelete = { 9 | deleteReason: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `deleteReason` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/components/campaignproperties.md: -------------------------------------------------------------------------------- 1 | # CampaignProperties 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { CampaignProperties } from "syllable-sdk/models/components"; 7 | 8 | let value: CampaignProperties = "caller_id"; 9 | ``` 10 | 11 | ## Values 12 | 13 | ```typescript 14 | "id" | "campaign_name" | "campaign_variables" | "daily_start_time" | "daily_end_time" | "source" | "caller_id" 15 | ``` -------------------------------------------------------------------------------- /docs/models/components/channelproperties.md: -------------------------------------------------------------------------------- 1 | # ChannelProperties 2 | 3 | Names of channel fields supported for filtering/sorting on list endpoint. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { ChannelProperties } from "syllable-sdk/models/components"; 9 | 10 | let value: ChannelProperties = "name"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "id" | "name" | "channel_service" | "supported_modes" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/channelservices.md: -------------------------------------------------------------------------------- 1 | # ChannelServices 2 | 3 | The communication service for a channel. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { ChannelServices } from "syllable-sdk/models/components"; 9 | 10 | let value: ChannelServices = "sip"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "sip" | "twilio" | "email" | "webchat" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/channeltargetproperties.md: -------------------------------------------------------------------------------- 1 | # ChannelTargetProperties 2 | 3 | Names of channel target fields supported for filtering/sorting on full channel targets list 4 | endpoint. 5 | 6 | ## Example Usage 7 | 8 | ```typescript 9 | import { ChannelTargetProperties } from "syllable-sdk/models/components"; 10 | 11 | let value: ChannelTargetProperties = "channel_name"; 12 | ``` 13 | 14 | ## Values 15 | 16 | ```typescript 17 | "id" | "channel_id" | "channel_name" | "agent_id" | "target" | "target_mode" | "fallback_target" | "is_test" | "updated_at" 18 | ``` -------------------------------------------------------------------------------- /docs/models/components/communicationrequestrequestvariables.md: -------------------------------------------------------------------------------- 1 | # CommunicationRequestRequestVariables 2 | 3 | Variables for request 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { CommunicationRequestRequestVariables } from "syllable-sdk/models/components"; 9 | 10 | let value: CommunicationRequestRequestVariables = {}; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/components/conditions.md: -------------------------------------------------------------------------------- 1 | # Conditions 2 | 3 | Conditions for insight workflow to trigger on a given call recording. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { Conditions } from "syllable-sdk/models/components"; 9 | 10 | let value: Conditions = {}; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/components/conversationproperties.md: -------------------------------------------------------------------------------- 1 | # ConversationProperties 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { ConversationProperties } from "syllable-sdk/models/components"; 7 | 8 | let value: ConversationProperties = "llm_provider"; 9 | ``` 10 | 11 | ## Values 12 | 13 | ```typescript 14 | "timestamp" | "agent_type" | "agent_id" | "agent_name" | "prompt_id" | "prompt_name" | "llm_provider" | "llm_model" | "llm_version" | "is_legacy" 15 | ``` -------------------------------------------------------------------------------- /docs/models/components/custommessageproperties.md: -------------------------------------------------------------------------------- 1 | # CustomMessageProperties 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { CustomMessageProperties } from "syllable-sdk/models/components"; 7 | 8 | let value: CustomMessageProperties = "label"; 9 | ``` 10 | 11 | ## Values 12 | 13 | ```typescript 14 | "id" | "name" | "text" | "label" | "updated_at" 15 | ``` -------------------------------------------------------------------------------- /docs/models/components/dashboard.md: -------------------------------------------------------------------------------- 1 | # Dashboard 2 | 3 | Deprecated. Please update to use DashboardTokenResponse. 4 | Basic information about a dashboard. 5 | 6 | ## Example Usage 7 | 8 | ```typescript 9 | import { Dashboard } from "syllable-sdk/models/components"; 10 | 11 | let value: Dashboard = { 12 | embeddedId: "", 13 | guestToken: "", 14 | name: "", 15 | supersetUrl: "https://dismal-affiliate.net/", 16 | }; 17 | ``` 18 | 19 | ## Fields 20 | 21 | | Field | Type | Required | Description | 22 | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | 23 | | `embeddedId` | *string* | :heavy_check_mark: | Superset embedded ID of the dashboard | 24 | | `guestToken` | *string* | :heavy_check_mark: | Superset guest token of the dashboard | 25 | | `name` | *string* | :heavy_check_mark: | Name of the dashboard | 26 | | `supersetUrl` | *string* | :heavy_check_mark: | Superset URL of the dashboard | -------------------------------------------------------------------------------- /docs/models/components/dashboardproperties.md: -------------------------------------------------------------------------------- 1 | # DashboardProperties 2 | 3 | Names of dashboard fields supported for filtering/sorting on list endpoint. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { DashboardProperties } from "syllable-sdk/models/components"; 9 | 10 | let value: DashboardProperties = "display_name"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "id" | "name" | "display_name" | "rank" | "label" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/datasourceproperties.md: -------------------------------------------------------------------------------- 1 | # DataSourceProperties 2 | 3 | Names of data source fields supported for filtering/sorting on list endpoint. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { DataSourceProperties } from "syllable-sdk/models/components"; 9 | 10 | let value: DataSourceProperties = "chunk"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "name" | "description" | "labels" | "chunk" | "chunk_delimiter" | "updated_at" | "last_updated_by" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/dayofweek.md: -------------------------------------------------------------------------------- 1 | # DayOfWeek 2 | 3 | Available options for day of the week for use in message rules. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { DayOfWeek } from "syllable-sdk/models/components"; 9 | 10 | let value: DayOfWeek = "fr"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "mo" | "tu" | "we" | "th" | "fr" | "sa" | "su" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/daysofweek.md: -------------------------------------------------------------------------------- 1 | # DaysOfWeek 2 | 3 | Enum representing days of the week. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { DaysOfWeek } from "syllable-sdk/models/components"; 9 | 10 | let value: DaysOfWeek = "tue"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/defaults.md: -------------------------------------------------------------------------------- 1 | # Defaults 2 | 3 | The default values for the parameters of the function/tool call. 4 | 5 | 6 | ## Supported Types 7 | 8 | ### `any` 9 | 10 | ```typescript 11 | const value: any = ""; 12 | ``` 13 | 14 | ### `{ [k: string]: components.ToolParameterDefault }` 15 | 16 | ```typescript 17 | const value: { [k: string]: components.ToolParameterDefault } = { 18 | "key": { 19 | transform: { 20 | when: { 21 | key: "key", 22 | value: "value", 23 | }, 24 | }, 25 | }, 26 | }; 27 | ``` 28 | 29 | -------------------------------------------------------------------------------- /docs/models/components/dialogmessage.md: -------------------------------------------------------------------------------- 1 | # DialogMessage 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { DialogMessage } from "syllable-sdk/models/components"; 7 | 8 | let value: DialogMessage = { 9 | text: "Tell me about Syllable.ai!", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | Example | 16 | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -------------------------- | 17 | | `text` | *string* | :heavy_check_mark: | Dialog message text | Tell me about Syllable.ai! | -------------------------------------------------------------------------------- /docs/models/components/dialogrole.md: -------------------------------------------------------------------------------- 1 | # DialogRole 2 | 3 | Role of dialog 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { DialogRole } from "syllable-sdk/models/components"; 9 | 10 | let value: DialogRole = "agent"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "agent" | "user" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/eventproperties.md: -------------------------------------------------------------------------------- 1 | # EventProperties 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { EventProperties } from "syllable-sdk/models/components"; 7 | 8 | let value: EventProperties = "source"; 9 | ``` 10 | 11 | ## Values 12 | 13 | ```typescript 14 | "timestamp" | "session_id" | "conversation_id" | "source" | "source_id" | "category" | "type" | "user_id" | "description" | "attributes" 15 | ``` -------------------------------------------------------------------------------- /docs/models/components/filet.md: -------------------------------------------------------------------------------- 1 | # FileT 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { FileT } from "syllable-sdk/models/components"; 7 | 8 | // No examples available for this model 9 | ``` 10 | 11 | ## Fields 12 | 13 | | Field | Type | Required | Description | 14 | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | 15 | | `fileName` | *string* | :heavy_check_mark: | N/A | 16 | | `content` | *ReadableStream* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/components/incidentorganizationresponse.md: -------------------------------------------------------------------------------- 1 | # IncidentOrganizationResponse 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { IncidentOrganizationResponse } from "syllable-sdk/models/components"; 7 | 8 | let value: IncidentOrganizationResponse = { 9 | id: 131797, 10 | name: "", 11 | displayName: "Michelle2", 12 | }; 13 | ``` 14 | 15 | ## Fields 16 | 17 | | Field | Type | Required | Description | 18 | | ------------------ | ------------------ | ------------------ | ------------------ | 19 | | `id` | *number* | :heavy_check_mark: | N/A | 20 | | `name` | *string* | :heavy_check_mark: | N/A | 21 | | `displayName` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/components/incidentproperties.md: -------------------------------------------------------------------------------- 1 | # IncidentProperties 2 | 3 | Names of agent fields supported for filtering/sorting on list endpoint. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { IncidentProperties } from "syllable-sdk/models/components"; 9 | 10 | let value: IncidentProperties = "sub_organization_id"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "id" | "description" | "impact_category" | "sessions_impacted" | "markdown" | "created_at" | "updated_at" | "organization_id" | "sub_organization_id" | "start_datetime" | "end_datetime" | "resolution_datetime" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/insights.md: -------------------------------------------------------------------------------- 1 | # Insights 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { Insights } from "syllable-sdk/models/components"; 7 | 8 | let value: Insights = {}; 9 | ``` 10 | 11 | ## Fields 12 | 13 | | Field | Type | Required | Description | 14 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/components/insightsproperties.md: -------------------------------------------------------------------------------- 1 | # InsightsProperties 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { InsightsProperties } from "syllable-sdk/models/components"; 7 | 8 | let value: InsightsProperties = "id"; 9 | ``` 10 | 11 | ## Values 12 | 13 | ```typescript 14 | "id" | "session_id" | "insight_key" | "insight_tool_id" 15 | ``` -------------------------------------------------------------------------------- /docs/models/components/insightsworkflowqueuesession.md: -------------------------------------------------------------------------------- 1 | # InsightsWorkflowQueueSession 2 | 3 | Session identifier for workflow queue. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { InsightsWorkflowQueueSession } from "syllable-sdk/models/components"; 9 | 10 | let value: InsightsWorkflowQueueSession = { 11 | workflowName: "summary-workflow", 12 | sessionIdList: [ 13 | [12334, 23445, 34556], 14 | ], 15 | }; 16 | ``` 17 | 18 | ## Fields 19 | 20 | | Field | Type | Required | Description | Example | 21 | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- | 22 | | `workflowName` | *string* | :heavy_check_mark: | Unique name for workflow | summary-workflow | 23 | | `sessionIdList` | *number*[] | :heavy_check_mark: | List of session identifiers | [12334,23445,34556] | -------------------------------------------------------------------------------- /docs/models/components/insighttoolinputtoolarguments.md: -------------------------------------------------------------------------------- 1 | # InsightToolInputToolArguments 2 | 3 | Arguments for calling the insight tool 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { InsightToolInputToolArguments } from "syllable-sdk/models/components"; 9 | 10 | let value: InsightToolInputToolArguments = {}; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/components/insighttoolproperties.md: -------------------------------------------------------------------------------- 1 | # InsightToolProperties 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { InsightToolProperties } from "syllable-sdk/models/components"; 7 | 8 | let value: InsightToolProperties = "name"; 9 | ``` 10 | 11 | ## Values 12 | 13 | ```typescript 14 | "id" | "name" | "description" | "tool_arguments" | "insight_tool_definition_id" | "updated_at" 15 | ``` -------------------------------------------------------------------------------- /docs/models/components/insighttooltestinput.md: -------------------------------------------------------------------------------- 1 | # InsightToolTestInput 2 | 3 | Request model to test an insight tool. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { InsightToolTestInput } from "syllable-sdk/models/components"; 9 | 10 | let value: InsightToolTestInput = { 11 | toolName: "summary-tool", 12 | sessionId: 283467, 13 | }; 14 | ``` 15 | 16 | ## Fields 17 | 18 | | Field | Type | Required | Description | Example | 19 | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | 20 | | `toolName` | *string* | :heavy_check_mark: | Human readable name of insight tool | summary-tool | 21 | | `sessionId` | *number* | :heavy_check_mark: | The session ID of the session to run the tool against | 283467 | -------------------------------------------------------------------------------- /docs/models/components/insightworkflowinputconditions.md: -------------------------------------------------------------------------------- 1 | # InsightWorkflowInputConditions 2 | 3 | Conditions for insight workflow to trigger on a given call recording. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { InsightWorkflowInputConditions } from "syllable-sdk/models/components"; 9 | 10 | let value: InsightWorkflowInputConditions = {}; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/components/insightworkflowproperties.md: -------------------------------------------------------------------------------- 1 | # InsightWorkflowProperties 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { InsightWorkflowProperties } from "syllable-sdk/models/components"; 7 | 8 | let value: InsightWorkflowProperties = "conditions"; 9 | ``` 10 | 11 | ## Values 12 | 13 | ```typescript 14 | "id" | "name" | "description" | "status" | "conditions" | "insight_tool_ids" | "updated_at" 15 | ``` -------------------------------------------------------------------------------- /docs/models/components/jsonvalue.md: -------------------------------------------------------------------------------- 1 | # JsonValue 2 | 3 | JSON value of insight tool result 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { JsonValue } from "syllable-sdk/models/components"; 9 | 10 | let value: JsonValue = {}; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/components/languagecode.md: -------------------------------------------------------------------------------- 1 | # LanguageCode 2 | 3 | BCP 47 codes of languages that Syllable supports. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { LanguageCode } from "syllable-sdk/models/components"; 9 | 10 | let value: LanguageCode = "yue-HK"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "yue-HK" | "en-US" | "ko-KR" | "zh-CN" | "es-US" | "th-TH" | "vi-VN" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/languagegroupagentinfo.md: -------------------------------------------------------------------------------- 1 | # LanguageGroupAgentInfo 2 | 3 | Information about an agent linked to a language group. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { LanguageGroupAgentInfo } from "syllable-sdk/models/components"; 9 | 10 | let value: LanguageGroupAgentInfo = { 11 | id: 1, 12 | name: "Test Agent", 13 | }; 14 | ``` 15 | 16 | ## Fields 17 | 18 | | Field | Type | Required | Description | Example | 19 | | --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | 20 | | `id` | *number* | :heavy_check_mark: | The ID of the agent | 1 | 21 | | `name` | *string* | :heavy_check_mark: | The name of the agent | Test Agent | -------------------------------------------------------------------------------- /docs/models/components/languagegroupproperties.md: -------------------------------------------------------------------------------- 1 | # LanguageGroupProperties 2 | 3 | Names of language group fields supported for filtering/sorting on list endpoint. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { LanguageGroupProperties } from "syllable-sdk/models/components"; 9 | 10 | let value: LanguageGroupProperties = "name"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "name" | "description" | "skip_current_language_in_message" | "updated_at" | "last_updated_by" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/latencycategory.md: -------------------------------------------------------------------------------- 1 | # LatencyCategory 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { LatencyCategory } from "syllable-sdk/models/components"; 7 | 8 | let value: LatencyCategory = "tool"; 9 | ``` 10 | 11 | ## Values 12 | 13 | ```typescript 14 | "tts" | "stt" | "llm" | "tool" | "http" 15 | ``` -------------------------------------------------------------------------------- /docs/models/components/latencyunittype.md: -------------------------------------------------------------------------------- 1 | # LatencyUnitType 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { LatencyUnitType } from "syllable-sdk/models/components"; 7 | 8 | let value: LatencyUnitType = "nanoseconds"; 9 | ``` 10 | 11 | ## Values 12 | 13 | ```typescript 14 | "minutes" | "seconds" | "milliseconds" | "microseconds" | "nanoseconds" 15 | ``` -------------------------------------------------------------------------------- /docs/models/components/loc.md: -------------------------------------------------------------------------------- 1 | # Loc 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `string` 7 | 8 | ```typescript 9 | const value: string = ""; 10 | ``` 11 | 12 | ### `number` 13 | 14 | ```typescript 15 | const value: number = 570197; 16 | ``` 17 | 18 | -------------------------------------------------------------------------------- /docs/models/components/orderbydirection.md: -------------------------------------------------------------------------------- 1 | # OrderByDirection 2 | 3 | The direction in which to order list results, either ascending or descending. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { OrderByDirection } from "syllable-sdk/models/components"; 9 | 10 | let value: OrderByDirection = "asc"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "asc" | "desc" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/promptllmprovider.md: -------------------------------------------------------------------------------- 1 | # PromptLlmProvider 2 | 3 | LLM API provider. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { PromptLlmProvider } from "syllable-sdk/models/components"; 9 | 10 | let value: PromptLlmProvider = "google"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "azure_openai" | "google" | "openai" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/promptproperties.md: -------------------------------------------------------------------------------- 1 | # PromptProperties 2 | 3 | Names of prompt fields supported for filtering/sorting on list endpoint. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { PromptProperties } from "syllable-sdk/models/components"; 9 | 10 | let value: PromptProperties = "tools"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "id" | "name" | "description" | "name_description" | "context" | "tools" | "llm_config" | "last_updated" | "last_updated_by" | "agent_count" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/requeststatus.md: -------------------------------------------------------------------------------- 1 | # RequestStatus 2 | 3 | Status of a communication request. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { RequestStatus } from "syllable-sdk/models/components"; 9 | 10 | let value: RequestStatus = "DUPLICATE"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "PENDING" | "DUPLICATE" | "INITIATED" | "CONNECTED" | "FAILED" | "CANCELED" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/requestvariables.md: -------------------------------------------------------------------------------- 1 | # RequestVariables 2 | 3 | Variables for request 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { RequestVariables } from "syllable-sdk/models/components"; 9 | 10 | let value: RequestVariables = {}; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/components/response.md: -------------------------------------------------------------------------------- 1 | # Response 2 | 3 | The response from the agent 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { Response } from "syllable-sdk/models/components"; 9 | 10 | let value: Response = {}; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/components/security.md: -------------------------------------------------------------------------------- 1 | # Security 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { Security } from "syllable-sdk/models/components"; 7 | 8 | let value: Security = {}; 9 | ``` 10 | 11 | ## Fields 12 | 13 | | Field | Type | Required | Description | 14 | | ------------------ | ------------------ | ------------------ | ------------------ | 15 | | `apiKeyHeader` | *string* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/components/servicecreaterequest.md: -------------------------------------------------------------------------------- 1 | # ServiceCreateRequest 2 | 3 | Request model to create a service. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { ServiceCreateRequest } from "syllable-sdk/models/components"; 9 | 10 | let value: ServiceCreateRequest = { 11 | name: "Weather tools", 12 | description: "Service containing tools for fetching weather information", 13 | }; 14 | ``` 15 | 16 | ## Fields 17 | 18 | | Field | Type | Required | Description | Example | 19 | | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | 20 | | `name` | *string* | :heavy_check_mark: | The name of the service | Weather tools | 21 | | `description` | *string* | :heavy_check_mark: | The description of the service | Service containing tools for fetching weather information | -------------------------------------------------------------------------------- /docs/models/components/serviceproperties.md: -------------------------------------------------------------------------------- 1 | # ServiceProperties 2 | 3 | Names of service fields supported for filtering/sorting on list endpoint. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { ServiceProperties } from "syllable-sdk/models/components"; 9 | 10 | let value: ServiceProperties = "name"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "id" | "name" | "description" | "updated_at" | "last_updated_by" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/sessionlabelproperties.md: -------------------------------------------------------------------------------- 1 | # SessionLabelProperties 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { SessionLabelProperties } from "syllable-sdk/models/components"; 7 | 8 | let value: SessionLabelProperties = "session_id_list"; 9 | ``` 10 | 11 | ## Values 12 | 13 | ```typescript 14 | "timestamp" | "session_id" | "type" | "code" | "user_email" | "issue_categories" | "session_id_list" 15 | ``` -------------------------------------------------------------------------------- /docs/models/components/sessionproperties.md: -------------------------------------------------------------------------------- 1 | # SessionProperties 2 | 3 | Names of session fields supported for filtering/sorting on list endpoint. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { SessionProperties } from "syllable-sdk/models/components"; 9 | 10 | let value: SessionProperties = "channel_manager_type"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "timestamp" | "session_id" | "conversation_id" | "channel_manager_service" | "channel_manager_type" | "channel_manager_sid" | "agent_type" | "agent_id" | "agent_name" | "prompt_id" | "prompt_name" | "source" | "target" | "duration" | "is_legacy" | "is_test" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/statictoolparametertype.md: -------------------------------------------------------------------------------- 1 | # StaticToolParameterType 2 | 3 | The expected type for a static tool parameter. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { StaticToolParameterType } from "syllable-sdk/models/components"; 9 | 10 | let value: StaticToolParameterType = "boolean"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "string" | "int" | "boolean" | "data_source_list" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/takeoutrequeststatus.md: -------------------------------------------------------------------------------- 1 | # TakeoutRequestStatus 2 | 3 | Status of a takeout request. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { TakeoutRequestStatus } from "syllable-sdk/models/components"; 9 | 10 | let value: TakeoutRequestStatus = "in_progress"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "pending" | "in_progress" | "completed" | "failed" | "canceled" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/targetmodes.md: -------------------------------------------------------------------------------- 1 | # TargetModes 2 | 3 | Available modes (communication methods) for channel targets. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { TargetModes } from "syllable-sdk/models/components"; 9 | 10 | let value: TargetModes = "voice"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "voice" | "chat" | "sms" | "email" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/toolagentinfo.md: -------------------------------------------------------------------------------- 1 | # ToolAgentInfo 2 | 3 | Information about an agent linked to a tool via a prompt. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { ToolAgentInfo } from "syllable-sdk/models/components"; 9 | 10 | let value: ToolAgentInfo = { 11 | id: 1, 12 | name: "Test Agent", 13 | }; 14 | ``` 15 | 16 | ## Fields 17 | 18 | | Field | Type | Required | Description | Example | 19 | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | 20 | | `id` | *number* | :heavy_check_mark: | The internal ID of the agent | 1 | 21 | | `name` | *string* | :heavy_check_mark: | The name of the agent | Test Agent | -------------------------------------------------------------------------------- /docs/models/components/toolargumentlocation.md: -------------------------------------------------------------------------------- 1 | # ToolArgumentLocation 2 | 3 | The location of the argument in a tool HTTP request. 4 | 'body' is used for JSON data in the POST request body. 5 | 'form' is used for form data in the POST request body. 6 | 'path' is used for URL path parameters. 7 | 'query' is used for query parameters in the URL. 8 | 9 | ## Example Usage 10 | 11 | ```typescript 12 | import { ToolArgumentLocation } from "syllable-sdk/models/components"; 13 | 14 | let value: ToolArgumentLocation = "form"; 15 | ``` 16 | 17 | ## Values 18 | 19 | ```typescript 20 | "body" | "form" | "path" | "query" 21 | ``` -------------------------------------------------------------------------------- /docs/models/components/toolarguments.md: -------------------------------------------------------------------------------- 1 | # ToolArguments 2 | 3 | Arguments for calling the insight tool 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { ToolArguments } from "syllable-sdk/models/components"; 9 | 10 | let value: ToolArguments = {}; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/components/toolhttpmethod.md: -------------------------------------------------------------------------------- 1 | # ToolHttpMethod 2 | 3 | The HTTP method to use for a tool HTTP request. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { ToolHttpMethod } from "syllable-sdk/models/components"; 9 | 10 | let value: ToolHttpMethod = "get"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "get" | "post" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/toolparameters.md: -------------------------------------------------------------------------------- 1 | # ToolParameters 2 | 3 | Parameters for tools that use this definition and their associated types 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { ToolParameters } from "syllable-sdk/models/components"; 9 | 10 | let value: ToolParameters = {}; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/components/toolpromptinfo.md: -------------------------------------------------------------------------------- 1 | # ToolPromptInfo 2 | 3 | Information about a prompt linked to a tool. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { ToolPromptInfo } from "syllable-sdk/models/components"; 9 | 10 | let value: ToolPromptInfo = { 11 | id: 1, 12 | name: "Test Prompt", 13 | }; 14 | ``` 15 | 16 | ## Fields 17 | 18 | | Field | Type | Required | Description | Example | 19 | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- | 20 | | `id` | *number* | :heavy_check_mark: | The ID of the prompt | 1 | 21 | | `name` | *string* | :heavy_check_mark: | The name of the prompt | Test Prompt | -------------------------------------------------------------------------------- /docs/models/components/toolproperties.md: -------------------------------------------------------------------------------- 1 | # ToolProperties 2 | 3 | Names of tool fields supported for filtering/sorting on list endpoint. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { ToolProperties } from "syllable-sdk/models/components"; 9 | 10 | let value: ToolProperties = "id"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "id" | "name" | "service_name" | "definition" | "service_id" | "updated_at" | "last_updated_by" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/toolresultset.md: -------------------------------------------------------------------------------- 1 | # ToolResultSet 2 | 3 | Result key/types for insight tool definition 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { ToolResultSet } from "syllable-sdk/models/components"; 9 | 10 | let value: ToolResultSet = {}; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/components/ttsprovider.md: -------------------------------------------------------------------------------- 1 | # TtsProvider 2 | 3 | TTS provider for an agent voice. 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { TtsProvider } from "syllable-sdk/models/components"; 9 | 10 | let value: TtsProvider = "OpenAI"; 11 | ``` 12 | 13 | ## Values 14 | 15 | ```typescript 16 | "OpenAI" | "ElevenLabs" | "Google" 17 | ``` -------------------------------------------------------------------------------- /docs/models/components/type.md: -------------------------------------------------------------------------------- 1 | # Type 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { Type } from "syllable-sdk/models/components"; 7 | 8 | let value: Type = "endpoint"; 9 | ``` 10 | 11 | ## Values 12 | 13 | ```typescript 14 | "action" | "endpoint" | "context" | "log" 15 | ``` -------------------------------------------------------------------------------- /docs/models/components/validationerror.md: -------------------------------------------------------------------------------- 1 | # ValidationError 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { ValidationError } from "syllable-sdk/models/components"; 7 | 8 | let value: ValidationError = { 9 | loc: [ 10 | "", 11 | ], 12 | msg: "", 13 | type: "", 14 | }; 15 | ``` 16 | 17 | ## Fields 18 | 19 | | Field | Type | Required | Description | 20 | | ------------------ | ------------------ | ------------------ | ------------------ | 21 | | `loc` | *components.Loc*[] | :heavy_check_mark: | N/A | 22 | | `msg` | *string* | :heavy_check_mark: | N/A | 23 | | `type` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/errors/httpvalidationerror.md: -------------------------------------------------------------------------------- 1 | # HTTPValidationError 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { HTTPValidationError } from "syllable-sdk/models/errors"; 7 | 8 | // No examples available for this model 9 | ``` 10 | 11 | ## Fields 12 | 13 | | Field | Type | Required | Description | 14 | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | 15 | | `detail` | [components.ValidationError](../../models/components/validationerror.md)[] | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/agentdeleterequest.md: -------------------------------------------------------------------------------- 1 | # AgentDeleteRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { AgentDeleteRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: AgentDeleteRequest = { 9 | agentId: 24678, 10 | reason: "", 11 | }; 12 | ``` 13 | 14 | ## Fields 15 | 16 | | Field | Type | Required | Description | 17 | | ------------------ | ------------------ | ------------------ | ------------------ | 18 | | `agentId` | *number* | :heavy_check_mark: | N/A | 19 | | `reason` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/agentgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # AgentGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { AgentGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: AgentGetByIdRequest = { 9 | agentId: 179603, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `agentId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/channeltargetsdeleterequest.md: -------------------------------------------------------------------------------- 1 | # ChannelTargetsDeleteRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { ChannelTargetsDeleteRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: ChannelTargetsDeleteRequest = { 9 | channelId: "", 10 | targetId: "", 11 | }; 12 | ``` 13 | 14 | ## Fields 15 | 16 | | Field | Type | Required | Description | 17 | | ------------------ | ------------------ | ------------------ | ------------------ | 18 | | `channelId` | *string* | :heavy_check_mark: | N/A | 19 | | `targetId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/channeltargetsgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # ChannelTargetsGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { ChannelTargetsGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: ChannelTargetsGetByIdRequest = { 9 | channelId: 896672, 10 | targetId: 990339, 11 | }; 12 | ``` 13 | 14 | ## Fields 15 | 16 | | Field | Type | Required | Description | 17 | | ------------------ | ------------------ | ------------------ | ------------------ | 18 | | `channelId` | *number* | :heavy_check_mark: | N/A | 19 | | `targetId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/custommessagegetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # CustomMessageGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { CustomMessageGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: CustomMessageGetByIdRequest = { 9 | customMessageId: 687488, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `customMessageId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/custommessagesdeleterequest.md: -------------------------------------------------------------------------------- 1 | # CustomMessagesDeleteRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { CustomMessagesDeleteRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: CustomMessagesDeleteRequest = { 9 | customMessageId: 215507, 10 | reason: "", 11 | }; 12 | ``` 13 | 14 | ## Fields 15 | 16 | | Field | Type | Required | Description | 17 | | ------------------ | ------------------ | ------------------ | ------------------ | 18 | | `customMessageId` | *number* | :heavy_check_mark: | N/A | 19 | | `reason` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/datasourcesdeleterequest.md: -------------------------------------------------------------------------------- 1 | # DataSourcesDeleteRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { DataSourcesDeleteRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: DataSourcesDeleteRequest = { 9 | dataSourceId: 320017, 10 | reason: "", 11 | }; 12 | ``` 13 | 14 | ## Fields 15 | 16 | | Field | Type | Required | Description | 17 | | ------------------ | ------------------ | ------------------ | ------------------ | 18 | | `dataSourceId` | *number* | :heavy_check_mark: | N/A | 19 | | `reason` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/datasourcesgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # DataSourcesGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { DataSourcesGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: DataSourcesGetByIdRequest = { 9 | dataSourceId: 758379, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `dataSourceId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/generatesessionrecordingurlsrequest.md: -------------------------------------------------------------------------------- 1 | # GenerateSessionRecordingUrlsRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { GenerateSessionRecordingUrlsRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: GenerateSessionRecordingUrlsRequest = { 9 | sessionId: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `sessionId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/getsessiondatabysessionidrequest.md: -------------------------------------------------------------------------------- 1 | # GetSessionDataBySessionIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { GetSessionDataBySessionIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: GetSessionDataBySessionIdRequest = { 9 | sessionId: 374170, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `sessionId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/getsessiondatabysidrequest.md: -------------------------------------------------------------------------------- 1 | # GetSessionDataBySidRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { GetSessionDataBySidRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: GetSessionDataBySidRequest = { 9 | channelManagerService: "", 10 | channelManagerSid: "", 11 | }; 12 | ``` 13 | 14 | ## Fields 15 | 16 | | Field | Type | Required | Description | 17 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 18 | | `channelManagerService` | *string* | :heavy_check_mark: | N/A | 19 | | `channelManagerSid` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/getsessiontoolcallresultbyidrequest.md: -------------------------------------------------------------------------------- 1 | # GetSessionToolCallResultByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { GetSessionToolCallResultByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: GetSessionToolCallResultByIdRequest = { 9 | sessionId: 463575, 10 | toolCallId: "", 11 | }; 12 | ``` 13 | 14 | ## Fields 15 | 16 | | Field | Type | Required | Description | 17 | | ------------------ | ------------------ | ------------------ | ------------------ | 18 | | `sessionId` | *number* | :heavy_check_mark: | N/A | 19 | | `toolCallId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/incidentdeleterequest.md: -------------------------------------------------------------------------------- 1 | # IncidentDeleteRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { IncidentDeleteRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: IncidentDeleteRequest = { 9 | incidentId: 628982, 10 | reason: "", 11 | }; 12 | ``` 13 | 14 | ## Fields 15 | 16 | | Field | Type | Required | Description | 17 | | ------------------ | ------------------ | ------------------ | ------------------ | 18 | | `incidentId` | *number* | :heavy_check_mark: | N/A | 19 | | `reason` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/incidentgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # IncidentGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { IncidentGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: IncidentGetByIdRequest = { 9 | incidentId: 831049, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `incidentId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/insightsworkflowdeleterequest.md: -------------------------------------------------------------------------------- 1 | # InsightsWorkflowDeleteRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { InsightsWorkflowDeleteRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: InsightsWorkflowDeleteRequest = { 9 | workflowId: 185636, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `workflowId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/insightsworkflowgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # InsightsWorkflowGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { InsightsWorkflowGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: InsightsWorkflowGetByIdRequest = { 9 | workflowId: 273542, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `workflowId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/insighttoolgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # InsightToolGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { InsightToolGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: InsightToolGetByIdRequest = { 9 | toolId: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `toolId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/languagegroupsdeleterequest.md: -------------------------------------------------------------------------------- 1 | # LanguageGroupsDeleteRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { LanguageGroupsDeleteRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: LanguageGroupsDeleteRequest = { 9 | languageGroupId: 144847, 10 | reason: "", 11 | }; 12 | ``` 13 | 14 | ## Fields 15 | 16 | | Field | Type | Required | Description | 17 | | ------------------ | ------------------ | ------------------ | ------------------ | 18 | | `languageGroupId` | *number* | :heavy_check_mark: | N/A | 19 | | `reason` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/languagegroupsgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # LanguageGroupsGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { LanguageGroupsGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: LanguageGroupsGetByIdRequest = { 9 | languageGroupId: 183280, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `languageGroupId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/outboundbatchgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # OutboundBatchGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { OutboundBatchGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: OutboundBatchGetByIdRequest = { 9 | batchId: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `batchId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/outboundbatchremoverequest.md: -------------------------------------------------------------------------------- 1 | # OutboundBatchRemoveRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { OutboundBatchRemoveRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: OutboundBatchRemoveRequest = { 9 | batchId: "", 10 | requestBody: [ 11 | "", 12 | ], 13 | }; 14 | ``` 15 | 16 | ## Fields 17 | 18 | | Field | Type | Required | Description | 19 | | ------------------ | ------------------ | ------------------ | ------------------ | 20 | | `batchId` | *string* | :heavy_check_mark: | N/A | 21 | | `requestBody` | *string*[] | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/outboundbatchresultsrequest.md: -------------------------------------------------------------------------------- 1 | # OutboundBatchResultsRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { OutboundBatchResultsRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: OutboundBatchResultsRequest = { 9 | batchId: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `batchId` | *string* | :heavy_check_mark: | N/A | 18 | | `referenceId` | *string* | :heavy_minus_sign: | N/A | 19 | | `status` | *string* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/outboundcampaigngetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # OutboundCampaignGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { OutboundCampaignGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: OutboundCampaignGetByIdRequest = { 9 | campaignId: 117531, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `campaignId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/postgetdashboardrequest.md: -------------------------------------------------------------------------------- 1 | # PostGetDashboardRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { PostGetDashboardRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: PostGetDashboardRequest = { 9 | dashboardName: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `dashboardName` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/promptsdeleterequest.md: -------------------------------------------------------------------------------- 1 | # PromptsDeleteRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { PromptsDeleteRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: PromptsDeleteRequest = { 9 | promptId: 730856, 10 | reason: "", 11 | }; 12 | ``` 13 | 14 | ## Fields 15 | 16 | | Field | Type | Required | Description | 17 | | ------------------ | ------------------ | ------------------ | ------------------ | 18 | | `promptId` | *number* | :heavy_check_mark: | N/A | 19 | | `reason` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/promptsgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # PromptsGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { PromptsGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: PromptsGetByIdRequest = { 9 | promptId: 947371, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `promptId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/promptshistoryrequest.md: -------------------------------------------------------------------------------- 1 | # PromptsHistoryRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { PromptsHistoryRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: PromptsHistoryRequest = { 9 | promptId: 253941, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `promptId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/queuesessionsworkflowresponsequeuesessionsworkflow.md: -------------------------------------------------------------------------------- 1 | # QueueSessionsWorkflowResponseQueueSessionsWorkflow 2 | 3 | Successful Response 4 | 5 | ## Example Usage 6 | 7 | ```typescript 8 | import { QueueSessionsWorkflowResponseQueueSessionsWorkflow } from "syllable-sdk/models/operations"; 9 | 10 | let value: QueueSessionsWorkflowResponseQueueSessionsWorkflow = {}; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ----------- | ----------- | ----------- | ----------- | -------------------------------------------------------------------------------- /docs/models/operations/servicedeleterequest.md: -------------------------------------------------------------------------------- 1 | # ServiceDeleteRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { ServiceDeleteRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: ServiceDeleteRequest = { 9 | serviceId: 518201, 10 | reason: "", 11 | }; 12 | ``` 13 | 14 | ## Fields 15 | 16 | | Field | Type | Required | Description | 17 | | ------------------ | ------------------ | ------------------ | ------------------ | 18 | | `serviceId` | *number* | :heavy_check_mark: | N/A | 19 | | `reason` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/servicesgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # ServicesGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { ServicesGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: ServicesGetByIdRequest = { 9 | serviceId: 213312, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `serviceId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/sessionfullsummarygetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # SessionFullSummaryGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { SessionFullSummaryGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: SessionFullSummaryGetByIdRequest = { 9 | sessionId: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `sessionId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/sessiongetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # SessionGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { SessionGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: SessionGetByIdRequest = { 9 | sessionId: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `sessionId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/sessionlabelgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # SessionLabelGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { SessionLabelGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: SessionLabelGetByIdRequest = { 9 | sessionLabelId: 25662, 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `sessionLabelId` | *number* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/sessionlatencygetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # SessionLatencyGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { SessionLatencyGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: SessionLatencyGetByIdRequest = { 9 | sessionId: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `sessionId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/sessionrecordingstreamrequest.md: -------------------------------------------------------------------------------- 1 | # SessionRecordingStreamRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { SessionRecordingStreamRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: SessionRecordingStreamRequest = { 9 | token: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `token` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/sessiontranscriptgetbyidrequest.md: -------------------------------------------------------------------------------- 1 | # SessionTranscriptGetByIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { SessionTranscriptGetByIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: SessionTranscriptGetByIdRequest = { 9 | sessionId: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `sessionId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/takeoutsgetbyjobidrequest.md: -------------------------------------------------------------------------------- 1 | # TakeoutsGetByJobIdRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { TakeoutsGetByJobIdRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: TakeoutsGetByJobIdRequest = { 9 | jobId: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `jobId` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/tooldeleterequest.md: -------------------------------------------------------------------------------- 1 | # ToolDeleteRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { ToolDeleteRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: ToolDeleteRequest = { 9 | toolName: "", 10 | reason: "", 11 | }; 12 | ``` 13 | 14 | ## Fields 15 | 16 | | Field | Type | Required | Description | 17 | | ------------------ | ------------------ | ------------------ | ------------------ | 18 | | `toolName` | *string* | :heavy_check_mark: | N/A | 19 | | `reason` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/toolgetbynamerequest.md: -------------------------------------------------------------------------------- 1 | # ToolGetByNameRequest 2 | 3 | ## Example Usage 4 | 5 | ```typescript 6 | import { ToolGetByNameRequest } from "syllable-sdk/models/operations"; 7 | 8 | let value: ToolGetByNameRequest = { 9 | toolName: "", 10 | }; 11 | ``` 12 | 13 | ## Fields 14 | 15 | | Field | Type | Required | Description | 16 | | ------------------ | ------------------ | ------------------ | ------------------ | 17 | | `toolName` | *string* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/sdks/outbound/README.md: -------------------------------------------------------------------------------- 1 | # Outbound 2 | (*outbound*) 3 | 4 | ## Overview 5 | 6 | ### Available Operations 7 | -------------------------------------------------------------------------------- /docs/sdks/syllablesdk/README.md: -------------------------------------------------------------------------------- 1 | # SyllableSDK 2 | 3 | ## Overview 4 | 5 | SyllableSDK: 6 | # Syllable Platform SDK 7 | 8 | Syllable SDK gives you the power of awesome AI agentry. 🚀 9 | 10 | ## Overview 11 | 12 | The Syllable SDK provides a comprehensive set of tools and APIs to integrate powerful AI 13 | capabilities into your communication applications. Whether you're building chatbots, virtual 14 | assistants, or any other AI-driven solutions, Syllable SDK has got you covered. 15 | 16 | ## Features 17 | 18 | - **Natural Language Processing (NLP)**: Understand and generate human language with ease. 19 | - **Machine Learning Models**: Leverage pre-trained models or train your own custom models. 20 | - **Speech Recognition**: Convert speech to text and vice versa. 21 | - **Data Analytics**: Analyze and visualize data to gain insights. 22 | - **Integration**: Seamlessly integrate with other services and platforms. 23 | 24 | 25 | 26 | ### Available Operations 27 | -------------------------------------------------------------------------------- /eslint.config.mjs: -------------------------------------------------------------------------------- 1 | import globals from "globals"; 2 | import pluginJs from "@eslint/js"; 3 | import tseslint from "typescript-eslint"; 4 | 5 | /** @type {import('eslint').Linter.Config[]} */ 6 | export default [ 7 | { files: ["**/*.{js,mjs,cjs,ts}"] }, 8 | { languageOptions: { globals: globals.browser } }, 9 | pluginJs.configs.recommended, 10 | ...tseslint.configs.recommended, 11 | { 12 | rules: { 13 | "no-constant-condition": "off", 14 | // Handled by typescript compiler 15 | "@typescript-eslint/no-unused-vars": "off", 16 | "@typescript-eslint/no-explicit-any": "off", 17 | "@typescript-eslint/no-empty-object-type": "off", 18 | "@typescript-eslint/no-namespace": "off", 19 | }, 20 | }, 21 | ]; 22 | -------------------------------------------------------------------------------- /home.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Home" 3 | description: "Welcome to Syllable AI SDK" 4 | --- 5 | 6 | Syllable SDK: 7 | 8 | # Syllable Platform SDK 9 | 10 | Syllable SDK gives you the power of awesome AI agentry. 🚀 11 | 12 | ## Overview 13 | 14 | The Syllable SDK provides a comprehensive set of tools and APIs to integrate powerful AI 15 | capabilities into your communication applications. Whether you're building chatbots, virtual 16 | assistants, or any other AI-driven solutions, Syllable SDK has got you covered. 17 | 18 | ## Features 19 | 20 | * **Natural Language Processing (NLP)**: Understand and generate human language with ease. 21 | 22 | * **Machine Learning Models**: Leverage pre-trained models or train your own custom models. 23 | 24 | * **Speech Recognition**: Convert speech to text and vice versa. 25 | 26 | * **Data Analytics**: Analyze and visualize data to gain insights. 27 | 28 | * **Integration**: Seamlessly integrate with other services and platforms. -------------------------------------------------------------------------------- /jsr.json: -------------------------------------------------------------------------------- 1 | 2 | 3 | { 4 | "name": "syllable-sdk", 5 | "version": "0.1.0-alpha.88", 6 | "exports": { 7 | ".": "./src/index.ts", 8 | "./models/errors": "./src/models/errors/index.ts", 9 | "./models/components": "./src/models/components/index.ts", 10 | "./models/operations": "./src/models/operations/index.ts", 11 | "./lib/config": "./src/lib/config.ts", 12 | "./lib/http": "./src/lib/http.ts", 13 | "./lib/retries": "./src/lib/retries.ts", 14 | "./lib/sdks": "./src/lib/sdks.ts", 15 | "./types": "./src/types/index.ts" 16 | }, 17 | "publish": { 18 | "include": [ 19 | "LICENSE", 20 | "README.md", 21 | "RUNTIMES.md", 22 | "USAGE.md", 23 | "jsr.json", 24 | "src/**/*.ts" 25 | ] 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "syllable-sdk", 3 | "version": "0.1.0-alpha.88", 4 | "author": "Syllable", 5 | "main": "./index.js", 6 | "sideEffects": false, 7 | "repository": { 8 | "type": "git", 9 | "url": "https://github.com/asksyllable/syllable-sdk-typescript.git" 10 | }, 11 | "scripts": { 12 | "lint": "eslint --cache --max-warnings=0 src", 13 | "build": "tsc", 14 | "prepublishOnly": "npm run build" 15 | }, 16 | "peerDependencies": { 17 | "zod": ">= 3" 18 | }, 19 | "devDependencies": { 20 | "@eslint/js": "^9.19.0", 21 | "eslint": "^9.19.0", 22 | "globals": "^15.14.0", 23 | "typescript": "^5.4.5", 24 | "typescript-eslint": "^8.22.0", 25 | "zod": "^3.23.4" 26 | }, 27 | "dependencies": { 28 | 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /src/core.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import { ClientSDK } from "./lib/sdks.js"; 6 | 7 | /** 8 | * A minimal client to use when calling standalone SDK functions. Typically, an 9 | * instance of this class would be instantiated once at the start of an 10 | * application and passed around through some dependency injection mechanism to 11 | * parts of an application that need to make SDK calls. 12 | */ 13 | export class SyllableSDKCore extends ClientSDK {} 14 | -------------------------------------------------------------------------------- /src/hooks/index.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | export * from "./hooks.js"; 6 | export * from "./types.js"; 7 | -------------------------------------------------------------------------------- /src/hooks/registration.ts: -------------------------------------------------------------------------------- 1 | import { Hooks } from "./types.js"; 2 | 3 | /* 4 | * This file is only ever generated once on the first generation and then is free to be modified. 5 | * Any hooks you wish to add should be registered in the initHooks function. Feel free to define them 6 | * in this file or in separate files in the hooks folder. 7 | */ 8 | 9 | // @ts-expect-error remove this line when you add your first hook and hooks is used 10 | export function initHooks(hooks: Hooks) { 11 | // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook 12 | // with an instance of a hook that implements that specific Hook interface 13 | // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance 14 | } 15 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | export * from "./lib/config.js"; 6 | export * as files from "./lib/files.js"; 7 | export * from "./sdk/sdk.js"; 8 | -------------------------------------------------------------------------------- /src/lib/base64.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | 7 | export function bytesToBase64(u8arr: Uint8Array): string { 8 | return btoa(String.fromCodePoint(...u8arr)); 9 | } 10 | 11 | export function bytesFromBase64(encoded: string): Uint8Array { 12 | return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0)); 13 | } 14 | 15 | export function stringToBytes(str: string): Uint8Array { 16 | return new TextEncoder().encode(str); 17 | } 18 | 19 | export function stringFromBytes(u8arr: Uint8Array): string { 20 | return new TextDecoder().decode(u8arr); 21 | } 22 | 23 | export function stringToBase64(str: string): string { 24 | return bytesToBase64(stringToBytes(str)); 25 | } 26 | 27 | export function stringFromBase64(b64str: string): string { 28 | return stringFromBytes(bytesFromBase64(b64str)); 29 | } 30 | 31 | export const zodOutbound = z 32 | .instanceof(Uint8Array) 33 | .or(z.string().transform(stringToBytes)); 34 | 35 | export const zodInbound = z 36 | .instanceof(Uint8Array) 37 | .or(z.string().transform(bytesFromBase64)); 38 | -------------------------------------------------------------------------------- /src/lib/env.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import { dlv } from "./dlv.js"; 6 | 7 | import * as z from "zod"; 8 | 9 | export interface Env { 10 | SYLLABLESDK_API_KEY_HEADER?: string | undefined; 11 | 12 | SYLLABLESDK_DEBUG?: boolean | undefined; 13 | } 14 | 15 | export const envSchema: z.ZodType = z.object({ 16 | SYLLABLESDK_API_KEY_HEADER: z.string().optional(), 17 | 18 | SYLLABLESDK_DEBUG: z.coerce.boolean().optional(), 19 | }); 20 | 21 | let envMemo: Env | undefined = undefined; 22 | /** 23 | * Reads and validates environment variables. 24 | */ 25 | export function env(): Env { 26 | if (envMemo) { 27 | return envMemo; 28 | } 29 | 30 | envMemo = envSchema.parse( 31 | dlv(globalThis, "process.env") ?? dlv(globalThis, "Deno.env") ?? {}, 32 | ); 33 | return envMemo; 34 | } 35 | 36 | /** 37 | * Clears the cached env object. Useful for testing with a fresh environment. 38 | */ 39 | export function resetEnv() { 40 | envMemo = undefined; 41 | } 42 | -------------------------------------------------------------------------------- /src/lib/files.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | /** 6 | * Consumes a stream and returns a concatenated array buffer. Useful in 7 | * situations where we need to read the whole file because it forms part of a 8 | * larger payload containing other fields, and we can't modify the underlying 9 | * request structure. 10 | */ 11 | export async function readableStreamToArrayBuffer( 12 | readable: ReadableStream, 13 | ): Promise { 14 | const reader = readable.getReader(); 15 | const chunks: Uint8Array[] = []; 16 | 17 | let totalLength = 0; 18 | let done = false; 19 | 20 | while (!done) { 21 | const { value, done: doneReading } = await reader.read(); 22 | 23 | if (doneReading) { 24 | done = true; 25 | } else { 26 | chunks.push(value); 27 | totalLength += value.length; 28 | } 29 | } 30 | 31 | const concatenatedChunks = new Uint8Array(totalLength); 32 | let offset = 0; 33 | 34 | for (const chunk of chunks) { 35 | concatenatedChunks.set(chunk, offset); 36 | offset += chunk.length; 37 | } 38 | 39 | return concatenatedChunks.buffer; 40 | } 41 | -------------------------------------------------------------------------------- /src/lib/logger.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | export interface Logger { 6 | group(label?: string): void; 7 | groupEnd(): void; 8 | log(message: any, ...args: any[]): void; 9 | } 10 | -------------------------------------------------------------------------------- /src/lib/url.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | const hasOwn = Object.prototype.hasOwnProperty; 6 | 7 | export type Params = Partial>; 8 | 9 | export function pathToFunc( 10 | pathPattern: string, 11 | options?: { charEncoding?: "percent" | "none" }, 12 | ): (params?: Params) => string { 13 | const paramRE = /\{([a-zA-Z0-9_]+?)\}/g; 14 | 15 | return function buildURLPath(params: Record = {}): string { 16 | return pathPattern.replace(paramRE, function (_, placeholder) { 17 | if (!hasOwn.call(params, placeholder)) { 18 | throw new Error(`Parameter '${placeholder}' is required`); 19 | } 20 | 21 | const value = params[placeholder]; 22 | if (typeof value !== "string" && typeof value !== "number") { 23 | throw new Error( 24 | `Parameter '${placeholder}' must be a string or number`, 25 | ); 26 | } 27 | 28 | return options?.charEncoding === "percent" 29 | ? encodeURIComponent(`${value}`) 30 | : `${value}`; 31 | }); 32 | }; 33 | } 34 | -------------------------------------------------------------------------------- /src/models/components/agentsttprovider.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Speech-to-text providers supported by agents. 10 | */ 11 | export const AgentSttProvider = { 12 | GoogleSTTV1: "Google STT V1", 13 | GoogleSTTV2: "Google STT V2", 14 | DeepgramNova2: "Deepgram Nova 2", 15 | } as const; 16 | /** 17 | * Speech-to-text providers supported by agents. 18 | */ 19 | export type AgentSttProvider = ClosedEnum; 20 | 21 | /** @internal */ 22 | export const AgentSttProvider$inboundSchema: z.ZodNativeEnum< 23 | typeof AgentSttProvider 24 | > = z.nativeEnum(AgentSttProvider); 25 | 26 | /** @internal */ 27 | export const AgentSttProvider$outboundSchema: z.ZodNativeEnum< 28 | typeof AgentSttProvider 29 | > = AgentSttProvider$inboundSchema; 30 | 31 | /** 32 | * @internal 33 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 34 | */ 35 | export namespace AgentSttProvider$ { 36 | /** @deprecated use `AgentSttProvider$inboundSchema` instead. */ 37 | export const inboundSchema = AgentSttProvider$inboundSchema; 38 | /** @deprecated use `AgentSttProvider$outboundSchema` instead. */ 39 | export const outboundSchema = AgentSttProvider$outboundSchema; 40 | } 41 | -------------------------------------------------------------------------------- /src/models/components/agentvoicegender.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Gender for an agent voice. 10 | */ 11 | export const AgentVoiceGender = { 12 | Female: "female", 13 | Male: "male", 14 | } as const; 15 | /** 16 | * Gender for an agent voice. 17 | */ 18 | export type AgentVoiceGender = ClosedEnum; 19 | 20 | /** @internal */ 21 | export const AgentVoiceGender$inboundSchema: z.ZodNativeEnum< 22 | typeof AgentVoiceGender 23 | > = z.nativeEnum(AgentVoiceGender); 24 | 25 | /** @internal */ 26 | export const AgentVoiceGender$outboundSchema: z.ZodNativeEnum< 27 | typeof AgentVoiceGender 28 | > = AgentVoiceGender$inboundSchema; 29 | 30 | /** 31 | * @internal 32 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 33 | */ 34 | export namespace AgentVoiceGender$ { 35 | /** @deprecated use `AgentVoiceGender$inboundSchema` instead. */ 36 | export const inboundSchema = AgentVoiceGender$inboundSchema; 37 | /** @deprecated use `AgentVoiceGender$outboundSchema` instead. */ 38 | export const outboundSchema = AgentVoiceGender$outboundSchema; 39 | } 40 | -------------------------------------------------------------------------------- /src/models/components/agentvoicemodel.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Model for an agent voice. 10 | */ 11 | export const AgentVoiceModel = { 12 | MultilingualV2: "Multilingual_v2", 13 | Neural2: "Neural2", 14 | Standard: "Standard", 15 | Studio: "Studio", 16 | WaveNet: "WaveNet", 17 | Whisper: "Whisper", 18 | } as const; 19 | /** 20 | * Model for an agent voice. 21 | */ 22 | export type AgentVoiceModel = ClosedEnum; 23 | 24 | /** @internal */ 25 | export const AgentVoiceModel$inboundSchema: z.ZodNativeEnum< 26 | typeof AgentVoiceModel 27 | > = z.nativeEnum(AgentVoiceModel); 28 | 29 | /** @internal */ 30 | export const AgentVoiceModel$outboundSchema: z.ZodNativeEnum< 31 | typeof AgentVoiceModel 32 | > = AgentVoiceModel$inboundSchema; 33 | 34 | /** 35 | * @internal 36 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 37 | */ 38 | export namespace AgentVoiceModel$ { 39 | /** @deprecated use `AgentVoiceModel$inboundSchema` instead. */ 40 | export const inboundSchema = AgentVoiceModel$inboundSchema; 41 | /** @deprecated use `AgentVoiceModel$outboundSchema` instead. */ 42 | export const outboundSchema = AgentVoiceModel$outboundSchema; 43 | } 44 | -------------------------------------------------------------------------------- /src/models/components/agentwaitsound.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Wait sounds supported by agents. 10 | */ 11 | export const AgentWaitSound = { 12 | NoSound: "No Sound", 13 | Keyboard1: "Keyboard 1", 14 | Keyboard2: "Keyboard 2", 15 | CallCenter: "Call Center", 16 | } as const; 17 | /** 18 | * Wait sounds supported by agents. 19 | */ 20 | export type AgentWaitSound = ClosedEnum; 21 | 22 | /** @internal */ 23 | export const AgentWaitSound$inboundSchema: z.ZodNativeEnum< 24 | typeof AgentWaitSound 25 | > = z.nativeEnum(AgentWaitSound); 26 | 27 | /** @internal */ 28 | export const AgentWaitSound$outboundSchema: z.ZodNativeEnum< 29 | typeof AgentWaitSound 30 | > = AgentWaitSound$inboundSchema; 31 | 32 | /** 33 | * @internal 34 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 35 | */ 36 | export namespace AgentWaitSound$ { 37 | /** @deprecated use `AgentWaitSound$inboundSchema` instead. */ 38 | export const inboundSchema = AgentWaitSound$inboundSchema; 39 | /** @deprecated use `AgentWaitSound$outboundSchema` instead. */ 40 | export const outboundSchema = AgentWaitSound$outboundSchema; 41 | } 42 | -------------------------------------------------------------------------------- /src/models/components/batchproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | export const BatchProperties = { 9 | BatchId: "batch_id", 10 | CampaignId: "campaign_id", 11 | Status: "status", 12 | ExpiresOn: "expires_on", 13 | } as const; 14 | export type BatchProperties = ClosedEnum; 15 | 16 | /** @internal */ 17 | export const BatchProperties$inboundSchema: z.ZodNativeEnum< 18 | typeof BatchProperties 19 | > = z.nativeEnum(BatchProperties); 20 | 21 | /** @internal */ 22 | export const BatchProperties$outboundSchema: z.ZodNativeEnum< 23 | typeof BatchProperties 24 | > = BatchProperties$inboundSchema; 25 | 26 | /** 27 | * @internal 28 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 29 | */ 30 | export namespace BatchProperties$ { 31 | /** @deprecated use `BatchProperties$inboundSchema` instead. */ 32 | export const inboundSchema = BatchProperties$inboundSchema; 33 | /** @deprecated use `BatchProperties$outboundSchema` instead. */ 34 | export const outboundSchema = BatchProperties$outboundSchema; 35 | } 36 | -------------------------------------------------------------------------------- /src/models/components/batchstatus.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Status of a communication batch. 10 | */ 11 | export const BatchStatus = { 12 | Pending: "PENDING", 13 | Active: "ACTIVE", 14 | Paused: "PAUSED", 15 | Failed: "FAILED", 16 | Canceled: "CANCELED", 17 | Expired: "EXPIRED", 18 | } as const; 19 | /** 20 | * Status of a communication batch. 21 | */ 22 | export type BatchStatus = ClosedEnum; 23 | 24 | /** @internal */ 25 | export const BatchStatus$inboundSchema: z.ZodNativeEnum = z 26 | .nativeEnum(BatchStatus); 27 | 28 | /** @internal */ 29 | export const BatchStatus$outboundSchema: z.ZodNativeEnum = 30 | BatchStatus$inboundSchema; 31 | 32 | /** 33 | * @internal 34 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 35 | */ 36 | export namespace BatchStatus$ { 37 | /** @deprecated use `BatchStatus$inboundSchema` instead. */ 38 | export const inboundSchema = BatchStatus$inboundSchema; 39 | /** @deprecated use `BatchStatus$outboundSchema` instead. */ 40 | export const outboundSchema = BatchStatus$outboundSchema; 41 | } 42 | -------------------------------------------------------------------------------- /src/models/components/campaignproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | export const CampaignProperties = { 9 | Id: "id", 10 | CampaignName: "campaign_name", 11 | CampaignVariables: "campaign_variables", 12 | DailyStartTime: "daily_start_time", 13 | DailyEndTime: "daily_end_time", 14 | Source: "source", 15 | CallerId: "caller_id", 16 | } as const; 17 | export type CampaignProperties = ClosedEnum; 18 | 19 | /** @internal */ 20 | export const CampaignProperties$inboundSchema: z.ZodNativeEnum< 21 | typeof CampaignProperties 22 | > = z.nativeEnum(CampaignProperties); 23 | 24 | /** @internal */ 25 | export const CampaignProperties$outboundSchema: z.ZodNativeEnum< 26 | typeof CampaignProperties 27 | > = CampaignProperties$inboundSchema; 28 | 29 | /** 30 | * @internal 31 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 32 | */ 33 | export namespace CampaignProperties$ { 34 | /** @deprecated use `CampaignProperties$inboundSchema` instead. */ 35 | export const inboundSchema = CampaignProperties$inboundSchema; 36 | /** @deprecated use `CampaignProperties$outboundSchema` instead. */ 37 | export const outboundSchema = CampaignProperties$outboundSchema; 38 | } 39 | -------------------------------------------------------------------------------- /src/models/components/channelproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Names of channel fields supported for filtering/sorting on list endpoint. 10 | */ 11 | export const ChannelProperties = { 12 | Id: "id", 13 | Name: "name", 14 | ChannelService: "channel_service", 15 | SupportedModes: "supported_modes", 16 | } as const; 17 | /** 18 | * Names of channel fields supported for filtering/sorting on list endpoint. 19 | */ 20 | export type ChannelProperties = ClosedEnum; 21 | 22 | /** @internal */ 23 | export const ChannelProperties$inboundSchema: z.ZodNativeEnum< 24 | typeof ChannelProperties 25 | > = z.nativeEnum(ChannelProperties); 26 | 27 | /** @internal */ 28 | export const ChannelProperties$outboundSchema: z.ZodNativeEnum< 29 | typeof ChannelProperties 30 | > = ChannelProperties$inboundSchema; 31 | 32 | /** 33 | * @internal 34 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 35 | */ 36 | export namespace ChannelProperties$ { 37 | /** @deprecated use `ChannelProperties$inboundSchema` instead. */ 38 | export const inboundSchema = ChannelProperties$inboundSchema; 39 | /** @deprecated use `ChannelProperties$outboundSchema` instead. */ 40 | export const outboundSchema = ChannelProperties$outboundSchema; 41 | } 42 | -------------------------------------------------------------------------------- /src/models/components/channelservices.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * The communication service for a channel. 10 | */ 11 | export const ChannelServices = { 12 | Sip: "sip", 13 | Twilio: "twilio", 14 | Email: "email", 15 | Webchat: "webchat", 16 | } as const; 17 | /** 18 | * The communication service for a channel. 19 | */ 20 | export type ChannelServices = ClosedEnum; 21 | 22 | /** @internal */ 23 | export const ChannelServices$inboundSchema: z.ZodNativeEnum< 24 | typeof ChannelServices 25 | > = z.nativeEnum(ChannelServices); 26 | 27 | /** @internal */ 28 | export const ChannelServices$outboundSchema: z.ZodNativeEnum< 29 | typeof ChannelServices 30 | > = ChannelServices$inboundSchema; 31 | 32 | /** 33 | * @internal 34 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 35 | */ 36 | export namespace ChannelServices$ { 37 | /** @deprecated use `ChannelServices$inboundSchema` instead. */ 38 | export const inboundSchema = ChannelServices$inboundSchema; 39 | /** @deprecated use `ChannelServices$outboundSchema` instead. */ 40 | export const outboundSchema = ChannelServices$outboundSchema; 41 | } 42 | -------------------------------------------------------------------------------- /src/models/components/conversationproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | export const ConversationProperties = { 9 | Timestamp: "timestamp", 10 | AgentType: "agent_type", 11 | AgentId: "agent_id", 12 | AgentName: "agent_name", 13 | PromptId: "prompt_id", 14 | PromptName: "prompt_name", 15 | LlmProvider: "llm_provider", 16 | LlmModel: "llm_model", 17 | LlmVersion: "llm_version", 18 | IsLegacy: "is_legacy", 19 | } as const; 20 | export type ConversationProperties = ClosedEnum; 21 | 22 | /** @internal */ 23 | export const ConversationProperties$inboundSchema: z.ZodNativeEnum< 24 | typeof ConversationProperties 25 | > = z.nativeEnum(ConversationProperties); 26 | 27 | /** @internal */ 28 | export const ConversationProperties$outboundSchema: z.ZodNativeEnum< 29 | typeof ConversationProperties 30 | > = ConversationProperties$inboundSchema; 31 | 32 | /** 33 | * @internal 34 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 35 | */ 36 | export namespace ConversationProperties$ { 37 | /** @deprecated use `ConversationProperties$inboundSchema` instead. */ 38 | export const inboundSchema = ConversationProperties$inboundSchema; 39 | /** @deprecated use `ConversationProperties$outboundSchema` instead. */ 40 | export const outboundSchema = ConversationProperties$outboundSchema; 41 | } 42 | -------------------------------------------------------------------------------- /src/models/components/custommessageproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | export const CustomMessageProperties = { 9 | Id: "id", 10 | Name: "name", 11 | Text: "text", 12 | Label: "label", 13 | UpdatedAt: "updated_at", 14 | } as const; 15 | export type CustomMessageProperties = ClosedEnum< 16 | typeof CustomMessageProperties 17 | >; 18 | 19 | /** @internal */ 20 | export const CustomMessageProperties$inboundSchema: z.ZodNativeEnum< 21 | typeof CustomMessageProperties 22 | > = z.nativeEnum(CustomMessageProperties); 23 | 24 | /** @internal */ 25 | export const CustomMessageProperties$outboundSchema: z.ZodNativeEnum< 26 | typeof CustomMessageProperties 27 | > = CustomMessageProperties$inboundSchema; 28 | 29 | /** 30 | * @internal 31 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 32 | */ 33 | export namespace CustomMessageProperties$ { 34 | /** @deprecated use `CustomMessageProperties$inboundSchema` instead. */ 35 | export const inboundSchema = CustomMessageProperties$inboundSchema; 36 | /** @deprecated use `CustomMessageProperties$outboundSchema` instead. */ 37 | export const outboundSchema = CustomMessageProperties$outboundSchema; 38 | } 39 | -------------------------------------------------------------------------------- /src/models/components/dashboardproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Names of dashboard fields supported for filtering/sorting on list endpoint. 10 | */ 11 | export const DashboardProperties = { 12 | Id: "id", 13 | Name: "name", 14 | DisplayName: "display_name", 15 | Rank: "rank", 16 | Label: "label", 17 | } as const; 18 | /** 19 | * Names of dashboard fields supported for filtering/sorting on list endpoint. 20 | */ 21 | export type DashboardProperties = ClosedEnum; 22 | 23 | /** @internal */ 24 | export const DashboardProperties$inboundSchema: z.ZodNativeEnum< 25 | typeof DashboardProperties 26 | > = z.nativeEnum(DashboardProperties); 27 | 28 | /** @internal */ 29 | export const DashboardProperties$outboundSchema: z.ZodNativeEnum< 30 | typeof DashboardProperties 31 | > = DashboardProperties$inboundSchema; 32 | 33 | /** 34 | * @internal 35 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 36 | */ 37 | export namespace DashboardProperties$ { 38 | /** @deprecated use `DashboardProperties$inboundSchema` instead. */ 39 | export const inboundSchema = DashboardProperties$inboundSchema; 40 | /** @deprecated use `DashboardProperties$outboundSchema` instead. */ 41 | export const outboundSchema = DashboardProperties$outboundSchema; 42 | } 43 | -------------------------------------------------------------------------------- /src/models/components/dayofweek.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Available options for day of the week for use in message rules. 10 | */ 11 | export const DayOfWeek = { 12 | Mo: "mo", 13 | Tu: "tu", 14 | We: "we", 15 | Th: "th", 16 | Fr: "fr", 17 | Sa: "sa", 18 | Su: "su", 19 | } as const; 20 | /** 21 | * Available options for day of the week for use in message rules. 22 | */ 23 | export type DayOfWeek = ClosedEnum; 24 | 25 | /** @internal */ 26 | export const DayOfWeek$inboundSchema: z.ZodNativeEnum = z 27 | .nativeEnum(DayOfWeek); 28 | 29 | /** @internal */ 30 | export const DayOfWeek$outboundSchema: z.ZodNativeEnum = 31 | DayOfWeek$inboundSchema; 32 | 33 | /** 34 | * @internal 35 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 36 | */ 37 | export namespace DayOfWeek$ { 38 | /** @deprecated use `DayOfWeek$inboundSchema` instead. */ 39 | export const inboundSchema = DayOfWeek$inboundSchema; 40 | /** @deprecated use `DayOfWeek$outboundSchema` instead. */ 41 | export const outboundSchema = DayOfWeek$outboundSchema; 42 | } 43 | -------------------------------------------------------------------------------- /src/models/components/daysofweek.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Enum representing days of the week. 10 | */ 11 | export const DaysOfWeek = { 12 | Mon: "mon", 13 | Tue: "tue", 14 | Wed: "wed", 15 | Thu: "thu", 16 | Fri: "fri", 17 | Sat: "sat", 18 | Sun: "sun", 19 | } as const; 20 | /** 21 | * Enum representing days of the week. 22 | */ 23 | export type DaysOfWeek = ClosedEnum; 24 | 25 | /** @internal */ 26 | export const DaysOfWeek$inboundSchema: z.ZodNativeEnum = z 27 | .nativeEnum(DaysOfWeek); 28 | 29 | /** @internal */ 30 | export const DaysOfWeek$outboundSchema: z.ZodNativeEnum = 31 | DaysOfWeek$inboundSchema; 32 | 33 | /** 34 | * @internal 35 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 36 | */ 37 | export namespace DaysOfWeek$ { 38 | /** @deprecated use `DaysOfWeek$inboundSchema` instead. */ 39 | export const inboundSchema = DaysOfWeek$inboundSchema; 40 | /** @deprecated use `DaysOfWeek$outboundSchema` instead. */ 41 | export const outboundSchema = DaysOfWeek$outboundSchema; 42 | } 43 | -------------------------------------------------------------------------------- /src/models/components/dialogrole.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Role of dialog 10 | */ 11 | export const DialogRole = { 12 | Agent: "agent", 13 | User: "user", 14 | } as const; 15 | /** 16 | * Role of dialog 17 | */ 18 | export type DialogRole = ClosedEnum; 19 | 20 | /** @internal */ 21 | export const DialogRole$inboundSchema: z.ZodNativeEnum = z 22 | .nativeEnum(DialogRole); 23 | 24 | /** @internal */ 25 | export const DialogRole$outboundSchema: z.ZodNativeEnum = 26 | DialogRole$inboundSchema; 27 | 28 | /** 29 | * @internal 30 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 31 | */ 32 | export namespace DialogRole$ { 33 | /** @deprecated use `DialogRole$inboundSchema` instead. */ 34 | export const inboundSchema = DialogRole$inboundSchema; 35 | /** @deprecated use `DialogRole$outboundSchema` instead. */ 36 | export const outboundSchema = DialogRole$outboundSchema; 37 | } 38 | -------------------------------------------------------------------------------- /src/models/components/eventproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | export const EventProperties = { 9 | Timestamp: "timestamp", 10 | SessionId: "session_id", 11 | ConversationId: "conversation_id", 12 | Source: "source", 13 | SourceId: "source_id", 14 | Category: "category", 15 | Type: "type", 16 | UserId: "user_id", 17 | Description: "description", 18 | Attributes: "attributes", 19 | } as const; 20 | export type EventProperties = ClosedEnum; 21 | 22 | /** @internal */ 23 | export const EventProperties$inboundSchema: z.ZodNativeEnum< 24 | typeof EventProperties 25 | > = z.nativeEnum(EventProperties); 26 | 27 | /** @internal */ 28 | export const EventProperties$outboundSchema: z.ZodNativeEnum< 29 | typeof EventProperties 30 | > = EventProperties$inboundSchema; 31 | 32 | /** 33 | * @internal 34 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 35 | */ 36 | export namespace EventProperties$ { 37 | /** @deprecated use `EventProperties$inboundSchema` instead. */ 38 | export const inboundSchema = EventProperties$inboundSchema; 39 | /** @deprecated use `EventProperties$outboundSchema` instead. */ 40 | export const outboundSchema = EventProperties$outboundSchema; 41 | } 42 | -------------------------------------------------------------------------------- /src/models/components/insightsproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | export const InsightsProperties = { 9 | Id: "id", 10 | SessionId: "session_id", 11 | InsightKey: "insight_key", 12 | InsightToolId: "insight_tool_id", 13 | } as const; 14 | export type InsightsProperties = ClosedEnum; 15 | 16 | /** @internal */ 17 | export const InsightsProperties$inboundSchema: z.ZodNativeEnum< 18 | typeof InsightsProperties 19 | > = z.nativeEnum(InsightsProperties); 20 | 21 | /** @internal */ 22 | export const InsightsProperties$outboundSchema: z.ZodNativeEnum< 23 | typeof InsightsProperties 24 | > = InsightsProperties$inboundSchema; 25 | 26 | /** 27 | * @internal 28 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 29 | */ 30 | export namespace InsightsProperties$ { 31 | /** @deprecated use `InsightsProperties$inboundSchema` instead. */ 32 | export const inboundSchema = InsightsProperties$inboundSchema; 33 | /** @deprecated use `InsightsProperties$outboundSchema` instead. */ 34 | export const outboundSchema = InsightsProperties$outboundSchema; 35 | } 36 | -------------------------------------------------------------------------------- /src/models/components/insighttoolproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | export const InsightToolProperties = { 9 | Id: "id", 10 | Name: "name", 11 | Description: "description", 12 | ToolArguments: "tool_arguments", 13 | InsightToolDefinitionId: "insight_tool_definition_id", 14 | UpdatedAt: "updated_at", 15 | } as const; 16 | export type InsightToolProperties = ClosedEnum; 17 | 18 | /** @internal */ 19 | export const InsightToolProperties$inboundSchema: z.ZodNativeEnum< 20 | typeof InsightToolProperties 21 | > = z.nativeEnum(InsightToolProperties); 22 | 23 | /** @internal */ 24 | export const InsightToolProperties$outboundSchema: z.ZodNativeEnum< 25 | typeof InsightToolProperties 26 | > = InsightToolProperties$inboundSchema; 27 | 28 | /** 29 | * @internal 30 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 31 | */ 32 | export namespace InsightToolProperties$ { 33 | /** @deprecated use `InsightToolProperties$inboundSchema` instead. */ 34 | export const inboundSchema = InsightToolProperties$inboundSchema; 35 | /** @deprecated use `InsightToolProperties$outboundSchema` instead. */ 36 | export const outboundSchema = InsightToolProperties$outboundSchema; 37 | } 38 | -------------------------------------------------------------------------------- /src/models/components/insightworkflowproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | export const InsightWorkflowProperties = { 9 | Id: "id", 10 | Name: "name", 11 | Description: "description", 12 | Status: "status", 13 | Conditions: "conditions", 14 | InsightToolIds: "insight_tool_ids", 15 | UpdatedAt: "updated_at", 16 | } as const; 17 | export type InsightWorkflowProperties = ClosedEnum< 18 | typeof InsightWorkflowProperties 19 | >; 20 | 21 | /** @internal */ 22 | export const InsightWorkflowProperties$inboundSchema: z.ZodNativeEnum< 23 | typeof InsightWorkflowProperties 24 | > = z.nativeEnum(InsightWorkflowProperties); 25 | 26 | /** @internal */ 27 | export const InsightWorkflowProperties$outboundSchema: z.ZodNativeEnum< 28 | typeof InsightWorkflowProperties 29 | > = InsightWorkflowProperties$inboundSchema; 30 | 31 | /** 32 | * @internal 33 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 34 | */ 35 | export namespace InsightWorkflowProperties$ { 36 | /** @deprecated use `InsightWorkflowProperties$inboundSchema` instead. */ 37 | export const inboundSchema = InsightWorkflowProperties$inboundSchema; 38 | /** @deprecated use `InsightWorkflowProperties$outboundSchema` instead. */ 39 | export const outboundSchema = InsightWorkflowProperties$outboundSchema; 40 | } 41 | -------------------------------------------------------------------------------- /src/models/components/languagecode.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * BCP 47 codes of languages that Syllable supports. 10 | */ 11 | export const LanguageCode = { 12 | YueHK: "yue-HK", 13 | EnUS: "en-US", 14 | KoKR: "ko-KR", 15 | ZhCN: "zh-CN", 16 | EsUS: "es-US", 17 | THTH: "th-TH", 18 | ViVN: "vi-VN", 19 | } as const; 20 | /** 21 | * BCP 47 codes of languages that Syllable supports. 22 | */ 23 | export type LanguageCode = ClosedEnum; 24 | 25 | /** @internal */ 26 | export const LanguageCode$inboundSchema: z.ZodNativeEnum = 27 | z.nativeEnum(LanguageCode); 28 | 29 | /** @internal */ 30 | export const LanguageCode$outboundSchema: z.ZodNativeEnum = 31 | LanguageCode$inboundSchema; 32 | 33 | /** 34 | * @internal 35 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 36 | */ 37 | export namespace LanguageCode$ { 38 | /** @deprecated use `LanguageCode$inboundSchema` instead. */ 39 | export const inboundSchema = LanguageCode$inboundSchema; 40 | /** @deprecated use `LanguageCode$outboundSchema` instead. */ 41 | export const outboundSchema = LanguageCode$outboundSchema; 42 | } 43 | -------------------------------------------------------------------------------- /src/models/components/latencycategory.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | export const LatencyCategory = { 9 | Tts: "tts", 10 | Stt: "stt", 11 | Llm: "llm", 12 | Tool: "tool", 13 | Http: "http", 14 | } as const; 15 | export type LatencyCategory = ClosedEnum; 16 | 17 | /** @internal */ 18 | export const LatencyCategory$inboundSchema: z.ZodNativeEnum< 19 | typeof LatencyCategory 20 | > = z.nativeEnum(LatencyCategory); 21 | 22 | /** @internal */ 23 | export const LatencyCategory$outboundSchema: z.ZodNativeEnum< 24 | typeof LatencyCategory 25 | > = LatencyCategory$inboundSchema; 26 | 27 | /** 28 | * @internal 29 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 30 | */ 31 | export namespace LatencyCategory$ { 32 | /** @deprecated use `LatencyCategory$inboundSchema` instead. */ 33 | export const inboundSchema = LatencyCategory$inboundSchema; 34 | /** @deprecated use `LatencyCategory$outboundSchema` instead. */ 35 | export const outboundSchema = LatencyCategory$outboundSchema; 36 | } 37 | -------------------------------------------------------------------------------- /src/models/components/latencyunittype.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | export const LatencyUnitType = { 9 | Minutes: "minutes", 10 | Seconds: "seconds", 11 | Milliseconds: "milliseconds", 12 | Microseconds: "microseconds", 13 | Nanoseconds: "nanoseconds", 14 | } as const; 15 | export type LatencyUnitType = ClosedEnum; 16 | 17 | /** @internal */ 18 | export const LatencyUnitType$inboundSchema: z.ZodNativeEnum< 19 | typeof LatencyUnitType 20 | > = z.nativeEnum(LatencyUnitType); 21 | 22 | /** @internal */ 23 | export const LatencyUnitType$outboundSchema: z.ZodNativeEnum< 24 | typeof LatencyUnitType 25 | > = LatencyUnitType$inboundSchema; 26 | 27 | /** 28 | * @internal 29 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 30 | */ 31 | export namespace LatencyUnitType$ { 32 | /** @deprecated use `LatencyUnitType$inboundSchema` instead. */ 33 | export const inboundSchema = LatencyUnitType$inboundSchema; 34 | /** @deprecated use `LatencyUnitType$outboundSchema` instead. */ 35 | export const outboundSchema = LatencyUnitType$outboundSchema; 36 | } 37 | -------------------------------------------------------------------------------- /src/models/components/orderbydirection.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * The direction in which to order list results, either ascending or descending. 10 | */ 11 | export const OrderByDirection = { 12 | Asc: "asc", 13 | Desc: "desc", 14 | } as const; 15 | /** 16 | * The direction in which to order list results, either ascending or descending. 17 | */ 18 | export type OrderByDirection = ClosedEnum; 19 | 20 | /** @internal */ 21 | export const OrderByDirection$inboundSchema: z.ZodNativeEnum< 22 | typeof OrderByDirection 23 | > = z.nativeEnum(OrderByDirection); 24 | 25 | /** @internal */ 26 | export const OrderByDirection$outboundSchema: z.ZodNativeEnum< 27 | typeof OrderByDirection 28 | > = OrderByDirection$inboundSchema; 29 | 30 | /** 31 | * @internal 32 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 33 | */ 34 | export namespace OrderByDirection$ { 35 | /** @deprecated use `OrderByDirection$inboundSchema` instead. */ 36 | export const inboundSchema = OrderByDirection$inboundSchema; 37 | /** @deprecated use `OrderByDirection$outboundSchema` instead. */ 38 | export const outboundSchema = OrderByDirection$outboundSchema; 39 | } 40 | -------------------------------------------------------------------------------- /src/models/components/promptllmprovider.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * LLM API provider. 10 | */ 11 | export const PromptLlmProvider = { 12 | AzureOpenai: "azure_openai", 13 | Google: "google", 14 | Openai: "openai", 15 | } as const; 16 | /** 17 | * LLM API provider. 18 | */ 19 | export type PromptLlmProvider = ClosedEnum; 20 | 21 | /** @internal */ 22 | export const PromptLlmProvider$inboundSchema: z.ZodNativeEnum< 23 | typeof PromptLlmProvider 24 | > = z.nativeEnum(PromptLlmProvider); 25 | 26 | /** @internal */ 27 | export const PromptLlmProvider$outboundSchema: z.ZodNativeEnum< 28 | typeof PromptLlmProvider 29 | > = PromptLlmProvider$inboundSchema; 30 | 31 | /** 32 | * @internal 33 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 34 | */ 35 | export namespace PromptLlmProvider$ { 36 | /** @deprecated use `PromptLlmProvider$inboundSchema` instead. */ 37 | export const inboundSchema = PromptLlmProvider$inboundSchema; 38 | /** @deprecated use `PromptLlmProvider$outboundSchema` instead. */ 39 | export const outboundSchema = PromptLlmProvider$outboundSchema; 40 | } 41 | -------------------------------------------------------------------------------- /src/models/components/requeststatus.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Status of a communication request. 10 | */ 11 | export const RequestStatus = { 12 | Pending: "PENDING", 13 | Duplicate: "DUPLICATE", 14 | Initiated: "INITIATED", 15 | Connected: "CONNECTED", 16 | Failed: "FAILED", 17 | Canceled: "CANCELED", 18 | } as const; 19 | /** 20 | * Status of a communication request. 21 | */ 22 | export type RequestStatus = ClosedEnum; 23 | 24 | /** @internal */ 25 | export const RequestStatus$inboundSchema: z.ZodNativeEnum< 26 | typeof RequestStatus 27 | > = z.nativeEnum(RequestStatus); 28 | 29 | /** @internal */ 30 | export const RequestStatus$outboundSchema: z.ZodNativeEnum< 31 | typeof RequestStatus 32 | > = RequestStatus$inboundSchema; 33 | 34 | /** 35 | * @internal 36 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 37 | */ 38 | export namespace RequestStatus$ { 39 | /** @deprecated use `RequestStatus$inboundSchema` instead. */ 40 | export const inboundSchema = RequestStatus$inboundSchema; 41 | /** @deprecated use `RequestStatus$outboundSchema` instead. */ 42 | export const outboundSchema = RequestStatus$outboundSchema; 43 | } 44 | -------------------------------------------------------------------------------- /src/models/components/serviceproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Names of service fields supported for filtering/sorting on list endpoint. 10 | */ 11 | export const ServiceProperties = { 12 | Id: "id", 13 | Name: "name", 14 | Description: "description", 15 | UpdatedAt: "updated_at", 16 | LastUpdatedBy: "last_updated_by", 17 | } as const; 18 | /** 19 | * Names of service fields supported for filtering/sorting on list endpoint. 20 | */ 21 | export type ServiceProperties = ClosedEnum; 22 | 23 | /** @internal */ 24 | export const ServiceProperties$inboundSchema: z.ZodNativeEnum< 25 | typeof ServiceProperties 26 | > = z.nativeEnum(ServiceProperties); 27 | 28 | /** @internal */ 29 | export const ServiceProperties$outboundSchema: z.ZodNativeEnum< 30 | typeof ServiceProperties 31 | > = ServiceProperties$inboundSchema; 32 | 33 | /** 34 | * @internal 35 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 36 | */ 37 | export namespace ServiceProperties$ { 38 | /** @deprecated use `ServiceProperties$inboundSchema` instead. */ 39 | export const inboundSchema = ServiceProperties$inboundSchema; 40 | /** @deprecated use `ServiceProperties$outboundSchema` instead. */ 41 | export const outboundSchema = ServiceProperties$outboundSchema; 42 | } 43 | -------------------------------------------------------------------------------- /src/models/components/sessionlabelproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | export const SessionLabelProperties = { 9 | Timestamp: "timestamp", 10 | SessionId: "session_id", 11 | Type: "type", 12 | Code: "code", 13 | UserEmail: "user_email", 14 | IssueCategories: "issue_categories", 15 | SessionIdList: "session_id_list", 16 | } as const; 17 | export type SessionLabelProperties = ClosedEnum; 18 | 19 | /** @internal */ 20 | export const SessionLabelProperties$inboundSchema: z.ZodNativeEnum< 21 | typeof SessionLabelProperties 22 | > = z.nativeEnum(SessionLabelProperties); 23 | 24 | /** @internal */ 25 | export const SessionLabelProperties$outboundSchema: z.ZodNativeEnum< 26 | typeof SessionLabelProperties 27 | > = SessionLabelProperties$inboundSchema; 28 | 29 | /** 30 | * @internal 31 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 32 | */ 33 | export namespace SessionLabelProperties$ { 34 | /** @deprecated use `SessionLabelProperties$inboundSchema` instead. */ 35 | export const inboundSchema = SessionLabelProperties$inboundSchema; 36 | /** @deprecated use `SessionLabelProperties$outboundSchema` instead. */ 37 | export const outboundSchema = SessionLabelProperties$outboundSchema; 38 | } 39 | -------------------------------------------------------------------------------- /src/models/components/statictoolparametertype.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * The expected type for a static tool parameter. 10 | */ 11 | export const StaticToolParameterType = { 12 | String: "string", 13 | Int: "int", 14 | Boolean: "boolean", 15 | DataSourceList: "data_source_list", 16 | } as const; 17 | /** 18 | * The expected type for a static tool parameter. 19 | */ 20 | export type StaticToolParameterType = ClosedEnum< 21 | typeof StaticToolParameterType 22 | >; 23 | 24 | /** @internal */ 25 | export const StaticToolParameterType$inboundSchema: z.ZodNativeEnum< 26 | typeof StaticToolParameterType 27 | > = z.nativeEnum(StaticToolParameterType); 28 | 29 | /** @internal */ 30 | export const StaticToolParameterType$outboundSchema: z.ZodNativeEnum< 31 | typeof StaticToolParameterType 32 | > = StaticToolParameterType$inboundSchema; 33 | 34 | /** 35 | * @internal 36 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 37 | */ 38 | export namespace StaticToolParameterType$ { 39 | /** @deprecated use `StaticToolParameterType$inboundSchema` instead. */ 40 | export const inboundSchema = StaticToolParameterType$inboundSchema; 41 | /** @deprecated use `StaticToolParameterType$outboundSchema` instead. */ 42 | export const outboundSchema = StaticToolParameterType$outboundSchema; 43 | } 44 | -------------------------------------------------------------------------------- /src/models/components/takeoutrequeststatus.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Status of a takeout request. 10 | */ 11 | export const TakeoutRequestStatus = { 12 | Pending: "pending", 13 | InProgress: "in_progress", 14 | Completed: "completed", 15 | Failed: "failed", 16 | Canceled: "canceled", 17 | } as const; 18 | /** 19 | * Status of a takeout request. 20 | */ 21 | export type TakeoutRequestStatus = ClosedEnum; 22 | 23 | /** @internal */ 24 | export const TakeoutRequestStatus$inboundSchema: z.ZodNativeEnum< 25 | typeof TakeoutRequestStatus 26 | > = z.nativeEnum(TakeoutRequestStatus); 27 | 28 | /** @internal */ 29 | export const TakeoutRequestStatus$outboundSchema: z.ZodNativeEnum< 30 | typeof TakeoutRequestStatus 31 | > = TakeoutRequestStatus$inboundSchema; 32 | 33 | /** 34 | * @internal 35 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 36 | */ 37 | export namespace TakeoutRequestStatus$ { 38 | /** @deprecated use `TakeoutRequestStatus$inboundSchema` instead. */ 39 | export const inboundSchema = TakeoutRequestStatus$inboundSchema; 40 | /** @deprecated use `TakeoutRequestStatus$outboundSchema` instead. */ 41 | export const outboundSchema = TakeoutRequestStatus$outboundSchema; 42 | } 43 | -------------------------------------------------------------------------------- /src/models/components/targetmodes.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Available modes (communication methods) for channel targets. 10 | */ 11 | export const TargetModes = { 12 | Voice: "voice", 13 | Chat: "chat", 14 | Sms: "sms", 15 | Email: "email", 16 | } as const; 17 | /** 18 | * Available modes (communication methods) for channel targets. 19 | */ 20 | export type TargetModes = ClosedEnum; 21 | 22 | /** @internal */ 23 | export const TargetModes$inboundSchema: z.ZodNativeEnum = z 24 | .nativeEnum(TargetModes); 25 | 26 | /** @internal */ 27 | export const TargetModes$outboundSchema: z.ZodNativeEnum = 28 | TargetModes$inboundSchema; 29 | 30 | /** 31 | * @internal 32 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 33 | */ 34 | export namespace TargetModes$ { 35 | /** @deprecated use `TargetModes$inboundSchema` instead. */ 36 | export const inboundSchema = TargetModes$inboundSchema; 37 | /** @deprecated use `TargetModes$outboundSchema` instead. */ 38 | export const outboundSchema = TargetModes$outboundSchema; 39 | } 40 | -------------------------------------------------------------------------------- /src/models/components/toolhttpmethod.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * The HTTP method to use for a tool HTTP request. 10 | */ 11 | export const ToolHttpMethod = { 12 | Get: "get", 13 | Post: "post", 14 | } as const; 15 | /** 16 | * The HTTP method to use for a tool HTTP request. 17 | */ 18 | export type ToolHttpMethod = ClosedEnum; 19 | 20 | /** @internal */ 21 | export const ToolHttpMethod$inboundSchema: z.ZodNativeEnum< 22 | typeof ToolHttpMethod 23 | > = z.nativeEnum(ToolHttpMethod); 24 | 25 | /** @internal */ 26 | export const ToolHttpMethod$outboundSchema: z.ZodNativeEnum< 27 | typeof ToolHttpMethod 28 | > = ToolHttpMethod$inboundSchema; 29 | 30 | /** 31 | * @internal 32 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 33 | */ 34 | export namespace ToolHttpMethod$ { 35 | /** @deprecated use `ToolHttpMethod$inboundSchema` instead. */ 36 | export const inboundSchema = ToolHttpMethod$inboundSchema; 37 | /** @deprecated use `ToolHttpMethod$outboundSchema` instead. */ 38 | export const outboundSchema = ToolHttpMethod$outboundSchema; 39 | } 40 | -------------------------------------------------------------------------------- /src/models/components/toolproperties.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * Names of tool fields supported for filtering/sorting on list endpoint. 10 | */ 11 | export const ToolProperties = { 12 | Id: "id", 13 | Name: "name", 14 | ServiceName: "service_name", 15 | Definition: "definition", 16 | ServiceId: "service_id", 17 | UpdatedAt: "updated_at", 18 | LastUpdatedBy: "last_updated_by", 19 | } as const; 20 | /** 21 | * Names of tool fields supported for filtering/sorting on list endpoint. 22 | */ 23 | export type ToolProperties = ClosedEnum; 24 | 25 | /** @internal */ 26 | export const ToolProperties$inboundSchema: z.ZodNativeEnum< 27 | typeof ToolProperties 28 | > = z.nativeEnum(ToolProperties); 29 | 30 | /** @internal */ 31 | export const ToolProperties$outboundSchema: z.ZodNativeEnum< 32 | typeof ToolProperties 33 | > = ToolProperties$inboundSchema; 34 | 35 | /** 36 | * @internal 37 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 38 | */ 39 | export namespace ToolProperties$ { 40 | /** @deprecated use `ToolProperties$inboundSchema` instead. */ 41 | export const inboundSchema = ToolProperties$inboundSchema; 42 | /** @deprecated use `ToolProperties$outboundSchema` instead. */ 43 | export const outboundSchema = ToolProperties$outboundSchema; 44 | } 45 | -------------------------------------------------------------------------------- /src/models/components/ttsprovider.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | import { ClosedEnum } from "../../types/enums.js"; 7 | 8 | /** 9 | * TTS provider for an agent voice. 10 | */ 11 | export const TtsProvider = { 12 | OpenAI: "OpenAI", 13 | ElevenLabs: "ElevenLabs", 14 | Google: "Google", 15 | } as const; 16 | /** 17 | * TTS provider for an agent voice. 18 | */ 19 | export type TtsProvider = ClosedEnum; 20 | 21 | /** @internal */ 22 | export const TtsProvider$inboundSchema: z.ZodNativeEnum = z 23 | .nativeEnum(TtsProvider); 24 | 25 | /** @internal */ 26 | export const TtsProvider$outboundSchema: z.ZodNativeEnum = 27 | TtsProvider$inboundSchema; 28 | 29 | /** 30 | * @internal 31 | * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. 32 | */ 33 | export namespace TtsProvider$ { 34 | /** @deprecated use `TtsProvider$inboundSchema` instead. */ 35 | export const inboundSchema = TtsProvider$inboundSchema; 36 | /** @deprecated use `TtsProvider$outboundSchema` instead. */ 37 | export const outboundSchema = TtsProvider$outboundSchema; 38 | } 39 | -------------------------------------------------------------------------------- /src/models/errors/index.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | export * from "./httpclienterrors.js"; 6 | export * from "./httpvalidationerror.js"; 7 | export * from "./sdkerror.js"; 8 | export * from "./sdkvalidationerror.js"; 9 | -------------------------------------------------------------------------------- /src/models/errors/sdkerror.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | export class SDKError extends Error { 6 | public readonly statusCode: number; 7 | public readonly contentType: string; 8 | 9 | constructor( 10 | message: string, 11 | public readonly rawResponse: Response, 12 | public readonly body: string = "", 13 | ) { 14 | const statusCode = rawResponse.status; 15 | const contentType = rawResponse.headers.get("content-type") || ""; 16 | const bodyString = body.length > 0 ? `\n${body}` : ""; 17 | 18 | super( 19 | `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`, 20 | ); 21 | 22 | this.statusCode = statusCode; 23 | this.contentType = contentType; 24 | 25 | this.name = "SDKError"; 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/sdk/channels.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import { channelsDelete } from "../funcs/channelsDelete.js"; 6 | import { channelsList } from "../funcs/channelsList.js"; 7 | import { ClientSDK, RequestOptions } from "../lib/sdks.js"; 8 | import * as components from "../models/components/index.js"; 9 | import * as operations from "../models/operations/index.js"; 10 | import { unwrapAsync } from "../types/fp.js"; 11 | import { Targets } from "./targets.js"; 12 | 13 | export class Channels extends ClientSDK { 14 | private _targets?: Targets; 15 | get targets(): Targets { 16 | return (this._targets ??= new Targets(this._options)); 17 | } 18 | 19 | /** 20 | * Get Channels 21 | */ 22 | async list( 23 | request: operations.ChannelsListRequest, 24 | options?: RequestOptions, 25 | ): Promise { 26 | return unwrapAsync(channelsList( 27 | this, 28 | request, 29 | options, 30 | )); 31 | } 32 | 33 | /** 34 | * Delete Channel Target 35 | * 36 | * @remarks 37 | * Hard-delete a channel target by ID 38 | */ 39 | async delete( 40 | request: operations.ChannelTargetsDeleteRequest, 41 | options?: RequestOptions, 42 | ): Promise { 43 | return unwrapAsync(channelsDelete( 44 | this, 45 | request, 46 | options, 47 | )); 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /src/sdk/conversations.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import { conversationsList } from "../funcs/conversationsList.js"; 6 | import { ClientSDK, RequestOptions } from "../lib/sdks.js"; 7 | import * as components from "../models/components/index.js"; 8 | import * as operations from "../models/operations/index.js"; 9 | import { unwrapAsync } from "../types/fp.js"; 10 | 11 | export class Conversations extends ClientSDK { 12 | /** 13 | * Conversations List 14 | */ 15 | async list( 16 | request: operations.ConversationsListRequest, 17 | options?: RequestOptions, 18 | ): Promise { 19 | return unwrapAsync(conversationsList( 20 | this, 21 | request, 22 | options, 23 | )); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /src/sdk/events.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import { eventsList } from "../funcs/eventsList.js"; 6 | import { ClientSDK, RequestOptions } from "../lib/sdks.js"; 7 | import * as components from "../models/components/index.js"; 8 | import * as operations from "../models/operations/index.js"; 9 | import { unwrapAsync } from "../types/fp.js"; 10 | 11 | export class Events extends ClientSDK { 12 | /** 13 | * Events List 14 | */ 15 | async list( 16 | request: operations.EventsListRequest, 17 | options?: RequestOptions, 18 | ): Promise { 19 | return unwrapAsync(eventsList( 20 | this, 21 | request, 22 | options, 23 | )); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /src/sdk/fullsummary.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import { sessionsFullSummaryGetById } from "../funcs/sessionsFullSummaryGetById.js"; 6 | import { ClientSDK, RequestOptions } from "../lib/sdks.js"; 7 | import * as components from "../models/components/index.js"; 8 | import * as operations from "../models/operations/index.js"; 9 | import { unwrapAsync } from "../types/fp.js"; 10 | 11 | export class FullSummary extends ClientSDK { 12 | /** 13 | * Get Full Session Summary By Id 14 | */ 15 | async getById( 16 | request: operations.SessionFullSummaryGetByIdRequest, 17 | options?: RequestOptions, 18 | ): Promise { 19 | return unwrapAsync(sessionsFullSummaryGetById( 20 | this, 21 | request, 22 | options, 23 | )); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /src/sdk/index.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | export * from "./sdk.js"; 6 | -------------------------------------------------------------------------------- /src/sdk/insights.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import { insightsList } from "../funcs/insightsList.js"; 6 | import { ClientSDK, RequestOptions } from "../lib/sdks.js"; 7 | import * as components from "../models/components/index.js"; 8 | import * as operations from "../models/operations/index.js"; 9 | import { unwrapAsync } from "../types/fp.js"; 10 | import { SyllableSDKTools } from "./syllablesdktools.js"; 11 | import { Workflows } from "./workflows.js"; 12 | 13 | export class Insights extends ClientSDK { 14 | private _workflows?: Workflows; 15 | get workflows(): Workflows { 16 | return (this._workflows ??= new Workflows(this._options)); 17 | } 18 | 19 | private _tools?: SyllableSDKTools; 20 | get tools(): SyllableSDKTools { 21 | return (this._tools ??= new SyllableSDKTools(this._options)); 22 | } 23 | 24 | /** 25 | * Insights List 26 | * 27 | * @remarks 28 | * List the evaluated insights for sessions. 29 | */ 30 | async list( 31 | request: operations.InsightsListRequest, 32 | options?: RequestOptions, 33 | ): Promise { 34 | return unwrapAsync(insightsList( 35 | this, 36 | request, 37 | options, 38 | )); 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /src/sdk/latency.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import { sessionsLatencyGetById } from "../funcs/sessionsLatencyGetById.js"; 6 | import { ClientSDK, RequestOptions } from "../lib/sdks.js"; 7 | import * as components from "../models/components/index.js"; 8 | import * as operations from "../models/operations/index.js"; 9 | import { unwrapAsync } from "../types/fp.js"; 10 | 11 | export class Latency extends ClientSDK { 12 | /** 13 | * Inspect Latency For Session 14 | */ 15 | async getById( 16 | request: operations.SessionLatencyGetByIdRequest, 17 | options?: RequestOptions, 18 | ): Promise { 19 | return unwrapAsync(sessionsLatencyGetById( 20 | this, 21 | request, 22 | options, 23 | )); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /src/sdk/outbound.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import { ClientSDK } from "../lib/sdks.js"; 6 | import { Batches } from "./batches.js"; 7 | import { Campaigns } from "./campaigns.js"; 8 | 9 | export class Outbound extends ClientSDK { 10 | private _batches?: Batches; 11 | get batches(): Batches { 12 | return (this._batches ??= new Batches(this._options)); 13 | } 14 | 15 | private _campaigns?: Campaigns; 16 | get campaigns(): Campaigns { 17 | return (this._campaigns ??= new Campaigns(this._options)); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/sdk/takeouts.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import { takeoutsCreate } from "../funcs/takeoutsCreate.js"; 6 | import { takeoutsTakeoutsGetByJobId } from "../funcs/takeoutsTakeoutsGetByJobId.js"; 7 | import { ClientSDK, RequestOptions } from "../lib/sdks.js"; 8 | import * as components from "../models/components/index.js"; 9 | import * as operations from "../models/operations/index.js"; 10 | import { unwrapAsync } from "../types/fp.js"; 11 | 12 | export class Takeouts extends ClientSDK { 13 | /** 14 | * Create Takeout 15 | */ 16 | async create( 17 | options?: RequestOptions, 18 | ): Promise { 19 | return unwrapAsync(takeoutsCreate( 20 | this, 21 | options, 22 | )); 23 | } 24 | 25 | /** 26 | * Get Takeout 27 | */ 28 | async takeoutsGetByJobId( 29 | request: operations.TakeoutsGetByJobIdRequest, 30 | options?: RequestOptions, 31 | ): Promise { 32 | return unwrapAsync(takeoutsTakeoutsGetByJobId( 33 | this, 34 | request, 35 | options, 36 | )); 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /src/sdk/test.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import { agentsTestSendTestMessage } from "../funcs/agentsTestSendTestMessage.js"; 6 | import { ClientSDK, RequestOptions } from "../lib/sdks.js"; 7 | import * as components from "../models/components/index.js"; 8 | import { unwrapAsync } from "../types/fp.js"; 9 | 10 | export class Test extends ClientSDK { 11 | /** 12 | * Send New Message 13 | * 14 | * @remarks 15 | * Send a new message 16 | */ 17 | async sendTestMessage( 18 | request: components.TestMessage, 19 | options?: RequestOptions, 20 | ): Promise { 21 | return unwrapAsync(agentsTestSendTestMessage( 22 | this, 23 | request, 24 | options, 25 | )); 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/sdk/transcript.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import { sessionsTranscriptGetById } from "../funcs/sessionsTranscriptGetById.js"; 6 | import { ClientSDK, RequestOptions } from "../lib/sdks.js"; 7 | import * as components from "../models/components/index.js"; 8 | import * as operations from "../models/operations/index.js"; 9 | import { unwrapAsync } from "../types/fp.js"; 10 | 11 | export class Transcript extends ClientSDK { 12 | /** 13 | * Get Session Transcript By Id 14 | */ 15 | async getById( 16 | request: operations.SessionTranscriptGetByIdRequest, 17 | options?: RequestOptions, 18 | ): Promise { 19 | return unwrapAsync(sessionsTranscriptGetById( 20 | this, 21 | request, 22 | options, 23 | )); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /src/types/blobs.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | 7 | export const blobLikeSchema: z.ZodType = 8 | z.custom(isBlobLike, { 9 | message: "expected a Blob, File or Blob-like object", 10 | fatal: true, 11 | }); 12 | 13 | export function isBlobLike(val: unknown): val is Blob { 14 | if (val instanceof Blob) { 15 | return true; 16 | } 17 | 18 | if (typeof val !== "object" || val == null || !(Symbol.toStringTag in val)) { 19 | return false; 20 | } 21 | 22 | const name = val[Symbol.toStringTag]; 23 | if (typeof name !== "string") { 24 | return false; 25 | } 26 | if (name !== "Blob" && name !== "File") { 27 | return false; 28 | } 29 | 30 | return "stream" in val && typeof val.stream === "function"; 31 | } 32 | -------------------------------------------------------------------------------- /src/types/constdatetime.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | import * as z from "zod"; 6 | 7 | export function constDateTime( 8 | val: string, 9 | ): z.ZodType { 10 | return z.custom((v) => { 11 | return ( 12 | typeof v === "string" && new Date(v).getTime() === new Date(val).getTime() 13 | ); 14 | }, `Value must be equivelant to ${val}`); 15 | } 16 | -------------------------------------------------------------------------------- /src/types/enums.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | declare const __brand: unique symbol; 6 | export type Unrecognized = T & { [__brand]: "unrecognized" }; 7 | 8 | export function catchUnrecognizedEnum(value: T): Unrecognized { 9 | return value as Unrecognized; 10 | } 11 | 12 | type Prettify = { [K in keyof T]: T[K] } & {}; 13 | export type ClosedEnum = T[keyof T]; 14 | export type OpenEnum = 15 | | Prettify 16 | | Unrecognized; 17 | -------------------------------------------------------------------------------- /src/types/index.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | export { blobLikeSchema, isBlobLike } from "./blobs.js"; 6 | export { catchUnrecognizedEnum } from "./enums.js"; 7 | export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js"; 8 | export type { Result } from "./fp.js"; 9 | export type { PageIterator, Paginator } from "./operations.js"; 10 | export { createPageIterator } from "./operations.js"; 11 | export { RFCDate } from "./rfcdate.js"; 12 | -------------------------------------------------------------------------------- /src/types/rfcdate.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | const dateRE = /^\d{4}-\d{2}-\d{2}$/; 6 | 7 | export class RFCDate { 8 | private serialized: string; 9 | 10 | /** 11 | * Creates a new RFCDate instance using today's date. 12 | */ 13 | static today(): RFCDate { 14 | return new RFCDate(new Date()); 15 | } 16 | 17 | /** 18 | * Creates a new RFCDate instance using the provided input. 19 | * If a string is used then in must be in the format YYYY-MM-DD. 20 | * 21 | * @param date A Date object or a date string in YYYY-MM-DD format 22 | * @example 23 | * new RFCDate("2022-01-01") 24 | * @example 25 | * new RFCDate(new Date()) 26 | */ 27 | constructor(date: Date | string) { 28 | if (typeof date === "string" && !dateRE.test(date)) { 29 | throw new RangeError( 30 | "RFCDate: date strings must be in the format YYYY-MM-DD: " + date, 31 | ); 32 | } 33 | 34 | const value = new Date(date); 35 | if (isNaN(+value)) { 36 | throw new RangeError("RFCDate: invalid date provided: " + date); 37 | } 38 | 39 | this.serialized = value.toISOString().slice(0, "YYYY-MM-DD".length); 40 | if (!dateRE.test(this.serialized)) { 41 | throw new TypeError( 42 | `RFCDate: failed to build valid date with given value: ${date} serialized to ${this.serialized}`, 43 | ); 44 | } 45 | } 46 | 47 | toJSON(): string { 48 | return this.toString(); 49 | } 50 | 51 | toString(): string { 52 | return this.serialized; 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /src/types/streams.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. 3 | */ 4 | 5 | export function isReadableStream( 6 | val: unknown, 7 | ): val is ReadableStream { 8 | if (typeof val !== "object" || val === null) { 9 | return false; 10 | } 11 | 12 | // Check for the presence of methods specific to ReadableStream 13 | const stream = val as ReadableStream; 14 | 15 | // ReadableStream has methods like getReader, cancel, and tee 16 | return ( 17 | typeof stream.getReader === "function" && 18 | typeof stream.cancel === "function" && 19 | typeof stream.tee === "function" 20 | ); 21 | } 22 | -------------------------------------------------------------------------------- /tools/concat_all_docs.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Define the output file 4 | output_file="combined.md" 5 | 6 | # Clear the output file if it already exists 7 | > "$output_file" 8 | 9 | # Function to recursively find and concatenate markdown files 10 | concatenate_markdown_files() { 11 | local dir="$1" 12 | for file in "$dir"/*; do 13 | if [ -d "$file" ]; then 14 | # If the file is a directory, recurse into it 15 | concatenate_markdown_files "$file" 16 | elif [ -f "$file" ] && [[ "$file" == *.md ]]; then 17 | # If the file is a markdown file, concatenate it to the output file 18 | echo "Processing $file" 19 | cat "$file" >> "$output_file" 20 | echo -e "\n" >> "$output_file" # Add a newline for separation 21 | fi 22 | done 23 | } 24 | 25 | # Start the recursion from the current directory 26 | concatenate_markdown_files "docs" 27 | 28 | echo "All markdown files have been concatenated into $output_file" 29 | echo "Generating doc file" 30 | 31 | " 32 | -------------------------------------------------------------------------------- /tools/install_docs_op.sh: -------------------------------------------------------------------------------- 1 | cp README.md ../phoenix/services/object_player/docs/syllable_docs 2 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "incremental": true, 4 | "tsBuildInfoFile": ".tsbuildinfo", 5 | "target": "ES2020", 6 | "lib": ["ES2022", "DOM", "DOM.Iterable"], 7 | "jsx": "react-jsx", 8 | 9 | "module": "Node16", 10 | "moduleResolution": "Node16", 11 | 12 | "allowJs": true, 13 | 14 | "declaration": true, 15 | "declarationMap": true, 16 | "sourceMap": true, 17 | "outDir": ".", 18 | 19 | 20 | // https://github.com/tsconfig/bases/blob/a1bf7c0fa2e094b068ca3e1448ca2ece4157977e/bases/strictest.json 21 | "strict": true, 22 | "allowUnusedLabels": false, 23 | "allowUnreachableCode": false, 24 | "exactOptionalPropertyTypes": true, 25 | "useUnknownInCatchVariables": true, 26 | "noFallthroughCasesInSwitch": true, 27 | "noImplicitOverride": true, 28 | "noImplicitReturns": true, 29 | "noPropertyAccessFromIndexSignature": true, 30 | "noUncheckedIndexedAccess": true, 31 | "noUnusedLocals": true, 32 | "noUnusedParameters": true, 33 | "isolatedModules": true, 34 | "checkJs": true, 35 | "esModuleInterop": true, 36 | "skipLibCheck": true, 37 | "forceConsistentCasingInFileNames": true 38 | }, 39 | "include": ["src"], 40 | "exclude": ["node_modules"] 41 | } 42 | --------------------------------------------------------------------------------