@stigg/typescript 0.1.0-beta.20 → 0.1.0-beta.21

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 (274) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/package.json +1 -1
  3. package/resources/v1/addons/addons.d.mts +143 -33
  4. package/resources/v1/addons/addons.d.mts.map +1 -1
  5. package/resources/v1/addons/addons.d.ts +143 -33
  6. package/resources/v1/addons/addons.d.ts.map +1 -1
  7. package/resources/v1/addons/addons.js +110 -17
  8. package/resources/v1/addons/addons.js.map +1 -1
  9. package/resources/v1/addons/addons.mjs +110 -17
  10. package/resources/v1/addons/addons.mjs.map +1 -1
  11. package/resources/v1/addons/entitlements.d.mts +62 -5
  12. package/resources/v1/addons/entitlements.d.mts.map +1 -1
  13. package/resources/v1/addons/entitlements.d.ts +62 -5
  14. package/resources/v1/addons/entitlements.d.ts.map +1 -1
  15. package/resources/v1/addons/entitlements.js +49 -8
  16. package/resources/v1/addons/entitlements.js.map +1 -1
  17. package/resources/v1/addons/entitlements.mjs +49 -8
  18. package/resources/v1/addons/entitlements.mjs.map +1 -1
  19. package/resources/v1/addons/index.d.mts +2 -2
  20. package/resources/v1/addons/index.d.mts.map +1 -1
  21. package/resources/v1/addons/index.d.ts +2 -2
  22. package/resources/v1/addons/index.d.ts.map +1 -1
  23. package/resources/v1/addons/index.js.map +1 -1
  24. package/resources/v1/addons/index.mjs.map +1 -1
  25. package/resources/v1/coupons.d.mts +80 -20
  26. package/resources/v1/coupons.d.mts.map +1 -1
  27. package/resources/v1/coupons.d.ts +80 -20
  28. package/resources/v1/coupons.d.ts.map +1 -1
  29. package/resources/v1/coupons.js +60 -9
  30. package/resources/v1/coupons.js.map +1 -1
  31. package/resources/v1/coupons.mjs +60 -9
  32. package/resources/v1/coupons.mjs.map +1 -1
  33. package/resources/v1/credits/credits.d.mts +59 -26
  34. package/resources/v1/credits/credits.d.mts.map +1 -1
  35. package/resources/v1/credits/credits.d.ts +59 -26
  36. package/resources/v1/credits/credits.d.ts.map +1 -1
  37. package/resources/v1/credits/credits.js +36 -5
  38. package/resources/v1/credits/credits.js.map +1 -1
  39. package/resources/v1/credits/credits.mjs +36 -5
  40. package/resources/v1/credits/credits.mjs.map +1 -1
  41. package/resources/v1/credits/custom-currencies.d.mts +96 -23
  42. package/resources/v1/credits/custom-currencies.d.mts.map +1 -1
  43. package/resources/v1/credits/custom-currencies.d.ts +96 -23
  44. package/resources/v1/credits/custom-currencies.d.ts.map +1 -1
  45. package/resources/v1/credits/custom-currencies.js +76 -12
  46. package/resources/v1/credits/custom-currencies.js.map +1 -1
  47. package/resources/v1/credits/custom-currencies.mjs +76 -12
  48. package/resources/v1/credits/custom-currencies.mjs.map +1 -1
  49. package/resources/v1/credits/grants.d.mts +60 -23
  50. package/resources/v1/credits/grants.d.mts.map +1 -1
  51. package/resources/v1/credits/grants.d.ts +60 -23
  52. package/resources/v1/credits/grants.d.ts.map +1 -1
  53. package/resources/v1/credits/grants.js +35 -5
  54. package/resources/v1/credits/grants.js.map +1 -1
  55. package/resources/v1/credits/grants.mjs +35 -5
  56. package/resources/v1/credits/grants.mjs.map +1 -1
  57. package/resources/v1/credits/index.d.mts +2 -2
  58. package/resources/v1/credits/index.d.mts.map +1 -1
  59. package/resources/v1/credits/index.d.ts +2 -2
  60. package/resources/v1/credits/index.d.ts.map +1 -1
  61. package/resources/v1/credits/index.js.map +1 -1
  62. package/resources/v1/credits/index.mjs.map +1 -1
  63. package/resources/v1/customers/customers.d.mts +165 -48
  64. package/resources/v1/customers/customers.d.mts.map +1 -1
  65. package/resources/v1/customers/customers.d.ts +165 -48
  66. package/resources/v1/customers/customers.d.ts.map +1 -1
  67. package/resources/v1/customers/customers.js +124 -19
  68. package/resources/v1/customers/customers.js.map +1 -1
  69. package/resources/v1/customers/customers.mjs +124 -19
  70. package/resources/v1/customers/customers.mjs.map +1 -1
  71. package/resources/v1/customers/index.d.mts +2 -2
  72. package/resources/v1/customers/index.d.mts.map +1 -1
  73. package/resources/v1/customers/index.d.ts +2 -2
  74. package/resources/v1/customers/index.d.ts.map +1 -1
  75. package/resources/v1/customers/index.js.map +1 -1
  76. package/resources/v1/customers/index.mjs +1 -1
  77. package/resources/v1/customers/index.mjs.map +1 -1
  78. package/resources/v1/customers/integrations.d.mts +64 -9
  79. package/resources/v1/customers/integrations.d.mts.map +1 -1
  80. package/resources/v1/customers/integrations.d.ts +64 -9
  81. package/resources/v1/customers/integrations.d.ts.map +1 -1
  82. package/resources/v1/customers/integrations.js +57 -9
  83. package/resources/v1/customers/integrations.js.map +1 -1
  84. package/resources/v1/customers/integrations.mjs +57 -9
  85. package/resources/v1/customers/integrations.mjs.map +1 -1
  86. package/resources/v1/customers/payment-method.d.mts +31 -7
  87. package/resources/v1/customers/payment-method.d.mts.map +1 -1
  88. package/resources/v1/customers/payment-method.d.ts +31 -7
  89. package/resources/v1/customers/payment-method.d.ts.map +1 -1
  90. package/resources/v1/customers/payment-method.js +26 -4
  91. package/resources/v1/customers/payment-method.js.map +1 -1
  92. package/resources/v1/customers/payment-method.mjs +26 -4
  93. package/resources/v1/customers/payment-method.mjs.map +1 -1
  94. package/resources/v1/customers/promotional-entitlements.d.mts +40 -7
  95. package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -1
  96. package/resources/v1/customers/promotional-entitlements.d.ts +40 -7
  97. package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -1
  98. package/resources/v1/customers/promotional-entitlements.js +38 -6
  99. package/resources/v1/customers/promotional-entitlements.js.map +1 -1
  100. package/resources/v1/customers/promotional-entitlements.mjs +38 -6
  101. package/resources/v1/customers/promotional-entitlements.mjs.map +1 -1
  102. package/resources/v1/events/beta/customers/assignments.d.mts +27 -5
  103. package/resources/v1/events/beta/customers/assignments.d.mts.map +1 -1
  104. package/resources/v1/events/beta/customers/assignments.d.ts +27 -5
  105. package/resources/v1/events/beta/customers/assignments.d.ts.map +1 -1
  106. package/resources/v1/events/beta/customers/assignments.js +27 -4
  107. package/resources/v1/events/beta/customers/assignments.js.map +1 -1
  108. package/resources/v1/events/beta/customers/assignments.mjs +27 -4
  109. package/resources/v1/events/beta/customers/assignments.mjs.map +1 -1
  110. package/resources/v1/events/beta/customers/entities.d.mts +66 -10
  111. package/resources/v1/events/beta/customers/entities.d.mts.map +1 -1
  112. package/resources/v1/events/beta/customers/entities.d.ts +66 -10
  113. package/resources/v1/events/beta/customers/entities.d.ts.map +1 -1
  114. package/resources/v1/events/beta/customers/entities.js +64 -10
  115. package/resources/v1/events/beta/customers/entities.js.map +1 -1
  116. package/resources/v1/events/beta/customers/entities.mjs +64 -10
  117. package/resources/v1/events/beta/customers/entities.mjs.map +1 -1
  118. package/resources/v1/events/beta/customers/entitlements.d.mts +23 -10
  119. package/resources/v1/events/beta/customers/entitlements.d.mts.map +1 -1
  120. package/resources/v1/events/beta/customers/entitlements.d.ts +23 -10
  121. package/resources/v1/events/beta/customers/entitlements.d.ts.map +1 -1
  122. package/resources/v1/events/beta/customers/entitlements.js +14 -2
  123. package/resources/v1/events/beta/customers/entitlements.js.map +1 -1
  124. package/resources/v1/events/beta/customers/entitlements.mjs +14 -2
  125. package/resources/v1/events/beta/customers/entitlements.mjs.map +1 -1
  126. package/resources/v1/events/beta/entity-types.d.mts +25 -3
  127. package/resources/v1/events/beta/entity-types.d.mts.map +1 -1
  128. package/resources/v1/events/beta/entity-types.d.ts +25 -3
  129. package/resources/v1/events/beta/entity-types.d.ts.map +1 -1
  130. package/resources/v1/events/beta/entity-types.js +23 -3
  131. package/resources/v1/events/beta/entity-types.js.map +1 -1
  132. package/resources/v1/events/beta/entity-types.mjs +23 -3
  133. package/resources/v1/events/beta/entity-types.mjs.map +1 -1
  134. package/resources/v1/events/events.d.mts +13 -2
  135. package/resources/v1/events/events.d.mts.map +1 -1
  136. package/resources/v1/events/events.d.ts +13 -2
  137. package/resources/v1/events/events.d.ts.map +1 -1
  138. package/resources/v1/events/events.js +14 -2
  139. package/resources/v1/events/events.js.map +1 -1
  140. package/resources/v1/events/events.mjs +14 -2
  141. package/resources/v1/events/events.mjs.map +1 -1
  142. package/resources/v1/features.d.mts +108 -30
  143. package/resources/v1/features.d.mts.map +1 -1
  144. package/resources/v1/features.d.ts +108 -30
  145. package/resources/v1/features.d.ts.map +1 -1
  146. package/resources/v1/features.js +72 -11
  147. package/resources/v1/features.js.map +1 -1
  148. package/resources/v1/features.mjs +72 -11
  149. package/resources/v1/features.mjs.map +1 -1
  150. package/resources/v1/index.d.mts +7 -7
  151. package/resources/v1/index.d.mts.map +1 -1
  152. package/resources/v1/index.d.ts +7 -7
  153. package/resources/v1/index.d.ts.map +1 -1
  154. package/resources/v1/index.js.map +1 -1
  155. package/resources/v1/index.mjs.map +1 -1
  156. package/resources/v1/plans/entitlements.d.mts +62 -5
  157. package/resources/v1/plans/entitlements.d.mts.map +1 -1
  158. package/resources/v1/plans/entitlements.d.ts +62 -5
  159. package/resources/v1/plans/entitlements.d.ts.map +1 -1
  160. package/resources/v1/plans/entitlements.js +49 -8
  161. package/resources/v1/plans/entitlements.js.map +1 -1
  162. package/resources/v1/plans/entitlements.mjs +49 -8
  163. package/resources/v1/plans/entitlements.mjs.map +1 -1
  164. package/resources/v1/plans/index.d.mts +2 -2
  165. package/resources/v1/plans/index.d.mts.map +1 -1
  166. package/resources/v1/plans/index.d.ts +2 -2
  167. package/resources/v1/plans/index.d.ts.map +1 -1
  168. package/resources/v1/plans/index.js.map +1 -1
  169. package/resources/v1/plans/index.mjs.map +1 -1
  170. package/resources/v1/plans/plans.d.mts +156 -34
  171. package/resources/v1/plans/plans.d.mts.map +1 -1
  172. package/resources/v1/plans/plans.d.ts +156 -34
  173. package/resources/v1/plans/plans.d.ts.map +1 -1
  174. package/resources/v1/plans/plans.js +127 -20
  175. package/resources/v1/plans/plans.js.map +1 -1
  176. package/resources/v1/plans/plans.mjs +127 -20
  177. package/resources/v1/plans/plans.mjs.map +1 -1
  178. package/resources/v1/products.d.mts +97 -23
  179. package/resources/v1/products.d.mts.map +1 -1
  180. package/resources/v1/products.d.ts +97 -23
  181. package/resources/v1/products.d.ts.map +1 -1
  182. package/resources/v1/products.js +73 -11
  183. package/resources/v1/products.js.map +1 -1
  184. package/resources/v1/products.mjs +73 -11
  185. package/resources/v1/products.mjs.map +1 -1
  186. package/resources/v1/subscriptions/future-update.d.mts +29 -3
  187. package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
  188. package/resources/v1/subscriptions/future-update.d.ts +29 -3
  189. package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
  190. package/resources/v1/subscriptions/future-update.js +25 -4
  191. package/resources/v1/subscriptions/future-update.js.map +1 -1
  192. package/resources/v1/subscriptions/future-update.mjs +25 -4
  193. package/resources/v1/subscriptions/future-update.mjs.map +1 -1
  194. package/resources/v1/subscriptions/index.d.mts +4 -4
  195. package/resources/v1/subscriptions/index.d.mts.map +1 -1
  196. package/resources/v1/subscriptions/index.d.ts +4 -4
  197. package/resources/v1/subscriptions/index.d.ts.map +1 -1
  198. package/resources/v1/subscriptions/index.js.map +1 -1
  199. package/resources/v1/subscriptions/index.mjs +1 -1
  200. package/resources/v1/subscriptions/index.mjs.map +1 -1
  201. package/resources/v1/subscriptions/invoice.d.mts +15 -2
  202. package/resources/v1/subscriptions/invoice.d.mts.map +1 -1
  203. package/resources/v1/subscriptions/invoice.d.ts +15 -2
  204. package/resources/v1/subscriptions/invoice.d.ts.map +1 -1
  205. package/resources/v1/subscriptions/invoice.js +13 -2
  206. package/resources/v1/subscriptions/invoice.js.map +1 -1
  207. package/resources/v1/subscriptions/invoice.mjs +13 -2
  208. package/resources/v1/subscriptions/invoice.mjs.map +1 -1
  209. package/resources/v1/subscriptions/subscriptions.d.mts +242 -78
  210. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  211. package/resources/v1/subscriptions/subscriptions.d.ts +242 -78
  212. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  213. package/resources/v1/subscriptions/subscriptions.js +126 -19
  214. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  215. package/resources/v1/subscriptions/subscriptions.mjs +128 -21
  216. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  217. package/resources/v1/subscriptions/usage.d.mts +29 -4
  218. package/resources/v1/subscriptions/usage.d.mts.map +1 -1
  219. package/resources/v1/subscriptions/usage.d.ts +29 -4
  220. package/resources/v1/subscriptions/usage.d.ts.map +1 -1
  221. package/resources/v1/subscriptions/usage.js +26 -4
  222. package/resources/v1/subscriptions/usage.js.map +1 -1
  223. package/resources/v1/subscriptions/usage.mjs +26 -4
  224. package/resources/v1/subscriptions/usage.mjs.map +1 -1
  225. package/resources/v1/usage.d.mts +24 -2
  226. package/resources/v1/usage.d.mts.map +1 -1
  227. package/resources/v1/usage.d.ts +24 -2
  228. package/resources/v1/usage.d.ts.map +1 -1
  229. package/resources/v1/usage.js +26 -4
  230. package/resources/v1/usage.js.map +1 -1
  231. package/resources/v1/usage.mjs +26 -4
  232. package/resources/v1/usage.mjs.map +1 -1
  233. package/resources/v1/v1.d.mts +14 -14
  234. package/resources/v1/v1.d.mts.map +1 -1
  235. package/resources/v1/v1.d.ts +14 -14
  236. package/resources/v1/v1.d.ts.map +1 -1
  237. package/resources/v1/v1.js.map +1 -1
  238. package/resources/v1/v1.mjs.map +1 -1
  239. package/src/resources/v1/addons/addons.ts +286 -39
  240. package/src/resources/v1/addons/entitlements.ts +123 -10
  241. package/src/resources/v1/addons/index.ts +5 -0
  242. package/src/resources/v1/coupons.ts +154 -23
  243. package/src/resources/v1/credits/credits.ts +102 -24
  244. package/src/resources/v1/credits/custom-currencies.ts +188 -30
  245. package/src/resources/v1/credits/grants.ts +102 -24
  246. package/src/resources/v1/credits/index.ts +4 -0
  247. package/src/resources/v1/customers/customers.ts +318 -57
  248. package/src/resources/v1/customers/index.ts +8 -1
  249. package/src/resources/v1/customers/integrations.ts +129 -16
  250. package/src/resources/v1/customers/payment-method.ts +66 -9
  251. package/src/resources/v1/customers/promotional-entitlements.ts +82 -11
  252. package/src/resources/v1/events/beta/customers/assignments.ts +56 -7
  253. package/src/resources/v1/events/beta/customers/entities.ts +136 -16
  254. package/src/resources/v1/events/beta/customers/entitlements.ts +38 -11
  255. package/src/resources/v1/events/beta/entity-types.ts +51 -5
  256. package/src/resources/v1/events/events.ts +28 -3
  257. package/src/resources/v1/features.ts +204 -34
  258. package/src/resources/v1/index.ts +19 -0
  259. package/src/resources/v1/plans/entitlements.ts +123 -10
  260. package/src/resources/v1/plans/index.ts +5 -0
  261. package/src/resources/v1/plans/plans.ts +314 -43
  262. package/src/resources/v1/products.ts +189 -27
  263. package/src/resources/v1/subscriptions/future-update.ts +68 -5
  264. package/src/resources/v1/subscriptions/index.ts +9 -2
  265. package/src/resources/v1/subscriptions/invoice.ts +36 -3
  266. package/src/resources/v1/subscriptions/subscriptions.ts +410 -85
  267. package/src/resources/v1/subscriptions/usage.ts +61 -5
  268. package/src/resources/v1/usage.ts +53 -5
  269. package/src/resources/v1/v1.ts +38 -0
  270. package/src/version.ts +1 -1
  271. package/version.d.mts +1 -1
  272. package/version.d.ts +1 -1
  273. package/version.js +1 -1
  274. package/version.mjs +1 -1
