@accelbyte/sdk-ams 0.0.0-dev-20240904033042 → 0.0.0-dev-20240910111050

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { AccelByteSDK, SdkSetConfigParam, Response } from '@accelbyte/sdk';
 import { AxiosResponse, AxiosInstance } from 'axios';
-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-CS_GmAA_.cjs';
+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';
 import { z } from 'zod';
 
 /**
@@ -8,9 +8,21 @@ import { z } from 'zod';
  */
 
 declare function AccountAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
+     */
     getAccount: () => Promise<AxiosResponse<AccountResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
+     */
     createAccount: (data: AccountCreateRequest) => Promise<AxiosResponse<AccountCreateResponse>>;
+    /**
+     * 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]
+     */
     getAccountLink: () => Promise<AxiosResponse<AccountLinkTokenResponse>>;
+    /**
+     * 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]
+     */
     createAccountLink: (data: AccountLinkRequest) => Promise<AxiosResponse<AccountLinkResponse>>;
 };
 
@@ -19,7 +31,13 @@ declare function AccountAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function AmsInfoAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
+     */
     getRegions: () => Promise<AxiosResponse<AmsRegionsResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
+     */
     getSupportedInstances: () => Promise<AxiosResponse<AvailableInstanceTypesResponse>>;
 };
 
@@ -28,9 +46,15 @@ declare function AmsInfoAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function AmsQoSAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * ``` 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
+     */
     getQos: (queryParams?: {
         status?: string | null;
     }) => Promise<AxiosResponse<QoSEndpointResponse>>;
+    /**
+     * ``` Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [UPDATE] This endpoint updates the registered QoS service&#39;s configurable configuration.
+     */
     patchQo_ByRegion: (region: string, data: UpdateServerRequest) => Promise<AxiosResponse<unknown>>;
 };
 
@@ -39,11 +63,17 @@ declare function AmsQoSAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function ArtifactsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [DELETE]
+     */
     deleteArtifact: (queryParams?: {
         artifactType?: string | null;
         fleetId?: string | null;
         uploadedBefore?: string | null;
     }) => Promise<AxiosResponse<unknown>>;
+    /**
+     * 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]
+     */
     getArtifacts: (queryParams?: {
         artifactType?: string | null;
         count?: number;
@@ -58,10 +88,25 @@ declare function ArtifactsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam):
         startDate?: string | null;
         status?: string | null;
     }) => Promise<AxiosResponse<ArtifactListResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
+     */
     getArtifactsUsage: () => Promise<AxiosResponse<ArtifactUsageResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [DELETE]
+     */
     deleteArtifact_ByArtifactId: (artifactID: string) => Promise<AxiosResponse<unknown>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
+     */
     getUrl_ByArtifactId: (artifactID: string) => Promise<AxiosResponse<ArtifactUrlResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
+     */
     getArtifactsSamplingRules_ByFleetId: (fleetID: string) => Promise<AxiosResponse<FleetArtifactsSampleRules>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [UPDATE]
+     */
     updateArtifactsSamplingRule_ByFleetId: (fleetID: string, data: FleetArtifactsSampleRules) => Promise<AxiosResponse<FleetArtifactsSampleRules>>;
 };
 
@@ -70,12 +115,24 @@ declare function ArtifactsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam):
  */
 
 declare function DevelopmentAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getDevelopmentServerConfigurations: (queryParams?: {
         count?: number;
         offset?: number;
     }) => Promise<AxiosResponse<DevelopmentServerConfigurationListResponse>>;
+    /**
+     * Configuration name can be up to 128 characters and must conform to ^[.a-zA-Z0-9_-]+$ Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
+     */
     createDevelopmentServerConfiguration: (data: DevelopmentServerConfigurationCreateRequest) => Promise<AxiosResponse<DevelopmentServerConfigurationCreateResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
+     */
     deleteDevelopmentServerConfiguration_ByDevelopmentServerConfigId: (developmentServerConfigID: string) => Promise<AxiosResponse<unknown>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getDevelopmentServerConfiguration_ByDevelopmentServerConfigId: (developmentServerConfigID: string) => Promise<AxiosResponse<DevelopmentServerConfigurationGetResponse>>;
 };
 
