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

package/dist/all-query-imports.d.cts

@@ -1,7 +1,7 @@
 import { AccelByteSDK, SdkSetConfigParam, ApiError } from '@accelbyte/sdk';
 import { AxiosError, AxiosResponse } from 'axios';
 import { UseQueryOptions, UseQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
-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-DIDPJOnU.cjs';
+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';
 import 'zod';
 
 /**
@@ -12,13 +12,57 @@ declare enum Key_AccountAdmin {
     Account = "Ams.AccountAdmin.Account",
     AccountLink = "Ams.AccountAdmin.AccountLink"
 }
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_AccountAdmin.Account, input]
+ * }
+ * ```
+ */
 declare const useAccountAdminApi_GetAccount: (sdk: AccelByteSDK, input: SdkSetConfigParam, options?: Omit<UseQueryOptions<AccountResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<AccountResponse>) => void) => UseQueryResult<AccountResponse, AxiosError<ApiError>>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:ACCOUNT [CREATE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_AccountAdmin.Account, input]
+ * }
+ * ```
+ */
 declare const useAccountAdminApi_CreateAccount: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<AccountCreateResponse, AxiosError<ApiError>, SdkSetConfigParam & {
     data: AccountCreateRequest;
 }>, "mutationKey">, callback?: (data: AccountCreateResponse) => void) => UseMutationResult<AccountCreateResponse, AxiosError<ApiError>, SdkSetConfigParam & {
     data: AccountCreateRequest;
 }>;
+/**
+ * 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]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_AccountAdmin.AccountLink, input]
+ * }
+ * ```
+ */
 declare const useAccountAdminApi_GetAccountLink: (sdk: AccelByteSDK, input: SdkSetConfigParam, options?: Omit<UseQueryOptions<AccountLinkTokenResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<AccountLinkTokenResponse>) => void) => UseQueryResult<AccountLinkTokenResponse, AxiosError<ApiError>>;
+/**
+ * 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]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_AccountAdmin.AccountLink, input]
+ * }
+ * ```
+ */
 declare const useAccountAdminApi_CreateAccountLink: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<AccountLinkResponse, AxiosError<ApiError>, SdkSetConfigParam & {
     data: AccountLinkRequest;
 }>, "mutationKey">, callback?: (data: AccountLinkResponse) => void) => UseMutationResult<AccountLinkResponse, AxiosError<ApiError>, SdkSetConfigParam & {
@@ -33,7 +77,29 @@ declare enum Key_AmsInfoAdmin {
     Regions = "Ams.AmsInfoAdmin.Regions",
     SupportedInstances = "Ams.AmsInfoAdmin.SupportedInstances"
 }
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_AmsInfoAdmin.Regions, input]
+ * }
+ * ```
+ */
 declare const useAmsInfoAdminApi_GetRegions: (sdk: AccelByteSDK, input: SdkSetConfigParam, options?: Omit<UseQueryOptions<AmsRegionsResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<AmsRegionsResponse>) => void) => UseQueryResult<AmsRegionsResponse, AxiosError<ApiError>>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_AmsInfoAdmin.SupportedInstances, input]
+ * }
+ * ```
+ */
 declare const useAmsInfoAdminApi_GetSupportedInstances: (sdk: AccelByteSDK, input: SdkSetConfigParam, options?: Omit<UseQueryOptions<AvailableInstanceTypesResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<AvailableInstanceTypesResponse>) => void) => UseQueryResult<AvailableInstanceTypesResponse, AxiosError<ApiError>>;
 
 /**
@@ -44,11 +110,33 @@ declare enum Key_AmsQoSAdmin {
     Qos = "Ams.AmsQoSAdmin.Qos",
     Qo_ByRegion = "Ams.AmsQoSAdmin.Qo_ByRegion"
 }
+/**
+ * ``` 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
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_AmsQoSAdmin.Qos, input]
+ * }
+ * ```
+ */
 declare const useAmsQoSAdminApi_GetQos: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     queryParams?: {
         status?: string | null;
     };
 }, options?: Omit<UseQueryOptions<QoSEndpointResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<QoSEndpointResponse>) => void) => UseQueryResult<QoSEndpointResponse, AxiosError<ApiError>>;
