@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.
@@ -1740,12 +1740,14 @@ declare const DsHistoryList: z.ZodObject<{
1740
1740
  reason: z.ZodString;
1741
1741
  region: z.ZodString;
1742
1742
  serverId: z.ZodString;
1743
+ sessionId: z.ZodString;
1743
1744
  status: z.ZodString;
1744
1745
  }, "strip", z.ZodTypeAny, {
1745
1746
  status: string;
1746
1747
  region: string;
1747
1748
  ipAddress: string;
1748
1749
  serverId: string;
1750
+ sessionId: string;
1749
1751
  exitCode: number;
1750
1752
  reason: string;
1751
1753
  createdAt?: any;
@@ -1754,6 +1756,7 @@ declare const DsHistoryList: z.ZodObject<{
1754
1756
  region: string;
1755
1757
  ipAddress: string;
1756
1758
  serverId: string;
1759
+ sessionId: string;
1757
1760
  exitCode: number;
1758
1761
  reason: string;
1759
1762
  createdAt?: any;
@@ -1802,6 +1805,7 @@ declare const DsHistoryList: z.ZodObject<{
1802
1805
  region: string;
1803
1806
  ipAddress: string;
1804
1807
  serverId: string;
1808
+ sessionId: string;
1805
1809
  exitCode: number;
1806
1810
  reason: string;
1807
1811
  createdAt?: any;
@@ -1822,6 +1826,7 @@ declare const DsHistoryList: z.ZodObject<{
1822
1826
  region: string;
1823
1827
  ipAddress: string;
1824
1828
  serverId: string;
1829
+ sessionId: string;
1825
1830
  exitCode: number;
1826
1831
  reason: string;
1827
1832
  createdAt?: any;
@@ -1740,12 +1740,14 @@ declare const DsHistoryList: z.ZodObject<{
1740
1740
  reason: z.ZodString;
1741
1741
  region: z.ZodString;
1742
1742
  serverId: z.ZodString;
1743
+ sessionId: z.ZodString;
1743
1744
  status: z.ZodString;
1744
1745
  }, "strip", z.ZodTypeAny, {
1745
1746
  status: string;
1746
1747
  region: string;
1747
1748
  ipAddress: string;
1748
1749
  serverId: string;
1750
+ sessionId: string;
1749
1751
  exitCode: number;
1750
1752
  reason: string;
1751
1753
  createdAt?: any;
@@ -1754,6 +1756,7 @@ declare const DsHistoryList: z.ZodObject<{
1754
1756
  region: string;
1755
1757
  ipAddress: string;
1756
1758
  serverId: string;
1759
+ sessionId: string;
1757
1760
  exitCode: number;
1758
1761
  reason: string;
1759
1762
  createdAt?: any;
@@ -1802,6 +1805,7 @@ declare const DsHistoryList: z.ZodObject<{
1802
1805
  region: string;
1803
1806
  ipAddress: string;
1804
1807
  serverId: string;
1808
+ sessionId: string;
1805
1809
  exitCode: number;
1806
1810
  reason: string;
1807
1811
  createdAt?: any;
@@ -1822,6 +1826,7 @@ declare const DsHistoryList: z.ZodObject<{
1822
1826
  region: string;
1823
1827
  ipAddress: string;
1824
1828
  serverId: string;
1829
+ sessionId: string;
1825
1830
  exitCode: number;
1826
1831
  reason: string;
1827
1832
  createdAt?: any;
@@ -213,9 +213,21 @@ function AccountAdminApi(sdk, args) {
213
213
  return resp.response;
214
214
  }
215
215
  return {
216
+ /**
217
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
218
+ */
216
219
  getAccount,
220
+ /**
221
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
222
+ */
217
223
  createAccount,
224
+ /**
225
+ * 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]
226
+ */
218
227
  getAccountLink,
228
+ /**
229
+ * 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]
230
+ */
219
231
  createAccountLink
220
232
  };
221
233
  }
@@ -373,7 +385,13 @@ function AmsInfoAdminApi(sdk, args) {
373
385
  return resp.response;
374
386
  }
375
387
  return {
388
+ /**
389
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
390
+ */
376
391
  getRegions,
392
+ /**
393
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
394
+ */
377
395
  getSupportedInstances
378
396
  };
379
397
  }
@@ -503,7 +521,13 @@ function AmsQoSAdminApi(sdk, args) {
503
521
  return resp.response;
504
522
  }
505
523
  return {
524
+ /**
525
+ * ``` 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&#39;s IP:Port 2. Send string &#34;PING&#34; after connection established 3. Wait for string &#34;PONG&#34; 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
526
+ */
506
527
  getQos,
528
+ /**
529
+ * ``` Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [UPDATE] This endpoint updates the registered QoS service&#39;s configurable configuration.
530
+ */
507
531
  patchQo_ByRegion
508
532
  };
509
533
  }
@@ -749,12 +773,33 @@ function ArtifactsAdminApi(sdk, args) {
749
773
  return resp.response;
750
774
  }
751
775
  return {
776
+ /**
777
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [DELETE]
778
+ */
752
779
  deleteArtifact,
780
+ /**
781
+ * Get all artifacts matching the provided search criteria. When criteria is not specified the data returned won&#39;t have been filtered on those parameters Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
782
+ */
753
783
  getArtifacts,
784
+ /**
785
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
786
+ */
754
787
  getArtifactsUsage,
788
+ /**
789
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [DELETE]
790
+ */
755
791
  deleteArtifact_ByArtifactId,
792
+ /**
793
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
794
+ */
756
795
  getUrl_ByArtifactId,
796
+ /**
797
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
798
+ */
757
799
  getArtifactsSamplingRules_ByFleetId,
800
+ /**
801
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [UPDATE]
802
+ */
758
803
  updateArtifactsSamplingRule_ByFleetId
759
804
  };
760
805
  }
@@ -1005,9 +1050,21 @@ function DevelopmentAdminApi(sdk, args) {
1005
1050
  return resp.response;
1006
1051
  }
1007
1052
  return {
1053
+ /**
1054
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
1055
+ */
1008
1056
  getDevelopmentServerConfigurations,
1057
+ /**
1058
+ * Configuration name can be up to 128 characters and must conform to ^[.a-zA-Z0-9_-]+$ Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
1059
+ */
1009
1060
  createDevelopmentServerConfiguration,
1061
+ /**
1062
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
1063
+ */
1010
1064
  deleteDevelopmentServerConfiguration_ByDevelopmentServerConfigId,
1065
+ /**
1066
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
1067
+ */
1011
1068
  getDevelopmentServerConfiguration_ByDevelopmentServerConfigId
1012
1069
  };
1013
1070
  }
@@ -1344,11 +1401,29 @@ function FleetsAdminApi(sdk, args) {
1344
1401
  return resp.response;
1345
1402
  }
1346
1403
  return {
1404
+ /**
1405
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
1406
+ */
1347
1407
  getFleets,
1408
+ /**
1409
+ * Optionally, sampling rules for the fleet can also be specified Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
1410
+ */
1348
1411
  createFleet,
1412
+ /**
1413
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
1414
+ */
1349
1415
  deleteFleet_ByFleetId,
1416
+ /**
1417
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
1418
+ */
1350
1419
  getFleet_ByFleetId,
1420
+ /**
1421
+ * Optionally, sampling rules for the fleet can also be updated Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [UPDATE]
1422
+ */
1351
1423
  updateFleet_ByFleetId,
1424
+ /**
1425
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
1426
+ */
1352
1427
  getServers_ByFleetId
1353
1428
  };
1354
1429
  }
@@ -1629,11 +1704,29 @@ function ImagesAdminApi(sdk, args) {
1629
1704
  return resp.response;
1630
1705
  }
1631
1706
  return {
1707
+ /**
1708
+ * 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]
1709
+ */
1632
1710
  getImages,
1711
+ /**
1712
+ * Returns information regarding the account&#39;s usage for images storage including the free tier quota Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
1713
+ */
1633
1714
  getImagesStorage,
1715
+ /**
1716
+ * 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]
1717
+ */
1634
1718
  deleteImage_ByImageId,
1719
+ /**
1720
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
1721
+ */
1635
1722
  getImage_ByImageId,
1723
+ /**
1724
+ * This allows editing of the image name, toggling `IsProtected`, or adding &amp; removal of tags Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [UPDATE]
1725
+ */
1636
1726
  patchImage_ByImageId,
1727
+ /**
1728
+ * Unmarks an image for deletion. The image will be available for fleets. Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
1729
+ */
1637
1730
  createRestore_ByImageId
1638
1731
  };
1639
1732
  }
@@ -1749,6 +1842,7 @@ var DsHistoryEvent = import_zod45.z.object({
1749
1842
  reason: import_zod45.z.string(),
1750
1843
  region: import_zod45.z.string(),
1751
1844
  serverId: import_zod45.z.string(),
1845
+ sessionId: import_zod45.z.string(),
1752
1846
  status: import_zod45.z.string()
1753
1847
  });
1754
1848
 
@@ -1888,9 +1982,21 @@ function ServersAdminApi(sdk, args) {
1888
1982
  return resp.response;
1889
1983
  }
1890
1984
  return {
1985
+ /**
1986
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
1987
+ */
1891
1988
  getServer_ByServerId,
1989
+ /**
1990
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
1991
+ */
1892
1992
  getHistory_ByServerId,
1993
+ /**
1994
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
1995
+ */
1893
1996
  getServersHistory_ByFleetId,
1997
+ /**
1998
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:DS:LOGS [READ]
1999
+ */
1894
2000
  getConnectioninfo_ByServerId
1895
2001
  };
1896
2002
  }