@@ -84,11 +141,29 @@ declare function DevelopmentAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam
  */
 
 declare function FleetsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getFleets: () => Promise<AxiosResponse<FleetListResponse>>;
+    /**
+     * Optionally, sampling rules for the fleet can also be specified Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
+     */
     createFleet: (data: FleetParameters) => Promise<AxiosResponse<FleetCreateResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
+     */
     deleteFleet_ByFleetId: (fleetID: string) => Promise<AxiosResponse<unknown>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getFleet_ByFleetId: (fleetID: string) => Promise<AxiosResponse<FleetGetResponse>>;
+    /**
+     * Optionally, sampling rules for the fleet can also be updated Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [UPDATE]
+     */
     updateFleet_ByFleetId: (fleetID: string, data: FleetParameters) => Promise<AxiosResponse<unknown>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getServers_ByFleetId: (fleetID: string, queryParams?: {
         count?: number;
         offset?: number;
@@ -105,11 +180,29 @@ declare function FleetsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function ImagesAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * 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]
+     */
     getImages: () => Promise<AxiosResponse<ImageList>>;
+    /**
+     * Returns information regarding the account&#39;s usage for images storage including the free tier quota Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
+     */
     getImagesStorage: () => Promise<AxiosResponse<ImageStorage>>;
+    /**
+     * 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]
+     */
     deleteImage_ByImageId: (imageID: string) => Promise<AxiosResponse<unknown>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
+     */
     getImage_ByImageId: (imageID: string) => Promise<AxiosResponse<ImageDetails>>;
+    /**
+     * This allows editing of the image name, toggling `IsProtected`, or adding &amp; removal of tags Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [UPDATE]
+     */
     patchImage_ByImageId: (imageID: string, data: ImageUpdate) => Promise<AxiosResponse<ImageDetails>>;
+    /**
+     * Unmarks an image for deletion. The image will be available for fleets. Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
+     */
     createRestore_ByImageId: (imageID: string) => Promise<AxiosResponse<unknown>>;
 };
 
@@ -118,8 +211,17 @@ declare function ImagesAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function ServersAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getServer_ByServerId: (serverID: string) => Promise<AxiosResponse<FleetServerInfoResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getHistory_ByServerId: (serverID: string) => Promise<AxiosResponse<FleetServerHistoryResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getServersHistory_ByFleetId: (fleetID: string, queryParams?: {
         count?: number;
         offset?: number;
@@ -129,6 +231,9 @@ declare function ServersAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
         sortDirection?: string | null;
         status?: string | null;
     }) => Promise<AxiosResponse<DsHistoryList>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:DS:LOGS [READ]
+     */
     getConnectioninfo_ByServerId: (serverID: string) => Promise<AxiosResponse<FleetServerConnectionInfoResponse>>;
 };
 
@@ -137,6 +242,9 @@ declare function ServersAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function AccountApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: NAMESPACE:{namespace}:AMS:ACCOUNT [READ]
+     */
     getAccount: () => Promise<AxiosResponse<AccountResponse>>;
 };
 
@@ -153,6 +261,9 @@ declare function AmsInfoApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function AuthApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Check if fleet commander is authorized to talk to AMS with this IAM
+     */
     getAuth: () => Promise<AxiosResponse<unknown>>;
 };
 
@@ -169,7 +280,13 @@ declare function FleetCommanderApi(sdk: AccelByteSDK, args?: SdkSetConfigParam):
  */
 
 declare function FleetsApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * 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]
+     */
     updateServerClaim: (data: FleetClaimByKeysReq) => Promise<AxiosResponse<FleetClaimResponse>>;
+    /**
+     * Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
+     */
     updateClaim_ByFleetId: (fleetID: string, data: FleetClaimReq) => Promise<AxiosResponse<FleetClaimResponse>>;
 };
 
