syllable-sdk 0.1.0-alpha.29 → 0.1.0-alpha.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (687) hide show
  1. package/.devcontainer/devcontainer.json +45 -0
  2. package/README.md +1 -55
  3. package/api-reference/openapi.json +4398 -0
  4. package/docs/openapi.json +1 -0
  5. package/docs/sdks/agents/README.md +39 -15
  6. package/docs/sdks/channels/README.md +4 -1
  7. package/docs/sdks/conversations/README.md +1 -1
  8. package/docs/sdks/custommessages/README.md +4 -1
  9. package/docs/sdks/dashboards/README.md +1 -1
  10. package/docs/sdks/events/README.md +1 -1
  11. package/docs/sdks/prompts/README.md +10 -7
  12. package/docs/sdks/services/README.md +1 -1
  13. package/docs/sdks/sessionlabels/README.md +6 -4
  14. package/docs/sdks/sessions/README.md +1 -1
  15. package/docs/sdks/targets/README.md +18 -15
  16. package/docs/sdks/test/README.md +1 -1
  17. package/docs/sdks/tools/README.md +9 -6
  18. package/docs/sdks/transcript/README.md +0 -2
  19. package/funcs/agentsAgentGetAvailableVoices.d.ts.map +1 -1
  20. package/funcs/agentsAgentGetAvailableVoices.js +4 -3
  21. package/funcs/agentsAgentGetAvailableVoices.js.map +1 -1
  22. package/funcs/agentsCreate.d.ts +1 -1
  23. package/funcs/agentsCreate.d.ts.map +1 -1
  24. package/funcs/agentsCreate.js +4 -3
  25. package/funcs/agentsCreate.js.map +1 -1
  26. package/funcs/agentsDelete.d.ts.map +1 -1
  27. package/funcs/agentsDelete.js +4 -3
  28. package/funcs/agentsDelete.js.map +1 -1
  29. package/funcs/agentsGetById.d.ts.map +1 -1
  30. package/funcs/agentsGetById.js +4 -3
  31. package/funcs/agentsGetById.js.map +1 -1
  32. package/funcs/agentsList.d.ts.map +1 -1
  33. package/funcs/agentsList.js +4 -3
  34. package/funcs/agentsList.js.map +1 -1
  35. package/funcs/agentsTestSendTestMessage.d.ts.map +1 -1
  36. package/funcs/agentsTestSendTestMessage.js +4 -3
  37. package/funcs/agentsTestSendTestMessage.js.map +1 -1
  38. package/funcs/agentsUpdate.d.ts +1 -1
  39. package/funcs/agentsUpdate.d.ts.map +1 -1
  40. package/funcs/agentsUpdate.js +4 -3
  41. package/funcs/agentsUpdate.js.map +1 -1
  42. package/funcs/channelsDelete.d.ts.map +1 -1
  43. package/funcs/channelsDelete.js +4 -3
  44. package/funcs/channelsDelete.js.map +1 -1
  45. package/funcs/channelsList.d.ts.map +1 -1
  46. package/funcs/channelsList.js +4 -3
  47. package/funcs/channelsList.js.map +1 -1
  48. package/funcs/channelsTargetsAvailableTargets.d.ts.map +1 -1
  49. package/funcs/channelsTargetsAvailableTargets.js +4 -3
  50. package/funcs/channelsTargetsAvailableTargets.js.map +1 -1
  51. package/funcs/channelsTargetsCreate.d.ts +1 -1
  52. package/funcs/channelsTargetsCreate.d.ts.map +1 -1
  53. package/funcs/channelsTargetsCreate.js +4 -3
  54. package/funcs/channelsTargetsCreate.js.map +1 -1
  55. package/funcs/channelsTargetsGetById.d.ts +1 -1
  56. package/funcs/channelsTargetsGetById.d.ts.map +1 -1
  57. package/funcs/channelsTargetsGetById.js +4 -3
  58. package/funcs/channelsTargetsGetById.js.map +1 -1
  59. package/funcs/channelsTargetsList.d.ts +1 -1
  60. package/funcs/channelsTargetsList.d.ts.map +1 -1
  61. package/funcs/channelsTargetsList.js +4 -3
  62. package/funcs/channelsTargetsList.js.map +1 -1
  63. package/funcs/channelsTargetsUpdate.d.ts +1 -1
  64. package/funcs/channelsTargetsUpdate.d.ts.map +1 -1
  65. package/funcs/channelsTargetsUpdate.js +4 -3
  66. package/funcs/channelsTargetsUpdate.js.map +1 -1
  67. package/funcs/conversationsList.d.ts.map +1 -1
  68. package/funcs/conversationsList.js +4 -3
  69. package/funcs/conversationsList.js.map +1 -1
  70. package/funcs/customMessagesCreate.d.ts.map +1 -1
  71. package/funcs/customMessagesCreate.js +4 -3
  72. package/funcs/customMessagesCreate.js.map +1 -1
  73. package/funcs/customMessagesDelete.d.ts.map +1 -1
  74. package/funcs/customMessagesDelete.js +4 -3
  75. package/funcs/customMessagesDelete.js.map +1 -1
  76. package/funcs/customMessagesGetById.d.ts.map +1 -1
  77. package/funcs/customMessagesGetById.js +4 -3
  78. package/funcs/customMessagesGetById.js.map +1 -1
  79. package/funcs/customMessagesList.d.ts.map +1 -1
  80. package/funcs/customMessagesList.js +4 -3
  81. package/funcs/customMessagesList.js.map +1 -1
  82. package/funcs/customMessagesUpdate.d.ts.map +1 -1
  83. package/funcs/customMessagesUpdate.js +4 -3
  84. package/funcs/customMessagesUpdate.js.map +1 -1
  85. package/funcs/dashboardsPostSessionEventsDashboard.d.ts.map +1 -1
  86. package/funcs/dashboardsPostSessionEventsDashboard.js +4 -3
  87. package/funcs/dashboardsPostSessionEventsDashboard.js.map +1 -1
  88. package/funcs/dashboardsPostSessionSummaryDashboard.d.ts.map +1 -1
  89. package/funcs/dashboardsPostSessionSummaryDashboard.js +4 -3
  90. package/funcs/dashboardsPostSessionSummaryDashboard.js.map +1 -1
  91. package/funcs/dashboardsPostSessionTransfersDashboard.d.ts.map +1 -1
  92. package/funcs/dashboardsPostSessionTransfersDashboard.js +4 -3
  93. package/funcs/dashboardsPostSessionTransfersDashboard.js.map +1 -1
  94. package/funcs/dashboardsPostSessionsDashboard.d.ts.map +1 -1
  95. package/funcs/dashboardsPostSessionsDashboard.js +4 -3
  96. package/funcs/dashboardsPostSessionsDashboard.js.map +1 -1
  97. package/funcs/eventsList.d.ts.map +1 -1
  98. package/funcs/eventsList.js +4 -3
  99. package/funcs/eventsList.js.map +1 -1
  100. package/funcs/promptsCreate.d.ts +1 -1
  101. package/funcs/promptsCreate.d.ts.map +1 -1
  102. package/funcs/promptsCreate.js +5 -4
  103. package/funcs/promptsCreate.js.map +1 -1
  104. package/funcs/promptsDelete.d.ts.map +1 -1
  105. package/funcs/promptsDelete.js +4 -3
  106. package/funcs/promptsDelete.js.map +1 -1
  107. package/funcs/promptsGetById.d.ts +1 -1
  108. package/funcs/promptsGetById.d.ts.map +1 -1
  109. package/funcs/promptsGetById.js +4 -3
  110. package/funcs/promptsGetById.js.map +1 -1
  111. package/funcs/promptsList.d.ts +1 -1
  112. package/funcs/promptsList.d.ts.map +1 -1
  113. package/funcs/promptsList.js +4 -3
  114. package/funcs/promptsList.js.map +1 -1
  115. package/funcs/promptsPromptsHistory.d.ts.map +1 -1
  116. package/funcs/promptsPromptsHistory.js +4 -3
  117. package/funcs/promptsPromptsHistory.js.map +1 -1
  118. package/funcs/promptsUpdate.d.ts +1 -1
  119. package/funcs/promptsUpdate.d.ts.map +1 -1
  120. package/funcs/promptsUpdate.js +5 -4
  121. package/funcs/promptsUpdate.js.map +1 -1
  122. package/funcs/servicesCreate.d.ts.map +1 -1
  123. package/funcs/servicesCreate.js +4 -3
  124. package/funcs/servicesCreate.js.map +1 -1
  125. package/funcs/servicesList.d.ts.map +1 -1
  126. package/funcs/servicesList.js +4 -3
  127. package/funcs/servicesList.js.map +1 -1
  128. package/funcs/servicesUpdate.d.ts.map +1 -1
  129. package/funcs/servicesUpdate.js +4 -3
  130. package/funcs/servicesUpdate.js.map +1 -1
  131. package/funcs/sessionLabelsCreate.d.ts.map +1 -1
  132. package/funcs/sessionLabelsCreate.js +4 -3
  133. package/funcs/sessionLabelsCreate.js.map +1 -1
  134. package/funcs/sessionLabelsGetById.d.ts.map +1 -1
  135. package/funcs/sessionLabelsGetById.js +4 -3
  136. package/funcs/sessionLabelsGetById.js.map +1 -1
  137. package/funcs/sessionLabelsList.d.ts.map +1 -1
  138. package/funcs/sessionLabelsList.js +4 -3
  139. package/funcs/sessionLabelsList.js.map +1 -1
  140. package/funcs/sessionsGenerateSessionRecordingUrls.d.ts.map +1 -1
  141. package/funcs/sessionsGenerateSessionRecordingUrls.js +4 -3
  142. package/funcs/sessionsGenerateSessionRecordingUrls.js.map +1 -1
  143. package/funcs/sessionsGetById.d.ts.map +1 -1
  144. package/funcs/sessionsGetById.js +4 -3
  145. package/funcs/sessionsGetById.js.map +1 -1
  146. package/funcs/sessionsList.d.ts.map +1 -1
  147. package/funcs/sessionsList.js +4 -3
  148. package/funcs/sessionsList.js.map +1 -1
  149. package/funcs/sessionsSessionRecordingStream.d.ts.map +1 -1
  150. package/funcs/sessionsSessionRecordingStream.js +4 -3
  151. package/funcs/sessionsSessionRecordingStream.js.map +1 -1
  152. package/funcs/sessionsTranscriptGetById.d.ts.map +1 -1
  153. package/funcs/sessionsTranscriptGetById.js +4 -3
  154. package/funcs/sessionsTranscriptGetById.js.map +1 -1
  155. package/funcs/toolsCreate.d.ts +1 -1
  156. package/funcs/toolsCreate.d.ts.map +1 -1
  157. package/funcs/toolsCreate.js +5 -4
  158. package/funcs/toolsCreate.js.map +1 -1
  159. package/funcs/toolsGetByName.d.ts.map +1 -1
  160. package/funcs/toolsGetByName.js +4 -3
  161. package/funcs/toolsGetByName.js.map +1 -1
  162. package/funcs/toolsList.d.ts +1 -1
  163. package/funcs/toolsList.d.ts.map +1 -1
  164. package/funcs/toolsList.js +4 -3
  165. package/funcs/toolsList.js.map +1 -1
  166. package/funcs/toolsUpdate.d.ts +1 -1
  167. package/funcs/toolsUpdate.d.ts.map +1 -1
  168. package/funcs/toolsUpdate.js +5 -4
  169. package/funcs/toolsUpdate.js.map +1 -1
  170. package/funcs/v1PostSessionEventsDashboard.d.ts.map +1 -1
  171. package/funcs/v1PostSessionEventsDashboard.js +4 -3
  172. package/funcs/v1PostSessionEventsDashboard.js.map +1 -1
  173. package/funcs/v1PostSessionSummaryDashboard.d.ts.map +1 -1
  174. package/funcs/v1PostSessionSummaryDashboard.js +4 -3
  175. package/funcs/v1PostSessionSummaryDashboard.js.map +1 -1
  176. package/funcs/v1PostSessionTransfersDashboard.d.ts.map +1 -1
  177. package/funcs/v1PostSessionTransfersDashboard.js +4 -3
  178. package/funcs/v1PostSessionTransfersDashboard.js.map +1 -1
  179. package/funcs/v1PostSessionsDashboard.d.ts.map +1 -1
  180. package/funcs/v1PostSessionsDashboard.js +4 -3
  181. package/funcs/v1PostSessionsDashboard.js.map +1 -1
  182. package/jsr.json +27 -0
  183. package/lib/config.d.ts +3 -3
  184. package/lib/config.js +3 -3
  185. package/lib/config.js.map +1 -1
  186. package/lib/encodings.d.ts +10 -9
  187. package/lib/encodings.d.ts.map +1 -1
  188. package/lib/encodings.js +73 -47
  189. package/lib/encodings.js.map +1 -1
  190. package/lib/primitives.d.ts +1 -0
  191. package/lib/primitives.d.ts.map +1 -1
  192. package/lib/primitives.js +10 -0
  193. package/lib/primitives.js.map +1 -1
  194. package/lib/sdks.d.ts.map +1 -1
  195. package/lib/sdks.js +4 -1
  196. package/lib/sdks.js.map +1 -1
  197. package/mintlify/mint-backup.json +290 -0
  198. package/mintlify/mint.json +289 -0
  199. package/models/components/agentcreate.d.ts +66 -16
  200. package/models/components/agentcreate.d.ts.map +1 -1
  201. package/models/components/agentcreate.js +34 -11
  202. package/models/components/agentcreate.js.map +1 -1
  203. package/models/components/agentresponse.d.ts +43 -27
  204. package/models/components/agentresponse.d.ts.map +1 -1
  205. package/models/components/agentresponse.js +17 -17
  206. package/models/components/agentresponse.js.map +1 -1
  207. package/models/components/agenttooldefaults.d.ts +9 -0
  208. package/models/components/agenttooldefaults.d.ts.map +1 -1
  209. package/models/components/agenttooldefaults.js.map +1 -1
  210. package/models/components/agenttoolfielddefault.d.ts +9 -0
  211. package/models/components/agenttoolfielddefault.d.ts.map +1 -1
  212. package/models/components/agenttoolfielddefault.js.map +1 -1
  213. package/models/components/agentupdate.d.ts +67 -17
  214. package/models/components/agentupdate.d.ts.map +1 -1
  215. package/models/components/agentupdate.js +34 -11
  216. package/models/components/agentupdate.js.map +1 -1
  217. package/models/components/agentvoice.d.ts +12 -0
  218. package/models/components/agentvoice.d.ts.map +1 -1
  219. package/models/components/agentvoice.js.map +1 -1
  220. package/models/components/agentvoicevarname.d.ts +6 -0
  221. package/models/components/agentvoicevarname.d.ts.map +1 -1
  222. package/models/components/agentvoicevarname.js +3 -0
  223. package/models/components/agentvoicevarname.js.map +1 -1
  224. package/models/components/channel.d.ts +4 -1
  225. package/models/components/channel.d.ts.map +1 -1
  226. package/models/components/channel.js.map +1 -1
  227. package/models/components/channelservices.d.ts +6 -0
  228. package/models/components/channelservices.d.ts.map +1 -1
  229. package/models/components/channelservices.js +3 -0
  230. package/models/components/channelservices.js.map +1 -1
  231. package/models/components/channeltargetcreaterequest.d.ts +22 -3
  232. package/models/components/channeltargetcreaterequest.d.ts.map +1 -1
  233. package/models/components/channeltargetcreaterequest.js +7 -6
  234. package/models/components/channeltargetcreaterequest.js.map +1 -1
  235. package/models/components/channeltargetresponse.d.ts +90 -0
  236. package/models/components/channeltargetresponse.d.ts.map +1 -0
  237. package/models/components/{channeltarget.js → channeltargetresponse.js} +37 -36
  238. package/models/components/channeltargetresponse.js.map +1 -0
  239. package/models/components/channeltargetupdaterequest.d.ts +27 -5
  240. package/models/components/channeltargetupdaterequest.d.ts.map +1 -1
  241. package/models/components/channeltargetupdaterequest.js +9 -8
  242. package/models/components/channeltargetupdaterequest.js.map +1 -1
  243. package/models/components/conversation.d.ts +42 -0
  244. package/models/components/conversation.d.ts.map +1 -1
  245. package/models/components/conversation.js.map +1 -1
  246. package/models/components/custommessagecreaterequest.d.ts +3 -3
  247. package/models/components/custommessagecreaterequest.d.ts.map +1 -1
  248. package/models/components/custommessagecreaterequest.js +3 -3
  249. package/models/components/custommessagecreaterequest.js.map +1 -1
  250. package/models/components/custommessageresponse.d.ts +11 -3
  251. package/models/components/custommessageresponse.d.ts.map +1 -1
  252. package/models/components/custommessageresponse.js +3 -3
  253. package/models/components/custommessageresponse.js.map +1 -1
  254. package/models/components/{daocustommessagerule.d.ts → custommessagerule.d.ts} +14 -14
  255. package/models/components/custommessagerule.d.ts.map +1 -0
  256. package/models/components/{daocustommessagerule.js → custommessagerule.js} +17 -17
  257. package/models/components/custommessagerule.js.map +1 -0
  258. package/models/components/custommessageupdaterequest.d.ts +3 -3
  259. package/models/components/custommessageupdaterequest.d.ts.map +1 -1
  260. package/models/components/custommessageupdaterequest.js +3 -3
  261. package/models/components/custommessageupdaterequest.js.map +1 -1
  262. package/models/components/dashboard.d.ts +15 -0
  263. package/models/components/dashboard.d.ts.map +1 -1
  264. package/models/components/dashboard.js.map +1 -1
  265. package/models/components/event.d.ts +33 -0
  266. package/models/components/event.d.ts.map +1 -1
  267. package/models/components/event.js.map +1 -1
  268. package/models/components/index.d.ts +19 -27
  269. package/models/components/index.d.ts.map +1 -1
  270. package/models/components/index.js +19 -27
  271. package/models/components/index.js.map +1 -1
  272. package/models/components/internaltool.d.ts +46 -0
  273. package/models/components/internaltool.d.ts.map +1 -0
  274. package/models/components/{sdkinternaltool.js → internaltool.js} +20 -20
  275. package/models/components/internaltool.js.map +1 -0
  276. package/models/components/listresponsechanneltargetresponse.d.ts +38 -0
  277. package/models/components/listresponsechanneltargetresponse.d.ts.map +1 -0
  278. package/models/components/{listresponsedirectorymember.js → listresponsechanneltargetresponse.js} +20 -20
  279. package/models/components/listresponsechanneltargetresponse.js.map +1 -0
  280. package/models/components/listresponsepromptresponse.d.ts +38 -0
  281. package/models/components/listresponsepromptresponse.d.ts.map +1 -0
  282. package/models/components/{listresponsechanneltarget.js → listresponsepromptresponse.js} +20 -20
  283. package/models/components/listresponsepromptresponse.js.map +1 -0
  284. package/models/components/listresponsetoolresponse.d.ts +38 -0
  285. package/models/components/listresponsetoolresponse.d.ts.map +1 -0
  286. package/models/components/{listresponseprompt.js → listresponsetoolresponse.js} +20 -20
  287. package/models/components/listresponsetoolresponse.js.map +1 -0
  288. package/models/components/promptcreaterequest.d.ts +55 -0
  289. package/models/components/promptcreaterequest.d.ts.map +1 -0
  290. package/models/components/{promptcreate.js → promptcreaterequest.js} +20 -20
  291. package/models/components/promptcreaterequest.js.map +1 -0
  292. package/models/components/prompthistory.d.ts +35 -8
  293. package/models/components/prompthistory.d.ts.map +1 -1
  294. package/models/components/prompthistory.js +8 -8
  295. package/models/components/prompthistory.js.map +1 -1
  296. package/models/components/promptllmconfig.d.ts +48 -0
  297. package/models/components/promptllmconfig.d.ts.map +1 -0
  298. package/models/components/{llmconfig.js → promptllmconfig.js} +20 -20
  299. package/models/components/promptllmconfig.js.map +1 -0
  300. package/models/components/{provider.d.ts → promptllmprovider.d.ts} +8 -8
  301. package/models/components/promptllmprovider.d.ts.map +1 -0
  302. package/models/components/{provider.js → promptllmprovider.js} +12 -13
  303. package/models/components/promptllmprovider.js.map +1 -0
  304. package/models/components/promptresponse.d.ts +87 -0
  305. package/models/components/promptresponse.d.ts.map +1 -0
  306. package/models/components/{prompt.js → promptresponse.js} +20 -21
  307. package/models/components/promptresponse.js.map +1 -0
  308. package/models/components/promptupdaterequest.d.ts +65 -0
  309. package/models/components/promptupdaterequest.d.ts.map +1 -0
  310. package/models/components/{promptupdate.js → promptupdaterequest.js} +20 -20
  311. package/models/components/promptupdaterequest.js.map +1 -0
  312. package/models/components/service.d.ts +4 -1
  313. package/models/components/service.d.ts.map +1 -1
  314. package/models/components/service.js.map +1 -1
  315. package/models/components/session.d.ts +60 -0
  316. package/models/components/session.d.ts.map +1 -1
  317. package/models/components/session.js.map +1 -1
  318. package/models/components/sessionaction.d.ts +15 -0
  319. package/models/components/sessionaction.d.ts.map +1 -1
  320. package/models/components/sessionaction.js.map +1 -1
  321. package/models/components/sessionlabel.d.ts +25 -1
  322. package/models/components/sessionlabel.d.ts.map +1 -1
  323. package/models/components/sessionlabel.js.map +1 -1
  324. package/models/components/sessionlabelcreate.d.ts +18 -0
  325. package/models/components/sessionlabelcreate.d.ts.map +1 -1
  326. package/models/components/sessionlabelcreate.js.map +1 -1
  327. package/models/components/sessionrecordingresponse.d.ts +12 -0
  328. package/models/components/sessionrecordingresponse.d.ts.map +1 -1
  329. package/models/components/sessionrecordingresponse.js.map +1 -1
  330. package/models/components/sessiontext.d.ts +15 -0
  331. package/models/components/sessiontext.d.ts.map +1 -1
  332. package/models/components/sessiontext.js.map +1 -1
  333. package/models/components/sessiontranscriptionresponse.d.ts +12 -0
  334. package/models/components/sessiontranscriptionresponse.d.ts.map +1 -1
  335. package/models/components/sessiontranscriptionresponse.js.map +1 -1
  336. package/models/components/sttprovider.d.ts +6 -0
  337. package/models/components/sttprovider.d.ts.map +1 -1
  338. package/models/components/sttprovider.js +3 -0
  339. package/models/components/sttprovider.js.map +1 -1
  340. package/models/components/targetmodes.d.ts +6 -0
  341. package/models/components/targetmodes.d.ts.map +1 -1
  342. package/models/components/targetmodes.js +3 -0
  343. package/models/components/targetmodes.js.map +1 -1
  344. package/models/components/testmessage.d.ts +21 -0
  345. package/models/components/testmessage.d.ts.map +1 -1
  346. package/models/components/testmessage.js.map +1 -1
  347. package/models/components/testmessageresponse.d.ts +19 -4
  348. package/models/components/testmessageresponse.d.ts.map +1 -1
  349. package/models/components/testmessageresponse.js +4 -4
  350. package/models/components/testmessageresponse.js.map +1 -1
  351. package/models/components/toolargumentlocation.d.ts +52 -0
  352. package/models/components/toolargumentlocation.d.ts.map +1 -0
  353. package/models/components/{custommessage.js → toolargumentlocation.js} +26 -28
  354. package/models/components/toolargumentlocation.js.map +1 -0
  355. package/models/components/toolcreaterequest.d.ts +132 -0
  356. package/models/components/toolcreaterequest.d.ts.map +1 -0
  357. package/models/components/{toolcreate.js → toolcreaterequest.js} +20 -20
  358. package/models/components/toolcreaterequest.js.map +1 -0
  359. package/models/components/{sdktooldefinition.d.ts → tooldefinition.d.ts} +113 -21
  360. package/models/components/tooldefinition.d.ts.map +1 -0
  361. package/models/components/{sdktooldefinition.js → tooldefinition.js} +23 -23
  362. package/models/components/tooldefinition.js.map +1 -0
  363. package/models/components/{function.d.ts → toolfunction.d.ts} +15 -15
  364. package/models/components/toolfunction.d.ts.map +1 -0
  365. package/models/components/{function.js → toolfunction.js} +17 -17
  366. package/models/components/toolfunction.js.map +1 -0
  367. package/models/components/toolhttpendpoint.d.ts +53 -0
  368. package/models/components/toolhttpendpoint.d.ts.map +1 -0
  369. package/models/components/toolhttpendpoint.js +74 -0
  370. package/models/components/toolhttpendpoint.js.map +1 -0
  371. package/models/components/toolhttpmethod.d.ts +34 -0
  372. package/models/components/toolhttpmethod.d.ts.map +1 -0
  373. package/models/components/{directorymemberproperties.js → toolhttpmethod.js} +17 -18
  374. package/models/components/toolhttpmethod.js.map +1 -0
  375. package/models/components/toolparameterdefault.d.ts +2 -2
  376. package/models/components/toolparametertransform.d.ts +4 -4
  377. package/models/components/toolparametertransform.js +1 -1
  378. package/models/components/toolparametertransformcondition.d.ts +1 -1
  379. package/models/components/toolresponse.d.ts +149 -0
  380. package/models/components/toolresponse.d.ts.map +1 -0
  381. package/models/components/{tool.js → toolresponse.js} +20 -21
  382. package/models/components/toolresponse.js.map +1 -0
  383. package/models/components/toolupdaterequest.d.ts +137 -0
  384. package/models/components/toolupdaterequest.d.ts.map +1 -0
  385. package/models/components/{toolupdate.js → toolupdaterequest.js} +20 -20
  386. package/models/components/toolupdaterequest.js.map +1 -0
  387. package/models/operations/index.d.ts +0 -4
  388. package/models/operations/index.d.ts.map +1 -1
  389. package/models/operations/index.js +0 -4
  390. package/models/operations/index.js.map +1 -1
  391. package/openapi-final.json +3083 -0
  392. package/openapi.json +8479 -0
  393. package/package.json +1 -1
  394. package/sdk/agents.d.ts +2 -2
  395. package/sdk/agents.d.ts.map +1 -1
  396. package/sdk/prompts.d.ts +4 -4
  397. package/sdk/prompts.d.ts.map +1 -1
  398. package/sdk/prompts.js.map +1 -1
  399. package/sdk/sdk.d.ts +0 -3
  400. package/sdk/sdk.d.ts.map +1 -1
  401. package/sdk/sdk.js +0 -4
  402. package/sdk/sdk.js.map +1 -1
  403. package/sdk/targets.d.ts +4 -4
  404. package/sdk/targets.d.ts.map +1 -1
  405. package/sdk/tools.d.ts +3 -3
  406. package/sdk/tools.d.ts.map +1 -1
  407. package/sdk/tools.js.map +1 -1
  408. package/src/funcs/agentsAgentGetAvailableVoices.ts +5 -3
  409. package/src/funcs/agentsCreate.ts +8 -6
  410. package/src/funcs/agentsDelete.ts +5 -3
  411. package/src/funcs/agentsGetById.ts +5 -3
  412. package/src/funcs/agentsList.ts +5 -3
  413. package/src/funcs/agentsTestSendTestMessage.ts +5 -3
  414. package/src/funcs/agentsUpdate.ts +8 -6
  415. package/src/funcs/channelsDelete.ts +5 -3
  416. package/src/funcs/channelsList.ts +5 -3
  417. package/src/funcs/channelsTargetsAvailableTargets.ts +5 -3
  418. package/src/funcs/channelsTargetsCreate.ts +8 -6
  419. package/src/funcs/channelsTargetsGetById.ts +8 -6
  420. package/src/funcs/channelsTargetsList.ts +8 -6
  421. package/src/funcs/channelsTargetsUpdate.ts +8 -6
  422. package/src/funcs/conversationsList.ts +5 -3
  423. package/src/funcs/customMessagesCreate.ts +5 -3
  424. package/src/funcs/customMessagesDelete.ts +5 -3
  425. package/src/funcs/customMessagesGetById.ts +5 -3
  426. package/src/funcs/customMessagesList.ts +5 -3
  427. package/src/funcs/customMessagesUpdate.ts +5 -3
  428. package/src/funcs/dashboardsPostSessionEventsDashboard.ts +5 -3
  429. package/src/funcs/dashboardsPostSessionSummaryDashboard.ts +5 -3
  430. package/src/funcs/dashboardsPostSessionTransfersDashboard.ts +5 -3
  431. package/src/funcs/dashboardsPostSessionsDashboard.ts +5 -3
  432. package/src/funcs/eventsList.ts +5 -3
  433. package/src/funcs/promptsCreate.ts +10 -8
  434. package/src/funcs/promptsDelete.ts +5 -3
  435. package/src/funcs/promptsGetById.ts +8 -6
  436. package/src/funcs/promptsList.ts +8 -6
  437. package/src/funcs/promptsPromptsHistory.ts +5 -3
  438. package/src/funcs/promptsUpdate.ts +10 -8
  439. package/src/funcs/servicesCreate.ts +5 -3
  440. package/src/funcs/servicesList.ts +5 -3
  441. package/src/funcs/servicesUpdate.ts +5 -3
  442. package/src/funcs/sessionLabelsCreate.ts +5 -3
  443. package/src/funcs/sessionLabelsGetById.ts +5 -3
  444. package/src/funcs/sessionLabelsList.ts +5 -3
  445. package/src/funcs/sessionsGenerateSessionRecordingUrls.ts +5 -3
  446. package/src/funcs/sessionsGetById.ts +5 -3
  447. package/src/funcs/sessionsList.ts +5 -3
  448. package/src/funcs/sessionsSessionRecordingStream.ts +5 -3
  449. package/src/funcs/sessionsTranscriptGetById.ts +5 -3
  450. package/src/funcs/toolsCreate.ts +10 -8
  451. package/src/funcs/toolsGetByName.ts +5 -3
  452. package/src/funcs/toolsList.ts +8 -6
  453. package/src/funcs/toolsUpdate.ts +10 -8
  454. package/src/funcs/v1PostSessionEventsDashboard.ts +5 -3
  455. package/src/funcs/v1PostSessionSummaryDashboard.ts +5 -3
  456. package/src/funcs/v1PostSessionTransfersDashboard.ts +5 -3
  457. package/src/funcs/v1PostSessionsDashboard.ts +5 -3
  458. package/src/lib/config.ts +3 -3
  459. package/src/lib/encodings.ts +95 -61
  460. package/src/lib/primitives.ts +14 -0
  461. package/src/lib/sdks.ts +4 -1
  462. package/src/models/components/agentcreate.ts +99 -20
  463. package/src/models/components/agentresponse.ts +73 -53
  464. package/src/models/components/agenttooldefaults.ts +9 -0
  465. package/src/models/components/agenttoolfielddefault.ts +9 -0
  466. package/src/models/components/agentupdate.ts +104 -21
  467. package/src/models/components/agentvoice.ts +12 -0
  468. package/src/models/components/agentvoicevarname.ts +6 -0
  469. package/src/models/components/channel.ts +4 -1
  470. package/src/models/components/channelservices.ts +6 -0
  471. package/src/models/components/channeltargetcreaterequest.ts +32 -9
  472. package/src/models/components/channeltargetresponse.ts +179 -0
  473. package/src/models/components/channeltargetupdaterequest.ts +39 -13
  474. package/src/models/components/conversation.ts +42 -0
  475. package/src/models/components/custommessagecreaterequest.ts +9 -9
  476. package/src/models/components/custommessageresponse.ts +17 -9
  477. package/src/models/components/{daocustommessagerule.ts → custommessagerule.ts} +21 -21
  478. package/src/models/components/custommessageupdaterequest.ts +9 -9
  479. package/src/models/components/dashboard.ts +15 -0
  480. package/src/models/components/event.ts +33 -0
  481. package/src/models/components/index.ts +19 -27
  482. package/src/models/components/internaltool.ts +86 -0
  483. package/src/models/components/listresponsechanneltargetresponse.ts +104 -0
  484. package/src/models/components/{listresponsechanneltarget.ts → listresponsepromptresponse.ts} +30 -30
  485. package/src/models/components/{listresponseprompt.ts → listresponsetoolresponse.ts} +30 -30
  486. package/src/models/components/{promptcreate.ts → promptcreaterequest.ts} +35 -31
  487. package/src/models/components/prompthistory.ts +43 -16
  488. package/src/models/components/{llmconfig.ts → promptllmconfig.ts} +29 -27
  489. package/src/models/components/promptllmprovider.ts +39 -0
  490. package/src/models/components/promptresponse.ts +162 -0
  491. package/src/models/components/{promptupdate.ts → promptupdaterequest.ts} +37 -33
  492. package/src/models/components/service.ts +4 -1
  493. package/src/models/components/session.ts +60 -0
  494. package/src/models/components/sessionaction.ts +15 -0
  495. package/src/models/components/sessionlabel.ts +25 -1
  496. package/src/models/components/sessionlabelcreate.ts +18 -0
  497. package/src/models/components/sessionrecordingresponse.ts +12 -0
  498. package/src/models/components/sessiontext.ts +15 -0
  499. package/src/models/components/sessiontranscriptionresponse.ts +12 -0
  500. package/src/models/components/sttprovider.ts +6 -0
  501. package/src/models/components/targetmodes.ts +6 -0
  502. package/src/models/components/testmessage.ts +21 -0
  503. package/src/models/components/testmessageresponse.ts +23 -8
  504. package/src/models/components/toolargumentlocation.ts +53 -0
  505. package/src/models/components/toolcreaterequest.ts +187 -0
  506. package/src/models/components/{sdktooldefinition.ts → tooldefinition.ts} +131 -43
  507. package/src/models/components/{function.ts → toolfunction.ts} +21 -21
  508. package/src/models/components/toolhttpendpoint.ts +111 -0
  509. package/src/models/components/toolhttpmethod.ts +39 -0
  510. package/src/models/components/toolparameterdefault.ts +2 -2
  511. package/src/models/components/toolparametertransform.ts +4 -4
  512. package/src/models/components/toolparametertransformcondition.ts +1 -1
  513. package/src/models/components/toolresponse.ts +206 -0
  514. package/src/models/components/toolupdaterequest.ts +194 -0
  515. package/src/models/operations/index.ts +0 -4
  516. package/src/sdk/agents.ts +2 -2
  517. package/src/sdk/prompts.ts +6 -6
  518. package/src/sdk/sdk.ts +0 -6
  519. package/src/sdk/targets.ts +4 -4
  520. package/src/sdk/tools.ts +5 -5
  521. package/tsconfig.json +41 -0
  522. package/docs/sdks/directory/README.md +0 -559
  523. package/funcs/directoryCreate.d.ts +0 -16
  524. package/funcs/directoryCreate.d.ts.map +0 -1
  525. package/funcs/directoryCreate.js +0 -100
  526. package/funcs/directoryCreate.js.map +0 -1
  527. package/funcs/directoryDelete.d.ts +0 -16
  528. package/funcs/directoryDelete.d.ts.map +0 -1
  529. package/funcs/directoryDelete.js +0 -106
  530. package/funcs/directoryDelete.js.map +0 -1
  531. package/funcs/directoryDirectoryMemberBulkLoad.d.ts +0 -16
  532. package/funcs/directoryDirectoryMemberBulkLoad.d.ts.map +0 -1
  533. package/funcs/directoryDirectoryMemberBulkLoad.js +0 -113
  534. package/funcs/directoryDirectoryMemberBulkLoad.js.map +0 -1
  535. package/funcs/directoryDirectoryMemberDownload.d.ts +0 -14
  536. package/funcs/directoryDirectoryMemberDownload.d.ts.map +0 -1
  537. package/funcs/directoryDirectoryMemberDownload.js +0 -86
  538. package/funcs/directoryDirectoryMemberDownload.js.map +0 -1
  539. package/funcs/directoryGetById.d.ts +0 -17
  540. package/funcs/directoryGetById.d.ts.map +0 -1
  541. package/funcs/directoryGetById.js +0 -106
  542. package/funcs/directoryGetById.js.map +0 -1
  543. package/funcs/directoryList.d.ts +0 -17
  544. package/funcs/directoryList.d.ts.map +0 -1
  545. package/funcs/directoryList.js +0 -112
  546. package/funcs/directoryList.js.map +0 -1
  547. package/funcs/directoryUpdate.d.ts +0 -17
  548. package/funcs/directoryUpdate.d.ts.map +0 -1
  549. package/funcs/directoryUpdate.js +0 -107
  550. package/funcs/directoryUpdate.js.map +0 -1
  551. package/models/components/agent.d.ts +0 -70
  552. package/models/components/agent.d.ts.map +0 -1
  553. package/models/components/agent.js +0 -111
  554. package/models/components/agent.js.map +0 -1
  555. package/models/components/bodydirectorymemberbulkload.d.ts +0 -56
  556. package/models/components/bodydirectorymemberbulkload.d.ts.map +0 -1
  557. package/models/components/bodydirectorymemberbulkload.js +0 -100
  558. package/models/components/bodydirectorymemberbulkload.js.map +0 -1
  559. package/models/components/channeltarget.d.ts +0 -53
  560. package/models/components/channeltarget.d.ts.map +0 -1
  561. package/models/components/channeltarget.js.map +0 -1
  562. package/models/components/custommessage.d.ts +0 -42
  563. package/models/components/custommessage.d.ts.map +0 -1
  564. package/models/components/custommessage.js.map +0 -1
  565. package/models/components/daochanneltargetagent.d.ts +0 -47
  566. package/models/components/daochanneltargetagent.d.ts.map +0 -1
  567. package/models/components/daochanneltargetagent.js +0 -92
  568. package/models/components/daochanneltargetagent.js.map +0 -1
  569. package/models/components/daocustommessagerule.d.ts.map +0 -1
  570. package/models/components/daocustommessagerule.js.map +0 -1
  571. package/models/components/directoryextension.d.ts +0 -52
  572. package/models/components/directoryextension.d.ts.map +0 -1
  573. package/models/components/directoryextension.js +0 -84
  574. package/models/components/directoryextension.js.map +0 -1
  575. package/models/components/directorymember.d.ts +0 -63
  576. package/models/components/directorymember.d.ts.map +0 -1
  577. package/models/components/directorymember.js +0 -108
  578. package/models/components/directorymember.js.map +0 -1
  579. package/models/components/directorymembercreate.d.ts +0 -61
  580. package/models/components/directorymembercreate.d.ts.map +0 -1
  581. package/models/components/directorymembercreate.js +0 -106
  582. package/models/components/directorymembercreate.js.map +0 -1
  583. package/models/components/directorymemberproperties.d.ts +0 -40
  584. package/models/components/directorymemberproperties.d.ts.map +0 -1
  585. package/models/components/directorymemberproperties.js.map +0 -1
  586. package/models/components/function.d.ts.map +0 -1
  587. package/models/components/function.js.map +0 -1
  588. package/models/components/httpendpoint.d.ts +0 -114
  589. package/models/components/httpendpoint.d.ts.map +0 -1
  590. package/models/components/httpendpoint.js +0 -119
  591. package/models/components/httpendpoint.js.map +0 -1
  592. package/models/components/listresponsechanneltarget.d.ts +0 -38
  593. package/models/components/listresponsechanneltarget.d.ts.map +0 -1
  594. package/models/components/listresponsechanneltarget.js.map +0 -1
  595. package/models/components/listresponsedirectorymember.d.ts +0 -38
  596. package/models/components/listresponsedirectorymember.d.ts.map +0 -1
  597. package/models/components/listresponsedirectorymember.js.map +0 -1
  598. package/models/components/listresponseprompt.d.ts +0 -38
  599. package/models/components/listresponseprompt.d.ts.map +0 -1
  600. package/models/components/listresponseprompt.js.map +0 -1
  601. package/models/components/listresponsetool.d.ts +0 -38
  602. package/models/components/listresponsetool.d.ts.map +0 -1
  603. package/models/components/listresponsetool.js +0 -81
  604. package/models/components/listresponsetool.js.map +0 -1
  605. package/models/components/llmconfig.d.ts +0 -48
  606. package/models/components/llmconfig.d.ts.map +0 -1
  607. package/models/components/llmconfig.js.map +0 -1
  608. package/models/components/prompt.d.ts +0 -80
  609. package/models/components/prompt.d.ts.map +0 -1
  610. package/models/components/prompt.js.map +0 -1
  611. package/models/components/promptcreate.d.ts +0 -55
  612. package/models/components/promptcreate.d.ts.map +0 -1
  613. package/models/components/promptcreate.js.map +0 -1
  614. package/models/components/promptupdate.d.ts +0 -65
  615. package/models/components/promptupdate.d.ts.map +0 -1
  616. package/models/components/promptupdate.js.map +0 -1
  617. package/models/components/provider.d.ts.map +0 -1
  618. package/models/components/provider.js.map +0 -1
  619. package/models/components/sdkinternaltool.d.ts +0 -46
  620. package/models/components/sdkinternaltool.d.ts.map +0 -1
  621. package/models/components/sdkinternaltool.js.map +0 -1
  622. package/models/components/sdktooldefinition.d.ts.map +0 -1
  623. package/models/components/sdktooldefinition.js.map +0 -1
  624. package/models/components/target.d.ts +0 -65
  625. package/models/components/target.d.ts.map +0 -1
  626. package/models/components/target.js +0 -94
  627. package/models/components/target.js.map +0 -1
  628. package/models/components/tool.d.ts +0 -50
  629. package/models/components/tool.d.ts.map +0 -1
  630. package/models/components/tool.js.map +0 -1
  631. package/models/components/toolcreate.d.ts +0 -40
  632. package/models/components/toolcreate.d.ts.map +0 -1
  633. package/models/components/toolcreate.js.map +0 -1
  634. package/models/components/toolupdate.d.ts +0 -45
  635. package/models/components/toolupdate.d.ts.map +0 -1
  636. package/models/components/toolupdate.js.map +0 -1
  637. package/models/operations/directorymemberdelete.d.ts +0 -29
  638. package/models/operations/directorymemberdelete.d.ts.map +0 -1
  639. package/models/operations/directorymemberdelete.js +0 -68
  640. package/models/operations/directorymemberdelete.js.map +0 -1
  641. package/models/operations/directorymembergetbyid.d.ts +0 -29
  642. package/models/operations/directorymembergetbyid.d.ts.map +0 -1
  643. package/models/operations/directorymembergetbyid.js +0 -68
  644. package/models/operations/directorymembergetbyid.js.map +0 -1
  645. package/models/operations/directorymemberlist.d.ts +0 -46
  646. package/models/operations/directorymemberlist.d.ts.map +0 -1
  647. package/models/operations/directorymemberlist.js +0 -101
  648. package/models/operations/directorymemberlist.js.map +0 -1
  649. package/models/operations/directorymemberupdate.d.ts +0 -32
  650. package/models/operations/directorymemberupdate.d.ts.map +0 -1
  651. package/models/operations/directorymemberupdate.js +0 -73
  652. package/models/operations/directorymemberupdate.js.map +0 -1
  653. package/sdk/directory.d.ts +0 -55
  654. package/sdk/directory.d.ts.map +0 -1
  655. package/sdk/directory.js +0 -82
  656. package/sdk/directory.js.map +0 -1
  657. package/src/funcs/directoryCreate.ts +0 -132
  658. package/src/funcs/directoryDelete.ts +0 -140
  659. package/src/funcs/directoryDirectoryMemberBulkLoad.ts +0 -149
  660. package/src/funcs/directoryDirectoryMemberDownload.ts +0 -108
  661. package/src/funcs/directoryGetById.ts +0 -140
  662. package/src/funcs/directoryList.ts +0 -146
  663. package/src/funcs/directoryUpdate.ts +0 -141
  664. package/src/models/components/agent.ts +0 -153
  665. package/src/models/components/bodydirectorymemberbulkload.ts +0 -134
  666. package/src/models/components/channeltarget.ts +0 -136
  667. package/src/models/components/custommessage.ts +0 -79
  668. package/src/models/components/daochanneltargetagent.ts +0 -117
  669. package/src/models/components/directoryextension.ts +0 -113
  670. package/src/models/components/directorymember.ts +0 -155
  671. package/src/models/components/directorymembercreate.ts +0 -163
  672. package/src/models/components/directorymemberproperties.ts +0 -39
  673. package/src/models/components/httpendpoint.ts +0 -158
  674. package/src/models/components/listresponsedirectorymember.ts +0 -103
  675. package/src/models/components/listresponsetool.ts +0 -101
  676. package/src/models/components/prompt.ts +0 -152
  677. package/src/models/components/provider.ts +0 -37
  678. package/src/models/components/sdkinternaltool.ts +0 -88
  679. package/src/models/components/target.ts +0 -132
  680. package/src/models/components/tool.ts +0 -101
  681. package/src/models/components/toolcreate.ts +0 -91
  682. package/src/models/components/toolupdate.ts +0 -98
  683. package/src/models/operations/directorymemberdelete.ts +0 -77
  684. package/src/models/operations/directorymembergetbyid.ts +0 -77
  685. package/src/models/operations/directorymemberlist.ts +0 -128
  686. package/src/models/operations/directorymemberupdate.ts +0 -84
  687. package/src/sdk/directory.ts +0 -134
