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
@@ -6,6 +6,14 @@ const resource_1 = require("../../resource.js");
6
6
  class ExternalDimensionalPriceGroupID extends resource_1.APIResource {
7
7
  /**
8
8
  * Fetch dimensional price group by external ID
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const dimensionalPriceGroup =
13
+ * await client.dimensionalPriceGroups.externalDimensionalPriceGroupId.retrieve(
14
+ * 'external_dimensional_price_group_id',
15
+ * );
16
+ * ```
9
17
  */
10
18
  retrieve(externalDimensionalPriceGroupId, options) {
11
19
  return this._client.get(`/dimensional_price_groups/external_dimensional_price_group_id/${externalDimensionalPriceGroupId}`, options);
@@ -14,6 +22,14 @@ class ExternalDimensionalPriceGroupID extends resource_1.APIResource {
14
22
  * This endpoint can be used to update the `external_dimensional_price_group_id`
15
23
  * and `metadata` of an existing dimensional price group. Other fields on a
16
24
  * dimensional price group are currently immutable.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * const dimensionalPriceGroup =
29
+ * await client.dimensionalPriceGroups.externalDimensionalPriceGroupId.update(
30
+ * 'external_dimensional_price_group_id',
31
+ * );
32
+ * ```
17
33
  */
18
34
  update(externalDimensionalPriceGroupId, body, options) {
19
35
  return this._client.put(`/dimensional_price_groups/external_dimensional_price_group_id/${externalDimensionalPriceGroupId}`, { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"external-dimensional-price-group-id.js","sourceRoot":"","sources":["../../src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAI7C,MAAa,+BAAgC,SAAQ,sBAAW;IAC9D;;OAEG;IACH,QAAQ,CACN,+BAAuC,EACvC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,iEAAiE,+BAA+B,EAAE,EAClG,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,+BAAuC,EACvC,IAAiD,EACjD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,iEAAiE,+BAA+B,EAAE,EAClG,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CACrB,CAAC;IACJ,CAAC;CACF;AA7BD,0EA6BC"}
1
+ {"version":3,"file":"external-dimensional-price-group-id.js","sourceRoot":"","sources":["../../src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAI7C,MAAa,+BAAgC,SAAQ,sBAAW;IAC9D;;;;;;;;;;OAUG;IACH,QAAQ,CACN,+BAAuC,EACvC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,iEAAiE,+BAA+B,EAAE,EAClG,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,+BAAuC,EACvC,IAAiD,EACjD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,iEAAiE,+BAA+B,EAAE,EAClG,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CACrB,CAAC;IACJ,CAAC;CACF;AA7CD,0EA6CC"}
@@ -3,6 +3,14 @@ import { APIResource } from "../../resource.mjs";
3
3
  export class ExternalDimensionalPriceGroupID extends APIResource {
4
4
  /**
5
5
  * Fetch dimensional price group by external ID
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * const dimensionalPriceGroup =
10
+ * await client.dimensionalPriceGroups.externalDimensionalPriceGroupId.retrieve(
11
+ * 'external_dimensional_price_group_id',
12
+ * );
13
+ * ```
6
14
  */
7
15
  retrieve(externalDimensionalPriceGroupId, options) {
8
16
  return this._client.get(`/dimensional_price_groups/external_dimensional_price_group_id/${externalDimensionalPriceGroupId}`, options);
@@ -11,6 +19,14 @@ export class ExternalDimensionalPriceGroupID extends APIResource {
11
19
  * This endpoint can be used to update the `external_dimensional_price_group_id`
12
20
  * and `metadata` of an existing dimensional price group. Other fields on a
13
21
  * dimensional price group are currently immutable.
22
+ *
23
+ * @example
24
+ * ```ts
25
+ * const dimensionalPriceGroup =
26
+ * await client.dimensionalPriceGroups.externalDimensionalPriceGroupId.update(
27
+ * 'external_dimensional_price_group_id',
28
+ * );
29
+ * ```
14
30
  */
15
31
  update(externalDimensionalPriceGroupId, body, options) {
16
32
  return this._client.put(`/dimensional_price_groups/external_dimensional_price_group_id/${externalDimensionalPriceGroupId}`, { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"external-dimensional-price-group-id.mjs","sourceRoot":"","sources":["../../src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,+BAAgC,SAAQ,WAAW;IAC9D;;OAEG;IACH,QAAQ,CACN,+BAAuC,EACvC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,iEAAiE,+BAA+B,EAAE,EAClG,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,+BAAuC,EACvC,IAAiD,EACjD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,iEAAiE,+BAA+B,EAAE,EAClG,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CACrB,CAAC;IACJ,CAAC;CACF"}
1
+ {"version":3,"file":"external-dimensional-price-group-id.mjs","sourceRoot":"","sources":["../../src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,+BAAgC,SAAQ,WAAW;IAC9D;;;;;;;;;;OAUG;IACH,QAAQ,CACN,+BAAuC,EACvC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,iEAAiE,+BAA+B,EAAE,EAClG,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,+BAAuC,EACvC,IAAiD,EACjD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,iEAAiE,+BAA+B,EAAE,EAClG,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CACrB,CAAC;IACJ,CAAC;CACF"}
@@ -48,6 +48,14 @@ export declare class Backfills extends APIResource {
48
48
  *
49
49
  * You may not have multiple backfills in a pending or pending_revert state with
50
50
  * overlapping timeframes.
51
+ *
52
+ * @example
53
+ * ```ts
54
+ * const backfill = await client.events.backfills.create({
55
+ * timeframe_end: '2019-12-27T18:11:19.117Z',
56
+ * timeframe_start: '2019-12-27T18:11:19.117Z',
57
+ * });
58
+ * ```
51
59
  */
52
60
  create(body: BackfillCreateParams, options?: Core.RequestOptions): Core.APIPromise<BackfillCreateResponse>;
53
61
  /**
@@ -57,6 +65,14 @@ export declare class Backfills extends APIResource {
57
65
  * backfill. The response also includes
58
66
  * [`pagination_metadata`](/api-reference/pagination), which lets the caller
59
67
  * retrieve the next page of results if they exist.
68
+ *
69
+ * @example
70
+ * ```ts
71
+ * // Automatically fetches more pages as needed.
72
+ * for await (const backfillListResponse of client.events.backfills.list()) {
73
+ * // ...
74
+ * }
75
+ * ```
60
76
  */
61
77
  list(query?: BackfillListParams, options?: Core.RequestOptions): Core.PagePromise<BackfillListResponsesPage, BackfillListResponse>;
62
78
  list(options?: Core.RequestOptions): Core.PagePromise<BackfillListResponsesPage, BackfillListResponse>;
@@ -65,10 +81,24 @@ export declare class Backfills extends APIResource {
65
81
  * backfill, Orb will asynchronously reflect the updated usage in invoice amounts
66
82
  * and usage graphs. Once all of the updates are complete, the backfill's status
67
83
  * will transition to `reflected`.
84
+ *
85
+ * @example
86
+ * ```ts
87
+ * const response = await client.events.backfills.close(
88
+ * 'backfill_id',
89
+ * );
90
+ * ```
68
91
  */
69
92
  close(backfillId: string, options?: Core.RequestOptions): Core.APIPromise<BackfillCloseResponse>;
70
93
  /**
71
94
  * This endpoint is used to fetch a backfill given an identifier.
95
+ *
96
+ * @example
97
+ * ```ts
98
+ * const response = await client.events.backfills.fetch(
99
+ * 'backfill_id',
100
+ * );
101
+ * ```
72
102
  */
73
103
  fetch(backfillId: string, options?: Core.RequestOptions): Core.APIPromise<BackfillFetchResponse>;
74
104
  /**
@@ -79,6 +109,13 @@ export declare class Backfills extends APIResource {
79
109
  *
80
110
  * If a backfill is reverted before its closed, no usage will be updated as a
81
111
  * result of the backfill and it will immediately transition to `reverted`.
112
+ *
113
+ * @example
114
+ * ```ts
115
+ * const response = await client.events.backfills.revert(
116
+ * 'backfill_id',
117
+ * );
118
+ * ```
82
119
  */
83
120
  revert(backfillId: string, options?: Core.RequestOptions): Core.APIPromise<BackfillRevertResponse>;
84
121
  }
@@ -1 +1 @@
1
- {"version":3,"file":"backfills.d.ts","sourceRoot":"","sources":["../../src/resources/events/backfills.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,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1G;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;IACpE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;IAWtG;;;;;OAKG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIhG;;OAEG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIhG;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;CAGnG;AAED,qBAAa,yBAA0B,SAAQ,IAAI,CAAC,oBAAoB,CAAC;CAAG;AAE5E;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;CAAG;AAIzD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
1
+ {"version":3,"file":"backfills.d.ts","sourceRoot":"","sources":["../../src/resources/events/backfills.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,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1G;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;IACpE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;IAWtG;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIhG;;;;;;;;;OASG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIhG;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;CAGnG;AAED,qBAAa,yBAA0B,SAAQ,IAAI,CAAC,oBAAoB,CAAC;CAAG;AAE5E;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAEhE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;CAAG;AAIzD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -52,6 +52,14 @@ class Backfills extends resource_1.APIResource {
52
52
  *
53
53
  * You may not have multiple backfills in a pending or pending_revert state with
54
54
  * overlapping timeframes.
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * const backfill = await client.events.backfills.create({
59
+ * timeframe_end: '2019-12-27T18:11:19.117Z',
60
+ * timeframe_start: '2019-12-27T18:11:19.117Z',
61
+ * });
62
+ * ```
55
63
  */
56
64
  create(body, options) {
57
65
  return this._client.post('/events/backfills', { body, ...options });
@@ -67,12 +75,26 @@ class Backfills extends resource_1.APIResource {
67
75
  * backfill, Orb will asynchronously reflect the updated usage in invoice amounts
68
76
  * and usage graphs. Once all of the updates are complete, the backfill's status
69
77
  * will transition to `reflected`.
78
+ *
79
+ * @example
80
+ * ```ts
81
+ * const response = await client.events.backfills.close(
82
+ * 'backfill_id',
83
+ * );
84
+ * ```
70
85
  */
71
86
  close(backfillId, options) {
72
87
  return this._client.post(`/events/backfills/${backfillId}/close`, options);
73
88
  }
74
89
  /**
75
90
  * This endpoint is used to fetch a backfill given an identifier.
91
+ *
92
+ * @example
93
+ * ```ts
94
+ * const response = await client.events.backfills.fetch(
95
+ * 'backfill_id',
96
+ * );
97
+ * ```
76
98
  */
77
99
  fetch(backfillId, options) {
78
100
  return this._client.get(`/events/backfills/${backfillId}`, options);
@@ -85,6 +107,13 @@ class Backfills extends resource_1.APIResource {
85
107
  *
86
108
  * If a backfill is reverted before its closed, no usage will be updated as a
87
109
  * result of the backfill and it will immediately transition to `reverted`.
110
+ *
111
+ * @example
112
+ * ```ts
113
+ * const response = await client.events.backfills.revert(
114
+ * 'backfill_id',
115
+ * );
116
+ * ```
88
117
  */
89
118
  revert(backfillId, options) {
90
119
  return this._client.post(`/events/backfills/${backfillId}/revert`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"backfills.js","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,oDAAyD;AAEzD;;;;GAIG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAeD,IAAI,CACF,QAAkD,EAAE,EACpD,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,mBAAmB,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAkB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AAnGD,8BAmGC;AAED,MAAa,yBAA0B,SAAQ,iBAA0B;CAAG;AAA5E,8DAA4E;AAuU5E,SAAS,CAAC,yBAAyB,GAAG,yBAAyB,CAAC"}
1
+ {"version":3,"file":"backfills.js","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,oDAAyD;AAEzD;;;;GAIG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAuBD,IAAI,CACF,QAAkD,EAAE,EACpD,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,mBAAmB,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,UAAkB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AAxID,8BAwIC;AAED,MAAa,yBAA0B,SAAQ,iBAA0B;CAAG;AAA5E,8DAA4E;AAuU5E,SAAS,CAAC,yBAAyB,GAAG,yBAAyB,CAAC"}
@@ -49,6 +49,14 @@ export class Backfills extends APIResource {
49
49
  *
50
50
  * You may not have multiple backfills in a pending or pending_revert state with
51
51
  * overlapping timeframes.
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * const backfill = await client.events.backfills.create({
56
+ * timeframe_end: '2019-12-27T18:11:19.117Z',
57
+ * timeframe_start: '2019-12-27T18:11:19.117Z',
58
+ * });
59
+ * ```
52
60
  */
53
61
  create(body, options) {
54
62
  return this._client.post('/events/backfills', { body, ...options });
@@ -64,12 +72,26 @@ export class Backfills extends APIResource {
64
72
  * backfill, Orb will asynchronously reflect the updated usage in invoice amounts
65
73
  * and usage graphs. Once all of the updates are complete, the backfill's status
66
74
  * will transition to `reflected`.
75
+ *
76
+ * @example
77
+ * ```ts
78
+ * const response = await client.events.backfills.close(
79
+ * 'backfill_id',
80
+ * );
81
+ * ```
67
82
  */
68
83
  close(backfillId, options) {
69
84
  return this._client.post(`/events/backfills/${backfillId}/close`, options);
70
85
  }
71
86
  /**
72
87
  * This endpoint is used to fetch a backfill given an identifier.
88
+ *
89
+ * @example
90
+ * ```ts
91
+ * const response = await client.events.backfills.fetch(
92
+ * 'backfill_id',
93
+ * );
94
+ * ```
73
95
  */
74
96
  fetch(backfillId, options) {
75
97
  return this._client.get(`/events/backfills/${backfillId}`, options);
@@ -82,6 +104,13 @@ export class Backfills extends APIResource {
82
104
  *
83
105
  * If a backfill is reverted before its closed, no usage will be updated as a
84
106
  * result of the backfill and it will immediately transition to `reverted`.
107
+ *
108
+ * @example
109
+ * ```ts
110
+ * const response = await client.events.backfills.revert(
111
+ * 'backfill_id',
112
+ * );
113
+ * ```
85
114
  */
86
115
  revert(backfillId, options) {
87
116
  return this._client.post(`/events/backfills/${backfillId}/revert`, options);
@@ -1 +1 @@
1
- {"version":3,"file":"backfills.mjs","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAeD,IAAI,CACF,QAAkD,EAAE,EACpD,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,mBAAmB,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAkB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,IAA0B;CAAG;AAuU5E,SAAS,CAAC,yBAAyB,GAAG,yBAAyB,CAAC"}
1
+ {"version":3,"file":"backfills.mjs","sourceRoot":"","sources":["../../src/resources/events/backfills.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,EAAE,IAAI,EAAmB;AAEhC;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAuBD,IAAI,CACF,QAAkD,EAAE,EACpD,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,mBAAmB,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,UAAkB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,UAAkB,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,UAAU,SAAS,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,IAA0B;CAAG;AAuU5E,SAAS,CAAC,yBAAyB,GAAG,yBAAyB,CAAC"}
@@ -58,6 +58,15 @@ export declare class Events extends APIResource {
58
58
  * - By default, no more than 100 events can be amended for a single customer in a
59
59
  * 100 day period. For higher volume updates, consider using the
60
60
  * [event backfill](create-backfill) endpoint.
61
+ *
62
+ * @example
63
+ * ```ts
64
+ * const event = await client.events.update('event_id', {
65
+ * event_name: 'event_name',
66
+ * properties: { foo: 'bar' },
67
+ * timestamp: '2020-12-09T16:09:53Z',
68
+ * });
69
+ * ```
61
70
  */
62
71
  update(eventId: string, body: EventUpdateParams, options?: Core.RequestOptions): Core.APIPromise<EventUpdateResponse>;
63
72
  /**
@@ -101,6 +110,11 @@ export declare class Events extends APIResource {
101
110
  * - By default, no more than 100 events can be deprecated for a single customer in
102
111
  * a 100 day period. For higher volume updates, consider using the
103
112
  * [event backfill](create-backfill) endpoint.
113
+ *
114
+ * @example
115
+ * ```ts
116
+ * const response = await client.events.deprecate('event_id');
117
+ * ```
104
118
  */
105
119
  deprecate(eventId: string, options?: Core.RequestOptions): Core.APIPromise<EventDeprecateResponse>;
106
120
  /**
@@ -219,8 +233,8 @@ export declare class Events extends APIResource {
219
233
  * billed for in the corresponding billing period.
220
234
  *
221
235
  * In general, Orb does not expect events with future dated timestamps. In cases
222
- * where the timestamp is at least 24 hours ahead of the current time, the event
223
- * will not be accepted as a valid event, and will throw validation errors.
236
+ * where the timestamp is 5 minutes ahead of the current time, the event will not
237
+ * be accepted as a valid event, and will throw validation errors.
224
238
  *
225
239
  * ## Event validation
226
240
  *
@@ -235,9 +249,9 @@ export declare class Events extends APIResource {
235
249
  * - If the `external_customer_id` is specified, the customer in Orb does not need
236
250
  * to exist. Events will be attributed to any future customers with the
237
251
  * `external_customer_id` on subscription creation.
238
- * - `timestamp` must conform to ISO 8601 and represent a timestamp at most 1 hour
239
- * in the future. This timestamp should be sent in UTC timezone (no timezone
240
- * offset).
252
+ * - `timestamp` must conform to ISO 8601 and represent a timestamp at most 5
253
+ * minutes in the future. This timestamp should be sent in UTC timezone (no
254
+ * timezone offset).
241
255
  *
242
256
  * ## Idempotency and retry semantics
243
257
  *
@@ -274,39 +288,26 @@ export declare class Events extends APIResource {
274
288
  * request payload size, but please give us a heads up if you’re changing either of
275
289
  * these factors by an order of magnitude from initial setup.
276
290
  *
277
- * ## Testing in debug mode
278
- *
279
- * The ingestion API supports a debug mode, which returns additional verbose output
280
- * to indicate which event idempotency keys were newly ingested or duplicates from
281
- * previous requests. To enable this mode, mark `debug=true` as a query parameter.
282
- *
283
- * If `debug=true` is not specified, the response will only contain
284
- * `validation_failed`. Orb will still honor the idempotency guarantees set
285
- * [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency) in all
286
- * cases.
287
- *
288
- * We strongly recommend that you only use debug mode as part of testing your
289
- * initial Orb integration. Once you're ready to switch to production, disable
290
- * debug mode to take advantage of improved performance and maximal throughput.
291
- *
292
- * #### Example: ingestion response with `debug=true`
291
+ * #### Example: ingestion response
293
292
  *
294
293
  * ```json
295
294
  * {
296
- * "debug": {
297
- * "duplicate": [],
298
- * "ingested": ["B7E83HDMfJPAunXW", "SJs5DQJ3TnwSqEZE", "8SivfDsNKwCeAXim"]
299
- * },
300
295
  * "validation_failed": []
301
296
  * }
302
297
  * ```
303
298
  *
304
- * #### Example: ingestion response with `debug=false`
305
- *
306
- * ```json
307
- * {
308
- * "validation_failed": []
309
- * }
299
+ * @example
300
+ * ```ts
301
+ * const response = await client.events.ingest({
302
+ * events: [
303
+ * {
304
+ * event_name: 'event_name',
305
+ * idempotency_key: 'idempotency_key',
306
+ * properties: { foo: 'bar' },
307
+ * timestamp: '2020-12-09T16:09:53Z',
308
+ * },
309
+ * ],
310
+ * });
310
311
  * ```
311
312
  */
312
313
  ingest(params: EventIngestParams, options?: Core.RequestOptions): Core.APIPromise<EventIngestResponse>;
@@ -326,6 +327,13 @@ export declare class Events extends APIResource {
326
327
  *
327
328
  * By default, Orb will not throw a `404` if no events matched, Orb will return an
328
329
  * empty array for `data` instead.
330
+ *
331
+ * @example
332
+ * ```ts
333
+ * const response = await client.events.search({
334
+ * event_ids: ['string'],
335
+ * });
336
+ * ```
329
337
  */
330
338
  search(body: EventSearchParams, options?: Core.RequestOptions): Core.APIPromise<EventSearchResponse>;
331
339
  }
@@ -461,8 +469,8 @@ export interface EventIngestParams {
461
469
  */
462
470
  backfill_id?: string | null;
463
471
  /**
464
- * Query param: Flag to enable additional debug information in the endpoint
465
- * response
472
+ * @deprecated Query param: Pending Deprecation: Flag to enable additional debug
473
+ * information in the endpoint response
466
474
  */
467
475
  debug?: boolean;
468
476
  }
@@ -1 +1 @@
1
- {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/resources/events/events.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,yBAAyB,EACzB,sBAAsB,EACtB,SAAS,EACV,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,SAAS,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAElE;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAIvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAIlG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6MG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAKtG;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGrG;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,iBAAiB,EAAE,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAE/D;;;OAGG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC,KAAK,GAAG,IAAI,CAAC;CAC1C;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAClC;IAED;;;OAGG;IACH,UAAiB,KAAK;QACpB,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;;OAIG;IACH,UAAiB,IAAI;QACnB;;;;WAIG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;;WAGG;QACH,UAAU,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEvC;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAEvC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,UAAU,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEvC;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtC;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAMD,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,KAAK,YAAY,IAAI,YAAY,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CAC3G"}
1
+ {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/resources/events/events.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,yBAAyB,EACzB,sBAAsB,EACtB,SAAS,EACV,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,SAAS,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAElE;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAIvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAIlG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgMG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAKtG;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGrG;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,iBAAiB,EAAE,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAE/D;;;OAGG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC,KAAK,GAAG,IAAI,CAAC;CAC1C;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAClC;IAED;;;OAGG;IACH,UAAiB,KAAK;QACpB,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;;OAIG;IACH,UAAiB,IAAI;QACnB;;;;WAIG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;;WAGG;QACH,UAAU,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEvC;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAEvC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,UAAU,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEvC;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtC;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAMD,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,KAAK,YAAY,IAAI,YAAY,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CAC3G"}
@@ -87,6 +87,15 @@ class Events extends resource_1.APIResource {
87
87
  * - By default, no more than 100 events can be amended for a single customer in a
88
88
  * 100 day period. For higher volume updates, consider using the
89
89
  * [event backfill](create-backfill) endpoint.
90
+ *
91
+ * @example
92
+ * ```ts
93
+ * const event = await client.events.update('event_id', {
94
+ * event_name: 'event_name',
95
+ * properties: { foo: 'bar' },
96
+ * timestamp: '2020-12-09T16:09:53Z',
97
+ * });
98
+ * ```
90
99
  */
91
100
  update(eventId, body, options) {
92
101
  return this._client.put(`/events/${eventId}`, { body, ...options });
@@ -132,6 +141,11 @@ class Events extends resource_1.APIResource {
132
141
  * - By default, no more than 100 events can be deprecated for a single customer in
133
142
  * a 100 day period. For higher volume updates, consider using the
134
143
  * [event backfill](create-backfill) endpoint.
144
+ *
145
+ * @example
146
+ * ```ts
147
+ * const response = await client.events.deprecate('event_id');
148
+ * ```
135
149
  */
136
150
  deprecate(eventId, options) {
137
151
  return this._client.put(`/events/${eventId}/deprecate`, options);
@@ -252,8 +266,8 @@ class Events extends resource_1.APIResource {
252
266
  * billed for in the corresponding billing period.
253
267
  *
254
268
  * In general, Orb does not expect events with future dated timestamps. In cases
255
- * where the timestamp is at least 24 hours ahead of the current time, the event
256
- * will not be accepted as a valid event, and will throw validation errors.
269
+ * where the timestamp is 5 minutes ahead of the current time, the event will not
270
+ * be accepted as a valid event, and will throw validation errors.
257
271
  *
258
272
  * ## Event validation
259
273
  *
@@ -268,9 +282,9 @@ class Events extends resource_1.APIResource {
268
282
  * - If the `external_customer_id` is specified, the customer in Orb does not need
269
283
  * to exist. Events will be attributed to any future customers with the
270
284
  * `external_customer_id` on subscription creation.
271
- * - `timestamp` must conform to ISO 8601 and represent a timestamp at most 1 hour
272
- * in the future. This timestamp should be sent in UTC timezone (no timezone
273
- * offset).
285
+ * - `timestamp` must conform to ISO 8601 and represent a timestamp at most 5
286
+ * minutes in the future. This timestamp should be sent in UTC timezone (no
287
+ * timezone offset).
274
288
  *
275
289
  * ## Idempotency and retry semantics
276
290
  *
@@ -307,39 +321,26 @@ class Events extends resource_1.APIResource {
307
321
  * request payload size, but please give us a heads up if you’re changing either of
308
322
  * these factors by an order of magnitude from initial setup.
309
323
  *
310
- * ## Testing in debug mode
311
- *
312
- * The ingestion API supports a debug mode, which returns additional verbose output
313
- * to indicate which event idempotency keys were newly ingested or duplicates from
314
- * previous requests. To enable this mode, mark `debug=true` as a query parameter.
315
- *
316
- * If `debug=true` is not specified, the response will only contain
317
- * `validation_failed`. Orb will still honor the idempotency guarantees set
318
- * [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency) in all
319
- * cases.
320
- *
321
- * We strongly recommend that you only use debug mode as part of testing your
322
- * initial Orb integration. Once you're ready to switch to production, disable
323
- * debug mode to take advantage of improved performance and maximal throughput.
324
- *
325
- * #### Example: ingestion response with `debug=true`
324
+ * #### Example: ingestion response
326
325
  *
327
326
  * ```json
328
327
  * {
329
- * "debug": {
330
- * "duplicate": [],
331
- * "ingested": ["B7E83HDMfJPAunXW", "SJs5DQJ3TnwSqEZE", "8SivfDsNKwCeAXim"]
332
- * },
333
328
  * "validation_failed": []
334
329
  * }
335
330
  * ```
336
331
  *
337
- * #### Example: ingestion response with `debug=false`
338
- *
339
- * ```json
340
- * {
341
- * "validation_failed": []
342
- * }
332
+ * @example
333
+ * ```ts
334
+ * const response = await client.events.ingest({
335
+ * events: [
336
+ * {
337
+ * event_name: 'event_name',
338
+ * idempotency_key: 'idempotency_key',
339
+ * properties: { foo: 'bar' },
340
+ * timestamp: '2020-12-09T16:09:53Z',
341
+ * },
342
+ * ],
343
+ * });
343
344
  * ```
344
345
  */
345
346
  ingest(params, options) {
@@ -362,6 +363,13 @@ class Events extends resource_1.APIResource {
362
363
  *
363
364
  * By default, Orb will not throw a `404` if no events matched, Orb will return an
364
365
  * empty array for `data` instead.
366
+ *
367
+ * @example
368
+ * ```ts
369
+ * const response = await client.events.search({
370
+ * event_ids: ['string'],
371
+ * });
372
+ * ```
365
373
  */
366
374
  search(body, options) {
367
375
  return this._client.post('/events/search', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/resources/events/events.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAE7C,6DAA4C;AAC5C,8CAUqB;AACrB,uDAAsC;AACtC,wCAAkE;AAElE;;;;GAIG;AACH,MAAa,MAAO,SAAQ,sBAAW;IAAvC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA8UhE,CAAC;IA5UC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,MAAM,CACJ,OAAe,EACf,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,SAAS,CAAC,OAAe,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6MG;IACH,MAAM,CAAC,MAAyB,EAAE,OAA6B;QAC7D,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AAhVD,wBAgVC;AA6ND,MAAM,CAAC,SAAS,GAAG,qBAAS,CAAC;AAC7B,MAAM,CAAC,yBAAyB,GAAG,qCAAyB,CAAC;AAC7D,MAAM,CAAC,MAAM,GAAG,eAAM,CAAC"}
1
+ {"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/resources/events/events.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAE7C,6DAA4C;AAC5C,8CAUqB;AACrB,uDAAsC;AACtC,wCAAkE;AAElE;;;;GAIG;AACH,MAAa,MAAO,SAAQ,sBAAW;IAAvC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsVhE,CAAC;IApVC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,MAAM,CACJ,OAAe,EACf,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,SAAS,CAAC,OAAe,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,YAAY,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgMG;IACH,MAAM,CAAC,MAAyB,EAAE,OAA6B;QAC7D,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AAxVD,wBAwVC;AA6ND,MAAM,CAAC,SAAS,GAAG,qBAAS,CAAC;AAC7B,MAAM,CAAC,yBAAyB,GAAG,qCAAyB,CAAC;AAC7D,MAAM,CAAC,MAAM,GAAG,eAAM,CAAC"}