@deeprelay/sdk 0.2.0 → 0.3.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 (514) hide show
  1. package/.openapi-generator/FILES +66 -0
  2. package/README.md +47 -11
  3. package/dist/apis/AlertsApi.d.ts +50 -0
  4. package/dist/apis/AlertsApi.js +127 -0
  5. package/dist/apis/ApiKeysApi.d.ts +107 -0
  6. package/dist/apis/ApiKeysApi.js +284 -0
  7. package/dist/apis/BillingApi.d.ts +25 -7
  8. package/dist/apis/BillingApi.js +57 -7
  9. package/dist/apis/InferenceApi.d.ts +12 -1
  10. package/dist/apis/InferenceApi.js +22 -1
  11. package/dist/apis/MetaApi.d.ts +1 -1
  12. package/dist/apis/MetaApi.js +1 -1
  13. package/dist/apis/RequestsApi.d.ts +130 -0
  14. package/dist/apis/RequestsApi.js +269 -0
  15. package/dist/apis/UsageApi.d.ts +15 -1
  16. package/dist/apis/UsageApi.js +19 -2
  17. package/dist/apis/WebhooksApi.d.ts +1 -1
  18. package/dist/apis/WebhooksApi.js +1 -1
  19. package/dist/apis/index.d.ts +3 -0
  20. package/dist/apis/index.js +3 -0
  21. package/dist/esm/apis/AlertsApi.d.ts +50 -0
  22. package/dist/esm/apis/AlertsApi.js +123 -0
  23. package/dist/esm/apis/ApiKeysApi.d.ts +107 -0
  24. package/dist/esm/apis/ApiKeysApi.js +280 -0
  25. package/dist/esm/apis/BillingApi.d.ts +25 -7
  26. package/dist/esm/apis/BillingApi.js +57 -7
  27. package/dist/esm/apis/InferenceApi.d.ts +12 -1
  28. package/dist/esm/apis/InferenceApi.js +22 -1
  29. package/dist/esm/apis/MetaApi.d.ts +1 -1
  30. package/dist/esm/apis/MetaApi.js +1 -1
  31. package/dist/esm/apis/RequestsApi.d.ts +130 -0
  32. package/dist/esm/apis/RequestsApi.js +265 -0
  33. package/dist/esm/apis/UsageApi.d.ts +15 -1
  34. package/dist/esm/apis/UsageApi.js +18 -1
  35. package/dist/esm/apis/WebhooksApi.d.ts +1 -1
  36. package/dist/esm/apis/WebhooksApi.js +1 -1
  37. package/dist/esm/apis/index.d.ts +3 -0
  38. package/dist/esm/apis/index.js +3 -0
  39. package/dist/esm/models/AlertEmailToggles.d.ts +50 -0
  40. package/dist/esm/models/AlertEmailToggles.js +55 -0
  41. package/dist/esm/models/AlertSettings.d.ts +51 -0
  42. package/dist/esm/models/AlertSettings.js +56 -0
  43. package/dist/esm/models/AlertSettingsUpdate.d.ts +39 -0
  44. package/dist/esm/models/AlertSettingsUpdate.js +48 -0
  45. package/dist/esm/models/ApiKey.d.ts +123 -0
  46. package/dist/esm/models/ApiKey.js +96 -0
  47. package/dist/esm/models/ApiKeyCreate.d.ts +70 -0
  48. package/dist/esm/models/ApiKeyCreate.js +57 -0
  49. package/dist/esm/models/ApiKeyCreated.d.ts +129 -0
  50. package/dist/esm/models/ApiKeyCreated.js +100 -0
  51. package/dist/esm/models/ApiKeyList.d.ts +33 -0
  52. package/dist/esm/models/ApiKeyList.js +44 -0
  53. package/dist/esm/models/ApiKeyScopes.d.ts +65 -0
  54. package/dist/esm/models/ApiKeyScopes.js +66 -0
  55. package/dist/esm/models/ApiKeyUpdate.d.ts +62 -0
  56. package/dist/esm/models/ApiKeyUpdate.js +51 -0
  57. package/dist/esm/models/Balance.d.ts +1 -1
  58. package/dist/esm/models/Balance.js +1 -1
  59. package/dist/esm/models/ChatChoice.d.ts +11 -1
  60. package/dist/esm/models/ChatChoice.js +3 -1
  61. package/dist/esm/models/ChatCompletionRequest.d.ts +78 -2
  62. package/dist/esm/models/ChatCompletionRequest.js +26 -1
  63. package/dist/esm/models/ChatCompletionRequestResponseFormat.d.ts +31 -0
  64. package/dist/esm/models/ChatCompletionRequestResponseFormat.js +52 -0
  65. package/dist/esm/models/ChatCompletionRequestToolChoice.d.ts +23 -0
  66. package/dist/esm/models/ChatCompletionRequestToolChoice.js +50 -0
  67. package/dist/esm/models/ChatCompletionResponse.d.ts +1 -1
  68. package/dist/esm/models/ChatCompletionResponse.js +1 -1
  69. package/dist/esm/models/ChatMessage.d.ts +22 -2
  70. package/dist/esm/models/ChatMessage.js +10 -5
  71. package/dist/esm/models/CostDetails.d.ts +59 -0
  72. package/dist/esm/models/CostDetails.js +59 -0
  73. package/dist/esm/models/CreateCryptoDepositRequest.d.ts +4 -1
  74. package/dist/esm/models/CreateCryptoDepositRequest.js +4 -2
  75. package/dist/esm/models/CreateWebhookEndpointRequest.d.ts +5 -1
  76. package/dist/esm/models/CreateWebhookEndpointRequest.js +6 -2
  77. package/dist/esm/models/CryptoDeposit.d.ts +3 -1
  78. package/dist/esm/models/CryptoDeposit.js +4 -2
  79. package/dist/esm/models/Embedding.d.ts +1 -1
  80. package/dist/esm/models/Embedding.js +1 -1
  81. package/dist/esm/models/EmbeddingsRequest.d.ts +1 -1
  82. package/dist/esm/models/EmbeddingsRequest.js +1 -1
  83. package/dist/esm/models/EmbeddingsRequestInput.d.ts +1 -1
  84. package/dist/esm/models/EmbeddingsRequestInput.js +1 -1
  85. package/dist/esm/models/EmbeddingsResponse.d.ts +1 -1
  86. package/dist/esm/models/EmbeddingsResponse.js +1 -1
  87. package/dist/esm/models/EmbeddingsUsage.d.ts +1 -1
  88. package/dist/esm/models/EmbeddingsUsage.js +1 -1
  89. package/dist/esm/models/GetHealth200Response.d.ts +1 -1
  90. package/dist/esm/models/GetHealth200Response.js +1 -1
  91. package/dist/esm/models/ImagesGenerationsRequest.d.ts +2 -2
  92. package/dist/esm/models/ImagesGenerationsRequest.js +1 -1
  93. package/dist/esm/models/ImagesResponse.d.ts +1 -1
  94. package/dist/esm/models/ImagesResponse.js +1 -1
  95. package/dist/esm/models/ImagesResponseDataInner.d.ts +1 -1
  96. package/dist/esm/models/ImagesResponseDataInner.js +1 -1
  97. package/dist/esm/models/ImagesResponseUsage.d.ts +1 -1
  98. package/dist/esm/models/ImagesResponseUsage.js +1 -1
  99. package/dist/esm/models/InferencePreflight.d.ts +5 -2
  100. package/dist/esm/models/InferencePreflight.js +4 -1
  101. package/dist/esm/models/JSONSchemaFormat.d.ts +54 -0
  102. package/dist/esm/models/JSONSchemaFormat.js +49 -0
  103. package/dist/esm/models/ListDeposits200Response.d.ts +1 -1
  104. package/dist/esm/models/ListDeposits200Response.js +1 -1
  105. package/dist/esm/models/Model.d.ts +54 -5
  106. package/dist/esm/models/Model.js +21 -2
  107. package/dist/esm/models/ModelList.d.ts +1 -1
  108. package/dist/esm/models/ModelList.js +1 -1
  109. package/dist/esm/models/ModelMetrics.d.ts +101 -0
  110. package/dist/esm/models/ModelMetrics.js +85 -0
  111. package/dist/esm/models/ModelParametersInner.d.ts +1 -1
  112. package/dist/esm/models/ModelParametersInner.js +1 -1
  113. package/dist/esm/models/ModelPricing.d.ts +1 -1
  114. package/dist/esm/models/ModelPricing.js +1 -1
  115. package/dist/esm/models/ModelRate.d.ts +1 -1
  116. package/dist/esm/models/ModelRate.js +1 -1
  117. package/dist/esm/models/OpenAIErrorEnvelope.d.ts +1 -1
  118. package/dist/esm/models/OpenAIErrorEnvelope.js +1 -1
  119. package/dist/esm/models/OpenAIErrorEnvelopeError.d.ts +8 -2
  120. package/dist/esm/models/OpenAIErrorEnvelopeError.js +3 -1
  121. package/dist/esm/models/PeakWindow.d.ts +1 -1
  122. package/dist/esm/models/PeakWindow.js +1 -1
  123. package/dist/esm/models/Problem.d.ts +22 -1
  124. package/dist/esm/models/Problem.js +14 -1
  125. package/dist/esm/models/RefereeStatus.d.ts +1 -1
  126. package/dist/esm/models/RefereeStatus.js +1 -1
  127. package/dist/esm/models/Referral.d.ts +14 -2
  128. package/dist/esm/models/Referral.js +9 -1
  129. package/dist/esm/models/RequestLogEntry.d.ts +210 -0
  130. package/dist/esm/models/RequestLogEntry.js +129 -0
  131. package/dist/esm/models/RequestLogPage.d.ts +45 -0
  132. package/dist/esm/models/RequestLogPage.js +52 -0
  133. package/dist/esm/models/ResponseFormatJSONObject.d.ts +39 -0
  134. package/dist/esm/models/ResponseFormatJSONObject.js +51 -0
  135. package/dist/esm/models/ResponseFormatJSONSchema.d.ts +46 -0
  136. package/dist/esm/models/ResponseFormatJSONSchema.js +56 -0
  137. package/dist/esm/models/ResponseFormatText.d.ts +39 -0
  138. package/dist/esm/models/ResponseFormatText.js +51 -0
  139. package/dist/esm/models/SpendingLimit.d.ts +1 -1
  140. package/dist/esm/models/SpendingLimit.js +1 -1
  141. package/dist/esm/models/StreamOptions.d.ts +1 -1
  142. package/dist/esm/models/StreamOptions.js +1 -1
  143. package/dist/esm/models/Subscription.d.ts +9 -2
  144. package/dist/esm/models/Subscription.js +6 -1
  145. package/dist/esm/models/SubscriptionCheckoutRequest.d.ts +18 -4
  146. package/dist/esm/models/SubscriptionCheckoutRequest.js +10 -1
  147. package/dist/esm/models/SubscriptionCheckoutSession.d.ts +21 -1
  148. package/dist/esm/models/SubscriptionCheckoutSession.js +12 -1
  149. package/dist/esm/models/SubscriptionModelUsage.d.ts +68 -0
  150. package/dist/esm/models/SubscriptionModelUsage.js +67 -0
  151. package/dist/esm/models/SubscriptionPlan.d.ts +4 -4
  152. package/dist/esm/models/SubscriptionPlan.js +1 -1
  153. package/dist/esm/models/SubscriptionPortalRequest.d.ts +1 -1
  154. package/dist/esm/models/SubscriptionPortalRequest.js +1 -1
  155. package/dist/esm/models/SubscriptionPortalSession.d.ts +1 -1
  156. package/dist/esm/models/SubscriptionPortalSession.js +1 -1
  157. package/dist/esm/models/SubscriptionPrice.d.ts +1 -1
  158. package/dist/esm/models/SubscriptionPrice.js +1 -1
  159. package/dist/esm/models/SubscriptionQuota.d.ts +10 -4
  160. package/dist/esm/models/SubscriptionQuota.js +8 -4
  161. package/dist/esm/models/SubscriptionTier.d.ts +53 -0
  162. package/dist/esm/models/SubscriptionTier.js +55 -0
  163. package/dist/esm/models/SubscriptionUpgradeRequest.d.ts +32 -0
  164. package/dist/esm/models/SubscriptionUpgradeRequest.js +43 -0
  165. package/dist/esm/models/SubscriptionUsage.d.ts +28 -3
  166. package/dist/esm/models/SubscriptionUsage.js +15 -4
  167. package/dist/esm/models/Tool.d.ts +46 -0
  168. package/dist/esm/models/Tool.js +56 -0
  169. package/dist/esm/models/ToolCall.d.ts +60 -0
  170. package/dist/esm/models/ToolCall.js +56 -0
  171. package/dist/esm/models/ToolCallFunction.d.ts +39 -0
  172. package/dist/esm/models/ToolCallFunction.js +47 -0
  173. package/dist/esm/models/ToolChoiceFunction.d.ts +46 -0
  174. package/dist/esm/models/ToolChoiceFunction.js +56 -0
  175. package/dist/esm/models/ToolChoiceFunctionFunction.d.ts +32 -0
  176. package/dist/esm/models/ToolChoiceFunctionFunction.js +43 -0
  177. package/dist/esm/models/ToolFunction.d.ts +47 -0
  178. package/dist/esm/models/ToolFunction.js +47 -0
  179. package/dist/esm/models/UpdateSpendingLimitRequest.d.ts +1 -1
  180. package/dist/esm/models/UpdateSpendingLimitRequest.js +1 -1
  181. package/dist/esm/models/Usage.d.ts +29 -1
  182. package/dist/esm/models/Usage.js +12 -1
  183. package/dist/esm/models/UsageBucket.d.ts +39 -6
  184. package/dist/esm/models/UsageBucket.js +11 -1
  185. package/dist/esm/models/UsageCompletionTokensDetails.d.ts +32 -0
  186. package/dist/esm/models/UsageCompletionTokensDetails.js +41 -0
  187. package/dist/esm/models/UsagePage.d.ts +2 -1
  188. package/dist/esm/models/UsagePage.js +1 -1
  189. package/dist/esm/models/UsagePromptTokensDetails.d.ts +33 -0
  190. package/dist/esm/models/UsagePromptTokensDetails.js +41 -0
  191. package/dist/esm/models/VideoCreateRequest.d.ts +1 -1
  192. package/dist/esm/models/VideoCreateRequest.js +1 -1
  193. package/dist/esm/models/VideoJob.d.ts +1 -1
  194. package/dist/esm/models/VideoJob.js +1 -1
  195. package/dist/esm/models/VideoList.d.ts +1 -1
  196. package/dist/esm/models/VideoList.js +1 -1
  197. package/dist/esm/models/WebhookEndpoint.d.ts +5 -1
  198. package/dist/esm/models/WebhookEndpoint.js +6 -2
  199. package/dist/esm/models/WebhookEndpointPage.d.ts +1 -1
  200. package/dist/esm/models/WebhookEndpointPage.js +1 -1
  201. package/dist/esm/models/index.d.ts +30 -0
  202. package/dist/esm/models/index.js +30 -0
  203. package/dist/esm/runtime.d.ts +1 -1
  204. package/dist/esm/runtime.js +2 -2
  205. package/dist/models/AlertEmailToggles.d.ts +50 -0
  206. package/dist/models/AlertEmailToggles.js +62 -0
  207. package/dist/models/AlertSettings.d.ts +51 -0
  208. package/dist/models/AlertSettings.js +63 -0
  209. package/dist/models/AlertSettingsUpdate.d.ts +39 -0
  210. package/dist/models/AlertSettingsUpdate.js +55 -0
  211. package/dist/models/ApiKey.d.ts +123 -0
  212. package/dist/models/ApiKey.js +103 -0
  213. package/dist/models/ApiKeyCreate.d.ts +70 -0
  214. package/dist/models/ApiKeyCreate.js +64 -0
  215. package/dist/models/ApiKeyCreated.d.ts +129 -0
  216. package/dist/models/ApiKeyCreated.js +107 -0
  217. package/dist/models/ApiKeyList.d.ts +33 -0
  218. package/dist/models/ApiKeyList.js +51 -0
  219. package/dist/models/ApiKeyScopes.d.ts +65 -0
  220. package/dist/models/ApiKeyScopes.js +74 -0
  221. package/dist/models/ApiKeyUpdate.d.ts +62 -0
  222. package/dist/models/ApiKeyUpdate.js +58 -0
  223. package/dist/models/Balance.d.ts +1 -1
  224. package/dist/models/Balance.js +1 -1
  225. package/dist/models/ChatChoice.d.ts +11 -1
  226. package/dist/models/ChatChoice.js +3 -1
  227. package/dist/models/ChatCompletionRequest.d.ts +78 -2
  228. package/dist/models/ChatCompletionRequest.js +26 -1
  229. package/dist/models/ChatCompletionRequestResponseFormat.d.ts +31 -0
  230. package/dist/models/ChatCompletionRequestResponseFormat.js +58 -0
  231. package/dist/models/ChatCompletionRequestToolChoice.d.ts +23 -0
  232. package/dist/models/ChatCompletionRequestToolChoice.js +56 -0
  233. package/dist/models/ChatCompletionResponse.d.ts +1 -1
  234. package/dist/models/ChatCompletionResponse.js +1 -1
  235. package/dist/models/ChatMessage.d.ts +22 -2
  236. package/dist/models/ChatMessage.js +10 -5
  237. package/dist/models/CostDetails.d.ts +59 -0
  238. package/dist/models/CostDetails.js +66 -0
  239. package/dist/models/CreateCryptoDepositRequest.d.ts +4 -1
  240. package/dist/models/CreateCryptoDepositRequest.js +4 -2
  241. package/dist/models/CreateWebhookEndpointRequest.d.ts +5 -1
  242. package/dist/models/CreateWebhookEndpointRequest.js +6 -2
  243. package/dist/models/CryptoDeposit.d.ts +3 -1
  244. package/dist/models/CryptoDeposit.js +4 -2
  245. package/dist/models/Embedding.d.ts +1 -1
  246. package/dist/models/Embedding.js +1 -1
  247. package/dist/models/EmbeddingsRequest.d.ts +1 -1
  248. package/dist/models/EmbeddingsRequest.js +1 -1
  249. package/dist/models/EmbeddingsRequestInput.d.ts +1 -1
  250. package/dist/models/EmbeddingsRequestInput.js +1 -1
  251. package/dist/models/EmbeddingsResponse.d.ts +1 -1
  252. package/dist/models/EmbeddingsResponse.js +1 -1
  253. package/dist/models/EmbeddingsUsage.d.ts +1 -1
  254. package/dist/models/EmbeddingsUsage.js +1 -1
  255. package/dist/models/GetHealth200Response.d.ts +1 -1
  256. package/dist/models/GetHealth200Response.js +1 -1
  257. package/dist/models/ImagesGenerationsRequest.d.ts +2 -2
  258. package/dist/models/ImagesGenerationsRequest.js +1 -1
  259. package/dist/models/ImagesResponse.d.ts +1 -1
  260. package/dist/models/ImagesResponse.js +1 -1
  261. package/dist/models/ImagesResponseDataInner.d.ts +1 -1
  262. package/dist/models/ImagesResponseDataInner.js +1 -1
  263. package/dist/models/ImagesResponseUsage.d.ts +1 -1
  264. package/dist/models/ImagesResponseUsage.js +1 -1
  265. package/dist/models/InferencePreflight.d.ts +5 -2
  266. package/dist/models/InferencePreflight.js +4 -1
  267. package/dist/models/JSONSchemaFormat.d.ts +54 -0
  268. package/dist/models/JSONSchemaFormat.js +56 -0
  269. package/dist/models/ListDeposits200Response.d.ts +1 -1
  270. package/dist/models/ListDeposits200Response.js +1 -1
  271. package/dist/models/Model.d.ts +54 -5
  272. package/dist/models/Model.js +21 -2
  273. package/dist/models/ModelList.d.ts +1 -1
  274. package/dist/models/ModelList.js +1 -1
  275. package/dist/models/ModelMetrics.d.ts +101 -0
  276. package/dist/models/ModelMetrics.js +93 -0
  277. package/dist/models/ModelParametersInner.d.ts +1 -1
  278. package/dist/models/ModelParametersInner.js +1 -1
  279. package/dist/models/ModelPricing.d.ts +1 -1
  280. package/dist/models/ModelPricing.js +1 -1
  281. package/dist/models/ModelRate.d.ts +1 -1
  282. package/dist/models/ModelRate.js +1 -1
  283. package/dist/models/OpenAIErrorEnvelope.d.ts +1 -1
  284. package/dist/models/OpenAIErrorEnvelope.js +1 -1
  285. package/dist/models/OpenAIErrorEnvelopeError.d.ts +8 -2
  286. package/dist/models/OpenAIErrorEnvelopeError.js +3 -1
  287. package/dist/models/PeakWindow.d.ts +1 -1
  288. package/dist/models/PeakWindow.js +1 -1
  289. package/dist/models/Problem.d.ts +22 -1
  290. package/dist/models/Problem.js +14 -1
  291. package/dist/models/RefereeStatus.d.ts +1 -1
  292. package/dist/models/RefereeStatus.js +1 -1
  293. package/dist/models/Referral.d.ts +14 -2
  294. package/dist/models/Referral.js +9 -1
  295. package/dist/models/RequestLogEntry.d.ts +210 -0
  296. package/dist/models/RequestLogEntry.js +137 -0
  297. package/dist/models/RequestLogPage.d.ts +45 -0
  298. package/dist/models/RequestLogPage.js +59 -0
  299. package/dist/models/ResponseFormatJSONObject.d.ts +39 -0
  300. package/dist/models/ResponseFormatJSONObject.js +59 -0
  301. package/dist/models/ResponseFormatJSONSchema.d.ts +46 -0
  302. package/dist/models/ResponseFormatJSONSchema.js +64 -0
  303. package/dist/models/ResponseFormatText.d.ts +39 -0
  304. package/dist/models/ResponseFormatText.js +59 -0
  305. package/dist/models/SpendingLimit.d.ts +1 -1
  306. package/dist/models/SpendingLimit.js +1 -1
  307. package/dist/models/StreamOptions.d.ts +1 -1
  308. package/dist/models/StreamOptions.js +1 -1
  309. package/dist/models/Subscription.d.ts +9 -2
  310. package/dist/models/Subscription.js +6 -1
  311. package/dist/models/SubscriptionCheckoutRequest.d.ts +18 -4
  312. package/dist/models/SubscriptionCheckoutRequest.js +11 -1
  313. package/dist/models/SubscriptionCheckoutSession.d.ts +21 -1
  314. package/dist/models/SubscriptionCheckoutSession.js +13 -1
  315. package/dist/models/SubscriptionModelUsage.d.ts +68 -0
  316. package/dist/models/SubscriptionModelUsage.js +74 -0
  317. package/dist/models/SubscriptionPlan.d.ts +4 -4
  318. package/dist/models/SubscriptionPlan.js +1 -1
  319. package/dist/models/SubscriptionPortalRequest.d.ts +1 -1
  320. package/dist/models/SubscriptionPortalRequest.js +1 -1
  321. package/dist/models/SubscriptionPortalSession.d.ts +1 -1
  322. package/dist/models/SubscriptionPortalSession.js +1 -1
  323. package/dist/models/SubscriptionPrice.d.ts +1 -1
  324. package/dist/models/SubscriptionPrice.js +1 -1
  325. package/dist/models/SubscriptionQuota.d.ts +10 -4
  326. package/dist/models/SubscriptionQuota.js +8 -4
  327. package/dist/models/SubscriptionTier.d.ts +53 -0
  328. package/dist/models/SubscriptionTier.js +62 -0
  329. package/dist/models/SubscriptionUpgradeRequest.d.ts +32 -0
  330. package/dist/models/SubscriptionUpgradeRequest.js +50 -0
  331. package/dist/models/SubscriptionUsage.d.ts +28 -3
  332. package/dist/models/SubscriptionUsage.js +15 -4
  333. package/dist/models/Tool.d.ts +46 -0
  334. package/dist/models/Tool.js +64 -0
  335. package/dist/models/ToolCall.d.ts +60 -0
  336. package/dist/models/ToolCall.js +64 -0
  337. package/dist/models/ToolCallFunction.d.ts +39 -0
  338. package/dist/models/ToolCallFunction.js +54 -0
  339. package/dist/models/ToolChoiceFunction.d.ts +46 -0
  340. package/dist/models/ToolChoiceFunction.js +64 -0
  341. package/dist/models/ToolChoiceFunctionFunction.d.ts +32 -0
  342. package/dist/models/ToolChoiceFunctionFunction.js +50 -0
  343. package/dist/models/ToolFunction.d.ts +47 -0
  344. package/dist/models/ToolFunction.js +54 -0
  345. package/dist/models/UpdateSpendingLimitRequest.d.ts +1 -1
  346. package/dist/models/UpdateSpendingLimitRequest.js +1 -1
  347. package/dist/models/Usage.d.ts +29 -1
  348. package/dist/models/Usage.js +12 -1
  349. package/dist/models/UsageBucket.d.ts +39 -6
  350. package/dist/models/UsageBucket.js +11 -1
  351. package/dist/models/UsageCompletionTokensDetails.d.ts +32 -0
  352. package/dist/models/UsageCompletionTokensDetails.js +48 -0
  353. package/dist/models/UsagePage.d.ts +2 -1
  354. package/dist/models/UsagePage.js +1 -1
  355. package/dist/models/UsagePromptTokensDetails.d.ts +33 -0
  356. package/dist/models/UsagePromptTokensDetails.js +48 -0
  357. package/dist/models/VideoCreateRequest.d.ts +1 -1
  358. package/dist/models/VideoCreateRequest.js +1 -1
  359. package/dist/models/VideoJob.d.ts +1 -1
  360. package/dist/models/VideoJob.js +1 -1
  361. package/dist/models/VideoList.d.ts +1 -1
  362. package/dist/models/VideoList.js +1 -1
  363. package/dist/models/WebhookEndpoint.d.ts +5 -1
  364. package/dist/models/WebhookEndpoint.js +6 -2
  365. package/dist/models/WebhookEndpointPage.d.ts +1 -1
  366. package/dist/models/WebhookEndpointPage.js +1 -1
  367. package/dist/models/index.d.ts +30 -0
  368. package/dist/models/index.js +30 -0
  369. package/dist/runtime.d.ts +1 -1
  370. package/dist/runtime.js +2 -2
  371. package/docs/AlertEmailToggles.md +40 -0
  372. package/docs/AlertSettings.md +40 -0
  373. package/docs/AlertSettingsUpdate.md +36 -0
  374. package/docs/AlertsApi.md +151 -0
  375. package/docs/ApiKey.md +65 -0
  376. package/docs/ApiKeyCreate.md +46 -0
  377. package/docs/ApiKeyCreated.md +67 -0
  378. package/docs/ApiKeyList.md +34 -0
  379. package/docs/ApiKeyScopes.md +38 -0
  380. package/docs/ApiKeyUpdate.md +45 -0
  381. package/docs/ApiKeysApi.md +389 -0
  382. package/docs/BillingApi.md +83 -3
  383. package/docs/ChatChoice.md +2 -0
  384. package/docs/ChatCompletionRequest.md +22 -0
  385. package/docs/ChatCompletionRequestResponseFormat.md +37 -0
  386. package/docs/ChatCompletionRequestToolChoice.md +37 -0
  387. package/docs/ChatMessage.md +4 -0
  388. package/docs/CostDetails.md +43 -0
  389. package/docs/InferenceApi.md +94 -71
  390. package/docs/JSONSchemaFormat.md +41 -0
  391. package/docs/Model.md +16 -0
  392. package/docs/ModelMetrics.md +55 -0
  393. package/docs/OpenAIErrorEnvelopeError.md +2 -0
  394. package/docs/Problem.md +4 -0
  395. package/docs/Referral.md +6 -2
  396. package/docs/RequestLogEntry.md +87 -0
  397. package/docs/RequestLogPage.md +38 -0
  398. package/docs/RequestsApi.md +282 -0
  399. package/docs/ResponseFormatJSONObject.md +35 -0
  400. package/docs/ResponseFormatJSONSchema.md +36 -0
  401. package/docs/ResponseFormatText.md +34 -0
  402. package/docs/Subscription.md +3 -1
  403. package/docs/SubscriptionCheckoutRequest.md +2 -0
  404. package/docs/SubscriptionCheckoutSession.md +4 -0
  405. package/docs/SubscriptionModelUsage.md +47 -0
  406. package/docs/SubscriptionPlan.md +1 -1
  407. package/docs/SubscriptionQuota.md +5 -3
  408. package/docs/SubscriptionTier.md +41 -0
  409. package/docs/SubscriptionUpgradeRequest.md +34 -0
  410. package/docs/SubscriptionUsage.md +10 -2
  411. package/docs/Tool.md +36 -0
  412. package/docs/ToolCall.md +41 -0
  413. package/docs/ToolCallFunction.md +36 -0
  414. package/docs/ToolChoiceFunction.md +36 -0
  415. package/docs/ToolChoiceFunctionFunction.md +34 -0
  416. package/docs/ToolFunction.md +38 -0
  417. package/docs/Usage.md +8 -0
  418. package/docs/UsageApi.md +17 -9
  419. package/docs/UsageBucket.md +11 -0
  420. package/docs/UsageCompletionTokensDetails.md +34 -0
  421. package/docs/UsagePromptTokensDetails.md +35 -0
  422. package/package.json +1 -1
  423. package/src/apis/AlertsApi.ts +145 -0
  424. package/src/apis/ApiKeysApi.ts +357 -0
  425. package/src/apis/BillingApi.ts +73 -7
  426. package/src/apis/InferenceApi.ts +32 -1
  427. package/src/apis/MetaApi.ts +1 -1
  428. package/src/apis/RequestsApi.ts +335 -0
  429. package/src/apis/UsageApi.ts +23 -1
  430. package/src/apis/WebhooksApi.ts +1 -1
  431. package/src/apis/index.ts +3 -0
  432. package/src/models/AlertEmailToggles.ts +93 -0
  433. package/src/models/AlertSettings.ts +101 -0
  434. package/src/models/AlertSettingsUpdate.ts +83 -0
  435. package/src/models/ApiKey.ts +205 -0
  436. package/src/models/ApiKeyCreate.ts +115 -0
  437. package/src/models/ApiKeyCreated.ts +214 -0
  438. package/src/models/ApiKeyList.ts +74 -0
  439. package/src/models/ApiKeyScopes.ts +106 -0
  440. package/src/models/ApiKeyUpdate.ts +105 -0
  441. package/src/models/Balance.ts +1 -1
  442. package/src/models/ChatChoice.ts +11 -1
  443. package/src/models/ChatCompletionRequest.ts +118 -2
  444. package/src/models/ChatCompletionRequestResponseFormat.ts +84 -0
  445. package/src/models/ChatCompletionRequestToolChoice.ts +70 -0
  446. package/src/models/ChatCompletionResponse.ts +1 -1
  447. package/src/models/ChatMessage.ts +35 -5
  448. package/src/models/CostDetails.ts +105 -0
  449. package/src/models/CreateCryptoDepositRequest.ts +5 -2
  450. package/src/models/CreateWebhookEndpointRequest.ts +6 -2
  451. package/src/models/CryptoDeposit.ts +4 -2
  452. package/src/models/Embedding.ts +1 -1
  453. package/src/models/EmbeddingsRequest.ts +1 -1
  454. package/src/models/EmbeddingsRequestInput.ts +1 -1
  455. package/src/models/EmbeddingsResponse.ts +1 -1
  456. package/src/models/EmbeddingsUsage.ts +1 -1
  457. package/src/models/GetHealth200Response.ts +1 -1
  458. package/src/models/ImagesGenerationsRequest.ts +2 -2
  459. package/src/models/ImagesResponse.ts +1 -1
  460. package/src/models/ImagesResponseDataInner.ts +1 -1
  461. package/src/models/ImagesResponseUsage.ts +1 -1
  462. package/src/models/InferencePreflight.ts +5 -2
  463. package/src/models/JSONSchemaFormat.ts +92 -0
  464. package/src/models/ListDeposits200Response.ts +1 -1
  465. package/src/models/Model.ts +78 -6
  466. package/src/models/ModelList.ts +1 -1
  467. package/src/models/ModelMetrics.ts +165 -0
  468. package/src/models/ModelParametersInner.ts +1 -1
  469. package/src/models/ModelPricing.ts +1 -1
  470. package/src/models/ModelRate.ts +1 -1
  471. package/src/models/OpenAIErrorEnvelope.ts +1 -1
  472. package/src/models/OpenAIErrorEnvelopeError.ts +10 -2
  473. package/src/models/PeakWindow.ts +1 -1
  474. package/src/models/Problem.ts +26 -1
  475. package/src/models/RefereeStatus.ts +1 -1
  476. package/src/models/Referral.ts +20 -2
  477. package/src/models/RequestLogEntry.ts +307 -0
  478. package/src/models/RequestLogPage.ts +92 -0
  479. package/src/models/ResponseFormatJSONObject.ts +78 -0
  480. package/src/models/ResponseFormatJSONSchema.ts +95 -0
  481. package/src/models/ResponseFormatText.ts +78 -0
  482. package/src/models/SpendingLimit.ts +1 -1
  483. package/src/models/StreamOptions.ts +1 -1
  484. package/src/models/Subscription.ts +18 -2
  485. package/src/models/SubscriptionCheckoutRequest.ts +23 -4
  486. package/src/models/SubscriptionCheckoutSession.ts +28 -1
  487. package/src/models/SubscriptionModelUsage.ts +120 -0
  488. package/src/models/SubscriptionPlan.ts +4 -4
  489. package/src/models/SubscriptionPortalRequest.ts +1 -1
  490. package/src/models/SubscriptionPortalSession.ts +1 -1
  491. package/src/models/SubscriptionPrice.ts +1 -1
  492. package/src/models/SubscriptionQuota.ts +16 -7
  493. package/src/models/SubscriptionTier.ts +108 -0
  494. package/src/models/SubscriptionUpgradeRequest.ts +66 -0
  495. package/src/models/SubscriptionUsage.ts +47 -6
  496. package/src/models/Tool.ts +95 -0
  497. package/src/models/ToolCall.ts +110 -0
  498. package/src/models/ToolCallFunction.ts +76 -0
  499. package/src/models/ToolChoiceFunction.ts +95 -0
  500. package/src/models/ToolChoiceFunctionFunction.ts +66 -0
  501. package/src/models/ToolFunction.ts +83 -0
  502. package/src/models/UpdateSpendingLimitRequest.ts +1 -1
  503. package/src/models/Usage.ts +56 -1
  504. package/src/models/UsageBucket.ts +49 -6
  505. package/src/models/UsageCompletionTokensDetails.ts +65 -0
  506. package/src/models/UsagePage.ts +2 -1
  507. package/src/models/UsagePromptTokensDetails.ts +66 -0
  508. package/src/models/VideoCreateRequest.ts +1 -1
  509. package/src/models/VideoJob.ts +1 -1
  510. package/src/models/VideoList.ts +1 -1
  511. package/src/models/WebhookEndpoint.ts +6 -2
  512. package/src/models/WebhookEndpointPage.ts +1 -1
  513. package/src/models/index.ts +30 -0
  514. package/src/runtime.ts +2 -2
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * deeprelay Public Developer API
3
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
3
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store. Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API. OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@deeprelay.ai
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * deeprelay Public Developer API
6
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
6
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store. Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API. OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@deeprelay.ai
@@ -1,8 +1,20 @@
1
+ export * from './AlertEmailToggles';
2
+ export * from './AlertSettings';
3
+ export * from './AlertSettingsUpdate';
4
+ export * from './ApiKey';
5
+ export * from './ApiKeyCreate';
6
+ export * from './ApiKeyCreated';
7
+ export * from './ApiKeyList';
8
+ export * from './ApiKeyScopes';
9
+ export * from './ApiKeyUpdate';
1
10
  export * from './Balance';
