@indiegems/gem-web-sdk 5.9.0

package/dist/server-api.d.ts

@@ -0,0 +1,1078 @@
+interface Clock {
+    now(): number;
+    setTimeout(fn: () => void, ms: number): unknown;
+    clearTimeout(handle: unknown): void;
+}
+declare const CONDITIONAL_HEADERS: readonly [
+    "if-match",
+    "if-none-match"
+];
+type ConditionalRequestHeaders = Partial<Record<(typeof CONDITIONAL_HEADERS)[number], string>>;
+interface TransportRequest {
+    readonly method: "GET" | "PUT" | "POST" | "PATCH" | "DELETE";
+    readonly path: string;
+    readonly body?: unknown;
+    readonly headers?: ConditionalRequestHeaders;
+    readonly signal?: AbortSignal;
+    readonly keepalive?: boolean;
+}
+interface TransportResponse {
+    readonly status: number;
+    readonly body: unknown;
+    readonly etag?: string;
+    readonly retryAfterSeconds?: number;
+}
+interface Transport {
+    request(request: TransportRequest): Promise<TransportResponse>;
+}
+type Base64String = string & {
+    readonly __contentEncoding: "base64";
+};
+interface ClientOptions {
+    readonly transport: Transport;
+    readonly clock: Clock;
+    readonly maxRetries?: number;
+}
+interface RequestOptions {
+    readonly keepalive?: boolean;
+    readonly ifMatch?: string;
+    readonly replaySafe?: boolean;
+}
+interface VersionedGetOptions {
+    readonly signal?: AbortSignal;
+    readonly ifNoneMatch?: string;
+}
+type VersionedResponse<T> = {
+    readonly modified: true;
+    readonly body: T;
+    readonly etag?: string;
+} | {
+    readonly modified: false;
+    readonly etag?: string;
+};
+declare class GemClient {
+    private readonly options;
+    constructor(options: ClientOptions);
+    get<T>(path: string, signal?: AbortSignal): Promise<T>;
+    getWithEtag<T>(path: string, options?: VersionedGetOptions): Promise<VersionedResponse<T>>;
+    put<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
+    post<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
+    patch<T>(path: string, body: unknown, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
+    delete<T>(path: string, signal?: AbortSignal, options?: RequestOptions): Promise<T>;
+    private send;
+    private sendRaw;
+    private backoff;
+}
+interface GameApi {
+    readonly client: GemClient;
+    gameId(): string;
+}
+type ActiveWindowResponse = {
+    "ends_at": string;
+    "window_id": string;
+};
+type AdminActionRequest = {
+    "action": "mute";
+    "player_id": string;
+} | {
+    "action": "unmute";
+    "player_id": string;
+} | {
+    "action": "remove";
+    "player_id": string;
+} | {
+    "action": "ban";
+    "player_id": string;
+} | {
+    "action": "move_channel";
+    "channel": string;
+    "player_id": string;
+} | {
+    "action": "proximity_params";
+    "hearing_radius"?: number | null;
+    "max_voices"?: number | null;
+};
+type BatchOrderItem = {
+    "nonce"?: string | null;
+    "operations": OperationRequest[];
+    "source_reference"?: string | null;
+};
+type BatchOrderItemResult = {
+    "auto_claimed_rewards"?: InventoryChange[];
+    "changes": InventoryChange[];
+    "nonce"?: string | null;
+    "order_id": string;
+    "status": OrderStatus;
+};
+type BatchOrderRequest = {
+    "channel"?: null | GameChannel;
+    "game_id"?: string | null;
+    "orders": BatchOrderItem[];
+    "source": OrderSource;
+};
+type BatchOrderResponse = {
+    "etag"?: string | null;
+    "orders": BatchOrderItemResult[];
+    "status": OrderStatus;
+};
+type BucketBalanceResponse = {
+    "balance": number;
+    "bucket": string;
+};
+type CatalogItem = {
+    "consumable": boolean;
+    "display_name"?: string | null;
+    "fungible": boolean;
+    "icon_url"?: string | null;
+    "item_id": string;
+    "platform_prices": PurchasePrice[];
+    "stack_size"?: number | null;
+};
+type CatalogRecipe = {
+    "availability_end"?: string | null;
+    "availability_start"?: string | null;
+    "catalog_id": string;
+    "cooldown_seconds"?: number | null;
+    "display_name"?: string | null;
+    "max_uses"?: number | null;
+    "platform_prices": PurchasePrice[];
+    "recipe_id": string;
+    "recipe_type": string;
+};
+type ClientPlatform = "universal" | "mobile" | "web";
+type CreateOrderRequest = {
+    "channel"?: null | GameChannel;
+    "game_id"?: string | null;
+    "nonce"?: string | null;
+    "operations": OperationRequest[];
+    "source": OrderSource;
+    "source_reference"?: string | null;
+};
+type CreateSessionRequest = {
+    "channel_assignments": Record<string, unknown>;
+    "game_id": string;
+    "members": string[];
+    "mode_override"?: string | null;
+    "region": string;
+    "session_id": string;
+    "text_chat_enabled_override"?: boolean | null;
+};
+type CurrencyBalanceResponse = {
+    "buckets"?: BucketBalanceResponse[] | null;
+    "currency_id": string;
+    "total": number;
+};
+type CurrencyResetOverride = {
+    "bucket": string;
+    "currency_id": string;
+    "last_reset_at"?: string | null;
+    "next_reset_at"?: string | null;
+};
+type DropRateEntry = {
+    "drop_rate": number;
+    "entry_id": string;
+    "rarity_tier"?: string | null;
+    "weight": number;
+};
+type DropRatesResponse = {
+    "allow_duplicate_rolls": boolean;
+    "entries": DropRateEntry[];
+    "loot_table_id": string;
+    "name": string;
+    "roll_count": number;
+    "total_weight": number;
+};
+type EntityLeaderboardEntryResponse = {
+    "occurred_at": number;
+    "properties"?: Record<string, unknown> | null;
+    "rank": number;
+    "stats"?: Record<string, unknown> | null;
+};
+type EntityLeaderboardResponse = {
+    "bucket_1"?: string | null;
+    "bucket_2"?: string | null;
+    "entity_id": string;
+    "entity_type": EntityType;
+    "entries": EntityLeaderboardEntryResponse[];
+    "generated_at": number;
+    "leaderboard_type": string;
+    "personal_best"?: null | EntityLeaderboardEntryResponse;
+    "run_type": string;
+    "total_runs": number;
+    "total_runs_exact": boolean;
+};
+type EntityType = "player" | "character";
+type ErrorDetail = {
+    "code": string;
+    "details"?: unknown;
+    "message": string;
+};
+type ErrorResponse = {
+    "error": ErrorDetail;
+};
+type EventDefinitionResponse = {
+    "created_at": string;
+    "description": string;
+    "display_name": string;
+    "event_id": string;
+    "icon_url": string;
+    "is_enabled": boolean;
+    "metadata": unknown;
+    "schedule": unknown;
+    "schedule_type": string;
+    "slug"?: string | null;
+    "status"?: null | EventStatusInfo;
+    "updated_at": string;
+};
+type EventListResponse = {
+    "events": EventDefinitionResponse[];
+    "limit": number;
+    "offset": number;
+    "total": number;
+};
+type EventStatusInfo = {
+    "current_window"?: null | ActiveWindowResponse;
+    "is_active": boolean;
+    "next_window"?: null | WindowPreviewResponse;
+};
+type FidelityReport = {
+    "caveats": string[];
+    "defaults_applied": string[];
+};
+type GameChannel = "dev" | "test" | "release";
+type GameRoomMemberResponseV2 = {
+    "avatar_icon_id"?: string | null;
+    "discriminator"?: string | null;
+    "display_name"?: string | null;
+    "display_tag"?: string | null;
+    "group_id"?: string | null;
+    "is_ready": boolean;
+    "joined_at": number;
+    "platform"?: null | ClientPlatform;
+    "player_id": string;
+    "role": string;
+};
+type GameRoomResponseV2 = {
+    "created_at": number;
+    "game_channel": string;
+    "game_id": string;
+    "game_room_type": string;
+    "host_player_id": string;
+    "id": string;
+    "is_public": boolean;
+    "join_code"?: string | null;
+    "match_id"?: string | null;
+    "max_players": number;
+    "member_count": number;
+    "members": GameRoomMemberResponseV2[];
+    "name": string;
+    "region"?: string | null;
+    "room_args"?: Record<string, unknown> | null;
+    "room_args_template"?: null | RoomArgsTemplate;
+    "settings"?: unknown;
+    "started_at"?: number | null;
+    "status": string;
+    "template_id"?: string | null;
+    "template_slug"?: string | null;
+    "transports": string[];
+    "updated_at": number;
+    "version": number;
+};
+type GameRoomSummaryResponse = {
+    "created_at": number;
+    "game_channel": string;
+    "game_id": string;
+    "game_room_type": string;
+    "host_player_id": string;
+    "id": string;
+    "is_public": boolean;
+    "max_players": number;
+    "member_count": number;
+    "name": string;
+    "status": string;
+    "template_slug"?: string | null;
+};
+type GameRoomTemplateListResponse = {
+    "templates": GameRoomTemplateResponse[];
+};
+type GameRoomTemplateResponse = {
+    "allow_host_transfer": boolean;
+    "allow_join_in_progress": boolean;
+    "allow_kick": boolean;
+    "allow_party_join": boolean;
+    "allow_ready_check": boolean;
+    "auto_close_when_empty": boolean;
+    "auto_leave_on_client_shutdown": boolean;
+    "auto_start_host": boolean;
+    "default_visibility": string;
+    "game_id"?: string | null;
+    "game_room_ttl_seconds": number;
+    "game_room_type": string;
+    "id": string;
+    "idle_timeout_seconds"?: number | null;
+    "is_active": boolean;
+    "match_type": MatchType;
+    "max_match_duration_seconds": number;
+    "max_players": number;
+    "min_players": number;
+    "name": string;
+    "notify_on_host_transfer": string;
+    "notify_on_join": string;
+    "notify_on_kick": string;
+    "notify_on_leave": string;
+    "notify_on_ready": string;
+    "offline_member_timeout_seconds"?: number | null;
+    "room_args_template"?: null | RoomArgsTemplate;
+    "show_in_browser": boolean;
+    "slug"?: string | null;
+    "transports": string[];
+};
+type GameRoomsListResponse = {
+    "game_rooms": GameRoomSummaryResponse[];
+    "next_cursor"?: string | null;
+};
+type InitiateTransferRequest = {
+    "currencies"?: TransferCurrencyRequest[];
+    "items"?: TransferItemRequest[];
+    "message"?: string | null;
+    "nonce": string;
+    "source_entity_id": string;
+    "source_entity_type": string;
+    "target_entity_id": string;
+    "target_entity_type": string;
+};
+type InventoryChange = {
+    "balance_after": number;
+    "balance_before": number;
+    "bucket": string;
+    "currency_id": string;
+    "delta": number;
+    "type": "currency";
+} | {
+    "delta": number;
+    "instance_id": string;
+    "item_definition_id": string;
+    "quantity_after": number;
+    "quantity_before": number;
+    "type": "item";
+} | {
+    "instance_id": string;
+    "item_definition_id": string;
+    "properties_after": unknown;
+    "properties_before": unknown;
+    "type": "item_properties_changed";
+} | {
+    "custom_data_after": unknown;
+    "custom_data_before": unknown;
+    "instance_id": string;
+    "item_definition_id": string;
+    "type": "item_custom_data_changed";
+} | {
+    "completed": boolean;
+    "delta": number;
+    "depth"?: number;
+    "op_index"?: number | null;
+    "progression_definition_id": string;
+    "type": "progression";
+    "value_after": number;
+    "value_before": number;
+} | {
+    "clamped_by": PlatformGrantClamp;
+    "granted": number;
+    "mapping_index": number;
+    "outcome": PlatformGrantOutcome;
+    "progression_definition_id": string;
+    "reason"?: string | null;
+    "requested": number;
+    "target_currency_id": string;
+    "type": "platform_grant";
+} | {
+    "balance_after": number;
+    "balance_before": number;
+    "bucket": string;
+    "currency_id": string;
+    "type": "currency_bucket_reset";
+} | {
+    "progression_definition_id": string;
+    "reset_reason": string;
+    "type": "progression_reset";
+    "value_before": number;
+    "was_completed": boolean;
+} | {
+    "type": "unknown";
+};
+type InventoryResponse = {
+    "currencies": PaginatedCollectionCurrencyBalanceResponse;
+    "entity_id": string;
+    "etag": string;
+    "items": PaginatedCollectionItemInstanceResponse;
+    "progressions": PaginatedCollectionProgressionStateResponse;
+    "scope": InventoryScopeResponse;
+};
+type InventoryScopeResponse = {
+    "type": "platform";
+} | {
+    "channel": GameChannel;
+    "game_id": string;
+    "type": "game";
+};
+type ItemInstanceResponse = {
+    "acquired_at": number;
+    "custom_data"?: unknown;
+    "instance_id": string;
+    "item_definition_id": string;
+    "properties": unknown;
+    "quantity": number;
+};
+type LeaderboardEntryResponse = {
+    "discriminator"?: string | null;
+    "display_name"?: string | null;
+    "display_tag"?: string | null;
+    "entity_id"?: string | null;
+    "entity_type"?: null | EntityType;
+    "is_viewer"?: boolean;
+    "occurred_at": number;
+    "properties"?: Record<string, unknown> | null;
+    "rank": number;
+    "stats"?: Record<string, unknown> | null;
+};
+type LeaderboardResponse = {
+    "bucket_1"?: string | null;
+    "bucket_2"?: string | null;
+    "entries": LeaderboardEntryResponse[];
+    "generated_at": number;
+    "leaderboard_type": string;
+    "run_type": string;
+    "update_frequency_seconds": number;
+};
+type ListTransfersResponse = {
+    "next_cursor"?: string | null;
+    "transfers": TransferResponse[];
+};
+type LootRollResultResponse = {
+    "entry_id": string;
+    "grants": InventoryChange[];
+    "rarity_tier"?: string | null;
+    "roll_number": number;
+    "was_replacement": boolean;
+};
+type MatchType = "dedicated" | "p2p" | "none";
+type OperationRequest = {
+    "amount": number;
+    "bucket"?: string | null;
+    "currency_id": SlugOrId;
+    "overflow"?: OverflowBehavior;
+    "reason"?: string | null;
+    "type": "currency_grant";
+} | {
+    "amount": number;
+    "bucket"?: string | null;
+    "currency_id": SlugOrId;
+    "overflow"?: OverflowBehavior;
+    "reason"?: string | null;
+    "type": "currency_consume";
+} | {
+    "amount": number;
+    "bucket"?: string | null;
+    "currency_id": SlugOrId;
+    "reason"?: string | null;
+    "type": "currency_set";
+} | {
+    "custom_data"?: Record<string, unknown> | null;
+    "instance_id"?: string | null;
+    "item_definition_id": SlugOrId;
+    "overflow"?: OverflowBehavior;
+    "properties"?: Record<string, unknown> | null;
+    "quantity"?: number;
+    "reason"?: string | null;
+    "type": "item_grant";
+} | {
+    "instance_id"?: string | null;
+    "item_definition_id": SlugOrId;
+    "overflow"?: OverflowBehavior;
+    "quantity"?: number;
+    "reason"?: string | null;
+    "type": "item_remove";
+} | {
+    "instance_id": string;
+    "item_definition_id": SlugOrId;
+    "properties": Record<string, unknown>;
+    "reason"?: string | null;
+    "type": "item_set_properties";
+} | {
+    "instance_id": string;
+    "item_definition_id": SlugOrId;
+    "reason"?: string | null;
+    "type": "item_set_custom_data";
+    "updates": Record<string, unknown>;
+} | {
+    "amount": number;
+    "progression_definition_id": SlugOrId;
+    "reason"?: string | null;
+    "type": "progression_add";
+} | {
+    "progression_definition_id": SlugOrId;
+    "reason"?: string | null;
+    "type": "progression_set";
+    "value": number;
+} | {
+    "progression_definition_id": SlugOrId;
+    "reason"?: string | null;
+    "type": "progression_max";
+    "value": number;
+} | {
+    "progression_definition_id": SlugOrId;
+    "reason"?: string | null;
+    "type": "progression_reset";
+};
+type OrderListResponse = {
+    "has_more": boolean;
+    "next_cursor"?: string | null;
+    "orders": OrderRecordResponse[];
+};
+type OrderRecordResponse = {
+    "created_at": number;
+    "nonce"?: string | null;
+    "order_id": string;
+    "source": OrderSource;
+    "source_reference"?: string | null;
+    "status": string;
+};
+type OrderResponse = {
+    "changes"?: InventoryChange[];
+    "error"?: string | null;
+    "etag"?: string | null;
+    "order_id": string;
+    "status": OrderStatus;
+};
+type OrderSource = "real_money_purchase" | "real_money_refund" | "full_game_purchase" | "full_game_refund" | "platform_purchase" | "reward" | "admin" | "system" | "promo" | "game_consume" | "play" | "recipe" | "transfer" | "platform_funded_game_inventory_purchase";
+type OrderStatus = "completed" | "failed";
+type OverflowBehavior = "fail" | "clamp" | "allow";
+type PaginatedCollectionCurrencyBalanceResponse = {
+    "data": {
+        "buckets"?: BucketBalanceResponse[] | null;
+        "currency_id": string;
+        "total": number;
+    }[];
+    "has_more": boolean;
+    "next_cursor"?: string | null;
+};
+type PaginatedCollectionItemInstanceResponse = {
+    "data": {
+        "acquired_at": number;
+        "custom_data"?: unknown;
+        "instance_id": string;
+        "item_definition_id": string;
+        "properties": unknown;
+        "quantity": number;
+    }[];
+    "has_more": boolean;
+    "next_cursor"?: string | null;
+};
+type PaginatedCollectionProgressionStateResponse = {
+    "data": {
+        "completion_count": number;
+        "current_value": number;
+        "is_completed": boolean;
+        "progression_definition_id": string;
+    }[];
+    "has_more": boolean;
+    "next_cursor"?: string | null;
+};
+type PaginatedResponseSaveDataResponse = {
+    "data": {
+        "created_at": number;
+        "download_url"?: string | null;
+        "entity_id": string;
+        "entity_type": string;
+        "etag": string;
+        "key": string;
+        "metadata"?: unknown;
+        "size_bytes": number;
+        "updated_at": number;
+    }[];
+    "has_more": boolean;
+    "next_cursor"?: string | null;
+};
+type PlatformGrantClamp = "none" | "max_per_event" | "game_max_per_entity" | "platform_max_per_game_per_entity" | "max_balance";
+type PlatformGrantOutcome = "fired" | "clamped" | "suppressed";
+type ProgressionAddRequest = {
+    "amount": number;
+    "reason"?: string | null;
+};
+type ProgressionClaimRequest = {
+    "channel"?: null | GameChannel;
+    "game_id": string;
+    "reason"?: string | null;
+    "track_id"?: string | null;
+};
+type ProgressionResetRequest = {
+    "reason"?: string | null;
+};
+type ProgressionStateOverride = {
+    "last_reset_at"?: string | null;
+    "last_window_id"?: string | null;
+    "progression_definition_id": string;
+    "rewards_claimed_through"?: Record<string, unknown> | null;
+};
+type ProgressionStateResponse = {
+    "completion_count": number;
+    "current_value": number;
+    "is_completed": boolean;
+    "progression_definition_id": string;
+};
+type PurchaseCatalogResponse = {
+    "config_version": number;
+    "items": CatalogItem[];
+    "recipes": CatalogRecipe[];
+};
+type PurchasePrice = {
+    "platform_currency_id": string;
+    "price": number;
+};
+type PutSettingRequest = {
+    "value": Base64String;
+};
+type RecipeAvailabilityResponse = {
+    "can_execute": boolean;
+    "cooldown_expires_at"?: string | null;
+    "reasons": UnavailabilityReason[];
+    "recipe_id": string;
+    "uses_remaining"?: number | null;
+};
+type RecipeExecuteRequest = {
+    "catalog_id": SlugOrId;
+    "channel"?: null | GameChannel;
+    "game_id": string;
+    "nonce"?: string | null;
+    "recipe_id": SlugOrId;
+};
+type RecipeExecuteResponse = {
+    "auto_claimed_rewards": InventoryChange[];
+    "consumed": InventoryChange[];
+    "etag"?: string | null;
+    "granted": InventoryChange[];
+    "loot_results"?: LootRollResultResponse[] | null;
+    "order_id": string;
+    "status": OrderStatus;
+};
+type RecipeUsageListResponse = {
+    "usages": RecipeUsageResponse[];
+};
+type RecipeUsageResponse = {
+    "cooldown_expires_at"?: string | null;
+    "is_on_cooldown": boolean;
+    "last_used_at"?: string | null;
+    "recipe_id": string;
+    "use_count": number;
+};
+type RoomArgType = "string" | "int" | "float" | "bool";
+type RoomArgsResponse = {
+    "room_args": Record<string, unknown>;
+    "room_args_template": RoomArgsTemplate;
+};
+type RoomArgsTemplate = {
+    "name": string;
+} & {
+    "allowed"?: Record<string, unknown>[] | null;
+    "default"?: Record<string, unknown> | null;
+    "description"?: string | null;
+    "fixed"?: Record<string, unknown> | null;
+    "list"?: boolean;
+    "max"?: number | null;
+    "max_items"?: number | null;
+    "max_length"?: number | null;
+    "min"?: number | null;
+    "min_items"?: number | null;
+    "mutable"?: boolean | null;
+    "required"?: boolean;
+    "type": RoomArgType;
+}[];
+type SaveDataResponse = {
+    "created_at": number;
+    "download_url"?: string | null;
+    "entity_id": string;
+    "entity_type": string;
+    "etag": string;
+    "key": string;
+    "metadata"?: unknown;
+    "size_bytes": number;
+    "updated_at": number;
+};
+type SaveFinalizeRequest = {
+    "session_id": string;
+};
+type SaveUploadUrlRequest = {
+    "content_type"?: string;
+    "metadata"?: unknown;
+    "size_bytes": number;
+};
+type SaveUploadUrlResponse = {
+    "expires_at": number;
+    "session_id": string;
+    "upload_headers": Record<string, unknown>;
+    "upload_url": string;
+};
+type SettingResponse = {
+    "etag": string;
+    "key": string;
+    "updated_at": number;
+    "value": Base64String;
+};
+type SettingsListResponse = {
+    "settings": SettingResponse[];
+};
+type SimulateOrderRequest = {
+    "inventory": SuppliedInventory;
+    "order": CreateOrderRequest;
+    "overrides"?: SimulationOverrides;
+    "seed"?: string | null;
+    "simulated_at"?: string | null;
+};
+type SimulateOrderResponse = {
+    "auto_claimed_rewards": InventoryChange[];
+    "changes": InventoryChange[];
+    "fidelity": FidelityReport;
+    "generation_details"?: unknown;
+    "outcome": SimulationOutcome;
+    "resulting_etag": string;
+    "resulting_inventory": InventoryResponse;
+    "seed": string;
+    "simulation_id": string;
+};
+type SimulationFailure = {
+    "code": string;
+    "message": string;
+    "operation_index"?: number | null;
+};
+type SimulationOutcome = {
+    "failure"?: null | SimulationFailure;
+    "status": OrderStatus;
+};
+type SimulationOverrides = {
+    "currencies"?: CurrencyResetOverride[];
+    "progressions"?: ProgressionStateOverride[];
+};
+type SlugOrId = string;
+type SuppliedBucketRow = {
+    "balance": number;
+    "bucket": string;
+};
+type SuppliedCurrencies = {
+    "data"?: SuppliedCurrencyRow[];
+    "has_more"?: boolean;
+    "next_cursor"?: string | null;
+};
+type SuppliedCurrencyRow = {
+    "buckets"?: SuppliedBucketRow[] | null;
+    "currency_id": string;
+    "total": number;
+};
+type SuppliedInventory = {
+    "currencies"?: SuppliedCurrencies;
+    "entity_id"?: string | null;
+    "etag"?: string;
+    "items"?: SuppliedItems;
+    "progressions"?: SuppliedProgressions;
+    "scope"?: null | SuppliedScope;
+};
+type SuppliedItemRow = {
+    "acquired_at"?: number | null;
+    "custom_data"?: unknown;
+    "instance_id": string;
+    "item_definition_id": string;
+    "properties"?: unknown;
+    "quantity": number;
+};
+type SuppliedItems = {
+    "data"?: SuppliedItemRow[];
+    "has_more"?: boolean;
+    "next_cursor"?: string | null;
+};
+type SuppliedProgressionRow = {
+    "completion_count": number;
+    "current_value": number;
+    "is_completed": boolean;
+    "progression_definition_id": string;
+};
+type SuppliedProgressions = {
+    "data"?: SuppliedProgressionRow[];
+    "has_more"?: boolean;
+    "next_cursor"?: string | null;
+};
+type SuppliedScope = {
+    "type": "platform";
+} | {
+    "channel"?: null | GameChannel;
+    "game_id": string;
+    "type": "game";
+};
+type TransferCurrencyRequest = {
+    "amount": number;
+    "currency_id": string;
+};
+type TransferItemRequest = {
+    "instance_id"?: string | null;
+    "item_definition_id": string;
+    "quantity": number;
+};
+type TransferResponse = {
+    "created_at": string;
+    "currencies": unknown;
+    "expires_at": string;
+    "items": unknown;
+    "message"?: string | null;
+    "resolved_at"?: string | null;
+    "source_entity_id": string;
+    "source_entity_type": string;
+    "status": string;
+    "target_entity_id": string;
+    "target_entity_type": string;
+    "transfer_id": string;
+};
+type UnavailabilityReason = {
+    "type": "not_found";
+} | {
+    "type": "inactive";
+} | {
+    "type": "not_client_executable";
+} | {
+    "available_from": string;
+    "type": "not_yet_available";
+} | {
+    "expired_at": string;
+    "type": "expired";
+} | {
+    "event_id": string;
+    "type": "event_not_active";
+} | {
+    "expires_at": string;
+    "type": "on_cooldown";
+} | {
+    "max_uses": number;
+    "type": "max_uses_reached";
+} | {
+    "prerequisite_type": string;
+    "reference_id": string;
+    "type": "prerequisite_not_met";
+} | {
+    "available": number;
+    "currency_id": string;
+    "required": number;
+    "type": "insufficient_currency";
+} | {
+    "available": number;
+    "item_definition_id": string;
+    "required": number;
+    "type": "insufficient_items";
+};
+type UpdateGameRoomRequest = {
+    "is_public"?: boolean | null;
+    "max_players"?: number | null;
+    "name"?: string | null;
+    "room_args"?: Record<string, unknown> | null;
+    "settings"?: unknown;
+};
+type UpdateRoomArgsRequest = {
+    "room_args": Record<string, unknown>;
+};
+type WindowPreviewResponse = {
+    "ends_at": string;
+    "starts_at": string;
+};
+declare function acceptTransfer(api: GameApi, transfer_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<TransferResponse>;
+declare function addEntityProgression(api: GameApi, entity_type: string, entity_id: string, progression_definition_id: SlugOrId, body: ProgressionAddRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<OrderResponse>;
+declare function adminAction(api: GameApi, session_id: string, body: AdminActionRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<void>;
+declare function cancelInventoryTransfer(api: GameApi, transfer_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<TransferResponse>;
+declare function claimEntityProgressionRewards(api: GameApi, entity_type: string, entity_id: string, progression_definition_id: SlugOrId, body: ProgressionClaimRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<OrderResponse>;
+declare function closeGameRoom(api: GameApi, game_room_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<void>;
+declare function createEntityBatchOrder(api: GameApi, entity_type: string, entity_id: string, body: BatchOrderRequest, options?: {
+    ifMatch?: string;
+    signal?: AbortSignal;
+}): Promise<BatchOrderResponse>;
+declare function createEntityOrder(api: GameApi, entity_type: string, entity_id: string, body: CreateOrderRequest, options?: {
+    ifMatch?: string;
+    signal?: AbortSignal;
+}): Promise<OrderResponse>;
+declare function createSession(api: GameApi, body: CreateSessionRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<void>;
+declare function deleteEntityGameSetting(api: GameApi, entity_type: string, entity_id: string, key: string, options?: {
+    signal?: AbortSignal;
+}): Promise<void>;
+declare function deleteEntitySave(api: GameApi, entity_type: string, entity_id: string, key: string, options?: {
+    signal?: AbortSignal;
+}): Promise<void>;
+declare function deleteSession(api: GameApi, session_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<void>;
+declare function executeEntityRecipe(api: GameApi, entity_type: string, entity_id: string, body: RecipeExecuteRequest, options?: {
+    ifMatch?: string;
+    signal?: AbortSignal;
+}): Promise<RecipeExecuteResponse>;
+declare function finalizeSaveUpload(api: GameApi, entity_type: string, entity_id: string, key: string, body: SaveFinalizeRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<SaveDataResponse>;
+declare function getDropRates(api: GameApi, loot_table_id: SlugOrId, options?: {
+    signal?: AbortSignal;
+}): Promise<DropRatesResponse>;
+declare function getEntityCurrency(api: GameApi, entity_type: string, entity_id: string, currency_id: SlugOrId, options?: {
+    signal?: AbortSignal;
+}): Promise<CurrencyBalanceResponse>;
+declare function getEntityGameSetting(api: GameApi, entity_type: string, entity_id: string, key: string, options?: {
+    ifNoneMatch?: string;
+    signal?: AbortSignal;
+}): Promise<VersionedResponse<SettingResponse>>;
+declare function getEntityInventory(api: GameApi, entity_type: string, entity_id: string, options?: {
+    "include_buckets"?: boolean;
+    "currency_limit"?: number;
+    "currency_cursor"?: string;
+    "item_limit"?: number;
+    "item_cursor"?: string;
+    "progression_limit"?: number;
+    "progression_cursor"?: string;
+    signal?: AbortSignal;
+}): Promise<InventoryResponse>;
+declare function getEntityInventoryItem(api: GameApi, entity_type: string, entity_id: string, item_definition_id: SlugOrId, options?: {
+    signal?: AbortSignal;
+}): Promise<ItemInstanceResponse[]>;
+declare function getEntityLeaderboard(api: GameApi, leaderboard_type: string, entity_type: string, entity_id: string, options?: {
+    "bucket_1"?: string;
+    "bucket_2"?: string;
+    "limit"?: number;
+    signal?: AbortSignal;
+}): Promise<EntityLeaderboardResponse>;
+declare function getEntityOrder(api: GameApi, entity_type: string, entity_id: string, order_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<OrderRecordResponse>;
+declare function getEntityProgression(api: GameApi, entity_type: string, entity_id: string, progression_definition_id: SlugOrId, options?: {
+    signal?: AbortSignal;
+}): Promise<ProgressionStateResponse>;
+declare function getEntityRecipeAvailability(api: GameApi, entity_type: string, entity_id: string, catalog_id: SlugOrId, recipe_id: SlugOrId, options?: {
+    signal?: AbortSignal;
+}): Promise<RecipeAvailabilityResponse>;
+declare function getEntityRecipeUsage(api: GameApi, entity_type: string, entity_id: string, options?: {
+    "limit"?: number;
+    signal?: AbortSignal;
+}): Promise<RecipeUsageListResponse>;
+declare function getEntitySave(api: GameApi, entity_type: string, entity_id: string, key: string, options?: {
+    ifNoneMatch?: string;
+    signal?: AbortSignal;
+}): Promise<VersionedResponse<SaveDataResponse>>;
+declare function getEvent(api: GameApi, event_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<EventDefinitionResponse>;
+declare function getGameRoomV2(api: GameApi, game_room_id: string, options?: {
+    ifNoneMatch?: string;
+    signal?: AbortSignal;
+}): Promise<VersionedResponse<GameRoomResponseV2>>;
+declare function getLeaderboard(api: GameApi, leaderboard_type: string, options?: {
+    "bucket_1"?: string;
+    "bucket_2"?: string;
+    signal?: AbortSignal;
+}): Promise<LeaderboardResponse>;
+declare function getPurchaseCatalog(api: GameApi, options?: {
+    "config_version"?: number;
+    signal?: AbortSignal;
+}): Promise<PurchaseCatalogResponse>;
+declare function getResolvedTemplate(api: GameApi, template_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<GameRoomTemplateResponse>;
+declare function getRoomArgs(api: GameApi, game_room_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<RoomArgsResponse>;
+declare function getTransferDetails(api: GameApi, transfer_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<TransferResponse>;
+declare function initiateInventoryTransfer(api: GameApi, body: InitiateTransferRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<TransferResponse>;
+declare function kickPlayer(api: GameApi, game_room_id: string, player_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<void>;
+declare function listEntityGameSettings(api: GameApi, entity_type: string, entity_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<SettingsListResponse>;
+declare function listEntityOrders(api: GameApi, entity_type: string, entity_id: string, options?: {
+    "limit"?: number;
+    "cursor"?: string;
+    signal?: AbortSignal;
+}): Promise<OrderListResponse>;
+declare function listEntityProgressions(api: GameApi, entity_type: string, entity_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<ProgressionStateResponse[]>;
+declare function listEntitySaves(api: GameApi, entity_type: string, entity_id: string, options?: {
+    "limit"?: number;
+    "cursor"?: string;
+    signal?: AbortSignal;
+}): Promise<PaginatedResponseSaveDataResponse>;
+declare function listEvents(api: GameApi, options?: {
+    "include_inactive"?: boolean;
+    "limit"?: number;
+    "offset"?: number;
+    signal?: AbortSignal;
+}): Promise<EventListResponse>;
+declare function listGameRooms(api: GameApi, options?: {
+    "status"?: string | null;
+    "game_channel"?: string | null;
+    "game_room_type"?: string | null;
+    "template_id"?: string | null;
+    "template_slug"?: string | null;
+    "limit"?: number | null;
+    "cursor"?: string | null;
+    signal?: AbortSignal;
+}): Promise<GameRoomsListResponse>;
+declare function listResolvedTemplates(api: GameApi, options?: {
+    signal?: AbortSignal;
+}): Promise<GameRoomTemplateListResponse>;
+declare function listTransfers(api: GameApi, options: {
+    "entity_type": string;
+    "entity_id": string;
+    "direction"?: string;
+    "status"?: string;
+    "cursor"?: string;
+    "limit"?: number;
+    signal?: AbortSignal;
+}): Promise<ListTransfersResponse>;
+declare function matchEnd(api: GameApi, match_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<void>;
+declare function putEntityGameSetting(api: GameApi, entity_type: string, entity_id: string, key: string, body: PutSettingRequest, options?: {
+    ifMatch?: string;
+    signal?: AbortSignal;
+}): Promise<SettingResponse>;
+declare function putRoomArgs(api: GameApi, game_room_id: string, body: UpdateRoomArgsRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<RoomArgsResponse>;
+declare function rejectTransfer(api: GameApi, transfer_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<TransferResponse>;
+declare function requestSaveUploadUrl(api: GameApi, entity_type: string, entity_id: string, key: string, body: SaveUploadUrlRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<SaveUploadUrlResponse>;
+declare function resetEntityProgression(api: GameApi, entity_type: string, entity_id: string, progression_definition_id: SlugOrId, body: ProgressionResetRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<OrderResponse>;
+declare function simulateEntityOrder(api: GameApi, entity_type: string, entity_id: string, body: SimulateOrderRequest, options?: {
+    signal?: AbortSignal;
+}): Promise<SimulateOrderResponse>;
+declare function transferHostV2(api: GameApi, game_room_id: string, player_id: string, options?: {
+    signal?: AbortSignal;
+}): Promise<GameRoomResponseV2>;
+declare function updateGameRoomV2(api: GameApi, game_room_id: string, body: UpdateGameRoomRequest, options?: {
+    ifMatch?: string;
+    signal?: AbortSignal;
+}): Promise<GameRoomResponseV2>;
+export { type ActiveWindowResponse, type AdminActionRequest, type BatchOrderItem, type BatchOrderItemResult, type BatchOrderRequest, type BatchOrderResponse, type BucketBalanceResponse, type CatalogItem, type CatalogRecipe, type ClientPlatform, type CreateOrderRequest, type CreateSessionRequest, type CurrencyBalanceResponse, type CurrencyResetOverride, type DropRateEntry, type DropRatesResponse, type EntityLeaderboardEntryResponse, type EntityLeaderboardResponse, type EntityType, type ErrorDetail, type ErrorResponse, type EventDefinitionResponse, type EventListResponse, type EventStatusInfo, type FidelityReport, type GameApi, type GameChannel, type GameRoomMemberResponseV2, type GameRoomResponseV2, type GameRoomSummaryResponse, type GameRoomTemplateListResponse, type GameRoomTemplateResponse, type GameRoomsListResponse, type InitiateTransferRequest, type InventoryChange, type InventoryResponse, type InventoryScopeResponse, type ItemInstanceResponse, type LeaderboardEntryResponse, type LeaderboardResponse, type ListTransfersResponse, type LootRollResultResponse, type MatchType, type OperationRequest, type OrderListResponse, type OrderRecordResponse, type OrderResponse, type OrderSource, type OrderStatus, type OverflowBehavior, type PaginatedCollectionCurrencyBalanceResponse, type PaginatedCollectionItemInstanceResponse, type PaginatedCollectionProgressionStateResponse, type PaginatedResponseSaveDataResponse, type PlatformGrantClamp, type PlatformGrantOutcome, type ProgressionAddRequest, type ProgressionClaimRequest, type ProgressionResetRequest, type ProgressionStateOverride, type ProgressionStateResponse, type PurchaseCatalogResponse, type PurchasePrice, type PutSettingRequest, type RecipeAvailabilityResponse, type RecipeExecuteRequest, type RecipeExecuteResponse, type RecipeUsageListResponse, type RecipeUsageResponse, type RoomArgType, type RoomArgsResponse, type RoomArgsTemplate, type SaveDataResponse, type SaveFinalizeRequest, type SaveUploadUrlRequest, type SaveUploadUrlResponse, type SettingResponse, type SettingsListResponse, type SimulateOrderRequest, type SimulateOrderResponse, type SimulationFailure, type SimulationOutcome, type SimulationOverrides, type SlugOrId, type SuppliedBucketRow, type SuppliedCurrencies, type SuppliedCurrencyRow, type SuppliedInventory, type SuppliedItemRow, type SuppliedItems, type SuppliedProgressionRow, type SuppliedProgressions, type SuppliedScope, type TransferCurrencyRequest, type TransferItemRequest, type TransferResponse, type UnavailabilityReason, type UpdateGameRoomRequest, type UpdateRoomArgsRequest, type WindowPreviewResponse, acceptTransfer, addEntityProgression, adminAction, cancelInventoryTransfer, claimEntityProgressionRewards, closeGameRoom, createEntityBatchOrder, createEntityOrder, createSession, deleteEntityGameSetting, deleteEntitySave, deleteSession, executeEntityRecipe, finalizeSaveUpload, getDropRates, getEntityCurrency, getEntityGameSetting, getEntityInventory, getEntityInventoryItem, getEntityLeaderboard, getEntityOrder, getEntityProgression, getEntityRecipeAvailability, getEntityRecipeUsage, getEntitySave, getEvent, getGameRoomV2, getLeaderboard, getPurchaseCatalog, getResolvedTemplate, getRoomArgs, getTransferDetails, initiateInventoryTransfer, kickPlayer, listEntityGameSettings, listEntityOrders, listEntityProgressions, listEntitySaves, listEvents, listGameRooms, listResolvedTemplates, listTransfers, matchEnd, putEntityGameSetting, putRoomArgs, rejectTransfer, requestSaveUploadUrl, resetEntityProgression, simulateEntityOrder, transferHostV2, updateGameRoomV2 };