@stigg/typescript 0.1.0-alpha.1 → 0.1.0-alpha.11

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 (317) hide show
  1. package/CHANGELOG.md +158 -0
  2. package/README.md +40 -0
  3. package/client.d.mts +6 -8
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +6 -8
  6. package/client.d.ts.map +1 -1
  7. package/client.js +23 -21
  8. package/client.js.map +1 -1
  9. package/client.mjs +24 -22
  10. package/client.mjs.map +1 -1
  11. package/core/pagination.d.mts +11 -5
  12. package/core/pagination.d.mts.map +1 -1
  13. package/core/pagination.d.ts +11 -5
  14. package/core/pagination.d.ts.map +1 -1
  15. package/core/pagination.js +9 -9
  16. package/core/pagination.js.map +1 -1
  17. package/core/pagination.mjs +9 -9
  18. package/core/pagination.mjs.map +1 -1
  19. package/internal/parse.d.mts.map +1 -1
  20. package/internal/parse.d.ts.map +1 -1
  21. package/internal/parse.js +5 -0
  22. package/internal/parse.js.map +1 -1
  23. package/internal/parse.mjs +5 -0
  24. package/internal/parse.mjs.map +1 -1
  25. package/internal/qs/formats.d.mts +7 -0
  26. package/internal/qs/formats.d.mts.map +1 -0
  27. package/internal/qs/formats.d.ts +7 -0
  28. package/internal/qs/formats.d.ts.map +1 -0
  29. package/internal/qs/formats.js +13 -0
  30. package/internal/qs/formats.js.map +1 -0
  31. package/internal/qs/formats.mjs +9 -0
  32. package/internal/qs/formats.mjs.map +1 -0
  33. package/internal/qs/index.d.mts +10 -0
  34. package/internal/qs/index.d.mts.map +1 -0
  35. package/internal/qs/index.d.ts +10 -0
  36. package/internal/qs/index.d.ts.map +1 -0
  37. package/internal/qs/index.js +14 -0
  38. package/internal/qs/index.js.map +1 -0
  39. package/internal/qs/index.mjs +10 -0
  40. package/internal/qs/index.mjs.map +1 -0
  41. package/internal/qs/stringify.d.mts +3 -0
  42. package/internal/qs/stringify.d.mts.map +1 -0
  43. package/internal/qs/stringify.d.ts +3 -0
  44. package/internal/qs/stringify.d.ts.map +1 -0
  45. package/internal/qs/stringify.js +277 -0
  46. package/internal/qs/stringify.js.map +1 -0
  47. package/internal/qs/stringify.mjs +274 -0
  48. package/internal/qs/stringify.mjs.map +1 -0
  49. package/internal/qs/types.d.mts +57 -0
  50. package/internal/qs/types.d.mts.map +1 -0
  51. package/internal/qs/types.d.ts +57 -0
  52. package/internal/qs/types.d.ts.map +1 -0
  53. package/internal/qs/types.js +3 -0
  54. package/internal/qs/types.js.map +1 -0
  55. package/internal/qs/types.mjs +2 -0
  56. package/internal/qs/types.mjs.map +1 -0
  57. package/internal/qs/utils.d.mts +15 -0
  58. package/internal/qs/utils.d.mts.map +1 -0
  59. package/internal/qs/utils.d.ts +15 -0
  60. package/internal/qs/utils.d.ts.map +1 -0
  61. package/internal/qs/utils.js +230 -0
  62. package/internal/qs/utils.js.map +1 -0
  63. package/internal/qs/utils.mjs +217 -0
  64. package/internal/qs/utils.mjs.map +1 -0
  65. package/package.json +1 -1
  66. package/resources/index.d.mts +1 -1
  67. package/resources/index.d.mts.map +1 -1
  68. package/resources/index.d.ts +1 -1
  69. package/resources/index.d.ts.map +1 -1
  70. package/resources/index.js.map +1 -1
  71. package/resources/index.mjs +1 -1
  72. package/resources/index.mjs.map +1 -1
  73. package/resources/v1/addons/addons.d.mts +1298 -0
  74. package/resources/v1/addons/addons.d.mts.map +1 -0
  75. package/resources/v1/addons/addons.d.ts +1298 -0
  76. package/resources/v1/addons/addons.d.ts.map +1 -0
  77. package/resources/v1/addons/addons.js +78 -0
  78. package/resources/v1/addons/addons.js.map +1 -0
  79. package/resources/v1/addons/addons.mjs +73 -0
  80. package/resources/v1/addons/addons.mjs.map +1 -0
  81. package/resources/v1/addons/entitlements.d.mts +747 -0
  82. package/resources/v1/addons/entitlements.d.mts.map +1 -0
  83. package/resources/v1/addons/entitlements.d.ts +747 -0
  84. package/resources/v1/addons/entitlements.d.ts.map +1 -0
  85. package/resources/v1/addons/entitlements.js +36 -0
  86. package/resources/v1/addons/entitlements.js.map +1 -0
  87. package/resources/v1/addons/entitlements.mjs +32 -0
  88. package/resources/v1/addons/entitlements.mjs.map +1 -0
  89. package/resources/v1/addons/index.d.mts +3 -0
  90. package/resources/v1/addons/index.d.mts.map +1 -0
  91. package/resources/v1/addons/index.d.ts +3 -0
  92. package/resources/v1/addons/index.d.ts.map +1 -0
  93. package/resources/v1/addons/index.js +9 -0
  94. package/resources/v1/addons/index.js.map +1 -0
  95. package/resources/v1/addons/index.mjs +4 -0
  96. package/resources/v1/addons/index.mjs.map +1 -0
  97. package/resources/v1/addons.d.mts +2 -0
  98. package/resources/v1/addons.d.mts.map +1 -0
  99. package/resources/v1/addons.d.ts +2 -0
  100. package/resources/v1/addons.d.ts.map +1 -0
  101. package/resources/v1/addons.js +6 -0
  102. package/resources/v1/addons.js.map +1 -0
  103. package/resources/v1/addons.mjs +3 -0
  104. package/resources/v1/addons.mjs.map +1 -0
  105. package/resources/v1/coupons.d.mts +154 -157
  106. package/resources/v1/coupons.d.mts.map +1 -1
  107. package/resources/v1/coupons.d.ts +154 -157
  108. package/resources/v1/coupons.d.ts.map +1 -1
  109. package/resources/v1/coupons.js +21 -4
  110. package/resources/v1/coupons.js.map +1 -1
  111. package/resources/v1/coupons.mjs +21 -4
  112. package/resources/v1/coupons.mjs.map +1 -1
  113. package/resources/v1/customers/customers.d.mts +247 -118
  114. package/resources/v1/customers/customers.d.mts.map +1 -1
  115. package/resources/v1/customers/customers.d.ts +247 -118
  116. package/resources/v1/customers/customers.d.ts.map +1 -1
  117. package/resources/v1/customers/customers.js +37 -16
  118. package/resources/v1/customers/customers.js.map +1 -1
  119. package/resources/v1/customers/customers.mjs +37 -16
  120. package/resources/v1/customers/customers.mjs.map +1 -1
  121. package/resources/v1/customers/index.d.mts +2 -2
  122. package/resources/v1/customers/index.d.mts.map +1 -1
  123. package/resources/v1/customers/index.d.ts +2 -2
  124. package/resources/v1/customers/index.d.ts.map +1 -1
  125. package/resources/v1/customers/index.js +3 -3
  126. package/resources/v1/customers/index.js.map +1 -1
  127. package/resources/v1/customers/index.mjs +1 -1
  128. package/resources/v1/customers/index.mjs.map +1 -1
  129. package/resources/v1/customers/payment-method.d.mts +7 -2
  130. package/resources/v1/customers/payment-method.d.mts.map +1 -1
  131. package/resources/v1/customers/payment-method.d.ts +7 -2
  132. package/resources/v1/customers/payment-method.d.ts.map +1 -1
  133. package/resources/v1/customers/payment-method.js +4 -2
  134. package/resources/v1/customers/payment-method.js.map +1 -1
  135. package/resources/v1/customers/payment-method.mjs +4 -2
  136. package/resources/v1/customers/payment-method.mjs.map +1 -1
  137. package/resources/v1/customers/promotional-entitlements.d.mts +498 -0
  138. package/resources/v1/customers/promotional-entitlements.d.mts.map +1 -0
  139. package/resources/v1/customers/promotional-entitlements.d.ts +498 -0
  140. package/resources/v1/customers/promotional-entitlements.d.ts.map +1 -0
  141. package/resources/v1/customers/promotional-entitlements.js +32 -0
  142. package/resources/v1/customers/promotional-entitlements.js.map +1 -0
  143. package/resources/v1/customers/promotional-entitlements.mjs +28 -0
  144. package/resources/v1/customers/promotional-entitlements.mjs.map +1 -0
  145. package/resources/v1/events.d.mts +63 -0
  146. package/resources/v1/events.d.mts.map +1 -0
  147. package/resources/v1/events.d.ts +63 -0
  148. package/resources/v1/events.d.ts.map +1 -0
  149. package/resources/v1/events.js +16 -0
  150. package/resources/v1/events.js.map +1 -0
  151. package/resources/v1/events.mjs +12 -0
  152. package/resources/v1/events.mjs.map +1 -0
  153. package/resources/v1/features.d.mts +444 -0
  154. package/resources/v1/features.d.mts.map +1 -0
  155. package/resources/v1/features.d.ts +444 -0
  156. package/resources/v1/features.d.ts.map +1 -0
  157. package/resources/v1/features.js +51 -0
  158. package/resources/v1/features.js.map +1 -0
  159. package/resources/v1/features.mjs +47 -0
  160. package/resources/v1/features.mjs.map +1 -0
  161. package/resources/v1/index.d.mts +10 -4
  162. package/resources/v1/index.d.mts.map +1 -1
  163. package/resources/v1/index.d.ts +10 -4
  164. package/resources/v1/index.d.ts.map +1 -1
  165. package/resources/v1/index.js +17 -5
  166. package/resources/v1/index.js.map +1 -1
  167. package/resources/v1/index.mjs +7 -1
  168. package/resources/v1/index.mjs.map +1 -1
  169. package/resources/v1/plans/entitlements.d.mts +747 -0
  170. package/resources/v1/plans/entitlements.d.mts.map +1 -0
  171. package/resources/v1/plans/entitlements.d.ts +747 -0
  172. package/resources/v1/plans/entitlements.d.ts.map +1 -0
  173. package/resources/v1/plans/entitlements.js +36 -0
  174. package/resources/v1/plans/entitlements.js.map +1 -0
  175. package/resources/v1/plans/entitlements.mjs +32 -0
  176. package/resources/v1/plans/entitlements.mjs.map +1 -0
  177. package/resources/v1/plans/index.d.mts +3 -0
  178. package/resources/v1/plans/index.d.mts.map +1 -0
  179. package/resources/v1/plans/index.d.ts +3 -0
  180. package/resources/v1/plans/index.d.ts.map +1 -0
  181. package/resources/v1/plans/index.js +9 -0
  182. package/resources/v1/plans/index.js.map +1 -0
  183. package/resources/v1/plans/index.mjs +4 -0
  184. package/resources/v1/plans/index.mjs.map +1 -0
  185. package/resources/v1/plans/plans.d.mts +973 -0
  186. package/resources/v1/plans/plans.d.mts.map +1 -0
  187. package/resources/v1/plans/plans.d.ts +973 -0
  188. package/resources/v1/plans/plans.d.ts.map +1 -0
  189. package/resources/v1/plans/plans.js +76 -0
  190. package/resources/v1/plans/plans.js.map +1 -0
  191. package/resources/v1/plans/plans.mjs +71 -0
  192. package/resources/v1/plans/plans.mjs.map +1 -0
  193. package/resources/v1/plans.d.mts +2 -0
  194. package/resources/v1/plans.d.mts.map +1 -0
  195. package/resources/v1/plans.d.ts +2 -0
  196. package/resources/v1/plans.d.ts.map +1 -0
  197. package/resources/v1/plans.js +6 -0
  198. package/resources/v1/plans.js.map +1 -0
  199. package/resources/v1/plans.mjs +3 -0
  200. package/resources/v1/plans.mjs.map +1 -0
  201. package/resources/v1/products.d.mts +332 -0
  202. package/resources/v1/products.d.mts.map +1 -0
  203. package/resources/v1/products.d.ts +332 -0
  204. package/resources/v1/products.d.ts.map +1 -0
  205. package/resources/v1/products.js +52 -0
  206. package/resources/v1/products.js.map +1 -0
  207. package/resources/v1/products.mjs +48 -0
  208. package/resources/v1/products.mjs.map +1 -0
  209. package/resources/v1/subscriptions/future-update.d.mts +12 -19
  210. package/resources/v1/subscriptions/future-update.d.mts.map +1 -1
  211. package/resources/v1/subscriptions/future-update.d.ts +12 -19
  212. package/resources/v1/subscriptions/future-update.d.ts.map +1 -1
  213. package/resources/v1/subscriptions/future-update.js +3 -2
  214. package/resources/v1/subscriptions/future-update.js.map +1 -1
  215. package/resources/v1/subscriptions/future-update.mjs +3 -2
  216. package/resources/v1/subscriptions/future-update.mjs.map +1 -1
  217. package/resources/v1/subscriptions/index.d.mts +4 -2
  218. package/resources/v1/subscriptions/index.d.mts.map +1 -1
  219. package/resources/v1/subscriptions/index.d.ts +4 -2
  220. package/resources/v1/subscriptions/index.d.ts.map +1 -1
  221. package/resources/v1/subscriptions/index.js +5 -1
  222. package/resources/v1/subscriptions/index.js.map +1 -1
  223. package/resources/v1/subscriptions/index.mjs +3 -1
  224. package/resources/v1/subscriptions/index.mjs.map +1 -1
  225. package/resources/v1/subscriptions/invoice.d.mts +34 -0
  226. package/resources/v1/subscriptions/invoice.d.mts.map +1 -0
  227. package/resources/v1/subscriptions/invoice.d.ts +34 -0
  228. package/resources/v1/subscriptions/invoice.d.ts.map +1 -0
  229. package/resources/v1/subscriptions/invoice.js +17 -0
  230. package/resources/v1/subscriptions/invoice.js.map +1 -0
  231. package/resources/v1/subscriptions/invoice.mjs +13 -0
  232. package/resources/v1/subscriptions/invoice.mjs.map +1 -0
  233. package/resources/v1/subscriptions/subscriptions.d.mts +1565 -518
  234. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  235. package/resources/v1/subscriptions/subscriptions.d.ts +1565 -518
  236. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  237. package/resources/v1/subscriptions/subscriptions.js +52 -12
  238. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  239. package/resources/v1/subscriptions/subscriptions.mjs +53 -13
  240. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  241. package/resources/v1/subscriptions/usage.d.mts +98 -0
  242. package/resources/v1/subscriptions/usage.d.mts.map +1 -0
  243. package/resources/v1/subscriptions/usage.d.ts +98 -0
  244. package/resources/v1/subscriptions/usage.d.ts.map +1 -0
  245. package/resources/v1/subscriptions/usage.js +24 -0
  246. package/resources/v1/subscriptions/usage.js.map +1 -0
  247. package/resources/v1/subscriptions/usage.mjs +20 -0
  248. package/resources/v1/subscriptions/usage.mjs.map +1 -0
  249. package/resources/v1/usage.d.mts +230 -0
  250. package/resources/v1/usage.d.mts.map +1 -0
  251. package/resources/v1/usage.d.ts +230 -0
  252. package/resources/v1/usage.d.ts.map +1 -0
  253. package/resources/v1/usage.js +24 -0
  254. package/resources/v1/usage.js.map +1 -0
  255. package/resources/v1/usage.mjs +20 -0
  256. package/resources/v1/usage.mjs.map +1 -0
  257. package/resources/v1/v1.d.mts +30 -149
  258. package/resources/v1/v1.d.mts.map +1 -1
  259. package/resources/v1/v1.d.ts +30 -149
  260. package/resources/v1/v1.d.ts.map +1 -1
  261. package/resources/v1/v1.js +24 -12
  262. package/resources/v1/v1.js.map +1 -1
  263. package/resources/v1/v1.mjs +24 -12
  264. package/resources/v1/v1.mjs.map +1 -1
  265. package/src/client.ts +33 -40
  266. package/src/core/pagination.ts +24 -18
  267. package/src/internal/parse.ts +6 -0
  268. package/src/internal/qs/LICENSE.md +13 -0
  269. package/src/internal/qs/README.md +3 -0
  270. package/src/internal/qs/formats.ts +10 -0
  271. package/src/internal/qs/index.ts +13 -0
  272. package/src/internal/qs/stringify.ts +385 -0
  273. package/src/internal/qs/types.ts +71 -0
  274. package/src/internal/qs/utils.ts +265 -0
  275. package/src/resources/index.ts +1 -7
  276. package/src/resources/v1/addons/addons.ts +3245 -0
  277. package/src/resources/v1/addons/entitlements.ts +976 -0
  278. package/src/resources/v1/addons/index.ts +26 -0
  279. package/src/resources/v1/addons.ts +3 -0
  280. package/src/resources/v1/coupons.ts +311 -436
  281. package/src/resources/v1/customers/customers.ts +334 -153
  282. package/src/resources/v1/customers/index.ts +17 -2
  283. package/src/resources/v1/customers/payment-method.ts +7 -2
  284. package/src/resources/v1/customers/promotional-entitlements.ts +669 -0
  285. package/src/resources/v1/events.ts +74 -0
  286. package/src/resources/v1/features.ts +571 -0
  287. package/src/resources/v1/index.ts +73 -15
  288. package/src/resources/v1/plans/entitlements.ts +968 -0
  289. package/src/resources/v1/plans/index.ts +24 -0
  290. package/src/resources/v1/plans/plans.ts +2032 -0
  291. package/src/resources/v1/plans.ts +3 -0
  292. package/src/resources/v1/products.ts +423 -0
  293. package/src/resources/v1/subscriptions/future-update.ts +12 -27
  294. package/src/resources/v1/subscriptions/index.ts +16 -11
  295. package/src/resources/v1/subscriptions/invoice.ts +42 -0
  296. package/src/resources/v1/subscriptions/subscriptions.ts +3341 -832
  297. package/src/resources/v1/subscriptions/usage.ts +126 -0
  298. package/src/resources/v1/usage.ts +284 -0
  299. package/src/resources/v1/v1.ts +174 -197
  300. package/src/version.ts +1 -1
  301. package/version.d.mts +1 -1
  302. package/version.d.mts.map +1 -1
  303. package/version.d.ts +1 -1
  304. package/version.d.ts.map +1 -1
  305. package/version.js +1 -1
  306. package/version.js.map +1 -1
  307. package/version.mjs +1 -1
  308. package/version.mjs.map +1 -1
  309. package/resources/v1/customers/usage.d.mts +0 -98
  310. package/resources/v1/customers/usage.d.mts.map +0 -1
  311. package/resources/v1/customers/usage.d.ts +0 -98
  312. package/resources/v1/customers/usage.d.ts.map +0 -1
  313. package/resources/v1/customers/usage.js +0 -20
  314. package/resources/v1/customers/usage.js.map +0 -1
  315. package/resources/v1/customers/usage.mjs +0 -16
  316. package/resources/v1/customers/usage.mjs.map +0 -1
  317. package/src/resources/v1/customers/usage.ts +0 -132