2
11
  export * from './ChatChoice';
3
12
  export * from './ChatCompletionRequest';
13
+ export * from './ChatCompletionRequestResponseFormat';
14
+ export * from './ChatCompletionRequestToolChoice';
4
15
  export * from './ChatCompletionResponse';
5
16
  export * from './ChatMessage';
17
+ export * from './CostDetails';
6
18
  export * from './CreateCryptoDepositRequest';
7
19
  export * from './CreateWebhookEndpointRequest';
8
20
  export * from './CryptoDeposit';
@@ -17,9 +29,11 @@ export * from './ImagesResponse';
17
29
  export * from './ImagesResponseDataInner';
18
30
  export * from './ImagesResponseUsage';
19
31
  export * from './InferencePreflight';
32
+ export * from './JSONSchemaFormat';
20
33
  export * from './ListDeposits200Response';
21
34
  export * from './Model';
22
35
  export * from './ModelList';
36
+ export * from './ModelMetrics';
23
37
  export * from './ModelParametersInner';
24
38
  export * from './ModelPricing';
25
39
  export * from './ModelRate';
@@ -29,21 +43,37 @@ export * from './PeakWindow';
29
43
  export * from './Problem';
30
44
  export * from './RefereeStatus';
31
45
  export * from './Referral';
46
+ export * from './RequestLogEntry';
47
+ export * from './RequestLogPage';
48
+ export * from './ResponseFormatJSONObject';
49
+ export * from './ResponseFormatJSONSchema';
50
+ export * from './ResponseFormatText';
32
51
  export * from './SpendingLimit';
