@stigg/typescript 0.1.0-alpha.3 → 0.1.0-alpha.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (456) hide show
  1. package/CHANGELOG.md +398 -0
  2. package/README.md +9 -0
  3. package/client.d.mts +10 -9
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +10 -9
  6. package/client.d.ts.map +1 -1
  7. package/client.js +32 -26
  8. package/client.js.map +1 -1
  9. package/client.mjs +33 -27
  10. package/client.mjs.map +1 -1
  11. package/internal/parse.d.mts.map +1 -1
  12. package/internal/parse.d.ts.map +1 -1
  13. package/internal/parse.js +5 -0
  14. package/internal/parse.js.map +1 -1
  15. package/internal/parse.mjs +5 -0
  16. package/internal/parse.mjs.map +1 -1
  17. package/internal/qs/formats.d.mts +7 -0
  18. package/internal/qs/formats.d.mts.map +1 -0
  19. package/internal/qs/formats.d.ts +7 -0
  20. package/internal/qs/formats.d.ts.map +1 -0
  21. package/internal/qs/formats.js +13 -0
  22. package/internal/qs/formats.js.map +1 -0
  23. package/internal/qs/formats.mjs +9 -0
  24. package/internal/qs/formats.mjs.map +1 -0
  25. package/internal/qs/index.d.mts +10 -0
  26. package/internal/qs/index.d.mts.map +1 -0
  27. package/internal/qs/index.d.ts +10 -0
  28. package/internal/qs/index.d.ts.map +1 -0
  29. package/internal/qs/index.js +14 -0
  30. package/internal/qs/index.js.map +1 -0
  31. package/internal/qs/index.mjs +10 -0
  32. package/internal/qs/index.mjs.map +1 -0
  33. package/internal/qs/stringify.d.mts +3 -0
  34. package/internal/qs/stringify.d.mts.map +1 -0
  35. package/internal/qs/stringify.d.ts +3 -0
  36. package/internal/qs/stringify.d.ts.map +1 -0
  37. package/internal/qs/stringify.js +277 -0
  38. package/internal/qs/stringify.js.map +1 -0
  39. package/internal/qs/stringify.mjs +274 -0
  40. package/internal/qs/stringify.mjs.map +1 -0
  41. package/internal/qs/types.d.mts +57 -0
  42. package/internal/qs/types.d.mts.map +1 -0
  43. package/internal/qs/types.d.ts +57 -0
  44. package/internal/qs/types.d.ts.map +1 -0
  45. package/internal/qs/types.js +3 -0
  46. package/internal/qs/types.js.map +1 -0
  47. package/internal/qs/types.mjs +2 -0
  48. package/internal/qs/types.mjs.map +1 -0
  49. package/internal/qs/utils.d.mts +15 -0
  50. package/internal/qs/utils.d.mts.map +1 -0
  51. package/internal/qs/utils.d.ts +15 -0
  52. package/internal/qs/utils.d.ts.map +1 -0
  53. package/internal/qs/utils.js +230 -0
  54. package/internal/qs/utils.js.map +1 -0
  55. package/internal/qs/utils.mjs +217 -0
  56. package/internal/qs/utils.mjs.map +1 -0
  57. package/internal/tslib.js +17 -17
  58. package/internal/utils/env.js +2 -2
  59. package/internal/utils/env.js.map +1 -1
  60. package/internal/utils/env.mjs +2 -2
  61. package/internal/utils/env.mjs.map +1 -1
  62. package/internal/utils/query.d.mts +2 -0
  63. package/internal/utils/query.d.mts.map +1 -0
  64. package/internal/utils/query.d.ts +2 -0
  65. package/internal/utils/query.d.ts.map +1 -0
  66. package/internal/utils/query.js +10 -0
  67. package/internal/utils/query.js.map +1 -0
  68. package/internal/utils/query.mjs +6 -0
  69. package/internal/utils/query.mjs.map +1 -0
  70. package/internal/utils.d.mts +1 -0
  71. package/internal/utils.d.ts +1 -0
  72. package/internal/utils.js +1 -0
  73. package/internal/utils.js.map +1 -1
  74. package/internal/utils.mjs +1 -0
  75. package/package.json +12 -1
  76. package/resources/index.d.mts +2 -1
  77. package/resources/index.d.mts.map +1 -1
  78. package/resources/index.d.ts +2 -1
  79. package/resources/index.d.ts.map +1 -1
  80. package/resources/index.js +3 -1
  81. package/resources/index.js.map +1 -1
  82. package/resources/index.mjs +2 -1
  83. package/resources/index.mjs.map +1 -1
  84. package/resources/internal/beta/beta.d.mts +10 -0
  85. package/resources/internal/beta/beta.d.mts.map +1 -0
  86. package/resources/internal/beta/beta.d.ts +10 -0
  87. package/resources/internal/beta/beta.d.ts.map +1 -0
  88. package/resources/internal/beta/beta.js +17 -0
  89. package/resources/internal/beta/beta.js.map +1 -0
  90. package/resources/internal/beta/beta.mjs +12 -0
  91. package/resources/internal/beta/beta.mjs.map +1 -0
  92. package/resources/internal/beta/event-queues.d.mts +171 -0
  93. package/resources/internal/beta/event-queues.d.mts.map +1 -0
  94. package/resources/internal/beta/event-queues.d.ts +171 -0
  95. package/resources/internal/beta/event-queues.d.ts.map +1 -0
  96. package/resources/internal/beta/event-queues.js +40 -0
  97. package/resources/internal/beta/event-queues.js.map +1 -0
  98. package/resources/internal/beta/event-queues.mjs +36 -0
  99. package/resources/internal/beta/event-queues.mjs.map +1 -0
  100. package/resources/internal/beta/index.d.mts +3 -0
  101. package/resources/internal/beta/index.d.mts.map +1 -0
  102. package/resources/internal/beta/index.d.ts +3 -0
  103. package/resources/internal/beta/index.d.ts.map +1 -0
  104. package/resources/internal/beta/index.js +9 -0
  105. package/resources/internal/beta/index.js.map +1 -0
  106. package/resources/internal/beta/index.mjs +4 -0
  107. package/resources/internal/beta/index.mjs.map +1 -0
  108. package/resources/internal/beta.d.mts +2 -0
  109. package/resources/internal/beta.d.mts.map +1 -0
  110. package/resources/internal/beta.d.ts +2 -0
  111. package/resources/internal/beta.d.ts.map +1 -0
  112. package/resources/internal/beta.js +6 -0
  113. package/resources/internal/beta.js.map +1 -0
  114. package/resources/internal/beta.mjs +3 -0
  115. package/resources/internal/beta.mjs.map +1 -0
  116. package/resources/internal/index.d.mts +3 -0
  117. package/resources/internal/index.d.mts.map +1 -0
  118. package/resources/internal/index.d.ts +3 -0
  119. package/resources/internal/index.d.ts.map +1 -0
  120. package/resources/internal/index.js +9 -0
  121. package/resources/internal/index.js.map +1 -0
  122. package/resources/internal/index.mjs +4 -0
  123. package/resources/internal/index.mjs.map +1 -0
  124. package/resources/internal/internal.d.mts +10 -0
  125. package/resources/internal/internal.d.mts.map +1 -0
  126. package/resources/internal/internal.d.ts +10 -0
  127. package/resources/internal/internal.d.ts.map +1 -0
  128. package/resources/internal/internal.js +17 -0
  129. package/resources/internal/internal.js.map +1 -0
  130. package/resources/internal/internal.mjs +12 -0
  131. package/resources/internal/internal.mjs.map +1 -0
  132. package/resources/internal.d.mts +2 -0
  133. package/resources/internal.d.mts.map +1 -0
  134. package/resources/internal.d.ts +2 -0
  135. package/resources/internal.d.ts.map +1 -0
  136. package/resources/internal.js +6 -0
  137. package/resources/internal.js.map +1 -0
  138. package/resources/internal.mjs +3 -0
  139. package/resources/internal.mjs.map +1 -0
  140. package/resources/v1/addons/addons.d.mts +828 -0
  141. package/resources/v1/addons/addons.d.mts.map +1 -0
  142. package/resources/v1/addons/addons.d.ts +828 -0
  143. package/resources/v1/addons/addons.d.ts.map +1 -0
  144. package/resources/v1/addons/addons.js +75 -0
  145. package/resources/v1/addons/addons.js.map +1 -0
  146. package/resources/v1/addons/addons.mjs +70 -0
  147. package/resources/v1/addons/addons.mjs.map +1 -0
  148. package/resources/v1/addons/entitlements.d.mts +888 -0
  149. package/resources/v1/addons/entitlements.d.mts.map +1 -0
  150. package/resources/v1/addons/entitlements.d.ts +888 -0
  151. package/resources/v1/addons/entitlements.d.ts.map +1 -0
  152. package/resources/v1/addons/entitlements.js +36 -0
  153. package/resources/v1/addons/entitlements.js.map +1 -0
  154. package/resources/v1/addons/entitlements.mjs +32 -0
  155. package/resources/v1/addons/entitlements.mjs.map +1 -0
  156. package/resources/v1/addons/index.d.mts +3 -0
  157. package/resources/v1/addons/index.d.mts.map +1 -0
  158. package/resources/v1/addons/index.d.ts +3 -0
  159. package/resources/v1/addons/index.d.ts.map +1 -0
  160. package/resources/v1/addons/index.js +9 -0
  161. package/resources/v1/addons/index.js.map +1 -0
  162. package/resources/v1/addons/index.mjs +4 -0
  163. package/resources/v1/addons/index.mjs.map +1 -0
  164. package/resources/v1/addons.d.mts +2 -0
  165. package/resources/v1/addons.d.mts.map +1 -0
  166. package/resources/v1/addons.d.ts +2 -0
  167. package/resources/v1/addons.d.ts.map +1 -0
  168. package/resources/v1/addons.js +6 -0
  169. package/resources/v1/addons.js.map +1 -0
  170. package/resources/v1/addons.mjs +3 -0
  171. package/resources/v1/addons.mjs.map +1 -0
  172. package/resources/v1/coupons.d.mts +94 -96
  173. package/resources/v1/coupons.d.mts.map +1 -1
  174. package/resources/v1/coupons.d.ts +94 -96
  175. package/resources/v1/coupons.d.ts.map +1 -1
  176. package/resources/v1/coupons.js +19 -3
  177. package/resources/v1/coupons.js.map +1 -1
  178. package/resources/v1/coupons.mjs +19 -3
  179. package/resources/v1/coupons.mjs.map +1 -1
  180. package/resources/v1/customers/customers.d.mts +1214 -48
  181. package/resources/v1/customers/customers.d.mts.map +1 -1
  182. package/resources/v1/customers/customers.d.ts +1214 -48
  183. package/resources/v1/customers/customers.d.ts.map +1 -1
  184. package/resources/v1/customers/customers.js +48 -15
  185. package/resources/v1/customers/customers.js.map +1 -1
  186. package/resources/v1/customers/customers.mjs +48 -15
  187. package/resources/v1/customers/customers.mjs.map +1 -1
  188. package/resources/v1/customers/index.d.mts +3 -2
  189. package/resources/v1/customers/index.d.mts.map +1 -1
  190. package/resources/v1/customers/index.d.ts +3 -2
  191. package/resources/v1/customers/index.d.ts.map +1 -1
  192. package/resources/v1/customers/index.js +5 -3
  193. package/resources/v1/customers/index.js.map +1 -1
  194. package/resources/v1/customers/index.mjs +2 -1
  195. package/resources/v1/customers/index.mjs.map +1 -1
  196. package/resources/v1/customers/integrations.d.mts +142 -0
  197. package/resources/v1/customers/integrations.d.mts.map +1 -0
  198. package/resources/v1/customers/integrations.d.ts +142 -0
  199. package/resources/v1/customers/integrations.d.ts.map +1 -0
  200. package/resources/v1/customers/integrations.js +50 -0
  201. package/resources/v1/customers/integrations.js.map +1 -0
  202. package/resources/v1/customers/integrations.mjs +46 -0
  203. package/resources/v1/customers/integrations.mjs.map +1 -0
  204. package/resources/v1/customers/payment-method.d.mts +7 -2
  205. package/resources/v1/customers/payment-method.d.mts.map +1 -1
  206. package/resources/v1/customers/payment-method.d.ts +7 -2
  207. package/resources/v1/customers/payment-method.d.ts.map +1 -1
  208. package/resources/v1/customers/payment-method.js +7 -2
  209. package/resources/v1/customers/payment-method.js.map +1 -1
  210. package/resources/v1/customers/payment-method.mjs +7 -2
  211. package/resources/v1/customers/payment-method.mjs.map +1 -1
  212. package/resources/v1/customers/promotional-entitlements.d.mts +501 -0
  213. package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -0
  214. package/resources/v1/customers/promotional-entitlements.d.ts +501 -0
  215. package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -0
  216. package/resources/v1/customers/promotional-entitlements.js +35 -0
  217. package/resources/v1/customers/promotional-entitlements.js.map +1 -0
  218. package/resources/v1/customers/promotional-entitlements.mjs +31 -0
  219. package/resources/v1/customers/promotional-entitlements.mjs.map +1 -0
  220. package/resources/v1/events/credits/credits.d.mts +260 -0
  221. package/resources/v1/events/credits/credits.d.mts.map +1 -0
  222. package/resources/v1/events/credits/credits.d.ts +260 -0
  223. package/resources/v1/events/credits/credits.d.ts.map +1 -0
  224. package/resources/v1/events/credits/credits.js +41 -0
  225. package/resources/v1/events/credits/credits.js.map +1 -0
  226. package/resources/v1/events/credits/credits.mjs +36 -0
  227. package/resources/v1/events/credits/credits.mjs.map +1 -0
  228. package/resources/v1/events/credits/grants.d.mts +549 -0
  229. package/resources/v1/events/credits/grants.d.mts.map +1 -0
  230. package/resources/v1/events/credits/grants.d.ts +549 -0
  231. package/resources/v1/events/credits/grants.d.ts.map +1 -0
  232. package/resources/v1/events/credits/grants.js +37 -0
  233. package/resources/v1/events/credits/grants.js.map +1 -0
  234. package/resources/v1/events/credits/grants.mjs +33 -0
  235. package/resources/v1/events/credits/grants.mjs.map +1 -0
  236. package/resources/v1/events/credits/index.d.mts +3 -0
  237. package/resources/v1/events/credits/index.d.mts.map +1 -0
  238. package/resources/v1/events/credits/index.d.ts +3 -0
  239. package/resources/v1/events/credits/index.d.ts.map +1 -0
  240. package/resources/v1/events/credits/index.js +9 -0
  241. package/resources/v1/events/credits/index.js.map +1 -0
  242. package/resources/v1/events/credits/index.mjs +4 -0
  243. package/resources/v1/events/credits/index.mjs.map +1 -0
  244. package/resources/v1/events/credits.d.mts +2 -0
  245. package/resources/v1/events/credits.d.mts.map +1 -0
  246. package/resources/v1/events/credits.d.ts +2 -0
  247. package/resources/v1/events/credits.d.ts.map +1 -0
  248. package/resources/v1/events/credits.js +6 -0
  249. package/resources/v1/events/credits.js.map +1 -0
  250. package/resources/v1/events/credits.mjs +3 -0
  251. package/resources/v1/events/credits.mjs.map +1 -0
  252. package/resources/v1/events/events.d.mts +70 -0
  253. package/resources/v1/events/events.d.mts.map +1 -0
  254. package/resources/v1/events/events.d.ts +70 -0
  255. package/resources/v1/events/events.d.ts.map +1 -0
  256. package/resources/v1/events/events.js +27 -0
  257. package/resources/v1/events/events.js.map +1 -0
  258. package/resources/v1/events/events.mjs +22 -0
  259. package/resources/v1/events/events.mjs.map +1 -0
  260. package/resources/v1/events/index.d.mts +3 -0
  261. package/resources/v1/events/index.d.mts.map +1 -0
  262. package/resources/v1/events/index.d.ts +3 -0
  263. package/resources/v1/events/index.d.ts.map +1 -0
  264. package/resources/v1/events/index.js +9 -0
  265. package/resources/v1/events/index.js.map +1 -0
  266. package/resources/v1/events/index.mjs +4 -0
  267. package/resources/v1/events/index.mjs.map +1 -0
  268. package/resources/v1/events.d.mts +2 -0
  269. package/resources/v1/events.d.mts.map +1 -0
  270. package/resources/v1/events.d.ts +2 -0
  271. package/resources/v1/events.d.ts.map +1 -0
  272. package/resources/v1/events.js +6 -0
  273. package/resources/v1/events.js.map +1 -0
  274. package/resources/v1/events.mjs +3 -0
  275. package/resources/v1/events.mjs.map +1 -0
  276. package/resources/v1/features.d.mts +456 -0
  277. package/resources/v1/features.d.mts.map +1 -0
  278. package/resources/v1/features.d.ts +456 -0
  279. package/resources/v1/features.d.ts.map +1 -0
  280. package/resources/v1/features.js +54 -0
  281. package/resources/v1/features.js.map +1 -0
  282. package/resources/v1/features.mjs +50 -0
  283. package/resources/v1/features.mjs.map +1 -0
  284. package/resources/v1/index.d.mts +10 -4
  285. package/resources/v1/index.d.mts.map +1 -1
  286. package/resources/v1/index.d.ts +10 -4
  287. package/resources/v1/index.d.ts.map +1 -1
  288. package/resources/v1/index.js +17 -5
  289. package/resources/v1/index.js.map +1 -1
  290. package/resources/v1/index.mjs +7 -1
  291. package/resources/v1/index.mjs.map +1 -1
  292. package/resources/v1/plans/entitlements.d.mts +888 -0
  293. package/resources/v1/plans/entitlements.d.mts.map +1 -0
  294. package/resources/v1/plans/entitlements.d.ts +888 -0
  295. package/resources/v1/plans/entitlements.d.ts.map +1 -0
  296. package/resources/v1/plans/entitlements.js +36 -0
  297. package/resources/v1/plans/entitlements.js.map +1 -0
  298. package/resources/v1/plans/entitlements.mjs +32 -0
  299. package/resources/v1/plans/entitlements.mjs.map +1 -0
  300. package/resources/v1/plans/index.d.mts +3 -0
  301. package/resources/v1/plans/index.d.mts.map +1 -0
  302. package/resources/v1/plans/index.d.ts +3 -0
  303. package/resources/v1/plans/index.d.ts.map +1 -0
  304. package/resources/v1/plans/index.js +9 -0
  305. package/resources/v1/plans/index.js.map +1 -0
  306. package/resources/v1/plans/index.mjs +4 -0
  307. package/resources/v1/plans/index.mjs.map +1 -0
  308. package/resources/v1/plans/plans.d.mts +977 -0
  309. package/resources/v1/plans/plans.d.mts.map +1 -0
  310. package/resources/v1/plans/plans.d.ts +977 -0
  311. package/resources/v1/plans/plans.d.ts.map +1 -0
  312. package/resources/v1/plans/plans.js +72 -0
  313. package/resources/v1/plans/plans.js.map +1 -0
  314. package/resources/v1/plans/plans.mjs +67 -0
  315. package/resources/v1/plans/plans.mjs.map +1 -0
  316. package/resources/v1/plans.d.mts +2 -0
  317. package/resources/v1/plans.d.mts.map +1 -0
  318. package/resources/v1/plans.d.ts +2 -0
  319. package/resources/v1/plans.d.ts.map +1 -0
  320. package/resources/v1/plans.js +6 -0
  321. package/resources/v1/plans.js.map +1 -0
  322. package/resources/v1/plans.mjs +3 -0
  323. package/resources/v1/plans.mjs.map +1 -0
  324. package/resources/v1/products.d.mts +339 -0
  325. package/resources/v1/products.d.mts.map +1 -0
  326. package/resources/v1/products.d.ts +339 -0
  327. package/resources/v1/products.d.ts.map +1 -0
  328. package/resources/v1/products.js +55 -0
  329. package/resources/v1/products.js.map +1 -0
  330. package/resources/v1/products.mjs +51 -0
  331. package/resources/v1/products.mjs.map +1 -0
  332. package/resources/v1/subscriptions/future-update.d.mts +12 -22
  333. package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
  334. package/resources/v1/subscriptions/future-update.d.ts +12 -22
  335. package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
  336. package/resources/v1/subscriptions/future-update.js +6 -2
  337. package/resources/v1/subscriptions/future-update.js.map +1 -1
  338. package/resources/v1/subscriptions/future-update.mjs +6 -2
  339. package/resources/v1/subscriptions/future-update.mjs.map +1 -1
  340. package/resources/v1/subscriptions/index.d.mts +4 -2
  341. package/resources/v1/subscriptions/index.d.mts.map +1 -1
  342. package/resources/v1/subscriptions/index.d.ts +4 -2
  343. package/resources/v1/subscriptions/index.d.ts.map +1 -1
  344. package/resources/v1/subscriptions/index.js +5 -1
  345. package/resources/v1/subscriptions/index.js.map +1 -1
  346. package/resources/v1/subscriptions/index.mjs +3 -1
  347. package/resources/v1/subscriptions/index.mjs.map +1 -1
  348. package/resources/v1/subscriptions/invoice.d.mts +37 -0
  349. package/resources/v1/subscriptions/invoice.d.mts.map +1 -0
  350. package/resources/v1/subscriptions/invoice.d.ts +37 -0
  351. package/resources/v1/subscriptions/invoice.d.ts.map +1 -0
  352. package/resources/v1/subscriptions/invoice.js +20 -0
  353. package/resources/v1/subscriptions/invoice.js.map +1 -0
  354. package/resources/v1/subscriptions/invoice.mjs +16 -0
  355. package/resources/v1/subscriptions/invoice.mjs.map +1 -0
  356. package/resources/v1/subscriptions/subscriptions.d.mts +1926 -915
  357. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  358. package/resources/v1/subscriptions/subscriptions.d.ts +1926 -915
  359. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  360. package/resources/v1/subscriptions/subscriptions.js +47 -11
  361. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  362. package/resources/v1/subscriptions/subscriptions.mjs +49 -13
  363. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  364. package/resources/v1/subscriptions/usage.d.mts +101 -0
  365. package/resources/v1/subscriptions/usage.d.mts.map +1 -0
  366. package/resources/v1/subscriptions/usage.d.ts +101 -0
  367. package/resources/v1/subscriptions/usage.d.ts.map +1 -0
  368. package/resources/v1/subscriptions/usage.js +27 -0
  369. package/resources/v1/subscriptions/usage.js.map +1 -0
  370. package/resources/v1/subscriptions/usage.mjs +23 -0
  371. package/resources/v1/subscriptions/usage.mjs.map +1 -0
  372. package/resources/v1/usage.d.mts +233 -0
  373. package/resources/v1/usage.d.mts.map +1 -0
  374. package/resources/v1/usage.d.ts +233 -0
  375. package/resources/v1/usage.d.ts.map +1 -0
  376. package/resources/v1/usage.js +27 -0
  377. package/resources/v1/usage.js.map +1 -0
  378. package/resources/v1/usage.mjs +23 -0
  379. package/resources/v1/usage.mjs.map +1 -0
  380. package/resources/v1/v1.d.mts +30 -172
  381. package/resources/v1/v1.d.mts.map +1 -1
  382. package/resources/v1/v1.d.ts +30 -172
  383. package/resources/v1/v1.d.ts.map +1 -1
  384. package/resources/v1/v1.js +24 -12
  385. package/resources/v1/v1.js.map +1 -1
  386. package/resources/v1/v1.mjs +24 -12
  387. package/resources/v1/v1.mjs.map +1 -1
  388. package/src/client.ts +46 -47
  389. package/src/internal/parse.ts +6 -0
  390. package/src/internal/qs/LICENSE.md +13 -0
  391. package/src/internal/qs/README.md +3 -0
  392. package/src/internal/qs/formats.ts +10 -0
  393. package/src/internal/qs/index.ts +13 -0
  394. package/src/internal/qs/stringify.ts +385 -0
  395. package/src/internal/qs/types.ts +71 -0
  396. package/src/internal/qs/utils.ts +265 -0
  397. package/src/internal/utils/env.ts +2 -2
  398. package/src/internal/utils/query.ts +7 -0
  399. package/src/internal/utils.ts +1 -0
  400. package/src/resources/index.ts +2 -7
  401. package/src/resources/internal/beta/beta.ts +27 -0
  402. package/src/resources/internal/beta/event-queues.ts +554 -0
  403. package/src/resources/internal/beta/index.ts +10 -0
  404. package/src/resources/internal/beta.ts +3 -0
  405. package/src/resources/internal/index.ts +4 -0
  406. package/src/resources/internal/internal.ts +15 -0
  407. package/src/resources/internal.ts +3 -0
  408. package/src/resources/v1/addons/addons.ts +1856 -0
  409. package/src/resources/v1/addons/entitlements.ts +1153 -0
  410. package/src/resources/v1/addons/index.ts +23 -0
  411. package/src/resources/v1/addons.ts +3 -0
  412. package/src/resources/v1/coupons.ts +106 -229
  413. package/src/resources/v1/customers/customers.ts +2465 -60
  414. package/src/resources/v1/customers/index.ts +29 -2
  415. package/src/resources/v1/customers/integrations.ts +241 -0
  416. package/src/resources/v1/customers/payment-method.ts +7 -2
  417. package/src/resources/v1/customers/promotional-entitlements.ts +672 -0
  418. package/src/resources/v1/events/credits/credits.ts +358 -0
  419. package/src/resources/v1/events/credits/grants.ts +795 -0
  420. package/src/resources/v1/events/credits/index.ts +20 -0
  421. package/src/resources/v1/events/credits.ts +3 -0
  422. package/src/resources/v1/events/events.ts +103 -0
  423. package/src/resources/v1/events/index.ts +13 -0
  424. package/src/resources/v1/events.ts +3 -0
  425. package/src/resources/v1/features.ts +583 -0
  426. package/src/resources/v1/index.ts +69 -15
  427. package/src/resources/v1/plans/entitlements.ts +1145 -0
  428. package/src/resources/v1/plans/index.ts +23 -0
  429. package/src/resources/v1/plans/plans.ts +2029 -0
  430. package/src/resources/v1/plans.ts +3 -0
  431. package/src/resources/v1/products.ts +430 -0
  432. package/src/resources/v1/subscriptions/future-update.ts +12 -30
  433. package/src/resources/v1/subscriptions/index.ts +15 -11
  434. package/src/resources/v1/subscriptions/invoice.ts +45 -0
  435. package/src/resources/v1/subscriptions/subscriptions.ts +5302 -2289
  436. package/src/resources/v1/subscriptions/usage.ts +129 -0
  437. package/src/resources/v1/usage.ts +287 -0
  438. package/src/resources/v1/v1.ts +166 -220
  439. package/src/version.ts +1 -1
  440. package/version.d.mts +1 -1
  441. package/version.d.mts.map +1 -1
  442. package/version.d.ts +1 -1
  443. package/version.d.ts.map +1 -1
  444. package/version.js +1 -1
  445. package/version.js.map +1 -1
  446. package/version.mjs +1 -1
  447. package/version.mjs.map +1 -1
  448. package/resources/v1/customers/usage.d.mts +0 -4
  449. package/resources/v1/customers/usage.d.mts.map +0 -1
  450. package/resources/v1/customers/usage.d.ts +0 -4
  451. package/resources/v1/customers/usage.d.ts.map +0 -1
  452. package/resources/v1/customers/usage.js +0 -9
  453. package/resources/v1/customers/usage.js.map +0 -1
  454. package/resources/v1/customers/usage.mjs +0 -5
  455. package/resources/v1/customers/usage.mjs.map +0 -1
  456. package/src/resources/v1/customers/usage.ts +0 -5