@@ -1,559 +0,0 @@
1
- # Directory
2
- (*directory*)
3
-
4
- ## Overview
5
-
6
- Operations related to directory
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Directory Member List
11
- * [create](#create) - Create Directory Member
12
- * [getById](#getbyid) - Get Directory Member By Id
13
- * [update](#update) - Update Directory Member
14
- * [delete](#delete) - Delete Directory Member
15
- * [directoryMemberBulkLoad](#directorymemberbulkload) - Bulk Load Directory Members
16
- * [directoryMemberDownload](#directorymemberdownload) - Download Directory Members
17
-
18
- ## list
19
-
20
- List the existing directory_members
21
-
22
- ### Example Usage
23
-
24
- ```typescript
25
- import { SyllableSDK } from "syllable-sdk";
26
-
27
- const syllableSDK = new SyllableSDK({
28
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
29
- });
30
-
31
- async function run() {
32
- const result = await syllableSDK.directory.list({});
33
-
34
- // Handle the result
35
- console.log(result);
36
- }
37
-
38
- run();
39
- ```
40
-
41
- ### Standalone function
42
-
43
- The standalone function version of this method:
44
-
45
- ```typescript
46
- import { SyllableSDKCore } from "syllable-sdk/core.js";
47
- import { directoryList } from "syllable-sdk/funcs/directoryList.js";
48
-
49
- // Use `SyllableSDKCore` for best tree-shaking performance.
50
- // You can create one instance of it to use across an application.
51
- const syllableSDK = new SyllableSDKCore({
52
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
53
- });
54
-
55
- async function run() {
56
- const res = await directoryList(syllableSDK, {});
57
-
58
- if (!res.ok) {
59
- throw res.error;
60
- }
61
-
62
- const { value: result } = res;
63
-
64
- // Handle the result
65
- console.log(result);
66
- }
67
-
68
- run();
69
- ```
70
-
71
- ### Parameters
72
-
73
- | Parameter | Type | Required | Description |
74
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
75
- | `request` | [operations.DirectoryMemberListRequest](../../models/operations/directorymemberlistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
76
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
77
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
78
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
79
-
80
- ### Response
81
-
82
- **Promise\<[components.ListResponseDirectoryMember](../../models/components/listresponsedirectorymember.md)\>**
83
-
84
- ### Errors
85
-
86
- | Error Type | Status Code | Content Type |
87
- | -------------------------- | -------------------------- | -------------------------- |
88
- | errors.HTTPValidationError | 422 | application/json |
89
- | errors.SDKError | 4XX, 5XX | \*/\* |
90
-
91
- ## create
92
-
93
- Create a new member in the directory
94
-
95
- ### Example Usage
96
-
97
- ```typescript
98
- import { SyllableSDK } from "syllable-sdk";
99
-
100
- const syllableSDK = new SyllableSDK({
101
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
102
- });
103
-
104
- async function run() {
105
- const result = await syllableSDK.directory.create({
106
- name: "<value>",
107
- type: "<value>",
108
- });
109
-
110
- // Handle the result
111
- console.log(result);
112
- }
113
-
114
- run();
115
- ```
116
-
117
- ### Standalone function
118
-
119
- The standalone function version of this method:
120
-
121
- ```typescript
122
- import { SyllableSDKCore } from "syllable-sdk/core.js";
123
- import { directoryCreate } from "syllable-sdk/funcs/directoryCreate.js";
124
-
125
- // Use `SyllableSDKCore` for best tree-shaking performance.
126
- // You can create one instance of it to use across an application.
127
- const syllableSDK = new SyllableSDKCore({
128
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
129
- });
130
-
131
- async function run() {
132
- const res = await directoryCreate(syllableSDK, {
133
- name: "<value>",
134
- type: "<value>",
135
- });
136
-
137
- if (!res.ok) {
138
- throw res.error;
139
- }
140
-
141
- const { value: result } = res;
142
-
143
- // Handle the result
144
- console.log(result);
145
- }
146
-
147
- run();
148
- ```
149
-
150
- ### Parameters
151
-
152
- | Parameter | Type | Required | Description |
153
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
154
- | `request` | [components.DirectoryMemberCreate](../../models/components/directorymembercreate.md) | :heavy_check_mark: | The request object to use for the request. |
155
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
156
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
157
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
158
-
159
- ### Response
160
-
161
- **Promise\<[components.DirectoryMember](../../models/components/directorymember.md)\>**
162
-
163
- ### Errors
164
-
165
- | Error Type | Status Code | Content Type |
166
- | -------------------------- | -------------------------- | -------------------------- |
167
- | errors.HTTPValidationError | 422 | application/json |
168
- | errors.SDKError | 4XX, 5XX | \*/\* |
169
-
170
- ## getById
171
-
172
- Get a DirectoryMember by ID.
173
-
174
- ### Example Usage
175
-
176
- ```typescript
177
- import { SyllableSDK } from "syllable-sdk";
178
-
179
- const syllableSDK = new SyllableSDK({
180
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
181
- });
182
-
183
- async function run() {
184
- const result = await syllableSDK.directory.getById({
185
- memberId: 931598,
186
- });
187
-
188
- // Handle the result
189
- console.log(result);
190
- }
191
-
192
- run();
193
- ```
194
-
195
- ### Standalone function
196
-
197
- The standalone function version of this method:
198
-
199
- ```typescript
200
- import { SyllableSDKCore } from "syllable-sdk/core.js";
201
- import { directoryGetById } from "syllable-sdk/funcs/directoryGetById.js";
202
-
203
- // Use `SyllableSDKCore` for best tree-shaking performance.
204
- // You can create one instance of it to use across an application.
205
- const syllableSDK = new SyllableSDKCore({
206
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
207
- });
208
-
209
- async function run() {
210
- const res = await directoryGetById(syllableSDK, {
211
- memberId: 931598,
212
- });
213
-
214
- if (!res.ok) {
215
- throw res.error;
216
- }
217
-
218
- const { value: result } = res;
219
-
220
- // Handle the result
221
- console.log(result);
222
- }
223
-
224
- run();
225
- ```
226
-
227
- ### Parameters
228
-
229
- | Parameter | Type | Required | Description |
230
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
231
- | `request` | [operations.DirectoryMemberGetByIdRequest](../../models/operations/directorymembergetbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
232
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
233
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
234
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
235
-
236
- ### Response
237
-
238
- **Promise\<[components.DirectoryMember](../../models/components/directorymember.md)\>**
239
-
240
- ### Errors
241
-
242
- | Error Type | Status Code | Content Type |
243
- | -------------------------- | -------------------------- | -------------------------- |
244
- | errors.HTTPValidationError | 422 | application/json |
245
- | errors.SDKError | 4XX, 5XX | \*/\* |
246
-
247
- ## update
248
-
249
- Update a DirectoryMember.
250
-
251
- ### Example Usage
252
-
253
- ```typescript
254
- import { SyllableSDK } from "syllable-sdk";
255
-
256
- const syllableSDK = new SyllableSDK({
257
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
258
- });
259
-
260
- async function run() {
261
- const result = await syllableSDK.directory.update({
262
- memberId: 597129,
263
- directoryMember: {
264
- name: "<value>",
265
- type: "<value>",
266
- id: 857478,
267
- },
268
- });
269
-
270
- // Handle the result
271
- console.log(result);
272
- }
273
-
274
- run();
275
- ```
276
-
277
- ### Standalone function
278
-
279
- The standalone function version of this method:
280
-
281
- ```typescript
282
- import { SyllableSDKCore } from "syllable-sdk/core.js";
283
- import { directoryUpdate } from "syllable-sdk/funcs/directoryUpdate.js";
284
-
285
- // Use `SyllableSDKCore` for best tree-shaking performance.
286
- // You can create one instance of it to use across an application.
287
- const syllableSDK = new SyllableSDKCore({
288
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
289
- });
290
-
291
- async function run() {
292
- const res = await directoryUpdate(syllableSDK, {
293
- memberId: 597129,
294
- directoryMember: {
295
- name: "<value>",
296
- type: "<value>",
297
- id: 857478,
298
- },
299
- });
300
-
301
- if (!res.ok) {
302
- throw res.error;
303
- }
304
-
305
- const { value: result } = res;
306
-
307
- // Handle the result
308
- console.log(result);
309
- }
310
-
311
- run();
312
- ```
313
-
314
- ### Parameters
315
-
316
- | Parameter | Type | Required | Description |
317
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
318
- | `request` | [operations.DirectoryMemberUpdateRequest](../../models/operations/directorymemberupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
319
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
320
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
321
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
322
-
323
- ### Response
324
-
325
- **Promise\<[components.DirectoryMember](../../models/components/directorymember.md)\>**
326
-
327
- ### Errors
328
-
329
- | Error Type | Status Code | Content Type |
330
- | -------------------------- | -------------------------- | -------------------------- |
331
- | errors.HTTPValidationError | 422 | application/json |
332
- | errors.SDKError | 4XX, 5XX | \*/\* |
333
-
334
- ## delete
335
-
336
- Delete a DirectoryMember.
337
-
338
- ### Example Usage
339
-
340
- ```typescript
341
- import { SyllableSDK } from "syllable-sdk";
342
-
343
- const syllableSDK = new SyllableSDK({
344
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
345
- });
346
-
347
- async function run() {
348
- const result = await syllableSDK.directory.delete({
349
- memberId: 545907,
350
- });
351
-
352
- // Handle the result
353
- console.log(result);
354
- }
355
-
356
- run();
357
- ```
358
-
359
- ### Standalone function
360
-
361
- The standalone function version of this method:
362
-
363
- ```typescript
364
- import { SyllableSDKCore } from "syllable-sdk/core.js";
365
- import { directoryDelete } from "syllable-sdk/funcs/directoryDelete.js";
366
-
367
- // Use `SyllableSDKCore` for best tree-shaking performance.
368
- // You can create one instance of it to use across an application.
369
- const syllableSDK = new SyllableSDKCore({
370
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
371
- });
372
-
373
- async function run() {
374
- const res = await directoryDelete(syllableSDK, {
375
- memberId: 545907,
376
- });
377
-
378
- if (!res.ok) {
379
- throw res.error;
380
- }
381
-
382
- const { value: result } = res;
383
-
384
- // Handle the result
385
- console.log(result);
386
- }
387
-
388
- run();
389
- ```
390
-
391
- ### Parameters
392
-
393
- | Parameter | Type | Required | Description |
394
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
395
- | `request` | [operations.DirectoryMemberDeleteRequest](../../models/operations/directorymemberdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
396
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
397
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
398
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
399
-
400
- ### Response
401
-
402
- **Promise\<[any](../../models/.md)\>**
403
-
404
- ### Errors
405
-
406
- | Error Type | Status Code | Content Type |
407
- | -------------------------- | -------------------------- | -------------------------- |
408
- | errors.HTTPValidationError | 422 | application/json |
409
- | errors.SDKError | 4XX, 5XX | \*/\* |
410
-
411
- ## directoryMemberBulkLoad
412
-
413
- Update Directory Members in chunks of 100.
414
-
415
- ### Example Usage
416
-
417
- ```typescript
418
- import { openAsBlob } from "node:fs";
419
- import { SyllableSDK } from "syllable-sdk";
420
-
421
- const syllableSDK = new SyllableSDK({
422
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
423
- });
424
-
425
- async function run() {
426
- const result = await syllableSDK.directory.directoryMemberBulkLoad({
427
- file: await openAsBlob("example.file"),
428
- });
429
-
430
- // Handle the result
431
- console.log(result);
432
- }
433
-
434
- run();
435
- ```
436
-
437
- ### Standalone function
438
-
439
- The standalone function version of this method:
440
-
441
- ```typescript
442
- import { openAsBlob } from "node:fs";
443
- import { SyllableSDKCore } from "syllable-sdk/core.js";
444
- import { directoryDirectoryMemberBulkLoad } from "syllable-sdk/funcs/directoryDirectoryMemberBulkLoad.js";
445
-
446
- // Use `SyllableSDKCore` for best tree-shaking performance.
447
- // You can create one instance of it to use across an application.
448
- const syllableSDK = new SyllableSDKCore({
449
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
450
- });
451
-
452
- async function run() {
453
- const res = await directoryDirectoryMemberBulkLoad(syllableSDK, {
454
- file: await openAsBlob("example.file"),
455
- });
456
-
457
- if (!res.ok) {
458
- throw res.error;
459
- }
460
-
461
- const { value: result } = res;
462
-
463
- // Handle the result
464
- console.log(result);
465
- }
466
-
467
- run();
468
- ```
469
-
470
- ### Parameters
471
-
472
- | Parameter | Type | Required | Description |
473
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
474
- | `request` | [components.BodyDirectoryMemberBulkLoad](../../models/components/bodydirectorymemberbulkload.md) | :heavy_check_mark: | The request object to use for the request. |
475
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
476
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
477
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
478
-
479
- ### Response
480
-
481
- **Promise\<[any](../../models/.md)\>**
482
-
483
- ### Errors
484
-
485
- | Error Type | Status Code | Content Type |
486
- | -------------------------- | -------------------------- | -------------------------- |
487
- | errors.HTTPValidationError | 422 | application/json |
488
- | errors.SDKError | 4XX, 5XX | \*/\* |
489
-
490
- ## directoryMemberDownload
491
-
492
- Download the entire directory as a JSON file.
493
-
494
- ### Example Usage
495
-
496
- ```typescript
497
- import { SyllableSDK } from "syllable-sdk";
498
-
499
- const syllableSDK = new SyllableSDK({
500
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
501
- });
502
-
503
- async function run() {
504
- const result = await syllableSDK.directory.directoryMemberDownload();
505
-
506
- // Handle the result
507
- console.log(result);
508
- }
509
-
510
- run();
511
- ```
512
-
513
- ### Standalone function
514
-
515
- The standalone function version of this method:
516
-
517
- ```typescript
518
- import { SyllableSDKCore } from "syllable-sdk/core.js";
519
- import { directoryDirectoryMemberDownload } from "syllable-sdk/funcs/directoryDirectoryMemberDownload.js";
520
-
521
- // Use `SyllableSDKCore` for best tree-shaking performance.
522
- // You can create one instance of it to use across an application.
523
- const syllableSDK = new SyllableSDKCore({
524
- apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
525
- });
526
-
527
- async function run() {
528
- const res = await directoryDirectoryMemberDownload(syllableSDK);
529
-
530
- if (!res.ok) {
531
- throw res.error;
532
- }
533
-
534
- const { value: result } = res;
535
-
536
- // Handle the result
537
- console.log(result);
538
- }
539
-
540
- run();
541
- ```
542
-
543
- ### Parameters
544
-
545
- | Parameter | Type | Required | Description |
546
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
547
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
548
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
549
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
550
-
551
- ### Response
552
-
553
- **Promise\<[any](../../models/.md)\>**
554
-
555
- ### Errors
556
-
557
- | Error Type | Status Code | Content Type |
558
- | --------------- | --------------- | --------------- |
559
- | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -1,16 +0,0 @@
1
- import { SyllableSDKCore } from "../core.js";
2
- import { RequestOptions } from "../lib/sdks.js";
3
- import * as components from "../models/components/index.js";
4
- import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
5
- import * as errors from "../models/errors/index.js";
6
- import { SDKError } from "../models/errors/sdkerror.js";
7
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
8
- import { Result } from "../types/fp.js";
9
- /**
10
- * Create Directory Member
11
- *
12
- * @remarks
13
- * Create a new member in the directory
14
- */
15
- export declare function directoryCreate(client: SyllableSDKCore, request: components.DirectoryMemberCreate, options?: RequestOptions): Promise<Result<components.DirectoryMember, errors.HTTPValidationError | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
16
- //# sourceMappingURL=directoryCreate.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"directoryCreate.d.ts","sourceRoot":"","sources":["../src/funcs/directoryCreate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAI7C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,eAAe,EACxB,MAAM,CAAC,mBAAmB,GAC1B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAqFA"}