33
52
  export * from './StreamOptions';
34
53
  export * from './Subscription';
35
54
  export * from './SubscriptionCheckoutRequest';
36
55
  export * from './SubscriptionCheckoutSession';
56
+ export * from './SubscriptionModelUsage';
37
57
  export * from './SubscriptionPlan';
38
58
  export * from './SubscriptionPortalRequest';
39
59
  export * from './SubscriptionPortalSession';
40
60
  export * from './SubscriptionPrice';
41
61
  export * from './SubscriptionQuota';
62
+ export * from './SubscriptionTier';
63
+ export * from './SubscriptionUpgradeRequest';
42
64
  export * from './SubscriptionUsage';
65
+ export * from './Tool';
66
+ export * from './ToolCall';
67
+ export * from './ToolCallFunction';
68
+ export * from './ToolChoiceFunction';
69
+ export * from './ToolChoiceFunctionFunction';
70
+ export * from './ToolFunction';
43
71
  export * from './UpdateSpendingLimitRequest';
44
72
  export * from './Usage';
45
73
  export * from './UsageBucket';
74
+ export * from './UsageCompletionTokensDetails';
46
75
  export * from './UsagePage';
76
+ export * from './UsagePromptTokensDetails';
47
77
  export * from './VideoCreateRequest';