+/**
+ * ``` Required Permission: ADMIN:NAMESPACE:{namespace}:QOS:SERVER [UPDATE] This endpoint updates the registered QoS service&#39;s configurable configuration.
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_AmsQoSAdmin.Qo_ByRegion, input]
+ * }
+ * ```
+ */
 declare const useAmsQoSAdminApi_PatchQo_ByRegion: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
     region: string;
     data: UpdateServerRequest;
@@ -70,6 +158,17 @@ declare enum Key_ArtifactsAdmin {
     ArtifactsSamplingRules_ByFleetId = "Ams.ArtifactsAdmin.ArtifactsSamplingRules_ByFleetId",
     ArtifactsSamplingRule_ByFleetId = "Ams.ArtifactsAdmin.ArtifactsSamplingRule_ByFleetId"
 }
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA [DELETE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ArtifactsAdmin.Artifact, input]
+ * }
+ * ```
+ */
 declare const useArtifactsAdminApi_DeleteArtifact: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
     queryParams?: {
         artifactType?: string | null;
@@ -83,6 +182,17 @@ declare const useArtifactsAdminApi_DeleteArtifact: (sdk: AccelByteSDK, options?:
         uploadedBefore?: string | null;
     };
 }>;
+/**
+ * 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]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ArtifactsAdmin.Artifacts, input]
+ * }
+ * ```
+ */
 declare const useArtifactsAdminApi_GetArtifacts: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     queryParams?: {
         artifactType?: string | null;
@@ -99,18 +209,73 @@ declare const useArtifactsAdminApi_GetArtifacts: (sdk: AccelByteSDK, input: SdkS
         status?: string | null;
     };
 }, options?: Omit<UseQueryOptions<ArtifactListResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<ArtifactListResponse>) => void) => UseQueryResult<ArtifactListResponse, AxiosError<ApiError>>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ArtifactsAdmin.ArtifactsUsage, input]
+ * }
+ * ```
+ */
 declare const useArtifactsAdminApi_GetArtifactsUsage: (sdk: AccelByteSDK, input: SdkSetConfigParam, options?: Omit<UseQueryOptions<ArtifactUsageResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<ArtifactUsageResponse>) => void) => UseQueryResult<ArtifactUsageResponse, AxiosError<ApiError>>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [DELETE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ArtifactsAdmin.Artifact_ByArtifactId, input]
+ * }
+ * ```
+ */
 declare const useArtifactsAdminApi_DeleteArtifact_ByArtifactId: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
     artifactID: string;
 }>, "mutationKey">, callback?: (data: unknown) => void) => UseMutationResult<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
     artifactID: string;
 }>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ArtifactsAdmin.Url_ByArtifactId, input]
+ * }
+ * ```
+ */
 declare const useArtifactsAdminApi_GetUrl_ByArtifactId: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     artifactID: string;
 }, options?: Omit<UseQueryOptions<ArtifactUrlResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<ArtifactUrlResponse>) => void) => UseQueryResult<ArtifactUrlResponse, AxiosError<ApiError>>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ArtifactsAdmin.ArtifactsSamplingRules_ByFleetId, input]
+ * }
+ * ```
+ */
 declare const useArtifactsAdminApi_GetArtifactsSamplingRules_ByFleetId: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     fleetID: string;
 }, options?: Omit<UseQueryOptions<FleetArtifactsSampleRules, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<FleetArtifactsSampleRules>) => void) => UseQueryResult<FleetArtifactsSampleRules, AxiosError<ApiError>>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:ARTIFACT [UPDATE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ArtifactsAdmin.ArtifactsSamplingRule_ByFleetId, input]
