lark-billing 0.3.0 → 0.4.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.
- package/CHANGELOG.md +16 -0
- package/README.md +21 -30
- package/client.d.mts +1 -1
- package/client.d.mts.map +1 -1
- package/client.d.ts +1 -1
- package/client.d.ts.map +1 -1
- package/package.json +1 -1
- package/resources/customer-access.d.mts +8 -0
- package/resources/customer-access.d.mts.map +1 -1
- package/resources/customer-access.d.ts +8 -0
- package/resources/customer-access.d.ts.map +1 -1
- package/resources/customer-access.js +8 -0
- package/resources/customer-access.js.map +1 -1
- package/resources/customer-access.mjs +8 -0
- package/resources/customer-access.mjs.map +1 -1
- package/resources/invoices.d.mts +7 -0
- package/resources/invoices.d.mts.map +1 -1
- package/resources/invoices.d.ts +7 -0
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +7 -0
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +7 -0
- package/resources/invoices.mjs.map +1 -1
- package/resources/pricing-metrics.d.mts +10 -2
- package/resources/pricing-metrics.d.mts.map +1 -1
- package/resources/pricing-metrics.d.ts +10 -2
- package/resources/pricing-metrics.d.ts.map +1 -1
- package/resources/pricing-metrics.js +2 -2
- package/resources/pricing-metrics.mjs +2 -2
- package/resources/rate-cards.d.mts +151 -4
- package/resources/rate-cards.d.mts.map +1 -1
- package/resources/rate-cards.d.ts +151 -4
- package/resources/rate-cards.d.ts.map +1 -1
- package/resources/rate-cards.js +44 -0
- package/resources/rate-cards.js.map +1 -1
- package/resources/rate-cards.mjs +44 -0
- package/resources/rate-cards.mjs.map +1 -1
- package/resources/subjects.d.mts +7 -2
- package/resources/subjects.d.mts.map +1 -1
- package/resources/subjects.d.ts +7 -2
- package/resources/subjects.d.ts.map +1 -1
- package/resources/subjects.js +7 -2
- package/resources/subjects.js.map +1 -1
- package/resources/subjects.mjs +7 -2
- package/resources/subjects.mjs.map +1 -1
- package/resources/subscriptions.d.mts +9 -5
- package/resources/subscriptions.d.mts.map +1 -1
- package/resources/subscriptions.d.ts +9 -5
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js +9 -5
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs +9 -5
- package/resources/subscriptions.mjs.map +1 -1
- package/resources/usage-events.d.mts +4 -3
- package/resources/usage-events.d.mts.map +1 -1
- package/resources/usage-events.d.ts +4 -3
- package/resources/usage-events.d.ts.map +1 -1
- package/resources/usage-events.js +4 -3
- package/resources/usage-events.js.map +1 -1
- package/resources/usage-events.mjs +4 -3
- package/resources/usage-events.mjs.map +1 -1
- package/src/client.ts +1 -1
- package/src/resources/customer-access.ts +8 -0
- package/src/resources/invoices.ts +7 -0
- package/src/resources/pricing-metrics.ts +12 -2
- package/src/resources/rate-cards.ts +179 -4
- package/src/resources/subjects.ts +7 -2
- package/src/resources/subscriptions.ts +9 -5
- package/src/resources/usage-events.ts +4 -3
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -6,14 +6,58 @@ import { RequestOptions } from "../internal/request-options.mjs";
|
|
|
6
6
|
export declare class RateCards extends APIResource {
|
|
7
7
|
/**
|
|
8
8
|
* Create Rate Card
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const rateCardResource = await client.rateCards.create({
|
|
13
|
+
* billing_interval: 'monthly',
|
|
14
|
+
* name: 'Pro Plan',
|
|
15
|
+
* description:
|
|
16
|
+
* 'For production applicatidddons with moderate usage.',
|
|
17
|
+
* fixed_rates: [
|
|
18
|
+
* {
|
|
19
|
+
* name: 'Base Rate',
|
|
20
|
+
* price: {
|
|
21
|
+
* price_type: 'flat',
|
|
22
|
+
* amount: { value: 2500, currency_code: 'usd' },
|
|
23
|
+
* },
|
|
24
|
+
* },
|
|
25
|
+
* ],
|
|
26
|
+
* metadata: {},
|
|
27
|
+
* usage_based_rates: [
|
|
28
|
+
* {
|
|
29
|
+
* usage_based_rate_type: 'simple',
|
|
30
|
+
* name: 'Compute Hours',
|
|
31
|
+
* price: {
|
|
32
|
+
* price_type: 'flat',
|
|
33
|
+
* amount: { value: 100, currency_code: 'usd' },
|
|
34
|
+
* },
|
|
35
|
+
* included_units: 30,
|
|
36
|
+
* pricing_metric_id: 'pmtr_GlX5Tcm2HOn00CoRTFxw2Amw',
|
|
37
|
+
* },
|
|
38
|
+
* ],
|
|
39
|
+
* });
|
|
40
|
+
* ```
|
|
9
41
|
*/
|
|
10
42
|
create(body: RateCardCreateParams, options?: RequestOptions): APIPromise<RateCardResource>;
|
|
11
43
|
/**
|
|
12
44
|
* Get Rate Card
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* const rateCardResource = await client.rateCards.retrieve(
|
|
49
|
+
* 'rate_card_id',
|
|
50
|
+
* );
|
|
51
|
+
* ```
|
|
13
52
|
*/
|
|
14
53
|
retrieve(rateCardID: string, options?: RequestOptions): APIPromise<RateCardResource>;
|
|
15
54
|
/**
|
|
16
55
|
* List Rate Cards
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* const rateCards = await client.rateCards.list();
|
|
60
|
+
* ```
|
|
17
61
|
*/
|
|
18
62
|
list(query?: RateCardListParams | null | undefined, options?: RequestOptions): APIPromise<RateCardListResponse>;
|
|
19
63
|
}
|
|
@@ -68,6 +112,9 @@ export interface RateCardResource {
|
|
|
68
112
|
* The ID of the rate card.
|
|
69
113
|
*/
|
|
70
114
|
id: string;
|
|
115
|
+
/**
|
|
116
|
+
* How often the customer will be billed for this rate card.
|
|
117
|
+
*/
|
|
71
118
|
billing_interval: 'monthly' | 'yearly';
|
|
72
119
|
/**
|
|
73
120
|
* The date and time the rate card was created.
|
|
@@ -77,6 +124,10 @@ export interface RateCardResource {
|
|
|
77
124
|
* The fixed rates of the rate card.
|
|
78
125
|
*/
|
|
79
126
|
fixed_rates: Array<RateCardResource.FixedRate>;
|
|
127
|
+
/**
|
|
128
|
+
* Additional metadata about the rate card. You may use this to store any custom
|
|
129
|
+
* data about the rate card.
|
|
130
|
+
*/
|
|
80
131
|
metadata: {
|
|
81
132
|
[key: string]: string;
|
|
82
133
|
};
|
|
@@ -91,7 +142,7 @@ export interface RateCardResource {
|
|
|
91
142
|
/**
|
|
92
143
|
* The usage based rates of the rate card.
|
|
93
144
|
*/
|
|
94
|
-
usage_based_rates: Array<RateCardResource.
|
|
145
|
+
usage_based_rates: Array<RateCardResource.SimpleUsageBasedRateInterface | RateCardResource.DimensionalUsageBasedRateInterface>;
|
|
95
146
|
/**
|
|
96
147
|
* The description of the rate card.
|
|
97
148
|
*/
|
|
@@ -107,7 +158,7 @@ export declare namespace RateCardResource {
|
|
|
107
158
|
*/
|
|
108
159
|
price: RateCardsAPI.FlatPriceOutput | RateCardsAPI.PackagePriceOutput;
|
|
109
160
|
}
|
|
110
|
-
interface
|
|
161
|
+
interface SimpleUsageBasedRateInterface {
|
|
111
162
|
id: string;
|
|
112
163
|
description: string | null;
|
|
113
164
|
included_units: number;
|
|
@@ -119,6 +170,37 @@ export declare namespace RateCardResource {
|
|
|
119
170
|
pricing_metric_id: string;
|
|
120
171
|
usage_based_rate_type?: 'simple';
|
|
121
172
|
}
|
|
173
|
+
interface DimensionalUsageBasedRateInterface {
|
|
174
|
+
id: string;
|
|
175
|
+
description: string | null;
|
|
176
|
+
dimensions: Array<DimensionalUsageBasedRateInterface.Dimension>;
|
|
177
|
+
included_units: number;
|
|
178
|
+
name: string;
|
|
179
|
+
pricing_matrix: DimensionalUsageBasedRateInterface.PricingMatrix;
|
|
180
|
+
pricing_metric_id: string;
|
|
181
|
+
usage_based_rate_type?: 'dimensional';
|
|
182
|
+
}
|
|
183
|
+
namespace DimensionalUsageBasedRateInterface {
|
|
184
|
+
interface Dimension {
|
|
185
|
+
description: string | null;
|
|
186
|
+
key: string;
|
|
187
|
+
values: Array<string>;
|
|
188
|
+
}
|
|
189
|
+
interface PricingMatrix {
|
|
190
|
+
cells: Array<PricingMatrix.Cell>;
|
|
191
|
+
}
|
|
192
|
+
namespace PricingMatrix {
|
|
193
|
+
interface Cell {
|
|
194
|
+
dimension_coordinates: {
|
|
195
|
+
[key: string]: string;
|
|
196
|
+
};
|
|
197
|
+
/**
|
|
198
|
+
* Flat price is a price that linearly scales with the quantity.
|
|
199
|
+
*/
|
|
200
|
+
price: RateCardsAPI.FlatPriceOutput | RateCardsAPI.PackagePriceOutput;
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
}
|
|
122
204
|
}
|
|
123
205
|
export interface RateCardListResponse {
|
|
124
206
|
has_more: boolean;
|
|
@@ -149,7 +231,7 @@ export interface RateCardCreateParams {
|
|
|
149
231
|
* The usage based rates of the rate card. These are billed at the end of each
|
|
150
232
|
* billing cycle.
|
|
151
233
|
*/
|
|
152
|
-
usage_based_rates?: Array<RateCardCreateParams.
|
|
234
|
+
usage_based_rates?: Array<RateCardCreateParams.CreateSimpleUsageBasedRateRequest | RateCardCreateParams.CreateDimensionalUsageBasedRateRequest>;
|
|
153
235
|
}
|
|
154
236
|
export declare namespace RateCardCreateParams {
|
|
155
237
|
interface FixedRate {
|
|
@@ -166,7 +248,7 @@ export declare namespace RateCardCreateParams {
|
|
|
166
248
|
*/
|
|
167
249
|
description?: string | null;
|
|
168
250
|
}
|
|
169
|
-
interface
|
|
251
|
+
interface CreateSimpleUsageBasedRateRequest {
|
|
170
252
|
/**
|
|
171
253
|
* The name of the rate displayed to the customer.
|
|
172
254
|
*/
|
|
@@ -189,6 +271,71 @@ export declare namespace RateCardCreateParams {
|
|
|
189
271
|
*/
|
|
190
272
|
included_units?: number;
|
|
191
273
|
}
|
|
274
|
+
interface CreateDimensionalUsageBasedRateRequest {
|
|
275
|
+
/**
|
|
276
|
+
* The dimensions of the rate.
|
|
277
|
+
*/
|
|
278
|
+
dimensions: Array<CreateDimensionalUsageBasedRateRequest.Dimension>;
|
|
279
|
+
/**
|
|
280
|
+
* The name of the rate displayed to the customer.
|
|
281
|
+
*/
|
|
282
|
+
name: string;
|
|
283
|
+
/**
|
|
284
|
+
* The pricing matrix of the rate.
|
|
285
|
+
*/
|
|
286
|
+
pricing_matrix: CreateDimensionalUsageBasedRateRequest.PricingMatrix;
|
|
287
|
+
/**
|
|
288
|
+
* The ID of the pricing metric to use for this rate.
|
|
289
|
+
*/
|
|
290
|
+
pricing_metric_id: string;
|
|
291
|
+
usage_based_rate_type: 'dimensional';
|
|
292
|
+
/**
|
|
293
|
+
* The description of the rate displayed to the customer.
|
|
294
|
+
*/
|
|
295
|
+
description?: string | null;
|
|
296
|
+
/**
|
|
297
|
+
* The number of units included in the rate before the price is applied.
|
|
298
|
+
*/
|
|
299
|
+
included_units?: number;
|
|
300
|
+
}
|
|
301
|
+
namespace CreateDimensionalUsageBasedRateRequest {
|
|
302
|
+
interface Dimension {
|
|
303
|
+
/**
|
|
304
|
+
* The name of the dimension. This is used to identify the dimension in the pricing
|
|
305
|
+
* matrix.
|
|
306
|
+
*/
|
|
307
|
+
key: string;
|
|
308
|
+
/**
|
|
309
|
+
* A list of possible values for the dimension.
|
|
310
|
+
*/
|
|
311
|
+
values: Array<string>;
|
|
312
|
+
/**
|
|
313
|
+
* The description of the dimension.
|
|
314
|
+
*/
|
|
315
|
+
description?: string | null;
|
|
316
|
+
}
|
|
317
|
+
/**
|
|
318
|
+
* The pricing matrix of the rate.
|
|
319
|
+
*/
|
|
320
|
+
interface PricingMatrix {
|
|
321
|
+
cells: Array<PricingMatrix.Cell>;
|
|
322
|
+
}
|
|
323
|
+
namespace PricingMatrix {
|
|
324
|
+
interface Cell {
|
|
325
|
+
/**
|
|
326
|
+
* A key-value mapping of dimension keys and values to identify the price for a
|
|
327
|
+
* given set of dimension values.
|
|
328
|
+
*/
|
|
329
|
+
dimension_coordinates: {
|
|
330
|
+
[key: string]: string;
|
|
331
|
+
};
|
|
332
|
+
/**
|
|
333
|
+
* The price for the cell.
|
|
334
|
+
*/
|
|
335
|
+
price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
|
|
336
|
+
}
|
|
337
|
+
}
|
|
338
|
+
}
|
|
192
339
|
}
|
|
193
340
|
export interface RateCardListParams {
|
|
194
341
|
limit?: number;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rate-cards.d.mts","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
|
|
1
|
+
{"version":3,"file":"rate-cards.d.mts","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"}
|
|
@@ -6,14 +6,58 @@ import { RequestOptions } from "../internal/request-options.js";
|
|
|
6
6
|
export declare class RateCards extends APIResource {
|
|
7
7
|
/**
|
|
8
8
|
* Create Rate Card
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const rateCardResource = await client.rateCards.create({
|
|
13
|
+
* billing_interval: 'monthly',
|
|
14
|
+
* name: 'Pro Plan',
|
|
15
|
+
* description:
|
|
16
|
+
* 'For production applicatidddons with moderate usage.',
|
|
17
|
+
* fixed_rates: [
|
|
18
|
+
* {
|
|
19
|
+
* name: 'Base Rate',
|
|
20
|
+
* price: {
|
|
21
|
+
* price_type: 'flat',
|
|
22
|
+
* amount: { value: 2500, currency_code: 'usd' },
|
|
23
|
+
* },
|
|
24
|
+
* },
|
|
25
|
+
* ],
|
|
26
|
+
* metadata: {},
|
|
27
|
+
* usage_based_rates: [
|
|
28
|
+
* {
|
|
29
|
+
* usage_based_rate_type: 'simple',
|
|
30
|
+
* name: 'Compute Hours',
|
|
31
|
+
* price: {
|
|
32
|
+
* price_type: 'flat',
|
|
33
|
+
* amount: { value: 100, currency_code: 'usd' },
|
|
34
|
+
* },
|
|
35
|
+
* included_units: 30,
|
|
36
|
+
* pricing_metric_id: 'pmtr_GlX5Tcm2HOn00CoRTFxw2Amw',
|
|
37
|
+
* },
|
|
38
|
+
* ],
|
|
39
|
+
* });
|
|
40
|
+
* ```
|
|
9
41
|
*/
|
|
10
42
|
create(body: RateCardCreateParams, options?: RequestOptions): APIPromise<RateCardResource>;
|
|
11
43
|
/**
|
|
12
44
|
* Get Rate Card
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* const rateCardResource = await client.rateCards.retrieve(
|
|
49
|
+
* 'rate_card_id',
|
|
50
|
+
* );
|
|
51
|
+
* ```
|
|
13
52
|
*/
|
|
14
53
|
retrieve(rateCardID: string, options?: RequestOptions): APIPromise<RateCardResource>;
|
|
15
54
|
/**
|
|
16
55
|
* List Rate Cards
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* const rateCards = await client.rateCards.list();
|
|
60
|
+
* ```
|
|
17
61
|
*/
|
|
18
62
|
list(query?: RateCardListParams | null | undefined, options?: RequestOptions): APIPromise<RateCardListResponse>;
|
|
19
63
|
}
|
|
@@ -68,6 +112,9 @@ export interface RateCardResource {
|
|
|
68
112
|
* The ID of the rate card.
|
|
69
113
|
*/
|
|
70
114
|
id: string;
|
|
115
|
+
/**
|
|
116
|
+
* How often the customer will be billed for this rate card.
|
|
117
|
+
*/
|
|
71
118
|
billing_interval: 'monthly' | 'yearly';
|
|
72
119
|
/**
|
|
73
120
|
* The date and time the rate card was created.
|
|
@@ -77,6 +124,10 @@ export interface RateCardResource {
|
|
|
77
124
|
* The fixed rates of the rate card.
|
|
78
125
|
*/
|
|
79
126
|
fixed_rates: Array<RateCardResource.FixedRate>;
|
|
127
|
+
/**
|
|
128
|
+
* Additional metadata about the rate card. You may use this to store any custom
|
|
129
|
+
* data about the rate card.
|
|
130
|
+
*/
|
|
80
131
|
metadata: {
|
|
81
132
|
[key: string]: string;
|
|
82
133
|
};
|
|
@@ -91,7 +142,7 @@ export interface RateCardResource {
|
|
|
91
142
|
/**
|
|
92
143
|
* The usage based rates of the rate card.
|
|
93
144
|
*/
|
|
94
|
-
usage_based_rates: Array<RateCardResource.
|
|
145
|
+
usage_based_rates: Array<RateCardResource.SimpleUsageBasedRateInterface | RateCardResource.DimensionalUsageBasedRateInterface>;
|
|
95
146
|
/**
|
|
96
147
|
* The description of the rate card.
|
|
97
148
|
*/
|
|
@@ -107,7 +158,7 @@ export declare namespace RateCardResource {
|
|
|
107
158
|
*/
|
|
108
159
|
price: RateCardsAPI.FlatPriceOutput | RateCardsAPI.PackagePriceOutput;
|
|
109
160
|
}
|
|
110
|
-
interface
|
|
161
|
+
interface SimpleUsageBasedRateInterface {
|
|
111
162
|
id: string;
|
|
112
163
|
description: string | null;
|
|
113
164
|
included_units: number;
|
|
@@ -119,6 +170,37 @@ export declare namespace RateCardResource {
|
|
|
119
170
|
pricing_metric_id: string;
|
|
120
171
|
usage_based_rate_type?: 'simple';
|
|
121
172
|
}
|
|
173
|
+
interface DimensionalUsageBasedRateInterface {
|
|
174
|
+
id: string;
|
|
175
|
+
description: string | null;
|
|
176
|
+
dimensions: Array<DimensionalUsageBasedRateInterface.Dimension>;
|
|
177
|
+
included_units: number;
|
|
178
|
+
name: string;
|
|
179
|
+
pricing_matrix: DimensionalUsageBasedRateInterface.PricingMatrix;
|
|
180
|
+
pricing_metric_id: string;
|
|
181
|
+
usage_based_rate_type?: 'dimensional';
|
|
182
|
+
}
|
|
183
|
+
namespace DimensionalUsageBasedRateInterface {
|
|
184
|
+
interface Dimension {
|
|
185
|
+
description: string | null;
|
|
186
|
+
key: string;
|
|
187
|
+
values: Array<string>;
|
|
188
|
+
}
|
|
189
|
+
interface PricingMatrix {
|
|
190
|
+
cells: Array<PricingMatrix.Cell>;
|
|
191
|
+
}
|
|
192
|
+
namespace PricingMatrix {
|
|
193
|
+
interface Cell {
|
|
194
|
+
dimension_coordinates: {
|
|
195
|
+
[key: string]: string;
|
|
196
|
+
};
|
|
197
|
+
/**
|
|
198
|
+
* Flat price is a price that linearly scales with the quantity.
|
|
199
|
+
*/
|
|
200
|
+
price: RateCardsAPI.FlatPriceOutput | RateCardsAPI.PackagePriceOutput;
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
}
|
|
122
204
|
}
|
|
123
205
|
export interface RateCardListResponse {
|
|
124
206
|
has_more: boolean;
|
|
@@ -149,7 +231,7 @@ export interface RateCardCreateParams {
|
|
|
149
231
|
* The usage based rates of the rate card. These are billed at the end of each
|
|
150
232
|
* billing cycle.
|
|
151
233
|
*/
|
|
152
|
-
usage_based_rates?: Array<RateCardCreateParams.
|
|
234
|
+
usage_based_rates?: Array<RateCardCreateParams.CreateSimpleUsageBasedRateRequest | RateCardCreateParams.CreateDimensionalUsageBasedRateRequest>;
|
|
153
235
|
}
|
|
154
236
|
export declare namespace RateCardCreateParams {
|
|
155
237
|
interface FixedRate {
|
|
@@ -166,7 +248,7 @@ export declare namespace RateCardCreateParams {
|
|
|
166
248
|
*/
|
|
167
249
|
description?: string | null;
|
|
168
250
|
}
|
|
169
|
-
interface
|
|
251
|
+
interface CreateSimpleUsageBasedRateRequest {
|
|
170
252
|
/**
|
|
171
253
|
* The name of the rate displayed to the customer.
|
|
172
254
|
*/
|
|
@@ -189,6 +271,71 @@ export declare namespace RateCardCreateParams {
|
|
|
189
271
|
*/
|
|
190
272
|
included_units?: number;
|
|
191
273
|
}
|
|
274
|
+
interface CreateDimensionalUsageBasedRateRequest {
|
|
275
|
+
/**
|
|
276
|
+
* The dimensions of the rate.
|
|
277
|
+
*/
|
|
278
|
+
dimensions: Array<CreateDimensionalUsageBasedRateRequest.Dimension>;
|
|
279
|
+
/**
|
|
280
|
+
* The name of the rate displayed to the customer.
|
|
281
|
+
*/
|
|
282
|
+
name: string;
|
|
283
|
+
/**
|
|
284
|
+
* The pricing matrix of the rate.
|
|
285
|
+
*/
|
|
286
|
+
pricing_matrix: CreateDimensionalUsageBasedRateRequest.PricingMatrix;
|
|
287
|
+
/**
|
|
288
|
+
* The ID of the pricing metric to use for this rate.
|
|
289
|
+
*/
|
|
290
|
+
pricing_metric_id: string;
|
|
291
|
+
usage_based_rate_type: 'dimensional';
|
|
292
|
+
/**
|
|
293
|
+
* The description of the rate displayed to the customer.
|
|
294
|
+
*/
|
|
295
|
+
description?: string | null;
|
|
296
|
+
/**
|
|
297
|
+
* The number of units included in the rate before the price is applied.
|
|
298
|
+
*/
|
|
299
|
+
included_units?: number;
|
|
300
|
+
}
|
|
301
|
+
namespace CreateDimensionalUsageBasedRateRequest {
|
|
302
|
+
interface Dimension {
|
|
303
|
+
/**
|
|
304
|
+
* The name of the dimension. This is used to identify the dimension in the pricing
|
|
305
|
+
* matrix.
|
|
306
|
+
*/
|
|
307
|
+
key: string;
|
|
308
|
+
/**
|
|
309
|
+
* A list of possible values for the dimension.
|
|
310
|
+
*/
|
|
311
|
+
values: Array<string>;
|
|
312
|
+
/**
|
|
313
|
+
* The description of the dimension.
|
|
314
|
+
*/
|
|
315
|
+
description?: string | null;
|
|
316
|
+
}
|
|
317
|
+
/**
|
|
318
|
+
* The pricing matrix of the rate.
|
|
319
|
+
*/
|
|
320
|
+
interface PricingMatrix {
|
|
321
|
+
cells: Array<PricingMatrix.Cell>;
|
|
322
|
+
}
|
|
323
|
+
namespace PricingMatrix {
|
|
324
|
+
interface Cell {
|
|
325
|
+
/**
|
|
326
|
+
* A key-value mapping of dimension keys and values to identify the price for a
|
|
327
|
+
* given set of dimension values.
|
|
328
|
+
*/
|
|
329
|
+
dimension_coordinates: {
|
|
330
|
+
[key: string]: string;
|
|
331
|
+
};
|
|
332
|
+
/**
|
|
333
|
+
* The price for the cell.
|
|
334
|
+
*/
|
|
335
|
+
price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
|
|
336
|
+
}
|
|
337
|
+
}
|
|
338
|
+
}
|
|
192
339
|
}
|
|
193
340
|
export interface RateCardListParams {
|
|
194
341
|
limit?: number;
|
|
@@ -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
|
|
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"}
|
package/resources/rate-cards.js
CHANGED
|
@@ -7,18 +7,62 @@ const path_1 = require("../internal/utils/path.js");
|
|
|
7
7
|
class RateCards extends resource_1.APIResource {
|
|
8
8
|
/**
|
|
9
9
|
* Create Rate Card
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const rateCardResource = await client.rateCards.create({
|
|
14
|
+
* billing_interval: 'monthly',
|
|
15
|
+
* name: 'Pro Plan',
|
|
16
|
+
* description:
|
|
17
|
+
* 'For production applicatidddons with moderate usage.',
|
|
18
|
+
* fixed_rates: [
|
|
19
|
+
* {
|
|
20
|
+
* name: 'Base Rate',
|
|
21
|
+
* price: {
|
|
22
|
+
* price_type: 'flat',
|
|
23
|
+
* amount: { value: 2500, currency_code: 'usd' },
|
|
24
|
+
* },
|
|
25
|
+
* },
|
|
26
|
+
* ],
|
|
27
|
+
* metadata: {},
|
|
28
|
+
* usage_based_rates: [
|
|
29
|
+
* {
|
|
30
|
+
* usage_based_rate_type: 'simple',
|
|
31
|
+
* name: 'Compute Hours',
|
|
32
|
+
* price: {
|
|
33
|
+
* price_type: 'flat',
|
|
34
|
+
* amount: { value: 100, currency_code: 'usd' },
|
|
35
|
+
* },
|
|
36
|
+
* included_units: 30,
|
|
37
|
+
* pricing_metric_id: 'pmtr_GlX5Tcm2HOn00CoRTFxw2Amw',
|
|
38
|
+
* },
|
|
39
|
+
* ],
|
|
40
|
+
* });
|
|
41
|
+
* ```
|
|
10
42
|
*/
|
|
11
43
|
create(body, options) {
|
|
12
44
|
return this._client.post('/rate-cards', { body, ...options });
|
|
13
45
|
}
|
|
14
46
|
/**
|
|
15
47
|
* Get Rate Card
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* const rateCardResource = await client.rateCards.retrieve(
|
|
52
|
+
* 'rate_card_id',
|
|
53
|
+
* );
|
|
54
|
+
* ```
|
|
16
55
|
*/
|
|
17
56
|
retrieve(rateCardID, options) {
|
|
18
57
|
return this._client.get((0, path_1.path) `/rate-cards/${rateCardID}`, options);
|
|
19
58
|
}
|
|
20
59
|
/**
|
|
21
60
|
* List Rate Cards
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```ts
|
|
64
|
+
* const rateCards = await client.rateCards.list();
|
|
65
|
+
* ```
|
|
22
66
|
*/
|
|
23
67
|
list(query = {}, options) {
|
|
24
68
|
return this._client.get('/rate-cards', { query, ...options });
|
|
@@ -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
|
|
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"}
|
package/resources/rate-cards.mjs
CHANGED
|
@@ -4,18 +4,62 @@ import { path } from "../internal/utils/path.mjs";
|
|
|
4
4
|
export class RateCards extends APIResource {
|
|
5
5
|
/**
|
|
6
6
|
* Create Rate Card
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* const rateCardResource = await client.rateCards.create({
|
|
11
|
+
* billing_interval: 'monthly',
|
|
12
|
+
* name: 'Pro Plan',
|
|
13
|
+
* description:
|
|
14
|
+
* 'For production applicatidddons with moderate usage.',
|
|
15
|
+
* fixed_rates: [
|
|
16
|
+
* {
|
|
17
|
+
* name: 'Base Rate',
|
|
18
|
+
* price: {
|
|
19
|
+
* price_type: 'flat',
|
|
20
|
+
* amount: { value: 2500, currency_code: 'usd' },
|
|
21
|
+
* },
|
|
22
|
+
* },
|
|
23
|
+
* ],
|
|
24
|
+
* metadata: {},
|
|
25
|
+
* usage_based_rates: [
|
|
26
|
+
* {
|
|
27
|
+
* usage_based_rate_type: 'simple',
|
|
28
|
+
* name: 'Compute Hours',
|
|
29
|
+
* price: {
|
|
30
|
+
* price_type: 'flat',
|
|
31
|
+
* amount: { value: 100, currency_code: 'usd' },
|
|
32
|
+
* },
|
|
33
|
+
* included_units: 30,
|
|
34
|
+
* pricing_metric_id: 'pmtr_GlX5Tcm2HOn00CoRTFxw2Amw',
|
|
35
|
+
* },
|
|
36
|
+
* ],
|
|
37
|
+
* });
|
|
38
|
+
* ```
|
|
7
39
|
*/
|
|
8
40
|
create(body, options) {
|
|
9
41
|
return this._client.post('/rate-cards', { body, ...options });
|
|
10
42
|
}
|
|
11
43
|
/**
|
|
12
44
|
* Get Rate Card
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* const rateCardResource = await client.rateCards.retrieve(
|
|
49
|
+
* 'rate_card_id',
|
|
50
|
+
* );
|
|
51
|
+
* ```
|
|
13
52
|
*/
|
|
14
53
|
retrieve(rateCardID, options) {
|
|
15
54
|
return this._client.get(path `/rate-cards/${rateCardID}`, options);
|
|
16
55
|
}
|
|
17
56
|
/**
|
|
18
57
|
* List Rate Cards
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* const rateCards = await client.rateCards.list();
|
|
62
|
+
* ```
|
|
19
63
|
*/
|
|
20
64
|
list(query = {}, options) {
|
|
21
65
|
return this._client.get('/rate-cards', { query, ...options });
|
|
@@ -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
|
|
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"}
|
package/resources/subjects.d.mts
CHANGED
|
@@ -7,7 +7,12 @@ export declare class Subjects extends APIResource {
|
|
|
7
7
|
*
|
|
8
8
|
* @example
|
|
9
9
|
* ```ts
|
|
10
|
-
* const subject = await client.subjects.create(
|
|
10
|
+
* const subject = await client.subjects.create({
|
|
11
|
+
* email: 'john.doe@example.com',
|
|
12
|
+
* external_id: 'user_1234567890',
|
|
13
|
+
* metadata: {},
|
|
14
|
+
* name: 'John Doe',
|
|
15
|
+
* });
|
|
11
16
|
* ```
|
|
12
17
|
*/
|
|
13
18
|
create(body: SubjectCreateParams, options?: RequestOptions): APIPromise<SubjectCreateResponse>;
|
|
@@ -31,7 +36,7 @@ export declare class Subjects extends APIResource {
|
|
|
31
36
|
* 'subject_id',
|
|
32
37
|
* {
|
|
33
38
|
* email: 'john.doe@example.com',
|
|
34
|
-
* metadata: {
|
|
39
|
+
* metadata: {},
|
|
35
40
|
* name: 'John Doe',
|
|
36
41
|
* },
|
|
37
42
|
* );
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subjects.d.mts","sourceRoot":"","sources":["../src/resources/subjects.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"subjects.d.mts","sourceRoot":"","sources":["../src/resources/subjects.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIlF;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAI9B;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGzE;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,OAAO,CAAC;IAElB,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAClC;AAED,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|