@@ -2015,6 +2121,9 @@ function AccountApi(sdk, args) {
2015
2121
  return resp.response;
2016
2122
  }
2017
2123
  return {
2124
+ /**
2125
+ * Required Permission: NAMESPACE:{namespace}:AMS:ACCOUNT [READ]
2126
+ */
2018
2127
  getAccount
2019
2128
  };
2020
2129
  }
@@ -2164,6 +2273,9 @@ function AuthApi(sdk, args) {
2164
2273
  return resp.response;
2165
2274
  }
2166
2275
  return {
2276
+ /**
2277
+ * Check if fleet commander is authorized to talk to AMS with this IAM
2278
+ */
2167
2279
  getAuth
2168
2280
  };
2169
2281
  }
@@ -2333,7 +2445,13 @@ function FleetsApi(sdk, args) {
2333
2445
  return resp.response;
2334
2446
  }
2335
2447
  return {
2448
+ /**
2449
+ * 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&#39;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]
2450
+ */
2336
2451
  updateServerClaim,
2452
+ /**
2453
+ * Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
2454
+ */
2337
2455
  updateClaim_ByFleetId
2338
2456
  };
2339
2457
  }
@@ -2441,7 +2559,13 @@ function WatchdogsApi(sdk, args) {
2441
2559
  return resp.response;
2442
2560
  }