+ * }
+ * ```
+ */
 declare const useArtifactsAdminApi_UpdateArtifactsSamplingRule_ByFleetId: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<FleetArtifactsSampleRules, AxiosError<ApiError>, SdkSetConfigParam & {
     fleetID: string;
     data: FleetArtifactsSampleRules;
@@ -128,22 +293,66 @@ declare enum Key_DevelopmentAdmin {
     DevelopmentServerConfiguration = "Ams.DevelopmentAdmin.DevelopmentServerConfiguration",
     DevelopmentServerConfiguration_ByDevelopmentServerConfigId = "Ams.DevelopmentAdmin.DevelopmentServerConfiguration_ByDevelopmentServerConfigId"
 }
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_DevelopmentAdmin.DevelopmentServerConfigurations, input]
+ * }
+ * ```
+ */
 declare const useDevelopmentAdminApi_GetDevelopmentServerConfigurations: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     queryParams?: {
         count?: number;
         offset?: number;
     };
 }, options?: Omit<UseQueryOptions<DevelopmentServerConfigurationListResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<DevelopmentServerConfigurationListResponse>) => void) => UseQueryResult<DevelopmentServerConfigurationListResponse, AxiosError<ApiError>>;
+/**
+ * Configuration name can be up to 128 characters and must conform to ^[.a-zA-Z0-9_-]+$ Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_DevelopmentAdmin.DevelopmentServerConfiguration, input]
+ * }
+ * ```
+ */
 declare const useDevelopmentAdminApi_CreateDevelopmentServerConfiguration: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<DevelopmentServerConfigurationCreateResponse, AxiosError<ApiError>, SdkSetConfigParam & {
     data: DevelopmentServerConfigurationCreateRequest;
 }>, "mutationKey">, callback?: (data: DevelopmentServerConfigurationCreateResponse) => void) => UseMutationResult<DevelopmentServerConfigurationCreateResponse, AxiosError<ApiError>, SdkSetConfigParam & {
     data: DevelopmentServerConfigurationCreateRequest;
 }>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_DevelopmentAdmin.DevelopmentServerConfiguration_ByDevelopmentServerConfigId, input]
+ * }
+ * ```
+ */
 declare const useDevelopmentAdminApi_DeleteDevelopmentServerConfiguration_ByDevelopmentServerConfigId: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
     developmentServerConfigID: string;
 }>, "mutationKey">, callback?: (data: unknown) => void) => UseMutationResult<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
     developmentServerConfigID: string;
 }>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_DevelopmentAdmin.DevelopmentServerConfiguration_ByDevelopmentServerConfigId, input]
+ * }
+ * ```
+ */
 declare const useDevelopmentAdminApi_GetDevelopmentServerConfiguration_ByDevelopmentServerConfigId: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     developmentServerConfigID: string;
 }, options?: Omit<UseQueryOptions<DevelopmentServerConfigurationGetResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<DevelopmentServerConfigurationGetResponse>) => void) => UseQueryResult<DevelopmentServerConfigurationGetResponse, AxiosError<ApiError>>;
@@ -158,20 +367,75 @@ declare enum Key_FleetsAdmin {
     Fleet_ByFleetId = "Ams.FleetsAdmin.Fleet_ByFleetId",
     Servers_ByFleetId = "Ams.FleetsAdmin.Servers_ByFleetId"
 }
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_FleetsAdmin.Fleets, input]
+ * }
+ * ```
+ */
 declare const useFleetsAdminApi_GetFleets: (sdk: AccelByteSDK, input: SdkSetConfigParam, options?: Omit<UseQueryOptions<FleetListResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<FleetListResponse>) => void) => UseQueryResult<FleetListResponse, AxiosError<ApiError>>;
+/**
+ * Optionally, sampling rules for the fleet can also be specified Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [CREATE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_FleetsAdmin.Fleet, input]
+ * }
+ * ```
+ */
 declare const useFleetsAdminApi_CreateFleet: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<FleetCreateResponse, AxiosError<ApiError>, SdkSetConfigParam & {
     data: FleetParameters;
 }>, "mutationKey">, callback?: (data: FleetCreateResponse) => void) => UseMutationResult<FleetCreateResponse, AxiosError<ApiError>, SdkSetConfigParam & {
     data: FleetParameters;
 }>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [DELETE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_FleetsAdmin.Fleet_ByFleetId, input]
