telnyx 7.30.0 → 7.31.0

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 (357) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/client.d.mts +22 -4
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +22 -4
  5. package/client.d.ts.map +1 -1
  6. package/client.js +18 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +18 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/agent-gateways/agent-gateways.d.mts +360 -0
  12. package/resources/agent-gateways/agent-gateways.d.mts.map +1 -0
  13. package/resources/agent-gateways/agent-gateways.d.ts +360 -0
  14. package/resources/agent-gateways/agent-gateways.d.ts.map +1 -0
  15. package/resources/agent-gateways/agent-gateways.js +140 -0
  16. package/resources/agent-gateways/agent-gateways.js.map +1 -0
  17. package/resources/agent-gateways/agent-gateways.mjs +135 -0
  18. package/resources/agent-gateways/agent-gateways.mjs.map +1 -0
  19. package/resources/agent-gateways/apis.d.mts +300 -0
  20. package/resources/agent-gateways/apis.d.mts.map +1 -0
  21. package/resources/agent-gateways/apis.d.ts +300 -0
  22. package/resources/agent-gateways/apis.d.ts.map +1 -0
  23. package/resources/agent-gateways/apis.js +89 -0
  24. package/resources/agent-gateways/apis.js.map +1 -0
  25. package/resources/agent-gateways/apis.mjs +85 -0
  26. package/resources/agent-gateways/apis.mjs.map +1 -0
  27. package/resources/agent-gateways/guardrails.d.mts +210 -0
  28. package/resources/agent-gateways/guardrails.d.mts.map +1 -0
  29. package/resources/agent-gateways/guardrails.d.ts +210 -0
  30. package/resources/agent-gateways/guardrails.d.ts.map +1 -0
  31. package/resources/agent-gateways/guardrails.js +96 -0
  32. package/resources/agent-gateways/guardrails.js.map +1 -0
  33. package/resources/agent-gateways/guardrails.mjs +92 -0
  34. package/resources/agent-gateways/guardrails.mjs.map +1 -0
  35. package/resources/agent-gateways/index.d.mts +9 -0
  36. package/resources/agent-gateways/index.d.mts.map +1 -0
  37. package/resources/agent-gateways/index.d.ts +9 -0
  38. package/resources/agent-gateways/index.d.ts.map +1 -0
  39. package/resources/agent-gateways/index.js +21 -0
  40. package/resources/agent-gateways/index.js.map +1 -0
  41. package/resources/agent-gateways/index.mjs +10 -0
  42. package/resources/agent-gateways/index.mjs.map +1 -0
  43. package/resources/agent-gateways/keys/index.d.mts +3 -0
  44. package/resources/agent-gateways/keys/index.d.mts.map +1 -0
  45. package/resources/agent-gateways/keys/index.d.ts +3 -0
  46. package/resources/agent-gateways/keys/index.d.ts.map +1 -0
  47. package/resources/agent-gateways/keys/index.js +9 -0
  48. package/resources/agent-gateways/keys/index.js.map +1 -0
  49. package/resources/agent-gateways/keys/index.mjs +4 -0
  50. package/resources/agent-gateways/keys/index.mjs.map +1 -0
  51. package/resources/agent-gateways/keys/keys.d.mts +329 -0
  52. package/resources/agent-gateways/keys/keys.d.mts.map +1 -0
  53. package/resources/agent-gateways/keys/keys.d.ts +329 -0
  54. package/resources/agent-gateways/keys/keys.d.ts.map +1 -0
  55. package/resources/agent-gateways/keys/keys.js +99 -0
  56. package/resources/agent-gateways/keys/keys.js.map +1 -0
  57. package/resources/agent-gateways/keys/keys.mjs +94 -0
  58. package/resources/agent-gateways/keys/keys.mjs.map +1 -0
  59. package/resources/agent-gateways/keys/tool-permissions.d.mts +103 -0
  60. package/resources/agent-gateways/keys/tool-permissions.d.mts.map +1 -0
  61. package/resources/agent-gateways/keys/tool-permissions.d.ts +103 -0
  62. package/resources/agent-gateways/keys/tool-permissions.d.ts.map +1 -0
  63. package/resources/agent-gateways/keys/tool-permissions.js +62 -0
  64. package/resources/agent-gateways/keys/tool-permissions.js.map +1 -0
  65. package/resources/agent-gateways/keys/tool-permissions.mjs +58 -0
  66. package/resources/agent-gateways/keys/tool-permissions.mjs.map +1 -0
  67. package/resources/agent-gateways/keys.d.mts +2 -0
  68. package/resources/agent-gateways/keys.d.mts.map +1 -0
  69. package/resources/agent-gateways/keys.d.ts +2 -0
  70. package/resources/agent-gateways/keys.d.ts.map +1 -0
  71. package/resources/agent-gateways/keys.js +6 -0
  72. package/resources/agent-gateways/keys.js.map +1 -0
  73. package/resources/agent-gateways/keys.mjs +3 -0
  74. package/resources/agent-gateways/keys.mjs.map +1 -0
  75. package/resources/agent-gateways/mcp-servers.d.mts +246 -0
  76. package/resources/agent-gateways/mcp-servers.d.mts.map +1 -0
  77. package/resources/agent-gateways/mcp-servers.d.ts +246 -0
  78. package/resources/agent-gateways/mcp-servers.d.ts.map +1 -0
  79. package/resources/agent-gateways/mcp-servers.js +97 -0
  80. package/resources/agent-gateways/mcp-servers.js.map +1 -0
  81. package/resources/agent-gateways/mcp-servers.mjs +93 -0
  82. package/resources/agent-gateways/mcp-servers.mjs.map +1 -0
  83. package/resources/agent-gateways/policies.d.mts +266 -0
  84. package/resources/agent-gateways/policies.d.mts.map +1 -0
  85. package/resources/agent-gateways/policies.d.ts +266 -0
  86. package/resources/agent-gateways/policies.d.ts.map +1 -0
  87. package/resources/agent-gateways/policies.js +97 -0
  88. package/resources/agent-gateways/policies.js.map +1 -0
  89. package/resources/agent-gateways/policies.mjs +93 -0
  90. package/resources/agent-gateways/policies.mjs.map +1 -0
  91. package/resources/agent-gateways/policy-attachments.d.mts +123 -0
  92. package/resources/agent-gateways/policy-attachments.d.mts.map +1 -0
  93. package/resources/agent-gateways/policy-attachments.d.ts +123 -0
  94. package/resources/agent-gateways/policy-attachments.d.ts.map +1 -0
  95. package/resources/agent-gateways/policy-attachments.js +63 -0
  96. package/resources/agent-gateways/policy-attachments.js.map +1 -0
  97. package/resources/agent-gateways/policy-attachments.mjs +59 -0
  98. package/resources/agent-gateways/policy-attachments.mjs.map +1 -0
  99. package/resources/agent-gateways/teams/index.d.mts +3 -0
  100. package/resources/agent-gateways/teams/index.d.mts.map +1 -0
  101. package/resources/agent-gateways/teams/index.d.ts +3 -0
  102. package/resources/agent-gateways/teams/index.d.ts.map +1 -0
  103. package/resources/agent-gateways/teams/index.js +9 -0
  104. package/resources/agent-gateways/teams/index.js.map +1 -0
  105. package/resources/agent-gateways/teams/index.mjs +4 -0
  106. package/resources/agent-gateways/teams/index.mjs.map +1 -0
  107. package/resources/agent-gateways/teams/teams.d.mts +210 -0
  108. package/resources/agent-gateways/teams/teams.d.mts.map +1 -0
  109. package/resources/agent-gateways/teams/teams.d.ts +210 -0
  110. package/resources/agent-gateways/teams/teams.d.ts.map +1 -0
  111. package/resources/agent-gateways/teams/teams.js +98 -0
  112. package/resources/agent-gateways/teams/teams.js.map +1 -0
  113. package/resources/agent-gateways/teams/teams.mjs +93 -0
  114. package/resources/agent-gateways/teams/teams.mjs.map +1 -0
  115. package/resources/agent-gateways/teams/tool-permissions.d.mts +82 -0
  116. package/resources/agent-gateways/teams/tool-permissions.d.mts.map +1 -0
  117. package/resources/agent-gateways/teams/tool-permissions.d.ts +82 -0
  118. package/resources/agent-gateways/teams/tool-permissions.d.ts.map +1 -0
  119. package/resources/agent-gateways/teams/tool-permissions.js +62 -0
  120. package/resources/agent-gateways/teams/tool-permissions.js.map +1 -0
  121. package/resources/agent-gateways/teams/tool-permissions.mjs +58 -0
  122. package/resources/agent-gateways/teams/tool-permissions.mjs.map +1 -0
  123. package/resources/agent-gateways/teams.d.mts +2 -0
  124. package/resources/agent-gateways/teams.d.mts.map +1 -0
  125. package/resources/agent-gateways/teams.d.ts +2 -0
  126. package/resources/agent-gateways/teams.d.ts.map +1 -0
  127. package/resources/agent-gateways/teams.js +6 -0
  128. package/resources/agent-gateways/teams.js.map +1 -0
  129. package/resources/agent-gateways/teams.mjs +3 -0
  130. package/resources/agent-gateways/teams.mjs.map +1 -0
  131. package/resources/agent-gateways.d.mts +2 -0
  132. package/resources/agent-gateways.d.mts.map +1 -0
  133. package/resources/agent-gateways.d.ts +2 -0
  134. package/resources/agent-gateways.d.ts.map +1 -0
  135. package/resources/agent-gateways.js +6 -0
  136. package/resources/agent-gateways.js.map +1 -0
  137. package/resources/agent-gateways.mjs +3 -0
  138. package/resources/agent-gateways.mjs.map +1 -0
  139. package/resources/ai/assistants/assistants.d.mts +23 -9
  140. package/resources/ai/assistants/assistants.d.mts.map +1 -1
  141. package/resources/ai/assistants/assistants.d.ts +23 -9
  142. package/resources/ai/assistants/assistants.d.ts.map +1 -1
  143. package/resources/ai/assistants/assistants.js.map +1 -1
  144. package/resources/ai/assistants/assistants.mjs.map +1 -1
  145. package/resources/ai/memory/namespaces/index.d.mts +1 -1
  146. package/resources/ai/memory/namespaces/index.d.mts.map +1 -1
  147. package/resources/ai/memory/namespaces/index.d.ts +1 -1
  148. package/resources/ai/memory/namespaces/index.d.ts.map +1 -1
  149. package/resources/ai/memory/namespaces/index.js.map +1 -1
  150. package/resources/ai/memory/namespaces/index.mjs.map +1 -1
  151. package/resources/ai/memory/namespaces/namespaces.d.mts +2 -2
  152. package/resources/ai/memory/namespaces/namespaces.d.mts.map +1 -1
  153. package/resources/ai/memory/namespaces/namespaces.d.ts +2 -2
  154. package/resources/ai/memory/namespaces/namespaces.d.ts.map +1 -1
  155. package/resources/ai/memory/namespaces/namespaces.js.map +1 -1
  156. package/resources/ai/memory/namespaces/namespaces.mjs.map +1 -1
  157. package/resources/ai/memory/namespaces/profiles/index.d.mts +1 -1
  158. package/resources/ai/memory/namespaces/profiles/index.d.mts.map +1 -1
  159. package/resources/ai/memory/namespaces/profiles/index.d.ts +1 -1
  160. package/resources/ai/memory/namespaces/profiles/index.d.ts.map +1 -1
  161. package/resources/ai/memory/namespaces/profiles/index.js.map +1 -1
  162. package/resources/ai/memory/namespaces/profiles/index.mjs.map +1 -1
  163. package/resources/ai/memory/namespaces/profiles/profiles.d.mts +20 -2
  164. package/resources/ai/memory/namespaces/profiles/profiles.d.mts.map +1 -1
  165. package/resources/ai/memory/namespaces/profiles/profiles.d.ts +20 -2
  166. package/resources/ai/memory/namespaces/profiles/profiles.d.ts.map +1 -1
  167. package/resources/ai/memory/namespaces/profiles/profiles.js.map +1 -1
  168. package/resources/ai/memory/namespaces/profiles/profiles.mjs.map +1 -1
  169. package/resources/calendar-connections/calendar-connections.d.mts +380 -0
  170. package/resources/calendar-connections/calendar-connections.d.mts.map +1 -0
  171. package/resources/calendar-connections/calendar-connections.d.ts +380 -0
  172. package/resources/calendar-connections/calendar-connections.d.ts.map +1 -0
  173. package/resources/calendar-connections/calendar-connections.js +102 -0
  174. package/resources/calendar-connections/calendar-connections.js.map +1 -0
  175. package/resources/calendar-connections/calendar-connections.mjs +97 -0
  176. package/resources/calendar-connections/calendar-connections.mjs.map +1 -0
  177. package/resources/calendar-connections/index.d.mts +3 -0
  178. package/resources/calendar-connections/index.d.mts.map +1 -0
  179. package/resources/calendar-connections/index.d.ts +3 -0
  180. package/resources/calendar-connections/index.d.ts.map +1 -0
  181. package/resources/calendar-connections/index.js +9 -0
  182. package/resources/calendar-connections/index.js.map +1 -0
  183. package/resources/calendar-connections/index.mjs +4 -0
  184. package/resources/calendar-connections/index.mjs.map +1 -0
  185. package/resources/calendar-connections/meetings.d.mts +149 -0
  186. package/resources/calendar-connections/meetings.d.mts.map +1 -0
  187. package/resources/calendar-connections/meetings.d.ts +149 -0
  188. package/resources/calendar-connections/meetings.d.ts.map +1 -0
  189. package/resources/calendar-connections/meetings.js +47 -0
  190. package/resources/calendar-connections/meetings.js.map +1 -0
  191. package/resources/calendar-connections/meetings.mjs +43 -0
  192. package/resources/calendar-connections/meetings.mjs.map +1 -0
  193. package/resources/calendar-connections.d.mts +2 -0
  194. package/resources/calendar-connections.d.mts.map +1 -0
  195. package/resources/calendar-connections.d.ts +2 -0
  196. package/resources/calendar-connections.d.ts.map +1 -0
  197. package/resources/calendar-connections.js +6 -0
  198. package/resources/calendar-connections.js.map +1 -0
  199. package/resources/calendar-connections.mjs +3 -0
  200. package/resources/calendar-connections.mjs.map +1 -0
  201. package/resources/calls/actions.d.mts +11 -5
  202. package/resources/calls/actions.d.mts.map +1 -1
  203. package/resources/calls/actions.d.ts +11 -5
  204. package/resources/calls/actions.d.ts.map +1 -1
  205. package/resources/calls/calls.d.mts +4 -4
  206. package/resources/calls/calls.d.mts.map +1 -1
  207. package/resources/calls/calls.d.ts +4 -4
  208. package/resources/calls/calls.d.ts.map +1 -1
  209. package/resources/calls/calls.js.map +1 -1
  210. package/resources/calls/calls.mjs.map +1 -1
  211. package/resources/calls/index.d.mts +1 -1
  212. package/resources/calls/index.d.mts.map +1 -1
  213. package/resources/calls/index.d.ts +1 -1
  214. package/resources/calls/index.d.ts.map +1 -1
  215. package/resources/calls/index.js.map +1 -1
  216. package/resources/calls/index.mjs.map +1 -1
  217. package/resources/conferences/actions.d.mts +1 -1
  218. package/resources/conferences/actions.d.mts.map +1 -1
  219. package/resources/conferences/actions.d.ts +1 -1
  220. package/resources/conferences/actions.d.ts.map +1 -1
  221. package/resources/index.d.mts +6 -2
  222. package/resources/index.d.mts.map +1 -1
  223. package/resources/index.d.ts +6 -2
  224. package/resources/index.d.ts.map +1 -1
  225. package/resources/index.js +13 -4
  226. package/resources/index.js.map +1 -1
  227. package/resources/index.mjs +4 -0
  228. package/resources/index.mjs.map +1 -1
  229. package/resources/meeting-bot/calendar.d.mts +34 -0
  230. package/resources/meeting-bot/calendar.d.mts.map +1 -0
  231. package/resources/meeting-bot/calendar.d.ts +34 -0
  232. package/resources/meeting-bot/calendar.d.ts.map +1 -0
  233. package/resources/meeting-bot/calendar.js +26 -0
  234. package/resources/meeting-bot/calendar.js.map +1 -0
  235. package/resources/meeting-bot/calendar.mjs +22 -0
  236. package/resources/meeting-bot/calendar.mjs.map +1 -0
  237. package/resources/meeting-bot/index.d.mts +3 -0
  238. package/resources/meeting-bot/index.d.mts.map +1 -0
  239. package/resources/meeting-bot/index.d.ts +3 -0
  240. package/resources/meeting-bot/index.d.ts.map +1 -0
  241. package/resources/meeting-bot/index.js +9 -0
  242. package/resources/meeting-bot/index.js.map +1 -0
  243. package/resources/meeting-bot/index.mjs +4 -0
  244. package/resources/meeting-bot/index.mjs.map +1 -0
  245. package/resources/meeting-bot/meeting-bot.d.mts +10 -0
  246. package/resources/meeting-bot/meeting-bot.d.mts.map +1 -0
  247. package/resources/meeting-bot/meeting-bot.d.ts +10 -0
  248. package/resources/meeting-bot/meeting-bot.d.ts.map +1 -0
  249. package/resources/meeting-bot/meeting-bot.js +17 -0
  250. package/resources/meeting-bot/meeting-bot.js.map +1 -0
  251. package/resources/meeting-bot/meeting-bot.mjs +12 -0
  252. package/resources/meeting-bot/meeting-bot.mjs.map +1 -0
  253. package/resources/meeting-bot.d.mts +2 -0
  254. package/resources/meeting-bot.d.mts.map +1 -0
  255. package/resources/meeting-bot.d.ts +2 -0
  256. package/resources/meeting-bot.d.ts.map +1 -0
  257. package/resources/meeting-bot.js +6 -0
  258. package/resources/meeting-bot.js.map +1 -0
  259. package/resources/meeting-bot.mjs +3 -0
  260. package/resources/meeting-bot.mjs.map +1 -0
  261. package/resources/meeting-sessions/actions.d.mts +17 -11
  262. package/resources/meeting-sessions/actions.d.mts.map +1 -1
  263. package/resources/meeting-sessions/actions.d.ts +17 -11
  264. package/resources/meeting-sessions/actions.d.ts.map +1 -1
  265. package/resources/meeting-sessions/actions.js +14 -10
  266. package/resources/meeting-sessions/actions.js.map +1 -1
  267. package/resources/meeting-sessions/actions.mjs +14 -10
  268. package/resources/meeting-sessions/actions.mjs.map +1 -1
  269. package/resources/meeting-sessions/artifacts.d.mts +8 -7
  270. package/resources/meeting-sessions/artifacts.d.mts.map +1 -1
  271. package/resources/meeting-sessions/artifacts.d.ts +8 -7
  272. package/resources/meeting-sessions/artifacts.d.ts.map +1 -1
  273. package/resources/meeting-sessions/artifacts.js +8 -7
  274. package/resources/meeting-sessions/artifacts.js.map +1 -1
  275. package/resources/meeting-sessions/artifacts.mjs +8 -7
  276. package/resources/meeting-sessions/artifacts.mjs.map +1 -1
  277. package/resources/meeting-sessions/index.d.mts +1 -1
  278. package/resources/meeting-sessions/index.d.mts.map +1 -1
  279. package/resources/meeting-sessions/index.d.ts +1 -1
  280. package/resources/meeting-sessions/index.d.ts.map +1 -1
  281. package/resources/meeting-sessions/index.js.map +1 -1
  282. package/resources/meeting-sessions/index.mjs.map +1 -1
  283. package/resources/meeting-sessions/meeting-sessions.d.mts +281 -103
  284. package/resources/meeting-sessions/meeting-sessions.d.mts.map +1 -1
  285. package/resources/meeting-sessions/meeting-sessions.d.ts +281 -103
  286. package/resources/meeting-sessions/meeting-sessions.d.ts.map +1 -1
  287. package/resources/meeting-sessions/meeting-sessions.js +53 -21
  288. package/resources/meeting-sessions/meeting-sessions.js.map +1 -1
  289. package/resources/meeting-sessions/meeting-sessions.mjs +53 -21
  290. package/resources/meeting-sessions/meeting-sessions.mjs.map +1 -1
  291. package/resources/text-to-speech/text-to-speech.d.mts +45 -5
  292. package/resources/text-to-speech/text-to-speech.d.mts.map +1 -1
  293. package/resources/text-to-speech/text-to-speech.d.ts +45 -5
  294. package/resources/text-to-speech/text-to-speech.d.ts.map +1 -1
  295. package/resources/text-to-speech/text-to-speech.js +8 -2
  296. package/resources/text-to-speech/text-to-speech.js.map +1 -1
  297. package/resources/text-to-speech/text-to-speech.mjs +8 -2
  298. package/resources/text-to-speech/text-to-speech.mjs.map +1 -1
  299. package/resources/user-profile.d.mts +284 -0
  300. package/resources/user-profile.d.mts.map +1 -0
  301. package/resources/user-profile.d.ts +284 -0
  302. package/resources/user-profile.d.ts.map +1 -0
  303. package/resources/user-profile.js +42 -0
  304. package/resources/user-profile.js.map +1 -0
  305. package/resources/user-profile.mjs +38 -0
  306. package/resources/user-profile.mjs.map +1 -0
  307. package/resources/webhooks.d.mts +129 -3
  308. package/resources/webhooks.d.mts.map +1 -1
  309. package/resources/webhooks.d.ts +129 -3
  310. package/resources/webhooks.d.ts.map +1 -1
  311. package/src/client.ts +90 -0
  312. package/src/resources/agent-gateways/agent-gateways.ts +605 -0
  313. package/src/resources/agent-gateways/apis.ts +388 -0
  314. package/src/resources/agent-gateways/guardrails.ts +304 -0
  315. package/src/resources/agent-gateways/index.ts +87 -0
  316. package/src/resources/agent-gateways/keys/index.ts +20 -0
  317. package/src/resources/agent-gateways/keys/keys.ts +437 -0
  318. package/src/resources/agent-gateways/keys/tool-permissions.ts +139 -0
  319. package/src/resources/agent-gateways/keys.ts +3 -0
  320. package/src/resources/agent-gateways/mcp-servers.ts +328 -0
  321. package/src/resources/agent-gateways/policies.ts +348 -0
  322. package/src/resources/agent-gateways/policy-attachments.ts +167 -0
  323. package/src/resources/agent-gateways/teams/index.ts +16 -0
  324. package/src/resources/agent-gateways/teams/teams.ts +282 -0
  325. package/src/resources/agent-gateways/teams/tool-permissions.ts +112 -0
  326. package/src/resources/agent-gateways/teams.ts +3 -0
  327. package/src/resources/agent-gateways.ts +3 -0
  328. package/src/resources/ai/assistants/assistants.ts +24 -9
  329. package/src/resources/ai/memory/namespaces/index.ts +1 -0
  330. package/src/resources/ai/memory/namespaces/namespaces.ts +2 -0
  331. package/src/resources/ai/memory/namespaces/profiles/index.ts +1 -0
  332. package/src/resources/ai/memory/namespaces/profiles/profiles.ts +24 -1
  333. package/src/resources/calendar-connections/calendar-connections.ts +486 -0
  334. package/src/resources/calendar-connections/index.ts +21 -0
  335. package/src/resources/calendar-connections/meetings.ts +205 -0
  336. package/src/resources/calendar-connections.ts +3 -0
  337. package/src/resources/calls/actions.ts +16 -4
  338. package/src/resources/calls/calls.ts +6 -2
  339. package/src/resources/calls/index.ts +1 -0
  340. package/src/resources/conferences/actions.ts +2 -1
  341. package/src/resources/index.ts +36 -0
  342. package/src/resources/meeting-bot/calendar.ts +54 -0
  343. package/src/resources/meeting-bot/index.ts +8 -0
  344. package/src/resources/meeting-bot/meeting-bot.ts +23 -0
  345. package/src/resources/meeting-bot.ts +3 -0
  346. package/src/resources/meeting-sessions/actions.ts +17 -11
  347. package/src/resources/meeting-sessions/artifacts.ts +8 -7
  348. package/src/resources/meeting-sessions/index.ts +4 -0
  349. package/src/resources/meeting-sessions/meeting-sessions.ts +321 -102
  350. package/src/resources/text-to-speech/text-to-speech.ts +81 -5
  351. package/src/resources/user-profile.ts +357 -0
  352. package/src/resources/webhooks.ts +216 -0
  353. package/src/version.ts +1 -1
  354. package/version.d.mts +1 -1
  355. package/version.d.ts +1 -1
  356. package/version.js +1 -1
  357. package/version.mjs +1 -1
