@notiflows/node 0.0.1

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 (459) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +422 -0
  3. package/api-promise.d.mts +2 -0
  4. package/api-promise.d.mts.map +1 -0
  5. package/api-promise.d.ts +2 -0
  6. package/api-promise.d.ts.map +1 -0
  7. package/api-promise.js +6 -0
  8. package/api-promise.js.map +1 -0
  9. package/api-promise.mjs +2 -0
  10. package/api-promise.mjs.map +1 -0
  11. package/client.d.mts +207 -0
  12. package/client.d.mts.map +1 -0
  13. package/client.d.ts +207 -0
  14. package/client.d.ts.map +1 -0
  15. package/client.js +502 -0
  16. package/client.js.map +1 -0
  17. package/client.mjs +498 -0
  18. package/client.mjs.map +1 -0
  19. package/core/api-promise.d.mts +46 -0
  20. package/core/api-promise.d.mts.map +1 -0
  21. package/core/api-promise.d.ts +46 -0
  22. package/core/api-promise.d.ts.map +1 -0
  23. package/core/api-promise.js +74 -0
  24. package/core/api-promise.js.map +1 -0
  25. package/core/api-promise.mjs +70 -0
  26. package/core/api-promise.mjs.map +1 -0
  27. package/core/error.d.mts +46 -0
  28. package/core/error.d.mts.map +1 -0
  29. package/core/error.d.ts +46 -0
  30. package/core/error.d.ts.map +1 -0
  31. package/core/error.js +113 -0
  32. package/core/error.js.map +1 -0
  33. package/core/error.mjs +97 -0
  34. package/core/error.mjs.map +1 -0
  35. package/core/pagination.d.mts +59 -0
  36. package/core/pagination.d.mts.map +1 -0
  37. package/core/pagination.d.ts +59 -0
  38. package/core/pagination.d.ts.map +1 -0
  39. package/core/pagination.js +101 -0
  40. package/core/pagination.js.map +1 -0
  41. package/core/pagination.mjs +95 -0
  42. package/core/pagination.mjs.map +1 -0
  43. package/core/resource.d.mts +6 -0
  44. package/core/resource.d.mts.map +1 -0
  45. package/core/resource.d.ts +6 -0
  46. package/core/resource.d.ts.map +1 -0
  47. package/core/resource.js +11 -0
  48. package/core/resource.js.map +1 -0
  49. package/core/resource.mjs +7 -0
  50. package/core/resource.mjs.map +1 -0
  51. package/core/uploads.d.mts +3 -0
  52. package/core/uploads.d.mts.map +1 -0
  53. package/core/uploads.d.ts +3 -0
  54. package/core/uploads.d.ts.map +1 -0
  55. package/core/uploads.js +6 -0
  56. package/core/uploads.js.map +1 -0
  57. package/core/uploads.mjs +2 -0
  58. package/core/uploads.mjs.map +1 -0
  59. package/error.d.mts +2 -0
  60. package/error.d.mts.map +1 -0
  61. package/error.d.ts +2 -0
  62. package/error.d.ts.map +1 -0
  63. package/error.js +6 -0
  64. package/error.js.map +1 -0
  65. package/error.mjs +2 -0
  66. package/error.mjs.map +1 -0
  67. package/index.d.mts +7 -0
  68. package/index.d.mts.map +1 -0
  69. package/index.d.ts +7 -0
  70. package/index.d.ts.map +1 -0
  71. package/index.js +32 -0
  72. package/index.js.map +1 -0
  73. package/index.mjs +8 -0
  74. package/index.mjs.map +1 -0
  75. package/internal/builtin-types.d.mts +73 -0
  76. package/internal/builtin-types.d.mts.map +1 -0
  77. package/internal/builtin-types.d.ts +73 -0
  78. package/internal/builtin-types.d.ts.map +1 -0
  79. package/internal/builtin-types.js +4 -0
  80. package/internal/builtin-types.js.map +1 -0
  81. package/internal/builtin-types.mjs +3 -0
  82. package/internal/builtin-types.mjs.map +1 -0
  83. package/internal/detect-platform.d.mts +15 -0
  84. package/internal/detect-platform.d.mts.map +1 -0
  85. package/internal/detect-platform.d.ts +15 -0
  86. package/internal/detect-platform.d.ts.map +1 -0
  87. package/internal/detect-platform.js +162 -0
  88. package/internal/detect-platform.js.map +1 -0
  89. package/internal/detect-platform.mjs +157 -0
  90. package/internal/detect-platform.mjs.map +1 -0
  91. package/internal/errors.d.mts +3 -0
  92. package/internal/errors.d.mts.map +1 -0
  93. package/internal/errors.d.ts +3 -0
  94. package/internal/errors.d.ts.map +1 -0
  95. package/internal/errors.js +41 -0
  96. package/internal/errors.js.map +1 -0
  97. package/internal/errors.mjs +36 -0
  98. package/internal/errors.mjs.map +1 -0
  99. package/internal/headers.d.mts +20 -0
  100. package/internal/headers.d.mts.map +1 -0
  101. package/internal/headers.d.ts +20 -0
  102. package/internal/headers.d.ts.map +1 -0
  103. package/internal/headers.js +79 -0
  104. package/internal/headers.js.map +1 -0
  105. package/internal/headers.mjs +74 -0
  106. package/internal/headers.mjs.map +1 -0
  107. package/internal/parse.d.mts +12 -0
  108. package/internal/parse.d.mts.map +1 -0
  109. package/internal/parse.d.ts +12 -0
  110. package/internal/parse.d.ts.map +1 -0
  111. package/internal/parse.js +40 -0
  112. package/internal/parse.js.map +1 -0
  113. package/internal/parse.mjs +37 -0
  114. package/internal/parse.mjs.map +1 -0
  115. package/internal/request-options.d.mts +75 -0
  116. package/internal/request-options.d.mts.map +1 -0
  117. package/internal/request-options.d.ts +75 -0
  118. package/internal/request-options.d.ts.map +1 -0
  119. package/internal/request-options.js +14 -0
  120. package/internal/request-options.js.map +1 -0
  121. package/internal/request-options.mjs +10 -0
  122. package/internal/request-options.mjs.map +1 -0
  123. package/internal/shim-types.d.mts +17 -0
  124. package/internal/shim-types.d.mts.map +1 -0
  125. package/internal/shim-types.d.ts +17 -0
  126. package/internal/shim-types.d.ts.map +1 -0
  127. package/internal/shim-types.js +4 -0
  128. package/internal/shim-types.js.map +1 -0
  129. package/internal/shim-types.mjs +3 -0
  130. package/internal/shim-types.mjs.map +1 -0
  131. package/internal/shims.d.mts +20 -0
  132. package/internal/shims.d.mts.map +1 -0
  133. package/internal/shims.d.ts +20 -0
  134. package/internal/shims.d.ts.map +1 -0
  135. package/internal/shims.js +92 -0
  136. package/internal/shims.js.map +1 -0
  137. package/internal/shims.mjs +85 -0
  138. package/internal/shims.mjs.map +1 -0
  139. package/internal/to-file.d.mts +45 -0
  140. package/internal/to-file.d.mts.map +1 -0
  141. package/internal/to-file.d.ts +45 -0
  142. package/internal/to-file.d.ts.map +1 -0
  143. package/internal/to-file.js +91 -0
  144. package/internal/to-file.js.map +1 -0
  145. package/internal/to-file.mjs +88 -0
  146. package/internal/to-file.mjs.map +1 -0
  147. package/internal/tslib.js +81 -0
  148. package/internal/tslib.mjs +17 -0
  149. package/internal/types.d.mts +69 -0
  150. package/internal/types.d.mts.map +1 -0
  151. package/internal/types.d.ts +69 -0
  152. package/internal/types.d.ts.map +1 -0
  153. package/internal/types.js +4 -0
  154. package/internal/types.js.map +1 -0
  155. package/internal/types.mjs +3 -0
  156. package/internal/types.mjs.map +1 -0
  157. package/internal/uploads.d.mts +42 -0
  158. package/internal/uploads.d.mts.map +1 -0
  159. package/internal/uploads.d.ts +42 -0
  160. package/internal/uploads.d.ts.map +1 -0
  161. package/internal/uploads.js +141 -0
  162. package/internal/uploads.js.map +1 -0
  163. package/internal/uploads.mjs +131 -0
  164. package/internal/uploads.mjs.map +1 -0
  165. package/internal/utils/base64.d.mts +3 -0
  166. package/internal/utils/base64.d.mts.map +1 -0
  167. package/internal/utils/base64.d.ts +3 -0
  168. package/internal/utils/base64.d.ts.map +1 -0
  169. package/internal/utils/base64.js +38 -0
  170. package/internal/utils/base64.js.map +1 -0
  171. package/internal/utils/base64.mjs +33 -0
  172. package/internal/utils/base64.mjs.map +1 -0
  173. package/internal/utils/bytes.d.mts +4 -0
  174. package/internal/utils/bytes.d.mts.map +1 -0
  175. package/internal/utils/bytes.d.ts +4 -0
  176. package/internal/utils/bytes.d.ts.map +1 -0
  177. package/internal/utils/bytes.js +31 -0
  178. package/internal/utils/bytes.js.map +1 -0
  179. package/internal/utils/bytes.mjs +26 -0
  180. package/internal/utils/bytes.mjs.map +1 -0
  181. package/internal/utils/env.d.mts +9 -0
  182. package/internal/utils/env.d.mts.map +1 -0
  183. package/internal/utils/env.d.ts +9 -0
  184. package/internal/utils/env.d.ts.map +1 -0
  185. package/internal/utils/env.js +22 -0
  186. package/internal/utils/env.js.map +1 -0
  187. package/internal/utils/env.mjs +18 -0
  188. package/internal/utils/env.mjs.map +1 -0
  189. package/internal/utils/log.d.mts +37 -0
  190. package/internal/utils/log.d.mts.map +1 -0
  191. package/internal/utils/log.d.ts +37 -0
  192. package/internal/utils/log.d.ts.map +1 -0
  193. package/internal/utils/log.js +87 -0
  194. package/internal/utils/log.js.map +1 -0
  195. package/internal/utils/log.mjs +81 -0
  196. package/internal/utils/log.mjs.map +1 -0
  197. package/internal/utils/path.d.mts +15 -0
  198. package/internal/utils/path.d.mts.map +1 -0
  199. package/internal/utils/path.d.ts +15 -0
  200. package/internal/utils/path.d.ts.map +1 -0
  201. package/internal/utils/path.js +79 -0
  202. package/internal/utils/path.js.map +1 -0
  203. package/internal/utils/path.mjs +74 -0
  204. package/internal/utils/path.mjs.map +1 -0
  205. package/internal/utils/sleep.d.mts +2 -0
  206. package/internal/utils/sleep.d.mts.map +1 -0
  207. package/internal/utils/sleep.d.ts +2 -0
  208. package/internal/utils/sleep.d.ts.map +1 -0
  209. package/internal/utils/sleep.js +7 -0
  210. package/internal/utils/sleep.js.map +1 -0
  211. package/internal/utils/sleep.mjs +3 -0
  212. package/internal/utils/sleep.mjs.map +1 -0
  213. package/internal/utils/uuid.d.mts +5 -0
  214. package/internal/utils/uuid.d.mts.map +1 -0
  215. package/internal/utils/uuid.d.ts +5 -0
  216. package/internal/utils/uuid.d.ts.map +1 -0
  217. package/internal/utils/uuid.js +19 -0
  218. package/internal/utils/uuid.js.map +1 -0
  219. package/internal/utils/uuid.mjs +15 -0
  220. package/internal/utils/uuid.mjs.map +1 -0
  221. package/internal/utils/values.d.mts +18 -0
  222. package/internal/utils/values.d.mts.map +1 -0
  223. package/internal/utils/values.d.ts +18 -0
  224. package/internal/utils/values.d.ts.map +1 -0
  225. package/internal/utils/values.js +112 -0
  226. package/internal/utils/values.js.map +1 -0
  227. package/internal/utils/values.mjs +94 -0
  228. package/internal/utils/values.mjs.map +1 -0
  229. package/internal/utils.d.mts +7 -0
  230. package/internal/utils.d.mts.map +1 -0
  231. package/internal/utils.d.ts +7 -0
  232. package/internal/utils.d.ts.map +1 -0
  233. package/internal/utils.js +11 -0
  234. package/internal/utils.js.map +1 -0
  235. package/internal/utils.mjs +8 -0
  236. package/internal/utils.mjs.map +1 -0
  237. package/package.json +147 -0
  238. package/pagination.d.mts +2 -0
  239. package/pagination.d.mts.map +1 -0
  240. package/pagination.d.ts +2 -0
  241. package/pagination.d.ts.map +1 -0
  242. package/pagination.js +6 -0
  243. package/pagination.js.map +1 -0
  244. package/pagination.mjs +2 -0
  245. package/pagination.mjs.map +1 -0
  246. package/resource.d.mts +2 -0
  247. package/resource.d.mts.map +1 -0
  248. package/resource.d.ts +2 -0
  249. package/resource.d.ts.map +1 -0
  250. package/resource.js +6 -0
  251. package/resource.js.map +1 -0
  252. package/resource.mjs +2 -0
  253. package/resource.mjs.map +1 -0
  254. package/resources/deliveries.d.mts +143 -0
  255. package/resources/deliveries.d.mts.map +1 -0
  256. package/resources/deliveries.d.ts +143 -0
  257. package/resources/deliveries.d.ts.map +1 -0
  258. package/resources/deliveries.js +44 -0
  259. package/resources/deliveries.js.map +1 -0
  260. package/resources/deliveries.mjs +40 -0
  261. package/resources/deliveries.mjs.map +1 -0
  262. package/resources/index.d.mts +6 -0
  263. package/resources/index.d.mts.map +1 -0
  264. package/resources/index.d.ts +6 -0
  265. package/resources/index.d.ts.map +1 -0
  266. package/resources/index.js +15 -0
  267. package/resources/index.js.map +1 -0
  268. package/resources/index.mjs +7 -0
  269. package/resources/index.mjs.map +1 -0
  270. package/resources/notifications.d.mts +170 -0
  271. package/resources/notifications.d.mts.map +1 -0
  272. package/resources/notifications.d.ts +170 -0
  273. package/resources/notifications.d.ts.map +1 -0
  274. package/resources/notifications.js +58 -0
  275. package/resources/notifications.js.map +1 -0
  276. package/resources/notifications.mjs +54 -0
  277. package/resources/notifications.mjs.map +1 -0
  278. package/resources/notiflows.d.mts +122 -0
  279. package/resources/notiflows.d.mts.map +1 -0
  280. package/resources/notiflows.d.ts +122 -0
  281. package/resources/notiflows.d.ts.map +1 -0
  282. package/resources/notiflows.js +36 -0
  283. package/resources/notiflows.js.map +1 -0
  284. package/resources/notiflows.mjs +32 -0
  285. package/resources/notiflows.mjs.map +1 -0
  286. package/resources/topics/index.d.mts +3 -0
  287. package/resources/topics/index.d.mts.map +1 -0
  288. package/resources/topics/index.d.ts +3 -0
  289. package/resources/topics/index.d.ts.map +1 -0
  290. package/resources/topics/index.js +9 -0
  291. package/resources/topics/index.js.map +1 -0
  292. package/resources/topics/index.mjs +4 -0
  293. package/resources/topics/index.mjs.map +1 -0
  294. package/resources/topics/subscriptions.d.mts +137 -0
  295. package/resources/topics/subscriptions.d.mts.map +1 -0
  296. package/resources/topics/subscriptions.d.ts +137 -0
  297. package/resources/topics/subscriptions.d.ts.map +1 -0
  298. package/resources/topics/subscriptions.js +78 -0
  299. package/resources/topics/subscriptions.js.map +1 -0
  300. package/resources/topics/subscriptions.mjs +74 -0
  301. package/resources/topics/subscriptions.mjs.map +1 -0
  302. package/resources/topics/topics.d.mts +70 -0
  303. package/resources/topics/topics.d.mts.map +1 -0
  304. package/resources/topics/topics.d.ts +70 -0
  305. package/resources/topics/topics.d.ts.map +1 -0
  306. package/resources/topics/topics.js +65 -0
  307. package/resources/topics/topics.js.map +1 -0
  308. package/resources/topics/topics.mjs +60 -0
  309. package/resources/topics/topics.mjs.map +1 -0
  310. package/resources/topics.d.mts +2 -0
  311. package/resources/topics.d.mts.map +1 -0
  312. package/resources/topics.d.ts +2 -0
  313. package/resources/topics.d.ts.map +1 -0
  314. package/resources/topics.js +6 -0
  315. package/resources/topics.js.map +1 -0
  316. package/resources/topics.mjs +3 -0
  317. package/resources/topics.mjs.map +1 -0
  318. package/resources/users/channel-settings.d.mts +158 -0
  319. package/resources/users/channel-settings.d.mts.map +1 -0
  320. package/resources/users/channel-settings.d.ts +158 -0
  321. package/resources/users/channel-settings.d.ts.map +1 -0
  322. package/resources/users/channel-settings.js +98 -0
  323. package/resources/users/channel-settings.js.map +1 -0
  324. package/resources/users/channel-settings.mjs +94 -0
  325. package/resources/users/channel-settings.mjs.map +1 -0
  326. package/resources/users/deliveries.d.mts +71 -0
  327. package/resources/users/deliveries.d.mts.map +1 -0
  328. package/resources/users/deliveries.d.ts +71 -0
  329. package/resources/users/deliveries.d.ts.map +1 -0
  330. package/resources/users/deliveries.js +45 -0
  331. package/resources/users/deliveries.js.map +1 -0
  332. package/resources/users/deliveries.mjs +41 -0
  333. package/resources/users/deliveries.mjs.map +1 -0
  334. package/resources/users/index.d.mts +7 -0
  335. package/resources/users/index.d.mts.map +1 -0
  336. package/resources/users/index.d.ts +7 -0
  337. package/resources/users/index.d.ts.map +1 -0
  338. package/resources/users/index.js +17 -0
  339. package/resources/users/index.js.map +1 -0
  340. package/resources/users/index.mjs +8 -0
  341. package/resources/users/index.mjs.map +1 -0
  342. package/resources/users/notifications.d.mts +68 -0
  343. package/resources/users/notifications.d.mts.map +1 -0
  344. package/resources/users/notifications.d.ts +68 -0
  345. package/resources/users/notifications.d.ts.map +1 -0
  346. package/resources/users/notifications.js +43 -0
  347. package/resources/users/notifications.js.map +1 -0
  348. package/resources/users/notifications.mjs +39 -0
  349. package/resources/users/notifications.mjs.map +1 -0
  350. package/resources/users/preferences.d.mts +166 -0
  351. package/resources/users/preferences.d.mts.map +1 -0
  352. package/resources/users/preferences.d.ts +166 -0
  353. package/resources/users/preferences.d.ts.map +1 -0
  354. package/resources/users/preferences.js +60 -0
  355. package/resources/users/preferences.js.map +1 -0
  356. package/resources/users/preferences.mjs +56 -0
  357. package/resources/users/preferences.mjs.map +1 -0
  358. package/resources/users/subscriptions.d.mts +121 -0
  359. package/resources/users/subscriptions.d.mts.map +1 -0
  360. package/resources/users/subscriptions.d.ts +121 -0
  361. package/resources/users/subscriptions.d.ts.map +1 -0
  362. package/resources/users/subscriptions.js +84 -0
  363. package/resources/users/subscriptions.js.map +1 -0
  364. package/resources/users/subscriptions.mjs +80 -0
  365. package/resources/users/subscriptions.mjs.map +1 -0
  366. package/resources/users/users.d.mts +216 -0
  367. package/resources/users/users.d.mts.map +1 -0
  368. package/resources/users/users.d.ts +216 -0
  369. package/resources/users/users.d.ts.map +1 -0
  370. package/resources/users/users.js +102 -0
  371. package/resources/users/users.js.map +1 -0
  372. package/resources/users/users.mjs +97 -0
  373. package/resources/users/users.mjs.map +1 -0
  374. package/resources/users.d.mts +2 -0
  375. package/resources/users.d.mts.map +1 -0
  376. package/resources/users.d.ts +2 -0
  377. package/resources/users.d.ts.map +1 -0
  378. package/resources/users.js +6 -0
  379. package/resources/users.js.map +1 -0
  380. package/resources/users.mjs +3 -0
  381. package/resources/users.mjs.map +1 -0
  382. package/resources.d.mts +2 -0
  383. package/resources.d.mts.map +1 -0
  384. package/resources.d.ts +2 -0
  385. package/resources.d.ts.map +1 -0
  386. package/resources.js +5 -0
  387. package/resources.js.map +1 -0
  388. package/resources.mjs +2 -0
  389. package/resources.mjs.map +1 -0
  390. package/src/api-promise.ts +2 -0
  391. package/src/client.ts +838 -0
  392. package/src/core/README.md +3 -0
  393. package/src/core/api-promise.ts +92 -0
  394. package/src/core/error.ts +130 -0
  395. package/src/core/pagination.ts +163 -0
  396. package/src/core/resource.ts +11 -0
  397. package/src/core/uploads.ts +2 -0
  398. package/src/error.ts +2 -0
  399. package/src/index.ts +23 -0
  400. package/src/internal/README.md +3 -0
  401. package/src/internal/builtin-types.ts +93 -0
  402. package/src/internal/detect-platform.ts +196 -0
  403. package/src/internal/errors.ts +33 -0
  404. package/src/internal/headers.ts +97 -0
  405. package/src/internal/parse.ts +56 -0
  406. package/src/internal/request-options.ts +91 -0
  407. package/src/internal/shim-types.ts +26 -0
  408. package/src/internal/shims.ts +107 -0
  409. package/src/internal/to-file.ts +154 -0
  410. package/src/internal/types.ts +95 -0
  411. package/src/internal/uploads.ts +187 -0
  412. package/src/internal/utils/base64.ts +40 -0
  413. package/src/internal/utils/bytes.ts +32 -0
  414. package/src/internal/utils/env.ts +18 -0
  415. package/src/internal/utils/log.ts +128 -0
  416. package/src/internal/utils/path.ts +88 -0
  417. package/src/internal/utils/sleep.ts +3 -0
  418. package/src/internal/utils/uuid.ts +17 -0
  419. package/src/internal/utils/values.ts +105 -0
  420. package/src/internal/utils.ts +8 -0
  421. package/src/lib/.keep +4 -0
  422. package/src/pagination.ts +2 -0
  423. package/src/resource.ts +2 -0
  424. package/src/resources/deliveries.ts +183 -0
  425. package/src/resources/index.ts +19 -0
  426. package/src/resources/notifications.ts +225 -0
  427. package/src/resources/notiflows.ts +155 -0
  428. package/src/resources/topics/index.ts +11 -0
  429. package/src/resources/topics/subscriptions.ts +182 -0
  430. package/src/resources/topics/topics.ts +115 -0
  431. package/src/resources/topics.ts +3 -0
  432. package/src/resources/users/channel-settings.ts +205 -0
  433. package/src/resources/users/deliveries.ts +103 -0
  434. package/src/resources/users/index.ts +23 -0
  435. package/src/resources/users/notifications.ts +100 -0
  436. package/src/resources/users/preferences.ts +182 -0
  437. package/src/resources/users/subscriptions.ts +179 -0
  438. package/src/resources/users/users.ts +324 -0
  439. package/src/resources/users.ts +3 -0
  440. package/src/resources.ts +1 -0
  441. package/src/tsconfig.json +11 -0
  442. package/src/uploads.ts +2 -0
  443. package/src/version.ts +1 -0
  444. package/uploads.d.mts +2 -0
  445. package/uploads.d.mts.map +1 -0
  446. package/uploads.d.ts +2 -0
  447. package/uploads.d.ts.map +1 -0
  448. package/uploads.js +6 -0
  449. package/uploads.js.map +1 -0
  450. package/uploads.mjs +2 -0
  451. package/uploads.mjs.map +1 -0
  452. package/version.d.mts +2 -0
  453. package/version.d.mts.map +1 -0
  454. package/version.d.ts +2 -0
  455. package/version.d.ts.map +1 -0
  456. package/version.js +5 -0
  457. package/version.js.map +1 -0
  458. package/version.mjs +2 -0
  459. package/version.mjs.map +1 -0