+ * }
+ * ```
+ */
 declare const useFleetsAdminApi_DeleteFleet_ByFleetId: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
     fleetID: string;
 }>, "mutationKey">, callback?: (data: unknown) => void) => UseMutationResult<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
     fleetID: string;
 }>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_FleetsAdmin.Fleet_ByFleetId, input]
+ * }
+ * ```
+ */
 declare const useFleetsAdminApi_GetFleet_ByFleetId: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     fleetID: string;
 }, options?: Omit<UseQueryOptions<FleetGetResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<FleetGetResponse>) => void) => UseQueryResult<FleetGetResponse, AxiosError<ApiError>>;
+/**
+ * Optionally, sampling rules for the fleet can also be updated Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [UPDATE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_FleetsAdmin.Fleet_ByFleetId, input]
+ * }
+ * ```
+ */
 declare const useFleetsAdminApi_UpdateFleet_ByFleetId: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
     fleetID: string;
     data: FleetParameters;
@@ -179,11 +443,27 @@ declare const useFleetsAdminApi_UpdateFleet_ByFleetId: (sdk: AccelByteSDK, optio
     fleetID: string;
     data: FleetParameters;
 }>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_FleetsAdmin.Servers_ByFleetId, input]
+ * }
+ * ```
+ */
 declare const useFleetsAdminApi_GetServers_ByFleetId: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     fleetID: string;
     queryParams?: {
-        count?: string | null;
+        count?: number;
         offset?: number;
+        region?: string | null;
+        serverId?: string | null;
+        sortBy?: string | null;
+        sortDirection?: "asc" | "desc";
+        status?: "claimed" | "claiming" | "crash backoff" | "creating" | "draining" | "ready" | "unresponsive";
     };
 }, options?: Omit<UseQueryOptions<FleetServersResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<FleetServersResponse>) => void) => UseQueryResult<FleetServersResponse, AxiosError<ApiError>>;
 
@@ -197,16 +477,71 @@ declare enum Key_ImagesAdmin {
     Image_ByImageId = "Ams.ImagesAdmin.Image_ByImageId",
     Restore_ByImageId = "Ams.ImagesAdmin.Restore_ByImageId"
 }
+/**
+ * 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]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ImagesAdmin.Images, input]
+ * }
+ * ```
+ */
 declare const useImagesAdminApi_GetImages: (sdk: AccelByteSDK, input: SdkSetConfigParam, options?: Omit<UseQueryOptions<ImageList, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<ImageList>) => void) => UseQueryResult<ImageList, AxiosError<ApiError>>;
+/**
+ * Returns information regarding the account&#39;s usage for images storage including the free tier quota Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ImagesAdmin.ImagesStorage, input]
+ * }
+ * ```
+ */
 declare const useImagesAdminApi_GetImagesStorage: (sdk: AccelByteSDK, input: SdkSetConfigParam, options?: Omit<UseQueryOptions<ImageStorage, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<ImageStorage>) => void) => UseQueryResult<ImageStorage, AxiosError<ApiError>>;
+/**
+ * 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]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ImagesAdmin.Image_ByImageId, input]
+ * }
+ * ```
+ */
 declare const useImagesAdminApi_DeleteImage_ByImageId: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
     imageID: string;
 }>, "mutationKey">, callback?: (data: unknown) => void) => UseMutationResult<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
     imageID: string;
 }>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ImagesAdmin.Image_ByImageId, input]
