orb-billing 5.48.0 → 5.75.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (205) hide show
  1. package/CHANGELOG.md +241 -0
  2. package/core.js +2 -2
  3. package/core.js.map +1 -1
  4. package/core.mjs +2 -2
  5. package/core.mjs.map +1 -1
  6. package/index.d.ts.map +1 -1
  7. package/index.js +11 -0
  8. package/index.js.map +1 -1
  9. package/index.mjs +11 -0
  10. package/index.mjs.map +1 -1
  11. package/package.json +1 -1
  12. package/resources/alerts.d.ts +140 -3
  13. package/resources/alerts.d.ts.map +1 -1
  14. package/resources/alerts.js.map +1 -1
  15. package/resources/alerts.mjs.map +1 -1
  16. package/resources/beta/beta.d.ts +738 -7570
  17. package/resources/beta/beta.d.ts.map +1 -1
  18. package/resources/beta/beta.js.map +1 -1
  19. package/resources/beta/beta.mjs.map +1 -1
  20. package/resources/beta/external-plan-id.d.ts +664 -7572
  21. package/resources/beta/external-plan-id.d.ts.map +1 -1
  22. package/resources/coupons/coupons.d.ts +29 -0
  23. package/resources/coupons/coupons.d.ts.map +1 -1
  24. package/resources/coupons/coupons.js +21 -0
  25. package/resources/coupons/coupons.js.map +1 -1
  26. package/resources/coupons/coupons.mjs +21 -0
  27. package/resources/coupons/coupons.mjs.map +1 -1
  28. package/resources/coupons/subscriptions.d.ts +10 -0
  29. package/resources/coupons/subscriptions.d.ts.map +1 -1
  30. package/resources/coupons/subscriptions.js.map +1 -1
  31. package/resources/coupons/subscriptions.mjs.map +1 -1
  32. package/resources/credit-blocks.d.ts +98 -7
  33. package/resources/credit-blocks.d.ts.map +1 -1
  34. package/resources/credit-blocks.js +10 -7
  35. package/resources/credit-blocks.js.map +1 -1
  36. package/resources/credit-blocks.mjs +10 -7
  37. package/resources/credit-blocks.mjs.map +1 -1
  38. package/resources/credit-notes.d.ts +28 -0
  39. package/resources/credit-notes.d.ts.map +1 -1
  40. package/resources/credit-notes.js +20 -0
  41. package/resources/credit-notes.js.map +1 -1
  42. package/resources/credit-notes.mjs +20 -0
  43. package/resources/credit-notes.mjs.map +1 -1
  44. package/resources/customers/credits/credits.d.ts +89 -0
  45. package/resources/customers/credits/credits.d.ts.map +1 -1
  46. package/resources/customers/credits/credits.js.map +1 -1
  47. package/resources/customers/credits/credits.mjs.map +1 -1
  48. package/resources/customers/credits/ledger.d.ts +34 -20
  49. package/resources/customers/credits/ledger.d.ts.map +1 -1
  50. package/resources/customers/credits/ledger.js +28 -14
  51. package/resources/customers/credits/ledger.js.map +1 -1
  52. package/resources/customers/credits/ledger.mjs +28 -14
  53. package/resources/customers/credits/ledger.mjs.map +1 -1
  54. package/resources/customers/customers.d.ts +89 -6
  55. package/resources/customers/customers.d.ts.map +1 -1
  56. package/resources/customers/customers.js.map +1 -1
  57. package/resources/customers/customers.mjs.map +1 -1
  58. package/resources/dimensional-price-groups/dimensional-price-groups.d.ts +35 -1
  59. package/resources/dimensional-price-groups/dimensional-price-groups.d.ts.map +1 -1
  60. package/resources/dimensional-price-groups/dimensional-price-groups.js +26 -0
  61. package/resources/dimensional-price-groups/dimensional-price-groups.js.map +1 -1
  62. package/resources/dimensional-price-groups/dimensional-price-groups.mjs +26 -0
  63. package/resources/dimensional-price-groups/dimensional-price-groups.mjs.map +1 -1
  64. package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.ts +16 -0
  65. package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.ts.map +1 -1
  66. package/resources/dimensional-price-groups/external-dimensional-price-group-id.js +16 -0
  67. package/resources/dimensional-price-groups/external-dimensional-price-group-id.js.map +1 -1
  68. package/resources/dimensional-price-groups/external-dimensional-price-group-id.mjs +16 -0
  69. package/resources/dimensional-price-groups/external-dimensional-price-group-id.mjs.map +1 -1
  70. package/resources/events/backfills.d.ts +37 -0
  71. package/resources/events/backfills.d.ts.map +1 -1
  72. package/resources/events/backfills.js +29 -0
  73. package/resources/events/backfills.js.map +1 -1
  74. package/resources/events/backfills.mjs +29 -0
  75. package/resources/events/backfills.mjs.map +1 -1
  76. package/resources/events/events.d.ts +41 -33
  77. package/resources/events/events.d.ts.map +1 -1
  78. package/resources/events/events.js +39 -31
  79. package/resources/events/events.js.map +1 -1
  80. package/resources/events/events.mjs +39 -31
  81. package/resources/events/events.mjs.map +1 -1
  82. package/resources/events/volume.d.ts +7 -0
  83. package/resources/events/volume.d.ts.map +1 -1
  84. package/resources/events/volume.js +7 -0
  85. package/resources/events/volume.js.map +1 -1
  86. package/resources/events/volume.mjs +7 -0
  87. package/resources/events/volume.mjs.map +1 -1
  88. package/resources/invoice-line-items.d.ts +89 -1
  89. package/resources/invoice-line-items.d.ts.map +1 -1
  90. package/resources/invoice-line-items.js +12 -0
  91. package/resources/invoice-line-items.js.map +1 -1
  92. package/resources/invoice-line-items.mjs +12 -0
  93. package/resources/invoice-line-items.mjs.map +1 -1
  94. package/resources/invoices.d.ts +200 -12
  95. package/resources/invoices.d.ts.map +1 -1
  96. package/resources/invoices.js +64 -0
  97. package/resources/invoices.js.map +1 -1
  98. package/resources/invoices.mjs +64 -0
  99. package/resources/invoices.mjs.map +1 -1
  100. package/resources/items.d.ts +30 -0
  101. package/resources/items.d.ts.map +1 -1
  102. package/resources/items.js +22 -0
  103. package/resources/items.js.map +1 -1
  104. package/resources/items.mjs +22 -0
  105. package/resources/items.mjs.map +1 -1
  106. package/resources/licenses/external-licenses.d.ts +13 -1
  107. package/resources/licenses/external-licenses.d.ts.map +1 -1
  108. package/resources/licenses/external-licenses.js +12 -0
  109. package/resources/licenses/external-licenses.js.map +1 -1
  110. package/resources/licenses/external-licenses.mjs +12 -0
  111. package/resources/licenses/external-licenses.mjs.map +1 -1
  112. package/resources/licenses/licenses.d.ts +44 -0
  113. package/resources/licenses/licenses.d.ts.map +1 -1
  114. package/resources/licenses/licenses.js +44 -0
  115. package/resources/licenses/licenses.js.map +1 -1
  116. package/resources/licenses/licenses.mjs +44 -0
  117. package/resources/licenses/licenses.mjs.map +1 -1
  118. package/resources/licenses/usage.d.ts +17 -2
  119. package/resources/licenses/usage.d.ts.map +1 -1
  120. package/resources/licenses/usage.js +8 -0
  121. package/resources/licenses/usage.js.map +1 -1
  122. package/resources/licenses/usage.mjs +8 -0
  123. package/resources/licenses/usage.mjs.map +1 -1
  124. package/resources/metrics.d.ts +37 -5
  125. package/resources/metrics.d.ts.map +1 -1
  126. package/resources/metrics.js +27 -2
  127. package/resources/metrics.js.map +1 -1
  128. package/resources/metrics.mjs +27 -2
  129. package/resources/metrics.mjs.map +1 -1
  130. package/resources/plans/external-plan-id.d.ts +6 -2
  131. package/resources/plans/external-plan-id.d.ts.map +1 -1
  132. package/resources/plans/external-plan-id.js +2 -2
  133. package/resources/plans/external-plan-id.mjs +2 -2
  134. package/resources/plans/migrations.d.ts +42 -0
  135. package/resources/plans/migrations.d.ts.map +1 -1
  136. package/resources/plans/migrations.js.map +1 -1
  137. package/resources/plans/migrations.mjs.map +1 -1
  138. package/resources/plans/plans.d.ts +382 -3754
  139. package/resources/plans/plans.d.ts.map +1 -1
  140. package/resources/plans/plans.js +2 -2
  141. package/resources/plans/plans.js.map +1 -1
  142. package/resources/plans/plans.mjs +2 -2
  143. package/resources/plans/plans.mjs.map +1 -1
  144. package/resources/prices/external-price-id.d.ts +14 -0
  145. package/resources/prices/external-price-id.d.ts.map +1 -1
  146. package/resources/prices/external-price-id.js +14 -0
  147. package/resources/prices/external-price-id.js.map +1 -1
  148. package/resources/prices/external-price-id.mjs +14 -0
  149. package/resources/prices/external-price-id.mjs.map +1 -1
  150. package/resources/prices/prices.d.ts +1632 -393
  151. package/resources/prices/prices.d.ts.map +1 -1
  152. package/resources/prices/prices.js +46 -0
  153. package/resources/prices/prices.js.map +1 -1
  154. package/resources/prices/prices.mjs +46 -0
  155. package/resources/prices/prices.mjs.map +1 -1
  156. package/resources/shared.d.ts +922 -52
  157. package/resources/shared.d.ts.map +1 -1
  158. package/resources/shared.js.map +1 -1
  159. package/resources/shared.mjs.map +1 -1
  160. package/resources/subscription-changes.d.ts +72 -1
  161. package/resources/subscription-changes.d.ts.map +1 -1
  162. package/resources/subscription-changes.js.map +1 -1
  163. package/resources/subscription-changes.mjs.map +1 -1
  164. package/resources/subscriptions.d.ts +3075 -464
  165. package/resources/subscriptions.d.ts.map +1 -1
  166. package/resources/subscriptions.js +111 -0
  167. package/resources/subscriptions.js.map +1 -1
  168. package/resources/subscriptions.mjs +111 -0
  169. package/resources/subscriptions.mjs.map +1 -1
  170. package/src/core.ts +2 -2
  171. package/src/index.ts +12 -0
  172. package/src/resources/alerts.ts +161 -3
  173. package/src/resources/beta/beta.ts +828 -8988
  174. package/src/resources/beta/external-plan-id.ts +745 -8997
  175. package/src/resources/coupons/coupons.ts +29 -0
  176. package/src/resources/coupons/subscriptions.ts +10 -0
  177. package/src/resources/credit-blocks.ts +120 -7
  178. package/src/resources/credit-notes.ts +28 -0
  179. package/src/resources/customers/credits/credits.ts +111 -0
  180. package/src/resources/customers/credits/ledger.ts +34 -20
  181. package/src/resources/customers/customers.ts +99 -6
  182. package/src/resources/dimensional-price-groups/dimensional-price-groups.ts +35 -1
  183. package/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts +16 -0
  184. package/src/resources/events/backfills.ts +37 -0
  185. package/src/resources/events/events.ts +41 -33
  186. package/src/resources/events/volume.ts +7 -0
  187. package/src/resources/invoice-line-items.ts +104 -0
  188. package/src/resources/invoices.ts +215 -11
  189. package/src/resources/items.ts +30 -0
  190. package/src/resources/licenses/external-licenses.ts +13 -1
  191. package/src/resources/licenses/licenses.ts +44 -0
  192. package/src/resources/licenses/usage.ts +17 -2
  193. package/src/resources/metrics.ts +37 -5
  194. package/src/resources/plans/external-plan-id.ts +7 -2
  195. package/src/resources/plans/migrations.ts +42 -0
  196. package/src/resources/plans/plans.ts +456 -4482
  197. package/src/resources/prices/external-price-id.ts +14 -0
  198. package/src/resources/prices/prices.ts +1743 -264
  199. package/src/resources/shared.ts +1172 -50
  200. package/src/resources/subscription-changes.ts +88 -1
  201. package/src/resources/subscriptions.ts +4707 -1585
  202. package/src/version.ts +1 -1
  203. package/version.d.ts +1 -1
  204. package/version.js +1 -1
  205. package/version.mjs +1 -1