@@ -178,7 +295,13 @@ declare function FleetsApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function WatchdogsApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * This is to support local ds development scenarios Required Permission: NAMESPACE:{namespace}:AMS:LOCALDS [CREATE]
+     */
     getConnect_ByWatchdogId: (watchdogID: string) => Promise<AxiosResponse<unknown>>;
+    /**
+     * Required Permission: NAMESPACE:{namespace}:ARMADA:WATCHDOG [CREATE]
+     */
     getConnect_ByWatchdogId_ByNS: (watchdogID: string) => Promise<AxiosResponse<unknown>>;
 };
 
@@ -597,12 +720,14 @@ declare const DsHistoryEvent: z.ZodObject<{
     reason: z.ZodString;
     region: z.ZodString;
     serverId: z.ZodString;
+    sessionId: z.ZodString;
     status: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     status: string;
     region: string;
     ipAddress: string;
     serverId: string;
+    sessionId: string;
     exitCode: number;
     reason: string;
     createdAt?: any;
@@ -611,6 +736,7 @@ declare const DsHistoryEvent: z.ZodObject<{
     region: string;
     ipAddress: string;
     serverId: string;
+    sessionId: string;
     exitCode: number;
     reason: string;
     createdAt?: any;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { AccelByteSDK, SdkSetConfigParam, Response } from '@accelbyte/sdk';
 import { AxiosResponse, AxiosInstance } from 'axios';
-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-CS_GmAA_.js';
+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.js';
 import { z } from 'zod';
 
 /**
@@ -8,9 +8,21 @@ import { z } from 'zod';
  */
 
 declare function AccountAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
+     */
     getAccount: () => Promise<AxiosResponse<AccountResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
+     */
     createAccount: (data: AccountCreateRequest) => Promise<AxiosResponse<AccountCreateResponse>>;
+    /**
+     * 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]
+     */
     getAccountLink: () => Promise<AxiosResponse<AccountLinkTokenResponse>>;
+    /**
+     * 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]
+     */
     createAccountLink: (data: AccountLinkRequest) => Promise<AxiosResponse<AccountLinkResponse>>;
 };
 
@@ -19,7 +31,13 @@ declare function AccountAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function AmsInfoAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
+     */
     getRegions: () => Promise<AxiosResponse<AmsRegionsResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
+     */
     getSupportedInstances: () => Promise<AxiosResponse<AvailableInstanceTypesResponse>>;
 };
 
@@ -28,9 +46,15 @@ declare function AmsInfoAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function AmsQoSAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * ``` 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
+     */
     getQos: (queryParams?: {
         status?: string | null;
     }) => Promise<AxiosResponse<QoSEndpointResponse>>;
+    /**
+     * ``` Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [UPDATE] This endpoint updates the registered QoS service&#39;s configurable configuration.
+     */
     patchQo_ByRegion: (region: string, data: UpdateServerRequest) => Promise<AxiosResponse<unknown>>;
 };
 
@@ -39,11 +63,17 @@ declare function AmsQoSAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function ArtifactsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [DELETE]
+     */
     deleteArtifact: (queryParams?: {
         artifactType?: string | null;
         fleetId?: string | null;
         uploadedBefore?: string | null;
     }) => Promise<AxiosResponse<unknown>>;
+    /**
+     * 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]
+     */
     getArtifacts: (queryParams?: {
         artifactType?: string | null;
         count?: number;
@@ -58,10 +88,25 @@ declare function ArtifactsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam):
         startDate?: string | null;
         status?: string | null;
     }) => Promise<AxiosResponse<ArtifactListResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
+     */
     getArtifactsUsage: () => Promise<AxiosResponse<ArtifactUsageResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [DELETE]
+     */
     deleteArtifact_ByArtifactId: (artifactID: string) => Promise<AxiosResponse<unknown>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
+     */
     getUrl_ByArtifactId: (artifactID: string) => Promise<AxiosResponse<ArtifactUrlResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
+     */
     getArtifactsSamplingRules_ByFleetId: (fleetID: string) => Promise<AxiosResponse<FleetArtifactsSampleRules>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [UPDATE]
+     */
     updateArtifactsSamplingRule_ByFleetId: (fleetID: string, data: FleetArtifactsSampleRules) => Promise<AxiosResponse<FleetArtifactsSampleRules>>;
 };
 