@@ -4,12 +4,15 @@ import { APIResource } from '../../../core/resource';
4
4
  import * as CustomCurrenciesAPI from './custom-currencies';
5
5
  import {
6
6
  CustomCurrencies,
7
+ CustomCurrencyArchiveParams,
7
8
  CustomCurrencyCreateParams,
9
+ CustomCurrencyListAssociatedEntitiesParams,
8
10
  CustomCurrencyListAssociatedEntitiesResponse,
9
11
  CustomCurrencyListParams,
10
12
  CustomCurrencyListResponse,
11
13
  CustomCurrencyListResponsesMyCursorIDPage,
12
14
  CustomCurrencyResponse,
15
+ CustomCurrencyUnarchiveParams,
13
16
  CustomCurrencyUpdateParams,
14
17
  } from './custom-currencies';
15
18
  import * as GrantsAPI from './grants';
@@ -19,10 +22,12 @@ import {
19
22
  GrantListParams,
20
23
  GrantListResponse,
21
24
  GrantListResponsesMyCursorIDPage,
25
+ GrantVoidParams,
22
26
  Grants,
23
27
  } from './grants';
24
28
  import { APIPromise } from '../../../core/api-promise';
25
29
  import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
30
+ import { buildHeaders } from '../../../internal/headers';
26
31
  import { RequestOptions } from '../../../internal/request-options';