@@ -1,10 +1,30 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  import { APIResource } from '../../../core/resource';
4
+ import * as IntegrationsAPI from './integrations';
5
+ import {
6
+ IntegrationLinkParams,
7
+ IntegrationListParams,
8
+ IntegrationListResponse,
9
+ IntegrationListResponsesMyCursorIDPage,
10
+ IntegrationRetrieveParams,
11
+ IntegrationUnlinkParams,
12
+ IntegrationUpdateParams,
13
+ Integrations,
14
+ } from './integrations';
4
15
  import * as PaymentMethodAPI from './payment-method';
5
16
  import { PaymentMethod, PaymentMethodAttachParams } from './payment-method';
6
- import * as UsageAPI from './usage';
7
- import { Usage } from './usage';
17
+ import * as PromotionalEntitlementsAPI from './promotional-entitlements';
18
+ import {
19
+ PromotionalEntitlementCreateParams,
20
+ PromotionalEntitlementCreateResponse,
21
+ PromotionalEntitlementListParams,
22
+ PromotionalEntitlementListResponse,
23
+ PromotionalEntitlementListResponsesMyCursorIDPage,
24
+ PromotionalEntitlementRevokeParams,
25
+ PromotionalEntitlementRevokeResponse,
26
+ PromotionalEntitlements,
27
+ } from './promotional-entitlements';
8
28
  import { APIPromise } from '../../../core/api-promise';