2443
2561
  return {
2562
+ /**
2563
+ * This is to support local ds development scenarios Required Permission: NAMESPACE:{namespace}:AMS:LOCALDS [CREATE]
2564
+ */
2444
2565
  getConnect_ByWatchdogId,
2566
+ /**
2567
+ * Required Permission: NAMESPACE:{namespace}:ARMADA:WATCHDOG [CREATE]
2568
+ */
2445
2569
  getConnect_ByWatchdogId_ByNS
2446
2570
  };
2447
2571
  }
@@ -1,7 +1,7 @@
1
1
  import { AccelByteSDK, SdkSetConfigParam, ApiError } from '@accelbyte/sdk';
2
2
  import { AxiosError, AxiosResponse } from 'axios';
3
3
  import { UseQueryOptions, UseQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
4
- import { A as AccountResponse, b as AccountCreateResponse, a as AccountCreateRequest, c as AccountLinkTokenResponse, e as AccountLinkResponse, d as AccountLinkRequest, 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, l as DevelopmentServerConfigurationCreateResponse, k as DevelopmentServerConfigurationCreateRequest, m as DevelopmentServerConfigurationGetResponse, n as FleetListResponse, p as FleetCreateResponse, o as FleetParameters, 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, B as FleetClaimResponse, z as FleetClaimByKeysReq, C as FleetClaimReq } from './FleetClaimResponse-CS_GmAA_.cjs';
4
+ import { A as AccountResponse, b as AccountCreateResponse, a as AccountCreateRequest, c as AccountLinkTokenResponse, e as AccountLinkResponse, d as AccountLinkRequest, 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, l as DevelopmentServerConfigurationCreateResponse, k as DevelopmentServerConfigurationCreateRequest, m as DevelopmentServerConfigurationGetResponse, n as FleetListResponse, p as FleetCreateResponse, o as FleetParameters, 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, B as FleetClaimResponse, z as FleetClaimByKeysReq, C as FleetClaimReq } from './FleetClaimResponse-D9jxThLx.cjs';
5
5
  import 'zod';
6
6
 
7
7
  /**
@@ -1,7 +1,7 @@
1
1
  import { AccelByteSDK, SdkSetConfigParam, ApiError } from '@accelbyte/sdk';
2
2
  import { AxiosError, AxiosResponse } from 'axios';
3
3
  import { UseQueryOptions, UseQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
4
- import { A as AccountResponse, b as AccountCreateResponse, a as AccountCreateRequest, c as AccountLinkTokenResponse, e as AccountLinkResponse, d as AccountLinkRequest, 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, l as DevelopmentServerConfigurationCreateResponse, k as DevelopmentServerConfigurationCreateRequest, m as DevelopmentServerConfigurationGetResponse, n as FleetListResponse, p as FleetCreateResponse, o as FleetParameters, 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, B as FleetClaimResponse, z as FleetClaimByKeysReq, C as FleetClaimReq } from './FleetClaimResponse-CS_GmAA_.js';
4
+ import { A as AccountResponse, b as AccountCreateResponse, a as AccountCreateRequest, c as AccountLinkTokenResponse, e as AccountLinkResponse, d as AccountLinkRequest, 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, l as DevelopmentServerConfigurationCreateResponse, k as DevelopmentServerConfigurationCreateRequest, m as DevelopmentServerConfigurationGetResponse, n as FleetListResponse, p as FleetCreateResponse, o as FleetParameters, 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, B as FleetClaimResponse, z as FleetClaimByKeysReq, C as FleetClaimReq } from './FleetClaimResponse-D9jxThLx.js';
5
5
  import 'zod';
6
6
 
7
7
  /**
@@ -13,7 +13,7 @@ import {
13
13
  ImagesAdminApi,
14
14
  ServersAdminApi,
15
15
  WatchdogsApi
16
- } from "./chunk-5DT3PMPA.js";
16
+ } from "./chunk-M6F62AGQ.js";
17
17
 
18
18
  // src/generated-admin/queries/AccountAdmin.query.ts
19
19
  import { useMutation, useQuery } from "@tanstack/react-query";
@@ -122,9 +122,21 @@ function AccountAdminApi(sdk, args) {
122
122
  return resp.response;
123
123
  }
124
124
  return {
125
+ /**
126
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
127
+ */
125
128
  getAccount,
129
+ /**
130
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
131
+ */
126
132
  createAccount,
133
+ /**
134
+ * 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]
135
+ */
127
136
  getAccountLink,
137
+ /**
138
+ * 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]
139
+ */
128
140
  createAccountLink
129
141
  };
