lark-billing 0.5.0 → 0.7.0

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 (64) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/LICENSE +1 -1
  3. package/README.md +9 -0
  4. package/client.d.mts +3 -0
  5. package/client.d.mts.map +1 -1
  6. package/client.d.ts +3 -0
  7. package/client.d.ts.map +1 -1
  8. package/client.js +3 -0
  9. package/client.js.map +1 -1
  10. package/client.mjs +3 -0
  11. package/client.mjs.map +1 -1
  12. package/package.json +1 -1
  13. package/resources/index.d.mts +1 -0
  14. package/resources/index.d.mts.map +1 -1
  15. package/resources/index.d.ts +1 -0
  16. package/resources/index.d.ts.map +1 -1
  17. package/resources/index.js +3 -1
  18. package/resources/index.js.map +1 -1
  19. package/resources/index.mjs +1 -0
  20. package/resources/index.mjs.map +1 -1
  21. package/resources/rate-cards.d.mts +29 -0
  22. package/resources/rate-cards.d.mts.map +1 -1
  23. package/resources/rate-cards.d.ts +29 -0
  24. package/resources/rate-cards.d.ts.map +1 -1
  25. package/resources/rate-cards.js +2 -0
  26. package/resources/rate-cards.js.map +1 -1
  27. package/resources/rate-cards.mjs +2 -0
  28. package/resources/rate-cards.mjs.map +1 -1
  29. package/resources/rate-catalogs.d.mts +416 -0
  30. package/resources/rate-catalogs.d.mts.map +1 -0
  31. package/resources/rate-catalogs.d.ts +416 -0
  32. package/resources/rate-catalogs.d.ts.map +1 -0
  33. package/resources/rate-catalogs.js +75 -0
  34. package/resources/rate-catalogs.js.map +1 -0
  35. package/resources/rate-catalogs.mjs +71 -0
  36. package/resources/rate-catalogs.mjs.map +1 -0
  37. package/resources/subjects.d.mts +3 -3
  38. package/resources/subjects.d.mts.map +1 -1
  39. package/resources/subjects.d.ts +3 -3
  40. package/resources/subjects.d.ts.map +1 -1
  41. package/resources/subscriptions.d.mts +34 -0
  42. package/resources/subscriptions.d.mts.map +1 -1
  43. package/resources/subscriptions.d.ts +34 -0
  44. package/resources/subscriptions.d.ts.map +1 -1
  45. package/resources/subscriptions.js +2 -0
  46. package/resources/subscriptions.js.map +1 -1
  47. package/resources/subscriptions.mjs +2 -0
  48. package/resources/subscriptions.mjs.map +1 -1
  49. package/resources/usage-events.d.mts +2 -2
  50. package/resources/usage-events.d.ts +2 -2
  51. package/resources/usage-events.js +2 -2
  52. package/resources/usage-events.mjs +2 -2
  53. package/src/client.ts +27 -0
  54. package/src/resources/index.ts +12 -0
  55. package/src/resources/rate-cards.ts +37 -0
  56. package/src/resources/rate-catalogs.ts +597 -0
  57. package/src/resources/subjects.ts +3 -3
  58. package/src/resources/subscriptions.ts +30 -0
  59. package/src/resources/usage-events.ts +2 -2
  60. package/src/version.ts +1 -1
  61. package/version.d.mts +1 -1
  62. package/version.d.ts +1 -1
  63. package/version.js +1 -1
  64. package/version.mjs +1 -1