48
78
  export * from './VideoJob';
49
79
  export * from './VideoList';
@@ -16,11 +16,23 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  /* tslint:disable */
18
18
  /* eslint-disable */
19
+ __exportStar(require("./AlertEmailToggles"), exports);
20
+ __exportStar(require("./AlertSettings"), exports);
21
+ __exportStar(require("./AlertSettingsUpdate"), exports);
22
+ __exportStar(require("./ApiKey"), exports);
23
+ __exportStar(require("./ApiKeyCreate"), exports);
24
+ __exportStar(require("./ApiKeyCreated"), exports);
25
+ __exportStar(require("./ApiKeyList"), exports);
26
+ __exportStar(require("./ApiKeyScopes"), exports);
27
+ __exportStar(require("./ApiKeyUpdate"), exports);
19
28
  __exportStar(require("./Balance"), exports);
20
29
  __exportStar(require("./ChatChoice"), exports);
21
30
  __exportStar(require("./ChatCompletionRequest"), exports);
31
+ __exportStar(require("./ChatCompletionRequestResponseFormat"), exports);
32
+ __exportStar(require("./ChatCompletionRequestToolChoice"), exports);
22
33
  __exportStar(require("./ChatCompletionResponse"), exports);
23
34
  __exportStar(require("./ChatMessage"), exports);