130
142
  }
@@ -216,7 +228,13 @@ function AmsInfoAdminApi(sdk, args) {
216
228
  return resp.response;
217
229
  }
218
230
  return {
231
+ /**
232
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
233
+ */
219
234
  getRegions,
235
+ /**
236
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
237
+ */
220
238
  getSupportedInstances
221
239
  };
222
240
  }
@@ -304,7 +322,13 @@ function AmsQoSAdminApi(sdk, args) {
304
322
  return resp.response;
305
323
  }
306
324
  return {
325
+ /**
326
+ * ``` 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&#39;s IP:Port 2. Send string &#34;PING&#34; after connection established 3. Wait for string &#34;PONG&#34; 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
327
+ */
307
328
  getQos,
329
+ /**
330
+ * ``` Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [UPDATE] This endpoint updates the registered QoS service&#39;s configurable configuration.
331
+ */
308
332
  patchQo_ByRegion
309
333
  };
310
334
  }
@@ -503,12 +527,33 @@ function ArtifactsAdminApi(sdk, args) {
503
527
  return resp.response;
504
528
  }
505
529
  return {
530
+ /**
531
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [DELETE]
532
+ */
506
533
  deleteArtifact,
534
+ /**
535
+ * Get all artifacts matching the provided search criteria. When criteria is not specified the data returned won&#39;t have been filtered on those parameters Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
536
+ */
507
537
  getArtifacts,
538
+ /**
539
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
540
+ */
508
541
  getArtifactsUsage,
542
+ /**
543
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [DELETE]
544
+ */
509
545
  deleteArtifact_ByArtifactId,
546
+ /**
547
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
548
+ */
510
549
  getUrl_ByArtifactId,
550
+ /**
551
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
552
+ */
511
553
  getArtifactsSamplingRules_ByFleetId,
554
+ /**
555
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [UPDATE]
556
+ */
512
557
  updateArtifactsSamplingRule_ByFleetId
513
558
  };
514
559
  }
@@ -641,9 +686,21 @@ function DevelopmentAdminApi(sdk, args) {
641
686
  return resp.response;
642
687
  }
643
688
  return {
689
+ /**
690
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
691
+ */
644
692
  getDevelopmentServerConfigurations,
693
+ /**
694
+ * Configuration name can be up to 128 characters and must conform to ^[.a-zA-Z0-9_-]+$ Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
695
+ */
645
696
  createDevelopmentServerConfiguration,
697
+ /**
698
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
699
+ */
646
700
  deleteDevelopmentServerConfiguration_ByDevelopmentServerConfigId,
701
+ /**
702
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
703
+ */
647
704
  getDevelopmentServerConfiguration_ByDevelopmentServerConfigId
648
705
  };
649
706
  }
@@ -895,11 +952,29 @@ function FleetsAdminApi(sdk, args) {
895
952
  return resp.response;
896
953
  }