@@ -70,12 +115,24 @@ declare function ArtifactsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam):
  */
 
 declare function DevelopmentAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getDevelopmentServerConfigurations: (queryParams?: {
         count?: number;
         offset?: number;
     }) => Promise<AxiosResponse<DevelopmentServerConfigurationListResponse>>;
+    /**
+     * Configuration name can be up to 128 characters and must conform to ^[.a-zA-Z0-9_-]+$ Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
+     */
     createDevelopmentServerConfiguration: (data: DevelopmentServerConfigurationCreateRequest) => Promise<AxiosResponse<DevelopmentServerConfigurationCreateResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
+     */
     deleteDevelopmentServerConfiguration_ByDevelopmentServerConfigId: (developmentServerConfigID: string) => Promise<AxiosResponse<unknown>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getDevelopmentServerConfiguration_ByDevelopmentServerConfigId: (developmentServerConfigID: string) => Promise<AxiosResponse<DevelopmentServerConfigurationGetResponse>>;
 };
 
@@ -84,11 +141,29 @@ declare function DevelopmentAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam
  */
 
 declare function FleetsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getFleets: () => Promise<AxiosResponse<FleetListResponse>>;
+    /**
+     * Optionally, sampling rules for the fleet can also be specified Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
+     */
     createFleet: (data: FleetParameters) => Promise<AxiosResponse<FleetCreateResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
+     */
     deleteFleet_ByFleetId: (fleetID: string) => Promise<AxiosResponse<unknown>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getFleet_ByFleetId: (fleetID: string) => Promise<AxiosResponse<FleetGetResponse>>;
+    /**
+     * Optionally, sampling rules for the fleet can also be updated Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [UPDATE]
+     */
     updateFleet_ByFleetId: (fleetID: string, data: FleetParameters) => Promise<AxiosResponse<unknown>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getServers_ByFleetId: (fleetID: string, queryParams?: {
         count?: number;
         offset?: number;
@@ -105,11 +180,29 @@ declare function FleetsAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function ImagesAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * 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]
+     */
     getImages: () => Promise<AxiosResponse<ImageList>>;
+    /**
+     * Returns information regarding the account&#39;s usage for images storage including the free tier quota Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
+     */
     getImagesStorage: () => Promise<AxiosResponse<ImageStorage>>;
+    /**
+     * 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]
+     */
     deleteImage_ByImageId: (imageID: string) => Promise<AxiosResponse<unknown>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
+     */
     getImage_ByImageId: (imageID: string) => Promise<AxiosResponse<ImageDetails>>;
+    /**
+     * This allows editing of the image name, toggling `IsProtected`, or adding &amp; removal of tags Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [UPDATE]
+     */
     patchImage_ByImageId: (imageID: string, data: ImageUpdate) => Promise<AxiosResponse<ImageDetails>>;
+    /**
+     * Unmarks an image for deletion. The image will be available for fleets. Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
+     */
     createRestore_ByImageId: (imageID: string) => Promise<AxiosResponse<unknown>>;
 };
 
@@ -118,8 +211,17 @@ declare function ImagesAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function ServersAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getServer_ByServerId: (serverID: string) => Promise<AxiosResponse<FleetServerInfoResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getHistory_ByServerId: (serverID: string) => Promise<AxiosResponse<FleetServerHistoryResponse>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+     */
     getServersHistory_ByFleetId: (fleetID: string, queryParams?: {
         count?: number;
         offset?: number;
@@ -129,6 +231,9 @@ declare function ServersAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
         sortDirection?: string | null;
         status?: string | null;
     }) => Promise<AxiosResponse<DsHistoryList>>;
+    /**
+     * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:DS:LOGS [READ]
+     */
     getConnectioninfo_ByServerId: (serverID: string) => Promise<AxiosResponse<FleetServerConnectionInfoResponse>>;
 };
 
@@ -137,6 +242,9 @@ declare function ServersAdminApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function AccountApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Required Permission: NAMESPACE:{namespace}:AMS:ACCOUNT [READ]
+     */
     getAccount: () => Promise<AxiosResponse<AccountResponse>>;
 };
 