35
+ __exportStar(require("./CostDetails"), exports);
24
36
  __exportStar(require("./CreateCryptoDepositRequest"), exports);
25
37
  __exportStar(require("./CreateWebhookEndpointRequest"), exports);
26
38
  __exportStar(require("./CryptoDeposit"), exports);
@@ -35,9 +47,11 @@ __exportStar(require("./ImagesResponse"), exports);
35
47
  __exportStar(require("./ImagesResponseDataInner"), exports);
36
48
  __exportStar(require("./ImagesResponseUsage"), exports);
37
49
  __exportStar(require("./InferencePreflight"), exports);
50
+ __exportStar(require("./JSONSchemaFormat"), exports);
38
51
  __exportStar(require("./ListDeposits200Response"), exports);
39
52
  __exportStar(require("./Model"), exports);
40
53
  __exportStar(require("./ModelList"), exports);
54
+ __exportStar(require("./ModelMetrics"), exports);
41
55
  __exportStar(require("./ModelParametersInner"), exports);
42
56
  __exportStar(require("./ModelPricing"), exports);
43
57
  __exportStar(require("./ModelRate"), exports);
@@ -47,21 +61,37 @@ __exportStar(require("./PeakWindow"), exports);
47
61
  __exportStar(require("./Problem"), exports);