27
32
 
28
33
  export class Credits extends APIResource {
@@ -44,10 +49,21 @@ export class Credits extends APIResource {
44
49
  * ```
45
50
  */
46
51
  getAutoRecharge(
47
- query: CreditGetAutoRechargeParams,
52
+ params: CreditGetAutoRechargeParams,
48
53
  options?: RequestOptions,
49
54
  ): APIPromise<CreditGetAutoRechargeResponse> {
50
- return this._client.get('/api/v1/credits/auto-recharge', { query, ...options });
55
+ const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params;
56
+ return this._client.get('/api/v1/credits/auto-recharge', {
57
+ query,
58
+ ...options,
59
+ headers: buildHeaders([
60
+ {
61
+ ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
62
+ ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
63
+ },
64
+ options?.headers,
65
+ ]),
66
+ });
51
67
  }
52
68
 
53
69
  /**
@@ -61,8 +77,19 @@ export class Credits extends APIResource {
61
77
  * });
62
78
  * ```
63
79
  */
64
- getUsage(query: CreditGetUsageParams, options?: RequestOptions): APIPromise<CreditGetUsageResponse> {
65
- return this._client.get('/api/v1/credits/usage', { query, ...options });
80
+ getUsage(params: CreditGetUsageParams, options?: RequestOptions): APIPromise<CreditGetUsageResponse> {
81
+ const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params;
82
+ return this._client.get('/api/v1/credits/usage', {
83
+ query,
84
+ ...options,
85
+ headers: buildHeaders([
86
+ {
87
+ ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
88
+ ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
89
+ },
90
+ options?.headers,
91
+ ]),
92
+ });
66
93
  }
67
94
 
68
95
  /**
@@ -79,12 +106,20 @@ export class Credits extends APIResource {
79
106
  * ```
80
107
  */
81
108
  listLedger(
82
- query: CreditListLedgerParams,
109
+ params: CreditListLedgerParams,
83
110
  options?: RequestOptions,
84
111
  ): PagePromise<CreditListLedgerResponsesMyCursorIDPage, CreditListLedgerResponse> {
112
+ const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params;
85
113
  return this._client.getAPIList('/api/v1/credits/ledger', MyCursorIDPage<CreditListLedgerResponse>, {
86
114
  query,
87
115
  ...options,
116
+ headers: buildHeaders([
117
+ {
118
+ ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
119
+ ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
120
+ },
121
+ options?.headers,
122
+ ]),
88
123
  });
89
124
  }
90
125
  }
@@ -368,87 +403,126 @@ export interface CreditListLedgerResponse {
368
403
 
369
404
  export interface CreditGetAutoRechargeParams {
370
405
  /**
371
- * Filter by currency ID (required)
406
+ * Query param: Filter by currency ID (required)
372
407
  */
373
408
  currencyId: string;
374
409
 
375
410
  /**
376
- * Filter by customer ID (required)
411
+ * Query param: Filter by customer ID (required)
377
412
  */
378
413
  customerId: string;
414
+
415
+ /**
416
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
417
+ * token); falls back to the user's first membership. Ignored for API-key auth.
418
+ */
419
+ 'X-ACCOUNT-ID'?: string;
420
+
421
+ /**
422
+ * Header param: Environment ID — required when authenticating with a user JWT
423
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
424
+ * intrinsic to the key).
425
+ */
426
+ 'X-ENVIRONMENT-ID'?: string;
379
427
  }
380
428
 
381
429
  export interface CreditGetUsageParams {
382
430
  /**
383
- * Filter by customer ID (required)
431
+ * Query param: Filter by customer ID (required)
384
432
  */
385
433
  customerId: string;
386
434
 
387
435
  /**
388
- * Return items that come after this cursor
436
+ * Query param: Return items that come after this cursor
389
437
  */
390
438
  after?: string;
391
439
 
392
440
  /**
393
- * Return items that come before this cursor
441
+ * Query param: Return items that come before this cursor
394
442
  */
395
443
  before?: string;
396
444
 
397
445
  /**
398
- * Filter by currency ID
446
+ * Query param: Filter by currency ID
399
447
  */
400
448
  currencyId?: string;
401
449
 
402
450
  /**
403
- * End date for the credit usage time range (ISO 8601). Defaults to now when
404
- * startDate is provided
451
+ * Query param: End date for the credit usage time range (ISO 8601). Defaults to
452
+ * now when startDate is provided
405
453
  */
406
454
  endDate?: string;
407
455
 
408
456
  /**
409
- * Comma-separated list of feature dimension keys to group usage series by (up to
410
- * 3). Each key matches /^[a-zA-Z0-9_$-]+$/
457
+ * Query param: Comma-separated list of feature dimension keys to group usage
458
+ * series by (up to 3). Each key matches /^[a-zA-Z0-9_$-]+$/
411
459
  */
412
460
  groupBy?: string;
413
461
 
414
462
  /**
415
- * Maximum number of items to return
463
+ * Query param: Maximum number of items to return
416
464
  */
417
465
  limit?: number;
418
466
 
419
467
  /**
420
- * Filter by resource ID
468
+ * Query param: Filter by resource ID
421
469
  */
422
470
  resourceId?: string;
423
471
 
424
472
  /**
425
- * Start date for the credit usage time range (ISO 8601). Takes precedence over
426
- * timeRange when provided
473
+ * Query param: Start date for the credit usage time range (ISO 8601). Takes
474
+ * precedence over timeRange when provided
427
475
  */
428
476
  startDate?: string;
429
477
 
430
478
  /**
431
- * Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH, LAST_YEAR). Defaults
432
- * to LAST_MONTH
479
+ * Query param: Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH,
480
+ * LAST_YEAR). Defaults to LAST_MONTH
433
481
  */
434
482
  timeRange?: 'LAST_DAY' | 'LAST_WEEK' | 'LAST_MONTH' | 'LAST_YEAR';
483
+
484
+ /**
485
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
486
+ * token); falls back to the user's first membership. Ignored for API-key auth.
487
+ */
488
+ 'X-ACCOUNT-ID'?: string;
489
+
490
+ /**
491
+ * Header param: Environment ID — required when authenticating with a user JWT
492
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
493
+ * intrinsic to the key).
494
+ */
495
+ 'X-ENVIRONMENT-ID'?: string;
435
496
  }
436
497
 
437
498
  export interface CreditListLedgerParams extends MyCursorIDPageParams {
438
499
  /**
439
- * Filter by customer ID (required)
500
+ * Query param: Filter by customer ID (required)
440
501
  */
441
502
  customerId: string;
442
503
 
443
504
  /**
444
- * Filter by currency ID
505
+ * Query param: Filter by currency ID
445
506
  */
446
507
  currencyId?: string;
447
508
 
448
509
  /**
449
- * Filter by resource ID
510
+ * Query param: Filter by resource ID
450
511
  */
451
512
  resourceId?: string;
513
+
514
+ /**
515
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
516
+ * token); falls back to the user's first membership. Ignored for API-key auth.
517
+ */
518
+ 'X-ACCOUNT-ID'?: string;
519
+
520
+ /**
521
+ * Header param: Environment ID — required when authenticating with a user JWT
522
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
523
+ * intrinsic to the key).
524
+ */
525
+ 'X-ENVIRONMENT-ID'?: string;
452
526
  }
453
527
 
454
528
  Credits.Grants = Grants;
@@ -472,6 +546,7 @@ export declare namespace Credits {
472
546
  type GrantListResponsesMyCursorIDPage as GrantListResponsesMyCursorIDPage,
473
547
  type GrantCreateParams as GrantCreateParams,
474
548
  type GrantListParams as GrantListParams,
549
+ type GrantVoidParams as GrantVoidParams,
475
550
  };
476
551
 
477
552
  export {
@@ -483,5 +558,8 @@ export declare namespace Credits {
483
558
  type CustomCurrencyCreateParams as CustomCurrencyCreateParams,
484
559
  type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams,
485
560
  type CustomCurrencyListParams as CustomCurrencyListParams,
561
+ type CustomCurrencyArchiveParams as CustomCurrencyArchiveParams,
562
+ type CustomCurrencyListAssociatedEntitiesParams as CustomCurrencyListAssociatedEntitiesParams,
563
+ type CustomCurrencyUnarchiveParams as CustomCurrencyUnarchiveParams,
486
564
  };
487
565
  }
@@ -3,6 +3,7 @@
3
3
  import { APIResource } from '../../../core/resource';
4
4
  import { APIPromise } from '../../../core/api-promise';
5
5
  import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from '../../../core/pagination';
6
+ import { buildHeaders } from '../../../internal/headers';
6
7
  import { RequestOptions } from '../../../internal/request-options';
7
8
  import { path } from '../../../internal/utils/path';
8
9
 
@@ -22,8 +23,19 @@ export class CustomCurrencies extends APIResource {
22
23
  * });
23
24
  * ```
24
25
  */
25
- create(body: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse> {
26
- return this._client.post('/api/v1/credits/custom-currencies', { body, ...options });
26
+ create(params: CustomCurrencyCreateParams, options?: RequestOptions): APIPromise<CustomCurrencyResponse> {
27
+ const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
28
+ return this._client.post('/api/v1/credits/custom-currencies', {
29
+ body,
30
+ ...options,
31
+ headers: buildHeaders([
32
+ {
33
+ ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
34
+ ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
35
+ },
36
+ options?.headers,
37
+ ]),
38
+ });
27
39
  }
28
40
 
29
41
  /**
@@ -39,10 +51,21 @@ export class CustomCurrencies extends APIResource {
39
51
  */
40
52
  update(
41
53
  currencyID: string,
42
- body: CustomCurrencyUpdateParams,
54
+ params: CustomCurrencyUpdateParams,
43
55
  options?: RequestOptions,
44
56
  ): APIPromise<CustomCurrencyResponse> {
45
- return this._client.patch(path`/api/v1/credits/custom-currencies/${currencyID}`, { body, ...options });
57
+ const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
58
+ return this._client.patch(path`/api/v1/credits/custom-currencies/${currencyID}`, {
59
+ body,
60
+ ...options,
61
+ headers: buildHeaders([
62
+ {
63
+ ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
64
+ ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
65
+ },
66
+ options?.headers,
67
+ ]),
68
+ });
46
69
  }
47
70
 
48
71
  /**
@@ -59,13 +82,24 @@ export class CustomCurrencies extends APIResource {
59
82
  * ```
60
83
  */
61
84
  list(
62
- query: CustomCurrencyListParams | null | undefined = {},
85
+ params: CustomCurrencyListParams | null | undefined = {},
63
86
  options?: RequestOptions,
64
87
  ): PagePromise<CustomCurrencyListResponsesMyCursorIDPage, CustomCurrencyListResponse> {
88
+ const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...query } = params ?? {};
65
89
  return this._client.getAPIList(
66
90
  '/api/v1/credits/custom-currencies',
67
91
  MyCursorIDPage<CustomCurrencyListResponse>,
68
- { query, ...options },
92
+ {
93
+ query,
94
+ ...options,
95
+ headers: buildHeaders([
96
+ {
97
+ ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
98
+ ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
99
+ },
100
+ options?.headers,
101
+ ]),
102
+ },
69
103
  );
70
104
  }
71
105
 
@@ -82,8 +116,22 @@ export class CustomCurrencies extends APIResource {
82
116
  * );
83
117
  * ```
84
118
  */
85
- archive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyResponse> {
86
- return this._client.post(path`/api/v1/credits/custom-currencies/${currencyID}/archive`, options);
119
+ archive(
120
+ currencyID: string,
121
+ params: CustomCurrencyArchiveParams | null | undefined = {},
122
+ options?: RequestOptions,
123
+ ): APIPromise<CustomCurrencyResponse> {
124
+ const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
125
+ return this._client.post(path`/api/v1/credits/custom-currencies/${currencyID}/archive`, {
126
+ ...options,
127
+ headers: buildHeaders([
128
+ {
129
+ ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
130
+ ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
131
+ },
132
+ options?.headers,
133
+ ]),
134
+ });
87
135
  }
88
136
 
89
137
  /**
@@ -100,12 +148,20 @@ export class CustomCurrencies extends APIResource {
100
148
  */
101
149
  listAssociatedEntities(
102
150
  currencyID: string,
151
+ params: CustomCurrencyListAssociatedEntitiesParams | null | undefined = {},
103
152
  options?: RequestOptions,
104
153
  ): APIPromise<CustomCurrencyListAssociatedEntitiesResponse> {
105
- return this._client.get(
106
- path`/api/v1/credits/custom-currencies/${currencyID}/associated-entities`,
107
- options,
108
- );
154
+ const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
155
+ return this._client.get(path`/api/v1/credits/custom-currencies/${currencyID}/associated-entities`, {
156
+ ...options,
157
+ headers: buildHeaders([
158
+ {
159
+ ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
160
+ ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
161
+ },
162
+ options?.headers,
163
+ ]),
164
+ });
109
165
  }
110
166
 
111
167
  /**
@@ -120,8 +176,22 @@ export class CustomCurrencies extends APIResource {
120
176
  * );
121
177
  * ```
122
178
  */
123
- unarchive(currencyID: string, options?: RequestOptions): APIPromise<CustomCurrencyResponse> {
124
- return this._client.post(path`/api/v1/credits/custom-currencies/${currencyID}/unarchive`, options);
179
+ unarchive(
180
+ currencyID: string,
181
+ params: CustomCurrencyUnarchiveParams | null | undefined = {},
182
+ options?: RequestOptions,
183
+ ): APIPromise<CustomCurrencyResponse> {
184
+ const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID } = params ?? {};
185
+ return this._client.post(path`/api/v1/credits/custom-currencies/${currencyID}/unarchive`, {
186
+ ...options,
187
+ headers: buildHeaders([
188
+ {
189
+ ...(xAccountID != null ? { 'X-ACCOUNT-ID': xAccountID } : undefined),
190
+ ...(xEnvironmentID != null ? { 'X-ENVIRONMENT-ID': xEnvironmentID } : undefined),
191
+ },
192
+ options?.headers,
193
+ ]),
194
+ });
125
195
  }
126
196
  }