@@ -0,0 +1,498 @@
1
+ import { APIResource } from "../../../core/resource.js";
2
+ import { APIPromise } from "../../../core/api-promise.js";
3
+ import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.js";
4
+ import { RequestOptions } from "../../../internal/request-options.js";
5
+ export declare class PromotionalEntitlements extends APIResource {
6
+ /**
7
+ * Grants promotional entitlements to a customer, providing feature access outside
8
+ * their subscription. Entitlements can be time-limited or permanent.
9
+ */
10
+ create(id: string, body: PromotionalEntitlementCreateParams, options?: RequestOptions): APIPromise<PromotionalEntitlementCreateResponse>;
11
+ /**
12
+ * Retrieves a paginated list of a customer's promotional entitlements.
13
+ */
14
+ list(id: string, query?: PromotionalEntitlementListParams | null | undefined, options?: RequestOptions): PagePromise<PromotionalEntitlementListResponsesMyCursorIDPage, PromotionalEntitlementListResponse>;
15
+ /**
16
+ * Revokes a previously granted promotional entitlement from a customer for a
17
+ * specific feature.
18
+ */
19
+ revoke(featureID: string, params: PromotionalEntitlementRevokeParams, options?: RequestOptions): APIPromise<PromotionalEntitlementRevokeResponse>;
20
+ }
21
+ export type PromotionalEntitlementListResponsesMyCursorIDPage = MyCursorIDPage<PromotionalEntitlementListResponse>;
22
+ /**
23
+ * Response object
24
+ */
25
+ export interface PromotionalEntitlementCreateResponse {
26
+ data: Array<PromotionalEntitlementCreateResponse.Data>;
27
+ }
28
+ export declare namespace PromotionalEntitlementCreateResponse {
29
+ /**
30
+ * Granted feature entitlement
31
+ */
32
+ interface Data {
33
+ /**
34
+ * Unique identifier for the entity
35
+ */
36
+ id: string;
37
+ /**
38
+ * Timestamp of when the record was created
39
+ */
40
+ createdAt: string;
41
+ /**
42
+ * The description of the entitlement
43
+ */
44
+ description: string | null;
45
+ /**
46
+ * The end date of the promotional entitlement
47
+ */
48
+ endDate: string | null;
49
+ /**
50
+ * The enum values of the entitlement
51
+ */
52
+ enumValues: Array<string> | null;
53
+ /**
54
+ * The unique identifier for the environment
55
+ */
56
+ environmentId: string;
57
+ /**
58
+ * Feature group IDs associated with this entitlement
59
+ */
60
+ featureGroupIds: Array<string> | null;
61
+ /**
62
+ * The unique identifier of the entitlement feature
63
+ */
64
+ featureId: string;
65
+ /**
66
+ * Whether the entitlement has a soft limit
67
+ */
68
+ hasSoftLimit: boolean | null;
69
+ /**
70
+ * Whether the entitlement has an unlimited usage
71
+ */
72
+ hasUnlimitedUsage: boolean | null;
73
+ /**
74
+ * Whether the entitlement is visible
75
+ */
76
+ isVisible: boolean;
77
+ /**
78
+ * The grant period of the promotional entitlement
79
+ */
80
+ period: '1 week' | '1 month' | '6 month' | '1 year' | 'lifetime' | 'custom';
81
+ /**
82
+ * The reset period of the entitlement
83
+ */
84
+ resetPeriod: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
85
+ /**
86
+ * The reset period configuration of the entitlement
87
+ */
88
+ resetPeriodConfiguration: Data.YearlyResetPeriodConfig | Data.MonthlyResetPeriodConfig | Data.WeeklyResetPeriodConfig | null;
89
+ /**
90
+ * The start date of the entitlement
91
+ */
92
+ startDate: string;
93
+ /**
94
+ * The status of the entitlement
95
+ */
96
+ status: 'Active' | 'Expired' | 'Paused';
97
+ /**
98
+ * Timestamp of when the record was last updated
99
+ */
100
+ updatedAt: string;
101
+ /**
102
+ * The usage limit of the entitlement
103
+ */
104
+ usageLimit: number | null;
105
+ }
106
+ namespace Data {
107
+ /**
108
+ * Yearly reset configuration
109
+ */
110
+ interface YearlyResetPeriodConfig {
111
+ /**
112
+ * Reset anchor (SubscriptionStart)
113
+ */
114
+ accordingTo: 'SubscriptionStart';
115
+ }
116
+ /**
117
+ * Monthly reset configuration
118
+ */
119
+ interface MonthlyResetPeriodConfig {
120
+ /**
121
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
122
+ */
123
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
124
+ }
125
+ /**
126
+ * Weekly reset configuration
127
+ */
128
+ interface WeeklyResetPeriodConfig {
129
+ /**
130
+ * Reset anchor (SubscriptionStart or specific day)
131
+ */
132
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
133
+ }
134
+ }
135
+ }
136
+ /**
137
+ * Granted feature entitlement
138
+ */
139
+ export interface PromotionalEntitlementListResponse {
140
+ /**
141
+ * Unique identifier for the entity
142
+ */
143
+ id: string;
144
+ /**
145
+ * Timestamp of when the record was created
146
+ */
147
+ createdAt: string;
148
+ /**
149
+ * The description of the entitlement
150
+ */
151
+ description: string | null;
152
+ /**
153
+ * The end date of the promotional entitlement
154
+ */
155
+ endDate: string | null;
156
+ /**
157
+ * The enum values of the entitlement
158
+ */
159
+ enumValues: Array<string> | null;
160
+ /**
161
+ * The unique identifier for the environment
162
+ */
163
+ environmentId: string;
164
+ /**
165
+ * Feature group IDs associated with this entitlement
166
+ */
167
+ featureGroupIds: Array<string> | null;
168
+ /**
169
+ * The unique identifier of the entitlement feature
170
+ */
171
+ featureId: string;
172
+ /**
173
+ * Whether the entitlement has a soft limit
174
+ */
175
+ hasSoftLimit: boolean | null;
176
+ /**
177
+ * Whether the entitlement has an unlimited usage
178
+ */
179
+ hasUnlimitedUsage: boolean | null;
180
+ /**
181
+ * Whether the entitlement is visible
182
+ */
183
+ isVisible: boolean;
184
+ /**
185
+ * The grant period of the promotional entitlement
186
+ */
187
+ period: '1 week' | '1 month' | '6 month' | '1 year' | 'lifetime' | 'custom';
188
+ /**
189
+ * The reset period of the entitlement
190
+ */
191
+ resetPeriod: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
192
+ /**
193
+ * The reset period configuration of the entitlement
194
+ */
195
+ resetPeriodConfiguration: PromotionalEntitlementListResponse.YearlyResetPeriodConfig | PromotionalEntitlementListResponse.MonthlyResetPeriodConfig | PromotionalEntitlementListResponse.WeeklyResetPeriodConfig | null;
196
+ /**
197
+ * The start date of the entitlement
198
+ */
199
+ startDate: string;
200
+ /**
201
+ * The status of the entitlement
202
+ */
203
+ status: 'Active' | 'Expired' | 'Paused';
204
+ /**
205
+ * Timestamp of when the record was last updated
206
+ */
207
+ updatedAt: string;
208
+ /**
209
+ * The usage limit of the entitlement
210
+ */
211
+ usageLimit: number | null;
212
+ }
213
+ export declare namespace PromotionalEntitlementListResponse {
214
+ /**
215
+ * Yearly reset configuration
216
+ */
217
+ interface YearlyResetPeriodConfig {
218
+ /**
219
+ * Reset anchor (SubscriptionStart)
220
+ */
221
+ accordingTo: 'SubscriptionStart';
222
+ }
223
+ /**
224
+ * Monthly reset configuration
225
+ */
226
+ interface MonthlyResetPeriodConfig {
227
+ /**
228
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
229
+ */
230
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
231
+ }
232
+ /**
233
+ * Weekly reset configuration
234
+ */
235
+ interface WeeklyResetPeriodConfig {
236
+ /**
237
+ * Reset anchor (SubscriptionStart or specific day)
238
+ */
239
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
240
+ }
241
+ }
242
+ /**
243
+ * Response object
244
+ */
245
+ export interface PromotionalEntitlementRevokeResponse {
246
+ /**
247
+ * Granted feature entitlement
248
+ */
249
+ data: PromotionalEntitlementRevokeResponse.Data;
250
+ }
251
+ export declare namespace PromotionalEntitlementRevokeResponse {
252
+ /**
253
+ * Granted feature entitlement
254
+ */
255
+ interface Data {
256
+ /**
257
+ * Unique identifier for the entity
258
+ */
259
+ id: string;
260
+ /**
261
+ * Timestamp of when the record was created
262
+ */
263
+ createdAt: string;
264
+ /**
265
+ * The description of the entitlement
266
+ */
267
+ description: string | null;
268
+ /**
269
+ * The end date of the promotional entitlement
270
+ */
271
+ endDate: string | null;
272
+ /**
273
+ * The enum values of the entitlement
274
+ */
275
+ enumValues: Array<string> | null;
276
+ /**
277
+ * The unique identifier for the environment
278
+ */
279
+ environmentId: string;
280
+ /**
281
+ * Feature group IDs associated with this entitlement
282
+ */
283
+ featureGroupIds: Array<string> | null;
284
+ /**
285
+ * The unique identifier of the entitlement feature
286
+ */
287
+ featureId: string;
288
+ /**
289
+ * Whether the entitlement has a soft limit
290
+ */
291
+ hasSoftLimit: boolean | null;
292
+ /**
293
+ * Whether the entitlement has an unlimited usage
294
+ */
295
+ hasUnlimitedUsage: boolean | null;
296
+ /**
297
+ * Whether the entitlement is visible
298
+ */
299
+ isVisible: boolean;
300
+ /**
301
+ * The grant period of the promotional entitlement
302
+ */
303
+ period: '1 week' | '1 month' | '6 month' | '1 year' | 'lifetime' | 'custom';
304
+ /**
305
+ * The reset period of the entitlement
306
+ */
307
+ resetPeriod: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
308
+ /**
309
+ * The reset period configuration of the entitlement
310
+ */
311
+ resetPeriodConfiguration: Data.YearlyResetPeriodConfig | Data.MonthlyResetPeriodConfig | Data.WeeklyResetPeriodConfig | null;
312
+ /**
313
+ * The start date of the entitlement
314
+ */
315
+ startDate: string;
316
+ /**
317
+ * The status of the entitlement
318
+ */
319
+ status: 'Active' | 'Expired' | 'Paused';
320
+ /**
321
+ * Timestamp of when the record was last updated
322
+ */
323
+ updatedAt: string;
324
+ /**
325
+ * The usage limit of the entitlement
326
+ */
327
+ usageLimit: number | null;
328
+ }
329
+ namespace Data {
330
+ /**
331
+ * Yearly reset configuration
332
+ */
333
+ interface YearlyResetPeriodConfig {
334
+ /**
335
+ * Reset anchor (SubscriptionStart)
336
+ */
337
+ accordingTo: 'SubscriptionStart';
338
+ }
339
+ /**
340
+ * Monthly reset configuration
341
+ */
342
+ interface MonthlyResetPeriodConfig {
343
+ /**
344
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
345
+ */
346
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
347
+ }
348
+ /**
349
+ * Weekly reset configuration
350
+ */
351
+ interface WeeklyResetPeriodConfig {
352
+ /**
353
+ * Reset anchor (SubscriptionStart or specific day)
354
+ */
355
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
356
+ }
357
+ }
358
+ }
359
+ export interface PromotionalEntitlementCreateParams {
360
+ /**
361
+ * Promotional entitlements to grant
362
+ */
363
+ promotionalEntitlements: Array<PromotionalEntitlementCreateParams.PromotionalEntitlement>;
364
+ }
365
+ export declare namespace PromotionalEntitlementCreateParams {
366
+ /**
367
+ * Single entitlement grant config
368
+ */
369
+ interface PromotionalEntitlement {
370
+ /**
371
+ * The custom end date of the promotional entitlement
372
+ */
373
+ customEndDate: string | null;
374
+ /**
375
+ * The enum values of the entitlement
376
+ */
377
+ enumValues: Array<string> | null;
378
+ /**
379
+ * The unique identifier of the entitlement feature
380
+ */
381
+ featureId: string;
382
+ /**
383
+ * Whether the entitlement has a soft limit
384
+ */
385
+ hasSoftLimit: boolean | null;
386
+ /**
387
+ * Whether the entitlement has an unlimited usage
388
+ */
389
+ hasUnlimitedUsage: boolean | null;
390
+ /**
391
+ * Whether the entitlement is visible
392
+ */
393
+ isVisible: boolean | null;
394
+ /**
395
+ * The monthly reset period configuration of the entitlement, defined when reset
396
+ * period is monthly
397
+ */
398
+ monthlyResetPeriodConfiguration: PromotionalEntitlement.MonthlyResetPeriodConfiguration | null;
399
+ /**
400
+ * The grant period of the promotional entitlement
401
+ */
402
+ period: '1 week' | '1 month' | '6 month' | '1 year' | 'lifetime' | 'custom';
403
+ /**
404
+ * The reset period of the entitlement
405
+ */
406
+ resetPeriod: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | null;
407
+ /**
408
+ * The usage limit of the entitlement
409
+ */
410
+ usageLimit: number | null;
411
+ /**
412
+ * The weekly reset period configuration of the entitlement, defined when reset
413
+ * period is weekly
414
+ */
415
+ weeklyResetPeriodConfiguration: PromotionalEntitlement.WeeklyResetPeriodConfiguration | null;
416
+ /**
417
+ * The yearly reset period configuration of the entitlement, defined when reset
418
+ * period is yearly
419
+ */
420
+ yearlyResetPeriodConfiguration: PromotionalEntitlement.YearlyResetPeriodConfiguration | null;
421
+ }
422
+ namespace PromotionalEntitlement {
423
+ /**
424
+ * The monthly reset period configuration of the entitlement, defined when reset
425
+ * period is monthly
426
+ */
427
+ interface MonthlyResetPeriodConfiguration {
428
+ /**
429
+ * Reset anchor (SubscriptionStart or StartOfTheMonth)
430
+ */
431
+ accordingTo: 'SubscriptionStart' | 'StartOfTheMonth';
432
+ }
433
+ /**
434
+ * The weekly reset period configuration of the entitlement, defined when reset
435
+ * period is weekly
436
+ */
437
+ interface WeeklyResetPeriodConfiguration {
438
+ /**
439
+ * Reset anchor (SubscriptionStart or specific day)
440
+ */
441
+ accordingTo: 'SubscriptionStart' | 'EverySunday' | 'EveryMonday' | 'EveryTuesday' | 'EveryWednesday' | 'EveryThursday' | 'EveryFriday' | 'EverySaturday';
442
+ }
443
+ /**
444
+ * The yearly reset period configuration of the entitlement, defined when reset
445
+ * period is yearly
446
+ */
447
+ interface YearlyResetPeriodConfiguration {
448
+ /**
449
+ * Reset anchor (SubscriptionStart)
450
+ */
451
+ accordingTo: 'SubscriptionStart';
452
+ }
453
+ }
454
+ }
455
+ export interface PromotionalEntitlementListParams extends MyCursorIDPageParams {
456
+ /**
457
+ * Filter by creation date using range operators: gt, gte, lt, lte
458
+ */
459
+ createdAt?: PromotionalEntitlementListParams.CreatedAt;
460
+ /**
461
+ * Filter by promotional entitlement status. Supports comma-separated values for
462
+ * multiple statuses
463
+ */
464
+ status?: string;
465
+ }
466
+ export declare namespace PromotionalEntitlementListParams {
467
+ /**
468
+ * Filter by creation date using range operators: gt, gte, lt, lte
469
+ */
470
+ interface CreatedAt {
471
+ /**
472
+ * Greater than the specified createdAt value
473
+ */
474
+ gt?: string;
475
+ /**
476
+ * Greater than or equal to the specified createdAt value
477
+ */
478
+ gte?: string;
479
+ /**
480
+ * Less than the specified createdAt value
481
+ */
482
+ lt?: string;
483
+ /**
484
+ * Less than or equal to the specified createdAt value
485
+ */
486
+ lte?: string;
487
+ }
488
+ }
489
+ export interface PromotionalEntitlementRevokeParams {
490
+ /**
491
+ * The unique identifier of the customer
492
+ */
493
+ id: string;
494
+ }
495
+ export declare namespace PromotionalEntitlements {
496
+ export { type PromotionalEntitlementCreateResponse as PromotionalEntitlementCreateResponse, type PromotionalEntitlementListResponse as PromotionalEntitlementListResponse, type PromotionalEntitlementRevokeResponse as PromotionalEntitlementRevokeResponse, type PromotionalEntitlementListResponsesMyCursorIDPage as PromotionalEntitlementListResponsesMyCursorIDPage, type PromotionalEntitlementCreateParams as PromotionalEntitlementCreateParams, type PromotionalEntitlementListParams as PromotionalEntitlementListParams, type PromotionalEntitlementRevokeParams as PromotionalEntitlementRevokeParams, };
497
+ }
498
+ //# sourceMappingURL=promotional-entitlements.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"promotional-entitlements.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/promotional-entitlements.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE;OAC1D,EAAE,cAAc,EAAE;AAGzB,qBAAa,uBAAwB,SAAQ,WAAW;IACtD;;;OAGG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;OAEG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iDAAiD,EAAE,kCAAkC,CAAC;IAQrG;;;OAGG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAIpD;AAED,MAAM,MAAM,iDAAiD,GAC3D,cAAc,CAAC,kCAAkC,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,IAAI,EAAE,KAAK,CAAC,oCAAoC,CAAC,IAAI,CAAC,CAAC;CACxD;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;QAE5E;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAE/D;;WAEG;QACH,wBAAwB,EACpB,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC,wBAAwB,GAC7B,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC;QAET;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;QAExC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,WAAW,EAAE,mBAAmB,CAAC;SAClC;QAED;;WAEG;QACH,UAAiB,wBAAwB;YACvC;;eAEG;YACH,WAAW,EAAE,mBAAmB,GAAG,iBAAiB,CAAC;SACtD;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,WAAW,EACP,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;SACrB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;IAE5E;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,wBAAwB,EACpB,kCAAkC,CAAC,uBAAuB,GAC1D,kCAAkC,CAAC,wBAAwB,GAC3D,kCAAkC,CAAC,uBAAuB,GAC1D,IAAI,CAAC;IAET;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAExC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,kCAAkC,CAAC;IAClD;;OAEG;IACH,UAAiB,uBAAuB;QACtC;;WAEG;QACH,WAAW,EAAE,mBAAmB,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;WAEG;QACH,WAAW,EAAE,mBAAmB,GAAG,iBAAiB,CAAC;KACtD;IAED;;OAEG;IACH,UAAiB,uBAAuB;QACtC;;WAEG;QACH,WAAW,EACP,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;KACrB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,IAAI,EAAE,oCAAoC,CAAC,IAAI,CAAC;CACjD;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;QAE5E;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAE/D;;WAEG;QACH,wBAAwB,EACpB,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC,wBAAwB,GAC7B,IAAI,CAAC,uBAAuB,GAC5B,IAAI,CAAC;QAET;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;QAExC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,WAAW,EAAE,mBAAmB,CAAC;SAClC;QAED;;WAEG;QACH,UAAiB,wBAAwB;YACvC;;eAEG;YACH,WAAW,EAAE,mBAAmB,GAAG,iBAAiB,CAAC;SACtD;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,WAAW,EACP,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,uBAAuB,EAAE,KAAK,CAAC,kCAAkC,CAAC,sBAAsB,CAAC,CAAC;CAC3F;AAED,yBAAiB,kCAAkC,CAAC;IAClD;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,iBAAiB,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,+BAA+B,EAAE,sBAAsB,CAAC,+BAA+B,GAAG,IAAI,CAAC;QAE/F;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;QAE5E;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAE/D;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,8BAA8B,EAAE,sBAAsB,CAAC,8BAA8B,GAAG,IAAI,CAAC;QAE7F;;;WAGG;QACH,8BAA8B,EAAE,sBAAsB,CAAC,8BAA8B,GAAG,IAAI,CAAC;KAC9F;IAED,UAAiB,sBAAsB,CAAC;QACtC;;;WAGG;QACH,UAAiB,+BAA+B;YAC9C;;eAEG;YACH,WAAW,EAAE,mBAAmB,GAAG,iBAAiB,CAAC;SACtD;QAED;;;WAGG;QACH,UAAiB,8BAA8B;YAC7C;;eAEG;YACH,WAAW,EACP,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;SACrB;QAED;;;WAGG;QACH,UAAiB,8BAA8B;YAC7C;;eAEG;YACH,WAAW,EAAE,mBAAmB,CAAC;SAClC;KACF;CACF;AAED,MAAM,WAAW,gCAAiC,SAAQ,oBAAoB;IAC5E;;OAEG;IACH,SAAS,CAAC,EAAE,gCAAgC,CAAC,SAAS,CAAC;IAEvD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,yBAAiB,gCAAgC,CAAC;IAChD;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,uBAAuB,CAAC;IAC/C,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,iDAAiD,IAAI,iDAAiD,EAC3G,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.PromotionalEntitlements = void 0;
5
+ const resource_1 = require("../../../core/resource.js");
6
+ const pagination_1 = require("../../../core/pagination.js");
7
+ const path_1 = require("../../../internal/utils/path.js");
8
+ class PromotionalEntitlements extends resource_1.APIResource {
9
+ /**
10
+ * Grants promotional entitlements to a customer, providing feature access outside
11
+ * their subscription. Entitlements can be time-limited or permanent.
12
+ */
13
+ create(id, body, options) {
14
+ return this._client.post((0, path_1.path) `/api/v1/customers/${id}/promotional-entitlements`, { body, ...options });
15
+ }
16
+ /**
17
+ * Retrieves a paginated list of a customer's promotional entitlements.
18
+ */
19
+ list(id, query = {}, options) {
20
+ return this._client.getAPIList((0, path_1.path) `/api/v1/customers/${id}/promotional-entitlements`, (pagination_1.MyCursorIDPage), { query, ...options });
21
+ }
22
+ /**
23
+ * Revokes a previously granted promotional entitlement from a customer for a
24
+ * specific feature.
25
+ */
26
+ revoke(featureID, params, options) {
27
+ const { id } = params;
28
+ return this._client.delete((0, path_1.path) `/api/v1/customers/${id}/promotional-entitlements/${featureID}`, options);
29
+ }
30
+ }
31
+ exports.PromotionalEntitlements = PromotionalEntitlements;
32
+ //# sourceMappingURL=promotional-entitlements.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"promotional-entitlements.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/promotional-entitlements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAAkG;AAElG,0DAAoD;AAEpD,MAAa,uBAAwB,SAAQ,sBAAW;IACtD;;;OAGG;IACH,MAAM,CACJ,EAAU,EACV,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;OAEG;IACH,IAAI,CACF,EAAU,EACV,QAA6D,EAAE,EAC/D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,qBAAqB,EAAE,2BAA2B,EACtD,CAAA,2BAAkD,CAAA,EAClD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,SAAiB,EACjB,MAA0C,EAC1C,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,6BAA6B,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3G,CAAC;CACF;AAxCD,0DAwCC"}
@@ -0,0 +1,28 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../../../core/resource.mjs";
3
+ import { MyCursorIDPage } from "../../../core/pagination.mjs";
4
+ import { path } from "../../../internal/utils/path.mjs";
5
+ export class PromotionalEntitlements extends APIResource {
6
+ /**
7
+ * Grants promotional entitlements to a customer, providing feature access outside
8
+ * their subscription. Entitlements can be time-limited or permanent.
9
+ */
10
+ create(id, body, options) {
11
+ return this._client.post(path `/api/v1/customers/${id}/promotional-entitlements`, { body, ...options });
12
+ }
13
+ /**
14
+ * Retrieves a paginated list of a customer's promotional entitlements.
15
+ */
16
+ list(id, query = {}, options) {
17
+ return this._client.getAPIList(path `/api/v1/customers/${id}/promotional-entitlements`, (MyCursorIDPage), { query, ...options });
18
+ }
19
+ /**
20
+ * Revokes a previously granted promotional entitlement from a customer for a
21
+ * specific feature.
22
+ */
23
+ revoke(featureID, params, options) {
24
+ const { id } = params;
25
+ return this._client.delete(path `/api/v1/customers/${id}/promotional-entitlements/${featureID}`, options);
26
+ }
27
+ }
28
+ //# sourceMappingURL=promotional-entitlements.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"promotional-entitlements.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/promotional-entitlements.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,cAAc,EAA0C;OAE1D,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,uBAAwB,SAAQ,WAAW;IACtD;;;OAGG;IACH,MAAM,CACJ,EAAU,EACV,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,EAAE,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;OAEG;IACH,IAAI,CACF,EAAU,EACV,QAA6D,EAAE,EAC/D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,qBAAqB,EAAE,2BAA2B,EACtD,CAAA,cAAkD,CAAA,EAClD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,SAAiB,EACjB,MAA0C,EAC1C,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,EAAE,6BAA6B,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3G,CAAC;CACF"}
@@ -0,0 +1,63 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import { APIPromise } from "../../core/api-promise.mjs";
3
+ import { RequestOptions } from "../../internal/request-options.mjs";
4
+ export declare class Events extends APIResource {
5
+ /**
6
+ * Reports raw usage events for event-based metering. Events are ingested
7
+ * asynchronously and aggregated into usage totals.
8
+ */
9
+ report(body: EventReportParams, options?: RequestOptions): APIPromise<EventReportResponse>;
10
+ }
11
+ /**
12
+ * Response object
13
+ */
14
+ export interface EventReportResponse {
15
+ /**
16
+ * Empty success response confirming that events were successfully ingested and
17
+ * queued for processing by Stigg's metering system.
18
+ */
19
+ data: unknown;
20
+ }
21
+ export interface EventReportParams {
22
+ /**
23
+ * A list of usage events to report
24
+ */
25
+ events: Array<EventReportParams.Event>;
26
+ }
27
+ export declare namespace EventReportParams {
28
+ /**
29
+ * Raw usage event
30
+ */
31
+ interface Event {
32
+ /**
33
+ * Customer id
34
+ */
35
+ customerId: string;
36
+ /**
37
+ * The name of the usage event
38
+ */
39
+ eventName: string;
40
+ /**
41
+ * Idempotency key
42
+ */
43
+ idempotencyKey: string;
44
+ /**
45
+ * Dimensions associated with the usage event
46
+ */
47
+ dimensions?: {
48
+ [key: string]: string | number | boolean;
49
+ };
50
+ /**
51
+ * Resource id
52
+ */
53
+ resourceId?: string | null;
54
+ /**
55
+ * Timestamp
56
+ */
57
+ timestamp?: string;
58
+ }
59
+ }
60
+ export declare namespace Events {
61
+ export { type EventReportResponse as EventReportResponse, type EventReportParams as EventReportParams };
62
+ }
63
+ //# sourceMappingURL=events.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"events.d.mts","sourceRoot":"","sources":["../../src/resources/v1/events.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAG3F;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;CACxC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE1D;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACzG"}