48
62
  __exportStar(require("./RefereeStatus"), exports);
49
63
  __exportStar(require("./Referral"), exports);
64
+ __exportStar(require("./RequestLogEntry"), exports);
65
+ __exportStar(require("./RequestLogPage"), exports);
66
+ __exportStar(require("./ResponseFormatJSONObject"), exports);
67
+ __exportStar(require("./ResponseFormatJSONSchema"), exports);
68
+ __exportStar(require("./ResponseFormatText"), exports);
50
69
  __exportStar(require("./SpendingLimit"), exports);
51
70
  __exportStar(require("./StreamOptions"), exports);
52
71
  __exportStar(require("./Subscription"), exports);
53
72
  __exportStar(require("./SubscriptionCheckoutRequest"), exports);
54
73
  __exportStar(require("./SubscriptionCheckoutSession"), exports);
74
+ __exportStar(require("./SubscriptionModelUsage"), exports);
55
75
  __exportStar(require("./SubscriptionPlan"), exports);
56
76
  __exportStar(require("./SubscriptionPortalRequest"), exports);
57
77
  __exportStar(require("./SubscriptionPortalSession"), exports);
58
78
  __exportStar(require("./SubscriptionPrice"), exports);
59
79
  __exportStar(require("./SubscriptionQuota"), exports);
80
+ __exportStar(require("./SubscriptionTier"), exports);
81
+ __exportStar(require("./SubscriptionUpgradeRequest"), exports);
60
82
  __exportStar(require("./SubscriptionUsage"), exports);
83
+ __exportStar(require("./Tool"), exports);
84
+ __exportStar(require("./ToolCall"), exports);
85
+ __exportStar(require("./ToolCallFunction"), exports);
86
+ __exportStar(require("./ToolChoiceFunction"), exports);
87
+ __exportStar(require("./ToolChoiceFunctionFunction"), exports);
88
+ __exportStar(require("./ToolFunction"), exports);
61
89
  __exportStar(require("./UpdateSpendingLimitRequest"), exports);
62
90
  __exportStar(require("./Usage"), exports);
63
91
  __exportStar(require("./UsageBucket"), exports);
92
+ __exportStar(require("./UsageCompletionTokensDetails"), exports);
64
93
  __exportStar(require("./UsagePage"), exports);