@@ -0,0 +1,121 @@
1
+ import { APIResource } from "../../core/resource.js";
2
+ import { APIPromise } from "../../core/api-promise.js";
3
+ import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.js";
4
+ import { RequestOptions } from "../../internal/request-options.js";
5
+ export declare class Subscriptions extends APIResource {
6
+ /**
7
+ * Check if a user is subscribed to a specific topic.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const subscription =
12
+ * await client.users.subscriptions.retrieve(
13
+ * 'order-updates',
14
+ * { user_id: 'user_12345' },
15
+ * );
16
+ * ```
17
+ */
18
+ retrieve(topicName: string, params: SubscriptionRetrieveParams, options?: RequestOptions): APIPromise<Subscription>;
19
+ /**
20
+ * Retrieve all topic subscriptions for a user.
21
+ *
22
+ * @example
23
+ * ```ts
24
+ * // Automatically fetches more pages as needed.
25
+ * for await (const subscription of client.users.subscriptions.list(
26
+ * 'user_12345',
27
+ * )) {
28
+ * // ...
29
+ * }
30
+ * ```
31
+ */
32
+ list(userID: string, query?: SubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionsCursorPage, Subscription>;
33
+ /**
34
+ * Subscribe a user to a topic. Topics are created automatically if they don't
35
+ * exist.
36
+ *
37
+ * **Idempotent:** If the user is already subscribed, returns the existing
38
+ * subscription with `200 OK`.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * const subscription =
43
+ * await client.users.subscriptions.subscribe('user_12345', {
44
+ * topic_name: 'order-updates',
45
+ * });
46
+ * ```
47
+ */
48
+ subscribe(userID: string, body: SubscriptionSubscribeParams, options?: RequestOptions): APIPromise<Subscription>;
49
+ /**
50
+ * Remove a user's subscription from a topic. The user will no longer receive
51
+ * notifications triggered for this topic.
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * await client.users.subscriptions.unsubscribe(
56
+ * 'order-updates',
57
+ * { user_id: 'user_12345' },
58
+ * );
59
+ * ```
60
+ */
61
+ unsubscribe(topicName: string, params: SubscriptionUnsubscribeParams, options?: RequestOptions): APIPromise<void>;
62
+ }
63
+ export type SubscriptionsCursorPage = CursorPage<Subscription>;
64
+ /**
65
+ * A user's subscription to a topic
66
+ */
67
+ export interface Subscription {
68
+ /**
69
+ * Subscription ID
70
+ */
71
+ id: string;
72
+ /**
73
+ * When the subscription was created
74
+ */
75
+ created_at: string;
76
+ /**
77
+ * Name of the subscribed topic
78
+ */
79
+ topic_name: string;
80
+ /**
81
+ * User's internal ID
82
+ */
83
+ user_id: string;
84
+ }
85
+ export interface SubscriptionRetrieveParams {
86
+ /**
87
+ * User external ID
88
+ */
89
+ user_id: string;
90
+ }
91
+ export interface SubscriptionListParams extends CursorPageParams {
92
+ /**
93
+ * Cursor for fetching the previous page
94
+ */
95
+ before?: string;
96
+ /**
97
+ * Filter by created after (ISO 8601 datetime)
98
+ */
99
+ created_after?: string;
100
+ /**
101
+ * Filter by created before (ISO 8601 datetime)
102
+ */
103
+ created_before?: string;
104
+ }
105
+ export interface SubscriptionSubscribeParams {
106
+ /**
107
+ * Name of the topic to subscribe to. Topics are created automatically if they
108
+ * don't exist.
109
+ */
110
+ topic_name: string;
111
+ }
112
+ export interface SubscriptionUnsubscribeParams {
113
+ /**
114
+ * User external ID
115
+ */
116
+ user_id: string;
117
+ }
118
+ export declare namespace Subscriptions {
119
+ export { type Subscription as Subscription, type SubscriptionsCursorPage as SubscriptionsCursorPage, type SubscriptionRetrieveParams as SubscriptionRetrieveParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionSubscribeParams as SubscriptionSubscribeParams, type SubscriptionUnsubscribeParams as SubscriptionUnsubscribeParams, };
120
+ }
121
+ //# sourceMappingURL=subscriptions.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/resources/users/subscriptions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAK3B;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC;IAOrD;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;;;;;;;;;;OAWG;IACH,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
@@ -0,0 +1,84 @@
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.Subscriptions = void 0;
5
+ const resource_1 = require("../../core/resource.js");
6
+ const pagination_1 = require("../../core/pagination.js");
7
+ const headers_1 = require("../../internal/headers.js");
8
+ const path_1 = require("../../internal/utils/path.js");
9
+ class Subscriptions extends resource_1.APIResource {
10
+ /**
11
+ * Check if a user is subscribed to a specific topic.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const subscription =
16
+ * await client.users.subscriptions.retrieve(
17
+ * 'order-updates',
18
+ * { user_id: 'user_12345' },
19
+ * );
20
+ * ```
21
+ */
22
+ retrieve(topicName, params, options) {
23
+ const { user_id } = params;
24
+ return this._client.get((0, path_1.path) `/users/${user_id}/subscriptions/${topicName}`, options);
25
+ }
26
+ /**
27
+ * Retrieve all topic subscriptions for a user.
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * // Automatically fetches more pages as needed.
32
+ * for await (const subscription of client.users.subscriptions.list(
33
+ * 'user_12345',
34
+ * )) {
35
+ * // ...
36
+ * }
37
+ * ```
38
+ */
39
+ list(userID, query = {}, options) {
40
+ return this._client.getAPIList((0, path_1.path) `/users/${userID}/subscriptions`, (pagination_1.CursorPage), {
41
+ query,
42
+ ...options,
43
+ });
44
+ }
45
+ /**
46
+ * Subscribe a user to a topic. Topics are created automatically if they don't
47
+ * exist.
48
+ *
49
+ * **Idempotent:** If the user is already subscribed, returns the existing
50
+ * subscription with `200 OK`.
51
+ *
52
+ * @example
53
+ * ```ts
54
+ * const subscription =
55
+ * await client.users.subscriptions.subscribe('user_12345', {
56
+ * topic_name: 'order-updates',
57
+ * });
58
+ * ```
59
+ */
60
+ subscribe(userID, body, options) {
61
+ return this._client.post((0, path_1.path) `/users/${userID}/subscriptions`, { body, ...options });
62
+ }
63
+ /**
64
+ * Remove a user's subscription from a topic. The user will no longer receive
65
+ * notifications triggered for this topic.
66
+ *
67
+ * @example
68
+ * ```ts
69
+ * await client.users.subscriptions.unsubscribe(
70
+ * 'order-updates',
71
+ * { user_id: 'user_12345' },
72
+ * );
73
+ * ```
74
+ */
75
+ unsubscribe(topicName, params, options) {
76
+ const { user_id } = params;
77
+ return this._client.delete((0, path_1.path) `/users/${user_id}/subscriptions/${topicName}`, {
78
+ ...options,
79
+ headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
80
+ });
81
+ }
82
+ }
83
+ exports.Subscriptions = Subscriptions;
84
+ //# sourceMappingURL=subscriptions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../src/resources/users/subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAAuF;AACvF,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,SAAiB,EACjB,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,kBAAkB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAc,EACd,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,gBAAgB,EAAE,CAAA,uBAAwB,CAAA,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,MAAc,EACd,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CACT,SAAiB,EACjB,MAAqC,EACrC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,kBAAkB,SAAS,EAAE,EAAE;YAC7E,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA5FD,sCA4FC"}
@@ -0,0 +1,80 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../../core/resource.mjs";
3
+ import { CursorPage } from "../../core/pagination.mjs";
4
+ import { buildHeaders } from "../../internal/headers.mjs";
5
+ import { path } from "../../internal/utils/path.mjs";
6
+ export class Subscriptions extends APIResource {
7
+ /**
8
+ * Check if a user is subscribed to a specific topic.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const subscription =
13
+ * await client.users.subscriptions.retrieve(
14
+ * 'order-updates',
15
+ * { user_id: 'user_12345' },
16
+ * );
17
+ * ```
18
+ */
19
+ retrieve(topicName, params, options) {
20
+ const { user_id } = params;
21
+ return this._client.get(path `/users/${user_id}/subscriptions/${topicName}`, options);
22
+ }
23
+ /**
24
+ * Retrieve all topic subscriptions for a user.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * // Automatically fetches more pages as needed.
29
+ * for await (const subscription of client.users.subscriptions.list(
30
+ * 'user_12345',
31
+ * )) {
32
+ * // ...
33
+ * }
34
+ * ```
35
+ */
36
+ list(userID, query = {}, options) {
37
+ return this._client.getAPIList(path `/users/${userID}/subscriptions`, (CursorPage), {
38
+ query,
39
+ ...options,
40
+ });
41
+ }
42
+ /**
43
+ * Subscribe a user to a topic. Topics are created automatically if they don't
44
+ * exist.
45
+ *
46
+ * **Idempotent:** If the user is already subscribed, returns the existing
47
+ * subscription with `200 OK`.
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * const subscription =
52
+ * await client.users.subscriptions.subscribe('user_12345', {
53
+ * topic_name: 'order-updates',
54
+ * });
55
+ * ```
56
+ */
57
+ subscribe(userID, body, options) {
58
+ return this._client.post(path `/users/${userID}/subscriptions`, { body, ...options });
59
+ }
60
+ /**
61
+ * Remove a user's subscription from a topic. The user will no longer receive
62
+ * notifications triggered for this topic.
63
+ *
64
+ * @example
65
+ * ```ts
66
+ * await client.users.subscriptions.unsubscribe(
67
+ * 'order-updates',
68
+ * { user_id: 'user_12345' },
69
+ * );
70
+ * ```
71
+ */
72
+ unsubscribe(topicName, params, options) {
73
+ const { user_id } = params;
74
+ return this._client.delete(path `/users/${user_id}/subscriptions/${topicName}`, {
75
+ ...options,
76
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
77
+ });
78
+ }
79
+ }
80
+ //# sourceMappingURL=subscriptions.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"subscriptions.mjs","sourceRoot":"","sources":["../../src/resources/users/subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,UAAU,EAAsC;OAClD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,SAAiB,EACjB,MAAkC,EAClC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,kBAAkB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAc,EACd,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,UAAU,MAAM,gBAAgB,EAAE,CAAA,UAAwB,CAAA,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,MAAc,EACd,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,UAAU,MAAM,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CACT,SAAiB,EACjB,MAAqC,EACrC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,OAAO,kBAAkB,SAAS,EAAE,EAAE;YAC7E,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -0,0 +1,216 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import * as ChannelSettingsAPI from "./channel-settings.mjs";
3
+ import { ChannelSettingDeleteParams, ChannelSettingRetrieveParams, ChannelSettingUpdateParams, ChannelSettings, MobilePushSettings, SlackSettings } from "./channel-settings.mjs";
4
+ import * as DeliveriesAPI from "./deliveries.mjs";
5
+ import { Deliveries, DeliveryListParams, DeliveryRetrieveParams } from "./deliveries.mjs";
6
+ import * as NotificationsAPI from "./notifications.mjs";
7
+ import { NotificationListParams, NotificationRetrieveParams, Notifications } from "./notifications.mjs";
8
+ import * as PreferencesAPI from "./preferences.mjs";
9
+ import { PreferenceUpdateParams, Preferences, UpdatePreferencesRequest } from "./preferences.mjs";
10
+ import * as SubscriptionsAPI from "./subscriptions.mjs";
11
+ import { Subscription, SubscriptionListParams, SubscriptionRetrieveParams, SubscriptionSubscribeParams, SubscriptionUnsubscribeParams, Subscriptions, SubscriptionsCursorPage } from "./subscriptions.mjs";
12
+ import { APIPromise } from "../../core/api-promise.mjs";
13
+ import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
14
+ import { RequestOptions } from "../../internal/request-options.mjs";
15
+ export declare class Users extends APIResource {
16
+ channelSettings: ChannelSettingsAPI.ChannelSettings;
17
+ deliveries: DeliveriesAPI.Deliveries;
18
+ notifications: NotificationsAPI.Notifications;
19
+ preferences: PreferencesAPI.Preferences;
20
+ subscriptions: SubscriptionsAPI.Subscriptions;
21
+ /**
22
+ * Retrieve a single user by their external ID. The external ID is the identifier
23
+ * you assigned when creating the user.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const user = await client.users.retrieve('user_12345');
28
+ * ```
29
+ */
30
+ retrieve(id: string, options?: RequestOptions): APIPromise<User>;
31
+ /**
32
+ * Retrieve a paginated list of users in your project. Users are sorted by creation
33
+ * date (newest first).
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * // Automatically fetches more pages as needed.
38
+ * for await (const user of client.users.list()) {
39
+ * // ...
40
+ * }
41
+ * ```
42
+ */
43
+ list(query?: UserListParams | null | undefined, options?: RequestOptions): PagePromise<UsersCursorPage, User>;
44
+ /**
45
+ * Permanently delete a user and all their associated data including:
46
+ *
47
+ * - Subscriptions
48
+ * - Preferences
49
+ * - Channel settings
50
+ * - Notifications and deliveries
51
+ *
52
+ * **This action cannot be undone.**
53
+ *
54
+ * @example
55
+ * ```ts
56
+ * await client.users.delete('user_12345');
57
+ * ```
58
+ */
59
+ delete(id: string, options?: RequestOptions): APIPromise<void>;
60
+ /**
61
+ * Create a new user or update an existing user by external ID (upsert operation).
62
+ *
63
+ * - If the user doesn't exist, they will be created with the provided attributes.
64
+ * - If the user exists, their attributes will be updated (merge behavior).
65
+ * - `custom_fields` are deep-merged with existing values.
66
+ *
67
+ * **Returns:**
68
+ *
69
+ * - `201 Created` when a new user is created
70
+ * - `200 OK` when an existing user is updated
71
+ *
72
+ * @example
73
+ * ```ts
74
+ * const user = await client.users.upsert('user_12345', {
75
+ * external_id: 'user_12345',
76
+ * });
77
+ * ```
78
+ */
79
+ upsert(id: string, body: UserUpsertParams, options?: RequestOptions): APIPromise<User>;
80
+ }
81
+ export type UsersCursorPage = CursorPage<User>;
82
+ /**
83
+ * A user (recipient) in your project
84
+ */
85
+ export interface User {
86
+ /**
87
+ * Internal Notiflows user ID (UUIDv7)
88
+ */
89
+ id: string;
90
+ /**
91
+ * When the user was created (ISO 8601)
92
+ */
93
+ created_at: string;
94
+ /**
95
+ * Your system's unique identifier for this user
96
+ */
97
+ external_id: string;
98
+ /**
99
+ * When the user was last updated (ISO 8601)
100
+ */
101
+ updated_at: string;
102
+ /**
103
+ * URL to user's avatar image (must be https://)
104
+ */
105
+ avatar?: string | null;
106
+ /**
107
+ * Arbitrary JSON object for additional user attributes. Accessible in templates as
108
+ * `recipient.custom_fields.*`
109
+ */
110
+ custom_fields?: unknown | null;
111
+ /**
112
+ * User's email address for email notifications
113
+ */
114
+ email?: string | null;
115
+ /**
116
+ * User's first name for personalization
117
+ */
118
+ first_name?: string | null;
119
+ /**
120
+ * User's last name for personalization
121
+ */
122
+ last_name?: string | null;
123
+ /**
124
+ * BCP 47 locale code for localized notifications
125
+ */
126
+ locale?: string | null;
127
+ /**
128
+ * User's phone number in E.164 format for SMS notifications
129
+ */
130
+ phone?: string | null;
131
+ /**
132
+ * IANA timezone for time-sensitive notifications
133
+ */
134
+ timezone?: string | null;
135
+ }
136
+ export interface UserListParams extends CursorPageParams {
137
+ /**
138
+ * Cursor for fetching the previous page
139
+ */
140
+ before?: string;
141
+ /**
142
+ * Filter users created after this datetime (ISO 8601)
143
+ */
144
+ created_after?: string;
145
+ /**
146
+ * Filter users created before this datetime (ISO 8601)
147
+ */
148
+ created_before?: string;
149
+ }
150
+ export interface UserUpsertParams {
151
+ /**
152
+ * Your system's unique identifier for this user. Required for creating new users.
153
+ */
154
+ external_id: string;
155
+ /**
156
+ * URL to user's avatar image (must start with http:// or https://)
157
+ */
158
+ avatar?: string;
159
+ /**
160
+ * Initial channel settings (e.g., device tokens for push)
161
+ */
162
+ channel_settings?: Array<UserUpsertParams.ChannelSetting>;
163
+ /**
164
+ * Custom attributes. Deep-merged with existing values on update.
165
+ */
166
+ custom_fields?: unknown;
167
+ /**
168
+ * User's email address
169
+ */
170
+ email?: string;
171
+ /**
172
+ * User's first name
173
+ */
174
+ first_name?: string;
175
+ /**
176
+ * User's last name
177
+ */
178
+ last_name?: string;
179
+ /**
180
+ * BCP 47 locale code (e.g., en-US, es-ES, fr-FR)
181
+ */
182
+ locale?: string;
183
+ /**
184
+ * User's phone number in E.164 format
185
+ */
186
+ phone?: string;
187
+ /**
188
+ * Request body for updating user preferences. Only provided fields are updated.
189
+ */
190
+ preferences?: PreferencesAPI.UpdatePreferencesRequest;
191
+ /**
192
+ * IANA timezone (e.g., America/New_York, Europe/London)
193
+ */
194
+ timezone?: string;
195
+ }
196
+ export declare namespace UserUpsertParams {
197
+ interface ChannelSetting {
198
+ /**
199
+ * Channel ID
200
+ */
201
+ channel_id: string;
202
+ /**
203
+ * Provider-specific settings
204
+ */
205
+ settings: unknown;
206
+ }
207
+ }
208
+ export declare namespace Users {
209
+ export { type User as User, type UsersCursorPage as UsersCursorPage, type UserListParams as UserListParams, type UserUpsertParams as UserUpsertParams, };
210
+ export { type ChannelSettings as ChannelSettings, type MobilePushSettings as MobilePushSettings, type SlackSettings as SlackSettings, type ChannelSettingRetrieveParams as ChannelSettingRetrieveParams, type ChannelSettingUpdateParams as ChannelSettingUpdateParams, type ChannelSettingDeleteParams as ChannelSettingDeleteParams, };
211
+ export { Deliveries as Deliveries, type DeliveryRetrieveParams as DeliveryRetrieveParams, type DeliveryListParams as DeliveryListParams, };
212
+ export { Notifications as Notifications, type NotificationRetrieveParams as NotificationRetrieveParams, type NotificationListParams as NotificationListParams, };
213
+ export { type Preferences as Preferences, type UpdatePreferencesRequest as UpdatePreferencesRequest, type PreferenceUpdateParams as PreferenceUpdateParams, };
214
+ export { Subscriptions as Subscriptions, type Subscription as Subscription, type SubscriptionsCursorPage as SubscriptionsCursorPage, type SubscriptionRetrieveParams as SubscriptionRetrieveParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionSubscribeParams as SubscriptionSubscribeParams, type SubscriptionUnsubscribeParams as SubscriptionUnsubscribeParams, };
215
+ }
216
+ //# sourceMappingURL=users.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../../src/resources/users/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,kBAAkB;OACvB,EACL,0BAA0B,EAC1B,4BAA4B,EAC5B,0BAA0B,EAC1B,eAAe,EACf,kBAAkB,EAClB,aAAa,EACd;OACM,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE,kBAAkB,EAAE,sBAAsB,EAAE;OAC1D,KAAK,gBAAgB;OACrB,EAAE,sBAAsB,EAAE,0BAA0B,EAAE,aAAa,EAAE;OACrE,KAAK,cAAc;OACnB,EAAE,sBAAsB,EAAE,WAAW,EAAE,wBAAwB,EAAE;OACjE,KAAK,gBAAgB;OACrB,EACL,YAAY,EACZ,sBAAsB,EACtB,0BAA0B,EAC1B,2BAA2B,EAC3B,6BAA6B,EAC7B,aAAa,EACb,uBAAuB,EACxB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC,eAAe,EAAE,kBAAkB,CAAC,eAAe,CAAwD;IAC3G,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAClF,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IACjG,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IAEjG;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,eAAe,EAAE,IAAI,CAAC;IAIrC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAGvF;AAED,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;IAE1D;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,wBAAwB,CAAC;IAEtD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,cAAc;QAC7B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC;KACnB;CACF;AAMD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}