@@ -17,18 +17,44 @@ export class Licenses extends APIResource {
17
17
  * If a start date is provided, the license will be activated at the **start** of
18
18
  * the specified date in the customer's timezone. Otherwise, the activation time
19
19
  * will default to the **start** of the current day in the customer's timezone.
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * const license = await client.licenses.create({
24
+ * external_license_id: 'external_license_id',
25
+ * license_type_id: 'license_type_id',
26
+ * subscription_id: 'subscription_id',
27
+ * });
28
+ * ```
20
29
  */
21
30
  create(body, options) {
22
31
  return this._client.post('/licenses', { body, ...options });
23
32
  }
24
33
  /**
25
34
  * This endpoint is used to fetch a license given an identifier.
35
+ *
36
+ * @example
37
+ * ```ts
38
+ * const license = await client.licenses.retrieve(
39
+ * 'license_id',
40
+ * );
41
+ * ```
26
42
  */
27
43
  retrieve(licenseId, options) {
28
44
  return this._client.get(`/licenses/${licenseId}`, options);
29
45
  }
30
46
  /**
31
47
  * This endpoint returns a list of all licenses for a subscription.
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * // Automatically fetches more pages as needed.
52
+ * for await (const licenseListResponse of client.licenses.list(
53
+ * { subscription_id: 'subscription_id' },
54
+ * )) {
55
+ * // ...
56
+ * }
57
+ * ```
32
58
  */
33
59
  list(query, options) {
34
60
  return this._client.getAPIList('/licenses', LicenseListResponsesPage, { query, ...options });
@@ -39,12 +65,30 @@ export class Licenses extends APIResource {
39
65
  * If an end date is provided, the license will be deactivated at the **start** of
40
66
  * the specified date in the customer's timezone. Otherwise, the deactivation time
41
67
  * will default to the **end** of the current day in the customer's timezone.
68
+ *
69
+ * @example
70
+ * ```ts
71
+ * const response = await client.licenses.deactivate(
72
+ * 'license_id',
73
+ * );
74
+ * ```
42
75
  */
43
76
  deactivate(licenseId, body, options) {
44
77
  return this._client.post(`/licenses/${licenseId}/deactivate`, { body, ...options });
45
78
  }
46
79
  /**
47
80
  * This endpoint is used to fetch a license given an external license identifier.
81
+ *
82
+ * @example
83
+ * ```ts
84
+ * const response = await client.licenses.retrieveByExternalId(
85
+ * 'external_license_id',
86
+ * {
87
+ * license_type_id: 'license_type_id',
88
+ * subscription_id: 'subscription_id',
89
+ * },
90
+ * );
91
+ * ```
48
92
  */
49
93
  retrieveByExternalId(externalLicenseId, query, options) {
50
94
  return this._client.get(`/licenses/external_license_id/${externalLicenseId}`, { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"licenses.mjs","sourceRoot":"","sources":["../../src/resources/licenses/licenses.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,mBAAmB;OACxB,EAGL,gBAAgB,GACjB;OACM,KAAK,QAAQ;OACb,EACL,KAAK,GAKN;OACM,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;QACF,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuD3D,CAAC;IArDC;;;;;;OAMG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,IAAI,CACF,KAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CACR,SAAiB,EACjB,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;OAEG;IACH,oBAAoB,CAClB,iBAAyB,EACzB,KAAwC,EACxC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iCAAiC,iBAAiB,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AAED,MAAM,OAAO,wBAAyB,SAAQ,IAAyB;CAAG;AAuI1E,QAAQ,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;AAC7D,QAAQ,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;AAC7C,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC"}
1
+ {"version":3,"file":"licenses.mjs","sourceRoot":"","sources":["../../src/resources/licenses/licenses.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,mBAAmB;OACxB,EAGL,gBAAgB,GACjB;OACM,KAAK,QAAQ;OACb,EACL,KAAK,GAKN;OACM,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,qBAAgB,GAAyC,IAAI,mBAAmB,CAAC,gBAAgB,CAC/F,IAAI,CAAC,OAAO,CACb,CAAC;QACF,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmG3D,CAAC;IAjGC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAyB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,SAAiB,EACjB,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,SAAS,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAClB,iBAAyB,EACzB,KAAwC,EACxC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iCAAiC,iBAAiB,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AAED,MAAM,OAAO,wBAAyB,SAAQ,IAAyB;CAAG;AAuI1E,QAAQ,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;AAC7D,QAAQ,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;AAC7C,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC"}
@@ -7,12 +7,27 @@ export declare class Usage extends APIResource {
7
7
  * subscription.
8
8
  *
9
9
  * Date range defaults to the current billing period if not specified.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const response = await client.licenses.usage.getAllUsage({
14
+ * license_type_id: 'license_type_id',
15
+ * subscription_id: 'subscription_id',
16
+ * });
17
+ * ```
10
18
  */
11
19
  getAllUsage(query: UsageGetAllUsageParams, options?: Core.RequestOptions): Core.APIPromise<UsageGetAllUsageResponse>;
12
20
  /**
13
21
  * Returns usage and remaining credits for a specific license over a date range.
14
22
  *
15
23
  * Date range defaults to the current billing period if not specified.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const response = await client.licenses.usage.getUsage(
28
+ * 'license_id',
29
+ * );
30
+ * ```
16
31
  */
17
32
  getUsage(licenseId: string, query?: UsageGetUsageParams, options?: Core.RequestOptions): Core.APIPromise<UsageGetUsageResponse>;
18
33
  getUsage(licenseId: string, options?: Core.RequestOptions): Core.APIPromise<UsageGetUsageResponse>;
@@ -169,7 +184,7 @@ export interface UsageGetAllUsageParams {
169
184
  * How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
170
185
  * 'license,day').
171
186
  */
172
- group_by?: Array<string> | null;
187
+ group_by?: string | null;
173
188
  /**
174
189
  * Maximum number of rows in the response data (default 20, max 100).
175
190
  */
@@ -194,7 +209,7 @@ export interface UsageGetUsageParams {
194
209
  * How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
195
210
  * 'license,day').
196
211
  */
197
- group_by?: Array<string> | null;
212
+ group_by?: string | null;
198
213
  /**
199
214
  * Maximum number of rows in the response data (default 20, max 100).
200
215
  */
@@ -1 +1 @@
1
- {"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/resources/licenses/usage.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;OAKG;IACH,WAAW,CACT,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAI5C;;;;OAIG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IACzC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;CAWnG;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAE3C,mBAAmB,EAAE,MAAM,CAAC,kBAAkB,CAAC;CAChD;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;;;;OAMG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrC;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAExC,mBAAmB,EAAE,MAAM,CAAC,kBAAkB,CAAC;CAChD;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;;;;;OAMG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
1
+ {"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/resources/licenses/usage.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;OAaG;IACH,WAAW,CACT,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAI5C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IACzC,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;CAWnG;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAE3C,mBAAmB,EAAE,MAAM,CAAC,kBAAkB,CAAC;CAChD;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;;;;OAMG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrC;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAExC,mBAAmB,EAAE,MAAM,CAAC,kBAAkB,CAAC;CAChD;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;;;;;OAMG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
@@ -10,6 +10,14 @@ class Usage extends resource_1.APIResource {
10
10
  * subscription.
11
11
  *
12
12
  * Date range defaults to the current billing period if not specified.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const response = await client.licenses.usage.getAllUsage({
17
+ * license_type_id: 'license_type_id',
18
+ * subscription_id: 'subscription_id',
19
+ * });
20
+ * ```
13
21
  */
14
22
  getAllUsage(query, options) {
15
23
  return this._client.get('/licenses/usage', { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"usage.js","sourceRoot":"","sources":["../../src/resources/licenses/usage.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;OAKG;IACH,WAAW,CACT,KAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAaD,QAAQ,CACN,SAAiB,EACjB,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AAnCD,sBAmCC"}
1
+ {"version":3,"file":"usage.js","sourceRoot":"","sources":["../../src/resources/licenses/usage.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;;OAaG;IACH,WAAW,CACT,KAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAoBD,QAAQ,CACN,SAAiB,EACjB,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AAlDD,sBAkDC"}
@@ -7,6 +7,14 @@ export class Usage extends APIResource {
7
7
  * subscription.
8
8
  *
9
9
  * Date range defaults to the current billing period if not specified.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const response = await client.licenses.usage.getAllUsage({
14
+ * license_type_id: 'license_type_id',
15
+ * subscription_id: 'subscription_id',
16
+ * });
17
+ * ```
10
18
  */
11
19
  getAllUsage(query, options) {
12
20
  return this._client.get('/licenses/usage', { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"usage.mjs","sourceRoot":"","sources":["../../src/resources/licenses/usage.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAI3B,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;OAKG;IACH,WAAW,CACT,KAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAaD,QAAQ,CACN,SAAiB,EACjB,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF"}
1
+ {"version":3,"file":"usage.mjs","sourceRoot":"","sources":["../../src/resources/licenses/usage.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAI3B,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;OAaG;IACH,WAAW,CACT,KAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAoBD,QAAQ,CACN,SAAiB,EACjB,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF"}
@@ -11,24 +11,56 @@ export declare class Metrics extends APIResource {
11
11
  * This endpoint is used to create a [metric](/core-concepts###metric) using a SQL
12
12
  * string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a
13
13
  * description of constructing SQL queries with examples.
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * const billableMetric = await client.metrics.create({
18
+ * description: 'Sum of bytes downloaded in fast mode',
19
+ * item_id: 'item_id',
20
+ * name: 'Bytes downloaded',
21
+ * sql: "SELECT sum(bytes_downloaded) FROM events WHERE download_speed = 'fast'",
22
+ * });
23
+ * ```
14
24
  */
15
25
  create(body: MetricCreateParams, options?: Core.RequestOptions): Core.APIPromise<BillableMetric>;
16
26
  /**
17
27
  * This endpoint allows you to update the `metadata` property on a metric. If you
18
28
  * pass `null` for the metadata value, it will clear any existing metadata for that
19
29
  * invoice.
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * const billableMetric = await client.metrics.update(
34
+ * 'metric_id',
35
+ * );
36
+ * ```
20
37
  */
21
38
  update(metricId: string, body: MetricUpdateParams, options?: Core.RequestOptions): Core.APIPromise<BillableMetric>;
22
39
  /**
23
- * This endpoint is used to fetch [metric](/core-concepts##metric) details given a
24
- * metric identifier. It returns information about the metrics including its name,
25
- * description, and item.
40
+ * This endpoint is used to list [metrics](/core-concepts#metric). It returns
41
+ * information about the metrics including its name, description, and item.
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * // Automatically fetches more pages as needed.
46
+ * for await (const billableMetric of client.metrics.list()) {
47
+ * // ...
48
+ * }
49
+ * ```
26
50
  */
27
51
  list(query?: MetricListParams, options?: Core.RequestOptions): Core.PagePromise<BillableMetricsPage, BillableMetric>;
28
52
  list(options?: Core.RequestOptions): Core.PagePromise<BillableMetricsPage, BillableMetric>;
29
53
  /**
30
- * This endpoint is used to list [metrics](/core-concepts#metric). It returns
31
- * information about the metrics including its name, description, and item.
54
+ * This endpoint is used to fetch [metric](/core-concepts#metric) details given a
55
+ * metric identifier. It returns information about the metrics including its name,
56
+ * description, and item.
57
+ *
58
+ * @example
59
+ * ```ts
60
+ * const billableMetric = await client.metrics.fetch(
61
+ * 'metric_id',
62
+ * );
63
+ * ```
32
64
  */
33
65
  fetch(metricId: string, options?: Core.RequestOptions): Core.APIPromise<BillableMetric>;
34
66
  }
@@ -1 +1 @@
1
- {"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAIhG;;;;OAIG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAIlC;;;;OAIG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,cAAc,CAAC;IACxD,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,cAAc,CAAC;IAW1F;;;OAGG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;CAGxF;AAED,qBAAa,mBAAoB,SAAQ,IAAI,CAAC,cAAc,CAAC;CAAG;AAEhE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;IAExC,qBAAqB,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;CAClE;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;CACpD;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;CACpD;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,mBAAmB,IAAI,mBAAmB,EAC1C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
1
+ {"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAIhG;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAIlC;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,cAAc,CAAC;IACxD,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,cAAc,CAAC;IAW1F;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;CAGxF;AAED,qBAAa,mBAAoB,SAAQ,IAAI,CAAC,cAAc,CAAC;CAAG;AAEhE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;IAExC,qBAAqB,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;CAClE;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;CACpD;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;CACpD;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAID,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,mBAAmB,IAAI,mBAAmB,EAC1C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -14,6 +14,16 @@ class Metrics extends resource_1.APIResource {
14
14
  * This endpoint is used to create a [metric](/core-concepts###metric) using a SQL
15
15
  * string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a
16
16
  * description of constructing SQL queries with examples.
17
+ *
18
+ * @example
19
+ * ```ts
20
+ * const billableMetric = await client.metrics.create({
21
+ * description: 'Sum of bytes downloaded in fast mode',
22
+ * item_id: 'item_id',
23
+ * name: 'Bytes downloaded',
24
+ * sql: "SELECT sum(bytes_downloaded) FROM events WHERE download_speed = 'fast'",
25
+ * });
26
+ * ```
17
27
  */
18
28
  create(body, options) {
19
29
  return this._client.post('/metrics', { body, ...options });
@@ -22,6 +32,13 @@ class Metrics extends resource_1.APIResource {
22
32
  * This endpoint allows you to update the `metadata` property on a metric. If you
23
33
  * pass `null` for the metadata value, it will clear any existing metadata for that
24
34
  * invoice.
35
+ *
36
+ * @example
37
+ * ```ts
38
+ * const billableMetric = await client.metrics.update(
39
+ * 'metric_id',
40
+ * );
41
+ * ```
25
42
  */
26
43
  update(metricId, body, options) {
27
44
  return this._client.put(`/metrics/${metricId}`, { body, ...options });
@@ -33,8 +50,16 @@ class Metrics extends resource_1.APIResource {
33
50
  return this._client.getAPIList('/metrics', BillableMetricsPage, { query, ...options });
34
51
  }
35
52
  /**
36
- * This endpoint is used to list [metrics](/core-concepts#metric). It returns
37
- * information about the metrics including its name, description, and item.
53
+ * This endpoint is used to fetch [metric](/core-concepts#metric) details given a
54
+ * metric identifier. It returns information about the metrics including its name,
55
+ * description, and item.
56
+ *
57
+ * @example
58
+ * ```ts
59
+ * const billableMetric = await client.metrics.fetch(
60
+ * 'metric_id',
61
+ * );
62
+ * ```
38
63
  */
39
64
  fetch(metricId, options) {
40
65
  return this._client.get(`/metrics/${metricId}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"metrics.js","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAG3C,iDAAsD;AAEtD;;;GAGG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;OAIG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAYD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAlDD,0BAkDC;AAED,MAAa,mBAAoB,SAAQ,iBAAoB;CAAG;AAAhE,kDAAgE;AAkFhE,OAAO,CAAC,mBAAmB,GAAG,mBAAmB,CAAC"}
1
+ {"version":3,"file":"metrics.js","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAG3C,iDAAsD;AAEtD;;;GAGG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAmBD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAlFD,0BAkFC;AAED,MAAa,mBAAoB,SAAQ,iBAAoB;CAAG;AAAhE,kDAAgE;AAkFhE,OAAO,CAAC,mBAAmB,GAAG,mBAAmB,CAAC"}
@@ -11,6 +11,16 @@ export class Metrics extends APIResource {
11
11
  * This endpoint is used to create a [metric](/core-concepts###metric) using a SQL
12
12
  * string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a
13
13
  * description of constructing SQL queries with examples.
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * const billableMetric = await client.metrics.create({
18
+ * description: 'Sum of bytes downloaded in fast mode',
19
+ * item_id: 'item_id',
20
+ * name: 'Bytes downloaded',
21
+ * sql: "SELECT sum(bytes_downloaded) FROM events WHERE download_speed = 'fast'",
22
+ * });
23
+ * ```
14
24
  */
15
25
  create(body, options) {
16
26
  return this._client.post('/metrics', { body, ...options });
@@ -19,6 +29,13 @@ export class Metrics extends APIResource {
19
29
  * This endpoint allows you to update the `metadata` property on a metric. If you
20
30
  * pass `null` for the metadata value, it will clear any existing metadata for that
21
31
  * invoice.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const billableMetric = await client.metrics.update(
36
+ * 'metric_id',
37
+ * );
38
+ * ```
22
39
  */
23
40
  update(metricId, body, options) {
24
41
  return this._client.put(`/metrics/${metricId}`, { body, ...options });
@@ -30,8 +47,16 @@ export class Metrics extends APIResource {
30
47
  return this._client.getAPIList('/metrics', BillableMetricsPage, { query, ...options });
31
48
  }
32
49
  /**
33
- * This endpoint is used to list [metrics](/core-concepts#metric). It returns
34
- * information about the metrics including its name, description, and item.
50
+ * This endpoint is used to fetch [metric](/core-concepts#metric) details given a
51
+ * metric identifier. It returns information about the metrics including its name,
52
+ * description, and item.
53
+ *
54
+ * @example
55
+ * ```ts
56
+ * const billableMetric = await client.metrics.fetch(
57
+ * 'metric_id',
58
+ * );
59
+ * ```
35
60
  */
36
61
  fetch(metricId, options) {
37
62
  return this._client.get(`/metrics/${metricId}`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"metrics.mjs","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,IAAI,EAAmB;AAEhC;;;GAGG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;OAIG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAYD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,IAAoB;CAAG;AAkFhE,OAAO,CAAC,mBAAmB,GAAG,mBAAmB,CAAC"}
1
+ {"version":3,"file":"metrics.mjs","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,IAAI,EAAmB;AAEhC;;;GAGG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAmBD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,IAAoB;CAAG;AAkFhE,OAAO,CAAC,mBAAmB,GAAG,mBAAmB,CAAC"}
@@ -8,8 +8,8 @@ import * as PlansAPI from "./plans.js";
8
8
  */
9
9
  export declare class ExternalPlanID extends APIResource {
10
10
  /**
11
- * This endpoint can be used to update the `external_plan_id`, and `metadata` of an
12
- * existing plan.
11
+ * This endpoint can be used to update the `external_plan_id`, `description`, and
12
+ * `metadata` of an existing plan.
13
13
  *
14
14
  * Other fields on a plan are currently immutable.
15
15
  */
@@ -35,6 +35,10 @@ export declare class ExternalPlanID extends APIResource {
35
35
  fetch(externalPlanId: string, options?: Core.RequestOptions): Core.APIPromise<PlansAPI.Plan>;
36
36
  }
37
37
  export interface ExternalPlanIDUpdateParams {
38
+ /**
39
+ * An optional user-defined description of the plan.
40
+ */
41
+ description?: string | null;
38
42
  /**
39
43
  * An optional user-defined ID for this plan resource, used throughout the system
40
44
  * as an alias for this Plan. Use this field to identify a plan by an existing
@@ -1 +1 @@
1
- {"version":3,"file":"external-plan-id.d.ts","sourceRoot":"","sources":["../../src/resources/plans/external-plan-id.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AAEpC;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;OAKG;IACH,MAAM,CACJ,mBAAmB,EAAE,MAAM,EAC3B,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;IAIjC;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;CAG7F;AAED,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;CACpD;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EAAE,KAAK,0BAA0B,IAAI,0BAA0B,EAAE,CAAC;CAC1E"}
1
+ {"version":3,"file":"external-plan-id.d.ts","sourceRoot":"","sources":["../../src/resources/plans/external-plan-id.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AAEpC;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;OAKG;IACH,MAAM,CACJ,mBAAmB,EAAE,MAAM,EAC3B,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;IAIjC;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;CAG7F;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,CAAC;CACpD;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EAAE,KAAK,0BAA0B,IAAI,0BAA0B,EAAE,CAAC;CAC1E"}
@@ -10,8 +10,8 @@ const resource_1 = require("../../resource.js");
10
10
  */
11
11
  class ExternalPlanID extends resource_1.APIResource {
12
12
  /**
13
- * This endpoint can be used to update the `external_plan_id`, and `metadata` of an
14
- * existing plan.
13
+ * This endpoint can be used to update the `external_plan_id`, `description`, and
14
+ * `metadata` of an existing plan.
15
15
  *
16
16
  * Other fields on a plan are currently immutable.
17
17
  */
@@ -7,8 +7,8 @@ import { APIResource } from "../../resource.mjs";
7
7
  */
8
8
  export class ExternalPlanID extends APIResource {
9
9
  /**
10
- * This endpoint can be used to update the `external_plan_id`, and `metadata` of an
11
- * existing plan.
10
+ * This endpoint can be used to update the `external_plan_id`, `description`, and
11
+ * `metadata` of an existing plan.
12
12
  *
13
13
  * Other fields on a plan are currently immutable.
14
14
  */
@@ -27,21 +27,63 @@ export declare class Migrations extends APIResource {
27
27
  export declare class MigrationListResponsesPage extends Page<MigrationListResponse> {
28
28
  }
29
29
  export interface MigrationRetrieveResponse {
30
+ /**
31
+ * Unique identifier for this plan version change.
32
+ */
30
33
  id: string;
34
+ /**
35
+ * When the migration takes effect. Can be a specific date/time, or 'end_of_term'
36
+ * when scheduled to be at the end of the current billing period.
37
+ */
31
38
  effective_time: (string & {}) | (string & {}) | 'end_of_term' | null;
39
+ /**
40
+ * The ID of the plan being migrated.
41
+ */
32
42
  plan_id: string;
43
+ /**
44
+ * Current status of the migration: 'not_started', 'in_progress', 'completed',
45
+ * 'action_needed', or 'canceled'.
46
+ */
33
47
  status: 'not_started' | 'in_progress' | 'completed' | 'action_needed' | 'canceled';
34
48
  }
35
49
  export interface MigrationListResponse {
50
+ /**
51
+ * Unique identifier for this plan version change.
52
+ */
36
53
  id: string;
54
+ /**
55
+ * When the migration takes effect. Can be a specific date/time, or 'end_of_term'
56
+ * when scheduled to be at the end of the current billing period.
57
+ */
37
58
  effective_time: (string & {}) | (string & {}) | 'end_of_term' | null;
59
+ /**
60
+ * The ID of the plan being migrated.
61
+ */
38
62
  plan_id: string;
63
+ /**
64
+ * Current status of the migration: 'not_started', 'in_progress', 'completed',
65
+ * 'action_needed', or 'canceled'.
66
+ */
39
67
  status: 'not_started' | 'in_progress' | 'completed' | 'action_needed' | 'canceled';
40
68
  }
41
69
  export interface MigrationCancelResponse {
70
+ /**
71
+ * Unique identifier for this plan version change.
72
+ */
42
73
  id: string;
74
+ /**
75
+ * When the migration takes effect. Can be a specific date/time, or 'end_of_term'
76
+ * when scheduled to be at the end of the current billing period.
77
+ */
43
78
  effective_time: (string & {}) | (string & {}) | 'end_of_term' | null;
79
+ /**
80
+ * The ID of the plan being migrated.
81
+ */
44
82
  plan_id: string;
83
+ /**
84
+ * Current status of the migration: 'not_started', 'in_progress', 'completed',
85
+ * 'action_needed', or 'canceled'.
86
+ */
45
87
  status: 'not_started' | 'in_progress' | 'completed' | 'action_needed' | 'canceled';
46
88
  }
47
89
  export interface MigrationListParams extends PageParams {
@@ -1 +1 @@
1
- {"version":3,"file":"migrations.d.ts","sourceRoot":"","sources":["../../src/resources/plans/migrations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAI7C;;;;;OAKG;IACH,IAAI,CACF,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,qBAAqB,CAAC;IACtE,IAAI,CACF,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,qBAAqB,CAAC;IAetE;;OAEG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;CAG5C;AAED,qBAAa,0BAA2B,SAAQ,IAAI,CAAC,qBAAqB,CAAC;CAAG;AAE9E,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IAEX,cAAc,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,aAAa,GAAG,IAAI,CAAC;IAErE,OAAO,EAAE,MAAM,CAAC;IAEhB,MAAM,EAAE,aAAa,GAAG,aAAa,GAAG,WAAW,GAAG,eAAe,GAAG,UAAU,CAAC;CACpF;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,cAAc,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,aAAa,GAAG,IAAI,CAAC;IAErE,OAAO,EAAE,MAAM,CAAC;IAEhB,MAAM,EAAE,aAAa,GAAG,aAAa,GAAG,WAAW,GAAG,eAAe,GAAG,UAAU,CAAC;CACpF;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,cAAc,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,aAAa,GAAG,IAAI,CAAC;IAErE,OAAO,EAAE,MAAM,CAAC;IAEhB,MAAM,EAAE,aAAa,GAAG,aAAa,GAAG,WAAW,GAAG,eAAe,GAAG,UAAU,CAAC;CACpF;AAED,MAAM,WAAW,mBAAoB,SAAQ,UAAU;CAAG;AAI1D,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,0BAA0B,IAAI,0BAA0B,EACxD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
1
+ {"version":3,"file":"migrations.d.ts","sourceRoot":"","sources":["../../src/resources/plans/migrations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEzD;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAI7C;;;;;OAKG;IACH,IAAI,CACF,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,qBAAqB,CAAC;IACtE,IAAI,CACF,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,qBAAqB,CAAC;IAetE;;OAEG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;CAG5C;AAED,qBAAa,0BAA2B,SAAQ,IAAI,CAAC,qBAAqB,CAAC;CAAG;AAE9E,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,cAAc,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,aAAa,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,EAAE,aAAa,GAAG,aAAa,GAAG,WAAW,GAAG,eAAe,GAAG,UAAU,CAAC;CACpF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,cAAc,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,aAAa,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,EAAE,aAAa,GAAG,aAAa,GAAG,WAAW,GAAG,eAAe,GAAG,UAAU,CAAC;CACpF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,cAAc,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,aAAa,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,EAAE,aAAa,GAAG,aAAa,GAAG,WAAW,GAAG,eAAe,GAAG,UAAU,CAAC;CACpF;AAED,MAAM,WAAW,mBAAoB,SAAQ,UAAU;CAAG;AAI1D,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,0BAA0B,IAAI,0BAA0B,EACxD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
@@ -1 +1 @@
1
- {"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/resources/plans/migrations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,oDAAyD;AAEzD;;;;GAIG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;OAEG;IACH,QAAQ,CACN,MAAc,EACd,WAAmB,EACnB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,eAAe,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAiBD,IAAI,CACF,MAAc,EACd,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACrC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,MAAM,aAAa,EAAE,0BAA0B,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,MAAc,EACd,WAAmB,EACnB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,MAAM,eAAe,WAAW,SAAS,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;CACF;AAnDD,gCAmDC;AAED,MAAa,0BAA2B,SAAQ,iBAA2B;CAAG;AAA9E,gEAA8E;AAkC9E,UAAU,CAAC,0BAA0B,GAAG,0BAA0B,CAAC"}
1
+ {"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/resources/plans/migrations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,oDAAyD;AAEzD;;;;GAIG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;OAEG;IACH,QAAQ,CACN,MAAc,EACd,WAAmB,EACnB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,eAAe,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAiBD,IAAI,CACF,MAAc,EACd,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACrC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,MAAM,aAAa,EAAE,0BAA0B,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,MAAc,EACd,WAAmB,EACnB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,MAAM,eAAe,WAAW,SAAS,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;CACF;AAnDD,gCAmDC;AAED,MAAa,0BAA2B,SAAQ,iBAA2B;CAAG;AAA9E,gEAA8E;AA4E9E,UAAU,CAAC,0BAA0B,GAAG,0BAA0B,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"migrations.mjs","sourceRoot":"","sources":["../../src/resources/plans/migrations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC;;;;GAIG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,QAAQ,CACN,MAAc,EACd,WAAmB,EACnB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,eAAe,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAiBD,IAAI,CACF,MAAc,EACd,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACrC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,MAAM,aAAa,EAAE,0BAA0B,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,MAAc,EACd,WAAmB,EACnB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,MAAM,eAAe,WAAW,SAAS,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;CACF;AAED,MAAM,OAAO,0BAA2B,SAAQ,IAA2B;CAAG;AAkC9E,UAAU,CAAC,0BAA0B,GAAG,0BAA0B,CAAC"}
1
+ {"version":3,"file":"migrations.mjs","sourceRoot":"","sources":["../../src/resources/plans/migrations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC;;;;GAIG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,QAAQ,CACN,MAAc,EACd,WAAmB,EACnB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,MAAM,eAAe,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAiBD,IAAI,CACF,MAAc,EACd,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACrC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,MAAM,aAAa,EAAE,0BAA0B,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,MAAc,EACd,WAAmB,EACnB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,MAAM,eAAe,WAAW,SAAS,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;CACF;AAED,MAAM,OAAO,0BAA2B,SAAQ,IAA2B;CAAG;AA4E9E,UAAU,CAAC,0BAA0B,GAAG,0BAA0B,CAAC"}