@leaflow/sdk 0.0.0-dev.212.gea1bf06 → 0.0.0-dev.216.gab0f521
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/README.md +12 -3
- package/dist/billing/{v1 → account/v1}/client.d.ts +1 -1
- package/dist/{billingaccount → billing/account}/v1/client.js +1 -1
- package/dist/{billingaccount → billing/account}/v1/index.d.ts +0 -26
- package/dist/{billingaccount → billing/account}/v1/schema.d.ts +9 -776
- package/dist/{billingaccount → billing/catalog}/v1/client.d.ts +1 -1
- package/dist/billing/{v1 → catalog/v1}/client.js +1 -1
- package/dist/billing/catalog/v1/index.d.ts +29 -0
- package/dist/billing/catalog/v1/schema.d.ts +910 -0
- package/dist/billing/index.d.ts +3 -0
- package/dist/billing/index.js +6 -0
- package/dist/billing/project/v1/client.d.ts +4 -0
- package/dist/billing/project/v1/client.js +7 -0
- package/dist/billing/project/v1/index.js +5 -0
- package/dist/billing/project/v1/schema.js +5 -0
- package/dist/index.d.ts +1 -2
- package/dist/index.js +1 -2
- package/package.json +11 -7
- /package/dist/billing/{v1 → account/v1}/index.js +0 -0
- /package/dist/billing/{v1 → account/v1}/schema.js +0 -0
- /package/dist/{billingaccount → billing/catalog}/v1/index.js +0 -0
- /package/dist/{billingaccount → billing/catalog}/v1/schema.js +0 -0
- /package/dist/billing/{v1 → project/v1}/index.d.ts +0 -0
- /package/dist/billing/{v1 → project/v1}/schema.d.ts +0 -0
|
@@ -3,209 +3,6 @@
|
|
|
3
3
|
* Do not make direct changes to the file.
|
|
4
4
|
*/
|
|
5
5
|
export interface paths {
|
|
6
|
-
"/api/v1/prices": {
|
|
7
|
-
parameters: {
|
|
8
|
-
query?: never;
|
|
9
|
-
header?: never;
|
|
10
|
-
path?: never;
|
|
11
|
-
cookie?: never;
|
|
12
|
-
};
|
|
13
|
-
/**
|
|
14
|
-
* List what is on sale, with prices
|
|
15
|
-
* @description Every sellable thing and what it costs, in one request. A plan appears once per price.
|
|
16
|
-
*
|
|
17
|
-
* `currency` is required: a plan has a price in each currency it is sold in, so "what does
|
|
18
|
-
* this cost" has no answer without one.
|
|
19
|
-
*
|
|
20
|
-
* Retired prices are left out. Existing subscriptions still reference them, so this is not
|
|
21
|
-
* the place to look up what an existing purchase is paying.
|
|
22
|
-
*/
|
|
23
|
-
get: operations["list-prices"];
|
|
24
|
-
put?: never;
|
|
25
|
-
post?: never;
|
|
26
|
-
delete?: never;
|
|
27
|
-
options?: never;
|
|
28
|
-
head?: never;
|
|
29
|
-
patch?: never;
|
|
30
|
-
trace?: never;
|
|
31
|
-
};
|
|
32
|
-
"/api/v1/products": {
|
|
33
|
-
parameters: {
|
|
34
|
-
query?: never;
|
|
35
|
-
header?: never;
|
|
36
|
-
path?: never;
|
|
37
|
-
cookie?: never;
|
|
38
|
-
};
|
|
39
|
-
/** List catalog products */
|
|
40
|
-
get: operations["list-products"];
|
|
41
|
-
put?: never;
|
|
42
|
-
post?: never;
|
|
43
|
-
delete?: never;
|
|
44
|
-
options?: never;
|
|
45
|
-
head?: never;
|
|
46
|
-
patch?: never;
|
|
47
|
-
trace?: never;
|
|
48
|
-
};
|
|
49
|
-
"/api/v1/products/{productId}": {
|
|
50
|
-
parameters: {
|
|
51
|
-
query?: never;
|
|
52
|
-
header?: never;
|
|
53
|
-
path: {
|
|
54
|
-
productId: components["schemas"]["ProductID"];
|
|
55
|
-
};
|
|
56
|
-
cookie?: never;
|
|
57
|
-
};
|
|
58
|
-
/**
|
|
59
|
-
* Get a service
|
|
60
|
-
* @description Resolves an identifier that was stored elsewhere — on an order line, an invoice line, or
|
|
61
|
-
* the terms of a credit — into something that can be displayed.
|
|
62
|
-
*/
|
|
63
|
-
get: operations["get-product"];
|
|
64
|
-
put?: never;
|
|
65
|
-
post?: never;
|
|
66
|
-
delete?: never;
|
|
67
|
-
options?: never;
|
|
68
|
-
head?: never;
|
|
69
|
-
patch?: never;
|
|
70
|
-
trace?: never;
|
|
71
|
-
};
|
|
72
|
-
"/api/v1/plans/{planId}": {
|
|
73
|
-
parameters: {
|
|
74
|
-
query?: never;
|
|
75
|
-
header?: never;
|
|
76
|
-
path: {
|
|
77
|
-
planId: string;
|
|
78
|
-
};
|
|
79
|
-
cookie?: never;
|
|
80
|
-
};
|
|
81
|
-
/**
|
|
82
|
-
* Get a sellable item
|
|
83
|
-
* @description Resolves a stored identifier into something that can be displayed. Returns items that are
|
|
84
|
-
* no longer on sale: an existing purchase still refers to one.
|
|
85
|
-
*/
|
|
86
|
-
get: operations["get-plan"];
|
|
87
|
-
put?: never;
|
|
88
|
-
post?: never;
|
|
89
|
-
delete?: never;
|
|
90
|
-
options?: never;
|
|
91
|
-
head?: never;
|
|
92
|
-
patch?: never;
|
|
93
|
-
trace?: never;
|
|
94
|
-
};
|
|
95
|
-
"/api/v1/prices/{priceId}": {
|
|
96
|
-
parameters: {
|
|
97
|
-
query?: never;
|
|
98
|
-
header?: never;
|
|
99
|
-
path: {
|
|
100
|
-
priceId: string;
|
|
101
|
-
};
|
|
102
|
-
cookie?: never;
|
|
103
|
-
};
|
|
104
|
-
/**
|
|
105
|
-
* Get a price
|
|
106
|
-
* @description Returns the catalog price, including retired prices. Fixed purchase history and renewal agreements are shown on orders and subscriptions rather than reconstructed from today's catalog.
|
|
107
|
-
*/
|
|
108
|
-
get: operations["get-price"];
|
|
109
|
-
put?: never;
|
|
110
|
-
post?: never;
|
|
111
|
-
delete?: never;
|
|
112
|
-
options?: never;
|
|
113
|
-
head?: never;
|
|
114
|
-
patch?: never;
|
|
115
|
-
trace?: never;
|
|
116
|
-
};
|
|
117
|
-
"/api/v1/plans": {
|
|
118
|
-
parameters: {
|
|
119
|
-
query: {
|
|
120
|
-
product_id: components["schemas"]["ProductID"];
|
|
121
|
-
};
|
|
122
|
-
header?: never;
|
|
123
|
-
path?: never;
|
|
124
|
-
cookie?: never;
|
|
125
|
-
};
|
|
126
|
-
/** List catalog plans */
|
|
127
|
-
get: operations["list-plans"];
|
|
128
|
-
put?: never;
|
|
129
|
-
post?: never;
|
|
130
|
-
delete?: never;
|
|
131
|
-
options?: never;
|
|
132
|
-
head?: never;
|
|
133
|
-
patch?: never;
|
|
134
|
-
trace?: never;
|
|
135
|
-
};
|
|
136
|
-
"/api/v1/plans/{planId}/prices": {
|
|
137
|
-
parameters: {
|
|
138
|
-
query?: never;
|
|
139
|
-
header?: never;
|
|
140
|
-
path: {
|
|
141
|
-
planId: components["parameters"]["PlanId"];
|
|
142
|
-
};
|
|
143
|
-
cookie?: never;
|
|
144
|
-
};
|
|
145
|
-
/**
|
|
146
|
-
* List catalog prices
|
|
147
|
-
* @description Public list prices only. An account holding a negotiated agreement may be charged less;
|
|
148
|
-
* it is never charged more.
|
|
149
|
-
*/
|
|
150
|
-
get: operations["list-prices-by-plan"];
|
|
151
|
-
put?: never;
|
|
152
|
-
post?: never;
|
|
153
|
-
delete?: never;
|
|
154
|
-
options?: never;
|
|
155
|
-
head?: never;
|
|
156
|
-
patch?: never;
|
|
157
|
-
trace?: never;
|
|
158
|
-
};
|
|
159
|
-
"/api/v1/rate-cards/{rateCardId}/rules": {
|
|
160
|
-
parameters: {
|
|
161
|
-
query?: never;
|
|
162
|
-
header?: never;
|
|
163
|
-
path: {
|
|
164
|
-
rateCardId: components["parameters"]["RateCardId"];
|
|
165
|
-
};
|
|
166
|
-
cookie?: never;
|
|
167
|
-
};
|
|
168
|
-
/**
|
|
169
|
-
* List catalog rates
|
|
170
|
-
* @description Only public price lists are readable here. A list written for a single agreement is not,
|
|
171
|
-
* and its identifier cannot be used to reach it.
|
|
172
|
-
*/
|
|
173
|
-
get: operations["list-rates"];
|
|
174
|
-
put?: never;
|
|
175
|
-
post?: never;
|
|
176
|
-
delete?: never;
|
|
177
|
-
options?: never;
|
|
178
|
-
head?: never;
|
|
179
|
-
patch?: never;
|
|
180
|
-
trace?: never;
|
|
181
|
-
};
|
|
182
|
-
"/api/v1/estimates": {
|
|
183
|
-
parameters: {
|
|
184
|
-
query?: never;
|
|
185
|
-
header?: never;
|
|
186
|
-
path?: never;
|
|
187
|
-
cookie?: never;
|
|
188
|
-
};
|
|
189
|
-
get?: never;
|
|
190
|
-
put?: never;
|
|
191
|
-
/**
|
|
192
|
-
* Estimate a basket
|
|
193
|
-
* @description Uses public list prices. Nothing is reserved and nothing is recorded, so this may be
|
|
194
|
-
* called as often as required.
|
|
195
|
-
*
|
|
196
|
-
* `POST` is used because the set of items to price does not fit in a query string. There is
|
|
197
|
-
* no corresponding `GET`, and no estimate is stored to retrieve.
|
|
198
|
-
*
|
|
199
|
-
* An account holding a negotiated agreement may be charged less than this. Tax and
|
|
200
|
-
* discounts are not included.
|
|
201
|
-
*/
|
|
202
|
-
post: operations["create-estimate"];
|
|
203
|
-
delete?: never;
|
|
204
|
-
options?: never;
|
|
205
|
-
head?: never;
|
|
206
|
-
patch?: never;
|
|
207
|
-
trace?: never;
|
|
208
|
-
};
|
|
209
6
|
"/account/v1/currencies": {
|
|
210
7
|
parameters: {
|
|
211
8
|
query?: never;
|
|
@@ -594,7 +391,15 @@ export interface paths {
|
|
|
594
391
|
put?: never;
|
|
595
392
|
/**
|
|
596
393
|
* Pay together
|
|
597
|
-
* @description Pays outstanding invoices, including invoices
|
|
394
|
+
* @description Pays outstanding invoices, including the invoices of the listed orders, from the account's
|
|
395
|
+
* eligible credit grants and then its balance. No payment gateway is used; an invoice to be
|
|
396
|
+
* paid online is paid on its own.
|
|
397
|
+
*
|
|
398
|
+
* Either every invoice is paid or none is. When the credit grants and balance cannot cover
|
|
399
|
+
* them all, the request fails with `BILLING_INSUFFICIENT_FUNDS` and nothing is charged.
|
|
400
|
+
* Invoices that are already paid are not charged again. An invoice with an online payment
|
|
401
|
+
* still in progress is refused with `BILLING_PAYMENT_PENDING`, and an order whose payment
|
|
402
|
+
* deadline has passed with `BILLING_ORDER_EXPIRED`.
|
|
598
403
|
*/
|
|
599
404
|
post: operations["pay-together"];
|
|
600
405
|
delete?: never;
|
|
@@ -1152,124 +957,6 @@ export interface components {
|
|
|
1152
957
|
};
|
|
1153
958
|
/** @description Immutable platform service identifier, such as compute, canopy or assistant. */
|
|
1154
959
|
ProductID: string;
|
|
1155
|
-
ProductList: {
|
|
1156
|
-
items: components["schemas"]["Product"][];
|
|
1157
|
-
/** Format: int64 */
|
|
1158
|
-
total_count?: number;
|
|
1159
|
-
};
|
|
1160
|
-
Plan: {
|
|
1161
|
-
enabled: boolean;
|
|
1162
|
-
lookup_key?: string;
|
|
1163
|
-
product: components["schemas"]["Product"];
|
|
1164
|
-
features: components["schemas"]["PlanFeature"][];
|
|
1165
|
-
/** Format: uuid */
|
|
1166
|
-
id: string;
|
|
1167
|
-
product_id: components["schemas"]["ProductID"];
|
|
1168
|
-
name: string;
|
|
1169
|
-
description?: string;
|
|
1170
|
-
};
|
|
1171
|
-
PlanList: {
|
|
1172
|
-
items: components["schemas"]["Plan"][];
|
|
1173
|
-
/** Format: int64 */
|
|
1174
|
-
total_count?: number;
|
|
1175
|
-
};
|
|
1176
|
-
Price: {
|
|
1177
|
-
rate_card?: components["schemas"]["ObjectIdentity"];
|
|
1178
|
-
lookup_key?: string;
|
|
1179
|
-
product: components["schemas"]["Product"];
|
|
1180
|
-
plan: components["schemas"]["ObjectIdentity"];
|
|
1181
|
-
/** Format: uuid */
|
|
1182
|
-
meter_id?: string;
|
|
1183
|
-
meter?: components["schemas"]["ObjectIdentity"];
|
|
1184
|
-
unit_quantity: string;
|
|
1185
|
-
enabled?: boolean;
|
|
1186
|
-
termination_policy?: components["schemas"]["TerminationPolicy"];
|
|
1187
|
-
refund_policy?: components["schemas"]["RefundPolicy"];
|
|
1188
|
-
product_id?: components["schemas"]["ProductID"];
|
|
1189
|
-
/** Format: uuid */
|
|
1190
|
-
id: string;
|
|
1191
|
-
/** Format: uuid */
|
|
1192
|
-
plan_id: string;
|
|
1193
|
-
currency: string;
|
|
1194
|
-
/**
|
|
1195
|
-
* @description `postpaid` charges for what is used, `prepaid` buys a period in advance, `one_time`
|
|
1196
|
-
* charges once.
|
|
1197
|
-
* @enum {string}
|
|
1198
|
-
*/
|
|
1199
|
-
type: "postpaid" | "prepaid" | "one_time";
|
|
1200
|
-
/**
|
|
1201
|
-
* @description How the amount is arrived at. `rated` means the rate depends on attributes such as
|
|
1202
|
-
* region or machine type, and is looked up on a price list.
|
|
1203
|
-
* @enum {string}
|
|
1204
|
-
*/
|
|
1205
|
-
billing_scheme: "per_unit" | "tiered" | "rated";
|
|
1206
|
-
/** @description Present for `per_unit`. */
|
|
1207
|
-
unit_amount?: components["schemas"]["Money"];
|
|
1208
|
-
/**
|
|
1209
|
-
* @description `none` for a price that is not tiered, which is most of them.
|
|
1210
|
-
*
|
|
1211
|
-
* Otherwise `graduated` charges each band at its own rate, and `volume` charges
|
|
1212
|
-
* everything at the rate of the band the total falls in.
|
|
1213
|
-
* @enum {string}
|
|
1214
|
-
*/
|
|
1215
|
-
tiers_mode?: "none" | "graduated" | "volume";
|
|
1216
|
-
/** @description Present for `tiered`, in ascending order. */
|
|
1217
|
-
tiers?: components["schemas"]["Tier"][];
|
|
1218
|
-
/**
|
|
1219
|
-
* Format: uuid
|
|
1220
|
-
* @description For `rated` prices, the price list the rates are read from.
|
|
1221
|
-
*/
|
|
1222
|
-
rate_card_id?: string;
|
|
1223
|
-
/** @description The smallest quantity that can be bought. Absent means no lower bound. */
|
|
1224
|
-
min_quantity?: string;
|
|
1225
|
-
/**
|
|
1226
|
-
* @description The largest purchasable quantity. Omitted when no maximum applies. A quantity above this limit is
|
|
1227
|
-
* rejected with BILLING_PRICE_INVALID and field=max_quantity.
|
|
1228
|
-
*/
|
|
1229
|
-
max_quantity?: string;
|
|
1230
|
-
/** @description Quantities must be a multiple of this. Absent means any quantity within the bounds. */
|
|
1231
|
-
quantity_step?: string;
|
|
1232
|
-
/** @description For prepaid prices, how many periods one purchase covers. */
|
|
1233
|
-
interval_count?: number;
|
|
1234
|
-
/** @enum {string} */
|
|
1235
|
-
interval: "none" | "day" | "month" | "year";
|
|
1236
|
-
setup_fee?: components["schemas"]["Money"];
|
|
1237
|
-
};
|
|
1238
|
-
PriceList: {
|
|
1239
|
-
items: components["schemas"]["Price"][];
|
|
1240
|
-
/** Format: int64 */
|
|
1241
|
-
total_count?: number;
|
|
1242
|
-
};
|
|
1243
|
-
Rate: {
|
|
1244
|
-
meter: components["schemas"]["ObjectIdentity"];
|
|
1245
|
-
/** @description The unit readings arrive in, such as `core-second`. */
|
|
1246
|
-
unit?: string;
|
|
1247
|
-
/** @description The attributes this rate applies to, such as region and machine type. */
|
|
1248
|
-
dimensions: {
|
|
1249
|
-
[key: string]: string;
|
|
1250
|
-
};
|
|
1251
|
-
/** @enum {string} */
|
|
1252
|
-
pricing_model: "per_unit" | "graduated" | "volume";
|
|
1253
|
-
/** @description Present for `per_unit`. Tiered rates carry their amounts on the tiers. */
|
|
1254
|
-
unit_amount?: components["schemas"]["Money"];
|
|
1255
|
-
/** @description Present for `graduated` and `volume`, in ascending order. */
|
|
1256
|
-
tiers?: components["schemas"]["Tier"][];
|
|
1257
|
-
/**
|
|
1258
|
-
* @description How many measured units one amount covers. An hourly rate on a per-second meter is
|
|
1259
|
-
* `"3600"`.
|
|
1260
|
-
*/
|
|
1261
|
-
unit_quantity?: string;
|
|
1262
|
-
currency: string;
|
|
1263
|
-
/** Format: date-time */
|
|
1264
|
-
effective_from: string;
|
|
1265
|
-
/** Format: date-time */
|
|
1266
|
-
effective_to?: string | null;
|
|
1267
|
-
};
|
|
1268
|
-
RateList: {
|
|
1269
|
-
items: components["schemas"]["Rate"][];
|
|
1270
|
-
/** Format: int64 */
|
|
1271
|
-
total_count?: number;
|
|
1272
|
-
};
|
|
1273
960
|
/**
|
|
1274
961
|
* @description Identify a price directly, or select a price for a plan. For each resource give its ID or lookup key, never both. Lookup keys require product_id.
|
|
1275
962
|
*
|
|
@@ -1321,68 +1008,6 @@ export interface components {
|
|
|
1321
1008
|
*/
|
|
1322
1009
|
duration_seconds?: number;
|
|
1323
1010
|
};
|
|
1324
|
-
EstimateRequest: {
|
|
1325
|
-
/** @description Must be one the catalogue publishes. */
|
|
1326
|
-
currency: string;
|
|
1327
|
-
lines: components["schemas"]["QuoteLine"][];
|
|
1328
|
-
};
|
|
1329
|
-
QuoteLineResult: {
|
|
1330
|
-
/** @description Tax included in the account quote. Absent in public catalogue estimates. */
|
|
1331
|
-
tax_amount?: components["schemas"]["Money"];
|
|
1332
|
-
/** @description Tax already included in the displayed price. */
|
|
1333
|
-
tax_included_amount?: components["schemas"]["Money"];
|
|
1334
|
-
/** @description Which line of the request this answers. */
|
|
1335
|
-
index: number;
|
|
1336
|
-
/**
|
|
1337
|
-
* @description Whether a price was found for this line. Read this before anything else.
|
|
1338
|
-
*
|
|
1339
|
-
* A single item with no price no longer fails the whole request. A catalogue
|
|
1340
|
-
* almost always has something not yet priced, and refusing the request would
|
|
1341
|
-
* leave no way to render a list in which a few entries are simply not on sale.
|
|
1342
|
-
*
|
|
1343
|
-
* When false, `price_id`, `unit_amount` and `amount` are absent and
|
|
1344
|
-
* `unpriced_reason` states what is missing.
|
|
1345
|
-
*/
|
|
1346
|
-
priced: boolean;
|
|
1347
|
-
/**
|
|
1348
|
-
* @description Why no price was found; `none` while `priced` is true.
|
|
1349
|
-
*
|
|
1350
|
-
* The last four are told apart because their remedies differ: the price points
|
|
1351
|
-
* at no price list, the list holds no rate for that meter, that exact combination
|
|
1352
|
-
* of attributes is not configured, or it is configured but nothing is in effect
|
|
1353
|
-
* at the moment asked about.
|
|
1354
|
-
* @enum {string}
|
|
1355
|
-
*/
|
|
1356
|
-
unpriced_reason?: "none" | "no_price" | "no_rate_card" | "no_meter" | "no_dimensions" | "no_effective_rule";
|
|
1357
|
-
/**
|
|
1358
|
-
* Format: uuid
|
|
1359
|
-
* @description The price selected. Returned whenever `priced` is true, including when the
|
|
1360
|
-
* request identified the item indirectly, so that the choice can be confirmed.
|
|
1361
|
-
*/
|
|
1362
|
-
price_id?: string;
|
|
1363
|
-
plan_name?: string;
|
|
1364
|
-
unit_amount?: components["schemas"]["Money"];
|
|
1365
|
-
/**
|
|
1366
|
-
* @description The quantity actually priced. When `duration_seconds` is given, it is the requested
|
|
1367
|
-
* `quantity` multiplied by that duration.
|
|
1368
|
-
*/
|
|
1369
|
-
quantity?: string;
|
|
1370
|
-
/** @description Not rounded. Round only for display. */
|
|
1371
|
-
amount?: components["schemas"]["Money"];
|
|
1372
|
-
currency: string;
|
|
1373
|
-
};
|
|
1374
|
-
Quote: {
|
|
1375
|
-
lines?: components["schemas"]["QuoteLineResult"][];
|
|
1376
|
-
/**
|
|
1377
|
-
* @description What would be owed in total. Amounts to be returned are not netted off it.
|
|
1378
|
-
*
|
|
1379
|
-
* Null when any line could not be priced. What would be owed is not knowable then, and a
|
|
1380
|
-
* total that silently left the unpriced lines out would read as a smaller bill rather than
|
|
1381
|
-
* an incomplete one — the per-line `priced` flag is easy to skip, a missing total is not.
|
|
1382
|
-
*/
|
|
1383
|
-
total?: components["schemas"]["Money"] | null;
|
|
1384
|
-
currency: string;
|
|
1385
|
-
};
|
|
1386
1011
|
BillingAccount: {
|
|
1387
1012
|
/** Format: int64 */
|
|
1388
1013
|
id: number;
|
|
@@ -2488,13 +2113,6 @@ export interface components {
|
|
|
2488
2113
|
/** @description The longest term a purchase may have, in months. */
|
|
2489
2114
|
max_term_months?: number;
|
|
2490
2115
|
};
|
|
2491
|
-
Tier: {
|
|
2492
|
-
/** @description The upper bound of this band. Null on the last band, which has no bound. */
|
|
2493
|
-
up_to?: string | null;
|
|
2494
|
-
unit_amount: components["schemas"]["Money"];
|
|
2495
|
-
/** @description Charged once when this band is reached, in addition to the per-unit amount. */
|
|
2496
|
-
flat_amount?: components["schemas"]["Money"];
|
|
2497
|
-
};
|
|
2498
2116
|
/** @description Frozen purchase terms. Monetary fields come from related invoice-line snapshots and are absent when there is no immediate invoice. Later catalog changes do not reprice this line. */
|
|
2499
2117
|
OrderItem: {
|
|
2500
2118
|
position?: number;
|
|
@@ -2601,10 +2219,6 @@ export interface components {
|
|
|
2601
2219
|
/** Format: int64 */
|
|
2602
2220
|
total_count?: number;
|
|
2603
2221
|
};
|
|
2604
|
-
PlanFeature: {
|
|
2605
|
-
feature: components["schemas"]["ObjectIdentity"];
|
|
2606
|
-
name: string;
|
|
2607
|
-
};
|
|
2608
2222
|
Entitlement: {
|
|
2609
2223
|
product: components["schemas"]["Product"];
|
|
2610
2224
|
feature: components["schemas"]["ObjectIdentity"];
|
|
@@ -2680,15 +2294,6 @@ export interface components {
|
|
|
2680
2294
|
Money: string;
|
|
2681
2295
|
};
|
|
2682
2296
|
responses: {
|
|
2683
|
-
/** @description Unchanged since the `ETag` that was sent. No body. */
|
|
2684
|
-
NotModified: {
|
|
2685
|
-
headers: {
|
|
2686
|
-
/** @description The same entity tag that was sent. */
|
|
2687
|
-
ETag?: string;
|
|
2688
|
-
[name: string]: unknown;
|
|
2689
|
-
};
|
|
2690
|
-
content?: never;
|
|
2691
|
-
};
|
|
2692
2297
|
/** @description Error */
|
|
2693
2298
|
Error: {
|
|
2694
2299
|
headers: {
|
|
@@ -2700,13 +2305,6 @@ export interface components {
|
|
|
2700
2305
|
};
|
|
2701
2306
|
};
|
|
2702
2307
|
parameters: {
|
|
2703
|
-
/**
|
|
2704
|
-
* @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
|
|
2705
|
-
* answer is `304` with no body.
|
|
2706
|
-
*
|
|
2707
|
-
* Send it on every catalogue read. An unchanged catalogue is answered without a body.
|
|
2708
|
-
*/
|
|
2709
|
-
IfNoneMatch: string;
|
|
2710
2308
|
/** @description 1-based page number; the first page when omitted. */
|
|
2711
2309
|
Page: number;
|
|
2712
2310
|
/** @description How many per page, 100 at most. */
|
|
@@ -2718,8 +2316,6 @@ export interface components {
|
|
|
2718
2316
|
AccountIdQuery: number;
|
|
2719
2317
|
AccountId: number;
|
|
2720
2318
|
ProjectId: string;
|
|
2721
|
-
PlanId: string;
|
|
2722
|
-
RateCardId: string;
|
|
2723
2319
|
InvoiceId: string;
|
|
2724
2320
|
OrderId: string;
|
|
2725
2321
|
CancellationRequestId: string;
|
|
@@ -2732,369 +2328,6 @@ export interface components {
|
|
|
2732
2328
|
}
|
|
2733
2329
|
export type $defs = Record<string, never>;
|
|
2734
2330
|
export interface operations {
|
|
2735
|
-
"list-prices": {
|
|
2736
|
-
parameters: {
|
|
2737
|
-
query: {
|
|
2738
|
-
/** @description 1-based page number; the first page when omitted. */
|
|
2739
|
-
page?: components["parameters"]["Page"];
|
|
2740
|
-
/** @description How many per page, 100 at most. */
|
|
2741
|
-
page_size?: components["parameters"]["PageSize"];
|
|
2742
|
-
/** @description ISO 4217, three uppercase letters. */
|
|
2743
|
-
currency: string;
|
|
2744
|
-
product_id?: components["schemas"]["ProductID"];
|
|
2745
|
-
/** @description Narrows to one payment timing. */
|
|
2746
|
-
type?: "postpaid" | "prepaid" | "one_time";
|
|
2747
|
-
};
|
|
2748
|
-
header?: {
|
|
2749
|
-
/**
|
|
2750
|
-
* @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
|
|
2751
|
-
* answer is `304` with no body.
|
|
2752
|
-
*
|
|
2753
|
-
* Send it on every catalogue read. An unchanged catalogue is answered without a body.
|
|
2754
|
-
*/
|
|
2755
|
-
"If-None-Match"?: components["parameters"]["IfNoneMatch"];
|
|
2756
|
-
};
|
|
2757
|
-
path?: never;
|
|
2758
|
-
cookie?: never;
|
|
2759
|
-
};
|
|
2760
|
-
requestBody?: never;
|
|
2761
|
-
responses: {
|
|
2762
|
-
/** @description OK */
|
|
2763
|
-
200: {
|
|
2764
|
-
headers: {
|
|
2765
|
-
/** @description Changes whenever this catalog representation changes. */
|
|
2766
|
-
ETag?: string;
|
|
2767
|
-
[name: string]: unknown;
|
|
2768
|
-
};
|
|
2769
|
-
content: {
|
|
2770
|
-
"application/json": components["schemas"]["PriceList"];
|
|
2771
|
-
};
|
|
2772
|
-
};
|
|
2773
|
-
/** @description Not Modified */
|
|
2774
|
-
304: {
|
|
2775
|
-
headers: {
|
|
2776
|
-
[name: string]: unknown;
|
|
2777
|
-
};
|
|
2778
|
-
content?: never;
|
|
2779
|
-
};
|
|
2780
|
-
default: components["responses"]["Error"];
|
|
2781
|
-
};
|
|
2782
|
-
};
|
|
2783
|
-
"list-products": {
|
|
2784
|
-
parameters: {
|
|
2785
|
-
query?: {
|
|
2786
|
-
/** @description 1-based page number; the first page when omitted. */
|
|
2787
|
-
page?: components["parameters"]["Page"];
|
|
2788
|
-
/** @description How many per page, 100 at most. */
|
|
2789
|
-
page_size?: components["parameters"]["PageSize"];
|
|
2790
|
-
};
|
|
2791
|
-
header?: {
|
|
2792
|
-
/**
|
|
2793
|
-
* @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
|
|
2794
|
-
* answer is `304` with no body.
|
|
2795
|
-
*
|
|
2796
|
-
* Send it on every catalogue read. An unchanged catalogue is answered without a body.
|
|
2797
|
-
*/
|
|
2798
|
-
"If-None-Match"?: components["parameters"]["IfNoneMatch"];
|
|
2799
|
-
};
|
|
2800
|
-
path?: never;
|
|
2801
|
-
cookie?: never;
|
|
2802
|
-
};
|
|
2803
|
-
requestBody?: never;
|
|
2804
|
-
responses: {
|
|
2805
|
-
/** @description OK */
|
|
2806
|
-
200: {
|
|
2807
|
-
headers: {
|
|
2808
|
-
/**
|
|
2809
|
-
* @description Changes whenever the catalogue changes. Send it back as `If-None-Match`
|
|
2810
|
-
* to be told `304` instead of receiving the same listing again.
|
|
2811
|
-
*/
|
|
2812
|
-
ETag?: string;
|
|
2813
|
-
[name: string]: unknown;
|
|
2814
|
-
};
|
|
2815
|
-
content: {
|
|
2816
|
-
"application/json": components["schemas"]["ProductList"];
|
|
2817
|
-
};
|
|
2818
|
-
};
|
|
2819
|
-
304: components["responses"]["NotModified"];
|
|
2820
|
-
default: components["responses"]["Error"];
|
|
2821
|
-
};
|
|
2822
|
-
};
|
|
2823
|
-
"get-product": {
|
|
2824
|
-
parameters: {
|
|
2825
|
-
query?: never;
|
|
2826
|
-
header?: {
|
|
2827
|
-
/**
|
|
2828
|
-
* @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
|
|
2829
|
-
* answer is `304` with no body.
|
|
2830
|
-
*
|
|
2831
|
-
* Send it on every catalogue read. An unchanged catalogue is answered without a body.
|
|
2832
|
-
*/
|
|
2833
|
-
"If-None-Match"?: components["parameters"]["IfNoneMatch"];
|
|
2834
|
-
};
|
|
2835
|
-
path: {
|
|
2836
|
-
productId: components["schemas"]["ProductID"];
|
|
2837
|
-
};
|
|
2838
|
-
cookie?: never;
|
|
2839
|
-
};
|
|
2840
|
-
requestBody?: never;
|
|
2841
|
-
responses: {
|
|
2842
|
-
/** @description OK */
|
|
2843
|
-
200: {
|
|
2844
|
-
headers: {
|
|
2845
|
-
/** @description Changes whenever this catalog representation changes. */
|
|
2846
|
-
ETag?: string;
|
|
2847
|
-
[name: string]: unknown;
|
|
2848
|
-
};
|
|
2849
|
-
content: {
|
|
2850
|
-
"application/json": components["schemas"]["Product"];
|
|
2851
|
-
};
|
|
2852
|
-
};
|
|
2853
|
-
/** @description Not Modified */
|
|
2854
|
-
304: {
|
|
2855
|
-
headers: {
|
|
2856
|
-
[name: string]: unknown;
|
|
2857
|
-
};
|
|
2858
|
-
content?: never;
|
|
2859
|
-
};
|
|
2860
|
-
default: components["responses"]["Error"];
|
|
2861
|
-
};
|
|
2862
|
-
};
|
|
2863
|
-
"get-plan": {
|
|
2864
|
-
parameters: {
|
|
2865
|
-
query?: never;
|
|
2866
|
-
header?: {
|
|
2867
|
-
/**
|
|
2868
|
-
* @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
|
|
2869
|
-
* answer is `304` with no body.
|
|
2870
|
-
*
|
|
2871
|
-
* Send it on every catalogue read. An unchanged catalogue is answered without a body.
|
|
2872
|
-
*/
|
|
2873
|
-
"If-None-Match"?: components["parameters"]["IfNoneMatch"];
|
|
2874
|
-
};
|
|
2875
|
-
path: {
|
|
2876
|
-
planId: string;
|
|
2877
|
-
};
|
|
2878
|
-
cookie?: never;
|
|
2879
|
-
};
|
|
2880
|
-
requestBody?: never;
|
|
2881
|
-
responses: {
|
|
2882
|
-
/** @description OK */
|
|
2883
|
-
200: {
|
|
2884
|
-
headers: {
|
|
2885
|
-
/** @description Changes whenever this catalog representation changes. */
|
|
2886
|
-
ETag?: string;
|
|
2887
|
-
[name: string]: unknown;
|
|
2888
|
-
};
|
|
2889
|
-
content: {
|
|
2890
|
-
"application/json": components["schemas"]["Plan"];
|
|
2891
|
-
};
|
|
2892
|
-
};
|
|
2893
|
-
/** @description Not Modified */
|
|
2894
|
-
304: {
|
|
2895
|
-
headers: {
|
|
2896
|
-
[name: string]: unknown;
|
|
2897
|
-
};
|
|
2898
|
-
content?: never;
|
|
2899
|
-
};
|
|
2900
|
-
default: components["responses"]["Error"];
|
|
2901
|
-
};
|
|
2902
|
-
};
|
|
2903
|
-
"get-price": {
|
|
2904
|
-
parameters: {
|
|
2905
|
-
query?: never;
|
|
2906
|
-
header?: {
|
|
2907
|
-
/**
|
|
2908
|
-
* @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
|
|
2909
|
-
* answer is `304` with no body.
|
|
2910
|
-
*
|
|
2911
|
-
* Send it on every catalogue read. An unchanged catalogue is answered without a body.
|
|
2912
|
-
*/
|
|
2913
|
-
"If-None-Match"?: components["parameters"]["IfNoneMatch"];
|
|
2914
|
-
};
|
|
2915
|
-
path: {
|
|
2916
|
-
priceId: string;
|
|
2917
|
-
};
|
|
2918
|
-
cookie?: never;
|
|
2919
|
-
};
|
|
2920
|
-
requestBody?: never;
|
|
2921
|
-
responses: {
|
|
2922
|
-
/** @description OK */
|
|
2923
|
-
200: {
|
|
2924
|
-
headers: {
|
|
2925
|
-
/** @description Changes whenever this catalog listing changes. */
|
|
2926
|
-
ETag?: string;
|
|
2927
|
-
[name: string]: unknown;
|
|
2928
|
-
};
|
|
2929
|
-
content: {
|
|
2930
|
-
"application/json": components["schemas"]["Price"];
|
|
2931
|
-
};
|
|
2932
|
-
};
|
|
2933
|
-
/** @description Not Modified */
|
|
2934
|
-
304: {
|
|
2935
|
-
headers: {
|
|
2936
|
-
[name: string]: unknown;
|
|
2937
|
-
};
|
|
2938
|
-
content?: never;
|
|
2939
|
-
};
|
|
2940
|
-
default: components["responses"]["Error"];
|
|
2941
|
-
};
|
|
2942
|
-
};
|
|
2943
|
-
"list-plans": {
|
|
2944
|
-
parameters: {
|
|
2945
|
-
query: {
|
|
2946
|
-
product_id: components["schemas"]["ProductID"];
|
|
2947
|
-
/** @description 1-based page number; the first page when omitted. */
|
|
2948
|
-
page?: components["parameters"]["Page"];
|
|
2949
|
-
/** @description How many per page, 100 at most. */
|
|
2950
|
-
page_size?: components["parameters"]["PageSize"];
|
|
2951
|
-
};
|
|
2952
|
-
header?: {
|
|
2953
|
-
/**
|
|
2954
|
-
* @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
|
|
2955
|
-
* answer is `304` with no body.
|
|
2956
|
-
*
|
|
2957
|
-
* Send it on every catalogue read. An unchanged catalogue is answered without a body.
|
|
2958
|
-
*/
|
|
2959
|
-
"If-None-Match"?: components["parameters"]["IfNoneMatch"];
|
|
2960
|
-
};
|
|
2961
|
-
path?: never;
|
|
2962
|
-
cookie?: never;
|
|
2963
|
-
};
|
|
2964
|
-
requestBody?: never;
|
|
2965
|
-
responses: {
|
|
2966
|
-
/** @description OK */
|
|
2967
|
-
200: {
|
|
2968
|
-
headers: {
|
|
2969
|
-
/**
|
|
2970
|
-
* @description Changes whenever the catalogue changes. Send it back as `If-None-Match`
|
|
2971
|
-
* to be told `304` instead of receiving the same listing again.
|
|
2972
|
-
*/
|
|
2973
|
-
ETag?: string;
|
|
2974
|
-
[name: string]: unknown;
|
|
2975
|
-
};
|
|
2976
|
-
content: {
|
|
2977
|
-
"application/json": components["schemas"]["PlanList"];
|
|
2978
|
-
};
|
|
2979
|
-
};
|
|
2980
|
-
304: components["responses"]["NotModified"];
|
|
2981
|
-
default: components["responses"]["Error"];
|
|
2982
|
-
};
|
|
2983
|
-
};
|
|
2984
|
-
"list-prices-by-plan": {
|
|
2985
|
-
parameters: {
|
|
2986
|
-
query?: {
|
|
2987
|
-
/** @description 1-based page number; the first page when omitted. */
|
|
2988
|
-
page?: components["parameters"]["Page"];
|
|
2989
|
-
/** @description How many per page, 100 at most. */
|
|
2990
|
-
page_size?: components["parameters"]["PageSize"];
|
|
2991
|
-
currency?: string;
|
|
2992
|
-
};
|
|
2993
|
-
header?: {
|
|
2994
|
-
/**
|
|
2995
|
-
* @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
|
|
2996
|
-
* answer is `304` with no body.
|
|
2997
|
-
*
|
|
2998
|
-
* Send it on every catalogue read. An unchanged catalogue is answered without a body.
|
|
2999
|
-
*/
|
|
3000
|
-
"If-None-Match"?: components["parameters"]["IfNoneMatch"];
|
|
3001
|
-
};
|
|
3002
|
-
path: {
|
|
3003
|
-
planId: components["parameters"]["PlanId"];
|
|
3004
|
-
};
|
|
3005
|
-
cookie?: never;
|
|
3006
|
-
};
|
|
3007
|
-
requestBody?: never;
|
|
3008
|
-
responses: {
|
|
3009
|
-
/** @description OK */
|
|
3010
|
-
200: {
|
|
3011
|
-
headers: {
|
|
3012
|
-
/**
|
|
3013
|
-
* @description Changes whenever the catalogue changes. Send it back as `If-None-Match`
|
|
3014
|
-
* to be told `304` instead of receiving the same listing again.
|
|
3015
|
-
*/
|
|
3016
|
-
ETag?: string;
|
|
3017
|
-
[name: string]: unknown;
|
|
3018
|
-
};
|
|
3019
|
-
content: {
|
|
3020
|
-
"application/json": components["schemas"]["PriceList"];
|
|
3021
|
-
};
|
|
3022
|
-
};
|
|
3023
|
-
304: components["responses"]["NotModified"];
|
|
3024
|
-
default: components["responses"]["Error"];
|
|
3025
|
-
};
|
|
3026
|
-
};
|
|
3027
|
-
"list-rates": {
|
|
3028
|
-
parameters: {
|
|
3029
|
-
query?: {
|
|
3030
|
-
/** @description 1-based page number; the first page when omitted. */
|
|
3031
|
-
page?: components["parameters"]["Page"];
|
|
3032
|
-
/** @description How many per page, 100 at most. */
|
|
3033
|
-
page_size?: components["parameters"]["PageSize"];
|
|
3034
|
-
/** @description Filter by the meter UUID. */
|
|
3035
|
-
meter_id?: string;
|
|
3036
|
-
/** @description Return the rates in effect at this moment. Defaults to now. */
|
|
3037
|
-
at?: string;
|
|
3038
|
-
};
|
|
3039
|
-
header?: {
|
|
3040
|
-
/**
|
|
3041
|
-
* @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
|
|
3042
|
-
* answer is `304` with no body.
|
|
3043
|
-
*
|
|
3044
|
-
* Send it on every catalogue read. An unchanged catalogue is answered without a body.
|
|
3045
|
-
*/
|
|
3046
|
-
"If-None-Match"?: components["parameters"]["IfNoneMatch"];
|
|
3047
|
-
};
|
|
3048
|
-
path: {
|
|
3049
|
-
rateCardId: components["parameters"]["RateCardId"];
|
|
3050
|
-
};
|
|
3051
|
-
cookie?: never;
|
|
3052
|
-
};
|
|
3053
|
-
requestBody?: never;
|
|
3054
|
-
responses: {
|
|
3055
|
-
/** @description OK */
|
|
3056
|
-
200: {
|
|
3057
|
-
headers: {
|
|
3058
|
-
/**
|
|
3059
|
-
* @description Changes whenever the catalogue changes. Send it back as `If-None-Match`
|
|
3060
|
-
* to be told `304` instead of receiving the same listing again.
|
|
3061
|
-
*/
|
|
3062
|
-
ETag?: string;
|
|
3063
|
-
[name: string]: unknown;
|
|
3064
|
-
};
|
|
3065
|
-
content: {
|
|
3066
|
-
"application/json": components["schemas"]["RateList"];
|
|
3067
|
-
};
|
|
3068
|
-
};
|
|
3069
|
-
304: components["responses"]["NotModified"];
|
|
3070
|
-
default: components["responses"]["Error"];
|
|
3071
|
-
};
|
|
3072
|
-
};
|
|
3073
|
-
"create-estimate": {
|
|
3074
|
-
parameters: {
|
|
3075
|
-
query?: never;
|
|
3076
|
-
header?: never;
|
|
3077
|
-
path?: never;
|
|
3078
|
-
cookie?: never;
|
|
3079
|
-
};
|
|
3080
|
-
requestBody: {
|
|
3081
|
-
content: {
|
|
3082
|
-
"application/json": components["schemas"]["EstimateRequest"];
|
|
3083
|
-
};
|
|
3084
|
-
};
|
|
3085
|
-
responses: {
|
|
3086
|
-
/** @description OK */
|
|
3087
|
-
200: {
|
|
3088
|
-
headers: {
|
|
3089
|
-
[name: string]: unknown;
|
|
3090
|
-
};
|
|
3091
|
-
content: {
|
|
3092
|
-
"application/json": components["schemas"]["Quote"];
|
|
3093
|
-
};
|
|
3094
|
-
};
|
|
3095
|
-
default: components["responses"]["Error"];
|
|
3096
|
-
};
|
|
3097
|
-
};
|
|
3098
2331
|
"list-currencies": {
|
|
3099
2332
|
parameters: {
|
|
3100
2333
|
query?: never;
|