+ * }
+ * ```
+ */
 declare const useImagesAdminApi_GetImage_ByImageId: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     imageID: string;
 }, options?: Omit<UseQueryOptions<ImageDetails, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<ImageDetails>) => void) => UseQueryResult<ImageDetails, AxiosError<ApiError>>;
+/**
+ * This allows editing of the image name, toggling `IsProtected`, or adding &amp; removal of tags Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [UPDATE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ImagesAdmin.Image_ByImageId, input]
+ * }
+ * ```
+ */
 declare const useImagesAdminApi_PatchImage_ByImageId: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<ImageDetails, AxiosError<ApiError>, SdkSetConfigParam & {
     imageID: string;
     data: ImageUpdate;
@@ -214,6 +549,17 @@ declare const useImagesAdminApi_PatchImage_ByImageId: (sdk: AccelByteSDK, option
     imageID: string;
     data: ImageUpdate;
 }>;
+/**
+ * Unmarks an image for deletion. The image will be available for fleets. Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:IMAGE [DELETE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ImagesAdmin.Restore_ByImageId, input]
+ * }
+ * ```
+ */
 declare const useImagesAdminApi_CreateRestore_ByImageId: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
     imageID: string;
 }>, "mutationKey">, callback?: (data: unknown) => void) => UseMutationResult<unknown, AxiosError<ApiError>, SdkSetConfigParam & {
@@ -230,12 +576,45 @@ declare enum Key_ServersAdmin {
     ServersHistory_ByFleetId = "Ams.ServersAdmin.ServersHistory_ByFleetId",
     Connectioninfo_ByServerId = "Ams.ServersAdmin.Connectioninfo_ByServerId"
 }
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ServersAdmin.Server_ByServerId, input]
+ * }
+ * ```
+ */
 declare const useServersAdminApi_GetServer_ByServerId: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     serverID: string;
 }, options?: Omit<UseQueryOptions<FleetServerInfoResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<FleetServerInfoResponse>) => void) => UseQueryResult<FleetServerInfoResponse, AxiosError<ApiError>>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ServersAdmin.History_ByServerId, input]
+ * }
+ * ```
+ */
 declare const useServersAdminApi_GetHistory_ByServerId: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     serverID: string;
 }, options?: Omit<UseQueryOptions<FleetServerHistoryResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<FleetServerHistoryResponse>) => void) => UseQueryResult<FleetServerHistoryResponse, AxiosError<ApiError>>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:ARMADA:FLEET [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ServersAdmin.ServersHistory_ByFleetId, input]
+ * }
+ * ```
+ */
 declare const useServersAdminApi_GetServersHistory_ByFleetId: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     fleetID: string;
     queryParams?: {
@@ -248,6 +627,17 @@ declare const useServersAdminApi_GetServersHistory_ByFleetId: (sdk: AccelByteSDK
         status?: string | null;
     };
 }, options?: Omit<UseQueryOptions<DsHistoryList, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<DsHistoryList>) => void) => UseQueryResult<DsHistoryList, AxiosError<ApiError>>;
+/**
+ * Required Permission: ADMIN:NAMESPACE:{namespace}:AMS:DS:LOGS [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_ServersAdmin.Connectioninfo_ByServerId, input]
+ * }
+ * ```
+ */
 declare const useServersAdminApi_GetConnectioninfo_ByServerId: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     serverID: string;
 }, options?: Omit<UseQueryOptions<FleetServerConnectionInfoResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<FleetServerConnectionInfoResponse>) => void) => UseQueryResult<FleetServerConnectionInfoResponse, AxiosError<ApiError>>;
