@accelbyte/sdk-ams 0.0.0-dev-20240906023252 → 0.0.0-dev-20240910111050
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/dist/{FleetClaimResponse-CS_GmAA_.d.cts → FleetClaimResponse-D9jxThLx.d.cts} +5 -0
- package/dist/{FleetClaimResponse-CS_GmAA_.d.ts → FleetClaimResponse-D9jxThLx.d.ts} +5 -0
- package/dist/all-query-imports.cjs +124 -0
- package/dist/all-query-imports.d.cts +1 -1
- package/dist/all-query-imports.d.ts +1 -1
- package/dist/all-query-imports.js +1 -1
- package/dist/{chunk-5DT3PMPA.js → chunk-M6F62AGQ.js} +124 -0
- package/dist/index.cjs +124 -0
- package/dist/index.d.cts +127 -1
- package/dist/index.d.ts +127 -1
- package/dist/index.js +1 -1
- package/package.json +5 -4
package/dist/index.cjs
CHANGED
|
@@ -239,9 +239,21 @@ function AccountAdminApi(sdk, args) {
|
|
|
239
239
|
return resp.response;
|
|
240
240
|
}
|
|
241
241
|
return {
|
|
242
|
+
/**
|
|
243
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
|
|
244
|
+
*/
|
|
242
245
|
getAccount,
|
|
246
|
+
/**
|
|
247
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
|
|
248
|
+
*/
|
|
243
249
|
createAccount,
|
|
250
|
+
/**
|
|
251
|
+
* The link token returned can be used to connect another namespace to the account in which the provided namespace is linked. This route fails if there is no account linked to the specified namespace. Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
|
|
252
|
+
*/
|
|
244
253
|
getAccountLink,
|
|
254
|
+
/**
|
|
255
|
+
* This route will attempt to register the account to namespace linkage in AMS and requires a valid account link token. This route fails if an account is already linked AdminAccountLink Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
|
|
256
|
+
*/
|
|
245
257
|
createAccountLink
|
|
246
258
|
};
|
|
247
259
|
}
|
|
@@ -339,7 +351,13 @@ function AmsInfoAdminApi(sdk, args) {
|
|
|
339
351
|
return resp.response;
|
|
340
352
|
}
|
|
341
353
|
return {
|
|
354
|
+
/**
|
|
355
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
|
|
356
|
+
*/
|
|
342
357
|
getRegions,
|
|
358
|
+
/**
|
|
359
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
|
|
360
|
+
*/
|
|
343
361
|
getSupportedInstances
|
|
344
362
|
};
|
|
345
363
|
}
|
|
@@ -435,7 +453,13 @@ function AmsQoSAdminApi(sdk, args) {
|
|
|
435
453
|
return resp.response;
|
|
436
454
|
}
|
|
437
455
|
return {
|
|
456
|
+
/**
|
|
457
|
+
* ``` Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [READ] This endpoint lists all QoS services available in all regions. This endpoint is intended to be called by game client to find out all available regions. After getting a list of QoS on each region, game client is expected to ping each one with UDP connection as described below: 1. Make UDP connection to each QoS's IP:Port 2. Send string "PING" after connection established 3. Wait for string "PONG" response 4. Note the request-response latency for each QoS in each region The game then can use ping latency information to either: 1. Inform the player on these latencies and let player choose preferred region 2. Send the latency list to Matchmaking Service so that player can be matched with other players in nearby regions
|
|
458
|
+
*/
|
|
438
459
|
getQos,
|
|
460
|
+
/**
|
|
461
|
+
* ``` Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [UPDATE] This endpoint updates the registered QoS service's configurable configuration.
|
|
462
|
+
*/
|
|
439
463
|
patchQo_ByRegion
|
|
440
464
|
};
|
|
441
465
|
}
|
|
@@ -644,12 +668,33 @@ function ArtifactsAdminApi(sdk, args) {
|
|
|
644
668
|
return resp.response;
|
|
645
669
|
}
|
|
646
670
|
return {
|
|
671
|
+
/**
|
|
672
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [DELETE]
|
|
673
|
+
*/
|
|
647
674
|
deleteArtifact,
|
|
675
|
+
/**
|
|
676
|
+
* Get all artifacts matching the provided search criteria. When criteria is not specified the data returned won't have been filtered on those parameters Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
|
|
677
|
+
*/
|
|
648
678
|
getArtifacts,
|
|
679
|
+
/**
|
|
680
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
|
|
681
|
+
*/
|
|
649
682
|
getArtifactsUsage,
|
|
683
|
+
/**
|
|
684
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [DELETE]
|
|
685
|
+
*/
|
|
650
686
|
deleteArtifact_ByArtifactId,
|
|
687
|
+
/**
|
|
688
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
|
|
689
|
+
*/
|
|
651
690
|
getUrl_ByArtifactId,
|
|
691
|
+
/**
|
|
692
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
|
|
693
|
+
*/
|
|
652
694
|
getArtifactsSamplingRules_ByFleetId,
|
|
695
|
+
/**
|
|
696
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [UPDATE]
|
|
697
|
+
*/
|
|
653
698
|
updateArtifactsSamplingRule_ByFleetId
|
|
654
699
|
};
|
|
655
700
|
}
|
|
@@ -786,9 +831,21 @@ function DevelopmentAdminApi(sdk, args) {
|
|
|
786
831
|
return resp.response;
|
|
787
832
|
}
|
|
788
833
|
return {
|
|
834
|
+
/**
|
|
835
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
836
|
+
*/
|
|
789
837
|
getDevelopmentServerConfigurations,
|
|
838
|
+
/**
|
|
839
|
+
* Configuration name can be up to 128 characters and must conform to ^[.a-zA-Z0-9_-]+$ Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
|
|
840
|
+
*/
|
|
790
841
|
createDevelopmentServerConfiguration,
|
|
842
|
+
/**
|
|
843
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
|
|
844
|
+
*/
|
|
791
845
|
deleteDevelopmentServerConfiguration_ByDevelopmentServerConfigId,
|
|
846
|
+
/**
|
|
847
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
848
|
+
*/
|
|
792
849
|
getDevelopmentServerConfiguration_ByDevelopmentServerConfigId
|
|
793
850
|
};
|
|
794
851
|
}
|
|
@@ -1054,11 +1111,29 @@ function FleetsAdminApi(sdk, args) {
|
|
|
1054
1111
|
return resp.response;
|
|
1055
1112
|
}
|
|
1056
1113
|
return {
|
|
1114
|
+
/**
|
|
1115
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
1116
|
+
*/
|
|
1057
1117
|
getFleets,
|
|
1118
|
+
/**
|
|
1119
|
+
* Optionally, sampling rules for the fleet can also be specified Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
|
|
1120
|
+
*/
|
|
1058
1121
|
createFleet,
|
|
1122
|
+
/**
|
|
1123
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
|
|
1124
|
+
*/
|
|
1059
1125
|
deleteFleet_ByFleetId,
|
|
1126
|
+
/**
|
|
1127
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
1128
|
+
*/
|
|
1060
1129
|
getFleet_ByFleetId,
|
|
1130
|
+
/**
|
|
1131
|
+
* Optionally, sampling rules for the fleet can also be updated Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [UPDATE]
|
|
1132
|
+
*/
|
|
1061
1133
|
updateFleet_ByFleetId,
|
|
1134
|
+
/**
|
|
1135
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
1136
|
+
*/
|
|
1062
1137
|
getServers_ByFleetId
|
|
1063
1138
|
};
|
|
1064
1139
|
}
|
|
@@ -1245,11 +1320,29 @@ function ImagesAdminApi(sdk, args) {
|
|
|
1245
1320
|
return resp.response;
|
|
1246
1321
|
}
|
|
1247
1322
|
return {
|
|
1323
|
+
/**
|
|
1324
|
+
* Returns images which exist (uploaded, uploading, or building) in the linked account. This route fails if no account is linked Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
|
|
1325
|
+
*/
|
|
1248
1326
|
getImages,
|
|
1327
|
+
/**
|
|
1328
|
+
* Returns information regarding the account's usage for images storage including the free tier quota Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
|
|
1329
|
+
*/
|
|
1249
1330
|
getImagesStorage,
|
|
1331
|
+
/**
|
|
1332
|
+
* Marks an image for deletion. The image will stop being available for fleets and will eventually be deleted. Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
|
|
1333
|
+
*/
|
|
1250
1334
|
deleteImage_ByImageId,
|
|
1335
|
+
/**
|
|
1336
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
|
|
1337
|
+
*/
|
|
1251
1338
|
getImage_ByImageId,
|
|
1339
|
+
/**
|
|
1340
|
+
* This allows editing of the image name, toggling `IsProtected`, or adding & removal of tags Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [UPDATE]
|
|
1341
|
+
*/
|
|
1252
1342
|
patchImage_ByImageId,
|
|
1343
|
+
/**
|
|
1344
|
+
* Unmarks an image for deletion. The image will be available for fleets. Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
|
|
1345
|
+
*/
|
|
1253
1346
|
createRestore_ByImageId
|
|
1254
1347
|
};
|
|
1255
1348
|
}
|
|
@@ -1272,6 +1365,7 @@ var DsHistoryEvent = import_zod45.z.object({
|
|
|
1272
1365
|
reason: import_zod45.z.string(),
|
|
1273
1366
|
region: import_zod45.z.string(),
|
|
1274
1367
|
serverId: import_zod45.z.string(),
|
|
1368
|
+
sessionId: import_zod45.z.string(),
|
|
1275
1369
|
status: import_zod45.z.string()
|
|
1276
1370
|
});
|
|
1277
1371
|
|
|
@@ -1411,9 +1505,21 @@ function ServersAdminApi(sdk, args) {
|
|
|
1411
1505
|
return resp.response;
|
|
1412
1506
|
}
|
|
1413
1507
|
return {
|
|
1508
|
+
/**
|
|
1509
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
1510
|
+
*/
|
|
1414
1511
|
getServer_ByServerId,
|
|
1512
|
+
/**
|
|
1513
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
1514
|
+
*/
|
|
1415
1515
|
getHistory_ByServerId,
|
|
1516
|
+
/**
|
|
1517
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
1518
|
+
*/
|
|
1416
1519
|
getServersHistory_ByFleetId,
|
|
1520
|
+
/**
|
|
1521
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:DS:LOGS [READ]
|
|
1522
|
+
*/
|
|
1417
1523
|
getConnectioninfo_ByServerId
|
|
1418
1524
|
};
|
|
1419
1525
|
}
|
|
@@ -1468,6 +1574,9 @@ function AccountApi(sdk, args) {
|
|
|
1468
1574
|
return resp.response;
|
|
1469
1575
|
}
|
|
1470
1576
|
return {
|
|
1577
|
+
/**
|
|
1578
|
+
* Required Permission: NAMESPACE:{namespace}:AMS:ACCOUNT [READ]
|
|
1579
|
+
*/
|
|
1471
1580
|
getAccount
|
|
1472
1581
|
};
|
|
1473
1582
|
}
|
|
@@ -1575,6 +1684,9 @@ function AuthApi(sdk, args) {
|
|
|
1575
1684
|
return resp.response;
|
|
1576
1685
|
}
|
|
1577
1686
|
return {
|
|
1687
|
+
/**
|
|
1688
|
+
* Check if fleet commander is authorized to talk to AMS with this IAM
|
|
1689
|
+
*/
|
|
1578
1690
|
getAuth
|
|
1579
1691
|
};
|
|
1580
1692
|
}
|
|
@@ -1702,7 +1814,13 @@ function FleetsApi(sdk, args) {
|
|
|
1702
1814
|
return resp.response;
|
|
1703
1815
|
}
|
|
1704
1816
|
return {
|
|
1817
|
+
/**
|
|
1818
|
+
* Claim a dedicated server from fleets with matching claim keys. If the claim key is for a regular fleet (non development), the request will instantly fail if there are no DS available (HTTP 404). If the claim key is for a development fleet and there are no DS available, a new DS will be launched and the request might take up to 8 seconds to return (depending on the environment configuration). If it's not ready after that duration the request will still return HTTP 404. In either case, the call to this endpoint may be retried at any time to check if a DS has become available. Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
|
|
1819
|
+
*/
|
|
1705
1820
|
updateServerClaim,
|
|
1821
|
+
/**
|
|
1822
|
+
* Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
|
|
1823
|
+
*/
|
|
1706
1824
|
updateClaim_ByFleetId
|
|
1707
1825
|
};
|
|
1708
1826
|
}
|
|
@@ -1773,7 +1891,13 @@ function WatchdogsApi(sdk, args) {
|
|
|
1773
1891
|
return resp.response;
|
|
1774
1892
|
}
|
|
1775
1893
|
return {
|
|
1894
|
+
/**
|
|
1895
|
+
* This is to support local ds development scenarios Required Permission: NAMESPACE:{namespace}:AMS:LOCALDS [CREATE]
|
|
1896
|
+
*/
|
|
1776
1897
|
getConnect_ByWatchdogId,
|
|
1898
|
+
/**
|
|
1899
|
+
* Required Permission: NAMESPACE:{namespace}:ARMADA:WATCHDOG [CREATE]
|
|
1900
|
+
*/
|
|
1777
1901
|
getConnect_ByWatchdogId_ByNS
|
|
1778
1902
|
};
|
|
1779
1903
|
}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AccelByteSDK, SdkSetConfigParam, Response } from '@accelbyte/sdk';
|
|
2
2
|
import { AxiosResponse, AxiosInstance } from 'axios';
|
|
3
|
-
import { A as AccountResponse, a as AccountCreateRequest, b as AccountCreateResponse, c as AccountLinkTokenResponse, d as AccountLinkRequest, e as AccountLinkResponse, f as AmsRegionsResponse, g as AvailableInstanceTypesResponse, Q as QoSEndpointResponse, U as UpdateServerRequest, h as ArtifactListResponse, i as ArtifactUsageResponse, j as ArtifactUrlResponse, F as FleetArtifactsSampleRules, D as DevelopmentServerConfigurationListResponse, k as DevelopmentServerConfigurationCreateRequest, l as DevelopmentServerConfigurationCreateResponse, m as DevelopmentServerConfigurationGetResponse, n as FleetListResponse, o as FleetParameters, p as FleetCreateResponse, q as FleetGetResponse, r as FleetServersResponse, I as ImageList, s as ImageStorage, t as ImageDetails, u as ImageUpdate, v as FleetServerInfoResponse, w as FleetServerHistoryResponse, x as DsHistoryList, y as FleetServerConnectionInfoResponse, z as FleetClaimByKeysReq, B as FleetClaimResponse, C as FleetClaimReq } from './FleetClaimResponse-
|
|
3
|
+
import { A as AccountResponse, a as AccountCreateRequest, b as AccountCreateResponse, c as AccountLinkTokenResponse, d as AccountLinkRequest, e as AccountLinkResponse, f as AmsRegionsResponse, g as AvailableInstanceTypesResponse, Q as QoSEndpointResponse, U as UpdateServerRequest, h as ArtifactListResponse, i as ArtifactUsageResponse, j as ArtifactUrlResponse, F as FleetArtifactsSampleRules, D as DevelopmentServerConfigurationListResponse, k as DevelopmentServerConfigurationCreateRequest, l as DevelopmentServerConfigurationCreateResponse, m as DevelopmentServerConfigurationGetResponse, n as FleetListResponse, o as FleetParameters, p as FleetCreateResponse, q as FleetGetResponse, r as FleetServersResponse, I as ImageList, s as ImageStorage, t as ImageDetails, u as ImageUpdate, v as FleetServerInfoResponse, w as FleetServerHistoryResponse, x as DsHistoryList, y as FleetServerConnectionInfoResponse, z as FleetClaimByKeysReq, B as FleetClaimResponse, C as FleetClaimReq } from './FleetClaimResponse-D9jxThLx.cjs';
|
|
4
4
|
import { z } from 'zod';
|
|
5
5
|
|
|
6
6
|
/**
|
|
@@ -8,9 +8,21 @@ import { z } from 'zod';
|
|
|
8
8
|
*/
|
|
9
9
|
|
|
10
10
|
declare function AccountAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
11
|
+
/**
|
|
12
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
|
|
13
|
+
*/
|
|
11
14
|
getAccount: () => Promise<AxiosResponse<AccountResponse>>;
|
|
15
|
+
/**
|
|
16
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
|
|
17
|
+
*/
|
|
12
18
|
createAccount: (data: AccountCreateRequest) => Promise<AxiosResponse<AccountCreateResponse>>;
|
|
19
|
+
/**
|
|
20
|
+
* The link token returned can be used to connect another namespace to the account in which the provided namespace is linked. This route fails if there is no account linked to the specified namespace. Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
|
|
21
|
+
*/
|
|
13
22
|
getAccountLink: () => Promise<AxiosResponse<AccountLinkTokenResponse>>;
|
|
23
|
+
/**
|
|
24
|
+
* This route will attempt to register the account to namespace linkage in AMS and requires a valid account link token. This route fails if an account is already linked AdminAccountLink Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
|
|
25
|
+
*/
|
|
14
26
|
createAccountLink: (data: AccountLinkRequest) => Promise<AxiosResponse<AccountLinkResponse>>;
|
|
15
27
|
};
|
|
16
28
|
|
|
@@ -19,7 +31,13 @@ declare function AccountAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
|
19
31
|
*/
|
|
20
32
|
|
|
21
33
|
declare function AmsInfoAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
34
|
+
/**
|
|
35
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
|
|
36
|
+
*/
|
|
22
37
|
getRegions: () => Promise<AxiosResponse<AmsRegionsResponse>>;
|
|
38
|
+
/**
|
|
39
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
|
|
40
|
+
*/
|
|
23
41
|
getSupportedInstances: () => Promise<AxiosResponse<AvailableInstanceTypesResponse>>;
|
|
24
42
|
};
|
|
25
43
|
|
|
@@ -28,9 +46,15 @@ declare function AmsInfoAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
|
28
46
|
*/
|
|
29
47
|
|
|
30
48
|
declare function AmsQoSAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
49
|
+
/**
|
|
50
|
+
* ``` Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [READ] This endpoint lists all QoS services available in all regions. This endpoint is intended to be called by game client to find out all available regions. After getting a list of QoS on each region, game client is expected to ping each one with UDP connection as described below: 1. Make UDP connection to each QoS's IP:Port 2. Send string "PING" after connection established 3. Wait for string "PONG" response 4. Note the request-response latency for each QoS in each region The game then can use ping latency information to either: 1. Inform the player on these latencies and let player choose preferred region 2. Send the latency list to Matchmaking Service so that player can be matched with other players in nearby regions
|
|
51
|
+
*/
|
|
31
52
|
getQos: (queryParams?: {
|
|
32
53
|
status?: string | null;
|
|
33
54
|
}) => Promise<AxiosResponse<QoSEndpointResponse>>;
|
|
55
|
+
/**
|
|
56
|
+
* ``` Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [UPDATE] This endpoint updates the registered QoS service's configurable configuration.
|
|
57
|
+
*/
|
|
34
58
|
patchQo_ByRegion: (region: string, data: UpdateServerRequest) => Promise<AxiosResponse<unknown>>;
|
|
35
59
|
};
|
|
36
60
|
|
|
@@ -39,11 +63,17 @@ declare function AmsQoSAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
|
39
63
|
*/
|
|
40
64
|
|
|
41
65
|
declare function ArtifactsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
66
|
+
/**
|
|
67
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [DELETE]
|
|
68
|
+
*/
|
|
42
69
|
deleteArtifact: (queryParams?: {
|
|
43
70
|
artifactType?: string | null;
|
|
44
71
|
fleetId?: string | null;
|
|
45
72
|
uploadedBefore?: string | null;
|
|
46
73
|
}) => Promise<AxiosResponse<unknown>>;
|
|
74
|
+
/**
|
|
75
|
+
* Get all artifacts matching the provided search criteria. When criteria is not specified the data returned won't have been filtered on those parameters Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
|
|
76
|
+
*/
|
|
47
77
|
getArtifacts: (queryParams?: {
|
|
48
78
|
artifactType?: string | null;
|
|
49
79
|
count?: number;
|
|
@@ -58,10 +88,25 @@ declare function ArtifactsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam):
|
|
|
58
88
|
startDate?: string | null;
|
|
59
89
|
status?: string | null;
|
|
60
90
|
}) => Promise<AxiosResponse<ArtifactListResponse>>;
|
|
91
|
+
/**
|
|
92
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
|
|
93
|
+
*/
|
|
61
94
|
getArtifactsUsage: () => Promise<AxiosResponse<ArtifactUsageResponse>>;
|
|
95
|
+
/**
|
|
96
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [DELETE]
|
|
97
|
+
*/
|
|
62
98
|
deleteArtifact_ByArtifactId: (artifactID: string) => Promise<AxiosResponse<unknown>>;
|
|
99
|
+
/**
|
|
100
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
|
|
101
|
+
*/
|
|
63
102
|
getUrl_ByArtifactId: (artifactID: string) => Promise<AxiosResponse<ArtifactUrlResponse>>;
|
|
103
|
+
/**
|
|
104
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
|
|
105
|
+
*/
|
|
64
106
|
getArtifactsSamplingRules_ByFleetId: (fleetID: string) => Promise<AxiosResponse<FleetArtifactsSampleRules>>;
|
|
107
|
+
/**
|
|
108
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [UPDATE]
|
|
109
|
+
*/
|
|
65
110
|
updateArtifactsSamplingRule_ByFleetId: (fleetID: string, data: FleetArtifactsSampleRules) => Promise<AxiosResponse<FleetArtifactsSampleRules>>;
|
|
66
111
|
};
|
|
67
112
|
|
|
@@ -70,12 +115,24 @@ declare function ArtifactsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam):
|
|
|
70
115
|
*/
|
|
71
116
|
|
|
72
117
|
declare function DevelopmentAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
118
|
+
/**
|
|
119
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
120
|
+
*/
|
|
73
121
|
getDevelopmentServerConfigurations: (queryParams?: {
|
|
74
122
|
count?: number;
|
|
75
123
|
offset?: number;
|
|
76
124
|
}) => Promise<AxiosResponse<DevelopmentServerConfigurationListResponse>>;
|
|
125
|
+
/**
|
|
126
|
+
* Configuration name can be up to 128 characters and must conform to ^[.a-zA-Z0-9_-]+$ Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
|
|
127
|
+
*/
|
|
77
128
|
createDevelopmentServerConfiguration: (data: DevelopmentServerConfigurationCreateRequest) => Promise<AxiosResponse<DevelopmentServerConfigurationCreateResponse>>;
|
|
129
|
+
/**
|
|
130
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
|
|
131
|
+
*/
|
|
78
132
|
deleteDevelopmentServerConfiguration_ByDevelopmentServerConfigId: (developmentServerConfigID: string) => Promise<AxiosResponse<unknown>>;
|
|
133
|
+
/**
|
|
134
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
135
|
+
*/
|
|
79
136
|
getDevelopmentServerConfiguration_ByDevelopmentServerConfigId: (developmentServerConfigID: string) => Promise<AxiosResponse<DevelopmentServerConfigurationGetResponse>>;
|
|
80
137
|
};
|
|
81
138
|
|
|
@@ -84,11 +141,29 @@ declare function DevelopmentAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam
|
|
|
84
141
|
*/
|
|
85
142
|
|
|
86
143
|
declare function FleetsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
144
|
+
/**
|
|
145
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
146
|
+
*/
|
|
87
147
|
getFleets: () => Promise<AxiosResponse<FleetListResponse>>;
|
|
148
|
+
/**
|
|
149
|
+
* Optionally, sampling rules for the fleet can also be specified Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
|
|
150
|
+
*/
|
|
88
151
|
createFleet: (data: FleetParameters) => Promise<AxiosResponse<FleetCreateResponse>>;
|
|
152
|
+
/**
|
|
153
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
|
|
154
|
+
*/
|
|
89
155
|
deleteFleet_ByFleetId: (fleetID: string) => Promise<AxiosResponse<unknown>>;
|
|
156
|
+
/**
|
|
157
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
158
|
+
*/
|
|
90
159
|
getFleet_ByFleetId: (fleetID: string) => Promise<AxiosResponse<FleetGetResponse>>;
|
|
160
|
+
/**
|
|
161
|
+
* Optionally, sampling rules for the fleet can also be updated Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [UPDATE]
|
|
162
|
+
*/
|
|
91
163
|
updateFleet_ByFleetId: (fleetID: string, data: FleetParameters) => Promise<AxiosResponse<unknown>>;
|
|
164
|
+
/**
|
|
165
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
166
|
+
*/
|
|
92
167
|
getServers_ByFleetId: (fleetID: string, queryParams?: {
|
|
93
168
|
count?: number;
|
|
94
169
|
offset?: number;
|
|
@@ -105,11 +180,29 @@ declare function FleetsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
|
105
180
|
*/
|
|
106
181
|
|
|
107
182
|
declare function ImagesAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
183
|
+
/**
|
|
184
|
+
* Returns images which exist (uploaded, uploading, or building) in the linked account. This route fails if no account is linked Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
|
|
185
|
+
*/
|
|
108
186
|
getImages: () => Promise<AxiosResponse<ImageList>>;
|
|
187
|
+
/**
|
|
188
|
+
* Returns information regarding the account's usage for images storage including the free tier quota Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
|
|
189
|
+
*/
|
|
109
190
|
getImagesStorage: () => Promise<AxiosResponse<ImageStorage>>;
|
|
191
|
+
/**
|
|
192
|
+
* Marks an image for deletion. The image will stop being available for fleets and will eventually be deleted. Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
|
|
193
|
+
*/
|
|
110
194
|
deleteImage_ByImageId: (imageID: string) => Promise<AxiosResponse<unknown>>;
|
|
195
|
+
/**
|
|
196
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
|
|
197
|
+
*/
|
|
111
198
|
getImage_ByImageId: (imageID: string) => Promise<AxiosResponse<ImageDetails>>;
|
|
199
|
+
/**
|
|
200
|
+
* This allows editing of the image name, toggling `IsProtected`, or adding & removal of tags Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [UPDATE]
|
|
201
|
+
*/
|
|
112
202
|
patchImage_ByImageId: (imageID: string, data: ImageUpdate) => Promise<AxiosResponse<ImageDetails>>;
|
|
203
|
+
/**
|
|
204
|
+
* Unmarks an image for deletion. The image will be available for fleets. Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
|
|
205
|
+
*/
|
|
113
206
|
createRestore_ByImageId: (imageID: string) => Promise<AxiosResponse<unknown>>;
|
|
114
207
|
};
|
|
115
208
|
|
|
@@ -118,8 +211,17 @@ declare function ImagesAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
|
118
211
|
*/
|
|
119
212
|
|
|
120
213
|
declare function ServersAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
214
|
+
/**
|
|
215
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
216
|
+
*/
|
|
121
217
|
getServer_ByServerId: (serverID: string) => Promise<AxiosResponse<FleetServerInfoResponse>>;
|
|
218
|
+
/**
|
|
219
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
220
|
+
*/
|
|
122
221
|
getHistory_ByServerId: (serverID: string) => Promise<AxiosResponse<FleetServerHistoryResponse>>;
|
|
222
|
+
/**
|
|
223
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
|
|
224
|
+
*/
|
|
123
225
|
getServersHistory_ByFleetId: (fleetID: string, queryParams?: {
|
|
124
226
|
count?: number;
|
|
125
227
|
offset?: number;
|
|
@@ -129,6 +231,9 @@ declare function ServersAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
|
129
231
|
sortDirection?: string | null;
|
|
130
232
|
status?: string | null;
|
|
131
233
|
}) => Promise<AxiosResponse<DsHistoryList>>;
|
|
234
|
+
/**
|
|
235
|
+
* Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:DS:LOGS [READ]
|
|
236
|
+
*/
|
|
132
237
|
getConnectioninfo_ByServerId: (serverID: string) => Promise<AxiosResponse<FleetServerConnectionInfoResponse>>;
|
|
133
238
|
};
|
|
134
239
|
|
|
@@ -137,6 +242,9 @@ declare function ServersAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
|
137
242
|
*/
|
|
138
243
|
|
|
139
244
|
declare function AccountApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
245
|
+
/**
|
|
246
|
+
* Required Permission: NAMESPACE:{namespace}:AMS:ACCOUNT [READ]
|
|
247
|
+
*/
|
|
140
248
|
getAccount: () => Promise<AxiosResponse<AccountResponse>>;
|
|
141
249
|
};
|
|
142
250
|
|
|
@@ -153,6 +261,9 @@ declare function AmsInfoApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
|
153
261
|
*/
|
|
154
262
|
|
|
155
263
|
declare function AuthApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
264
|
+
/**
|
|
265
|
+
* Check if fleet commander is authorized to talk to AMS with this IAM
|
|
266
|
+
*/
|
|
156
267
|
getAuth: () => Promise<AxiosResponse<unknown>>;
|
|
157
268
|
};
|
|
158
269
|
|
|
@@ -169,7 +280,13 @@ declare function FleetCommanderApi(sdk: AccelByteSDK, args?: SdkSetConfigParam):
|
|
|
169
280
|
*/
|
|
170
281
|
|
|
171
282
|
declare function FleetsApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
283
|
+
/**
|
|
284
|
+
* Claim a dedicated server from fleets with matching claim keys. If the claim key is for a regular fleet (non development), the request will instantly fail if there are no DS available (HTTP 404). If the claim key is for a development fleet and there are no DS available, a new DS will be launched and the request might take up to 8 seconds to return (depending on the environment configuration). If it's not ready after that duration the request will still return HTTP 404. In either case, the call to this endpoint may be retried at any time to check if a DS has become available. Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
|
|
285
|
+
*/
|
|
172
286
|
updateServerClaim: (data: FleetClaimByKeysReq) => Promise<AxiosResponse<FleetClaimResponse>>;
|
|
287
|
+
/**
|
|
288
|
+
* Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
|
|
289
|
+
*/
|
|
173
290
|
updateClaim_ByFleetId: (fleetID: string, data: FleetClaimReq) => Promise<AxiosResponse<FleetClaimResponse>>;
|
|
174
291
|
};
|
|
175
292
|
|
|
@@ -178,7 +295,13 @@ declare function FleetsApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
|
178
295
|
*/
|
|
179
296
|
|
|
180
297
|
declare function WatchdogsApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
|
|
298
|
+
/**
|
|
299
|
+
* This is to support local ds development scenarios Required Permission: NAMESPACE:{namespace}:AMS:LOCALDS [CREATE]
|
|
300
|
+
*/
|
|
181
301
|
getConnect_ByWatchdogId: (watchdogID: string) => Promise<AxiosResponse<unknown>>;
|
|
302
|
+
/**
|
|
303
|
+
* Required Permission: NAMESPACE:{namespace}:ARMADA:WATCHDOG [CREATE]
|
|
304
|
+
*/
|
|
182
305
|
getConnect_ByWatchdogId_ByNS: (watchdogID: string) => Promise<AxiosResponse<unknown>>;
|
|
183
306
|
};
|
|
184
307
|
|
|
@@ -597,12 +720,14 @@ declare const DsHistoryEvent: z.ZodObject<{
|
|
|
597
720
|
reason: z.ZodString;
|
|
598
721
|
region: z.ZodString;
|
|
599
722
|
serverId: z.ZodString;
|
|
723
|
+
sessionId: z.ZodString;
|
|
600
724
|
status: z.ZodString;
|
|
601
725
|
}, "strip", z.ZodTypeAny, {
|
|
602
726
|
status: string;
|
|
603
727
|
region: string;
|
|
604
728
|
ipAddress: string;
|
|
605
729
|
serverId: string;
|
|
730
|
+
sessionId: string;
|
|
606
731
|
exitCode: number;
|
|
607
732
|
reason: string;
|
|
608
733
|
createdAt?: any;
|
|
@@ -611,6 +736,7 @@ declare const DsHistoryEvent: z.ZodObject<{
|
|
|
611
736
|
region: string;
|
|
612
737
|
ipAddress: string;
|
|
613
738
|
serverId: string;
|
|
739
|
+
sessionId: string;
|
|
614
740
|
exitCode: number;
|
|
615
741
|
reason: string;
|
|
616
742
|
createdAt?: any;
|