@@ -17,6 +17,7 @@ export declare class RateCards extends APIResource {
17
17
  * fixed_rates: [
18
18
  * {
19
19
  * name: 'Base Rate',
20
+ * code: 'base_rate',
20
21
  * price: {
21
22
  * price_type: 'flat',
22
23
  * amount: { value: 2500, currency_code: 'usd' },
@@ -28,6 +29,7 @@ export declare class RateCards extends APIResource {
28
29
  * {
29
30
  * usage_based_rate_type: 'simple',
30
31
  * name: 'Compute Hours',
32
+ * code: 'compute_hours',
31
33
  * price: {
32
34
  * price_type: 'flat',
33
35
  * amount: { value: 100, currency_code: 'usd' },
@@ -147,10 +149,15 @@ export interface RateCardResource {
147
149
  * The description of the rate card.
148
150
  */
149
151
  description?: string | null;
152
+ /**
153
+ * The ID of the rate catalog associated with this rate card.
154
+ */
155
+ rate_catalog_id?: string | null;
150
156
  }
151
157
  export declare namespace RateCardResource {
152
158
  interface FixedRate {
153
159
  id: string;
160
+ code: string;
154
161
  description: string | null;
155
162
  name: string;
156
163
  /**
@@ -160,6 +167,7 @@ export declare namespace RateCardResource {
160
167
  }
161
168
  interface SimpleUsageBasedRateInterface {
162
169
  id: string;
170
+ code: string;
163
171
  description: string | null;
164
172
  included_units: number;
165
173
  name: string;
@@ -172,6 +180,7 @@ export declare namespace RateCardResource {
172
180
  }
173
181
  interface DimensionalUsageBasedRateInterface {
174
182
  id: string;
183
+ code: string;
175
184
  description: string | null;
176
185
  dimensions: Array<DimensionalUsageBasedRateInterface.Dimension>;
177
186
  included_units: number;
@@ -227,6 +236,11 @@ export interface RateCardCreateParams {
227
236
  metadata?: {
228
237
  [key: string]: string;
229
238
  };
239
+ /**
240
+ * The ID of the rate catalog to pull rates from. If set, rates from the catalog
241
+ * with quantity > 1 will be included.
242
+ */
243
+ rate_catalog_id?: string | null;
230
244
  /**
231
245
  * The usage based rates of the rate card. These are billed at the end of each
232
246
  * billing cycle.
@@ -235,6 +249,11 @@ export interface RateCardCreateParams {
235
249
  }
236
250
  export declare namespace RateCardCreateParams {
237
251
  interface FixedRate {
252
+ /**
253
+ * Code of this rate to be used for setting quantity and price multipliers. This
254
+ * code must be unique within the rate card.
255
+ */
256
+ code: string;
238
257
  /**
239
258
  * The name of the rate displayed to the customer.
240
259
  */
@@ -249,6 +268,11 @@ export declare namespace RateCardCreateParams {
249
268
  description?: string | null;
250
269
  }
251
270
  interface CreateSimpleUsageBasedRateRequest {
271
+ /**
272
+ * Code of this rate to be used for price multipliers. This code must be unique
273
+ * within the rate card.
274
+ */
275
+ code: string;
252
276
  /**
253
277
  * The name of the rate displayed to the customer.
254
278
  */
@@ -272,6 +296,11 @@ export declare namespace RateCardCreateParams {
272
296
  included_units?: number;
273
297
  }
274
298
  interface CreateDimensionalUsageBasedRateRequest {
299
+ /**
300
+ * Code of this rate to be used for price multipliers. This code must be unique
301
+ * within the rate card.
302
+ */
303
+ code: string;
275
304
  /**
276
305
  * The dimensions of the rate.
277
306
  */
@@ -1 +1 @@
1
- {"version":3,"file":"rate-cards.d.ts","sourceRoot":"","sources":["../src/resources/rate-cards.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAI1F;;;;;;;;;OASG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAIpF;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;CAGpC;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,WAAW,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,WAAW,CAAC,YAAY,CAAC;IAEjC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,WAAW,CAAC;IAEpB,aAAa,EAAE,MAAM,CAAC;IAEtB,iBAAiB,EAAE,UAAU,GAAG,YAAY,CAAC;IAE7C,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,WAAW,CAAC,YAAY,CAAC;IAEjC,aAAa,EAAE,MAAM,CAAC;IAEtB,iBAAiB,EAAE,UAAU,GAAG,YAAY,CAAC;IAE7C,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/C;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,EAAE,KAAK,CACtB,gBAAgB,CAAC,6BAA6B,GAAG,gBAAgB,CAAC,kCAAkC,CACrG,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,SAAS;QACxB,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,eAAe,GAAG,YAAY,CAAC,kBAAkB,CAAC;KACvE;IAED,UAAiB,6BAA6B;QAC5C,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,cAAc,EAAE,MAAM,CAAC;QAEvB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,eAAe,GAAG,YAAY,CAAC,kBAAkB,CAAC;QAEtE,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qBAAqB,CAAC,EAAE,QAAQ,CAAC;KAClC;IAED,UAAiB,kCAAkC;QACjD,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,kCAAkC,CAAC,SAAS,CAAC,CAAC;QAEhE,cAAc,EAAE,MAAM,CAAC;QAEvB,IAAI,EAAE,MAAM,CAAC;QAEb,cAAc,EAAE,kCAAkC,CAAC,aAAa,CAAC;QAEjE,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qBAAqB,CAAC,EAAE,aAAa,CAAC;KACvC;IAED,UAAiB,kCAAkC,CAAC;QAClD,UAAiB,SAAS;YACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B,GAAG,EAAE,MAAM,CAAC;YAEZ,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACvB;QAED,UAAiB,aAAa;YAC5B,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;SAClC;QAED,UAAiB,aAAa,CAAC;YAC7B,UAAiB,IAAI;gBACnB,qBAAqB,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;gBAEjD;;mBAEG;gBACH,KAAK,EAAE,YAAY,CAAC,eAAe,GAAG,YAAY,CAAC,kBAAkB,CAAC;aACvE;SACF;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,OAAO,CAAC;IAElB,UAAU,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,gBAAgB,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAEpD,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,KAAK,CACrB,oBAAoB,CAAC,iCAAiC,GACtD,oBAAoB,CAAC,sCAAsC,CAC9D,CAAC;CACH;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,cAAc,GAAG,YAAY,CAAC,iBAAiB,CAAC;QAEpE;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;IAED,UAAiB,iCAAiC;QAChD;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,cAAc,GAAG,YAAY,CAAC,iBAAiB,CAAC;QAEpE;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qBAAqB,EAAE,QAAQ,CAAC;QAEhC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,sCAAsC;QACrD;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,sCAAsC,CAAC,SAAS,CAAC,CAAC;QAEpE;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,cAAc,EAAE,sCAAsC,CAAC,aAAa,CAAC;QAErE;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qBAAqB,EAAE,aAAa,CAAC;QAErC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,sCAAsC,CAAC;QACtD,UAAiB,SAAS;YACxB;;;eAGG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;QAED;;WAEG;QACH,UAAiB,aAAa;YAC5B,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;SAClC;QAED,UAAiB,aAAa,CAAC;YAC7B,UAAiB,IAAI;gBACnB;;;mBAGG;gBACH,qBAAqB,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;gBAEjD;;mBAEG;gBACH,KAAK,EAAE,YAAY,CAAC,cAAc,GAAG,YAAY,CAAC,iBAAiB,CAAC;aACrE;SACF;KACF;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
1
+ {"version":3,"file":"rate-cards.d.ts","sourceRoot":"","sources":["../src/resources/rate-cards.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAI1F;;;;;;;;;OASG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAIpF;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;CAGpC;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,WAAW,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,WAAW,CAAC,YAAY,CAAC;IAEjC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,WAAW,CAAC;IAEpB,aAAa,EAAE,MAAM,CAAC;IAEtB,iBAAiB,EAAE,UAAU,GAAG,YAAY,CAAC;IAE7C,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,WAAW,CAAC,YAAY,CAAC;IAEjC,aAAa,EAAE,MAAM,CAAC;IAEtB,iBAAiB,EAAE,UAAU,GAAG,YAAY,CAAC;IAE7C,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/C;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,EAAE,KAAK,CACtB,gBAAgB,CAAC,6BAA6B,GAAG,gBAAgB,CAAC,kCAAkC,CACrG,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,SAAS;QACxB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,MAAM,CAAC;QAEb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,eAAe,GAAG,YAAY,CAAC,kBAAkB,CAAC;KACvE;IAED,UAAiB,6BAA6B;QAC5C,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,MAAM,CAAC;QAEb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,cAAc,EAAE,MAAM,CAAC;QAEvB,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,eAAe,GAAG,YAAY,CAAC,kBAAkB,CAAC;QAEtE,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qBAAqB,CAAC,EAAE,QAAQ,CAAC;KAClC;IAED,UAAiB,kCAAkC;QACjD,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,MAAM,CAAC;QAEb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,EAAE,KAAK,CAAC,kCAAkC,CAAC,SAAS,CAAC,CAAC;QAEhE,cAAc,EAAE,MAAM,CAAC;QAEvB,IAAI,EAAE,MAAM,CAAC;QAEb,cAAc,EAAE,kCAAkC,CAAC,aAAa,CAAC;QAEjE,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qBAAqB,CAAC,EAAE,aAAa,CAAC;KACvC;IAED,UAAiB,kCAAkC,CAAC;QAClD,UAAiB,SAAS;YACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B,GAAG,EAAE,MAAM,CAAC;YAEZ,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACvB;QAED,UAAiB,aAAa;YAC5B,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;SAClC;QAED,UAAiB,aAAa,CAAC;YAC7B,UAAiB,IAAI;gBACnB,qBAAqB,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;gBAEjD;;mBAEG;gBACH,KAAK,EAAE,YAAY,CAAC,eAAe,GAAG,YAAY,CAAC,kBAAkB,CAAC;aACvE;SACF;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,OAAO,CAAC;IAElB,UAAU,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,gBAAgB,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAEpD,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,KAAK,CACrB,oBAAoB,CAAC,iCAAiC,GACtD,oBAAoB,CAAC,sCAAsC,CAC9D,CAAC;CACH;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,SAAS;QACxB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,cAAc,GAAG,YAAY,CAAC,iBAAiB,CAAC;QAEpE;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;IAED,UAAiB,iCAAiC;QAChD;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,cAAc,GAAG,YAAY,CAAC,iBAAiB,CAAC;QAEpE;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qBAAqB,EAAE,QAAQ,CAAC;QAEhC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,sCAAsC;QACrD;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,sCAAsC,CAAC,SAAS,CAAC,CAAC;QAEpE;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,cAAc,EAAE,sCAAsC,CAAC,aAAa,CAAC;QAErE;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qBAAqB,EAAE,aAAa,CAAC;QAErC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,sCAAsC,CAAC;QACtD,UAAiB,SAAS;YACxB;;;eAGG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;QAED;;WAEG;QACH,UAAiB,aAAa;YAC5B,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;SAClC;QAED,UAAiB,aAAa,CAAC;YAC7B,UAAiB,IAAI;gBACnB;;;mBAGG;gBACH,qBAAqB,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;gBAEjD;;mBAEG;gBACH,KAAK,EAAE,YAAY,CAAC,cAAc,GAAG,YAAY,CAAC,iBAAiB,CAAC;aACrE;SACF;KACF;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -18,6 +18,7 @@ class RateCards extends resource_1.APIResource {
18
18
  * fixed_rates: [
19
19
  * {
20
20
  * name: 'Base Rate',
21
+ * code: 'base_rate',
21
22
  * price: {
22
23
  * price_type: 'flat',
23
24
  * amount: { value: 2500, currency_code: 'usd' },
@@ -29,6 +30,7 @@ class RateCards extends resource_1.APIResource {
29
30
  * {
30
31
  * usage_based_rate_type: 'simple',
31
32
  * name: 'Compute Hours',
33
+ * code: 'compute_hours',
32
34
  * price: {
33
35
  * price_type: 'flat',
34
36
  * amount: { value: 100, currency_code: 'usd' },
@@ -1 +1 @@
1
- {"version":3,"file":"rate-cards.js","sourceRoot":"","sources":["../src/resources/rate-cards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AApED,8BAoEC"}
1
+ {"version":3,"file":"rate-cards.js","sourceRoot":"","sources":["../src/resources/rate-cards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AAtED,8BAsEC"}
@@ -15,6 +15,7 @@ export class RateCards extends APIResource {
15
15
  * fixed_rates: [
16
16
  * {
17
17
  * name: 'Base Rate',
18
+ * code: 'base_rate',
18
19
  * price: {
19
20
  * price_type: 'flat',
20
21
  * amount: { value: 2500, currency_code: 'usd' },
@@ -26,6 +27,7 @@ export class RateCards extends APIResource {
26
27
  * {
27
28
  * usage_based_rate_type: 'simple',
28
29
  * name: 'Compute Hours',
30
+ * code: 'compute_hours',
29
31
  * price: {
30
32
  * price_type: 'flat',
31
33
  * amount: { value: 100, currency_code: 'usd' },
@@ -1 +1 @@
1
- {"version":3,"file":"rate-cards.mjs","sourceRoot":"","sources":["../src/resources/rate-cards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF"}
1
+ {"version":3,"file":"rate-cards.mjs","sourceRoot":"","sources":["../src/resources/rate-cards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF"}
@@ -0,0 +1,416 @@
1
+ import { APIResource } from "../core/resource.mjs";
2
+ import * as InvoicesAPI from "./invoices.mjs";
3
+ import * as RateCardsAPI from "./rate-cards.mjs";
4
+ import { APIPromise } from "../core/api-promise.mjs";
5
+ import { RequestOptions } from "../internal/request-options.mjs";
6
+ export declare class RateCatalogs extends APIResource {
7
+ /**
8
+ * Create Rate Catalog
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const rateCatalog = await client.rateCatalogs.create({
13
+ * description: 'My Catalog Description',
14
+ * name: 'My Catalog',
15
+ * });
16
+ * ```
17
+ */
18
+ create(body: RateCatalogCreateParams, options?: RequestOptions): APIPromise<RateCatalogCreateResponse>;
19
+ /**
20
+ * Get Rate Catalog
21
+ *
22
+ * @example
23
+ * ```ts
24
+ * const rateCatalog = await client.rateCatalogs.retrieve(
25
+ * 'rate_catalog_id',
26
+ * );
27
+ * ```
28
+ */
29
+ retrieve(rateCatalogID: string, options?: RequestOptions): APIPromise<RateCatalogRetrieveResponse>;
30
+ /**
31
+ * List Rate Catalogs
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const rateCatalogs = await client.rateCatalogs.list();
36
+ * ```
37
+ */
38
+ list(query?: RateCatalogListParams | null | undefined, options?: RequestOptions): APIPromise<RateCatalogListResponse>;
39
+ /**
40
+ * Add Rates To Rate Catalog
41
+ *
42
+ * @example
43
+ * ```ts
44
+ * const response = await client.rateCatalogs.addRates(
45
+ * 'rate_catalog_id',
46
+ * { billing_interval: 'monthly' },
47
+ * );
48
+ * ```
49
+ */
50
+ addRates(rateCatalogID: string, body: RateCatalogAddRatesParams, options?: RequestOptions): APIPromise<RateCatalogAddRatesResponse>;
51
+ /**
52
+ * List Rates In Catalog
53
+ *
54
+ * @example
55
+ * ```ts
56
+ * const response = await client.rateCatalogs.listRates(
57
+ * 'rate_catalog_id',
58
+ * );
59
+ * ```
60
+ */
61
+ listRates(rateCatalogID: string, query?: RateCatalogListRatesParams | null | undefined, options?: RequestOptions): APIPromise<RateCatalogListRatesResponse>;
62
+ }
63
+ export interface RateCatalogCreateResponse {
64
+ id: string;
65
+ description: string;
66
+ name: string;
67
+ rate_count: number;
68
+ }
69
+ export interface RateCatalogRetrieveResponse {
70
+ id: string;
71
+ description: string;
72
+ name: string;
73
+ rate_count: number;
74
+ }
75
+ export interface RateCatalogListResponse {
76
+ has_more: boolean;
77
+ rate_catalogs: Array<RateCatalogListResponse.RateCatalog>;
78
+ }
79
+ export declare namespace RateCatalogListResponse {
80
+ interface RateCatalog {
81
+ id: string;
82
+ description: string;
83
+ name: string;
84
+ rate_count: number;
85
+ }
86
+ }
87
+ export interface RateCatalogAddRatesResponse {
88
+ id: string;
89
+ description: string;
90
+ name: string;
91
+ rate_count: number;
92
+ }
93
+ export interface RateCatalogListRatesResponse {
94
+ has_more: boolean;
95
+ rates: Array<RateCatalogListRatesResponse.Rate>;
96
+ }
97
+ export declare namespace RateCatalogListRatesResponse {
98
+ interface Rate {
99
+ id: string;
100
+ interval: 'monthly' | 'yearly';
101
+ rate_catalog_id: string;
102
+ type: 'fixed' | 'usage_based';
103
+ fixed?: Rate.Fixed | null;
104
+ usage_based?: Rate.SimpleUsageBasedRateTypedDict | Rate.DimensionalUsageBasedRateTypedDict | null;
105
+ }
106
+ namespace Rate {
107
+ interface Fixed {
108
+ id: string;
109
+ code: string | null;
110
+ credit_grants: Array<Fixed.CreditGrant>;
111
+ description: string | null;
112
+ name: string;
113
+ price: Fixed.FlatPriceTypedDict | Fixed.PackagePriceTypedDict;
114
+ quantity_code: string | null;
115
+ }
116
+ namespace Fixed {
117
+ interface CreditGrant {
118
+ amount: InvoicesAPI.AmountOutput;
119
+ expiration: CreditGrant.CreditGrantDurationExpirationModel | CreditGrant.CreditGrantDateTimeExpirationModel | null;
120
+ metadata: {
121
+ [key: string]: string;
122
+ };
123
+ name: string;
124
+ schedule: CreditGrant.CreditGrantScheduleOneTimeModel | CreditGrant.CreditGrantScheduleRateCycleStartModel | null;
125
+ subject_granting_config: CreditGrant.SubjectGrantingConfig | null;
126
+ }
127
+ namespace CreditGrant {
128
+ interface CreditGrantDurationExpirationModel {
129
+ duration: number;
130
+ unit: 'hours' | 'days' | 'weeks' | 'months' | 'years';
131
+ expiration_type?: 'duration';
132
+ }
133
+ interface CreditGrantDateTimeExpirationModel {
134
+ date: string;
135
+ expiration_type?: 'date';
136
+ }
137
+ interface CreditGrantScheduleOneTimeModel {
138
+ scheduled_at: string;
139
+ schedule_type?: 'one_time';
140
+ }
141
+ interface CreditGrantScheduleRateCycleStartModel {
142
+ rate_cycle_start_at: string;
143
+ schedule_type?: 'rate_cycle_start';
144
+ }
145
+ interface SubjectGrantingConfig {
146
+ apply_to_children: boolean;
147
+ apply_to_self: boolean;
148
+ }
149
+ }
150
+ interface FlatPriceTypedDict {
151
+ amount: FlatPriceTypedDict.Amount;
152
+ price_type: 'flat';
153
+ }
154
+ namespace FlatPriceTypedDict {
155
+ interface Amount {
156
+ currency_code: string;
157
+ value: string;
158
+ }
159
+ }
160
+ interface PackagePriceTypedDict {
161
+ amount: PackagePriceTypedDict.Amount;
162
+ package_units: number;
163
+ price_type: 'package';
164
+ rounding_behavior: 'round_up' | 'round_down';
165
+ }
166
+ namespace PackagePriceTypedDict {
167
+ interface Amount {
168
+ currency_code: string;
169
+ value: string;
170
+ }
171
+ }
172
+ }
173
+ interface SimpleUsageBasedRateTypedDict {
174
+ id: string;
175
+ code: string;
176
+ description: string | null;
177
+ included_units: number;
178
+ name: string;
179
+ price: SimpleUsageBasedRateTypedDict.FlatPriceTypedDict | SimpleUsageBasedRateTypedDict.PackagePriceTypedDict;
180
+ pricing_metric_id: string;
181
+ usage_based_rate_type: 'simple';
182
+ }
183
+ namespace SimpleUsageBasedRateTypedDict {
184
+ interface FlatPriceTypedDict {
185
+ amount: FlatPriceTypedDict.Amount;
186
+ price_type: 'flat';
187
+ }
188
+ namespace FlatPriceTypedDict {
189
+ interface Amount {
190
+ currency_code: string;
191
+ value: string;
192
+ }
193
+ }
194
+ interface PackagePriceTypedDict {
195
+ amount: PackagePriceTypedDict.Amount;
196
+ package_units: number;
197
+ price_type: 'package';
198
+ rounding_behavior: 'round_up' | 'round_down';
199
+ }
200
+ namespace PackagePriceTypedDict {
201
+ interface Amount {
202
+ currency_code: string;
203
+ value: string;
204
+ }
205
+ }
206
+ }
207
+ interface DimensionalUsageBasedRateTypedDict {
208
+ id: string;
209
+ code: string;
210
+ description: string | null;
211
+ dimensions: Array<DimensionalUsageBasedRateTypedDict.Dimension>;
212
+ included_units: number;
213
+ name: string;
214
+ pricing_matrix: DimensionalUsageBasedRateTypedDict.PricingMatrix;
215
+ pricing_metric_id: string;
216
+ usage_based_rate_type: 'dimensional';
217
+ }
218
+ namespace DimensionalUsageBasedRateTypedDict {
219
+ interface Dimension {
220
+ description: string | null;
221
+ key: string;
222
+ values: Array<string>;
223
+ }
224
+ interface PricingMatrix {
225
+ cells: Array<PricingMatrix.Cell>;
226
+ }
227
+ namespace PricingMatrix {
228
+ interface Cell {
229
+ dimension_coordinates: {
230
+ [key: string]: string;
231
+ };
232
+ price: Cell.FlatPriceTypedDict | Cell.PackagePriceTypedDict;
233
+ }
234
+ namespace Cell {
235
+ interface FlatPriceTypedDict {
236
+ amount: FlatPriceTypedDict.Amount;
237
+ price_type: 'flat';
238
+ }
239
+ namespace FlatPriceTypedDict {
240
+ interface Amount {
241
+ currency_code: string;
242
+ value: string;
243
+ }
244
+ }
245
+ interface PackagePriceTypedDict {
246
+ amount: PackagePriceTypedDict.Amount;
247
+ package_units: number;
248
+ price_type: 'package';
249
+ rounding_behavior: 'round_up' | 'round_down';
250
+ }
251
+ namespace PackagePriceTypedDict {
252
+ interface Amount {
253
+ currency_code: string;
254
+ value: string;
255
+ }
256
+ }
257
+ }
258
+ }
259
+ }
260
+ }
261
+ }
262
+ export interface RateCatalogCreateParams {
263
+ /**
264
+ * The description of the catalog.
265
+ */
266
+ description: string;
267
+ /**
268
+ * The name of the catalog.
269
+ */
270
+ name: string;
271
+ }
272
+ export interface RateCatalogListParams {
273
+ limit?: number;
274
+ offset?: number;
275
+ }
276
+ export interface RateCatalogAddRatesParams {
277
+ /**
278
+ * How often the customer will be billed for these rates.
279
+ */
280
+ billing_interval: 'monthly' | 'yearly';
281
+ /**
282
+ * The fixed rate to create in the catalog.
283
+ */
284
+ fixed_rates?: Array<RateCatalogAddRatesParams.FixedRate>;
285
+ /**
286
+ * The usage based rates to create in the catalog.
287
+ */
288
+ usage_based_rates?: Array<RateCatalogAddRatesParams.CreateSimpleUsageBasedRateRequest | RateCatalogAddRatesParams.CreateDimensionalUsageBasedRateRequest>;
289
+ }
290
+ export declare namespace RateCatalogAddRatesParams {
291
+ interface FixedRate {
292
+ /**
293
+ * Code of this rate to be used for setting quantity and price multipliers. This
294
+ * code must be unique within the rate card.
295
+ */
296
+ code: string;
297
+ /**
298
+ * The name of the rate displayed to the customer.
299
+ */
300
+ name: string;
301
+ /**
302
+ * Flat price is a price that linearly scales with the quantity.
303
+ */
304
+ price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
305
+ /**
306
+ * The description of the rate displayed to the customer.
307
+ */
308
+ description?: string | null;
309
+ }
310
+ interface CreateSimpleUsageBasedRateRequest {
311
+ /**
312
+ * Code of this rate to be used for price multipliers. This code must be unique
313
+ * within the rate card.
314
+ */
315
+ code: string;
316
+ /**
317
+ * The name of the rate displayed to the customer.
318
+ */
319
+ name: string;
320
+ /**
321
+ * Flat price is a price that linearly scales with the quantity.
322
+ */
323
+ price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
324
+ /**
325
+ * The ID of the pricing metric to use for this rate.
326
+ */
327
+ pricing_metric_id: string;
328
+ usage_based_rate_type: 'simple';
329
+ /**
330
+ * The description of the rate displayed to the customer.
331
+ */
332
+ description?: string | null;
333
+ /**
334
+ * The number of units included in the rate before the price is applied.
335
+ */
336
+ included_units?: number;
337
+ }
338
+ interface CreateDimensionalUsageBasedRateRequest {
339
+ /**
340
+ * Code of this rate to be used for price multipliers. This code must be unique
341
+ * within the rate card.
342
+ */
343
+ code: string;
344
+ /**
345
+ * The dimensions of the rate.
346
+ */
347
+ dimensions: Array<CreateDimensionalUsageBasedRateRequest.Dimension>;
348
+ /**
349
+ * The name of the rate displayed to the customer.
350
+ */
351
+ name: string;
352
+ /**
353
+ * The pricing matrix of the rate.
354
+ */
355
+ pricing_matrix: CreateDimensionalUsageBasedRateRequest.PricingMatrix;
356
+ /**
357
+ * The ID of the pricing metric to use for this rate.
358
+ */
359
+ pricing_metric_id: string;
360
+ usage_based_rate_type: 'dimensional';
361
+ /**
362
+ * The description of the rate displayed to the customer.
363
+ */
364
+ description?: string | null;
365
+ /**
366
+ * The number of units included in the rate before the price is applied.
367
+ */
368
+ included_units?: number;
369
+ }
370
+ namespace CreateDimensionalUsageBasedRateRequest {
371
+ interface Dimension {
372
+ /**
373
+ * The name of the dimension. This is used to identify the dimension in the pricing
374
+ * matrix.
375
+ */
376
+ key: string;
377
+ /**
378
+ * A list of possible values for the dimension.
379
+ */
380
+ values: Array<string>;
381
+ /**
382
+ * The description of the dimension.
383
+ */
384
+ description?: string | null;
385
+ }
386
+ /**
387
+ * The pricing matrix of the rate.
388
+ */
389
+ interface PricingMatrix {
390
+ cells: Array<PricingMatrix.Cell>;
391
+ }
392
+ namespace PricingMatrix {
393
+ interface Cell {
394
+ /**
395
+ * A key-value mapping of dimension keys and values to identify the price for a
396
+ * given set of dimension values.
397
+ */
398
+ dimension_coordinates: {
399
+ [key: string]: string;
400
+ };
401
+ /**
402
+ * The price for the cell.
403
+ */
404
+ price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
405
+ }
406
+ }
407
+ }
408
+ }
409
+ export interface RateCatalogListRatesParams {
410
+ limit?: number;
411
+ offset?: number;
412
+ }
413
+ export declare namespace RateCatalogs {
414
+ export { type RateCatalogCreateResponse as RateCatalogCreateResponse, type RateCatalogRetrieveResponse as RateCatalogRetrieveResponse, type RateCatalogListResponse as RateCatalogListResponse, type RateCatalogAddRatesResponse as RateCatalogAddRatesResponse, type RateCatalogListRatesResponse as RateCatalogListRatesResponse, type RateCatalogCreateParams as RateCatalogCreateParams, type RateCatalogListParams as RateCatalogListParams, type RateCatalogAddRatesParams as RateCatalogAddRatesParams, type RateCatalogListRatesParams as RateCatalogListRatesParams, };
415
+ }
416
+ //# sourceMappingURL=rate-catalogs.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rate-catalogs.d.mts","sourceRoot":"","sources":["../src/resources/rate-catalogs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAItG;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAIlG;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;OASG;IACH,SAAS,CACP,aAAa,EAAE,MAAM,EACrB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,OAAO,CAAC;IAElB,aAAa,EAAE,KAAK,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC3D;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,WAAW;QAC1B,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,MAAM,CAAC;QAEpB,IAAI,EAAE,MAAM,CAAC;QAEb,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,OAAO,CAAC;IAElB,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;CACjD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,QAAQ,EAAE,SAAS,GAAG,QAAQ,CAAC;QAE/B,eAAe,EAAE,MAAM,CAAC;QAExB,IAAI,EAAE,OAAO,GAAG,aAAa,CAAC;QAE9B,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAE1B,WAAW,CAAC,EAAE,IAAI,CAAC,6BAA6B,GAAG,IAAI,CAAC,kCAAkC,GAAG,IAAI,CAAC;KACnG;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,KAAK;YACpB,EAAE,EAAE,MAAM,CAAC;YAEX,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB,aAAa,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YAExC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,EAAE,KAAK,CAAC,kBAAkB,GAAG,KAAK,CAAC,qBAAqB,CAAC;YAE9D,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;SAC9B;QAED,UAAiB,KAAK,CAAC;YACrB,UAAiB,WAAW;gBAC1B,MAAM,EAAE,WAAW,CAAC,YAAY,CAAC;gBAEjC,UAAU,EACN,WAAW,CAAC,kCAAkC,GAC9C,WAAW,CAAC,kCAAkC,GAC9C,IAAI,CAAC;gBAET,QAAQ,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;gBAEpC,IAAI,EAAE,MAAM,CAAC;gBAEb,QAAQ,EACJ,WAAW,CAAC,+BAA+B,GAC3C,WAAW,CAAC,sCAAsC,GAClD,IAAI,CAAC;gBAET,uBAAuB,EAAE,WAAW,CAAC,qBAAqB,GAAG,IAAI,CAAC;aACnE;YAED,UAAiB,WAAW,CAAC;gBAC3B,UAAiB,kCAAkC;oBACjD,QAAQ,EAAE,MAAM,CAAC;oBAEjB,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;oBAEtD,eAAe,CAAC,EAAE,UAAU,CAAC;iBAC9B;gBAED,UAAiB,kCAAkC;oBACjD,IAAI,EAAE,MAAM,CAAC;oBAEb,eAAe,CAAC,EAAE,MAAM,CAAC;iBAC1B;gBAED,UAAiB,+BAA+B;oBAC9C,YAAY,EAAE,MAAM,CAAC;oBAErB,aAAa,CAAC,EAAE,UAAU,CAAC;iBAC5B;gBAED,UAAiB,sCAAsC;oBACrD,mBAAmB,EAAE,MAAM,CAAC;oBAE5B,aAAa,CAAC,EAAE,kBAAkB,CAAC;iBACpC;gBAED,UAAiB,qBAAqB;oBACpC,iBAAiB,EAAE,OAAO,CAAC;oBAE3B,aAAa,EAAE,OAAO,CAAC;iBACxB;aACF;YAED,UAAiB,kBAAkB;gBACjC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC;gBAElC,UAAU,EAAE,MAAM,CAAC;aACpB;YAED,UAAiB,kBAAkB,CAAC;gBAClC,UAAiB,MAAM;oBACrB,aAAa,EAAE,MAAM,CAAC;oBAEtB,KAAK,EAAE,MAAM,CAAC;iBACf;aACF;YAED,UAAiB,qBAAqB;gBACpC,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;gBAErC,aAAa,EAAE,MAAM,CAAC;gBAEtB,UAAU,EAAE,SAAS,CAAC;gBAEtB,iBAAiB,EAAE,UAAU,GAAG,YAAY,CAAC;aAC9C;YAED,UAAiB,qBAAqB,CAAC;gBACrC,UAAiB,MAAM;oBACrB,aAAa,EAAE,MAAM,CAAC;oBAEtB,KAAK,EAAE,MAAM,CAAC;iBACf;aACF;SACF;QAED,UAAiB,6BAA6B;YAC5C,EAAE,EAAE,MAAM,CAAC;YAEX,IAAI,EAAE,MAAM,CAAC;YAEb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B,cAAc,EAAE,MAAM,CAAC;YAEvB,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,EACD,6BAA6B,CAAC,kBAAkB,GAChD,6BAA6B,CAAC,qBAAqB,CAAC;YAExD,iBAAiB,EAAE,MAAM,CAAC;YAE1B,qBAAqB,EAAE,QAAQ,CAAC;SACjC;QAED,UAAiB,6BAA6B,CAAC;YAC7C,UAAiB,kBAAkB;gBACjC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC;gBAElC,UAAU,EAAE,MAAM,CAAC;aACpB;YAED,UAAiB,kBAAkB,CAAC;gBAClC,UAAiB,MAAM;oBACrB,aAAa,EAAE,MAAM,CAAC;oBAEtB,KAAK,EAAE,MAAM,CAAC;iBACf;aACF;YAED,UAAiB,qBAAqB;gBACpC,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;gBAErC,aAAa,EAAE,MAAM,CAAC;gBAEtB,UAAU,EAAE,SAAS,CAAC;gBAEtB,iBAAiB,EAAE,UAAU,GAAG,YAAY,CAAC;aAC9C;YAED,UAAiB,qBAAqB,CAAC;gBACrC,UAAiB,MAAM;oBACrB,aAAa,EAAE,MAAM,CAAC;oBAEtB,KAAK,EAAE,MAAM,CAAC;iBACf;aACF;SACF;QAED,UAAiB,kCAAkC;YACjD,EAAE,EAAE,MAAM,CAAC;YAEX,IAAI,EAAE,MAAM,CAAC;YAEb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B,UAAU,EAAE,KAAK,CAAC,kCAAkC,CAAC,SAAS,CAAC,CAAC;YAEhE,cAAc,EAAE,MAAM,CAAC;YAEvB,IAAI,EAAE,MAAM,CAAC;YAEb,cAAc,EAAE,kCAAkC,CAAC,aAAa,CAAC;YAEjE,iBAAiB,EAAE,MAAM,CAAC;YAE1B,qBAAqB,EAAE,aAAa,CAAC;SACtC;QAED,UAAiB,kCAAkC,CAAC;YAClD,UAAiB,SAAS;gBACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE3B,GAAG,EAAE,MAAM,CAAC;gBAEZ,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;aACvB;YAED,UAAiB,aAAa;gBAC5B,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;aAClC;YAED,UAAiB,aAAa,CAAC;gBAC7B,UAAiB,IAAI;oBACnB,qBAAqB,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;oBAEjD,KAAK,EAAE,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC;iBAC7D;gBAED,UAAiB,IAAI,CAAC;oBACpB,UAAiB,kBAAkB;wBACjC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC;wBAElC,UAAU,EAAE,MAAM,CAAC;qBACpB;oBAED,UAAiB,kBAAkB,CAAC;wBAClC,UAAiB,MAAM;4BACrB,aAAa,EAAE,MAAM,CAAC;4BAEtB,KAAK,EAAE,MAAM,CAAC;yBACf;qBACF;oBAED,UAAiB,qBAAqB;wBACpC,MAAM,EAAE,qBAAqB,CAAC,MAAM,CAAC;wBAErC,aAAa,EAAE,MAAM,CAAC;wBAEtB,UAAU,EAAE,SAAS,CAAC;wBAEtB,iBAAiB,EAAE,UAAU,GAAG,YAAY,CAAC;qBAC9C;oBAED,UAAiB,qBAAqB,CAAC;wBACrC,UAAiB,MAAM;4BACrB,aAAa,EAAE,MAAM,CAAC;4BAEtB,KAAK,EAAE,MAAM,CAAC;yBACf;qBACF;iBACF;aACF;SACF;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,gBAAgB,EAAE,SAAS,GAAG,QAAQ,CAAC;IAEvC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC;IAEzD;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CACrB,yBAAyB,CAAC,iCAAiC,GAC3D,yBAAyB,CAAC,sCAAsC,CACnE,CAAC;CACH;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,SAAS;QACxB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,cAAc,GAAG,YAAY,CAAC,iBAAiB,CAAC;QAEpE;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;IAED,UAAiB,iCAAiC;QAChD;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,YAAY,CAAC,cAAc,GAAG,YAAY,CAAC,iBAAiB,CAAC;QAEpE;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qBAAqB,EAAE,QAAQ,CAAC;QAEhC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,sCAAsC;QACrD;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,sCAAsC,CAAC,SAAS,CAAC,CAAC;QAEpE;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,cAAc,EAAE,sCAAsC,CAAC,aAAa,CAAC;QAErE;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B,qBAAqB,EAAE,aAAa,CAAC;QAErC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,sCAAsC,CAAC;QACtD,UAAiB,SAAS;YACxB;;;eAGG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;QAED;;WAEG;QACH,UAAiB,aAAa;YAC5B,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;SAClC;QAED,UAAiB,aAAa,CAAC;YAC7B,UAAiB,IAAI;gBACnB;;;mBAGG;gBACH,qBAAqB,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;gBAEjD;;mBAEG;gBACH,KAAK,EAAE,YAAY,CAAC,cAAc,GAAG,YAAY,CAAC,iBAAiB,CAAC;aACrE;SACF;KACF;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}