@4players/payment 1.0.0 → 1.0.1-beta.2
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/LICENSE +21 -0
- package/README.md +272 -0
- package/dist/index.cjs +39 -9
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +413 -28
- package/dist/index.d.ts +413 -28
- package/dist/index.js +39 -9
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/dist/index.d.cts
CHANGED
|
@@ -10,8 +10,8 @@ interface paths {
|
|
|
10
10
|
path?: never;
|
|
11
11
|
cookie?: never;
|
|
12
12
|
};
|
|
13
|
-
/** Get all apps the user has access to */
|
|
14
|
-
get: operations["
|
|
13
|
+
/** Get all fleet apps the user has access to (i.a. all projects that have Fleet activated) */
|
|
14
|
+
get: operations["getFleetProjects"];
|
|
15
15
|
put?: never;
|
|
16
16
|
post?: never;
|
|
17
17
|
delete?: never;
|
|
@@ -25,13 +25,33 @@ interface paths {
|
|
|
25
25
|
query?: never;
|
|
26
26
|
header?: never;
|
|
27
27
|
path: {
|
|
28
|
-
/** @description The ID of the
|
|
28
|
+
/** @description The ID of the fleet apps project to retrieve */
|
|
29
29
|
app_id: string;
|
|
30
30
|
};
|
|
31
31
|
cookie?: never;
|
|
32
32
|
};
|
|
33
33
|
/** Get the details of the app including the payment project */
|
|
34
|
-
get: operations["
|
|
34
|
+
get: operations["getFleetProject"];
|
|
35
|
+
put?: never;
|
|
36
|
+
post?: never;
|
|
37
|
+
delete?: never;
|
|
38
|
+
options?: never;
|
|
39
|
+
head?: never;
|
|
40
|
+
patch?: never;
|
|
41
|
+
trace?: never;
|
|
42
|
+
};
|
|
43
|
+
"/projects": {
|
|
44
|
+
parameters: {
|
|
45
|
+
query?: never;
|
|
46
|
+
header?: never;
|
|
47
|
+
path?: never;
|
|
48
|
+
cookie?: never;
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
* Get all projects for the authenticated user
|
|
52
|
+
* @description Returns a list of all ODIN projects the authenticated user has access to. Can be filtered by project type.
|
|
53
|
+
*/
|
|
54
|
+
get: operations["getProjects"];
|
|
35
55
|
put?: never;
|
|
36
56
|
post?: never;
|
|
37
57
|
delete?: never;
|
|
@@ -375,6 +395,26 @@ interface paths {
|
|
|
375
395
|
patch?: never;
|
|
376
396
|
trace?: never;
|
|
377
397
|
};
|
|
398
|
+
"/projects/{projectId}/activate-api": {
|
|
399
|
+
parameters: {
|
|
400
|
+
query?: never;
|
|
401
|
+
header?: never;
|
|
402
|
+
path?: never;
|
|
403
|
+
cookie?: never;
|
|
404
|
+
};
|
|
405
|
+
get?: never;
|
|
406
|
+
put?: never;
|
|
407
|
+
/**
|
|
408
|
+
* Activate an API for the specified project
|
|
409
|
+
* @description Activates the specified API for the project, enabling access to additional features.
|
|
410
|
+
*/
|
|
411
|
+
post: operations["activateAPI"];
|
|
412
|
+
delete?: never;
|
|
413
|
+
options?: never;
|
|
414
|
+
head?: never;
|
|
415
|
+
patch?: never;
|
|
416
|
+
trace?: never;
|
|
417
|
+
};
|
|
378
418
|
"/projects/{projectId}/create-token": {
|
|
379
419
|
parameters: {
|
|
380
420
|
query?: never;
|
|
@@ -484,14 +524,23 @@ interface components {
|
|
|
484
524
|
*/
|
|
485
525
|
UserStatus: "active" | "pending" | "revoked";
|
|
486
526
|
/**
|
|
487
|
-
* @description The role of the user within the project.
|
|
527
|
+
* @description The role of the user within the project. Admin has full access to the project including managing users. Maintainer has rfull read-write access to the project but cannot manage users. Developer has read access to the project but cannot manage users and cannot create certain resources in the project.
|
|
488
528
|
* @enum {string}
|
|
489
529
|
*/
|
|
490
|
-
PermissionRole: "
|
|
530
|
+
PermissionRole: "admin" | "maintainer" | "developer";
|
|
491
531
|
SuccessResponse: {
|
|
492
532
|
/** @description Indicates whether the operation was successful. */
|
|
493
533
|
success?: boolean;
|
|
494
534
|
};
|
|
535
|
+
UnauthorizedResponse: {
|
|
536
|
+
error?: components["schemas"]["Error"];
|
|
537
|
+
};
|
|
538
|
+
Error: {
|
|
539
|
+
/** @description The error message. */
|
|
540
|
+
message?: string;
|
|
541
|
+
/** @description The error code. */
|
|
542
|
+
code?: number;
|
|
543
|
+
};
|
|
495
544
|
ChangeUserRolePayload: {
|
|
496
545
|
/** @description The id of the user permission to change */
|
|
497
546
|
projectPermissionId: string;
|
|
@@ -515,6 +564,10 @@ interface components {
|
|
|
515
564
|
/** @description The billing state to be set for the project. This determines the billing plan and associated features. */
|
|
516
565
|
billingState: components["schemas"]["BillingState"];
|
|
517
566
|
};
|
|
567
|
+
ActivateAPIPayload: {
|
|
568
|
+
/** @description The slug of the API to activate for the project. */
|
|
569
|
+
api: string;
|
|
570
|
+
};
|
|
518
571
|
EditProjectPayload: {
|
|
519
572
|
/** @description The new name for the project. */
|
|
520
573
|
name?: string;
|
|
@@ -563,8 +616,7 @@ interface components {
|
|
|
563
616
|
/** @description A list of access keys associated with the project. */
|
|
564
617
|
accessKeys?: components["schemas"]["OdinAccessKey"][];
|
|
565
618
|
subscription?: components["schemas"]["Subscription"];
|
|
566
|
-
|
|
567
|
-
role?: string;
|
|
619
|
+
role?: components["schemas"]["PermissionRole"];
|
|
568
620
|
permissions?: components["schemas"]["OdinUserPermissions"];
|
|
569
621
|
/** @description A list of users associated with the project. */
|
|
570
622
|
users?: components["schemas"]["OdinUserRole"][];
|
|
@@ -951,7 +1003,7 @@ interface components {
|
|
|
951
1003
|
pathItems: never;
|
|
952
1004
|
}
|
|
953
1005
|
interface operations {
|
|
954
|
-
|
|
1006
|
+
getFleetProjects: {
|
|
955
1007
|
parameters: {
|
|
956
1008
|
query?: never;
|
|
957
1009
|
header?: never;
|
|
@@ -960,7 +1012,7 @@ interface operations {
|
|
|
960
1012
|
};
|
|
961
1013
|
requestBody?: never;
|
|
962
1014
|
responses: {
|
|
963
|
-
/** @description A list of
|
|
1015
|
+
/** @description A list of projects with a Fleet App ID and an error envelope. */
|
|
964
1016
|
200: {
|
|
965
1017
|
headers: {
|
|
966
1018
|
[name: string]: unknown;
|
|
@@ -969,14 +1021,23 @@ interface operations {
|
|
|
969
1021
|
"application/json": components["schemas"]["PaymentProject"][];
|
|
970
1022
|
};
|
|
971
1023
|
};
|
|
1024
|
+
/** @description Unauthorized – authentication required */
|
|
1025
|
+
401: {
|
|
1026
|
+
headers: {
|
|
1027
|
+
[name: string]: unknown;
|
|
1028
|
+
};
|
|
1029
|
+
content: {
|
|
1030
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1031
|
+
};
|
|
1032
|
+
};
|
|
972
1033
|
};
|
|
973
1034
|
};
|
|
974
|
-
|
|
1035
|
+
getFleetProject: {
|
|
975
1036
|
parameters: {
|
|
976
1037
|
query?: never;
|
|
977
1038
|
header?: never;
|
|
978
1039
|
path: {
|
|
979
|
-
/** @description The ID of the
|
|
1040
|
+
/** @description The ID of the fleet apps project to retrieve */
|
|
980
1041
|
app_id: string;
|
|
981
1042
|
};
|
|
982
1043
|
cookie?: never;
|
|
@@ -992,6 +1053,68 @@ interface operations {
|
|
|
992
1053
|
"application/json": components["schemas"]["PaymentProject"];
|
|
993
1054
|
};
|
|
994
1055
|
};
|
|
1056
|
+
/** @description Unauthorized – authentication required */
|
|
1057
|
+
401: {
|
|
1058
|
+
headers: {
|
|
1059
|
+
[name: string]: unknown;
|
|
1060
|
+
};
|
|
1061
|
+
content: {
|
|
1062
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1063
|
+
};
|
|
1064
|
+
};
|
|
1065
|
+
};
|
|
1066
|
+
};
|
|
1067
|
+
getProjects: {
|
|
1068
|
+
parameters: {
|
|
1069
|
+
query?: {
|
|
1070
|
+
/**
|
|
1071
|
+
* @description Filter projects by type. If not specified or empty, all projects are returned.
|
|
1072
|
+
* - `sdk`: Returns only SDK-based ODIN projects
|
|
1073
|
+
* - `conferencing`: Returns only conferencing/Rooms projects
|
|
1074
|
+
* - `app`: Returns only Fleet app projects
|
|
1075
|
+
*/
|
|
1076
|
+
type?: "" | "sdk" | "conferencing" | "app";
|
|
1077
|
+
};
|
|
1078
|
+
header?: never;
|
|
1079
|
+
path?: never;
|
|
1080
|
+
cookie?: never;
|
|
1081
|
+
};
|
|
1082
|
+
requestBody?: never;
|
|
1083
|
+
responses: {
|
|
1084
|
+
/** @description A list of projects the user has access to. */
|
|
1085
|
+
200: {
|
|
1086
|
+
headers: {
|
|
1087
|
+
[name: string]: unknown;
|
|
1088
|
+
};
|
|
1089
|
+
content: {
|
|
1090
|
+
"application/json": components["schemas"]["PaymentProject"][];
|
|
1091
|
+
};
|
|
1092
|
+
};
|
|
1093
|
+
/** @description Bad request – invalid type parameter */
|
|
1094
|
+
400: {
|
|
1095
|
+
headers: {
|
|
1096
|
+
[name: string]: unknown;
|
|
1097
|
+
};
|
|
1098
|
+
content: {
|
|
1099
|
+
"application/json": {
|
|
1100
|
+
error?: {
|
|
1101
|
+
/** @example Invalid type, must be empty (all projects), sdk or conferencing */
|
|
1102
|
+
message?: string;
|
|
1103
|
+
/** @example 1002 */
|
|
1104
|
+
code?: number;
|
|
1105
|
+
};
|
|
1106
|
+
};
|
|
1107
|
+
};
|
|
1108
|
+
};
|
|
1109
|
+
/** @description Unauthorized – authentication required */
|
|
1110
|
+
401: {
|
|
1111
|
+
headers: {
|
|
1112
|
+
[name: string]: unknown;
|
|
1113
|
+
};
|
|
1114
|
+
content: {
|
|
1115
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1116
|
+
};
|
|
1117
|
+
};
|
|
995
1118
|
};
|
|
996
1119
|
};
|
|
997
1120
|
getPeersOverTime: {
|
|
@@ -1018,6 +1141,15 @@ interface operations {
|
|
|
1018
1141
|
"application/json": components["schemas"]["OdinPeersOverTime"];
|
|
1019
1142
|
};
|
|
1020
1143
|
};
|
|
1144
|
+
/** @description Unauthorized – authentication required */
|
|
1145
|
+
401: {
|
|
1146
|
+
headers: {
|
|
1147
|
+
[name: string]: unknown;
|
|
1148
|
+
};
|
|
1149
|
+
content: {
|
|
1150
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1151
|
+
};
|
|
1152
|
+
};
|
|
1021
1153
|
};
|
|
1022
1154
|
};
|
|
1023
1155
|
createSetupSession: {
|
|
@@ -1065,9 +1197,7 @@ interface operations {
|
|
|
1065
1197
|
[name: string]: unknown;
|
|
1066
1198
|
};
|
|
1067
1199
|
content: {
|
|
1068
|
-
"application/json":
|
|
1069
|
-
error?: string;
|
|
1070
|
-
};
|
|
1200
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1071
1201
|
};
|
|
1072
1202
|
};
|
|
1073
1203
|
};
|
|
@@ -1090,6 +1220,15 @@ interface operations {
|
|
|
1090
1220
|
"application/json": components["schemas"]["BillingAccount"][];
|
|
1091
1221
|
};
|
|
1092
1222
|
};
|
|
1223
|
+
/** @description Unauthorized – authentication required */
|
|
1224
|
+
401: {
|
|
1225
|
+
headers: {
|
|
1226
|
+
[name: string]: unknown;
|
|
1227
|
+
};
|
|
1228
|
+
content: {
|
|
1229
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1230
|
+
};
|
|
1231
|
+
};
|
|
1093
1232
|
};
|
|
1094
1233
|
};
|
|
1095
1234
|
getBillingAccount: {
|
|
@@ -1113,6 +1252,15 @@ interface operations {
|
|
|
1113
1252
|
"application/json": components["schemas"]["BillingAccount"];
|
|
1114
1253
|
};
|
|
1115
1254
|
};
|
|
1255
|
+
/** @description Unauthorized – authentication required */
|
|
1256
|
+
401: {
|
|
1257
|
+
headers: {
|
|
1258
|
+
[name: string]: unknown;
|
|
1259
|
+
};
|
|
1260
|
+
content: {
|
|
1261
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1262
|
+
};
|
|
1263
|
+
};
|
|
1116
1264
|
/** @description The billing account could not be found. */
|
|
1117
1265
|
404: {
|
|
1118
1266
|
headers: {
|
|
@@ -1169,9 +1317,7 @@ interface operations {
|
|
|
1169
1317
|
[name: string]: unknown;
|
|
1170
1318
|
};
|
|
1171
1319
|
content: {
|
|
1172
|
-
"application/json":
|
|
1173
|
-
error?: string;
|
|
1174
|
-
};
|
|
1320
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1175
1321
|
};
|
|
1176
1322
|
};
|
|
1177
1323
|
};
|
|
@@ -1197,6 +1343,15 @@ interface operations {
|
|
|
1197
1343
|
"application/json": components["schemas"]["Invoice"][];
|
|
1198
1344
|
};
|
|
1199
1345
|
};
|
|
1346
|
+
/** @description Unauthorized – authentication required */
|
|
1347
|
+
401: {
|
|
1348
|
+
headers: {
|
|
1349
|
+
[name: string]: unknown;
|
|
1350
|
+
};
|
|
1351
|
+
content: {
|
|
1352
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1353
|
+
};
|
|
1354
|
+
};
|
|
1200
1355
|
};
|
|
1201
1356
|
};
|
|
1202
1357
|
getProject: {
|
|
@@ -1220,6 +1375,15 @@ interface operations {
|
|
|
1220
1375
|
"application/json": components["schemas"]["PaymentProject"];
|
|
1221
1376
|
};
|
|
1222
1377
|
};
|
|
1378
|
+
/** @description Unauthorized – authentication required */
|
|
1379
|
+
401: {
|
|
1380
|
+
headers: {
|
|
1381
|
+
[name: string]: unknown;
|
|
1382
|
+
};
|
|
1383
|
+
content: {
|
|
1384
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1385
|
+
};
|
|
1386
|
+
};
|
|
1223
1387
|
/** @description The project could not be found. */
|
|
1224
1388
|
404: {
|
|
1225
1389
|
headers: {
|
|
@@ -1261,6 +1425,15 @@ interface operations {
|
|
|
1261
1425
|
};
|
|
1262
1426
|
content?: never;
|
|
1263
1427
|
};
|
|
1428
|
+
/** @description Unauthorized – authentication required */
|
|
1429
|
+
401: {
|
|
1430
|
+
headers: {
|
|
1431
|
+
[name: string]: unknown;
|
|
1432
|
+
};
|
|
1433
|
+
content: {
|
|
1434
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1435
|
+
};
|
|
1436
|
+
};
|
|
1264
1437
|
/** @description Forbidden, e.g., the user does not have permission to edit the specified project. */
|
|
1265
1438
|
403: {
|
|
1266
1439
|
headers: {
|
|
@@ -1298,6 +1471,15 @@ interface operations {
|
|
|
1298
1471
|
"application/json": components["schemas"]["OdinAccessKey"];
|
|
1299
1472
|
};
|
|
1300
1473
|
};
|
|
1474
|
+
/** @description Unauthorized – authentication required */
|
|
1475
|
+
401: {
|
|
1476
|
+
headers: {
|
|
1477
|
+
[name: string]: unknown;
|
|
1478
|
+
};
|
|
1479
|
+
content: {
|
|
1480
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1481
|
+
};
|
|
1482
|
+
};
|
|
1301
1483
|
/** @description The access key could not be found. */
|
|
1302
1484
|
404: {
|
|
1303
1485
|
headers: {
|
|
@@ -1339,6 +1521,15 @@ interface operations {
|
|
|
1339
1521
|
};
|
|
1340
1522
|
content?: never;
|
|
1341
1523
|
};
|
|
1524
|
+
/** @description Unauthorized – authentication required */
|
|
1525
|
+
401: {
|
|
1526
|
+
headers: {
|
|
1527
|
+
[name: string]: unknown;
|
|
1528
|
+
};
|
|
1529
|
+
content: {
|
|
1530
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1531
|
+
};
|
|
1532
|
+
};
|
|
1342
1533
|
/** @description Forbidden, e.g., the user does not have permission to edit the specified access key. */
|
|
1343
1534
|
403: {
|
|
1344
1535
|
headers: {
|
|
@@ -1376,6 +1567,15 @@ interface operations {
|
|
|
1376
1567
|
"application/json": components["schemas"]["SuccessResponse"];
|
|
1377
1568
|
};
|
|
1378
1569
|
};
|
|
1570
|
+
/** @description Unauthorized – authentication required */
|
|
1571
|
+
401: {
|
|
1572
|
+
headers: {
|
|
1573
|
+
[name: string]: unknown;
|
|
1574
|
+
};
|
|
1575
|
+
content: {
|
|
1576
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1577
|
+
};
|
|
1578
|
+
};
|
|
1379
1579
|
/** @description Forbidden, e.g., the user does not have permission to delete the specified access key. */
|
|
1380
1580
|
403: {
|
|
1381
1581
|
headers: {
|
|
@@ -1421,6 +1621,15 @@ interface operations {
|
|
|
1421
1621
|
};
|
|
1422
1622
|
content?: never;
|
|
1423
1623
|
};
|
|
1624
|
+
/** @description Unauthorized – authentication required */
|
|
1625
|
+
401: {
|
|
1626
|
+
headers: {
|
|
1627
|
+
[name: string]: unknown;
|
|
1628
|
+
};
|
|
1629
|
+
content: {
|
|
1630
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1631
|
+
};
|
|
1632
|
+
};
|
|
1424
1633
|
/** @description Forbidden, e.g., the user does not have permission to create an access key for the specified project. */
|
|
1425
1634
|
403: {
|
|
1426
1635
|
headers: {
|
|
@@ -1455,6 +1664,15 @@ interface operations {
|
|
|
1455
1664
|
"application/json": components["schemas"]["Invoice"][];
|
|
1456
1665
|
};
|
|
1457
1666
|
};
|
|
1667
|
+
/** @description Unauthorized – authentication required */
|
|
1668
|
+
401: {
|
|
1669
|
+
headers: {
|
|
1670
|
+
[name: string]: unknown;
|
|
1671
|
+
};
|
|
1672
|
+
content: {
|
|
1673
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1674
|
+
};
|
|
1675
|
+
};
|
|
1458
1676
|
};
|
|
1459
1677
|
};
|
|
1460
1678
|
addProjectMember: {
|
|
@@ -1489,6 +1707,15 @@ interface operations {
|
|
|
1489
1707
|
};
|
|
1490
1708
|
content?: never;
|
|
1491
1709
|
};
|
|
1710
|
+
/** @description Unauthorized – authentication required */
|
|
1711
|
+
401: {
|
|
1712
|
+
headers: {
|
|
1713
|
+
[name: string]: unknown;
|
|
1714
|
+
};
|
|
1715
|
+
content: {
|
|
1716
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1717
|
+
};
|
|
1718
|
+
};
|
|
1492
1719
|
/** @description Forbidden, e.g., the user does not have permission to add users to the specified project. */
|
|
1493
1720
|
403: {
|
|
1494
1721
|
headers: {
|
|
@@ -1537,6 +1764,15 @@ interface operations {
|
|
|
1537
1764
|
};
|
|
1538
1765
|
content?: never;
|
|
1539
1766
|
};
|
|
1767
|
+
/** @description Unauthorized – authentication required */
|
|
1768
|
+
401: {
|
|
1769
|
+
headers: {
|
|
1770
|
+
[name: string]: unknown;
|
|
1771
|
+
};
|
|
1772
|
+
content: {
|
|
1773
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1774
|
+
};
|
|
1775
|
+
};
|
|
1540
1776
|
/** @description Forbidden, e.g., the user does not have permission to add users to the specified project. */
|
|
1541
1777
|
403: {
|
|
1542
1778
|
headers: {
|
|
@@ -1585,6 +1821,15 @@ interface operations {
|
|
|
1585
1821
|
};
|
|
1586
1822
|
content?: never;
|
|
1587
1823
|
};
|
|
1824
|
+
/** @description Unauthorized – authentication required */
|
|
1825
|
+
401: {
|
|
1826
|
+
headers: {
|
|
1827
|
+
[name: string]: unknown;
|
|
1828
|
+
};
|
|
1829
|
+
content: {
|
|
1830
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1831
|
+
};
|
|
1832
|
+
};
|
|
1588
1833
|
/** @description Forbidden, e.g., the user does not have permission to add users to the specified project. */
|
|
1589
1834
|
403: {
|
|
1590
1835
|
headers: {
|
|
@@ -1633,6 +1878,15 @@ interface operations {
|
|
|
1633
1878
|
};
|
|
1634
1879
|
content?: never;
|
|
1635
1880
|
};
|
|
1881
|
+
/** @description Unauthorized – authentication required */
|
|
1882
|
+
401: {
|
|
1883
|
+
headers: {
|
|
1884
|
+
[name: string]: unknown;
|
|
1885
|
+
};
|
|
1886
|
+
content: {
|
|
1887
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1888
|
+
};
|
|
1889
|
+
};
|
|
1636
1890
|
/** @description Forbidden, e.g., the user does not have permission to add users to the specified project. */
|
|
1637
1891
|
403: {
|
|
1638
1892
|
headers: {
|
|
@@ -1669,6 +1923,15 @@ interface operations {
|
|
|
1669
1923
|
"application/json": components["schemas"]["BillingOptions"];
|
|
1670
1924
|
};
|
|
1671
1925
|
};
|
|
1926
|
+
/** @description Unauthorized – authentication required */
|
|
1927
|
+
401: {
|
|
1928
|
+
headers: {
|
|
1929
|
+
[name: string]: unknown;
|
|
1930
|
+
};
|
|
1931
|
+
content: {
|
|
1932
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1933
|
+
};
|
|
1934
|
+
};
|
|
1672
1935
|
};
|
|
1673
1936
|
};
|
|
1674
1937
|
cancelBilling: {
|
|
@@ -1699,6 +1962,15 @@ interface operations {
|
|
|
1699
1962
|
};
|
|
1700
1963
|
content?: never;
|
|
1701
1964
|
};
|
|
1965
|
+
/** @description Unauthorized – authentication required */
|
|
1966
|
+
401: {
|
|
1967
|
+
headers: {
|
|
1968
|
+
[name: string]: unknown;
|
|
1969
|
+
};
|
|
1970
|
+
content: {
|
|
1971
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
1972
|
+
};
|
|
1973
|
+
};
|
|
1702
1974
|
/** @description Forbidden, e.g., the user does not have permission to add users to the specified project. */
|
|
1703
1975
|
403: {
|
|
1704
1976
|
headers: {
|
|
@@ -1715,6 +1987,56 @@ interface operations {
|
|
|
1715
1987
|
};
|
|
1716
1988
|
};
|
|
1717
1989
|
};
|
|
1990
|
+
activateAPI: {
|
|
1991
|
+
parameters: {
|
|
1992
|
+
query?: never;
|
|
1993
|
+
header?: never;
|
|
1994
|
+
path: {
|
|
1995
|
+
/** @description The unique identifier of the project. */
|
|
1996
|
+
projectId: string;
|
|
1997
|
+
};
|
|
1998
|
+
cookie?: never;
|
|
1999
|
+
};
|
|
2000
|
+
requestBody: {
|
|
2001
|
+
content: {
|
|
2002
|
+
"application/json": components["schemas"]["ActivateAPIPayload"];
|
|
2003
|
+
};
|
|
2004
|
+
};
|
|
2005
|
+
responses: {
|
|
2006
|
+
/** @description Successfully activated the API for the project. */
|
|
2007
|
+
200: {
|
|
2008
|
+
headers: {
|
|
2009
|
+
[name: string]: unknown;
|
|
2010
|
+
};
|
|
2011
|
+
content: {
|
|
2012
|
+
"application/json": components["schemas"]["SuccessResponse"];
|
|
2013
|
+
};
|
|
2014
|
+
};
|
|
2015
|
+
/** @description Bad request, e.g., missing api field or invalid input data. */
|
|
2016
|
+
400: {
|
|
2017
|
+
headers: {
|
|
2018
|
+
[name: string]: unknown;
|
|
2019
|
+
};
|
|
2020
|
+
content?: never;
|
|
2021
|
+
};
|
|
2022
|
+
/** @description Unauthorized – authentication required */
|
|
2023
|
+
401: {
|
|
2024
|
+
headers: {
|
|
2025
|
+
[name: string]: unknown;
|
|
2026
|
+
};
|
|
2027
|
+
content: {
|
|
2028
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
2029
|
+
};
|
|
2030
|
+
};
|
|
2031
|
+
/** @description The project could not be found or does not exist. */
|
|
2032
|
+
404: {
|
|
2033
|
+
headers: {
|
|
2034
|
+
[name: string]: unknown;
|
|
2035
|
+
};
|
|
2036
|
+
content?: never;
|
|
2037
|
+
};
|
|
2038
|
+
};
|
|
2039
|
+
};
|
|
1718
2040
|
createAccessToken: {
|
|
1719
2041
|
parameters: {
|
|
1720
2042
|
query?: never;
|
|
@@ -1747,6 +2069,15 @@ interface operations {
|
|
|
1747
2069
|
};
|
|
1748
2070
|
content?: never;
|
|
1749
2071
|
};
|
|
2072
|
+
/** @description Unauthorized – authentication required */
|
|
2073
|
+
401: {
|
|
2074
|
+
headers: {
|
|
2075
|
+
[name: string]: unknown;
|
|
2076
|
+
};
|
|
2077
|
+
content: {
|
|
2078
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
2079
|
+
};
|
|
2080
|
+
};
|
|
1750
2081
|
/** @description The project could not be found or does not exist. */
|
|
1751
2082
|
404: {
|
|
1752
2083
|
headers: {
|
|
@@ -1784,6 +2115,15 @@ interface operations {
|
|
|
1784
2115
|
};
|
|
1785
2116
|
content?: never;
|
|
1786
2117
|
};
|
|
2118
|
+
/** @description Unauthorized – authentication required */
|
|
2119
|
+
401: {
|
|
2120
|
+
headers: {
|
|
2121
|
+
[name: string]: unknown;
|
|
2122
|
+
};
|
|
2123
|
+
content: {
|
|
2124
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
2125
|
+
};
|
|
2126
|
+
};
|
|
1787
2127
|
/** @description Forbidden, e.g., the user does not have permission to add users to the specified project. */
|
|
1788
2128
|
403: {
|
|
1789
2129
|
headers: {
|
|
@@ -1828,6 +2168,15 @@ interface operations {
|
|
|
1828
2168
|
};
|
|
1829
2169
|
content?: never;
|
|
1830
2170
|
};
|
|
2171
|
+
/** @description Unauthorized – authentication required */
|
|
2172
|
+
401: {
|
|
2173
|
+
headers: {
|
|
2174
|
+
[name: string]: unknown;
|
|
2175
|
+
};
|
|
2176
|
+
content: {
|
|
2177
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
2178
|
+
};
|
|
2179
|
+
};
|
|
1831
2180
|
/** @description Forbidden, e.g., the user does not have permission to add users to the specified project. */
|
|
1832
2181
|
403: {
|
|
1833
2182
|
headers: {
|
|
@@ -1876,6 +2225,15 @@ interface operations {
|
|
|
1876
2225
|
};
|
|
1877
2226
|
content?: never;
|
|
1878
2227
|
};
|
|
2228
|
+
/** @description Unauthorized – authentication required */
|
|
2229
|
+
401: {
|
|
2230
|
+
headers: {
|
|
2231
|
+
[name: string]: unknown;
|
|
2232
|
+
};
|
|
2233
|
+
content: {
|
|
2234
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
2235
|
+
};
|
|
2236
|
+
};
|
|
1879
2237
|
/** @description Forbidden, e.g., the user does not have permission to add users to the specified project. */
|
|
1880
2238
|
403: {
|
|
1881
2239
|
headers: {
|
|
@@ -1924,6 +2282,15 @@ interface operations {
|
|
|
1924
2282
|
};
|
|
1925
2283
|
content?: never;
|
|
1926
2284
|
};
|
|
2285
|
+
/** @description Unauthorized – authentication required */
|
|
2286
|
+
401: {
|
|
2287
|
+
headers: {
|
|
2288
|
+
[name: string]: unknown;
|
|
2289
|
+
};
|
|
2290
|
+
content: {
|
|
2291
|
+
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
2292
|
+
};
|
|
2293
|
+
};
|
|
1927
2294
|
/** @description Forbidden, e.g., the user does not have permission to add users to the specified project. */
|
|
1928
2295
|
403: {
|
|
1929
2296
|
headers: {
|
|
@@ -1954,7 +2321,7 @@ interface operations {
|
|
|
1954
2321
|
*
|
|
1955
2322
|
* const client = new PaymentClient({ sessionId: 'your-session-id' });
|
|
1956
2323
|
*
|
|
1957
|
-
* const projects = await client.
|
|
2324
|
+
* const projects = await client.getProjects();
|
|
1958
2325
|
* ```
|
|
1959
2326
|
*/
|
|
1960
2327
|
|
|
@@ -1993,6 +2360,7 @@ type BillingState = components["schemas"]["BillingState"];
|
|
|
1993
2360
|
type PermissionRole = components["schemas"]["PermissionRole"];
|
|
1994
2361
|
type UserStatus = components["schemas"]["UserStatus"];
|
|
1995
2362
|
type InvoiceStatus = components["schemas"]["InvoiceStatus"];
|
|
2363
|
+
type ActivateAPIPayload = components["schemas"]["ActivateAPIPayload"];
|
|
1996
2364
|
type AddUserToProjectPayload = components["schemas"]["AddUserToProjectPayload"];
|
|
1997
2365
|
type ChangeUserRolePayload = components["schemas"]["ChangeUserRolePayload"];
|
|
1998
2366
|
type CreateAccessKeyPayload = components["schemas"]["CreateAccessKeyPayload"];
|
|
@@ -2005,10 +2373,12 @@ type ResourcePackagePricePayload = components["schemas"]["ResourcePackagePricePa
|
|
|
2005
2373
|
type ResourcePackagePricesPayload = components["schemas"]["ResourcePackagePricesPayload"];
|
|
2006
2374
|
type RevokeUserPayload = components["schemas"]["RevokeUserPayload"];
|
|
2007
2375
|
type SetBillingAccountPayload = components["schemas"]["SetBillingAccountPayload"];
|
|
2376
|
+
type GetProjectsQuery = operations["getProjects"]["parameters"]["query"];
|
|
2008
2377
|
type GetPeersOverTimeQuery = operations["getPeersOverTime"]["parameters"]["query"];
|
|
2009
2378
|
type GetInvoicesQuery = operations["getInvoices"]["parameters"]["query"];
|
|
2010
|
-
type
|
|
2011
|
-
type
|
|
2379
|
+
type GetFleetProjectsResponse = operations["getFleetProjects"]["responses"]["200"]["content"]["application/json"];
|
|
2380
|
+
type GetFleetProjectResponse = operations["getFleetProject"]["responses"]["200"]["content"]["application/json"];
|
|
2381
|
+
type GetProjectsResponse = operations["getProjects"]["responses"]["200"]["content"]["application/json"];
|
|
2012
2382
|
type GetPeersOverTimeResponse = operations["getPeersOverTime"]["responses"]["200"]["content"]["application/json"];
|
|
2013
2383
|
type GetBillingAccountsResponse = operations["getBillingAccounts"]["responses"]["200"]["content"]["application/json"];
|
|
2014
2384
|
type GetBillingAccountResponse = operations["getBillingAccount"]["responses"]["200"]["content"]["application/json"];
|
|
@@ -2056,18 +2426,25 @@ declare class PaymentClient {
|
|
|
2056
2426
|
private createEnvelopeMiddleware;
|
|
2057
2427
|
private handleError;
|
|
2058
2428
|
/**
|
|
2059
|
-
* Get all
|
|
2429
|
+
* Get all fleet apps the user has access to (projects with Fleet activated).
|
|
2060
2430
|
*
|
|
2061
|
-
* @returns Array of payment projects
|
|
2431
|
+
* @returns Array of payment projects with Fleet app IDs
|
|
2062
2432
|
*/
|
|
2063
|
-
|
|
2433
|
+
getFleetProjects(): Promise<GetFleetProjectsResponse>;
|
|
2064
2434
|
/**
|
|
2065
|
-
* Get the details of a specific app including the payment project.
|
|
2435
|
+
* Get the details of a specific fleet app including the payment project.
|
|
2066
2436
|
*
|
|
2067
|
-
* @param appId - The ID of the app to retrieve
|
|
2437
|
+
* @param appId - The ID of the fleet app to retrieve
|
|
2068
2438
|
* @returns Payment project details
|
|
2069
2439
|
*/
|
|
2070
|
-
|
|
2440
|
+
getFleetProject(appId: string): Promise<GetFleetProjectResponse>;
|
|
2441
|
+
/**
|
|
2442
|
+
* Get all projects the authenticated user has access to.
|
|
2443
|
+
*
|
|
2444
|
+
* @param query - Optional query parameters to filter by project type
|
|
2445
|
+
* @returns Array of payment projects
|
|
2446
|
+
*/
|
|
2447
|
+
getProjects(query?: GetProjectsQuery): Promise<GetProjectsResponse>;
|
|
2071
2448
|
/**
|
|
2072
2449
|
* Get a specific project by ID.
|
|
2073
2450
|
*
|
|
@@ -2148,6 +2525,14 @@ declare class PaymentClient {
|
|
|
2148
2525
|
* @returns Success response
|
|
2149
2526
|
*/
|
|
2150
2527
|
cancelBilling(projectId: string): Promise<SuccessResponse>;
|
|
2528
|
+
/**
|
|
2529
|
+
* Activate an API for the specified project.
|
|
2530
|
+
*
|
|
2531
|
+
* @param projectId - The unique identifier of the project
|
|
2532
|
+
* @param body - The API slug to activate
|
|
2533
|
+
* @returns Success response
|
|
2534
|
+
*/
|
|
2535
|
+
activateAPI(projectId: string, body: ActivateAPIPayload): Promise<SuccessResponse>;
|
|
2151
2536
|
/**
|
|
2152
2537
|
* Get all invoices for the current user, optionally filtered by ID.
|
|
2153
2538
|
*
|
|
@@ -2315,4 +2700,4 @@ declare class PaymentRateLimitError extends PaymentError {
|
|
|
2315
2700
|
constructor(retryAfter?: number);
|
|
2316
2701
|
}
|
|
2317
2702
|
|
|
2318
|
-
export { type AddUserToProjectPayload, type BillingAccount, type BillingChangeOptions, type BillingOptions, type BillingState, type BillingStateHistory, type ChangeUserRolePayload, type CreateAccessKeyPayload, type CreateAccessKeyResponse, type CreateAccessTokenResponse, type CreateBillingPortalSessionPayload, type CreateBillingPortalSessionResponse, type CreateSetupSessionPayload, type CreateSetupSessionResponse, type CreateTokenPayload, type EditAccessKeyPayload, type EditProjectPayload, type GetAccessKeyResponse, type GetBillingAccountInvoicesResponse, type GetBillingAccountResponse, type GetBillingAccountsResponse, type GetBillingOptionsResponse, type
|
|
2703
|
+
export { type ActivateAPIPayload, type AddUserToProjectPayload, type BillingAccount, type BillingChangeOptions, type BillingOptions, type BillingState, type BillingStateHistory, type ChangeUserRolePayload, type CreateAccessKeyPayload, type CreateAccessKeyResponse, type CreateAccessTokenResponse, type CreateBillingPortalSessionPayload, type CreateBillingPortalSessionResponse, type CreateSetupSessionPayload, type CreateSetupSessionResponse, type CreateTokenPayload, type EditAccessKeyPayload, type EditProjectPayload, type GetAccessKeyResponse, type GetBillingAccountInvoicesResponse, type GetBillingAccountResponse, type GetBillingAccountsResponse, type GetBillingOptionsResponse, type GetFleetProjectResponse, type GetFleetProjectsResponse, type GetInvoicePreviewResponse, type GetInvoicesQuery, type GetInvoicesResponse, type GetPeersOverTimeQuery, type GetPeersOverTimeResponse, type GetProjectResponse, type GetProjectsQuery, type GetProjectsResponse, type Invoice, type InvoicePosition, type InvoiceStatus, type Invoices, type OdinAccessKey, type OdinPeersOverTime, type OdinUserPermissions, type OdinUserRole, PaymentApiError, PaymentAuthError, PaymentClient, type PaymentClientConfig, PaymentError, PaymentNotFoundError, type PaymentProject, PaymentRateLimitError, PaymentValidationError, type PermissionRole, type PortalSession, type ResourcePackagePrice, type ResourcePackagePricePayload, type ResourcePackagePricesPayload, type RevokeUserPayload, type SetBillingAccountPayload, type SetupSession, type Subscription, type SubscriptionPosition, type SuccessResponse, type TariffParams, type TokenPayload, type UserStatus, type components, PaymentClient as default, type operations, type paths };
|