lago-javascript-client 1.40.0 → 1.44.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/esm/openapi/client.d.ts +2630 -1135
- package/esm/openapi/client.js +852 -67
- package/package.json +1 -1
- package/script/openapi/client.d.ts +2630 -1135
- package/script/openapi/client.js +852 -67
package/esm/openapi/client.js
CHANGED
|
@@ -148,8 +148,8 @@ export class HttpClient {
|
|
|
148
148
|
}
|
|
149
149
|
/**
|
|
150
150
|
* @title Lago API documentation
|
|
151
|
-
* @version 1.
|
|
152
|
-
* @license AGPLv3
|
|
151
|
+
* @version 1.44.0
|
|
152
|
+
* @license AGPLv3 (https://github.com/getlago/lago-openapi/blob/main/LICENSE)
|
|
153
153
|
* @baseUrl https://api.getlago.com/api/v1
|
|
154
154
|
* @externalDocs https://github.com/getlago
|
|
155
155
|
* @contact <tech@getlago.com>
|
|
@@ -1211,10 +1211,28 @@ export class Api extends HttpClient {
|
|
|
1211
1211
|
format: "json",
|
|
1212
1212
|
...params,
|
|
1213
1213
|
}),
|
|
1214
|
+
/**
|
|
1215
|
+
* @description This endpoint is used to create a wallet with prepaid credits.
|
|
1216
|
+
*
|
|
1217
|
+
* @tags wallets
|
|
1218
|
+
* @name CreateCustomerWallet
|
|
1219
|
+
* @summary Create a wallet
|
|
1220
|
+
* @request POST:/customers/{external_customer_id}/wallets
|
|
1221
|
+
* @secure
|
|
1222
|
+
*/
|
|
1223
|
+
createCustomerWallet: (externalCustomerId, data, params = {}) => this.request({
|
|
1224
|
+
path: `/customers/${externalCustomerId}/wallets`,
|
|
1225
|
+
method: "POST",
|
|
1226
|
+
body: data,
|
|
1227
|
+
secure: true,
|
|
1228
|
+
type: ContentType.Json,
|
|
1229
|
+
format: "json",
|
|
1230
|
+
...params,
|
|
1231
|
+
}),
|
|
1214
1232
|
/**
|
|
1215
1233
|
* @description This endpoint is used to list all wallets with prepaid credits of a customer
|
|
1216
1234
|
*
|
|
1217
|
-
* @tags
|
|
1235
|
+
* @tags wallets
|
|
1218
1236
|
* @name FindAllCustomerWallets
|
|
1219
1237
|
* @summary List all customer's wallets
|
|
1220
1238
|
* @request GET:/customers/{external_customer_id}/wallets
|
|
@@ -1228,6 +1246,223 @@ export class Api extends HttpClient {
|
|
|
1228
1246
|
format: "json",
|
|
1229
1247
|
...params,
|
|
1230
1248
|
}),
|
|
1249
|
+
/**
|
|
1250
|
+
* @description This endpoint is used to update an existing wallet with prepaid credits.
|
|
1251
|
+
*
|
|
1252
|
+
* @tags wallets
|
|
1253
|
+
* @name UpdateCustomerWallet
|
|
1254
|
+
* @summary Update a wallet
|
|
1255
|
+
* @request PUT:/customers/{external_customer_id}/wallets/{code}
|
|
1256
|
+
* @secure
|
|
1257
|
+
*/
|
|
1258
|
+
updateCustomerWallet: (externalCustomerId, code, data, params = {}) => this.request({
|
|
1259
|
+
path: `/customers/${externalCustomerId}/wallets/${code}`,
|
|
1260
|
+
method: "PUT",
|
|
1261
|
+
body: data,
|
|
1262
|
+
secure: true,
|
|
1263
|
+
type: ContentType.Json,
|
|
1264
|
+
format: "json",
|
|
1265
|
+
...params,
|
|
1266
|
+
}),
|
|
1267
|
+
/**
|
|
1268
|
+
* @description This endpoint is used to retrieve an existing wallet with prepaid credits.
|
|
1269
|
+
*
|
|
1270
|
+
* @tags wallets
|
|
1271
|
+
* @name FindCustomerWallet
|
|
1272
|
+
* @summary Retrieve a wallet
|
|
1273
|
+
* @request GET:/customers/{external_customer_id}/wallets/{code}
|
|
1274
|
+
* @secure
|
|
1275
|
+
*/
|
|
1276
|
+
findCustomerWallet: (externalCustomerId, code, params = {}) => this.request({
|
|
1277
|
+
path: `/customers/${externalCustomerId}/wallets/${code}`,
|
|
1278
|
+
method: "GET",
|
|
1279
|
+
secure: true,
|
|
1280
|
+
format: "json",
|
|
1281
|
+
...params,
|
|
1282
|
+
}),
|
|
1283
|
+
/**
|
|
1284
|
+
* @description This endpoint is used to terminate an existing wallet with prepaid credits.
|
|
1285
|
+
*
|
|
1286
|
+
* @tags wallets
|
|
1287
|
+
* @name DestroyCustomerWallet
|
|
1288
|
+
* @summary Terminate a wallet
|
|
1289
|
+
* @request DELETE:/customers/{external_customer_id}/wallets/{code}
|
|
1290
|
+
* @secure
|
|
1291
|
+
*/
|
|
1292
|
+
destroyCustomerWallet: (externalCustomerId, code, params = {}) => this.request({
|
|
1293
|
+
path: `/customers/${externalCustomerId}/wallets/${code}`,
|
|
1294
|
+
method: "DELETE",
|
|
1295
|
+
secure: true,
|
|
1296
|
+
format: "json",
|
|
1297
|
+
...params,
|
|
1298
|
+
}),
|
|
1299
|
+
/**
|
|
1300
|
+
* @description This endpoint replaces all existing metadata on a wallet with the provided key-value pairs. Any existing metadata keys not included in the request will be removed.
|
|
1301
|
+
*
|
|
1302
|
+
* @tags wallets
|
|
1303
|
+
* @name ReplaceCustomerWalletMetadata
|
|
1304
|
+
* @summary Replace wallet metadata
|
|
1305
|
+
* @request POST:/customers/{external_customer_id}/wallets/{wallet_code}/metadata
|
|
1306
|
+
* @secure
|
|
1307
|
+
*/
|
|
1308
|
+
replaceCustomerWalletMetadata: (externalCustomerId, walletCode, data, params = {}) => this.request({
|
|
1309
|
+
path: `/customers/${externalCustomerId}/wallets/${walletCode}/metadata`,
|
|
1310
|
+
method: "POST",
|
|
1311
|
+
body: data,
|
|
1312
|
+
secure: true,
|
|
1313
|
+
type: ContentType.Json,
|
|
1314
|
+
format: "json",
|
|
1315
|
+
...params,
|
|
1316
|
+
}),
|
|
1317
|
+
/**
|
|
1318
|
+
* @description This endpoint merges the provided metadata with existing metadata on the wallet. Existing keys not in the request are preserved. New keys are added, existing keys are updated.
|
|
1319
|
+
*
|
|
1320
|
+
* @tags wallets
|
|
1321
|
+
* @name MergeCustomerWalletMetadata
|
|
1322
|
+
* @summary Merge wallet metadata
|
|
1323
|
+
* @request PATCH:/customers/{external_customer_id}/wallets/{wallet_code}/metadata
|
|
1324
|
+
* @secure
|
|
1325
|
+
*/
|
|
1326
|
+
mergeCustomerWalletMetadata: (externalCustomerId, walletCode, data, params = {}) => this.request({
|
|
1327
|
+
path: `/customers/${externalCustomerId}/wallets/${walletCode}/metadata`,
|
|
1328
|
+
method: "PATCH",
|
|
1329
|
+
body: data,
|
|
1330
|
+
secure: true,
|
|
1331
|
+
type: ContentType.Json,
|
|
1332
|
+
format: "json",
|
|
1333
|
+
...params,
|
|
1334
|
+
}),
|
|
1335
|
+
/**
|
|
1336
|
+
* @description This endpoint removes all metadata from a wallet.
|
|
1337
|
+
*
|
|
1338
|
+
* @tags wallets
|
|
1339
|
+
* @name DeleteAllCustomerWalletMetadata
|
|
1340
|
+
* @summary Delete all wallet metadata
|
|
1341
|
+
* @request DELETE:/customers/{external_customer_id}/wallets/{wallet_code}/metadata
|
|
1342
|
+
* @secure
|
|
1343
|
+
*/
|
|
1344
|
+
deleteAllCustomerWalletMetadata: (externalCustomerId, walletCode, params = {}) => this.request({
|
|
1345
|
+
path: `/customers/${externalCustomerId}/wallets/${walletCode}/metadata`,
|
|
1346
|
+
method: "DELETE",
|
|
1347
|
+
secure: true,
|
|
1348
|
+
format: "json",
|
|
1349
|
+
...params,
|
|
1350
|
+
}),
|
|
1351
|
+
/**
|
|
1352
|
+
* @description This endpoint removes a single metadata key from a wallet.
|
|
1353
|
+
*
|
|
1354
|
+
* @tags wallets
|
|
1355
|
+
* @name DeleteCustomerWalletMetadataKey
|
|
1356
|
+
* @summary Delete a metadata key
|
|
1357
|
+
* @request DELETE:/customers/{external_customer_id}/wallets/{wallet_code}/metadata/{key}
|
|
1358
|
+
* @secure
|
|
1359
|
+
*/
|
|
1360
|
+
deleteCustomerWalletMetadataKey: (externalCustomerId, walletCode, key, params = {}) => this.request({
|
|
1361
|
+
path: `/customers/${externalCustomerId}/wallets/${walletCode}/metadata/${key}`,
|
|
1362
|
+
method: "DELETE",
|
|
1363
|
+
secure: true,
|
|
1364
|
+
format: "json",
|
|
1365
|
+
...params,
|
|
1366
|
+
}),
|
|
1367
|
+
/**
|
|
1368
|
+
* @description This endpoint enables the retrieval of all alerts for a wallet.
|
|
1369
|
+
*
|
|
1370
|
+
* @tags wallets
|
|
1371
|
+
* @name GetCustomerWalletAlerts
|
|
1372
|
+
* @summary List wallet alerts
|
|
1373
|
+
* @request GET:/customers/{external_customer_id}/wallets/{wallet_code}/alerts
|
|
1374
|
+
* @secure
|
|
1375
|
+
*/
|
|
1376
|
+
getCustomerWalletAlerts: (externalCustomerId, walletCode, params = {}) => this.request({
|
|
1377
|
+
path: `/customers/${externalCustomerId}/wallets/${walletCode}/alerts`,
|
|
1378
|
+
method: "GET",
|
|
1379
|
+
secure: true,
|
|
1380
|
+
format: "json",
|
|
1381
|
+
...params,
|
|
1382
|
+
}),
|
|
1383
|
+
/**
|
|
1384
|
+
* @description This endpoint allows you to create new alerts for a wallet. Send a single alert object wrapped in `alert` key to create one alert, or an array of alert objects wrapped in `alerts` key to create multiple alerts atomically.
|
|
1385
|
+
*
|
|
1386
|
+
* @tags wallets
|
|
1387
|
+
* @name CreateCustomerWalletAlert
|
|
1388
|
+
* @summary Create wallet alert(s)
|
|
1389
|
+
* @request POST:/customers/{external_customer_id}/wallets/{wallet_code}/alerts
|
|
1390
|
+
* @secure
|
|
1391
|
+
*/
|
|
1392
|
+
createCustomerWalletAlert: (externalCustomerId, walletCode, data, params = {}) => this.request({
|
|
1393
|
+
path: `/customers/${externalCustomerId}/wallets/${walletCode}/alerts`,
|
|
1394
|
+
method: "POST",
|
|
1395
|
+
body: data,
|
|
1396
|
+
secure: true,
|
|
1397
|
+
type: ContentType.Json,
|
|
1398
|
+
format: "json",
|
|
1399
|
+
...params,
|
|
1400
|
+
}),
|
|
1401
|
+
/**
|
|
1402
|
+
* @description This endpoint allows you to delete all alerts for a wallet.
|
|
1403
|
+
*
|
|
1404
|
+
* @tags wallets
|
|
1405
|
+
* @name DeleteAllCustomerWalletAlerts
|
|
1406
|
+
* @summary Delete all wallet alerts
|
|
1407
|
+
* @request DELETE:/customers/{external_customer_id}/wallets/{wallet_code}/alerts
|
|
1408
|
+
* @secure
|
|
1409
|
+
*/
|
|
1410
|
+
deleteAllCustomerWalletAlerts: (externalCustomerId, walletCode, params = {}) => this.request({
|
|
1411
|
+
path: `/customers/${externalCustomerId}/wallets/${walletCode}/alerts`,
|
|
1412
|
+
method: "DELETE",
|
|
1413
|
+
secure: true,
|
|
1414
|
+
...params,
|
|
1415
|
+
}),
|
|
1416
|
+
/**
|
|
1417
|
+
* @description This endpoint enables the retrieval of a specific alert for a wallet.
|
|
1418
|
+
*
|
|
1419
|
+
* @tags wallets
|
|
1420
|
+
* @name GetCustomerWalletAlert
|
|
1421
|
+
* @summary Retrieve a wallet alert
|
|
1422
|
+
* @request GET:/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}
|
|
1423
|
+
* @secure
|
|
1424
|
+
*/
|
|
1425
|
+
getCustomerWalletAlert: (externalCustomerId, walletCode, code, params = {}) => this.request({
|
|
1426
|
+
path: `/customers/${externalCustomerId}/wallets/${walletCode}/alerts/${code}`,
|
|
1427
|
+
method: "GET",
|
|
1428
|
+
secure: true,
|
|
1429
|
+
format: "json",
|
|
1430
|
+
...params,
|
|
1431
|
+
}),
|
|
1432
|
+
/**
|
|
1433
|
+
* @description This endpoint allows you to update an existing alert for a wallet.
|
|
1434
|
+
*
|
|
1435
|
+
* @tags wallets
|
|
1436
|
+
* @name UpdateCustomerWalletAlert
|
|
1437
|
+
* @summary Update a wallet alert
|
|
1438
|
+
* @request PUT:/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}
|
|
1439
|
+
* @secure
|
|
1440
|
+
*/
|
|
1441
|
+
updateCustomerWalletAlert: (externalCustomerId, walletCode, code, data, params = {}) => this.request({
|
|
1442
|
+
path: `/customers/${externalCustomerId}/wallets/${walletCode}/alerts/${code}`,
|
|
1443
|
+
method: "PUT",
|
|
1444
|
+
body: data,
|
|
1445
|
+
secure: true,
|
|
1446
|
+
type: ContentType.Json,
|
|
1447
|
+
format: "json",
|
|
1448
|
+
...params,
|
|
1449
|
+
}),
|
|
1450
|
+
/**
|
|
1451
|
+
* @description This endpoint allows you to delete an existing alert for a wallet.
|
|
1452
|
+
*
|
|
1453
|
+
* @tags wallets
|
|
1454
|
+
* @name DeleteCustomerWalletAlert
|
|
1455
|
+
* @summary Delete a wallet alert
|
|
1456
|
+
* @request DELETE:/customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}
|
|
1457
|
+
* @secure
|
|
1458
|
+
*/
|
|
1459
|
+
deleteCustomerWalletAlert: (externalCustomerId, walletCode, code, params = {}) => this.request({
|
|
1460
|
+
path: `/customers/${externalCustomerId}/wallets/${walletCode}/alerts/${code}`,
|
|
1461
|
+
method: "DELETE",
|
|
1462
|
+
secure: true,
|
|
1463
|
+
format: "json",
|
|
1464
|
+
...params,
|
|
1465
|
+
}),
|
|
1231
1466
|
/**
|
|
1232
1467
|
* @description This endpoint enables the retrieval of the usage-based billing data for a customer within the current period.
|
|
1233
1468
|
*
|
|
@@ -1295,6 +1530,55 @@ export class Api extends HttpClient {
|
|
|
1295
1530
|
format: "json",
|
|
1296
1531
|
...params,
|
|
1297
1532
|
}),
|
|
1533
|
+
/**
|
|
1534
|
+
* @description This endpoint retrieves all payment methods of a Customer.
|
|
1535
|
+
*
|
|
1536
|
+
* @tags payment_methods
|
|
1537
|
+
* @name FindAllCustomersPaymentMethods
|
|
1538
|
+
* @summary List all customer payment methods
|
|
1539
|
+
* @request GET:/customers/{external_customer_id}/payment_methods
|
|
1540
|
+
* @secure
|
|
1541
|
+
*/
|
|
1542
|
+
findAllCustomersPaymentMethods: (externalCustomerId, query, params = {}) => this.request({
|
|
1543
|
+
path: `/customers/${externalCustomerId}/payment_methods`,
|
|
1544
|
+
method: "GET",
|
|
1545
|
+
query: query,
|
|
1546
|
+
secure: true,
|
|
1547
|
+
format: "json",
|
|
1548
|
+
...params,
|
|
1549
|
+
}),
|
|
1550
|
+
/**
|
|
1551
|
+
* @description Use the payment method as default when not selected a payment method
|
|
1552
|
+
*
|
|
1553
|
+
* @tags payment_methods
|
|
1554
|
+
* @name PaymentMethodSetAsDefault
|
|
1555
|
+
* @summary Set the payment method as default
|
|
1556
|
+
* @request PUT:/customers/{external_customer_id}/payment_methods/{lago_id}/set_as_default
|
|
1557
|
+
* @secure
|
|
1558
|
+
*/
|
|
1559
|
+
paymentMethodSetAsDefault: (lagoId, externalCustomerId, params = {}) => this.request({
|
|
1560
|
+
path: `/customers/${externalCustomerId}/payment_methods/${lagoId}/set_as_default`,
|
|
1561
|
+
method: "PUT",
|
|
1562
|
+
secure: true,
|
|
1563
|
+
format: "json",
|
|
1564
|
+
...params,
|
|
1565
|
+
}),
|
|
1566
|
+
/**
|
|
1567
|
+
* @description This endpoint deletes a specific payment method for a customer.
|
|
1568
|
+
*
|
|
1569
|
+
* @tags payment_methods
|
|
1570
|
+
* @name DestroyPaymentMethod
|
|
1571
|
+
* @summary Delete a payment method
|
|
1572
|
+
* @request DELETE:/customers/{external_customer_id}/payment_methods/{lago_id}
|
|
1573
|
+
* @secure
|
|
1574
|
+
*/
|
|
1575
|
+
destroyPaymentMethod: (lagoId, externalCustomerId, params = {}) => this.request({
|
|
1576
|
+
path: `/customers/${externalCustomerId}/payment_methods/${lagoId}`,
|
|
1577
|
+
method: "DELETE",
|
|
1578
|
+
secure: true,
|
|
1579
|
+
format: "json",
|
|
1580
|
+
...params,
|
|
1581
|
+
}),
|
|
1298
1582
|
};
|
|
1299
1583
|
events = {
|
|
1300
1584
|
/**
|
|
@@ -1683,10 +1967,12 @@ export class Api extends HttpClient {
|
|
|
1683
1967
|
* @request POST:/invoices/{lago_id}/retry_payment
|
|
1684
1968
|
* @secure
|
|
1685
1969
|
*/
|
|
1686
|
-
retryPayment: (lagoId, params = {}) => this.request({
|
|
1970
|
+
retryPayment: (lagoId, data, params = {}) => this.request({
|
|
1687
1971
|
path: `/invoices/${lagoId}/retry_payment`,
|
|
1688
1972
|
method: "POST",
|
|
1973
|
+
body: data,
|
|
1689
1974
|
secure: true,
|
|
1975
|
+
type: ContentType.Json,
|
|
1690
1976
|
...params,
|
|
1691
1977
|
}),
|
|
1692
1978
|
/**
|
|
@@ -2123,19 +2409,17 @@ export class Api extends HttpClient {
|
|
|
2123
2409
|
format: "json",
|
|
2124
2410
|
...params,
|
|
2125
2411
|
}),
|
|
2126
|
-
};
|
|
2127
|
-
subscriptions = {
|
|
2128
2412
|
/**
|
|
2129
|
-
* @description This endpoint
|
|
2413
|
+
* @description This endpoint creates a new charge for a specific plan.
|
|
2130
2414
|
*
|
|
2131
|
-
* @tags
|
|
2132
|
-
* @name
|
|
2133
|
-
* @summary
|
|
2134
|
-
* @request POST:/
|
|
2415
|
+
* @tags plans
|
|
2416
|
+
* @name CreatePlanCharge
|
|
2417
|
+
* @summary Create a charge
|
|
2418
|
+
* @request POST:/plans/{code}/charges
|
|
2135
2419
|
* @secure
|
|
2136
2420
|
*/
|
|
2137
|
-
|
|
2138
|
-
path: `/
|
|
2421
|
+
createPlanCharge: (code, data, params = {}) => this.request({
|
|
2422
|
+
path: `/plans/${code}/charges`,
|
|
2139
2423
|
method: "POST",
|
|
2140
2424
|
body: data,
|
|
2141
2425
|
secure: true,
|
|
@@ -2144,16 +2428,16 @@ export class Api extends HttpClient {
|
|
|
2144
2428
|
...params,
|
|
2145
2429
|
}),
|
|
2146
2430
|
/**
|
|
2147
|
-
* @description This endpoint retrieves all
|
|
2431
|
+
* @description This endpoint retrieves all charges for a specific plan.
|
|
2148
2432
|
*
|
|
2149
|
-
* @tags
|
|
2150
|
-
* @name
|
|
2151
|
-
* @summary List all
|
|
2152
|
-
* @request GET:/
|
|
2433
|
+
* @tags plans
|
|
2434
|
+
* @name FindAllPlanCharges
|
|
2435
|
+
* @summary List all charges for a plan
|
|
2436
|
+
* @request GET:/plans/{code}/charges
|
|
2153
2437
|
* @secure
|
|
2154
2438
|
*/
|
|
2155
|
-
|
|
2156
|
-
path: `/
|
|
2439
|
+
findAllPlanCharges: (code, query, params = {}) => this.request({
|
|
2440
|
+
path: `/plans/${code}/charges`,
|
|
2157
2441
|
method: "GET",
|
|
2158
2442
|
query: query,
|
|
2159
2443
|
secure: true,
|
|
@@ -2161,35 +2445,33 @@ export class Api extends HttpClient {
|
|
|
2161
2445
|
...params,
|
|
2162
2446
|
}),
|
|
2163
2447
|
/**
|
|
2164
|
-
* @description This endpoint retrieves a specific
|
|
2448
|
+
* @description This endpoint retrieves a specific charge for a plan.
|
|
2165
2449
|
*
|
|
2166
|
-
* @tags
|
|
2167
|
-
* @name
|
|
2168
|
-
* @summary Retrieve a
|
|
2169
|
-
* @request GET:/
|
|
2450
|
+
* @tags plans
|
|
2451
|
+
* @name FindPlanCharge
|
|
2452
|
+
* @summary Retrieve a charge
|
|
2453
|
+
* @request GET:/plans/{code}/charges/{charge_code}
|
|
2170
2454
|
* @secure
|
|
2171
2455
|
*/
|
|
2172
|
-
|
|
2173
|
-
path: `/
|
|
2456
|
+
findPlanCharge: (code, chargeCode, params = {}) => this.request({
|
|
2457
|
+
path: `/plans/${code}/charges/${chargeCode}`,
|
|
2174
2458
|
method: "GET",
|
|
2175
|
-
query: query,
|
|
2176
2459
|
secure: true,
|
|
2177
2460
|
format: "json",
|
|
2178
2461
|
...params,
|
|
2179
2462
|
}),
|
|
2180
2463
|
/**
|
|
2181
|
-
* @description This endpoint
|
|
2464
|
+
* @description This endpoint updates a specific charge for a plan.
|
|
2182
2465
|
*
|
|
2183
|
-
* @tags
|
|
2184
|
-
* @name
|
|
2185
|
-
* @summary Update a
|
|
2186
|
-
* @request PUT:/
|
|
2466
|
+
* @tags plans
|
|
2467
|
+
* @name UpdatePlanCharge
|
|
2468
|
+
* @summary Update a charge
|
|
2469
|
+
* @request PUT:/plans/{code}/charges/{charge_code}
|
|
2187
2470
|
* @secure
|
|
2188
2471
|
*/
|
|
2189
|
-
|
|
2190
|
-
path: `/
|
|
2472
|
+
updatePlanCharge: (code, chargeCode, data, params = {}) => this.request({
|
|
2473
|
+
path: `/plans/${code}/charges/${chargeCode}`,
|
|
2191
2474
|
method: "PUT",
|
|
2192
|
-
query: query,
|
|
2193
2475
|
body: data,
|
|
2194
2476
|
secure: true,
|
|
2195
2477
|
type: ContentType.Json,
|
|
@@ -2197,35 +2479,300 @@ export class Api extends HttpClient {
|
|
|
2197
2479
|
...params,
|
|
2198
2480
|
}),
|
|
2199
2481
|
/**
|
|
2200
|
-
* @description This endpoint
|
|
2482
|
+
* @description This endpoint deletes a specific charge from a plan.
|
|
2201
2483
|
*
|
|
2202
|
-
* @tags
|
|
2203
|
-
* @name
|
|
2204
|
-
* @summary
|
|
2205
|
-
* @request DELETE:/
|
|
2484
|
+
* @tags plans
|
|
2485
|
+
* @name DestroyPlanCharge
|
|
2486
|
+
* @summary Delete a charge
|
|
2487
|
+
* @request DELETE:/plans/{code}/charges/{charge_code}
|
|
2206
2488
|
* @secure
|
|
2207
2489
|
*/
|
|
2208
|
-
|
|
2209
|
-
path: `/
|
|
2490
|
+
destroyPlanCharge: (code, chargeCode, data, params = {}) => this.request({
|
|
2491
|
+
path: `/plans/${code}/charges/${chargeCode}`,
|
|
2210
2492
|
method: "DELETE",
|
|
2211
|
-
|
|
2493
|
+
body: data,
|
|
2212
2494
|
secure: true,
|
|
2495
|
+
type: ContentType.Json,
|
|
2213
2496
|
format: "json",
|
|
2214
2497
|
...params,
|
|
2215
2498
|
}),
|
|
2216
2499
|
/**
|
|
2217
|
-
* @description This endpoint
|
|
2500
|
+
* @description This endpoint creates a new filter for a specific charge.
|
|
2218
2501
|
*
|
|
2219
|
-
* @tags
|
|
2220
|
-
* @name
|
|
2221
|
-
* @summary
|
|
2222
|
-
* @request
|
|
2502
|
+
* @tags plans
|
|
2503
|
+
* @name CreatePlanChargeFilter
|
|
2504
|
+
* @summary Create a charge filter
|
|
2505
|
+
* @request POST:/plans/{code}/charges/{charge_code}/filters
|
|
2223
2506
|
* @secure
|
|
2224
2507
|
*/
|
|
2225
|
-
|
|
2226
|
-
path: `/
|
|
2227
|
-
method: "
|
|
2228
|
-
|
|
2508
|
+
createPlanChargeFilter: (code, chargeCode, data, params = {}) => this.request({
|
|
2509
|
+
path: `/plans/${code}/charges/${chargeCode}/filters`,
|
|
2510
|
+
method: "POST",
|
|
2511
|
+
body: data,
|
|
2512
|
+
secure: true,
|
|
2513
|
+
type: ContentType.Json,
|
|
2514
|
+
format: "json",
|
|
2515
|
+
...params,
|
|
2516
|
+
}),
|
|
2517
|
+
/**
|
|
2518
|
+
* @description This endpoint retrieves all filters for a specific charge.
|
|
2519
|
+
*
|
|
2520
|
+
* @tags plans
|
|
2521
|
+
* @name FindAllPlanChargeFilters
|
|
2522
|
+
* @summary List all filters for a charge
|
|
2523
|
+
* @request GET:/plans/{code}/charges/{charge_code}/filters
|
|
2524
|
+
* @secure
|
|
2525
|
+
*/
|
|
2526
|
+
findAllPlanChargeFilters: (code, chargeCode, query, params = {}) => this.request({
|
|
2527
|
+
path: `/plans/${code}/charges/${chargeCode}/filters`,
|
|
2528
|
+
method: "GET",
|
|
2529
|
+
query: query,
|
|
2530
|
+
secure: true,
|
|
2531
|
+
format: "json",
|
|
2532
|
+
...params,
|
|
2533
|
+
}),
|
|
2534
|
+
/**
|
|
2535
|
+
* @description This endpoint retrieves a specific filter for a charge.
|
|
2536
|
+
*
|
|
2537
|
+
* @tags plans
|
|
2538
|
+
* @name FindPlanChargeFilter
|
|
2539
|
+
* @summary Retrieve a charge filter
|
|
2540
|
+
* @request GET:/plans/{code}/charges/{charge_code}/filters/{filter_id}
|
|
2541
|
+
* @secure
|
|
2542
|
+
*/
|
|
2543
|
+
findPlanChargeFilter: (code, chargeCode, filterId, params = {}) => this.request({
|
|
2544
|
+
path: `/plans/${code}/charges/${chargeCode}/filters/${filterId}`,
|
|
2545
|
+
method: "GET",
|
|
2546
|
+
secure: true,
|
|
2547
|
+
format: "json",
|
|
2548
|
+
...params,
|
|
2549
|
+
}),
|
|
2550
|
+
/**
|
|
2551
|
+
* @description This endpoint updates a specific filter for a charge.
|
|
2552
|
+
*
|
|
2553
|
+
* @tags plans
|
|
2554
|
+
* @name UpdatePlanChargeFilter
|
|
2555
|
+
* @summary Update a charge filter
|
|
2556
|
+
* @request PUT:/plans/{code}/charges/{charge_code}/filters/{filter_id}
|
|
2557
|
+
* @secure
|
|
2558
|
+
*/
|
|
2559
|
+
updatePlanChargeFilter: (code, chargeCode, filterId, data, params = {}) => this.request({
|
|
2560
|
+
path: `/plans/${code}/charges/${chargeCode}/filters/${filterId}`,
|
|
2561
|
+
method: "PUT",
|
|
2562
|
+
body: data,
|
|
2563
|
+
secure: true,
|
|
2564
|
+
type: ContentType.Json,
|
|
2565
|
+
format: "json",
|
|
2566
|
+
...params,
|
|
2567
|
+
}),
|
|
2568
|
+
/**
|
|
2569
|
+
* @description This endpoint deletes a specific filter from a charge.
|
|
2570
|
+
*
|
|
2571
|
+
* @tags plans
|
|
2572
|
+
* @name DestroyPlanChargeFilter
|
|
2573
|
+
* @summary Delete a charge filter
|
|
2574
|
+
* @request DELETE:/plans/{code}/charges/{charge_code}/filters/{filter_id}
|
|
2575
|
+
* @secure
|
|
2576
|
+
*/
|
|
2577
|
+
destroyPlanChargeFilter: (code, chargeCode, filterId, data, params = {}) => this.request({
|
|
2578
|
+
path: `/plans/${code}/charges/${chargeCode}/filters/${filterId}`,
|
|
2579
|
+
method: "DELETE",
|
|
2580
|
+
body: data,
|
|
2581
|
+
secure: true,
|
|
2582
|
+
type: ContentType.Json,
|
|
2583
|
+
format: "json",
|
|
2584
|
+
...params,
|
|
2585
|
+
}),
|
|
2586
|
+
/**
|
|
2587
|
+
* @description This endpoint creates a new fixed charge for a specific plan.
|
|
2588
|
+
*
|
|
2589
|
+
* @tags plans
|
|
2590
|
+
* @name CreatePlanFixedCharge
|
|
2591
|
+
* @summary Create a fixed charge
|
|
2592
|
+
* @request POST:/plans/{code}/fixed_charges
|
|
2593
|
+
* @secure
|
|
2594
|
+
*/
|
|
2595
|
+
createPlanFixedCharge: (code, data, params = {}) => this.request({
|
|
2596
|
+
path: `/plans/${code}/fixed_charges`,
|
|
2597
|
+
method: "POST",
|
|
2598
|
+
body: data,
|
|
2599
|
+
secure: true,
|
|
2600
|
+
type: ContentType.Json,
|
|
2601
|
+
format: "json",
|
|
2602
|
+
...params,
|
|
2603
|
+
}),
|
|
2604
|
+
/**
|
|
2605
|
+
* @description This endpoint retrieves all fixed charges for a specific plan.
|
|
2606
|
+
*
|
|
2607
|
+
* @tags plans
|
|
2608
|
+
* @name FindAllPlanFixedCharges
|
|
2609
|
+
* @summary List all fixed charges for a plan
|
|
2610
|
+
* @request GET:/plans/{code}/fixed_charges
|
|
2611
|
+
* @secure
|
|
2612
|
+
*/
|
|
2613
|
+
findAllPlanFixedCharges: (code, query, params = {}) => this.request({
|
|
2614
|
+
path: `/plans/${code}/fixed_charges`,
|
|
2615
|
+
method: "GET",
|
|
2616
|
+
query: query,
|
|
2617
|
+
secure: true,
|
|
2618
|
+
format: "json",
|
|
2619
|
+
...params,
|
|
2620
|
+
}),
|
|
2621
|
+
/**
|
|
2622
|
+
* @description This endpoint retrieves a specific fixed charge for a plan.
|
|
2623
|
+
*
|
|
2624
|
+
* @tags plans
|
|
2625
|
+
* @name FindPlanFixedCharge
|
|
2626
|
+
* @summary Retrieve a fixed charge
|
|
2627
|
+
* @request GET:/plans/{code}/fixed_charges/{fixed_charge_code}
|
|
2628
|
+
* @secure
|
|
2629
|
+
*/
|
|
2630
|
+
findPlanFixedCharge: (code, fixedChargeCode, params = {}) => this.request({
|
|
2631
|
+
path: `/plans/${code}/fixed_charges/${fixedChargeCode}`,
|
|
2632
|
+
method: "GET",
|
|
2633
|
+
secure: true,
|
|
2634
|
+
format: "json",
|
|
2635
|
+
...params,
|
|
2636
|
+
}),
|
|
2637
|
+
/**
|
|
2638
|
+
* @description This endpoint updates a specific fixed charge for a plan.
|
|
2639
|
+
*
|
|
2640
|
+
* @tags plans
|
|
2641
|
+
* @name UpdatePlanFixedCharge
|
|
2642
|
+
* @summary Update a fixed charge
|
|
2643
|
+
* @request PUT:/plans/{code}/fixed_charges/{fixed_charge_code}
|
|
2644
|
+
* @secure
|
|
2645
|
+
*/
|
|
2646
|
+
updatePlanFixedCharge: (code, fixedChargeCode, data, params = {}) => this.request({
|
|
2647
|
+
path: `/plans/${code}/fixed_charges/${fixedChargeCode}`,
|
|
2648
|
+
method: "PUT",
|
|
2649
|
+
body: data,
|
|
2650
|
+
secure: true,
|
|
2651
|
+
type: ContentType.Json,
|
|
2652
|
+
format: "json",
|
|
2653
|
+
...params,
|
|
2654
|
+
}),
|
|
2655
|
+
/**
|
|
2656
|
+
* @description This endpoint deletes a specific fixed charge from a plan.
|
|
2657
|
+
*
|
|
2658
|
+
* @tags plans
|
|
2659
|
+
* @name DestroyPlanFixedCharge
|
|
2660
|
+
* @summary Delete a fixed charge
|
|
2661
|
+
* @request DELETE:/plans/{code}/fixed_charges/{fixed_charge_code}
|
|
2662
|
+
* @secure
|
|
2663
|
+
*/
|
|
2664
|
+
destroyPlanFixedCharge: (code, fixedChargeCode, data, params = {}) => this.request({
|
|
2665
|
+
path: `/plans/${code}/fixed_charges/${fixedChargeCode}`,
|
|
2666
|
+
method: "DELETE",
|
|
2667
|
+
body: data,
|
|
2668
|
+
secure: true,
|
|
2669
|
+
type: ContentType.Json,
|
|
2670
|
+
format: "json",
|
|
2671
|
+
...params,
|
|
2672
|
+
}),
|
|
2673
|
+
};
|
|
2674
|
+
subscriptions = {
|
|
2675
|
+
/**
|
|
2676
|
+
* @description This endpoint assigns a plan to a customer, creating or modifying a subscription. Ideal for initial subscriptions or plan changes (upgrades/downgrades).
|
|
2677
|
+
*
|
|
2678
|
+
* @tags subscriptions
|
|
2679
|
+
* @name CreateSubscription
|
|
2680
|
+
* @summary Assign a plan to a customer
|
|
2681
|
+
* @request POST:/subscriptions
|
|
2682
|
+
* @secure
|
|
2683
|
+
*/
|
|
2684
|
+
createSubscription: (data, params = {}) => this.request({
|
|
2685
|
+
path: `/subscriptions`,
|
|
2686
|
+
method: "POST",
|
|
2687
|
+
body: data,
|
|
2688
|
+
secure: true,
|
|
2689
|
+
type: ContentType.Json,
|
|
2690
|
+
format: "json",
|
|
2691
|
+
...params,
|
|
2692
|
+
}),
|
|
2693
|
+
/**
|
|
2694
|
+
* @description This endpoint retrieves all active subscriptions.
|
|
2695
|
+
*
|
|
2696
|
+
* @tags subscriptions
|
|
2697
|
+
* @name FindAllSubscriptions
|
|
2698
|
+
* @summary List all subscriptions
|
|
2699
|
+
* @request GET:/subscriptions
|
|
2700
|
+
* @secure
|
|
2701
|
+
*/
|
|
2702
|
+
findAllSubscriptions: (query, params = {}) => this.request({
|
|
2703
|
+
path: `/subscriptions`,
|
|
2704
|
+
method: "GET",
|
|
2705
|
+
query: query,
|
|
2706
|
+
secure: true,
|
|
2707
|
+
format: "json",
|
|
2708
|
+
...params,
|
|
2709
|
+
}),
|
|
2710
|
+
/**
|
|
2711
|
+
* @description This endpoint retrieves a specific subscription.
|
|
2712
|
+
*
|
|
2713
|
+
* @tags subscriptions
|
|
2714
|
+
* @name FindSubscription
|
|
2715
|
+
* @summary Retrieve a subscription
|
|
2716
|
+
* @request GET:/subscriptions/{external_id}
|
|
2717
|
+
* @secure
|
|
2718
|
+
*/
|
|
2719
|
+
findSubscription: (externalId, query, params = {}) => this.request({
|
|
2720
|
+
path: `/subscriptions/${externalId}`,
|
|
2721
|
+
method: "GET",
|
|
2722
|
+
query: query,
|
|
2723
|
+
secure: true,
|
|
2724
|
+
format: "json",
|
|
2725
|
+
...params,
|
|
2726
|
+
}),
|
|
2727
|
+
/**
|
|
2728
|
+
* @description This endpoint allows you to update a subscription.
|
|
2729
|
+
*
|
|
2730
|
+
* @tags subscriptions
|
|
2731
|
+
* @name UpdateSubscription
|
|
2732
|
+
* @summary Update a subscription
|
|
2733
|
+
* @request PUT:/subscriptions/{external_id}
|
|
2734
|
+
* @secure
|
|
2735
|
+
*/
|
|
2736
|
+
updateSubscription: (externalId, data, query, params = {}) => this.request({
|
|
2737
|
+
path: `/subscriptions/${externalId}`,
|
|
2738
|
+
method: "PUT",
|
|
2739
|
+
query: query,
|
|
2740
|
+
body: data,
|
|
2741
|
+
secure: true,
|
|
2742
|
+
type: ContentType.Json,
|
|
2743
|
+
format: "json",
|
|
2744
|
+
...params,
|
|
2745
|
+
}),
|
|
2746
|
+
/**
|
|
2747
|
+
* @description This endpoint allows you to terminate a subscription.
|
|
2748
|
+
*
|
|
2749
|
+
* @tags subscriptions
|
|
2750
|
+
* @name DestroySubscription
|
|
2751
|
+
* @summary Terminate a subscription
|
|
2752
|
+
* @request DELETE:/subscriptions/{external_id}
|
|
2753
|
+
* @secure
|
|
2754
|
+
*/
|
|
2755
|
+
destroySubscription: (externalId, query, params = {}) => this.request({
|
|
2756
|
+
path: `/subscriptions/${externalId}`,
|
|
2757
|
+
method: "DELETE",
|
|
2758
|
+
query: query,
|
|
2759
|
+
secure: true,
|
|
2760
|
+
format: "json",
|
|
2761
|
+
...params,
|
|
2762
|
+
}),
|
|
2763
|
+
/**
|
|
2764
|
+
* @description This endpoint enables the retrieval of the lifetime usage of a subscription.
|
|
2765
|
+
*
|
|
2766
|
+
* @tags subscriptions
|
|
2767
|
+
* @name GetSubscriptionLifetimeUsage
|
|
2768
|
+
* @summary Retrieve subscription lifetime usage
|
|
2769
|
+
* @request GET:/subscriptions/{external_id}/lifetime_usage
|
|
2770
|
+
* @secure
|
|
2771
|
+
*/
|
|
2772
|
+
getSubscriptionLifetimeUsage: (externalId, params = {}) => this.request({
|
|
2773
|
+
path: `/subscriptions/${externalId}/lifetime_usage`,
|
|
2774
|
+
method: "GET",
|
|
2775
|
+
secure: true,
|
|
2229
2776
|
format: "json",
|
|
2230
2777
|
...params,
|
|
2231
2778
|
}),
|
|
@@ -2256,31 +2803,49 @@ export class Api extends HttpClient {
|
|
|
2256
2803
|
* @request GET:/subscriptions/{external_id}/alerts
|
|
2257
2804
|
* @secure
|
|
2258
2805
|
*/
|
|
2259
|
-
getSubscriptionAlerts: (externalId, params = {}) => this.request({
|
|
2806
|
+
getSubscriptionAlerts: (externalId, query, params = {}) => this.request({
|
|
2260
2807
|
path: `/subscriptions/${externalId}/alerts`,
|
|
2261
2808
|
method: "GET",
|
|
2809
|
+
query: query,
|
|
2262
2810
|
secure: true,
|
|
2263
2811
|
format: "json",
|
|
2264
2812
|
...params,
|
|
2265
2813
|
}),
|
|
2266
2814
|
/**
|
|
2267
|
-
* @description This endpoint allows you to create a
|
|
2815
|
+
* @description This endpoint allows you to create alerts for a subscription. Send a single alert object wrapped in `alert` key to create one alert, or an array of alert objects wrapped in `alerts` key to create multiple alerts atomically.
|
|
2268
2816
|
*
|
|
2269
2817
|
* @tags subscriptions
|
|
2270
2818
|
* @name CreateSubscriptionAlert
|
|
2271
|
-
* @summary Create
|
|
2819
|
+
* @summary Create subscription alert(s)
|
|
2272
2820
|
* @request POST:/subscriptions/{external_id}/alerts
|
|
2273
2821
|
* @secure
|
|
2274
2822
|
*/
|
|
2275
|
-
createSubscriptionAlert: (externalId, data, params = {}) => this.request({
|
|
2823
|
+
createSubscriptionAlert: (externalId, data, query, params = {}) => this.request({
|
|
2276
2824
|
path: `/subscriptions/${externalId}/alerts`,
|
|
2277
2825
|
method: "POST",
|
|
2826
|
+
query: query,
|
|
2278
2827
|
body: data,
|
|
2279
2828
|
secure: true,
|
|
2280
2829
|
type: ContentType.Json,
|
|
2281
2830
|
format: "json",
|
|
2282
2831
|
...params,
|
|
2283
2832
|
}),
|
|
2833
|
+
/**
|
|
2834
|
+
* @description This endpoint allows you to delete all alerts for a subscription.
|
|
2835
|
+
*
|
|
2836
|
+
* @tags subscriptions
|
|
2837
|
+
* @name DeleteAllSubscriptionAlerts
|
|
2838
|
+
* @summary Delete all subscription alerts
|
|
2839
|
+
* @request DELETE:/subscriptions/{external_id}/alerts
|
|
2840
|
+
* @secure
|
|
2841
|
+
*/
|
|
2842
|
+
deleteAllSubscriptionAlerts: (externalId, query, params = {}) => this.request({
|
|
2843
|
+
path: `/subscriptions/${externalId}/alerts`,
|
|
2844
|
+
method: "DELETE",
|
|
2845
|
+
query: query,
|
|
2846
|
+
secure: true,
|
|
2847
|
+
...params,
|
|
2848
|
+
}),
|
|
2284
2849
|
/**
|
|
2285
2850
|
* @description This endpoint enables the retrieval of a specific alert for a subscription.
|
|
2286
2851
|
*
|
|
@@ -2290,9 +2855,10 @@ export class Api extends HttpClient {
|
|
|
2290
2855
|
* @request GET:/subscriptions/{external_id}/alerts/{code}
|
|
2291
2856
|
* @secure
|
|
2292
2857
|
*/
|
|
2293
|
-
getSubscriptionAlert: (externalId, code, params = {}) => this.request({
|
|
2858
|
+
getSubscriptionAlert: (externalId, code, query, params = {}) => this.request({
|
|
2294
2859
|
path: `/subscriptions/${externalId}/alerts/${code}`,
|
|
2295
2860
|
method: "GET",
|
|
2861
|
+
query: query,
|
|
2296
2862
|
secure: true,
|
|
2297
2863
|
format: "json",
|
|
2298
2864
|
...params,
|
|
@@ -2306,9 +2872,10 @@ export class Api extends HttpClient {
|
|
|
2306
2872
|
* @request PUT:/subscriptions/{external_id}/alerts/{code}
|
|
2307
2873
|
* @secure
|
|
2308
2874
|
*/
|
|
2309
|
-
updateSubscriptionAlert: (externalId, code, data, params = {}) => this.request({
|
|
2875
|
+
updateSubscriptionAlert: (externalId, code, data, query, params = {}) => this.request({
|
|
2310
2876
|
path: `/subscriptions/${externalId}/alerts/${code}`,
|
|
2311
2877
|
method: "PUT",
|
|
2878
|
+
query: query,
|
|
2312
2879
|
body: data,
|
|
2313
2880
|
secure: true,
|
|
2314
2881
|
type: ContentType.Json,
|
|
@@ -2324,9 +2891,10 @@ export class Api extends HttpClient {
|
|
|
2324
2891
|
* @request DELETE:/subscriptions/{external_id}/alerts/{code}
|
|
2325
2892
|
* @secure
|
|
2326
2893
|
*/
|
|
2327
|
-
deleteSubscriptionAlert: (externalId, code, params = {}) => this.request({
|
|
2894
|
+
deleteSubscriptionAlert: (externalId, code, query, params = {}) => this.request({
|
|
2328
2895
|
path: `/subscriptions/${externalId}/alerts/${code}`,
|
|
2329
2896
|
method: "DELETE",
|
|
2897
|
+
query: query,
|
|
2330
2898
|
secure: true,
|
|
2331
2899
|
format: "json",
|
|
2332
2900
|
...params,
|
|
@@ -2340,9 +2908,10 @@ export class Api extends HttpClient {
|
|
|
2340
2908
|
* @request GET:/subscriptions/{external_id}/entitlements
|
|
2341
2909
|
* @secure
|
|
2342
2910
|
*/
|
|
2343
|
-
findAllSubscriptionEntitlements: (externalId, params = {}) => this.request({
|
|
2911
|
+
findAllSubscriptionEntitlements: (externalId, query, params = {}) => this.request({
|
|
2344
2912
|
path: `/subscriptions/${externalId}/entitlements`,
|
|
2345
2913
|
method: "GET",
|
|
2914
|
+
query: query,
|
|
2346
2915
|
secure: true,
|
|
2347
2916
|
format: "json",
|
|
2348
2917
|
...params,
|
|
@@ -2356,9 +2925,10 @@ export class Api extends HttpClient {
|
|
|
2356
2925
|
* @request PATCH:/subscriptions/{external_id}/entitlements
|
|
2357
2926
|
* @secure
|
|
2358
2927
|
*/
|
|
2359
|
-
updateSubscriptionEntitlements: (externalId, data, params = {}) => this.request({
|
|
2928
|
+
updateSubscriptionEntitlements: (externalId, data, query, params = {}) => this.request({
|
|
2360
2929
|
path: `/subscriptions/${externalId}/entitlements`,
|
|
2361
2930
|
method: "PATCH",
|
|
2931
|
+
query: query,
|
|
2362
2932
|
body: data,
|
|
2363
2933
|
secure: true,
|
|
2364
2934
|
type: ContentType.Json,
|
|
@@ -2374,9 +2944,10 @@ export class Api extends HttpClient {
|
|
|
2374
2944
|
* @request DELETE:/subscriptions/{external_id}/entitlements/{feature_code}
|
|
2375
2945
|
* @secure
|
|
2376
2946
|
*/
|
|
2377
|
-
destroySubscriptionEntitlement: (externalId, featureCode, params = {}) => this.request({
|
|
2947
|
+
destroySubscriptionEntitlement: (externalId, featureCode, query, params = {}) => this.request({
|
|
2378
2948
|
path: `/subscriptions/${externalId}/entitlements/${featureCode}`,
|
|
2379
2949
|
method: "DELETE",
|
|
2950
|
+
query: query,
|
|
2380
2951
|
secure: true,
|
|
2381
2952
|
format: "json",
|
|
2382
2953
|
...params,
|
|
@@ -2390,29 +2961,209 @@ export class Api extends HttpClient {
|
|
|
2390
2961
|
* @request DELETE:/subscriptions/{external_id}/entitlements/{feature_code}/privileges/{privilege_code}
|
|
2391
2962
|
* @secure
|
|
2392
2963
|
*/
|
|
2393
|
-
destroySubscriptionEntitlementPrivilege: (externalId, featureCode, privilegeCode, params = {}) => this.request({
|
|
2964
|
+
destroySubscriptionEntitlementPrivilege: (externalId, featureCode, privilegeCode, query, params = {}) => this.request({
|
|
2394
2965
|
path: `/subscriptions/${externalId}/entitlements/${featureCode}/privileges/${privilegeCode}`,
|
|
2395
2966
|
method: "DELETE",
|
|
2967
|
+
query: query,
|
|
2396
2968
|
secure: true,
|
|
2397
2969
|
format: "json",
|
|
2398
2970
|
...params,
|
|
2399
2971
|
}),
|
|
2400
2972
|
/**
|
|
2401
|
-
* @description This endpoint retrieves all fixed charges for a specific subscription.
|
|
2973
|
+
* @description This endpoint retrieves all effective fixed charges for a specific subscription. If the subscription has plan overrides with fixed charge overrides, the overridden fixed charges are returned.
|
|
2402
2974
|
*
|
|
2403
2975
|
* @tags subscriptions
|
|
2404
2976
|
* @name FindAllSubscriptionFixedCharges
|
|
2405
|
-
* @summary List
|
|
2977
|
+
* @summary List all fixed charges for a subscription
|
|
2406
2978
|
* @request GET:/subscriptions/{external_id}/fixed_charges
|
|
2407
2979
|
* @secure
|
|
2408
2980
|
*/
|
|
2409
|
-
findAllSubscriptionFixedCharges: (externalId, params = {}) => this.request({
|
|
2981
|
+
findAllSubscriptionFixedCharges: (externalId, query, params = {}) => this.request({
|
|
2410
2982
|
path: `/subscriptions/${externalId}/fixed_charges`,
|
|
2411
2983
|
method: "GET",
|
|
2984
|
+
query: query,
|
|
2985
|
+
secure: true,
|
|
2986
|
+
format: "json",
|
|
2987
|
+
...params,
|
|
2988
|
+
}),
|
|
2989
|
+
/**
|
|
2990
|
+
* @description This endpoint retrieves all effective charges for a specific subscription. If the subscription has plan overrides with charge overrides, the overridden charges are returned.
|
|
2991
|
+
*
|
|
2992
|
+
* @tags subscriptions
|
|
2993
|
+
* @name FindAllSubscriptionCharges
|
|
2994
|
+
* @summary List all charges for a subscription
|
|
2995
|
+
* @request GET:/subscriptions/{external_id}/charges
|
|
2996
|
+
* @secure
|
|
2997
|
+
*/
|
|
2998
|
+
findAllSubscriptionCharges: (externalId, query, params = {}) => this.request({
|
|
2999
|
+
path: `/subscriptions/${externalId}/charges`,
|
|
3000
|
+
method: "GET",
|
|
3001
|
+
query: query,
|
|
3002
|
+
secure: true,
|
|
3003
|
+
format: "json",
|
|
3004
|
+
...params,
|
|
3005
|
+
}),
|
|
3006
|
+
/**
|
|
3007
|
+
* @description This endpoint retrieves a specific effective charge for a subscription. If the subscription has a plan override with a charge override, the overridden charge is returned.
|
|
3008
|
+
*
|
|
3009
|
+
* @tags subscriptions
|
|
3010
|
+
* @name FindSubscriptionCharge
|
|
3011
|
+
* @summary Retrieve a charge for a subscription
|
|
3012
|
+
* @request GET:/subscriptions/{external_id}/charges/{charge_code}
|
|
3013
|
+
* @secure
|
|
3014
|
+
*/
|
|
3015
|
+
findSubscriptionCharge: (externalId, chargeCode, query, params = {}) => this.request({
|
|
3016
|
+
path: `/subscriptions/${externalId}/charges/${chargeCode}`,
|
|
3017
|
+
method: "GET",
|
|
3018
|
+
query: query,
|
|
3019
|
+
secure: true,
|
|
3020
|
+
format: "json",
|
|
3021
|
+
...params,
|
|
3022
|
+
}),
|
|
3023
|
+
/**
|
|
3024
|
+
* @description This endpoint creates or updates a charge override for a specific subscription. If the subscription does not have a plan override yet, one will be created automatically. The charge override allows customizing specific charge properties (invoice_display_name, min_amount_cents, properties, filters, taxes, applied_pricing_unit) without affecting the original plan charge. This is a premium feature.
|
|
3025
|
+
*
|
|
3026
|
+
* @tags subscriptions
|
|
3027
|
+
* @name OverrideSubscriptionCharge
|
|
3028
|
+
* @summary Override a charge for a subscription
|
|
3029
|
+
* @request PUT:/subscriptions/{external_id}/charges/{charge_code}
|
|
3030
|
+
* @secure
|
|
3031
|
+
*/
|
|
3032
|
+
overrideSubscriptionCharge: (externalId, chargeCode, data, query, params = {}) => this.request({
|
|
3033
|
+
path: `/subscriptions/${externalId}/charges/${chargeCode}`,
|
|
3034
|
+
method: "PUT",
|
|
3035
|
+
query: query,
|
|
3036
|
+
body: data,
|
|
3037
|
+
secure: true,
|
|
3038
|
+
type: ContentType.Json,
|
|
3039
|
+
format: "json",
|
|
3040
|
+
...params,
|
|
3041
|
+
}),
|
|
3042
|
+
/**
|
|
3043
|
+
* @description This endpoint creates a new filter for a specific charge on a subscription.
|
|
3044
|
+
*
|
|
3045
|
+
* @tags subscriptions
|
|
3046
|
+
* @name CreateSubscriptionChargeFilter
|
|
3047
|
+
* @summary Create a charge filter
|
|
3048
|
+
* @request POST:/subscriptions/{external_id}/charges/{charge_code}/filters
|
|
3049
|
+
* @secure
|
|
3050
|
+
*/
|
|
3051
|
+
createSubscriptionChargeFilter: (externalId, chargeCode, data, query, params = {}) => this.request({
|
|
3052
|
+
path: `/subscriptions/${externalId}/charges/${chargeCode}/filters`,
|
|
3053
|
+
method: "POST",
|
|
3054
|
+
query: query,
|
|
3055
|
+
body: data,
|
|
3056
|
+
secure: true,
|
|
3057
|
+
type: ContentType.Json,
|
|
3058
|
+
format: "json",
|
|
3059
|
+
...params,
|
|
3060
|
+
}),
|
|
3061
|
+
/**
|
|
3062
|
+
* @description This endpoint retrieves all filters for a specific charge on a subscription.
|
|
3063
|
+
*
|
|
3064
|
+
* @tags subscriptions
|
|
3065
|
+
* @name FindAllSubscriptionChargeFilters
|
|
3066
|
+
* @summary List all filters for a charge
|
|
3067
|
+
* @request GET:/subscriptions/{external_id}/charges/{charge_code}/filters
|
|
3068
|
+
* @secure
|
|
3069
|
+
*/
|
|
3070
|
+
findAllSubscriptionChargeFilters: (externalId, chargeCode, query, params = {}) => this.request({
|
|
3071
|
+
path: `/subscriptions/${externalId}/charges/${chargeCode}/filters`,
|
|
3072
|
+
method: "GET",
|
|
3073
|
+
query: query,
|
|
3074
|
+
secure: true,
|
|
3075
|
+
format: "json",
|
|
3076
|
+
...params,
|
|
3077
|
+
}),
|
|
3078
|
+
/**
|
|
3079
|
+
* @description This endpoint retrieves a specific filter for a charge on a subscription.
|
|
3080
|
+
*
|
|
3081
|
+
* @tags subscriptions
|
|
3082
|
+
* @name FindSubscriptionChargeFilter
|
|
3083
|
+
* @summary Retrieve a charge filter
|
|
3084
|
+
* @request GET:/subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}
|
|
3085
|
+
* @secure
|
|
3086
|
+
*/
|
|
3087
|
+
findSubscriptionChargeFilter: (externalId, chargeCode, filterId, query, params = {}) => this.request({
|
|
3088
|
+
path: `/subscriptions/${externalId}/charges/${chargeCode}/filters/${filterId}`,
|
|
3089
|
+
method: "GET",
|
|
3090
|
+
query: query,
|
|
3091
|
+
secure: true,
|
|
3092
|
+
format: "json",
|
|
3093
|
+
...params,
|
|
3094
|
+
}),
|
|
3095
|
+
/**
|
|
3096
|
+
* @description This endpoint updates a specific filter for a charge on a subscription.
|
|
3097
|
+
*
|
|
3098
|
+
* @tags subscriptions
|
|
3099
|
+
* @name UpdateSubscriptionChargeFilter
|
|
3100
|
+
* @summary Update a charge filter
|
|
3101
|
+
* @request PUT:/subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}
|
|
3102
|
+
* @secure
|
|
3103
|
+
*/
|
|
3104
|
+
updateSubscriptionChargeFilter: (externalId, chargeCode, filterId, data, query, params = {}) => this.request({
|
|
3105
|
+
path: `/subscriptions/${externalId}/charges/${chargeCode}/filters/${filterId}`,
|
|
3106
|
+
method: "PUT",
|
|
3107
|
+
query: query,
|
|
3108
|
+
body: data,
|
|
3109
|
+
secure: true,
|
|
3110
|
+
type: ContentType.Json,
|
|
3111
|
+
format: "json",
|
|
3112
|
+
...params,
|
|
3113
|
+
}),
|
|
3114
|
+
/**
|
|
3115
|
+
* @description This endpoint deletes a specific filter from a charge on a subscription.
|
|
3116
|
+
*
|
|
3117
|
+
* @tags subscriptions
|
|
3118
|
+
* @name DestroySubscriptionChargeFilter
|
|
3119
|
+
* @summary Delete a charge filter
|
|
3120
|
+
* @request DELETE:/subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}
|
|
3121
|
+
* @secure
|
|
3122
|
+
*/
|
|
3123
|
+
destroySubscriptionChargeFilter: (externalId, chargeCode, filterId, query, params = {}) => this.request({
|
|
3124
|
+
path: `/subscriptions/${externalId}/charges/${chargeCode}/filters/${filterId}`,
|
|
3125
|
+
method: "DELETE",
|
|
3126
|
+
query: query,
|
|
2412
3127
|
secure: true,
|
|
2413
3128
|
format: "json",
|
|
2414
3129
|
...params,
|
|
2415
3130
|
}),
|
|
3131
|
+
/**
|
|
3132
|
+
* @description This endpoint retrieves a specific effective fixed charge for a subscription. If the subscription has a plan override with a fixed charge override, the overridden fixed charge is returned.
|
|
3133
|
+
*
|
|
3134
|
+
* @tags subscriptions
|
|
3135
|
+
* @name FindSubscriptionFixedCharge
|
|
3136
|
+
* @summary Retrieve a fixed charge for a subscription
|
|
3137
|
+
* @request GET:/subscriptions/{external_id}/fixed_charges/{fixed_charge_code}
|
|
3138
|
+
* @secure
|
|
3139
|
+
*/
|
|
3140
|
+
findSubscriptionFixedCharge: (externalId, fixedChargeCode, query, params = {}) => this.request({
|
|
3141
|
+
path: `/subscriptions/${externalId}/fixed_charges/${fixedChargeCode}`,
|
|
3142
|
+
method: "GET",
|
|
3143
|
+
query: query,
|
|
3144
|
+
secure: true,
|
|
3145
|
+
format: "json",
|
|
3146
|
+
...params,
|
|
3147
|
+
}),
|
|
3148
|
+
/**
|
|
3149
|
+
* @description This endpoint creates or updates a fixed charge override for a specific subscription. If the subscription does not have a plan override yet, one will be created automatically. The fixed charge override allows customizing specific fixed charge properties (invoice_display_name, units, properties, taxes) without affecting the original plan fixed charge. This is a premium feature.
|
|
3150
|
+
*
|
|
3151
|
+
* @tags subscriptions
|
|
3152
|
+
* @name OverrideSubscriptionFixedCharge
|
|
3153
|
+
* @summary Override a fixed charge for a subscription
|
|
3154
|
+
* @request PUT:/subscriptions/{external_id}/fixed_charges/{fixed_charge_code}
|
|
3155
|
+
* @secure
|
|
3156
|
+
*/
|
|
3157
|
+
overrideSubscriptionFixedCharge: (externalId, fixedChargeCode, data, query, params = {}) => this.request({
|
|
3158
|
+
path: `/subscriptions/${externalId}/fixed_charges/${fixedChargeCode}`,
|
|
3159
|
+
method: "PUT",
|
|
3160
|
+
query: query,
|
|
3161
|
+
body: data,
|
|
3162
|
+
secure: true,
|
|
3163
|
+
type: ContentType.Json,
|
|
3164
|
+
format: "json",
|
|
3165
|
+
...params,
|
|
3166
|
+
}),
|
|
2416
3167
|
};
|
|
2417
3168
|
taxes = {
|
|
2418
3169
|
/**
|
|
@@ -2724,6 +3475,40 @@ export class Api extends HttpClient {
|
|
|
2724
3475
|
format: "json",
|
|
2725
3476
|
...params,
|
|
2726
3477
|
}),
|
|
3478
|
+
/**
|
|
3479
|
+
* @description This endpoint is used to list all consumption records for an inbound wallet transaction. It shows how the credits from this inbound transaction were consumed by outbound transactions. Only available for traceable wallets.
|
|
3480
|
+
*
|
|
3481
|
+
* @tags wallets
|
|
3482
|
+
* @name FindAllWalletTransactionConsumptions
|
|
3483
|
+
* @summary List all consumptions for a wallet transaction
|
|
3484
|
+
* @request GET:/wallet_transactions/{lago_id}/consumptions
|
|
3485
|
+
* @secure
|
|
3486
|
+
*/
|
|
3487
|
+
findAllWalletTransactionConsumptions: (lagoId, query, params = {}) => this.request({
|
|
3488
|
+
path: `/wallet_transactions/${lagoId}/consumptions`,
|
|
3489
|
+
method: "GET",
|
|
3490
|
+
query: query,
|
|
3491
|
+
secure: true,
|
|
3492
|
+
format: "json",
|
|
3493
|
+
...params,
|
|
3494
|
+
}),
|
|
3495
|
+
/**
|
|
3496
|
+
* @description This endpoint is used to list all funding records for an outbound wallet transaction. It shows which inbound transactions funded this outbound transaction. Only available for traceable wallets.
|
|
3497
|
+
*
|
|
3498
|
+
* @tags wallets
|
|
3499
|
+
* @name FindAllWalletTransactionFundings
|
|
3500
|
+
* @summary List all fundings for a wallet transaction
|
|
3501
|
+
* @request GET:/wallet_transactions/{lago_id}/fundings
|
|
3502
|
+
* @secure
|
|
3503
|
+
*/
|
|
3504
|
+
findAllWalletTransactionFundings: (lagoId, query, params = {}) => this.request({
|
|
3505
|
+
path: `/wallet_transactions/${lagoId}/fundings`,
|
|
3506
|
+
method: "GET",
|
|
3507
|
+
query: query,
|
|
3508
|
+
secure: true,
|
|
3509
|
+
format: "json",
|
|
3510
|
+
...params,
|
|
3511
|
+
}),
|
|
2727
3512
|
};
|
|
2728
3513
|
webhooks = {
|
|
2729
3514
|
/**
|