@@ -0,0 +1,266 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import { APIPromise } from "../../core/api-promise.mjs";
3
+ import { RequestOptions } from "../../internal/request-options.mjs";
4
+ /**
5
+ * Named sets of guardrails an instance applies to requests.
6
+ */
7
+ export declare class Policies extends APIResource {
8
+ /**
9
+ * Lists the instance's policies, each in its current version.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const policies = await client.agentGateways.policies.list(
14
+ * '32ce035d-3165-4031-b1a7-a7c0c259590a',
15
+ * );
16
+ * ```
17
+ */
18
+ list(instanceID: string, options?: RequestOptions): APIPromise<PolicyListResponse>;
19
+ /**
20
+ * Creates a named set of guardrails. It applies from the next request on, to the
21
+ * requests that name it in `policies` and to those its
22
+ * [attachments](https://developers.telnyx.com/api-reference/agent-gateway-policy-attachments/attach-a-policy)
23
+ * match.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const agentGatewayPolicyResponse =
28
+ * await client.agentGateways.policies.create(
29
+ * '32ce035d-3165-4031-b1a7-a7c0c259590a',
30
+ * {
31
+ * name: 'baseline',
32
+ * description: 'Mask personal data',
33
+ * guardrails: { add: ['mask-pii'] },
34
+ * },
35
+ * );
36
+ * ```
37
+ */
38
+ create(instanceID: string, body: PolicyCreateParams, options?: RequestOptions): APIPromise<AgentGatewayPolicyResponse>;
39
+ /**
40
+ * Deletes a policy and every version of it, and returns it as it was. A policy
41
+ * that an attachment names, or that another policy builds on, cannot be deleted.
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * const agentGatewayPolicyResponse =
46
+ * await client.agentGateways.policies.delete('strict', {
47
+ * instance_id: '32ce035d-3165-4031-b1a7-a7c0c259590a',
48
+ * });
49
+ * ```
50
+ */
51
+ delete(name: string, params: PolicyDeleteParams, options?: RequestOptions): APIPromise<AgentGatewayPolicyResponse>;
52
+ /**
53
+ * Returns one policy, in its current version.
54
+ *
55
+ * @example
56
+ * ```ts
57
+ * const agentGatewayPolicyResponse =
58
+ * await client.agentGateways.policies.retrieve('strict', {
59
+ * instance_id: '32ce035d-3165-4031-b1a7-a7c0c259590a',
60
+ * });
61
+ * ```
62
+ */
63
+ retrieve(name: string, params: PolicyRetrieveParams, options?: RequestOptions): APIPromise<AgentGatewayPolicyResponse>;
64
+ /**
65
+ * Changes a policy, which publishes a new version of it. A field left out stays as
66
+ * it is; `guardrails` and `pipeline` are replaced whole, and `model: null` removes
67
+ * the condition.
68
+ *
69
+ * @example
70
+ * ```ts
71
+ * const agentGatewayPolicyResponse =
72
+ * await client.agentGateways.policies.update('strict', {
73
+ * instance_id: '32ce035d-3165-4031-b1a7-a7c0c259590a',
74
+ * description: 'Baseline plus a word check',
75
+ * });
76
+ * ```
77
+ */
78
+ update(name: string, params: PolicyUpdateParams, options?: RequestOptions): APIPromise<AgentGatewayPolicyResponse>;
79
+ }
80
+ /**
81
+ * A named set of guardrails.
82
+ */
83
+ export interface AgentGatewayPolicy {
84
+ /**
85
+ * A policy this one builds on, by name. The policy starts with the base's
86
+ * guardrails.
87
+ */
88
+ base: string | null;
89
+ /**
90
+ * When the policy's current version was created. An update creates a new version.
91
+ */
92
+ created_at: string | null;
93
+ /**
94
+ * What the policy is for.
95
+ */
96
+ description: string | null;
97
+ /**
98
+ * The guardrails a policy adds to its base's, and the ones it removes from them,
99
+ * by name.
100
+ */
101
+ guardrails: AgentGatewayPolicyGuardrails;
102
+ /**
103
+ * A condition on the model, by name or regular expression. The policy's guardrails
104
+ * run only on requests for a matching model. `null` matches every model.
105
+ */
106
+ model: string | null;
107
+ /**
108
+ * A name, unique on the instance. A request names the policy in its `policies`
109
+ * field.
110
+ */
111
+ name: string;
112
+ /**
113
+ * Ordered steps that run in place of the policy's guardrails running
114
+ * independently.
115
+ */
116
+ pipeline: AgentGatewayPolicyPipeline | null;
117
+ /**
118
+ * When the policy last changed.
119
+ */
120
+ updated_at: string | null;
121
+ }
122
+ /**
123
+ * The guardrails a policy adds to its base's, and the ones it removes from them,
124
+ * by name.
125
+ */
126
+ export interface AgentGatewayPolicyGuardrails {
127
+ /**
128
+ * Guardrails the policy runs in addition to its base's.
129
+ */
130
+ add?: Array<string>;
131
+ /**
132
+ * Guardrails from its base that the policy does not run.
133
+ */
134
+ remove?: Array<string>;
135
+ }
136
+ /**
137
+ * Ordered steps that run in place of the policy's guardrails running
138
+ * independently.
139
+ */
140
+ export interface AgentGatewayPolicyPipeline {
141
+ /**
142
+ * `before_request` runs the steps on the request, and `after_request` on the
143
+ * model's response.
144
+ */
145
+ hook: 'before_request' | 'after_request';
146
+ steps: Array<AgentGatewayPolicyStep>;
147
+ }
148
+ export interface AgentGatewayPolicyResponse {
149
+ /**
150
+ * A named set of guardrails.
151
+ */
152
+ data: AgentGatewayPolicy;
153
+ }
154
+ /**
155
+ * One pipeline step: a guardrail, and what happens when it passes, fails, or
156
+ * errors.
157
+ */
158
+ export interface AgentGatewayPolicyStep {
159
+ /**
160
+ * A guardrail on the instance, by name.
161
+ */
162
+ guardrail: string;
163
+ /**
164
+ * The response that replaces the model's when an outcome is `respond`. Required
165
+ * with `respond`.
166
+ */
167
+ message?: string | null;
168
+ /**
169
+ * What happens when the guardrail errors. Left out, the same as `on_fail`.
170
+ */
171
+ on_error?: 'next' | 'allow' | 'block' | 'respond' | null;
172
+ /**
173
+ * What happens when the guardrail fails.
174
+ */
175
+ on_fail?: 'next' | 'allow' | 'block' | 'respond';
176
+ /**
177
+ * What happens when the guardrail passes. `next` goes on to the next step, `allow`
178
+ * allows the request, `block` blocks it, and `respond` answers with `message`.
179
+ */
180
+ on_pass?: 'next' | 'allow' | 'block' | 'respond';
181
+ /**
182
+ * `true` hands the step's modified request, such as masked text, to the next step.
183
+ */
184
+ pass_data?: boolean;
185
+ }
186
+ export interface PolicyListResponse {
187
+ data: Array<AgentGatewayPolicy>;
188
+ }
189
+ export interface PolicyCreateParams {
190
+ /**
191
+ * A name, unique on the instance. A request names the policy in its `policies`
192
+ * field.
193
+ */
194
+ name: string;
195
+ /**
196
+ * A policy this one builds on, by name. The policy starts with the base's
197
+ * guardrails.
198
+ */
199
+ base?: string | null;
200
+ /**
201
+ * What the policy is for.
202
+ */
203
+ description?: string | null;
204
+ /**
205
+ * The guardrails a policy adds to its base's, and the ones it removes from them,
206
+ * by name.
207
+ */
208
+ guardrails?: AgentGatewayPolicyGuardrails;
209
+ /**
210
+ * A condition on the model, by name or regular expression. The policy's guardrails
211
+ * run only on requests for a matching model. `null` matches every model.
212
+ */
213
+ model?: string | null;
214
+ /**
215
+ * Ordered steps that run in place of the policy's guardrails running
216
+ * independently.
217
+ */
218
+ pipeline?: AgentGatewayPolicyPipeline | null;
219
+ }
220
+ export interface PolicyDeleteParams {
221
+ /**
222
+ * The Agent Gateway's `id`.
223
+ */
224
+ instance_id: string;
225
+ }
226
+ export interface PolicyRetrieveParams {
227
+ /**
228
+ * The Agent Gateway's `id`.
229
+ */
230
+ instance_id: string;
231
+ }
232
+ export interface PolicyUpdateParams {
233
+ /**
234
+ * Path param: The Agent Gateway's `id`.
235
+ */
236
+ instance_id: string;
237
+ /**
238
+ * Body param: A policy this one builds on, by name. The policy starts with the
239
+ * base's guardrails.
240
+ */
241
+ base?: string | null;
242
+ /**
243
+ * Body param: What the policy is for.
244
+ */
245
+ description?: string | null;
246
+ /**
247
+ * Body param: The guardrails a policy adds to its base's, and the ones it removes
248
+ * from them, by name.
249
+ */
250
+ guardrails?: AgentGatewayPolicyGuardrails;
251
+ /**
252
+ * Body param: A condition on the model, by name or regular expression. The
253
+ * policy's guardrails run only on requests for a matching model. `null` matches
254
+ * every model.
255
+ */
256
+ model?: string | null;
257
+ /**
258
+ * Body param: Ordered steps that run in place of the policy's guardrails running
259
+ * independently.
260
+ */
261
+ pipeline?: AgentGatewayPolicyPipeline | null;
262
+ }
263
+ export declare namespace Policies {
264
+ export { type AgentGatewayPolicy as AgentGatewayPolicy, type AgentGatewayPolicyGuardrails as AgentGatewayPolicyGuardrails, type AgentGatewayPolicyPipeline as AgentGatewayPolicyPipeline, type AgentGatewayPolicyResponse as AgentGatewayPolicyResponse, type AgentGatewayPolicyStep as AgentGatewayPolicyStep, type PolicyListResponse as PolicyListResponse, type PolicyCreateParams as PolicyCreateParams, type PolicyDeleteParams as PolicyDeleteParams, type PolicyRetrieveParams as PolicyRetrieveParams, type PolicyUpdateParams as PolicyUpdateParams, };
265
+ }
266
+ //# sourceMappingURL=policies.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"policies.d.mts","sourceRoot":"","sources":["../../src/resources/agent-gateways/policies.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIlF;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAKzC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAKzC;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAI1C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,UAAU,EAAE,4BAA4B,CAAC;IAEzC;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,IAAI,EAAE,gBAAgB,GAAG,eAAe,CAAC;IAEzC,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC;IAEjD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC;IAEjD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,4BAA4B,CAAC;IAE1C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,4BAA4B,CAAC;IAE1C;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -0,0 +1,266 @@
1
+ import { APIResource } from "../../core/resource.js";
2
+ import { APIPromise } from "../../core/api-promise.js";
3
+ import { RequestOptions } from "../../internal/request-options.js";
4
+ /**
5
+ * Named sets of guardrails an instance applies to requests.
6
+ */
7
+ export declare class Policies extends APIResource {
8
+ /**
9
+ * Lists the instance's policies, each in its current version.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const policies = await client.agentGateways.policies.list(
14
+ * '32ce035d-3165-4031-b1a7-a7c0c259590a',
15
+ * );
16
+ * ```
17
+ */
18
+ list(instanceID: string, options?: RequestOptions): APIPromise<PolicyListResponse>;
19
+ /**
20
+ * Creates a named set of guardrails. It applies from the next request on, to the
21
+ * requests that name it in `policies` and to those its
22
+ * [attachments](https://developers.telnyx.com/api-reference/agent-gateway-policy-attachments/attach-a-policy)
23
+ * match.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const agentGatewayPolicyResponse =
28
+ * await client.agentGateways.policies.create(
29
+ * '32ce035d-3165-4031-b1a7-a7c0c259590a',
30
+ * {
31
+ * name: 'baseline',
32
+ * description: 'Mask personal data',
33
+ * guardrails: { add: ['mask-pii'] },
34
+ * },
35
+ * );
36
+ * ```
37
+ */
38
+ create(instanceID: string, body: PolicyCreateParams, options?: RequestOptions): APIPromise<AgentGatewayPolicyResponse>;
39
+ /**
40
+ * Deletes a policy and every version of it, and returns it as it was. A policy
41
+ * that an attachment names, or that another policy builds on, cannot be deleted.
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * const agentGatewayPolicyResponse =
46
+ * await client.agentGateways.policies.delete('strict', {
47
+ * instance_id: '32ce035d-3165-4031-b1a7-a7c0c259590a',
48
+ * });
49
+ * ```
50
+ */
51
+ delete(name: string, params: PolicyDeleteParams, options?: RequestOptions): APIPromise<AgentGatewayPolicyResponse>;
52
+ /**
53
+ * Returns one policy, in its current version.
54
+ *
55
+ * @example
56
+ * ```ts
57
+ * const agentGatewayPolicyResponse =
58
+ * await client.agentGateways.policies.retrieve('strict', {
59
+ * instance_id: '32ce035d-3165-4031-b1a7-a7c0c259590a',
60
+ * });
61
+ * ```
62
+ */
63
+ retrieve(name: string, params: PolicyRetrieveParams, options?: RequestOptions): APIPromise<AgentGatewayPolicyResponse>;
64
+ /**
65
+ * Changes a policy, which publishes a new version of it. A field left out stays as
66
+ * it is; `guardrails` and `pipeline` are replaced whole, and `model: null` removes
67
+ * the condition.
68
+ *
69
+ * @example
70
+ * ```ts
71
+ * const agentGatewayPolicyResponse =
72
+ * await client.agentGateways.policies.update('strict', {
73
+ * instance_id: '32ce035d-3165-4031-b1a7-a7c0c259590a',
74
+ * description: 'Baseline plus a word check',
75
+ * });
76
+ * ```
77
+ */
78
+ update(name: string, params: PolicyUpdateParams, options?: RequestOptions): APIPromise<AgentGatewayPolicyResponse>;
79
+ }
80
+ /**
81
+ * A named set of guardrails.
82
+ */
83
+ export interface AgentGatewayPolicy {
84
+ /**
85
+ * A policy this one builds on, by name. The policy starts with the base's
86
+ * guardrails.
87
+ */
88
+ base: string | null;
89
+ /**
90
+ * When the policy's current version was created. An update creates a new version.
91
+ */
92
+ created_at: string | null;
93
+ /**
94
+ * What the policy is for.
95
+ */
96
+ description: string | null;
97
+ /**
98
+ * The guardrails a policy adds to its base's, and the ones it removes from them,
99
+ * by name.
100
+ */
101
+ guardrails: AgentGatewayPolicyGuardrails;
102
+ /**
103
+ * A condition on the model, by name or regular expression. The policy's guardrails
104
+ * run only on requests for a matching model. `null` matches every model.
105
+ */
106
+ model: string | null;
107
+ /**
108
+ * A name, unique on the instance. A request names the policy in its `policies`
109
+ * field.
110
+ */
111
+ name: string;
112
+ /**
113
+ * Ordered steps that run in place of the policy's guardrails running
114
+ * independently.
115
+ */
116
+ pipeline: AgentGatewayPolicyPipeline | null;
117
+ /**
118
+ * When the policy last changed.
119
+ */
120
+ updated_at: string | null;
121
+ }
122
+ /**
123
+ * The guardrails a policy adds to its base's, and the ones it removes from them,
124
+ * by name.
125
+ */
126
+ export interface AgentGatewayPolicyGuardrails {
127
+ /**
128
+ * Guardrails the policy runs in addition to its base's.
129
+ */
130
+ add?: Array<string>;
131
+ /**
132
+ * Guardrails from its base that the policy does not run.
133
+ */
134
+ remove?: Array<string>;
135
+ }
136
+ /**
137
+ * Ordered steps that run in place of the policy's guardrails running
138
+ * independently.
139
+ */
140
+ export interface AgentGatewayPolicyPipeline {
141
+ /**
142
+ * `before_request` runs the steps on the request, and `after_request` on the
143
+ * model's response.
144
+ */
145
+ hook: 'before_request' | 'after_request';
146
+ steps: Array<AgentGatewayPolicyStep>;
147
+ }
148
+ export interface AgentGatewayPolicyResponse {
149
+ /**
150
+ * A named set of guardrails.
151
+ */
152
+ data: AgentGatewayPolicy;
153
+ }
154
+ /**
155
+ * One pipeline step: a guardrail, and what happens when it passes, fails, or
156
+ * errors.
157
+ */
158
+ export interface AgentGatewayPolicyStep {
159
+ /**
160
+ * A guardrail on the instance, by name.
161
+ */
162
+ guardrail: string;
163
+ /**
164
+ * The response that replaces the model's when an outcome is `respond`. Required
165
+ * with `respond`.
166
+ */
167
+ message?: string | null;
168
+ /**
169
+ * What happens when the guardrail errors. Left out, the same as `on_fail`.
170
+ */
171
+ on_error?: 'next' | 'allow' | 'block' | 'respond' | null;
172
+ /**
173
+ * What happens when the guardrail fails.
174
+ */
175
+ on_fail?: 'next' | 'allow' | 'block' | 'respond';
176
+ /**
177
+ * What happens when the guardrail passes. `next` goes on to the next step, `allow`
178
+ * allows the request, `block` blocks it, and `respond` answers with `message`.
179
+ */
180
+ on_pass?: 'next' | 'allow' | 'block' | 'respond';
181
+ /**
182
+ * `true` hands the step's modified request, such as masked text, to the next step.
183
+ */
184
+ pass_data?: boolean;
185
+ }
186
+ export interface PolicyListResponse {
187
+ data: Array<AgentGatewayPolicy>;
188
+ }
189
+ export interface PolicyCreateParams {
190
+ /**
191
+ * A name, unique on the instance. A request names the policy in its `policies`
192
+ * field.
193
+ */
194
+ name: string;
195
+ /**
196
+ * A policy this one builds on, by name. The policy starts with the base's
197
+ * guardrails.
198
+ */
199
+ base?: string | null;
200
+ /**
201
+ * What the policy is for.
202
+ */
203
+ description?: string | null;
204
+ /**
205
+ * The guardrails a policy adds to its base's, and the ones it removes from them,
206
+ * by name.
207
+ */
208
+ guardrails?: AgentGatewayPolicyGuardrails;
209
+ /**
210
+ * A condition on the model, by name or regular expression. The policy's guardrails
211
+ * run only on requests for a matching model. `null` matches every model.
212
+ */
213
+ model?: string | null;
214
+ /**
215
+ * Ordered steps that run in place of the policy's guardrails running
216
+ * independently.
217
+ */
218
+ pipeline?: AgentGatewayPolicyPipeline | null;
219
+ }
220
+ export interface PolicyDeleteParams {
221
+ /**
222
+ * The Agent Gateway's `id`.
223
+ */
224
+ instance_id: string;
225
+ }
226
+ export interface PolicyRetrieveParams {
227
+ /**
228
+ * The Agent Gateway's `id`.
229
+ */
230
+ instance_id: string;
231
+ }
232
+ export interface PolicyUpdateParams {
233
+ /**
234
+ * Path param: The Agent Gateway's `id`.
235
+ */
236
+ instance_id: string;
237
+ /**
238
+ * Body param: A policy this one builds on, by name. The policy starts with the
239
+ * base's guardrails.
240
+ */
241
+ base?: string | null;
242
+ /**
243
+ * Body param: What the policy is for.
244
+ */
245
+ description?: string | null;
246
+ /**
247
+ * Body param: The guardrails a policy adds to its base's, and the ones it removes
248
+ * from them, by name.
249
+ */
250
+ guardrails?: AgentGatewayPolicyGuardrails;
251
+ /**
252
+ * Body param: A condition on the model, by name or regular expression. The
253
+ * policy's guardrails run only on requests for a matching model. `null` matches
254
+ * every model.
255
+ */
256
+ model?: string | null;
257
+ /**
258
+ * Body param: Ordered steps that run in place of the policy's guardrails running
259
+ * independently.
260
+ */
261
+ pipeline?: AgentGatewayPolicyPipeline | null;
262
+ }
263
+ export declare namespace Policies {
264
+ export { type AgentGatewayPolicy as AgentGatewayPolicy, type AgentGatewayPolicyGuardrails as AgentGatewayPolicyGuardrails, type AgentGatewayPolicyPipeline as AgentGatewayPolicyPipeline, type AgentGatewayPolicyResponse as AgentGatewayPolicyResponse, type AgentGatewayPolicyStep as AgentGatewayPolicyStep, type PolicyListResponse as PolicyListResponse, type PolicyCreateParams as PolicyCreateParams, type PolicyDeleteParams as PolicyDeleteParams, type PolicyRetrieveParams as PolicyRetrieveParams, type PolicyUpdateParams as PolicyUpdateParams, };
265
+ }
266
+ //# sourceMappingURL=policies.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"policies.d.ts","sourceRoot":"","sources":["../../src/resources/agent-gateways/policies.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIlF;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAKzC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAKzC;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAI1C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,UAAU,EAAE,4BAA4B,CAAC;IAEzC;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,IAAI,EAAE,gBAAgB,GAAG,eAAe,CAAC;IAEzC,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC;IAEjD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC;IAEjD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,4BAA4B,CAAC;IAE1C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,4BAA4B,CAAC;IAE1C;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -0,0 +1,97 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.Policies = void 0;
5
+ const resource_1 = require("../../core/resource.js");
6
+ const path_1 = require("../../internal/utils/path.js");
7
+ /**
8
+ * Named sets of guardrails an instance applies to requests.
9
+ */
10
+ class Policies extends resource_1.APIResource {
11
+ /**
12
+ * Lists the instance's policies, each in its current version.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const policies = await client.agentGateways.policies.list(
17
+ * '32ce035d-3165-4031-b1a7-a7c0c259590a',
18
+ * );
19
+ * ```
20
+ */
21
+ list(instanceID, options) {
22
+ return this._client.get((0, path_1.path) `/agent_gateways/${instanceID}/policies`, options);
23
+ }
24
+ /**
25
+ * Creates a named set of guardrails. It applies from the next request on, to the
26
+ * requests that name it in `policies` and to those its
27
+ * [attachments](https://developers.telnyx.com/api-reference/agent-gateway-policy-attachments/attach-a-policy)
28
+ * match.
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * const agentGatewayPolicyResponse =
33
+ * await client.agentGateways.policies.create(
34
+ * '32ce035d-3165-4031-b1a7-a7c0c259590a',
35
+ * {
36
+ * name: 'baseline',
37
+ * description: 'Mask personal data',
38
+ * guardrails: { add: ['mask-pii'] },
39
+ * },
40
+ * );
41
+ * ```
42
+ */
43
+ create(instanceID, body, options) {
44
+ return this._client.post((0, path_1.path) `/agent_gateways/${instanceID}/policies`, { body, ...options });
45
+ }
46
+ /**
47
+ * Deletes a policy and every version of it, and returns it as it was. A policy
48
+ * that an attachment names, or that another policy builds on, cannot be deleted.
49
+ *
50
+ * @example
51
+ * ```ts
52
+ * const agentGatewayPolicyResponse =
53
+ * await client.agentGateways.policies.delete('strict', {
54
+ * instance_id: '32ce035d-3165-4031-b1a7-a7c0c259590a',
55
+ * });
56
+ * ```
57
+ */
58
+ delete(name, params, options) {
59
+ const { instance_id } = params;
60
+ return this._client.delete((0, path_1.path) `/agent_gateways/${instance_id}/policies/${name}`, options);
61
+ }
62
+ /**
63
+ * Returns one policy, in its current version.
64
+ *
65
+ * @example
66
+ * ```ts
67
+ * const agentGatewayPolicyResponse =
68
+ * await client.agentGateways.policies.retrieve('strict', {
69
+ * instance_id: '32ce035d-3165-4031-b1a7-a7c0c259590a',
70
+ * });
71
+ * ```
72
+ */
73
+ retrieve(name, params, options) {
74
+ const { instance_id } = params;
75
+ return this._client.get((0, path_1.path) `/agent_gateways/${instance_id}/policies/${name}`, options);
76
+ }
77
+ /**
78
+ * Changes a policy, which publishes a new version of it. A field left out stays as
79
+ * it is; `guardrails` and `pipeline` are replaced whole, and `model: null` removes
80
+ * the condition.
81
+ *
82
+ * @example
83
+ * ```ts
84
+ * const agentGatewayPolicyResponse =
85
+ * await client.agentGateways.policies.update('strict', {
86
+ * instance_id: '32ce035d-3165-4031-b1a7-a7c0c259590a',
87
+ * description: 'Baseline plus a word check',
88
+ * });
89
+ * ```
90
+ */
91
+ update(name, params, options) {
92
+ const { instance_id, ...body } = params;
93
+ return this._client.patch((0, path_1.path) `/agent_gateways/${instance_id}/policies/${name}`, { body, ...options });
94
+ }
95
+ }
96
+ exports.Policies = Policies;
97
+ //# sourceMappingURL=policies.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"policies.js","sourceRoot":"","sources":["../../src/resources/agent-gateways/policies.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;OASG;IACH,IAAI,CAAC,UAAkB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,UAAU,WAAW,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,mBAAmB,UAAU,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAY,EACZ,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,mBAAmB,WAAW,aAAa,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CACN,IAAY,EACZ,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,WAAW,aAAa,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,IAAY,EACZ,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,mBAAmB,WAAW,aAAa,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;CACF;AAzGD,4BAyGC"}