897
954
  return {
955
+ /**
956
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
957
+ */
898
958
  getFleets,
959
+ /**
960
+ * Optionally, sampling rules for the fleet can also be specified Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
961
+ */
899
962
  createFleet,
963
+ /**
964
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
965
+ */
900
966
  deleteFleet_ByFleetId,
967
+ /**
968
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
969
+ */
901
970
  getFleet_ByFleetId,
971
+ /**
972
+ * Optionally, sampling rules for the fleet can also be updated Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [UPDATE]
973
+ */
902
974
  updateFleet_ByFleetId,
975
+ /**
976
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
977
+ */
903
978
  getServers_ByFleetId
904
979
  };
905
980
  }
@@ -1078,11 +1153,29 @@ function ImagesAdminApi(sdk, args) {
1078
1153
  return resp.response;
1079
1154
  }
1080
1155
  return {
1156
+ /**
1157
+ * 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]
1158
+ */
1081
1159
  getImages,
1160
+ /**
1161
+ * Returns information regarding the account&#39;s usage for images storage including the free tier quota Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
1162
+ */
1082
1163
  getImagesStorage,
1164
+ /**
1165
+ * 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]
1166
+ */
1083
1167
  deleteImage_ByImageId,
1168
+ /**
1169
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
1170
+ */
1084
1171
  getImage_ByImageId,
1172
+ /**
1173
+ * This allows editing of the image name, toggling `IsProtected`, or adding &amp; removal of tags Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [UPDATE]
1174
+ */
1085
1175
  patchImage_ByImageId,
1176
+ /**
1177
+ * Unmarks an image for deletion. The image will be available for fleets. Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
1178
+ */
1086
1179
  createRestore_ByImageId
1087
1180
  };
1088
1181
  }
@@ -1096,6 +1189,7 @@ var DsHistoryEvent = z45.object({
1096
1189
  reason: z45.string(),
1097
1190
  region: z45.string(),
1098
1191
  serverId: z45.string(),
1192
+ sessionId: z45.string(),
1099
1193
  status: z45.string()
1100
1194
  });
1101
1195
 
@@ -1236,9 +1330,21 @@ function ServersAdminApi(sdk, args) {
1236
1330
  return resp.response;
1237
1331
  }
1238
1332
  return {
1333
+ /**
1334
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
1335
+ */
1239
1336
  getServer_ByServerId,
1337
+ /**
1338
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
1339
+ */
1240
1340
  getHistory_ByServerId,
1341
+ /**
1342
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
1343
+ */
1241
1344
  getServersHistory_ByFleetId,
1345
+ /**
1346
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:DS:LOGS [READ]
1347
+ */
1242
1348
  getConnectioninfo_ByServerId
1243
1349
  };
1244
1350
  }
@@ -1291,6 +1397,9 @@ function AccountApi(sdk, args) {
1291
1397
  return resp.response;
1292
1398
  }
1293
1399
  return {
1400
+ /**
1401
+ * Required Permission: NAMESPACE:{namespace}:AMS:ACCOUNT [READ]
1402
+ */
1294
1403
  getAccount
1295
1404
  };
1296
1405
  }
@@ -1394,6 +1503,9 @@ function AuthApi(sdk, args) {
1394
1503
  return resp.response;
1395
1504
  }
1396
1505
  return {
1506
+ /**
1507
+ * Check if fleet commander is authorized to talk to AMS with this IAM
1508
+ */
1397
1509
  getAuth
1398
1510
  };
1399
1511
  }
@@ -1515,7 +1627,13 @@ function FleetsApi(sdk, args) {
1515
1627
  return resp.response;
1516
1628
  }
1517
1629
  return {
1630
+ /**
1631
+ * 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&#39;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]
1632
+ */
1518
1633
  updateServerClaim,
1634
+ /**
1635
+ * Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
1636
+ */
1519
1637
  updateClaim_ByFleetId
1520
1638
  };
1521
1639
  }
@@ -1584,7 +1702,13 @@ function WatchdogsApi(sdk, args) {
1584
1702
  return resp.response;
1585
1703
  }
1586
1704
  return {
1705
+ /**
1706
+ * This is to support local ds development scenarios Required Permission: NAMESPACE:{namespace}:AMS:LOCALDS [CREATE]
1707
+ */
1587
1708
  getConnect_ByWatchdogId,
1709
+ /**
1710
+ * Required Permission: NAMESPACE:{namespace}:ARMADA:WATCHDOG [CREATE]
1711
+ */
1588
1712
  getConnect_ByWatchdogId_ByNS
1589
1713
  };
1590
1714
  }