94
+ __exportStar(require("./UsagePromptTokensDetails"), exports);
65
95
  __exportStar(require("./VideoCreateRequest"), exports);
66
96
  __exportStar(require("./VideoJob"), exports);
67
97
  __exportStar(require("./VideoList"), exports);
package/dist/runtime.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * deeprelay Public Developer API
3
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
3
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store. Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API. OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@deeprelay.ai
package/dist/runtime.js CHANGED
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * deeprelay Public Developer API
6
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
6
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store. Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API. OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@deeprelay.ai
@@ -69,7 +69,7 @@ class Configuration {
69
69
  return undefined;
70
70
  }
71
71
  get headers() {
72
- return Object.assign({ 'User-Agent': 'deeprelay-sdk-ts/0.2.0' }, this.configuration.headers);
72
+ return Object.assign({ 'User-Agent': 'deeprelay-sdk-ts/0.3.0' }, this.configuration.headers);
73
73
  }
74
74
  get credentials() {
75
75
  return this.configuration.credentials;
@@ -0,0 +1,40 @@
1
+
2
+ # AlertEmailToggles
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `balanceLow` | boolean
10
+ `subscriptionQuota` | boolean
11
+ `apiKeyBudget` | boolean
12
+ `memberSpend` | boolean
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { AlertEmailToggles } from '@deeprelay/sdk'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "balanceLow": null,
22
+ "subscriptionQuota": null,
23
+ "apiKeyBudget": null,
24
+ "memberSpend": null,
25
+ } satisfies AlertEmailToggles
26
+
27
+ console.log(example)
28
+
29
+ // Convert the instance to a JSON string
30
+ const exampleJSON: string = JSON.stringify(example)
31
+ console.log(exampleJSON)
32
+
33
+ // Parse the JSON string back to an object
34
+ const exampleParsed = JSON.parse(exampleJSON) as AlertEmailToggles
35
+ console.log(exampleParsed)
36
+ ```
37
+
38
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
+
40
+
@@ -0,0 +1,40 @@
1
+
2
+ # AlertSettings
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `balanceThresholdCents` | number
10
+ `email` | [AlertEmailToggles](AlertEmailToggles.md)
11
+ `updatedAt` | Date
12
+ `note` | string
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { AlertSettings } from '@deeprelay/sdk'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "balanceThresholdCents": null,
22
+ "email": null,
23
+ "updatedAt": null,
24
+ "note": null,
25
+ } satisfies AlertSettings
26
+
27
+ console.log(example)
28
+
29
+ // Convert the instance to a JSON string
30
+ const exampleJSON: string = JSON.stringify(example)
31
+ console.log(exampleJSON)
32
+
33
+ // Parse the JSON string back to an object
34
+ const exampleParsed = JSON.parse(exampleJSON) as AlertSettings
35
+ console.log(exampleParsed)
36
+ ```
37
+
38
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
+
40
+
@@ -0,0 +1,36 @@
1
+
2
+ # AlertSettingsUpdate
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `balanceThresholdCents` | number
10
+ `email` | [AlertEmailToggles](AlertEmailToggles.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { AlertSettingsUpdate } from '@deeprelay/sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "balanceThresholdCents": null,
20
+ "email": null,
21
+ } satisfies AlertSettingsUpdate
22
+
23
+ console.log(example)
24
+
25
+ // Convert the instance to a JSON string
26
+ const exampleJSON: string = JSON.stringify(example)
27
+ console.log(exampleJSON)
28
+
29
+ // Parse the JSON string back to an object
30
+ const exampleParsed = JSON.parse(exampleJSON) as AlertSettingsUpdate
31
+ console.log(exampleParsed)
32
+ ```
33
+
34
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
+
36
+
@@ -0,0 +1,151 @@
1
+ # AlertsApi
2
+
3
+ All URIs are relative to *https://api.deeprelay.ai/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**getAlertSettings**](AlertsApi.md#getalertsettings) | **GET** /alerts/settings | Get the organization\'s alert settings |
8
+ | [**putAlertSettings**](AlertsApi.md#putalertsettings) | **PUT** /alerts/settings | Replace the organization\'s alert settings |
9
+
10
+
11
+
12
+ ## getAlertSettings
13
+
14
+ > AlertSettings getAlertSettings()
15
+
16
+ Get the organization\'s alert settings
17
+
18
+ Returns the low-balance threshold and the four org-level alert email toggles. An organization that has never saved settings gets the defaults with `updated_at: null`. Requires the `billing:read` scope.
19
+
20
+ ### Example
21
+
22
+ ```ts
23
+ import {
24
+ Configuration,
25
+ AlertsApi,
26
+ } from '@deeprelay/sdk';
27
+ import type { GetAlertSettingsRequest } from '@deeprelay/sdk';
28
+
29
+ async function example() {
30
+ console.log("🚀 Testing @deeprelay/sdk SDK...");
31
+ const config = new Configuration({
32
+ // Configure HTTP bearer authorization: bearerAuth
33
+ accessToken: "YOUR BEARER TOKEN",
34
+ });
35
+ const api = new AlertsApi(config);
36
+
37
+ try {
38
+ const data = await api.getAlertSettings();
39
+ console.log(data);
40
+ } catch (error) {
41
+ console.error(error);
42
+ }
43
+ }
44
+
45
+ // Run the test
46
+ example().catch(console.error);
47
+ ```
48
+
49
+ ### Parameters
50
+
51
+ This endpoint does not need any parameter.
52
+
53
+ ### Return type
54
+
55
+ [**AlertSettings**](AlertSettings.md)
56
+
57
+ ### Authorization
58
+
59
+ [bearerAuth](../README.md#bearerAuth)
60
+
61
+ ### HTTP request headers
62
+
63
+ - **Content-Type**: Not defined
64
+ - **Accept**: `application/json`, `application/problem+json`
65
+
66
+
67
+ ### HTTP response details
68
+ | Status code | Description | Response headers |
69
+ |-------------|-------------|------------------|
70
+ | **200** | OK | - |
71
+ | **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
72
+ | **0** | Error response (RFC 7807) | - |
73
+
74
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
75
+
76
+
77
+ ## putAlertSettings
78
+
79
+ > AlertSettings putAlertSettings(alertSettingsUpdate)
80
+
81
+ Replace the organization\&#39;s alert settings
82
+
83
+ Replaces every setting at once: send &#x60;balance_threshold_cents&#x60; and all four &#x60;email&#x60; toggles (a missing field is 422 &#x60;validation_failed&#x60; naming the &#x60;field&#x60;). Requires the &#x60;billing:write&#x60; scope AND an org admin\&#39;s key or a &#x60;full_access&#x60; key (403 &#x60;forbidden&#x60; otherwise). The toggles only control the org-level emails; a member always receives their own spend-limit emails. Webhook delivery of the same events is configured on the webhook endpoint, not here.
84
+
85
+ ### Example
86
+
87
+ ```ts
88
+ import {
89
+ Configuration,
90
+ AlertsApi,
91
+ } from '@deeprelay/sdk';
92
+ import type { PutAlertSettingsRequest } from '@deeprelay/sdk';
93
+
94
+ async function example() {
95
+ console.log("🚀 Testing @deeprelay/sdk SDK...");
96
+ const config = new Configuration({
97
+ // Configure HTTP bearer authorization: bearerAuth
98
+ accessToken: "YOUR BEARER TOKEN",
99
+ });
100
+ const api = new AlertsApi(config);
101
+
102
+ const body = {
103
+ // AlertSettingsUpdate
104
+ alertSettingsUpdate: ...,
105
+ } satisfies PutAlertSettingsRequest;
106
+
107
+ try {
108
+ const data = await api.putAlertSettings(body);
109
+ console.log(data);
110
+ } catch (error) {
111
+ console.error(error);
112
+ }
113
+ }
114
+
115
+ // Run the test
116
+ example().catch(console.error);
117
+ ```
118
+
119
+ ### Parameters
120
+
121
+
122
+ | Name | Type | Description | Notes |
123
+ |------------- | ------------- | ------------- | -------------|
124
+ | **alertSettingsUpdate** | [AlertSettingsUpdate](AlertSettingsUpdate.md) | | |
125
+
126
+ ### Return type
127
+
128
+ [**AlertSettings**](AlertSettings.md)
129
+
130
+ ### Authorization
131
+
132
+ [bearerAuth](../README.md#bearerAuth)
133
+
134
+ ### HTTP request headers
135
+
136
+ - **Content-Type**: `application/json`
137
+ - **Accept**: `application/json`, `application/problem+json`
138
+
139
+
140
+ ### HTTP response details
141
+ | Status code | Description | Response headers |
142
+ |-------------|-------------|------------------|
143
+ | **200** | OK | - |
144
+ | **400** | Error response (RFC 7807) | - |
145
+ | **403** | Error response (RFC 7807) | - |
146
+ | **422** | Error response (RFC 7807) | - |
147
+ | **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
148
+ | **0** | Error response (RFC 7807) | - |
149
+
150
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
151
+
package/docs/ApiKey.md ADDED
@@ -0,0 +1,65 @@
1
+
2
+ # ApiKey
3
+
4
+ An API key\'s metadata and limits. Never carries the secret.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `apiKeyId` | string
11
+ `name` | string
12
+ `keyPrefix` | string
13
+ `last4` | string
14
+ `scopes` | [ApiKeyScopes](ApiKeyScopes.md)
15
+ `budgetCents` | number
16
+ `budgetUsedMicroCents` | number
17
+ `budgetResetsAt` | Date
18
+ `allowedModels` | Array&lt;string&gt;
19
+ `staleModels` | Array&lt;string&gt;
20
+ `rateLimitRps` | number
21
+ `rateLimitBurst` | number
22
+ `expiresAt` | Date
23
+ `createdAt` | Date
24
+ `lastUsedAt` | Date
25
+ `revokedAt` | Date
26
+
27
+ ## Example
28
+
29
+ ```typescript
30
+ import type { ApiKey } from '@deeprelay/sdk'
31
+
32
+ // TODO: Update the object below with actual values
33
+ const example = {
34
+ "apiKeyId": null,
35
+ "name": null,
36
+ "keyPrefix": null,
37
+ "last4": null,
38
+ "scopes": null,
39
+ "budgetCents": null,
40
+ "budgetUsedMicroCents": null,
41
+ "budgetResetsAt": null,
42
+ "allowedModels": null,
43
+ "staleModels": null,
44
+ "rateLimitRps": null,
45
+ "rateLimitBurst": null,
46
+ "expiresAt": null,
47
+ "createdAt": null,
48
+ "lastUsedAt": null,
49
+ "revokedAt": null,
50
+ } satisfies ApiKey
51
+
52
+ console.log(example)
53
+
54
+ // Convert the instance to a JSON string
55
+ const exampleJSON: string = JSON.stringify(example)
56
+ console.log(exampleJSON)
57
+
58
+ // Parse the JSON string back to an object
59
+ const exampleParsed = JSON.parse(exampleJSON) as ApiKey
60
+ console.log(exampleParsed)
61
+ ```
62
+
63
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
64
+
65
+
@@ -0,0 +1,46 @@
1
+
2
+ # ApiKeyCreate
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `name` | string
10
+ `scopes` | { [key: string]: any; }
11
+ `budgetCents` | number
12
+ `allowedModels` | Array&lt;string&gt;
13
+ `rateLimitRps` | number
14
+ `rateLimitBurst` | number
15
+ `expiresAt` | Date
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import type { ApiKeyCreate } from '@deeprelay/sdk'
21
+
22
+ // TODO: Update the object below with actual values
23
+ const example = {
24
+ "name": null,
25
+ "scopes": null,
26
+ "budgetCents": null,
27
+ "allowedModels": null,
28
+ "rateLimitRps": null,
29
+ "rateLimitBurst": null,
30
+ "expiresAt": null,
31
+ } satisfies ApiKeyCreate
32
+
33
+ console.log(example)
34
+
35
+ // Convert the instance to a JSON string
36
+ const exampleJSON: string = JSON.stringify(example)
37
+ console.log(exampleJSON)
38
+
39
+ // Parse the JSON string back to an object
40
+ const exampleParsed = JSON.parse(exampleJSON) as ApiKeyCreate
41
+ console.log(exampleParsed)
42
+ ```
43
+
44
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
45
+
46
+
@@ -0,0 +1,67 @@
1
+
2
+ # ApiKeyCreated
3
+
4
+ The new key\'s metadata plus its secret (`key`), returned exactly once. The same fields as `ApiKey`, plus `key`.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `apiKeyId` | string
11
+ `name` | string
12
+ `keyPrefix` | string
13
+ `last4` | string
14
+ `scopes` | [ApiKeyScopes](ApiKeyScopes.md)
15
+ `budgetCents` | number
16
+ `budgetUsedMicroCents` | number
17
+ `budgetResetsAt` | Date
18
+ `allowedModels` | Array&lt;string&gt;
19
+ `staleModels` | Array&lt;string&gt;
20
+ `rateLimitRps` | number
21
+ `rateLimitBurst` | number
22
+ `expiresAt` | Date
23
+ `createdAt` | Date
24
+ `lastUsedAt` | Date
25
+ `revokedAt` | Date
26
+ `key` | string
27
+
28
+ ## Example
29
+
30
+ ```typescript
31
+ import type { ApiKeyCreated } from '@deeprelay/sdk'
32
+
33
+ // TODO: Update the object below with actual values
34
+ const example = {
35
+ "apiKeyId": null,
36
+ "name": null,
37
+ "keyPrefix": null,
38
+ "last4": null,
39
+ "scopes": null,
40
+ "budgetCents": null,
41
+ "budgetUsedMicroCents": null,
42
+ "budgetResetsAt": null,
43
+ "allowedModels": null,
44
+ "staleModels": null,
45
+ "rateLimitRps": null,
46
+ "rateLimitBurst": null,
47
+ "expiresAt": null,
48
+ "createdAt": null,
49
+ "lastUsedAt": null,
50
+ "revokedAt": null,
51
+ "key": null,
52
+ } satisfies ApiKeyCreated
53
+
54
+ console.log(example)
55
+
56
+ // Convert the instance to a JSON string
57
+ const exampleJSON: string = JSON.stringify(example)
58
+ console.log(exampleJSON)
59
+
60
+ // Parse the JSON string back to an object
61
+ const exampleParsed = JSON.parse(exampleJSON) as ApiKeyCreated
62
+ console.log(exampleParsed)
63
+ ```
64
+
65
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
66
+
67
+
@@ -0,0 +1,34 @@
1
+
2
+ # ApiKeyList
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array&lt;ApiKey&gt;](ApiKey.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { ApiKeyList } from '@deeprelay/sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies ApiKeyList
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as ApiKeyList
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+