9
29
  import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
10
30
  import { RequestOptions } from '../../../internal/request-options';
@@ -12,31 +32,28 @@ import { path } from '../../../internal/utils/path';
12
32
 
13
33
  export class Customers extends APIResource {
14
34
  paymentMethod: PaymentMethodAPI.PaymentMethod = new PaymentMethodAPI.PaymentMethod(this._client);
15
- usage: UsageAPI.Usage = new UsageAPI.Usage(this._client);
35
+ promotionalEntitlements: PromotionalEntitlementsAPI.PromotionalEntitlements =
36
+ new PromotionalEntitlementsAPI.PromotionalEntitlements(this._client);
37
+ integrations: IntegrationsAPI.Integrations = new IntegrationsAPI.Integrations(this._client);
16
38
 
17
39
  /**
18
- * Provision customer
19
- */
20
- create(body: CustomerCreateParams, options?: RequestOptions): APIPromise<CustomerResponse> {
21
- return this._client.post('/api/v1/customers', { body, ...options });
22
- }
23
-
24
- /**
25
- * Get a single customer by ID
40
+ * Retrieves a customer by their unique identifier, including billing information
41
+ * and subscription status.
26
42
  */
27
43
  retrieve(id: string, options?: RequestOptions): APIPromise<CustomerResponse> {
28
44
  return this._client.get(path`/api/v1/customers/${id}`, options);
29
45
  }
30
46
 
31
47
  /**
32
- * Update a customer
48
+ * Updates an existing customer's properties such as name, email, and billing
49
+ * information.
33
50
  */
34
51
  update(id: string, body: CustomerUpdateParams, options?: RequestOptions): APIPromise<CustomerResponse> {
35
52
  return this._client.patch(path`/api/v1/customers/${id}`, { body, ...options });
36
53
  }
37
54
 
38
55
  /**
39
- * Get a list of customers
56
+ * Retrieves a paginated list of customers in the environment.
40
57
  */
41
58
  list(
42
59
  query: CustomerListParams | null | undefined = {},
@@ -49,14 +66,63 @@ export class Customers extends APIResource {
49
66
  }
50
67
 
51
68
  /**
52
- * Archive customer
69
+ * Archives a customer, preventing new subscriptions. Optionally cancels existing
70
+ * subscriptions.
53
71
  */
54
72
  archive(id: string, options?: RequestOptions): APIPromise<CustomerResponse> {
55
73
  return this._client.post(path`/api/v1/customers/${id}/archive`, options);
56
74
  }
57
75
 
58
76
  /**
59
- * Unarchive customer
77
+ * Imports multiple customers in bulk. Used for migrating customer data from
78
+ * external systems.
79
+ */
80
+ import(body: CustomerImportParams, options?: RequestOptions): APIPromise<CustomerImportResponse> {
81
+ return this._client.post('/api/v1/customers/import', { body, ...options });
82
+ }
83
+
84
+ /**
85
+ * Retrieves a paginated list of resources within the same customer.
86
+ */
87
+ listResources(
88
+ id: string,
89
+ query: CustomerListResourcesParams | null | undefined = {},
90
+ options?: RequestOptions,
91
+ ): PagePromise<CustomerListResourcesResponsesMyCursorIDPage, CustomerListResourcesResponse> {
92
+ return this._client.getAPIList(
93
+ path`/api/v1/customers/${id}/resources`,
94
+ MyCursorIDPage<CustomerListResourcesResponse>,
95
+ { query, ...options },
96
+ );
97
+ }
98
+
99
+ /**
100
+ * Creates a new customer and optionally provisions an initial subscription in a
101
+ * single operation.
102
+ */
103
+ provision(body: CustomerProvisionParams, options?: RequestOptions): APIPromise<CustomerResponse> {
104
+ return this._client.post('/api/v1/customers', { body, ...options });
105
+ }
106
+
107
+ /**
108
+ * Retrieves the effective entitlements for a customer or resource, including
109
+ * feature and credit entitlements.
110
+ *
111
+ * **Warning:** This REST API endpoint lacks built-in client-side caching, fallback
112
+ * mechanisms, and low-latency guarantees. It is not recommended for hot-path
113
+ * entitlement checks. For production use, consider using the Stigg Node Server SDK
114
+ * with caching or the Sidecar for low-latency cached responses.
115
+ */
116
+ retrieveEntitlements(
117
+ id: string,
118
+ query: CustomerRetrieveEntitlementsParams | null | undefined = {},
119
+ options?: RequestOptions,
120
+ ): APIPromise<CustomerRetrieveEntitlementsResponse> {
121
+ return this._client.get(path`/api/v1/customers/${id}/entitlements`, { query, ...options });
122
+ }
123
+
124
+ /**
125
+ * Restores an archived customer, allowing them to create new subscriptions again.
60
126
  */
61
127
  unarchive(id: string, options?: RequestOptions): APIPromise<CustomerResponse> {
62
128
  return this._client.post(path`/api/v1/customers/${id}/unarchive`, options);
@@ -65,6 +131,108 @@ export class Customers extends APIResource {
65
131
 
66
132
  export type CustomerListResponsesMyCursorIDPage = MyCursorIDPage<CustomerListResponse>;
67
133
 
134
+ export type CustomerListResourcesResponsesMyCursorIDPage = MyCursorIDPage<CustomerListResourcesResponse>;
135
+
136
+ /**
137
+ * Response object
138
+ */
139
+ export interface CustomerIntegrationResponse {
140
+ /**
141
+ * External billing or CRM integration link
142
+ */
143
+ data: CustomerIntegrationResponse.Data;
144
+ }
145
+
146
+ export namespace CustomerIntegrationResponse {
147
+ /**
148
+ * External billing or CRM integration link
149
+ */
150
+ export interface Data {
151
+ /**
152
+ * Integration details
153
+ */
154
+ id: string;
155
+
156
+ /**
157
+ * Synced entity id
158
+ */
159
+ syncedEntityId: string | null;
160
+
161
+ /**
162
+ * The vendor identifier of integration
163
+ */
164
+ vendorIdentifier:
165
+ | 'AUTH0'
166
+ | 'ZUORA'
167
+ | 'STRIPE'
168
+ | 'HUBSPOT'
169
+ | 'AWS_MARKETPLACE'
170
+ | 'SNOWFLAKE'
171
+ | 'SALESFORCE'
172
+ | 'BIG_QUERY'
173
+ | 'OPEN_FGA'
174
+ | 'APP_STORE';
175
+
176
+ /**
177
+ * Price billing sync revision data containing billing ID, link URL, and price
178
+ * group package billing ID
179
+ */
180
+ syncData?:
181
+ | Data.SyncRevisionPriceBillingData
182
+ | Data.SyncRevisionBillingData
183
+ | Data.SyncRevisionMarketplaceData
184
+ | null;
185
+ }
186
+
187
+ export namespace Data {
188
+ /**
189
+ * Price billing sync revision data containing billing ID, link URL, and price
190
+ * group package billing ID
191
+ */
192
+ export interface SyncRevisionPriceBillingData {
193
+ /**
194
+ * Billing integration id
195
+ */
196
+ billingId: string;
197
+
198
+ /**
199
+ * Billing integration url
200
+ */
201
+ billingLinkUrl: string;
202
+
203
+ /**
204
+ * Price group package billing id
205
+ */
206
+ priceGroupPackageBillingId: string;
207
+ }
208
+
209
+ /**
210
+ * Billing sync revision data containing billing ID and link URL
211
+ */
212
+ export interface SyncRevisionBillingData {
213
+ /**
214
+ * Billing integration id
215
+ */
216
+ billingId: string;
217
+
218
+ /**
219
+ * Billing integration url
220
+ */
221
+ billingLinkUrl: string;
222
+ }
223
+
224
+ /**
225
+ * Marketplace sync revision data containing dimensions
226
+ */
227
+ export interface SyncRevisionMarketplaceData {
228
+ /**
229
+ * Dimensions of the marketplace sync revision
230
+ */
231
+ dimensions: string;
232
+ }
233
+ }
234
+ }
235
+
68
236
  /**
69
237
  * Response object
70
238
  */
@@ -100,10 +268,137 @@ export namespace CustomerResponse {
100
268
  */
101
269
  updatedAt: string;
102
270
 
271
+ /**
272
+ * The billing currency of the customer
273
+ */
274
+ billingCurrency?:
275
+ | 'usd'
276
+ | 'aed'
277
+ | 'all'
278
+ | 'amd'
279
+ | 'ang'
280
+ | 'aud'
281
+ | 'awg'
282
+ | 'azn'
283
+ | 'bam'
284
+ | 'bbd'
285
+ | 'bdt'
286
+ | 'bgn'
287
+ | 'bif'
288
+ | 'bmd'
289
+ | 'bnd'
290
+ | 'bsd'
291
+ | 'bwp'
292
+ | 'byn'
293
+ | 'bzd'
294
+ | 'brl'
295
+ | 'cad'
296
+ | 'cdf'
297
+ | 'chf'
298
+ | 'cny'
299
+ | 'czk'
300
+ | 'dkk'
301
+ | 'dop'
302
+ | 'dzd'
303
+ | 'egp'
304
+ | 'etb'
305
+ | 'eur'
306
+ | 'fjd'
307
+ | 'gbp'
308
+ | 'gel'
309
+ | 'gip'
310
+ | 'gmd'
311
+ | 'gyd'
312
+ | 'hkd'
313
+ | 'hrk'
314
+ | 'htg'
315
+ | 'idr'
316
+ | 'ils'
317
+ | 'inr'
318
+ | 'isk'
319
+ | 'jmd'
320
+ | 'jpy'
321
+ | 'kes'
322
+ | 'kgs'
323
+ | 'khr'
324
+ | 'kmf'
325
+ | 'krw'
326
+ | 'kyd'
327
+ | 'kzt'
328
+ | 'lbp'
329
+ | 'lkr'
330
+ | 'lrd'
331
+ | 'lsl'
332
+ | 'mad'
333
+ | 'mdl'
334
+ | 'mga'
335
+ | 'mkd'
336
+ | 'mmk'
337
+ | 'mnt'
338
+ | 'mop'
339
+ | 'mro'
340
+ | 'mvr'
341
+ | 'mwk'
342
+ | 'mxn'
343
+ | 'myr'
344
+ | 'mzn'
345
+ | 'nad'
346
+ | 'ngn'
347
+ | 'nok'
348
+ | 'npr'
349
+ | 'nzd'
350
+ | 'pgk'
351
+ | 'php'
352
+ | 'pkr'
353
+ | 'pln'
354
+ | 'qar'
355
+ | 'ron'
356
+ | 'rsd'
357
+ | 'rub'
358
+ | 'rwf'
359
+ | 'sar'
360
+ | 'sbd'
361
+ | 'scr'
362
+ | 'sek'
363
+ | 'sgd'
364
+ | 'sle'
365
+ | 'sll'
366
+ | 'sos'
367
+ | 'szl'
368
+ | 'thb'
369
+ | 'tjs'
370
+ | 'top'
371
+ | 'try'
372
+ | 'ttd'
373
+ | 'tzs'
374
+ | 'uah'
375
+ | 'uzs'
376
+ | 'vnd'
377
+ | 'vuv'
378
+ | 'wst'
379
+ | 'xaf'
380
+ | 'xcd'
381
+ | 'yer'
382
+ | 'zar'
383
+ | 'zmw'
384
+ | 'clp'
385
+ | 'djf'
386
+ | 'gnf'
387
+ | 'ugx'
388
+ | 'pyg'
389
+ | 'xof'
390
+ | 'xpf'
391
+ | null;
392
+
393
+ /**
394
+ * The unique identifier for the entity in the billing provider
395
+ */
396
+ billingId?: string | null;
397
+
103
398
  /**
104
399
  * Customer level coupon
105
400
  */
106
- couponId?: string | null;
401
+ couponId?: (string & {}) | '' | null;
107
402
 
108
403
  /**
109
404
  * The default payment method details
@@ -120,6 +415,11 @@ export namespace CustomerResponse {
120
415
  */
121
416
  integrations?: Array<Data.Integration>;
122
417
 
418
+ /**
419
+ * Language to use for this customer
420
+ */
421
+ language?: string | null;
422
+
123
423
  /**
124
424
  * Additional metadata
125
425
  */
@@ -129,6 +429,16 @@ export namespace CustomerResponse {
129
429
  * The name of the customer
130
430
  */
131
431
  name?: string | null;
432
+
433
+ /**
434
+ * Vendor-specific billing passthrough fields.
435
+ */
436
+ passthrough?: Data.Passthrough;
437
+
438
+ /**
439
+ * Timezone to use for this customer
440
+ */
441
+ timezone?: string | null;
132
442
  }
133
443
 
134
444
  export namespace Data {
@@ -191,6 +501,328 @@ export namespace CustomerResponse {
191
501
  | 'OPEN_FGA'
192
502
  | 'APP_STORE';
193
503
  }
504
+
505
+ /**
506
+ * Vendor-specific billing passthrough fields.
507
+ */
508
+ export interface Passthrough {
509
+ /**
510
+ * Stripe-specific billing fields for the customer.
511
+ */
512
+ stripe?: Passthrough.Stripe;
513
+
514
+ /**
515
+ * Zuora-specific billing fields for the customer.
516
+ */
517
+ zuora?: Passthrough.Zuora;
518
+ }
519
+
520
+ export namespace Passthrough {
521
+ /**
522
+ * Stripe-specific billing fields for the customer.
523
+ */
524
+ export interface Stripe {
525
+ /**
526
+ * Physical address
527
+ */
528
+ billingAddress?: Stripe.BillingAddress;
529
+
530
+ /**
531
+ * Customer name
532
+ */
533
+ customerName?: string;
534
+
535
+ /**
536
+ * Invoice custom fields
537
+ */
538
+ invoiceCustomFields?: { [key: string]: string };
539
+
540
+ /**
541
+ * Additional metadata
542
+ */
543
+ metadata?: { [key: string]: string };
544
+
545
+ /**
546
+ * Billing provider payment method id, attached to this customer
547
+ */
548
+ paymentMethodId?: string;
549
+
550
+ /**
551
+ * Physical address
552
+ */
553
+ shippingAddress?: Stripe.ShippingAddress;
554
+
555
+ /**
556
+ * Tax IDs
557
+ */
558
+ taxIds?: Array<Stripe.TaxID>;
559
+ }
560
+
561
+ export namespace Stripe {
562
+ /**
563
+ * Physical address
564
+ */
565
+ export interface BillingAddress {
566
+ /**
567
+ * City name
568
+ */
569
+ city?: string;
570
+
571
+ /**
572
+ * Country code or name
573
+ */
574
+ country?: string;
575
+
576
+ /**
577
+ * Street address line 1
578
+ */
579
+ line1?: string;
580
+
581
+ /**
582
+ * Street address line 2
583
+ */
584
+ line2?: string;
585
+
586
+ /**
587
+ * Postal or ZIP code
588
+ */
589
+ postalCode?: string;
590
+
591
+ /**
592
+ * State or province
593
+ */
594
+ state?: string;
595
+ }
596
+
597
+ /**
598
+ * Physical address
599
+ */
600
+ export interface ShippingAddress {
601
+ /**
602
+ * City name
603
+ */
604
+ city?: string;
605
+
606
+ /**
607
+ * Country code or name
608
+ */
609
+ country?: string;
610
+
611
+ /**
612
+ * Street address line 1
613
+ */
614
+ line1?: string;
615
+
616
+ /**
617
+ * Street address line 2
618
+ */
619
+ line2?: string;
620
+
621
+ /**
622
+ * Postal or ZIP code
623
+ */
624
+ postalCode?: string;
625
+
626
+ /**
627
+ * State or province
628
+ */
629
+ state?: string;
630
+ }
631
+
632
+ /**
633
+ * Tax identifier with type and value for customer tax exemptions.
634
+ */
635
+ export interface TaxID {
636
+ /**
637
+ * The type of tax exemption identifier, such as VAT.
638
+ */
639
+ type: string;
640
+
641
+ /**
642
+ * The actual tax identifier value
643
+ */
644
+ value: string;
645
+ }
646
+ }
647
+
648
+ /**
649
+ * Zuora-specific billing fields for the customer.
650
+ */
651
+ export interface Zuora {
652
+ /**
653
+ * Physical address
654
+ */
655
+ billingAddress?: Zuora.BillingAddress;
656
+
657
+ /**
658
+ * Customers selected currency
659
+ */
660
+ currency?:
661
+ | 'usd'
662
+ | 'aed'
663
+ | 'all'
664
+ | 'amd'
665
+ | 'ang'
666
+ | 'aud'
667
+ | 'awg'
668
+ | 'azn'
669
+ | 'bam'
670
+ | 'bbd'
671
+ | 'bdt'
672
+ | 'bgn'
673
+ | 'bif'
674
+ | 'bmd'
675
+ | 'bnd'
676
+ | 'bsd'
677
+ | 'bwp'
678
+ | 'byn'
679
+ | 'bzd'
680
+ | 'brl'
681
+ | 'cad'
682
+ | 'cdf'
683
+ | 'chf'
684
+ | 'cny'
685
+ | 'czk'
686
+ | 'dkk'
687
+ | 'dop'
688
+ | 'dzd'
689
+ | 'egp'
690
+ | 'etb'
691
+ | 'eur'
692
+ | 'fjd'
693
+ | 'gbp'
694
+ | 'gel'
695
+ | 'gip'
696
+ | 'gmd'
697
+ | 'gyd'
698
+ | 'hkd'
699
+ | 'hrk'
700
+ | 'htg'
701
+ | 'idr'
702
+ | 'ils'
703
+ | 'inr'
704
+ | 'isk'
705
+ | 'jmd'
706
+ | 'jpy'
707
+ | 'kes'
708
+ | 'kgs'
709
+ | 'khr'
710
+ | 'kmf'
711
+ | 'krw'
712
+ | 'kyd'
713
+ | 'kzt'
714
+ | 'lbp'
715
+ | 'lkr'
716
+ | 'lrd'
717
+ | 'lsl'
718
+ | 'mad'
719
+ | 'mdl'
720
+ | 'mga'
721
+ | 'mkd'
722
+ | 'mmk'
723
+ | 'mnt'
724
+ | 'mop'
725
+ | 'mro'
726
+ | 'mvr'
727
+ | 'mwk'
728
+ | 'mxn'
729
+ | 'myr'
730
+ | 'mzn'
731
+ | 'nad'
732
+ | 'ngn'
733
+ | 'nok'
734
+ | 'npr'
735
+ | 'nzd'
736
+ | 'pgk'
737
+ | 'php'
738
+ | 'pkr'
739
+ | 'pln'
740
+ | 'qar'
741
+ | 'ron'
742
+ | 'rsd'
743
+ | 'rub'
744
+ | 'rwf'
745
+ | 'sar'
746
+ | 'sbd'
747
+ | 'scr'
748
+ | 'sek'
749
+ | 'sgd'
750
+ | 'sle'
751
+ | 'sll'
752
+ | 'sos'
753
+ | 'szl'
754
+ | 'thb'
755
+ | 'tjs'
756
+ | 'top'
757
+ | 'try'
758
+ | 'ttd'
759
+ | 'tzs'
760
+ | 'uah'
761
+ | 'uzs'
762
+ | 'vnd'
763
+ | 'vuv'
764
+ | 'wst'
765
+ | 'xaf'
766
+ | 'xcd'
767
+ | 'yer'
768
+ | 'zar'
769
+ | 'zmw'
770
+ | 'clp'
771
+ | 'djf'
772
+ | 'gnf'
773
+ | 'ugx'
774
+ | 'pyg'
775
+ | 'xof'
776
+ | 'xpf';
777
+
778
+ /**
779
+ * Additional metadata
780
+ */
781
+ metadata?: { [key: string]: string };
782
+
783
+ /**
784
+ * Billing provider payment method id, attached to this customer
785
+ */
786
+ paymentMethodId?: string;
787
+ }
788
+
789
+ export namespace Zuora {
790
+ /**
791
+ * Physical address
792
+ */
793
+ export interface BillingAddress {
794
+ /**
795
+ * City name
796
+ */
797
+ city?: string;
798
+
799
+ /**
800
+ * Country code or name
801
+ */
802
+ country?: string;
803
+
804
+ /**
805
+ * Street address line 1
806
+ */
807
+ line1?: string;
808
+
809
+ /**
810
+ * Street address line 2
811
+ */
812
+ line2?: string;
813
+
814
+ /**
815
+ * Postal or ZIP code
816
+ */
817
+ postalCode?: string;
818
+
819
+ /**
820
+ * State or province
821
+ */
822
+ state?: string;
823
+ }
824
+ }
825
+ }
194
826
  }
195
827
  }
196
828
 
@@ -218,10 +850,137 @@ export interface CustomerListResponse {
218
850
  */
219
851
  updatedAt: string;
220
852
 
853
+ /**
854
+ * The billing currency of the customer
855
+ */
856
+ billingCurrency?:
857
+ | 'usd'
858
+ | 'aed'
859
+ | 'all'
860
+ | 'amd'
861
+ | 'ang'
862
+ | 'aud'
863
+ | 'awg'
864
+ | 'azn'
865
+ | 'bam'
866
+ | 'bbd'
867
+ | 'bdt'
868
+ | 'bgn'
869
+ | 'bif'
870
+ | 'bmd'
871
+ | 'bnd'
872
+ | 'bsd'
873
+ | 'bwp'
874
+ | 'byn'
875
+ | 'bzd'
876
+ | 'brl'
877
+ | 'cad'
878
+ | 'cdf'
879
+ | 'chf'
880
+ | 'cny'
881
+ | 'czk'
882
+ | 'dkk'
883
+ | 'dop'
884
+ | 'dzd'
885
+ | 'egp'
886
+ | 'etb'
887
+ | 'eur'
888
+ | 'fjd'
889
+ | 'gbp'
890
+ | 'gel'
891
+ | 'gip'
892
+ | 'gmd'
893
+ | 'gyd'
894
+ | 'hkd'
895
+ | 'hrk'
896
+ | 'htg'
897
+ | 'idr'
898
+ | 'ils'
899
+ | 'inr'
900
+ | 'isk'
901
+ | 'jmd'
902
+ | 'jpy'
903
+ | 'kes'
904
+ | 'kgs'
905
+ | 'khr'
906
+ | 'kmf'
907
+ | 'krw'
908
+ | 'kyd'
909
+ | 'kzt'
910
+ | 'lbp'
911
+ | 'lkr'
912
+ | 'lrd'
913
+ | 'lsl'
914
+ | 'mad'
915
+ | 'mdl'
916
+ | 'mga'
917
+ | 'mkd'
918
+ | 'mmk'
919
+ | 'mnt'
920
+ | 'mop'
921
+ | 'mro'
922
+ | 'mvr'
923
+ | 'mwk'
924
+ | 'mxn'
925
+ | 'myr'
926
+ | 'mzn'
927
+ | 'nad'
928
+ | 'ngn'
929
+ | 'nok'
930
+ | 'npr'
931
+ | 'nzd'
932
+ | 'pgk'
933
+ | 'php'
934
+ | 'pkr'
935
+ | 'pln'
936
+ | 'qar'
937
+ | 'ron'
938
+ | 'rsd'
939
+ | 'rub'
940
+ | 'rwf'
941
+ | 'sar'
942
+ | 'sbd'
943
+ | 'scr'
944
+ | 'sek'
945
+ | 'sgd'
946
+ | 'sle'
947
+ | 'sll'
948
+ | 'sos'
949
+ | 'szl'
950
+ | 'thb'
951
+ | 'tjs'
952
+ | 'top'
953
+ | 'try'
954
+ | 'ttd'
955
+ | 'tzs'
956
+ | 'uah'
957
+ | 'uzs'
958
+ | 'vnd'
959
+ | 'vuv'
960
+ | 'wst'
961
+ | 'xaf'
962
+ | 'xcd'
963
+ | 'yer'
964
+ | 'zar'
965
+ | 'zmw'
966
+ | 'clp'
967
+ | 'djf'
968
+ | 'gnf'
969
+ | 'ugx'
970
+ | 'pyg'
971
+ | 'xof'
972
+ | 'xpf'
973
+ | null;
974
+
975
+ /**
976
+ * The unique identifier for the entity in the billing provider
977
+ */
978
+ billingId?: string | null;
979
+
221
980
  /**
222
981
  * Customer level coupon
223
982
  */
224
- couponId?: string | null;
983
+ couponId?: (string & {}) | '' | null;
225
984
 
226
985
  /**
227
986
  * The default payment method details
@@ -238,6 +997,11 @@ export interface CustomerListResponse {
238
997
  */
239
998
  integrations?: Array<CustomerListResponse.Integration>;
240
999
 
1000
+ /**
1001
+ * Language to use for this customer
1002
+ */
1003
+ language?: string | null;
1004
+
241
1005
  /**
242
1006
  * Additional metadata
243
1007
  */
@@ -247,6 +1011,16 @@ export interface CustomerListResponse {
247
1011
  * The name of the customer
248
1012
  */
249
1013
  name?: string | null;
1014
+
1015
+ /**
1016
+ * Vendor-specific billing passthrough fields.
1017
+ */
1018
+ passthrough?: CustomerListResponse.Passthrough;
1019
+
1020
+ /**
1021
+ * Timezone to use for this customer
1022
+ */
1023
+ timezone?: string | null;
250
1024
  }
251
1025
 
252
1026
  export namespace CustomerListResponse {
@@ -309,76 +1083,745 @@ export namespace CustomerListResponse {
309
1083
  | 'OPEN_FGA'
310
1084
  | 'APP_STORE';
311
1085
  }
312
- }
313
1086
 
314
- export interface CustomerCreateParams {
315
1087
  /**
316
- * Customer slug
1088
+ * Vendor-specific billing passthrough fields.
317
1089
  */
318
- id: string;
1090
+ export interface Passthrough {
1091
+ /**
1092
+ * Stripe-specific billing fields for the customer.
1093
+ */
1094
+ stripe?: Passthrough.Stripe;
1095
+
1096
+ /**
1097
+ * Zuora-specific billing fields for the customer.
1098
+ */
1099
+ zuora?: Passthrough.Zuora;
1100
+ }
1101
+
1102
+ export namespace Passthrough {
1103
+ /**
1104
+ * Stripe-specific billing fields for the customer.
1105
+ */
1106
+ export interface Stripe {
1107
+ /**
1108
+ * Physical address
1109
+ */
1110
+ billingAddress?: Stripe.BillingAddress;
1111
+
1112
+ /**
1113
+ * Customer name
1114
+ */
1115
+ customerName?: string;
1116
+
1117
+ /**
1118
+ * Invoice custom fields
1119
+ */
1120
+ invoiceCustomFields?: { [key: string]: string };
1121
+
1122
+ /**
1123
+ * Additional metadata
1124
+ */
1125
+ metadata?: { [key: string]: string };
1126
+
1127
+ /**
1128
+ * Billing provider payment method id, attached to this customer
1129
+ */
1130
+ paymentMethodId?: string;
1131
+
1132
+ /**
1133
+ * Physical address
1134
+ */
1135
+ shippingAddress?: Stripe.ShippingAddress;
1136
+
1137
+ /**
1138
+ * Tax IDs
1139
+ */
1140
+ taxIds?: Array<Stripe.TaxID>;
1141
+ }
1142
+
1143
+ export namespace Stripe {
1144
+ /**
1145
+ * Physical address
1146
+ */
1147
+ export interface BillingAddress {
1148
+ /**
1149
+ * City name
1150
+ */
1151
+ city?: string;
1152
+
1153
+ /**
1154
+ * Country code or name
1155
+ */
1156
+ country?: string;
1157
+
1158
+ /**
1159
+ * Street address line 1
1160
+ */
1161
+ line1?: string;
1162
+
1163
+ /**
1164
+ * Street address line 2
1165
+ */
1166
+ line2?: string;
1167
+
1168
+ /**
1169
+ * Postal or ZIP code
1170
+ */
1171
+ postalCode?: string;
1172
+
1173
+ /**
1174
+ * State or province
1175
+ */
1176
+ state?: string;
1177
+ }
1178
+
1179
+ /**
1180
+ * Physical address
1181
+ */
1182
+ export interface ShippingAddress {
1183
+ /**
1184
+ * City name
1185
+ */
1186
+ city?: string;
1187
+
1188
+ /**
1189
+ * Country code or name
1190
+ */
1191
+ country?: string;
1192
+
1193
+ /**
1194
+ * Street address line 1
1195
+ */
1196
+ line1?: string;
1197
+
1198
+ /**
1199
+ * Street address line 2
1200
+ */
1201
+ line2?: string;
1202
+
1203
+ /**
1204
+ * Postal or ZIP code
1205
+ */
1206
+ postalCode?: string;
1207
+
1208
+ /**
1209
+ * State or province
1210
+ */
1211
+ state?: string;
1212
+ }
1213
+
1214
+ /**
1215
+ * Tax identifier with type and value for customer tax exemptions.
1216
+ */
1217
+ export interface TaxID {
1218
+ /**
1219
+ * The type of tax exemption identifier, such as VAT.
1220
+ */
1221
+ type: string;
1222
+
1223
+ /**
1224
+ * The actual tax identifier value
1225
+ */
1226
+ value: string;
1227
+ }
1228
+ }
1229
+
1230
+ /**
1231
+ * Zuora-specific billing fields for the customer.
1232
+ */
1233
+ export interface Zuora {
1234
+ /**
1235
+ * Physical address
1236
+ */
1237
+ billingAddress?: Zuora.BillingAddress;
1238
+
1239
+ /**
1240
+ * Customers selected currency
1241
+ */
1242
+ currency?:
1243
+ | 'usd'
1244
+ | 'aed'
1245
+ | 'all'
1246
+ | 'amd'
1247
+ | 'ang'
1248
+ | 'aud'
1249
+ | 'awg'
1250
+ | 'azn'
1251
+ | 'bam'
1252
+ | 'bbd'
1253
+ | 'bdt'
1254
+ | 'bgn'
1255
+ | 'bif'
1256
+ | 'bmd'
1257
+ | 'bnd'
1258
+ | 'bsd'
1259
+ | 'bwp'
1260
+ | 'byn'
1261
+ | 'bzd'
1262
+ | 'brl'
1263
+ | 'cad'
1264
+ | 'cdf'
1265
+ | 'chf'
1266
+ | 'cny'
1267
+ | 'czk'
1268
+ | 'dkk'
1269
+ | 'dop'
1270
+ | 'dzd'
1271
+ | 'egp'
1272
+ | 'etb'
1273
+ | 'eur'
1274
+ | 'fjd'
1275
+ | 'gbp'
1276
+ | 'gel'
1277
+ | 'gip'
1278
+ | 'gmd'
1279
+ | 'gyd'
1280
+ | 'hkd'
1281
+ | 'hrk'
1282
+ | 'htg'
1283
+ | 'idr'
1284
+ | 'ils'
1285
+ | 'inr'
1286
+ | 'isk'
1287
+ | 'jmd'
1288
+ | 'jpy'
1289
+ | 'kes'
1290
+ | 'kgs'
1291
+ | 'khr'
1292
+ | 'kmf'
1293
+ | 'krw'
1294
+ | 'kyd'
1295
+ | 'kzt'
1296
+ | 'lbp'
1297
+ | 'lkr'
1298
+ | 'lrd'
1299
+ | 'lsl'
1300
+ | 'mad'
1301
+ | 'mdl'
1302
+ | 'mga'
1303
+ | 'mkd'
1304
+ | 'mmk'
1305
+ | 'mnt'
1306
+ | 'mop'
1307
+ | 'mro'
1308
+ | 'mvr'
1309
+ | 'mwk'
1310
+ | 'mxn'
1311
+ | 'myr'
1312
+ | 'mzn'
1313
+ | 'nad'
1314
+ | 'ngn'
1315
+ | 'nok'
1316
+ | 'npr'
1317
+ | 'nzd'
1318
+ | 'pgk'
1319
+ | 'php'
1320
+ | 'pkr'
1321
+ | 'pln'
1322
+ | 'qar'
1323
+ | 'ron'
1324
+ | 'rsd'
1325
+ | 'rub'
1326
+ | 'rwf'
1327
+ | 'sar'
1328
+ | 'sbd'
1329
+ | 'scr'
1330
+ | 'sek'
1331
+ | 'sgd'
1332
+ | 'sle'
1333
+ | 'sll'
1334
+ | 'sos'
1335
+ | 'szl'
1336
+ | 'thb'
1337
+ | 'tjs'
1338
+ | 'top'
1339
+ | 'try'
1340
+ | 'ttd'
1341
+ | 'tzs'
1342
+ | 'uah'
1343
+ | 'uzs'
1344
+ | 'vnd'
1345
+ | 'vuv'
1346
+ | 'wst'
1347
+ | 'xaf'
1348
+ | 'xcd'
1349
+ | 'yer'
1350
+ | 'zar'
1351
+ | 'zmw'
1352
+ | 'clp'
1353
+ | 'djf'
1354
+ | 'gnf'
1355
+ | 'ugx'
1356
+ | 'pyg'
1357
+ | 'xof'
1358
+ | 'xpf';
1359
+
1360
+ /**
1361
+ * Additional metadata
1362
+ */
1363
+ metadata?: { [key: string]: string };
1364
+
1365
+ /**
1366
+ * Billing provider payment method id, attached to this customer
1367
+ */
1368
+ paymentMethodId?: string;
1369
+ }
319
1370
 
1371
+ export namespace Zuora {
1372
+ /**
1373
+ * Physical address
1374
+ */
1375
+ export interface BillingAddress {
1376
+ /**
1377
+ * City name
1378
+ */
1379
+ city?: string;
1380
+
1381
+ /**
1382
+ * Country code or name
1383
+ */
1384
+ country?: string;
1385
+
1386
+ /**
1387
+ * Street address line 1
1388
+ */
1389
+ line1?: string;
1390
+
1391
+ /**
1392
+ * Street address line 2
1393
+ */
1394
+ line2?: string;
1395
+
1396
+ /**
1397
+ * Postal or ZIP code
1398
+ */
1399
+ postalCode?: string;
1400
+
1401
+ /**
1402
+ * State or province
1403
+ */
1404
+ state?: string;
1405
+ }
1406
+ }
1407
+ }
1408
+ }
1409
+
1410
+ /**
1411
+ * Response object
1412
+ */
1413
+ export interface CustomerImportResponse {
320
1414
  /**
321
- * Customer level coupon
1415
+ * List of newly created customer IDs from the import operation.
322
1416
  */
323
- couponId?: string | null;
1417
+ data: CustomerImportResponse.Data;
1418
+ }
324
1419
 
1420
+ export namespace CustomerImportResponse {
325
1421
  /**
326
- * The default payment method details
1422
+ * List of newly created customer IDs from the import operation.
327
1423
  */
328
- defaultPaymentMethod?: CustomerCreateParams.DefaultPaymentMethod | null;
1424
+ export interface Data {
1425
+ /**
1426
+ * Customer IDs created during import
1427
+ */
1428
+ newCustomers: Array<string>;
1429
+ }
1430
+ }
329
1431
 
1432
+ /**
1433
+ * Resource object that belongs to a customer
1434
+ */
1435
+ export interface CustomerListResourcesResponse {
330
1436
  /**
331
- * The email of the customer
1437
+ * Resource slug
332
1438
  */
333
- email?: string | null;
1439
+ id: string;
334
1440
 
335
1441
  /**
336
- * List of integrations
1442
+ * Timestamp of when the record was created
337
1443
  */
338
- integrations?: Array<CustomerCreateParams.Integration>;
1444
+ createdAt: string;
339
1445
 
340
1446
  /**
341
- * Additional metadata
1447
+ * Timestamp of when the record was last updated
342
1448
  */
343
- metadata?: { [key: string]: string };
1449
+ updatedAt: string;
1450
+ }
344
1451
 
1452
+ /**
1453
+ * Response object
1454
+ */
1455
+ export interface CustomerRetrieveEntitlementsResponse {
345
1456
  /**
346
- * The name of the customer
1457
+ * The effective entitlements state for a customer or resource.
347
1458
  */
348
- name?: string | null;
1459
+ data: CustomerRetrieveEntitlementsResponse.Data;
349
1460
  }
350
1461
 
351
- export namespace CustomerCreateParams {
1462
+ export namespace CustomerRetrieveEntitlementsResponse {
352
1463
  /**
353
- * The default payment method details
1464
+ * The effective entitlements state for a customer or resource.
354
1465
  */
355
- export interface DefaultPaymentMethod {
1466
+ export interface Data {
356
1467
  /**
357
- * The default payment method id
1468
+ * Reason why entitlements access was denied, if applicable
358
1469
  */
359
- billingId: string | null;
1470
+ accessDeniedReason: 'CustomerNotFound' | 'NoActiveSubscription' | 'CustomerIsArchived' | null;
360
1471
 
361
1472
  /**
362
- * The expiration month of the default payment method
1473
+ * List of effective feature and credit entitlements
363
1474
  */
364
- cardExpiryMonth: number | null;
1475
+ entitlements: Array<Data.Feature | Data.Credit>;
1476
+ }
365
1477
 
366
- /**
367
- * The expiration year of the default payment method
368
- */
369
- cardExpiryYear: number | null;
1478
+ export namespace Data {
1479
+ export interface Feature {
1480
+ accessDeniedReason:
1481
+ | 'FeatureNotFound'
1482
+ | 'CustomerNotFound'
1483
+ | 'CustomerIsArchived'
1484
+ | 'CustomerResourceNotFound'
1485
+ | 'NoActiveSubscription'
1486
+ | 'NoFeatureEntitlementInSubscription'
1487
+ | 'RequestedUsageExceedingLimit'
1488
+ | 'RequestedValuesMismatch'
1489
+ | 'BudgetExceeded'
1490
+ | 'Unknown'
1491
+ | 'FeatureTypeMismatch'
1492
+ | 'Revoked'
1493
+ | 'InsufficientCredits'
1494
+ | 'EntitlementNotFound'
1495
+ | null;
1496
+
1497
+ isGranted: boolean;
1498
+
1499
+ type: 'FEATURE';
1500
+
1501
+ currentUsage?: number;
370
1502
 
371
- /**
372
- * The last 4 digits of the default payment method
373
- */
374
- cardLast4Digits: string | null;
1503
+ /**
1504
+ * Timestamp of the last update to the entitlement grant or configuration.
1505
+ */
1506
+ entitlementUpdatedAt?: string;
375
1507
 
376
- /**
377
- * The default payment method type
378
- */
379
- type: 'CARD' | 'BANK' | 'CASH_APP';
1508
+ feature?: Feature.Feature;
1509
+
1510
+ hasUnlimitedUsage?: boolean;
1511
+
1512
+ resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
1513
+
1514
+ usageLimit?: number | null;
1515
+
1516
+ /**
1517
+ * The anchor for calculating the usage period for metered entitlements with a
1518
+ * reset period configured
1519
+ */
1520
+ usagePeriodAnchor?: string;
1521
+
1522
+ /**
1523
+ * The end date of the usage period for metered entitlements with a reset period
1524
+ * configured
1525
+ */
1526
+ usagePeriodEnd?: string;
1527
+
1528
+ /**
1529
+ * The start date of the usage period for metered entitlements with a reset period
1530
+ * configured
1531
+ */
1532
+ usagePeriodStart?: string;
1533
+
1534
+ /**
1535
+ * The next time the entitlement should be recalculated
1536
+ */
1537
+ validUntil?: string;
1538
+ }
1539
+
1540
+ export namespace Feature {
1541
+ export interface Feature {
1542
+ /**
1543
+ * The unique reference ID of the entitlement.
1544
+ */
1545
+ id: string;
1546
+
1547
+ /**
1548
+ * The human-readable name of the entitlement, shown in UI elements.
1549
+ */
1550
+ displayName: string;
1551
+
1552
+ /**
1553
+ * The current status of the feature.
1554
+ */
1555
+ featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE';
1556
+
1557
+ /**
1558
+ * The type of feature associated with the entitlement.
1559
+ */
1560
+ featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM';
1561
+ }
1562
+ }
1563
+
1564
+ export interface Credit {
1565
+ accessDeniedReason:
1566
+ | 'FeatureNotFound'
1567
+ | 'CustomerNotFound'
1568
+ | 'CustomerIsArchived'
1569
+ | 'CustomerResourceNotFound'
1570
+ | 'NoActiveSubscription'
1571
+ | 'NoFeatureEntitlementInSubscription'
1572
+ | 'RequestedUsageExceedingLimit'
1573
+ | 'RequestedValuesMismatch'
1574
+ | 'BudgetExceeded'
1575
+ | 'Unknown'
1576
+ | 'FeatureTypeMismatch'
1577
+ | 'Revoked'
1578
+ | 'InsufficientCredits'
1579
+ | 'EntitlementNotFound'
1580
+ | null;
1581
+
1582
+ /**
1583
+ * The currency associated with a credit entitlement.
1584
+ */
1585
+ currency: Credit.Currency;
1586
+
1587
+ currentUsage: number;
1588
+
1589
+ isGranted: boolean;
1590
+
1591
+ type: 'CREDIT';
1592
+
1593
+ usageLimit: number;
1594
+
1595
+ /**
1596
+ * Timestamp of the last update to the credit usage.
1597
+ */
1598
+ usageUpdatedAt: string;
1599
+
1600
+ /**
1601
+ * Timestamp of the last update to the entitlement grant or configuration.
1602
+ */
1603
+ entitlementUpdatedAt?: string;
1604
+
1605
+ /**
1606
+ * The end date of the current billing period for recurring credit grants.
1607
+ */
1608
+ usagePeriodEnd?: string;
1609
+
1610
+ /**
1611
+ * The next time the entitlement should be recalculated
1612
+ */
1613
+ validUntil?: string;
1614
+ }
1615
+
1616
+ export namespace Credit {
1617
+ /**
1618
+ * The currency associated with a credit entitlement.
1619
+ */
1620
+ export interface Currency {
1621
+ /**
1622
+ * The unique identifier of the custom currency.
1623
+ */
1624
+ currencyId: string;
1625
+
1626
+ /**
1627
+ * The display name of the currency.
1628
+ */
1629
+ displayName: string;
1630
+
1631
+ /**
1632
+ * A description of the currency.
1633
+ */
1634
+ description?: string | null;
1635
+
1636
+ /**
1637
+ * Additional metadata associated with the currency.
1638
+ */
1639
+ metadata?: { [key: string]: string } | null;
1640
+
1641
+ /**
1642
+ * The plural form of the currency unit.
1643
+ */
1644
+ unitPlural?: string | null;
1645
+
1646
+ /**
1647
+ * The singular form of the currency unit.
1648
+ */
1649
+ unitSingular?: string | null;
1650
+ }
1651
+ }
380
1652
  }
1653
+ }
1654
+
1655
+ export interface CustomerUpdateParams {
1656
+ /**
1657
+ * The billing currency of the customer
1658
+ */
1659
+ billingCurrency?:
1660
+ | 'usd'
1661
+ | 'aed'
1662
+ | 'all'
1663
+ | 'amd'
1664
+ | 'ang'
1665
+ | 'aud'
1666
+ | 'awg'
1667
+ | 'azn'
1668
+ | 'bam'
1669
+ | 'bbd'
1670
+ | 'bdt'
1671
+ | 'bgn'
1672
+ | 'bif'
1673
+ | 'bmd'
1674
+ | 'bnd'
1675
+ | 'bsd'
1676
+ | 'bwp'
1677
+ | 'byn'
1678
+ | 'bzd'
1679
+ | 'brl'
1680
+ | 'cad'
1681
+ | 'cdf'
1682
+ | 'chf'
1683
+ | 'cny'
1684
+ | 'czk'
1685
+ | 'dkk'
1686
+ | 'dop'
1687
+ | 'dzd'
1688
+ | 'egp'
1689
+ | 'etb'
1690
+ | 'eur'
1691
+ | 'fjd'
1692
+ | 'gbp'
1693
+ | 'gel'
1694
+ | 'gip'
1695
+ | 'gmd'
1696
+ | 'gyd'
1697
+ | 'hkd'
1698
+ | 'hrk'
1699
+ | 'htg'
1700
+ | 'idr'
1701
+ | 'ils'
1702
+ | 'inr'
1703
+ | 'isk'
1704
+ | 'jmd'
1705
+ | 'jpy'
1706
+ | 'kes'
1707
+ | 'kgs'
1708
+ | 'khr'
1709
+ | 'kmf'
1710
+ | 'krw'
1711
+ | 'kyd'
1712
+ | 'kzt'
1713
+ | 'lbp'
1714
+ | 'lkr'
1715
+ | 'lrd'
1716
+ | 'lsl'
1717
+ | 'mad'
1718
+ | 'mdl'
1719
+ | 'mga'
1720
+ | 'mkd'
1721
+ | 'mmk'
1722
+ | 'mnt'
1723
+ | 'mop'
1724
+ | 'mro'
1725
+ | 'mvr'
1726
+ | 'mwk'
1727
+ | 'mxn'
1728
+ | 'myr'
1729
+ | 'mzn'
1730
+ | 'nad'
1731
+ | 'ngn'
1732
+ | 'nok'
1733
+ | 'npr'
1734
+ | 'nzd'
1735
+ | 'pgk'
1736
+ | 'php'
1737
+ | 'pkr'
1738
+ | 'pln'
1739
+ | 'qar'
1740
+ | 'ron'
1741
+ | 'rsd'
1742
+ | 'rub'
1743
+ | 'rwf'
1744
+ | 'sar'
1745
+ | 'sbd'
1746
+ | 'scr'
1747
+ | 'sek'
1748
+ | 'sgd'
1749
+ | 'sle'
1750
+ | 'sll'
1751
+ | 'sos'
1752
+ | 'szl'
1753
+ | 'thb'
1754
+ | 'tjs'
1755
+ | 'top'
1756
+ | 'try'
1757
+ | 'ttd'
1758
+ | 'tzs'
1759
+ | 'uah'
1760
+ | 'uzs'
1761
+ | 'vnd'
1762
+ | 'vuv'
1763
+ | 'wst'
1764
+ | 'xaf'
1765
+ | 'xcd'
1766
+ | 'yer'
1767
+ | 'zar'
1768
+ | 'zmw'
1769
+ | 'clp'
1770
+ | 'djf'
1771
+ | 'gnf'
1772
+ | 'ugx'
1773
+ | 'pyg'
1774
+ | 'xof'
1775
+ | 'xpf'
1776
+ | null;
1777
+
1778
+ /**
1779
+ * The unique identifier for the entity in the billing provider
1780
+ */
1781
+ billingId?: string | null;
1782
+
1783
+ /**
1784
+ * Customer level coupon
1785
+ */
1786
+ couponId?: (string & {}) | '' | null;
381
1787
 
1788
+ /**
1789
+ * The email of the customer
1790
+ */
1791
+ email?: string | null;
1792
+
1793
+ /**
1794
+ * List of integrations
1795
+ */
1796
+ integrations?: Array<CustomerUpdateParams.Integration>;
1797
+
1798
+ /**
1799
+ * Language to use for this customer
1800
+ */
1801
+ language?: string | null;
1802
+
1803
+ /**
1804
+ * Additional metadata
1805
+ */
1806
+ metadata?: { [key: string]: string };
1807
+
1808
+ /**
1809
+ * The name of the customer
1810
+ */
1811
+ name?: string | null;
1812
+
1813
+ /**
1814
+ * Vendor-specific billing passthrough fields.
1815
+ */
1816
+ passthrough?: CustomerUpdateParams.Passthrough;
1817
+
1818
+ /**
1819
+ * Timezone to use for this customer
1820
+ */
1821
+ timezone?: string | null;
1822
+ }
1823
+
1824
+ export namespace CustomerUpdateParams {
382
1825
  /**
383
1826
  * External billing or CRM integration link
384
1827
  */
@@ -408,13 +1851,574 @@ export namespace CustomerCreateParams {
408
1851
  | 'OPEN_FGA'
409
1852
  | 'APP_STORE';
410
1853
  }
1854
+
1855
+ /**
1856
+ * Vendor-specific billing passthrough fields.
1857
+ */
1858
+ export interface Passthrough {
1859
+ /**
1860
+ * Stripe-specific billing fields for the customer.
1861
+ */
1862
+ stripe?: Passthrough.Stripe;
1863
+
1864
+ /**
1865
+ * Zuora-specific billing fields for the customer.
1866
+ */
1867
+ zuora?: Passthrough.Zuora;
1868
+ }
1869
+
1870
+ export namespace Passthrough {
1871
+ /**
1872
+ * Stripe-specific billing fields for the customer.
1873
+ */
1874
+ export interface Stripe {
1875
+ /**
1876
+ * Physical address
1877
+ */
1878
+ billingAddress?: Stripe.BillingAddress;
1879
+
1880
+ /**
1881
+ * Customer name
1882
+ */
1883
+ customerName?: string;
1884
+
1885
+ /**
1886
+ * Invoice custom fields
1887
+ */
1888
+ invoiceCustomFields?: { [key: string]: string };
1889
+
1890
+ /**
1891
+ * Additional metadata
1892
+ */
1893
+ metadata?: { [key: string]: string };
1894
+
1895
+ /**
1896
+ * Billing provider payment method id, attached to this customer
1897
+ */
1898
+ paymentMethodId?: string;
1899
+
1900
+ /**
1901
+ * Physical address
1902
+ */
1903
+ shippingAddress?: Stripe.ShippingAddress;
1904
+
1905
+ /**
1906
+ * Tax IDs
1907
+ */
1908
+ taxIds?: Array<Stripe.TaxID>;
1909
+ }
1910
+
1911
+ export namespace Stripe {
1912
+ /**
1913
+ * Physical address
1914
+ */
1915
+ export interface BillingAddress {
1916
+ /**
1917
+ * City name
1918
+ */
1919
+ city?: string;
1920
+
1921
+ /**
1922
+ * Country code or name
1923
+ */
1924
+ country?: string;
1925
+
1926
+ /**
1927
+ * Street address line 1
1928
+ */
1929
+ line1?: string;
1930
+
1931
+ /**
1932
+ * Street address line 2
1933
+ */
1934
+ line2?: string;
1935
+
1936
+ /**
1937
+ * Postal or ZIP code
1938
+ */
1939
+ postalCode?: string;
1940
+
1941
+ /**
1942
+ * State or province
1943
+ */
1944
+ state?: string;
1945
+ }
1946
+
1947
+ /**
1948
+ * Physical address
1949
+ */
1950
+ export interface ShippingAddress {
1951
+ /**
1952
+ * City name
1953
+ */
1954
+ city?: string;
1955
+
1956
+ /**
1957
+ * Country code or name
1958
+ */
1959
+ country?: string;
1960
+
1961
+ /**
1962
+ * Street address line 1
1963
+ */
1964
+ line1?: string;
1965
+
1966
+ /**
1967
+ * Street address line 2
1968
+ */
1969
+ line2?: string;
1970
+
1971
+ /**
1972
+ * Postal or ZIP code
1973
+ */
1974
+ postalCode?: string;
1975
+
1976
+ /**
1977
+ * State or province
1978
+ */
1979
+ state?: string;
1980
+ }
1981
+
1982
+ /**
1983
+ * Tax identifier with type and value for customer tax exemptions.
1984
+ */
1985
+ export interface TaxID {
1986
+ /**
1987
+ * The type of tax exemption identifier, such as VAT.
1988
+ */
1989
+ type: string;
1990
+
1991
+ /**
1992
+ * The actual tax identifier value
1993
+ */
1994
+ value: string;
1995
+ }
1996
+ }
1997
+
1998
+ /**
1999
+ * Zuora-specific billing fields for the customer.
2000
+ */
2001
+ export interface Zuora {
2002
+ /**
2003
+ * Physical address
2004
+ */
2005
+ billingAddress?: Zuora.BillingAddress;
2006
+
2007
+ /**
2008
+ * Customers selected currency
2009
+ */
2010
+ currency?:
2011
+ | 'usd'
2012
+ | 'aed'
2013
+ | 'all'
2014
+ | 'amd'
2015
+ | 'ang'
2016
+ | 'aud'
2017
+ | 'awg'
2018
+ | 'azn'
2019
+ | 'bam'
2020
+ | 'bbd'
2021
+ | 'bdt'
2022
+ | 'bgn'
2023
+ | 'bif'
2024
+ | 'bmd'
2025
+ | 'bnd'
2026
+ | 'bsd'
2027
+ | 'bwp'
2028
+ | 'byn'
2029
+ | 'bzd'
2030
+ | 'brl'
2031
+ | 'cad'
2032
+ | 'cdf'
2033
+ | 'chf'
2034
+ | 'cny'
2035
+ | 'czk'
2036
+ | 'dkk'
2037
+ | 'dop'
2038
+ | 'dzd'
2039
+ | 'egp'
2040
+ | 'etb'
2041
+ | 'eur'
2042
+ | 'fjd'
2043
+ | 'gbp'
2044
+ | 'gel'
2045
+ | 'gip'
2046
+ | 'gmd'
2047
+ | 'gyd'
2048
+ | 'hkd'
2049
+ | 'hrk'
2050
+ | 'htg'
2051
+ | 'idr'
2052
+ | 'ils'
2053
+ | 'inr'
2054
+ | 'isk'
2055
+ | 'jmd'
2056
+ | 'jpy'
2057
+ | 'kes'
2058
+ | 'kgs'
2059
+ | 'khr'
2060
+ | 'kmf'
2061
+ | 'krw'
2062
+ | 'kyd'
2063
+ | 'kzt'
2064
+ | 'lbp'
2065
+ | 'lkr'
2066
+ | 'lrd'
2067
+ | 'lsl'
2068
+ | 'mad'
2069
+ | 'mdl'
2070
+ | 'mga'
2071
+ | 'mkd'
2072
+ | 'mmk'
2073
+ | 'mnt'
2074
+ | 'mop'
2075
+ | 'mro'
2076
+ | 'mvr'
2077
+ | 'mwk'
2078
+ | 'mxn'
2079
+ | 'myr'
2080
+ | 'mzn'
2081
+ | 'nad'
2082
+ | 'ngn'
2083
+ | 'nok'
2084
+ | 'npr'
2085
+ | 'nzd'
2086
+ | 'pgk'
2087
+ | 'php'
2088
+ | 'pkr'
2089
+ | 'pln'
2090
+ | 'qar'
2091
+ | 'ron'
2092
+ | 'rsd'
2093
+ | 'rub'
2094
+ | 'rwf'
2095
+ | 'sar'
2096
+ | 'sbd'
2097
+ | 'scr'
2098
+ | 'sek'
2099
+ | 'sgd'
2100
+ | 'sle'
2101
+ | 'sll'
2102
+ | 'sos'
2103
+ | 'szl'
2104
+ | 'thb'
2105
+ | 'tjs'
2106
+ | 'top'
2107
+ | 'try'
2108
+ | 'ttd'
2109
+ | 'tzs'
2110
+ | 'uah'
2111
+ | 'uzs'
2112
+ | 'vnd'
2113
+ | 'vuv'
2114
+ | 'wst'
2115
+ | 'xaf'
2116
+ | 'xcd'
2117
+ | 'yer'
2118
+ | 'zar'
2119
+ | 'zmw'
2120
+ | 'clp'
2121
+ | 'djf'
2122
+ | 'gnf'
2123
+ | 'ugx'
2124
+ | 'pyg'
2125
+ | 'xof'
2126
+ | 'xpf';
2127
+
2128
+ /**
2129
+ * Additional metadata
2130
+ */
2131
+ metadata?: { [key: string]: string };
2132
+
2133
+ /**
2134
+ * Billing provider payment method id, attached to this customer
2135
+ */
2136
+ paymentMethodId?: string;
2137
+ }
2138
+
2139
+ export namespace Zuora {
2140
+ /**
2141
+ * Physical address
2142
+ */
2143
+ export interface BillingAddress {
2144
+ /**
2145
+ * City name
2146
+ */
2147
+ city?: string;
2148
+
2149
+ /**
2150
+ * Country code or name
2151
+ */
2152
+ country?: string;
2153
+
2154
+ /**
2155
+ * Street address line 1
2156
+ */
2157
+ line1?: string;
2158
+
2159
+ /**
2160
+ * Street address line 2
2161
+ */
2162
+ line2?: string;
2163
+
2164
+ /**
2165
+ * Postal or ZIP code
2166
+ */
2167
+ postalCode?: string;
2168
+
2169
+ /**
2170
+ * State or province
2171
+ */
2172
+ state?: string;
2173
+ }
2174
+ }
2175
+ }
411
2176
  }
412
2177
 
413
- export interface CustomerUpdateParams {
2178
+ export interface CustomerListParams extends MyCursorIDPageParams {
2179
+ /**
2180
+ * Filter by creation date using range operators: gt, gte, lt, lte
2181
+ */
2182
+ createdAt?: CustomerListParams.CreatedAt;
2183
+
2184
+ /**
2185
+ * Filter by exact customer email address
2186
+ */
2187
+ email?: string;
2188
+
2189
+ /**
2190
+ * Filter by exact customer name
2191
+ */
2192
+ name?: string;
2193
+ }
2194
+
2195
+ export namespace CustomerListParams {
2196
+ /**
2197
+ * Filter by creation date using range operators: gt, gte, lt, lte
2198
+ */
2199
+ export interface CreatedAt {
2200
+ /**
2201
+ * Greater than the specified createdAt value
2202
+ */
2203
+ gt?: string;
2204
+
2205
+ /**
2206
+ * Greater than or equal to the specified createdAt value
2207
+ */
2208
+ gte?: string;
2209
+
2210
+ /**
2211
+ * Less than the specified createdAt value
2212
+ */
2213
+ lt?: string;
2214
+
2215
+ /**
2216
+ * Less than or equal to the specified createdAt value
2217
+ */
2218
+ lte?: string;
2219
+ }
2220
+ }
2221
+
2222
+ export interface CustomerImportParams {
2223
+ /**
2224
+ * List of customer objects to import
2225
+ */
2226
+ customers: Array<CustomerImportParams.Customer>;
2227
+
2228
+ /**
2229
+ * Integration details
2230
+ */
2231
+ integrationId?: string;
2232
+ }
2233
+
2234
+ export namespace CustomerImportParams {
2235
+ export interface Customer {
2236
+ /**
2237
+ * Customer slug
2238
+ */
2239
+ id: string;
2240
+
2241
+ /**
2242
+ * The email of the customer
2243
+ */
2244
+ email: string | null;
2245
+
2246
+ /**
2247
+ * The name of the customer
2248
+ */
2249
+ name: string | null;
2250
+
2251
+ /**
2252
+ * Id in the billing provider
2253
+ */
2254
+ billingId?: string;
2255
+
2256
+ /**
2257
+ * Additional metadata
2258
+ */
2259
+ metadata?: { [key: string]: string };
2260
+
2261
+ /**
2262
+ * Billing provider payment method id
2263
+ */
2264
+ paymentMethodId?: string;
2265
+
2266
+ /**
2267
+ * The unique identifier for the customer in Salesforce integration
2268
+ */
2269
+ salesforceId?: string;
2270
+
2271
+ /**
2272
+ * Timestamp of when the record was last updated
2273
+ */
2274
+ updatedAt?: string;
2275
+ }
2276
+ }
2277
+
2278
+ export interface CustomerListResourcesParams extends MyCursorIDPageParams {}
2279
+
2280
+ export interface CustomerProvisionParams {
2281
+ /**
2282
+ * Customer slug
2283
+ */
2284
+ id: string;
2285
+
2286
+ /**
2287
+ * The billing currency of the customer
2288
+ */
2289
+ billingCurrency?:
2290
+ | 'usd'
2291
+ | 'aed'
2292
+ | 'all'
2293
+ | 'amd'
2294
+ | 'ang'
2295
+ | 'aud'
2296
+ | 'awg'
2297
+ | 'azn'
2298
+ | 'bam'
2299
+ | 'bbd'
2300
+ | 'bdt'
2301
+ | 'bgn'
2302
+ | 'bif'
2303
+ | 'bmd'
2304
+ | 'bnd'
2305
+ | 'bsd'
2306
+ | 'bwp'
2307
+ | 'byn'
2308
+ | 'bzd'
2309
+ | 'brl'
2310
+ | 'cad'
2311
+ | 'cdf'
2312
+ | 'chf'
2313
+ | 'cny'
2314
+ | 'czk'
2315
+ | 'dkk'
2316
+ | 'dop'
2317
+ | 'dzd'
2318
+ | 'egp'
2319
+ | 'etb'
2320
+ | 'eur'
2321
+ | 'fjd'
2322
+ | 'gbp'
2323
+ | 'gel'
2324
+ | 'gip'
2325
+ | 'gmd'
2326
+ | 'gyd'
2327
+ | 'hkd'
2328
+ | 'hrk'
2329
+ | 'htg'
2330
+ | 'idr'
2331
+ | 'ils'
2332
+ | 'inr'
2333
+ | 'isk'
2334
+ | 'jmd'
2335
+ | 'jpy'
2336
+ | 'kes'
2337
+ | 'kgs'
2338
+ | 'khr'
2339
+ | 'kmf'
2340
+ | 'krw'
2341
+ | 'kyd'
2342
+ | 'kzt'
2343
+ | 'lbp'
2344
+ | 'lkr'
2345
+ | 'lrd'
2346
+ | 'lsl'
2347
+ | 'mad'
2348
+ | 'mdl'
2349
+ | 'mga'
2350
+ | 'mkd'
2351
+ | 'mmk'
2352
+ | 'mnt'
2353
+ | 'mop'
2354
+ | 'mro'
2355
+ | 'mvr'
2356
+ | 'mwk'
2357
+ | 'mxn'
2358
+ | 'myr'
2359
+ | 'mzn'
2360
+ | 'nad'
2361
+ | 'ngn'
2362
+ | 'nok'
2363
+ | 'npr'
2364
+ | 'nzd'
2365
+ | 'pgk'
2366
+ | 'php'
2367
+ | 'pkr'
2368
+ | 'pln'
2369
+ | 'qar'
2370
+ | 'ron'
2371
+ | 'rsd'
2372
+ | 'rub'
2373
+ | 'rwf'
2374
+ | 'sar'
2375
+ | 'sbd'
2376
+ | 'scr'
2377
+ | 'sek'
2378
+ | 'sgd'
2379
+ | 'sle'
2380
+ | 'sll'
2381
+ | 'sos'
2382
+ | 'szl'
2383
+ | 'thb'
2384
+ | 'tjs'
2385
+ | 'top'
2386
+ | 'try'
2387
+ | 'ttd'
2388
+ | 'tzs'
2389
+ | 'uah'
2390
+ | 'uzs'
2391
+ | 'vnd'
2392
+ | 'vuv'
2393
+ | 'wst'
2394
+ | 'xaf'
2395
+ | 'xcd'
2396
+ | 'yer'
2397
+ | 'zar'
2398
+ | 'zmw'
2399
+ | 'clp'
2400
+ | 'djf'
2401
+ | 'gnf'
2402
+ | 'ugx'
2403
+ | 'pyg'
2404
+ | 'xof'
2405
+ | 'xpf'
2406
+ | null;
2407
+
2408
+ /**
2409
+ * The unique identifier for the entity in the billing provider
2410
+ */
2411
+ billingId?: string | null;
2412
+
414
2413
  /**
415
2414
  * Customer level coupon
416
2415
  */
417
- couponId?: string | null;
2416
+ couponId?: (string & {}) | '' | null;
2417
+
2418
+ /**
2419
+ * The default payment method details
2420
+ */
2421
+ defaultPaymentMethod?: CustomerProvisionParams.DefaultPaymentMethod | null;
418
2422
 
419
2423
  /**
420
2424
  * The email of the customer
@@ -424,7 +2428,12 @@ export interface CustomerUpdateParams {
424
2428
  /**
425
2429
  * List of integrations
426
2430
  */
427
- integrations?: Array<CustomerUpdateParams.Integration>;
2431
+ integrations?: Array<CustomerProvisionParams.Integration>;
2432
+
2433
+ /**
2434
+ * Language to use for this customer
2435
+ */
2436
+ language?: string | null;
428
2437
 
429
2438
  /**
430
2439
  * Additional metadata
@@ -435,9 +2444,49 @@ export interface CustomerUpdateParams {
435
2444
  * The name of the customer
436
2445
  */
437
2446
  name?: string | null;
2447
+
2448
+ /**
2449
+ * Vendor-specific billing passthrough fields.
2450
+ */
2451
+ passthrough?: CustomerProvisionParams.Passthrough;
2452
+
2453
+ /**
2454
+ * Timezone to use for this customer
2455
+ */
2456
+ timezone?: string | null;
438
2457
  }
439
2458
 
440
- export namespace CustomerUpdateParams {
2459
+ export namespace CustomerProvisionParams {
2460
+ /**
2461
+ * The default payment method details
2462
+ */
2463
+ export interface DefaultPaymentMethod {
2464
+ /**
2465
+ * The default payment method id
2466
+ */
2467
+ billingId: string | null;
2468
+
2469
+ /**
2470
+ * The expiration month of the default payment method
2471
+ */
2472
+ cardExpiryMonth: number | null;
2473
+
2474
+ /**
2475
+ * The expiration year of the default payment method
2476
+ */
2477
+ cardExpiryYear: number | null;
2478
+
2479
+ /**
2480
+ * The last 4 digits of the default payment method
2481
+ */
2482
+ cardLast4Digits: string | null;
2483
+
2484
+ /**
2485
+ * The default payment method type
2486
+ */
2487
+ type: 'CARD' | 'BANK' | 'CASH_APP';
2488
+ }
2489
+
441
2490
  /**
442
2491
  * External billing or CRM integration link
443
2492
  */
@@ -467,24 +2516,380 @@ export namespace CustomerUpdateParams {
467
2516
  | 'OPEN_FGA'
468
2517
  | 'APP_STORE';
469
2518
  }
2519
+
2520
+ /**
2521
+ * Vendor-specific billing passthrough fields.
2522
+ */
2523
+ export interface Passthrough {
2524
+ /**
2525
+ * Stripe-specific billing fields for the customer.
2526
+ */
2527
+ stripe?: Passthrough.Stripe;
2528
+
2529
+ /**
2530
+ * Zuora-specific billing fields for the customer.
2531
+ */
2532
+ zuora?: Passthrough.Zuora;
2533
+ }
2534
+
2535
+ export namespace Passthrough {
2536
+ /**
2537
+ * Stripe-specific billing fields for the customer.
2538
+ */
2539
+ export interface Stripe {
2540
+ /**
2541
+ * Physical address
2542
+ */
2543
+ billingAddress?: Stripe.BillingAddress;
2544
+
2545
+ /**
2546
+ * Customer name
2547
+ */
2548
+ customerName?: string;
2549
+
2550
+ /**
2551
+ * Invoice custom fields
2552
+ */
2553
+ invoiceCustomFields?: { [key: string]: string };
2554
+
2555
+ /**
2556
+ * Additional metadata
2557
+ */
2558
+ metadata?: { [key: string]: string };
2559
+
2560
+ /**
2561
+ * Billing provider payment method id, attached to this customer
2562
+ */
2563
+ paymentMethodId?: string;
2564
+
2565
+ /**
2566
+ * Physical address
2567
+ */
2568
+ shippingAddress?: Stripe.ShippingAddress;
2569
+
2570
+ /**
2571
+ * Tax IDs
2572
+ */
2573
+ taxIds?: Array<Stripe.TaxID>;
2574
+ }
2575
+
2576
+ export namespace Stripe {
2577
+ /**
2578
+ * Physical address
2579
+ */
2580
+ export interface BillingAddress {
2581
+ /**
2582
+ * City name
2583
+ */
2584
+ city?: string;
2585
+
2586
+ /**
2587
+ * Country code or name
2588
+ */
2589
+ country?: string;
2590
+
2591
+ /**
2592
+ * Street address line 1
2593
+ */
2594
+ line1?: string;
2595
+
2596
+ /**
2597
+ * Street address line 2
2598
+ */
2599
+ line2?: string;
2600
+
2601
+ /**
2602
+ * Postal or ZIP code
2603
+ */
2604
+ postalCode?: string;
2605
+
2606
+ /**
2607
+ * State or province
2608
+ */
2609
+ state?: string;
2610
+ }
2611
+
2612
+ /**
2613
+ * Physical address
2614
+ */
2615
+ export interface ShippingAddress {
2616
+ /**
2617
+ * City name
2618
+ */
2619
+ city?: string;
2620
+
2621
+ /**
2622
+ * Country code or name
2623
+ */
2624
+ country?: string;
2625
+
2626
+ /**
2627
+ * Street address line 1
2628
+ */
2629
+ line1?: string;
2630
+
2631
+ /**
2632
+ * Street address line 2
2633
+ */
2634
+ line2?: string;
2635
+
2636
+ /**
2637
+ * Postal or ZIP code
2638
+ */
2639
+ postalCode?: string;
2640
+
2641
+ /**
2642
+ * State or province
2643
+ */
2644
+ state?: string;
2645
+ }
2646
+
2647
+ /**
2648
+ * Tax identifier with type and value for customer tax exemptions.
2649
+ */
2650
+ export interface TaxID {
2651
+ /**
2652
+ * The type of tax exemption identifier, such as VAT.
2653
+ */
2654
+ type: string;
2655
+
2656
+ /**
2657
+ * The actual tax identifier value
2658
+ */
2659
+ value: string;
2660
+ }
2661
+ }
2662
+
2663
+ /**
2664
+ * Zuora-specific billing fields for the customer.
2665
+ */
2666
+ export interface Zuora {
2667
+ /**
2668
+ * Physical address
2669
+ */
2670
+ billingAddress?: Zuora.BillingAddress;
2671
+
2672
+ /**
2673
+ * Customers selected currency
2674
+ */
2675
+ currency?:
2676
+ | 'usd'
2677
+ | 'aed'
2678
+ | 'all'
2679
+ | 'amd'
2680
+ | 'ang'
2681
+ | 'aud'
2682
+ | 'awg'
2683
+ | 'azn'
2684
+ | 'bam'
2685
+ | 'bbd'
2686
+ | 'bdt'
2687
+ | 'bgn'
2688
+ | 'bif'
2689
+ | 'bmd'
2690
+ | 'bnd'
2691
+ | 'bsd'
2692
+ | 'bwp'
2693
+ | 'byn'
2694
+ | 'bzd'
2695
+ | 'brl'
2696
+ | 'cad'
2697
+ | 'cdf'
2698
+ | 'chf'
2699
+ | 'cny'
2700
+ | 'czk'
2701
+ | 'dkk'
2702
+ | 'dop'
2703
+ | 'dzd'
2704
+ | 'egp'
2705
+ | 'etb'
2706
+ | 'eur'
2707
+ | 'fjd'
2708
+ | 'gbp'
2709
+ | 'gel'
2710
+ | 'gip'
2711
+ | 'gmd'
2712
+ | 'gyd'
2713
+ | 'hkd'
2714
+ | 'hrk'
2715
+ | 'htg'
2716
+ | 'idr'
2717
+ | 'ils'
2718
+ | 'inr'
2719
+ | 'isk'
2720
+ | 'jmd'
2721
+ | 'jpy'
2722
+ | 'kes'
2723
+ | 'kgs'
2724
+ | 'khr'
2725
+ | 'kmf'
2726
+ | 'krw'
2727
+ | 'kyd'
2728
+ | 'kzt'
2729
+ | 'lbp'
2730
+ | 'lkr'
2731
+ | 'lrd'
2732
+ | 'lsl'
2733
+ | 'mad'
2734
+ | 'mdl'
2735
+ | 'mga'
2736
+ | 'mkd'
2737
+ | 'mmk'
2738
+ | 'mnt'
2739
+ | 'mop'
2740
+ | 'mro'
2741
+ | 'mvr'
2742
+ | 'mwk'
2743
+ | 'mxn'
2744
+ | 'myr'
2745
+ | 'mzn'
2746
+ | 'nad'
2747
+ | 'ngn'
2748
+ | 'nok'
2749
+ | 'npr'
2750
+ | 'nzd'
2751
+ | 'pgk'
2752
+ | 'php'
2753
+ | 'pkr'
2754
+ | 'pln'
2755
+ | 'qar'
2756
+ | 'ron'
2757
+ | 'rsd'
2758
+ | 'rub'
2759
+ | 'rwf'
2760
+ | 'sar'
2761
+ | 'sbd'
2762
+ | 'scr'
2763
+ | 'sek'
2764
+ | 'sgd'
2765
+ | 'sle'
2766
+ | 'sll'
2767
+ | 'sos'
2768
+ | 'szl'
2769
+ | 'thb'
2770
+ | 'tjs'
2771
+ | 'top'
2772
+ | 'try'
2773
+ | 'ttd'
2774
+ | 'tzs'
2775
+ | 'uah'
2776
+ | 'uzs'
2777
+ | 'vnd'
2778
+ | 'vuv'
2779
+ | 'wst'
2780
+ | 'xaf'
2781
+ | 'xcd'
2782
+ | 'yer'
2783
+ | 'zar'
2784
+ | 'zmw'
2785
+ | 'clp'
2786
+ | 'djf'
2787
+ | 'gnf'
2788
+ | 'ugx'
2789
+ | 'pyg'
2790
+ | 'xof'
2791
+ | 'xpf';
2792
+
2793
+ /**
2794
+ * Additional metadata
2795
+ */
2796
+ metadata?: { [key: string]: string };
2797
+
2798
+ /**
2799
+ * Billing provider payment method id, attached to this customer
2800
+ */
2801
+ paymentMethodId?: string;
2802
+ }
2803
+
2804
+ export namespace Zuora {
2805
+ /**
2806
+ * Physical address
2807
+ */
2808
+ export interface BillingAddress {
2809
+ /**
2810
+ * City name
2811
+ */
2812
+ city?: string;
2813
+
2814
+ /**
2815
+ * Country code or name
2816
+ */
2817
+ country?: string;
2818
+
2819
+ /**
2820
+ * Street address line 1
2821
+ */
2822
+ line1?: string;
2823
+
2824
+ /**
2825
+ * Street address line 2
2826
+ */
2827
+ line2?: string;
2828
+
2829
+ /**
2830
+ * Postal or ZIP code
2831
+ */
2832
+ postalCode?: string;
2833
+
2834
+ /**
2835
+ * State or province
2836
+ */
2837
+ state?: string;
2838
+ }
2839
+ }
2840
+ }
470
2841
  }
471
2842
 
472
- export interface CustomerListParams extends MyCursorIDPageParams {}
2843
+ export interface CustomerRetrieveEntitlementsParams {
2844
+ /**
2845
+ * Resource ID to scope entitlements to a specific resource
2846
+ */
2847
+ resourceId?: string;
2848
+ }
473
2849
 
474
2850
  Customers.PaymentMethod = PaymentMethod;
475
- Customers.Usage = Usage;
2851
+ Customers.PromotionalEntitlements = PromotionalEntitlements;
2852
+ Customers.Integrations = Integrations;
476
2853
 
477
2854
  export declare namespace Customers {
478
2855
  export {
2856
+ type CustomerIntegrationResponse as CustomerIntegrationResponse,
479
2857
  type CustomerResponse as CustomerResponse,
480
2858
  type CustomerListResponse as CustomerListResponse,
2859
+ type CustomerImportResponse as CustomerImportResponse,
2860
+ type CustomerListResourcesResponse as CustomerListResourcesResponse,
2861
+ type CustomerRetrieveEntitlementsResponse as CustomerRetrieveEntitlementsResponse,
481
2862
  type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage,
482
- type CustomerCreateParams as CustomerCreateParams,
2863
+ type CustomerListResourcesResponsesMyCursorIDPage as CustomerListResourcesResponsesMyCursorIDPage,
483
2864
  type CustomerUpdateParams as CustomerUpdateParams,
484
2865
  type CustomerListParams as CustomerListParams,
2866
+ type CustomerImportParams as CustomerImportParams,
2867
+ type CustomerListResourcesParams as CustomerListResourcesParams,
2868
+ type CustomerProvisionParams as CustomerProvisionParams,
2869
+ type CustomerRetrieveEntitlementsParams as CustomerRetrieveEntitlementsParams,
485
2870
  };
486
2871
 
487
2872
  export { PaymentMethod as PaymentMethod, type PaymentMethodAttachParams as PaymentMethodAttachParams };
488
2873
 
489
- export { Usage as Usage };
2874
+ export {
2875
+ PromotionalEntitlements as PromotionalEntitlements,
2876
+ type PromotionalEntitlementCreateResponse as PromotionalEntitlementCreateResponse,
2877
+ type PromotionalEntitlementListResponse as PromotionalEntitlementListResponse,
2878
+ type PromotionalEntitlementRevokeResponse as PromotionalEntitlementRevokeResponse,
2879
+ type PromotionalEntitlementListResponsesMyCursorIDPage as PromotionalEntitlementListResponsesMyCursorIDPage,
2880
+ type PromotionalEntitlementCreateParams as PromotionalEntitlementCreateParams,
2881
+ type PromotionalEntitlementListParams as PromotionalEntitlementListParams,
2882
+ type PromotionalEntitlementRevokeParams as PromotionalEntitlementRevokeParams,
2883
+ };
2884
+
2885
+ export {
2886
+ Integrations as Integrations,
2887
+ type IntegrationListResponse as IntegrationListResponse,
2888
+ type IntegrationListResponsesMyCursorIDPage as IntegrationListResponsesMyCursorIDPage,
2889
+ type IntegrationRetrieveParams as IntegrationRetrieveParams,
2890
+ type IntegrationUpdateParams as IntegrationUpdateParams,
2891
+ type IntegrationListParams as IntegrationListParams,
2892
+ type IntegrationLinkParams as IntegrationLinkParams,
2893
+ type IntegrationUnlinkParams as IntegrationUnlinkParams,
2894
+ };
490
2895
  }