@@ -153,6 +261,9 @@ declare function AmsInfoApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function AuthApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * Check if fleet commander is authorized to talk to AMS with this IAM
+     */
     getAuth: () => Promise<AxiosResponse<unknown>>;
 };
 
@@ -169,7 +280,13 @@ declare function FleetCommanderApi(sdk: AccelByteSDK, args?: SdkSetConfigParam):
  */
 
 declare function FleetsApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * 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]
+     */
     updateServerClaim: (data: FleetClaimByKeysReq) => Promise<AxiosResponse<FleetClaimResponse>>;
+    /**
+     * Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
+     */
     updateClaim_ByFleetId: (fleetID: string, data: FleetClaimReq) => Promise<AxiosResponse<FleetClaimResponse>>;
 };
 
@@ -178,7 +295,13 @@ declare function FleetsApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
  */
 
 declare function WatchdogsApi(sdk: AccelByteSDK, args?: SdkSetConfigParam): {
+    /**
+     * This is to support local ds development scenarios Required Permission: NAMESPACE:{namespace}:AMS:LOCALDS [CREATE]
+     */
     getConnect_ByWatchdogId: (watchdogID: string) => Promise<AxiosResponse<unknown>>;
+    /**
+     * Required Permission: NAMESPACE:{namespace}:ARMADA:WATCHDOG [CREATE]
+     */
     getConnect_ByWatchdogId_ByNS: (watchdogID: string) => Promise<AxiosResponse<unknown>>;
 };
 
@@ -597,12 +720,14 @@ declare const DsHistoryEvent: z.ZodObject<{
     reason: z.ZodString;
     region: z.ZodString;
     serverId: z.ZodString;
+    sessionId: z.ZodString;
     status: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     status: string;
     region: string;
     ipAddress: string;
     serverId: string;
+    sessionId: string;
     exitCode: number;
     reason: string;
     createdAt?: any;
@@ -611,6 +736,7 @@ declare const DsHistoryEvent: z.ZodObject<{
     region: string;
     ipAddress: string;
     serverId: string;
+    sessionId: string;
     exitCode: number;
     reason: string;
     createdAt?: any;

package/dist/index.js

@@ -72,7 +72,7 @@ import {
   Timeout,
   Watchdogs$,
   WatchdogsApi
-} from "./chunk-TMBQO77A.js";
+} from "./chunk-M6F62AGQ.js";
 
 // src/Ams.ts
 var apis = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@accelbyte/sdk-ams",
-  "version": "0.0.0-dev-20240904033042",
+  "version": "0.0.0-dev-20240910111050",
   "author": "AccelByte Inc",
   "license": "SEE LICENSE IN LICENSE",
   "main": "./dist/index.js",
@@ -8,6 +8,7 @@
   "scripts": {
     "build": "rimraf dist && tsup src/index.ts src/all-query-imports.ts --dts --format esm,cjs",
     "test": "echo ''",
+    "test-and-build": "yarn test && yarn build",
     "clean:src": "rimraf src/generated-*",
     "clean": "rimraf dist && rimraf node_modules && rimraf .yalc",
     "cg:lint": "eslint src/**/*.ts --fix --config ../../.eslintrc.js",
@@ -33,8 +34,8 @@
     "typescript": "5.5.4"
   },
   "dependencies": {
-    "@accelbyte/validator": "0.0.0-dev-20240904033042",
-    "axios": "1.3.6",
+    "@accelbyte/validator": "0.0.0-dev-20240910111050",
+    "axios": "1.7.7",
     "buffer": "6.0.3",
     "crypto-js": "4.1.1",
     "platform": "1.3.6",
@@ -43,7 +44,7 @@
     "zod": "3.23.8"
   },
   "peerDependencies": {
-    "@accelbyte/sdk": "0.0.0-dev-20240904033042",
+    "@accelbyte/sdk": "0.0.0-dev-20240910111050",
     "@tanstack/react-query": "^4.36.1"
   },
   "sideEffects": false,