127
197
 
@@ -304,35 +374,48 @@ export namespace CustomCurrencyListAssociatedEntitiesResponse {
304
374
 
305
375
  export interface CustomCurrencyCreateParams {
306
376
  /**
307
- * The unique identifier for the new custom currency
377
+ * Body param: The unique identifier for the new custom currency
308
378
  */
309
379
  id: string;
310
380
 
311
381
  /**
312
- * The display name of the custom currency
382
+ * Body param: The display name of the custom currency
313
383
  */
314
384
  displayName: string;
315
385
 
316
386
  /**
317
- * Description of the currency
387
+ * Body param: Description of the currency
318
388
  */
319
389
  description?: string;
320
390
 
321
391
  /**
322
- * Additional metadata to attach to the custom currency
392
+ * Body param: Additional metadata to attach to the custom currency
323
393
  */
324
394
  metadata?: { [key: string]: string };
325
395
 
326
396
  /**
327
- * The symbol used to represent the custom currency
397
+ * Body param: The symbol used to represent the custom currency
328
398
  */
329
399
  symbol?: string;
330
400
 
331
401
  /**
332
- * Singular and plural unit labels for a custom currency. Both fields are required
333
- * when supplied.
402
+ * Body param: Singular and plural unit labels for a custom currency. Both fields
403
+ * are required when supplied.
334
404
  */
335
405
  units?: CustomCurrencyCreateParams.Units;
406
+
407
+ /**
408
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
409
+ * token); falls back to the user's first membership. Ignored for API-key auth.
410
+ */
411
+ 'X-ACCOUNT-ID'?: string;
412
+
413
+ /**
414
+ * Header param: Environment ID — required when authenticating with a user JWT
415
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
416
+ * intrinsic to the key).
417
+ */
418
+ 'X-ENVIRONMENT-ID'?: string;
336
419
  }
337
420
 
338
421
  export namespace CustomCurrencyCreateParams {
@@ -355,31 +438,45 @@ export namespace CustomCurrencyCreateParams {
355
438
 
356
439
  export interface CustomCurrencyUpdateParams {
357
440
  /**
358
- * A human-readable description of the custom currency. Send an empty string to
359
- * clear.
441
+ * Body param: A human-readable description of the custom currency. Send an empty
442
+ * string to clear.
360
443
  */
361
444
  description?: string | null;
362
445
 
363
446
  /**
364
- * The display name of the custom currency
447
+ * Body param: The display name of the custom currency
365
448
  */
366
449
  displayName?: string;
367
450
 
368
451
  /**
369
- * Additional metadata to attach to the custom currency
452
+ * Body param: Additional metadata to attach to the custom currency
370
453
  */
371
454
  metadata?: { [key: string]: string } | null;
372
455
 
373
456
  /**
374
- * The symbol used to represent the custom currency. Send an empty string to clear.
457
+ * Body param: The symbol used to represent the custom currency. Send an empty
458
+ * string to clear.
375
459
  */
376
460
  symbol?: string | null;
377
461
 
378
462
  /**
379
- * Singular and plural unit labels for a custom currency. Both fields are required
380
- * when supplied.
463
+ * Body param: Singular and plural unit labels for a custom currency. Both fields
464
+ * are required when supplied.
381
465
  */
382
466
  units?: CustomCurrencyUpdateParams.Units;
467
+
468
+ /**
469
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
470
+ * token); falls back to the user's first membership. Ignored for API-key auth.
471
+ */
472
+ 'X-ACCOUNT-ID'?: string;
473
+
474
+ /**
475
+ * Header param: Environment ID — required when authenticating with a user JWT
476
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
477
+ * intrinsic to the key).
478
+ */
479
+ 'X-ENVIRONMENT-ID'?: string;
383
480
  }
384
481
 
385
482
  export namespace CustomCurrencyUpdateParams {
@@ -402,10 +499,68 @@ export namespace CustomCurrencyUpdateParams {
402
499
 
403
500
  export interface CustomCurrencyListParams extends MyCursorIDPageParams {
404
501
  /**
405
- * Filter by custom currency status. Supports comma-separated values (e.g.,
406
- * `ACTIVE,ARCHIVED`). Defaults to `ACTIVE`.
502
+ * Query param: Filter by custom currency status. Supports comma-separated values
503
+ * (e.g., `ACTIVE,ARCHIVED`). Defaults to `ACTIVE`.
407
504
  */
408
505
  status?: Array<'ACTIVE' | 'ARCHIVED'>;
506
+
507
+ /**
508
+ * Header param: Account ID — optional when authenticating with a user JWT (Bearer
509
+ * token); falls back to the user's first membership. Ignored for API-key auth.
510
+ */
511
+ 'X-ACCOUNT-ID'?: string;
512
+
513
+ /**
514
+ * Header param: Environment ID — required when authenticating with a user JWT
515
+ * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
516
+ * intrinsic to the key).
517
+ */
518
+ 'X-ENVIRONMENT-ID'?: string;
519
+ }
520
+
521
+ export interface CustomCurrencyArchiveParams {
522
+ /**
523
+ * Account ID — optional when authenticating with a user JWT (Bearer token); falls
524
+ * back to the user's first membership. Ignored for API-key auth.
525
+ */
526
+ 'X-ACCOUNT-ID'?: string;
527
+
528
+ /**
529
+ * Environment ID — required when authenticating with a user JWT (Bearer token) on
530
+ * environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
531
+ * key).
532
+ */
533
+ 'X-ENVIRONMENT-ID'?: string;
534
+ }
535
+
536
+ export interface CustomCurrencyListAssociatedEntitiesParams {
537
+ /**
538
+ * Account ID — optional when authenticating with a user JWT (Bearer token); falls
539
+ * back to the user's first membership. Ignored for API-key auth.
540
+ */
541
+ 'X-ACCOUNT-ID'?: string;
542
+
543
+ /**
544
+ * Environment ID — required when authenticating with a user JWT (Bearer token) on
545
+ * environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
546
+ * key).
547
+ */
548
+ 'X-ENVIRONMENT-ID'?: string;
549
+ }
550
+
551
+ export interface CustomCurrencyUnarchiveParams {
552
+ /**
553
+ * Account ID — optional when authenticating with a user JWT (Bearer token); falls
554
+ * back to the user's first membership. Ignored for API-key auth.
555
+ */
556
+ 'X-ACCOUNT-ID'?: string;
557
+
558
+ /**
559
+ * Environment ID — required when authenticating with a user JWT (Bearer token) on
560
+ * environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
561
+ * key).
562
+ */
563
+ 'X-ENVIRONMENT-ID'?: string;
409
564
  }
410
565
 
411
566
  export declare namespace CustomCurrencies {
@@ -417,5 +572,8 @@ export declare namespace CustomCurrencies {
417
572
  type CustomCurrencyCreateParams as CustomCurrencyCreateParams,
418
573
  type CustomCurrencyUpdateParams as CustomCurrencyUpdateParams,
419
574
  type CustomCurrencyListParams as CustomCurrencyListParams,
575
+ type CustomCurrencyArchiveParams as CustomCurrencyArchiveParams,
576
+ type CustomCurrencyListAssociatedEntitiesParams as CustomCurrencyListAssociatedEntitiesParams,
577
+ type CustomCurrencyUnarchiveParams as CustomCurrencyUnarchiveParams,
420
578
  };
421
579
  }