@@ -259,6 +649,17 @@ declare const useServersAdminApi_GetConnectioninfo_ByServerId: (sdk: AccelByteSD
 declare enum Key_Account {
     Account = "Ams.Account.Account"
 }
+/**
+ * Required Permission: NAMESPACE:{namespace}:AMS:ACCOUNT [READ]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_Account.Account, input]
+ * }
+ * ```
+ */
 declare const useAccountApi_GetAccount: (sdk: AccelByteSDK, input: SdkSetConfigParam, options?: Omit<UseQueryOptions<AccountResponse, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<AccountResponse>) => void) => UseQueryResult<AccountResponse, AxiosError<ApiError>>;
 
 /**
@@ -277,6 +678,17 @@ declare const useAmsInfoApi_GetUploadUrl: (sdk: AccelByteSDK, input: SdkSetConfi
 declare enum Key_Auth {
     Auth = "Ams.Auth.Auth"
 }
+/**
+ * Check if fleet commander is authorized to talk to AMS with this IAM
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_Auth.Auth, input]
+ * }
+ * ```
+ */
 declare const useAuthApi_GetAuth: (sdk: AccelByteSDK, input: SdkSetConfigParam, options?: Omit<UseQueryOptions<unknown, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<unknown>) => void) => UseQueryResult<unknown, AxiosError<ApiError>>;
 
 /**
@@ -296,11 +708,33 @@ declare enum Key_Fleets {
     ServerClaim = "Ams.Fleets.ServerClaim",
     Claim_ByFleetId = "Ams.Fleets.Claim_ByFleetId"
 }
+/**
+ * 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]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_Fleets.ServerClaim, input]
+ * }
+ * ```
+ */
 declare const useFleetsApi_UpdateServerClaim: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<FleetClaimResponse, AxiosError<ApiError>, SdkSetConfigParam & {
     data: FleetClaimByKeysReq;
 }>, "mutationKey">, callback?: (data: FleetClaimResponse) => void) => UseMutationResult<FleetClaimResponse, AxiosError<ApiError>, SdkSetConfigParam & {
     data: FleetClaimByKeysReq;
 }>;
+/**
+ * Required Permission: NAMESPACE:{namespace}:AMS:SERVER:CLAIM [UPDATE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_Fleets.Claim_ByFleetId, input]
+ * }
+ * ```
+ */
 declare const useFleetsApi_UpdateClaim_ByFleetId: (sdk: AccelByteSDK, options?: Omit<UseMutationOptions<FleetClaimResponse, AxiosError<ApiError>, SdkSetConfigParam & {
     fleetID: string;
     data: FleetClaimReq;
@@ -317,9 +751,31 @@ declare enum Key_Watchdogs {
     Connect_ByWatchdogId = "Ams.Watchdogs.Connect_ByWatchdogId",
     Connect_ByWatchdogId_ByNS = "Ams.Watchdogs.Connect_ByWatchdogId_ByNS"
 }
+/**
+ * This is to support local ds development scenarios Required Permission: NAMESPACE:{namespace}:AMS:LOCALDS [CREATE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_Watchdogs.Connect_ByWatchdogId, input]
+ * }
+ * ```
+ */
 declare const useWatchdogsApi_GetConnect_ByWatchdogId: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     watchdogID: string;
 }, options?: Omit<UseQueryOptions<unknown, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<unknown>) => void) => UseQueryResult<unknown, AxiosError<ApiError>>;
+/**
+ * Required Permission: NAMESPACE:{namespace}:ARMADA:WATCHDOG [CREATE]
+ *
+ * #### Default Query Options
+ * The default options include:
+ * ```
+ * {
+ *    queryKey: [Key_Watchdogs.Connect_ByWatchdogId_ByNS, input]
+ * }
+ * ```
+ */
 declare const useWatchdogsApi_GetConnect_ByWatchdogId_ByNS: (sdk: AccelByteSDK, input: SdkSetConfigParam & {
     watchdogID: string;
 }, options?: Omit<UseQueryOptions<unknown, AxiosError<ApiError>>, "queryKey">, callback?: (data: AxiosResponse<unknown>) => void) => UseQueryResult<unknown, AxiosError<ApiError>>;