@xmobitea/gn-typescript-client 2.6.13-tsc → 2.6.14

package/dist/runtime/GNNetworkStoreInventoryApi.d.ts

@@ -2,95 +2,404 @@ import { Action1 } from "./common/Action1";
 import { GNHashtable } from "./common/GNData";
 import { StoreInventoryModels } from "./entity/models/StoreInventoryModels";
 import { StoreInventoryResponseModels } from "./entity/models/StoreInventoryResponseModels";
+/**
+ * Public client-scoped namespace for the StoreInventory domain.
+ *
+ * Reachable through {@link GNNetwork.storeInventory} after
+ * {@link GNNetwork.init}. Manages storefront catalog reads,
+ * purchases, gifting and platform-receipt validation.
+ *
+ * Functional groupings:
+ *
+ * 1. **Catalog reads** — `getStoreItem`, `getStoreItems`,
+ *    `getStoreItemsWithSegment`,
+ *    `getStoreItemsWithTag`. Catalog rows carry
+ *    {@link StoreItemType} (`Consumable` /
+ *    `NonConsumable`).
+ * 2. **Purchase / gift** — `buyStoreItem` (paid with
+ *    in-game currency), `presentStoreItem` (gift to another
+ *    player), `redeemStoreItem` (apply a previously gifted
+ *    item).
+ * 3. **Platform receipt validation** —
+ *    `validateAppleAppStoreReceipt`,
+ *    `validateGooglePlayStoreReceipt`,
+ *    `validateFacebookStoreReceipt`. Each validates a
+ *    platform-specific receipt and grants the matching item
+ *    on success. The audit log captures the
+ *    {@link StoreReceiveType} for each grant.
+ * 4. **Audit log** — `getPurchaseLog`, `getReceiveLog`.
+ *    Read-only history of every item the player acquired
+ *    through the store.
+ *
+ * Common contract: same as {@link GamePlayerApi} (HTTP /
+ * `RequestType.StoreInventory` / `RequestRole.Client`,
+ * callback + Promise variants, `.server` / `.admin`
+ * sub-namespaces).
+ */
 export declare class StoreInventoryApi {
+    /** Server-scoped store operations for trusted backend callers. */
     server: ServerStoreInventoryApi;
+    /** Admin-scoped store operations for dashboard, GM, or backoffice callers. */
     admin: AdminStoreInventoryApi;
+    /**
+     * Sends the buyStoreItem operation and returns the typed response via callback.
+     */
     buyStoreItem(requestData: StoreInventoryModels.BuyStoreItemRequestData, onResponse?: Action1<StoreInventoryResponseModels.BuyStoreItemOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the buyStoreItem operation and resolves with the typed response.
+     */
     buyStoreItemAsync(requestData: StoreInventoryModels.BuyStoreItemRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.BuyStoreItemOperationResponse>;
+    /**
+     * Sends the getStoreItemInformation operation and returns the typed response via callback.
+     */
     getStoreItemInformation(requestData: StoreInventoryModels.GetStoreItemInformationRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetStoreItemInformationOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getStoreItemInformation operation and resolves with the typed response.
+     */
     getStoreItemInformationAsync(requestData: StoreInventoryModels.GetStoreItemInformationRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetStoreItemInformationOperationResponse>;
+    /**
+     * Sends the getStoreItemsWithTag operation and returns the typed response via callback.
+     */
     getStoreItemsWithTag(requestData: StoreInventoryModels.GetStoreItemsWithTagRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetStoreItemsWithTagOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getStoreItemsWithTag operation and resolves with the typed response.
+     */
     getStoreItemsWithTagAsync(requestData: StoreInventoryModels.GetStoreItemsWithTagRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetStoreItemsWithTagOperationResponse>;
+    /**
+     * Sends the createStoreItem operation and returns the typed response via callback.
+     */
     createStoreItem(requestData: StoreInventoryModels.CreateStoreItemRequestData, onResponse?: Action1<StoreInventoryResponseModels.CreateStoreItemOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the createStoreItem operation and resolves with the typed response.
+     */
     createStoreItemAsync(requestData: StoreInventoryModels.CreateStoreItemRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.CreateStoreItemOperationResponse>;
+    /**
+     * Sends the setRemoveStatus operation and returns the typed response via callback.
+     */
     setRemoveStatus(requestData: StoreInventoryModels.SetRemoveStatusRequestData, onResponse?: Action1<StoreInventoryResponseModels.SetRemoveStatusOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the setRemoveStatus operation and resolves with the typed response.
+     */
     setRemoveStatusAsync(requestData: StoreInventoryModels.SetRemoveStatusRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.SetRemoveStatusOperationResponse>;
+    /**
+     * Sends the setStoreItemInformation operation and returns the typed response via callback.
+     */
     setStoreItemInformation(requestData: StoreInventoryModels.SetStoreItemInformationRequestData, onResponse?: Action1<StoreInventoryResponseModels.SetStoreItemInformationOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the setStoreItemInformation operation and resolves with the typed response.
+     */
     setStoreItemInformationAsync(requestData: StoreInventoryModels.SetStoreItemInformationRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.SetStoreItemInformationOperationResponse>;
+    /**
+     * Sends the validateAppleAppStoreReceipt operation and returns the typed response via callback.
+     */
     validateAppleAppStoreReceipt(requestData: StoreInventoryModels.ValidateAppleAppStoreReceiptRequestData, onResponse?: Action1<StoreInventoryResponseModels.ValidateAppleAppStoreReceiptOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the validateAppleAppStoreReceipt operation and resolves with the typed response.
+     */
     validateAppleAppStoreReceiptAsync(requestData: StoreInventoryModels.ValidateAppleAppStoreReceiptRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.ValidateAppleAppStoreReceiptOperationResponse>;
+    /**
+     * Sends the validateFacebookStoreReceipt operation and returns the typed response via callback.
+     */
     validateFacebookStoreReceipt(requestData: StoreInventoryModels.ValidateFacebookStoreReceiptRequestData, onResponse?: Action1<StoreInventoryResponseModels.ValidateFacebookStoreReceiptOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the validateFacebookStoreReceipt operation and resolves with the typed response.
+     */
     validateFacebookStoreReceiptAsync(requestData: StoreInventoryModels.ValidateFacebookStoreReceiptRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.ValidateFacebookStoreReceiptOperationResponse>;
+    /**
+     * Sends the validateGooglePlayStoreReceipt operation and returns the typed response via callback.
+     */
     validateGooglePlayStoreReceipt(requestData: StoreInventoryModels.ValidateGooglePlayStoreReceiptRequestData, onResponse?: Action1<StoreInventoryResponseModels.ValidateGooglePlayStoreReceiptOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the validateGooglePlayStoreReceipt operation and resolves with the typed response.
+     */
     validateGooglePlayStoreReceiptAsync(requestData: StoreInventoryModels.ValidateGooglePlayStoreReceiptRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.ValidateGooglePlayStoreReceiptOperationResponse>;
+    /**
+     * Sends the getCreateLeaderboard operation and returns the typed response via callback.
+     */
     getCreateLeaderboard(requestData: StoreInventoryModels.GetCreateLeaderboardRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetCreateLeaderboardOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getCreateLeaderboard operation and resolves with the typed response.
+     */
     getCreateLeaderboardAsync(requestData: StoreInventoryModels.GetCreateLeaderboardRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetCreateLeaderboardOperationResponse>;
+    /**
+     * Sends the presentStoreItem operation and returns the typed response via callback.
+     */
     presentStoreItem(requestData: StoreInventoryModels.PresentStoreItemRequestData, onResponse?: Action1<StoreInventoryResponseModels.PresentStoreItemOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the presentStoreItem operation and resolves with the typed response.
+     */
     presentStoreItemAsync(requestData: StoreInventoryModels.PresentStoreItemRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.PresentStoreItemOperationResponse>;
+    /**
+     * Sends the getStoreLog operation and returns the typed response via callback.
+     */
     getStoreLog(requestData: StoreInventoryModels.GetStoreLogRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetStoreLogOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getStoreLog operation and resolves with the typed response.
+     */
     getStoreLogAsync(requestData: StoreInventoryModels.GetStoreLogRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetStoreLogOperationResponse>;
+    /**
+     * Sends the getStoreUsed operation and returns the typed response via callback.
+     */
     getStoreUsed(requestData: StoreInventoryModels.GetStoreUsedRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetStoreUsedOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getStoreUsed operation and resolves with the typed response.
+     */
     getStoreUsedAsync(requestData: StoreInventoryModels.GetStoreUsedRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetStoreUsedOperationResponse>;
+    /**
+     * Sends the removeStoreUsed operation and returns the typed response via callback.
+     */
     removeStoreUsed(requestData: StoreInventoryModels.RemoveStoreUsedRequestData, onResponse?: Action1<StoreInventoryResponseModels.RemoveStoreUsedOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the removeStoreUsed operation and resolves with the typed response.
+     */
     removeStoreUsedAsync(requestData: StoreInventoryModels.RemoveStoreUsedRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.RemoveStoreUsedOperationResponse>;
 }
+/**
+ * Server-scoped StoreInventory namespace, reachable through
+ * `GNNetwork.storeInventory.server`.
+ *
+ * Mirrors every method on {@link StoreInventoryApi} but uses
+ * the `Server*RequestData` DTO variants. The server flavour
+ * accepts an explicit `userId` so a trusted backend can
+ * issue purchases / gifts on behalf of any player. Always pass
+ * a valid server-side `secretKey`.
+ */
 export declare class ServerStoreInventoryApi {
+    /**
+     * Sends the buyStoreItem operation and returns the typed response via callback.
+     */
     buyStoreItem(requestData: StoreInventoryModels.ServerBuyStoreItemRequestData, onResponse?: Action1<StoreInventoryResponseModels.BuyStoreItemOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the buyStoreItem operation and resolves with the typed response.
+     */
     buyStoreItemAsync(requestData: StoreInventoryModels.ServerBuyStoreItemRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.BuyStoreItemOperationResponse>;
+    /**
+     * Sends the getStoreItemInformation operation and returns the typed response via callback.
+     */
     getStoreItemInformation(requestData: StoreInventoryModels.ServerGetStoreItemInformationRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetStoreItemInformationOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getStoreItemInformation operation and resolves with the typed response.
+     */
     getStoreItemInformationAsync(requestData: StoreInventoryModels.ServerGetStoreItemInformationRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetStoreItemInformationOperationResponse>;
+    /**
+     * Sends the getStoreItemsWithTag operation and returns the typed response via callback.
+     */
     getStoreItemsWithTag(requestData: StoreInventoryModels.ServerGetStoreItemsWithTagRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetStoreItemsWithTagOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getStoreItemsWithTag operation and resolves with the typed response.
+     */
     getStoreItemsWithTagAsync(requestData: StoreInventoryModels.ServerGetStoreItemsWithTagRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetStoreItemsWithTagOperationResponse>;
+    /**
+     * Sends the createStoreItem operation and returns the typed response via callback.
+     */
     createStoreItem(requestData: StoreInventoryModels.ServerCreateStoreItemRequestData, onResponse?: Action1<StoreInventoryResponseModels.CreateStoreItemOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the createStoreItem operation and resolves with the typed response.
+     */
     createStoreItemAsync(requestData: StoreInventoryModels.ServerCreateStoreItemRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.CreateStoreItemOperationResponse>;
+    /**
+     * Sends the setRemoveStatus operation and returns the typed response via callback.
+     */
     setRemoveStatus(requestData: StoreInventoryModels.ServerSetRemoveStatusRequestData, onResponse?: Action1<StoreInventoryResponseModels.SetRemoveStatusOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the setRemoveStatus operation and resolves with the typed response.
+     */
     setRemoveStatusAsync(requestData: StoreInventoryModels.ServerSetRemoveStatusRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.SetRemoveStatusOperationResponse>;
+    /**
+     * Sends the setStoreItemInformation operation and returns the typed response via callback.
+     */
     setStoreItemInformation(requestData: StoreInventoryModels.ServerSetStoreItemInformationRequestData, onResponse?: Action1<StoreInventoryResponseModels.SetStoreItemInformationOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the setStoreItemInformation operation and resolves with the typed response.
+     */
     setStoreItemInformationAsync(requestData: StoreInventoryModels.ServerSetStoreItemInformationRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.SetStoreItemInformationOperationResponse>;
+    /**
+     * Sends the validateAppleAppStoreReceipt operation and returns the typed response via callback.
+     */
     validateAppleAppStoreReceipt(requestData: StoreInventoryModels.ServerValidateAppleAppStoreReceiptRequestData, onResponse?: Action1<StoreInventoryResponseModels.ValidateAppleAppStoreReceiptOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the validateAppleAppStoreReceipt operation and resolves with the typed response.
+     */
     validateAppleAppStoreReceiptAsync(requestData: StoreInventoryModels.ServerValidateAppleAppStoreReceiptRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.ValidateAppleAppStoreReceiptOperationResponse>;
+    /**
+     * Sends the validateFacebookStoreReceipt operation and returns the typed response via callback.
+     */
     validateFacebookStoreReceipt(requestData: StoreInventoryModels.ServerValidateFacebookStoreReceiptRequestData, onResponse?: Action1<StoreInventoryResponseModels.ValidateFacebookStoreReceiptOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the validateFacebookStoreReceipt operation and resolves with the typed response.
+     */
     validateFacebookStoreReceiptAsync(requestData: StoreInventoryModels.ServerValidateFacebookStoreReceiptRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.ValidateFacebookStoreReceiptOperationResponse>;
+    /**
+     * Sends the validateGooglePlayStoreReceipt operation and returns the typed response via callback.
+     */
     validateGooglePlayStoreReceipt(requestData: StoreInventoryModels.ServerValidateGooglePlayStoreReceiptRequestData, onResponse?: Action1<StoreInventoryResponseModels.ValidateGooglePlayStoreReceiptOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the validateGooglePlayStoreReceipt operation and resolves with the typed response.
+     */
     validateGooglePlayStoreReceiptAsync(requestData: StoreInventoryModels.ServerValidateGooglePlayStoreReceiptRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.ValidateGooglePlayStoreReceiptOperationResponse>;
+    /**
+     * Sends the getCreateLeaderboard operation and returns the typed response via callback.
+     */
     getCreateLeaderboard(requestData: StoreInventoryModels.ServerGetCreateLeaderboardRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetCreateLeaderboardOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getCreateLeaderboard operation and resolves with the typed response.
+     */
     getCreateLeaderboardAsync(requestData: StoreInventoryModels.ServerGetCreateLeaderboardRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetCreateLeaderboardOperationResponse>;
+    /**
+     * Sends the presentStoreItem operation and returns the typed response via callback.
+     */
     presentStoreItem(requestData: StoreInventoryModels.ServerPresentStoreItemRequestData, onResponse?: Action1<StoreInventoryResponseModels.PresentStoreItemOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the presentStoreItem operation and resolves with the typed response.
+     */
     presentStoreItemAsync(requestData: StoreInventoryModels.ServerPresentStoreItemRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.PresentStoreItemOperationResponse>;
+    /**
+     * Sends the getStoreLog operation and returns the typed response via callback.
+     */
     getStoreLog(requestData: StoreInventoryModels.ServerGetStoreLogRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetStoreLogOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getStoreLog operation and resolves with the typed response.
+     */
     getStoreLogAsync(requestData: StoreInventoryModels.ServerGetStoreLogRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetStoreLogOperationResponse>;
+    /**
+     * Sends the getStoreUsed operation and returns the typed response via callback.
+     */
     getStoreUsed(requestData: StoreInventoryModels.ServerGetStoreUsedRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetStoreUsedOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getStoreUsed operation and resolves with the typed response.
+     */
     getStoreUsedAsync(requestData: StoreInventoryModels.ServerGetStoreUsedRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetStoreUsedOperationResponse>;
+    /**
+     * Sends the removeStoreUsed operation and returns the typed response via callback.
+     */
     removeStoreUsed(requestData: StoreInventoryModels.ServerRemoveStoreUsedRequestData, onResponse?: Action1<StoreInventoryResponseModels.RemoveStoreUsedOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the removeStoreUsed operation and resolves with the typed response.
+     */
     removeStoreUsedAsync(requestData: StoreInventoryModels.ServerRemoveStoreUsedRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.RemoveStoreUsedOperationResponse>;
 }
+/**
+ * Admin-scoped StoreInventory namespace, reachable through
+ * `GNNetwork.storeInventory.admin`.
+ *
+ * Mirrors {@link ServerStoreInventoryApi} but routed through
+ * {@link RequestRole.Admin}. The backend uses the caller's
+ * admin auth token to authorise privileged operations such as
+ * editing the storefront catalog, force-granting items,
+ * issuing refunds. Reserved for dashboard / backoffice
+ * tools.
+ */
 export declare class AdminStoreInventoryApi {
+    /**
+     * Sends the buyStoreItem operation and returns the typed response via callback.
+     */
     buyStoreItem(requestData: StoreInventoryModels.AdminBuyStoreItemRequestData, onResponse?: Action1<StoreInventoryResponseModels.BuyStoreItemOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the buyStoreItem operation and resolves with the typed response.
+     */
     buyStoreItemAsync(requestData: StoreInventoryModels.AdminBuyStoreItemRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.BuyStoreItemOperationResponse>;
+    /**
+     * Sends the getStoreItemInformation operation and returns the typed response via callback.
+     */
     getStoreItemInformation(requestData: StoreInventoryModels.AdminGetStoreItemInformationRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetStoreItemInformationOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getStoreItemInformation operation and resolves with the typed response.
+     */
     getStoreItemInformationAsync(requestData: StoreInventoryModels.AdminGetStoreItemInformationRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetStoreItemInformationOperationResponse>;
+    /**
+     * Sends the getStoreItemsWithTag operation and returns the typed response via callback.
+     */
     getStoreItemsWithTag(requestData: StoreInventoryModels.AdminGetStoreItemsWithTagRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetStoreItemsWithTagOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getStoreItemsWithTag operation and resolves with the typed response.
+     */
     getStoreItemsWithTagAsync(requestData: StoreInventoryModels.AdminGetStoreItemsWithTagRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetStoreItemsWithTagOperationResponse>;
+    /**
+     * Sends the createStoreItem operation and returns the typed response via callback.
+     */
     createStoreItem(requestData: StoreInventoryModels.AdminCreateStoreItemRequestData, onResponse?: Action1<StoreInventoryResponseModels.CreateStoreItemOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the createStoreItem operation and resolves with the typed response.
+     */
     createStoreItemAsync(requestData: StoreInventoryModels.AdminCreateStoreItemRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.CreateStoreItemOperationResponse>;
+    /**
+     * Sends the setRemoveStatus operation and returns the typed response via callback.
+     */
     setRemoveStatus(requestData: StoreInventoryModels.AdminSetRemoveStatusRequestData, onResponse?: Action1<StoreInventoryResponseModels.SetRemoveStatusOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the setRemoveStatus operation and resolves with the typed response.
+     */
     setRemoveStatusAsync(requestData: StoreInventoryModels.AdminSetRemoveStatusRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.SetRemoveStatusOperationResponse>;
+    /**
+     * Sends the setStoreItemInformation operation and returns the typed response via callback.
+     */
     setStoreItemInformation(requestData: StoreInventoryModels.AdminSetStoreItemInformationRequestData, onResponse?: Action1<StoreInventoryResponseModels.SetStoreItemInformationOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the setStoreItemInformation operation and resolves with the typed response.
+     */
     setStoreItemInformationAsync(requestData: StoreInventoryModels.AdminSetStoreItemInformationRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.SetStoreItemInformationOperationResponse>;
+    /**
+     * Sends the validateAppleAppStoreReceipt operation and returns the typed response via callback.
+     */
     validateAppleAppStoreReceipt(requestData: StoreInventoryModels.AdminValidateAppleAppStoreReceiptRequestData, onResponse?: Action1<StoreInventoryResponseModels.ValidateAppleAppStoreReceiptOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the validateAppleAppStoreReceipt operation and resolves with the typed response.
+     */
     validateAppleAppStoreReceiptAsync(requestData: StoreInventoryModels.AdminValidateAppleAppStoreReceiptRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.ValidateAppleAppStoreReceiptOperationResponse>;
+    /**
+     * Sends the validateFacebookStoreReceipt operation and returns the typed response via callback.
+     */
     validateFacebookStoreReceipt(requestData: StoreInventoryModels.AdminValidateFacebookStoreReceiptRequestData, onResponse?: Action1<StoreInventoryResponseModels.ValidateFacebookStoreReceiptOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the validateFacebookStoreReceipt operation and resolves with the typed response.
+     */
     validateFacebookStoreReceiptAsync(requestData: StoreInventoryModels.AdminValidateFacebookStoreReceiptRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.ValidateFacebookStoreReceiptOperationResponse>;
+    /**
+     * Sends the validateGooglePlayStoreReceipt operation and returns the typed response via callback.
+     */
     validateGooglePlayStoreReceipt(requestData: StoreInventoryModels.AdminValidateGooglePlayStoreReceiptRequestData, onResponse?: Action1<StoreInventoryResponseModels.ValidateGooglePlayStoreReceiptOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the validateGooglePlayStoreReceipt operation and resolves with the typed response.
+     */
     validateGooglePlayStoreReceiptAsync(requestData: StoreInventoryModels.AdminValidateGooglePlayStoreReceiptRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.ValidateGooglePlayStoreReceiptOperationResponse>;
+    /**
+     * Sends the getCreateLeaderboard operation and returns the typed response via callback.
+     */
     getCreateLeaderboard(requestData: StoreInventoryModels.AdminGetCreateLeaderboardRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetCreateLeaderboardOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getCreateLeaderboard operation and resolves with the typed response.
+     */
     getCreateLeaderboardAsync(requestData: StoreInventoryModels.AdminGetCreateLeaderboardRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetCreateLeaderboardOperationResponse>;
+    /**
+     * Sends the presentStoreItem operation and returns the typed response via callback.
+     */
     presentStoreItem(requestData: StoreInventoryModels.AdminPresentStoreItemRequestData, onResponse?: Action1<StoreInventoryResponseModels.PresentStoreItemOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the presentStoreItem operation and resolves with the typed response.
+     */
     presentStoreItemAsync(requestData: StoreInventoryModels.AdminPresentStoreItemRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.PresentStoreItemOperationResponse>;
+    /**
+     * Sends the getStoreLog operation and returns the typed response via callback.
+     */
     getStoreLog(requestData: StoreInventoryModels.AdminGetStoreLogRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetStoreLogOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getStoreLog operation and resolves with the typed response.
+     */
     getStoreLogAsync(requestData: StoreInventoryModels.AdminGetStoreLogRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetStoreLogOperationResponse>;
+    /**
+     * Sends the getStoreUsed operation and returns the typed response via callback.
+     */
     getStoreUsed(requestData: StoreInventoryModels.AdminGetStoreUsedRequestData, onResponse?: Action1<StoreInventoryResponseModels.GetStoreUsedOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getStoreUsed operation and resolves with the typed response.
+     */
     getStoreUsedAsync(requestData: StoreInventoryModels.AdminGetStoreUsedRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.GetStoreUsedOperationResponse>;
+    /**
+     * Sends the removeStoreUsed operation and returns the typed response via callback.
+     */
     removeStoreUsed(requestData: StoreInventoryModels.AdminRemoveStoreUsedRequestData, onResponse?: Action1<StoreInventoryResponseModels.RemoveStoreUsedOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the removeStoreUsed operation and resolves with the typed response.
+     */
     removeStoreUsedAsync(requestData: StoreInventoryModels.AdminRemoveStoreUsedRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<StoreInventoryResponseModels.RemoveStoreUsedOperationResponse>;
 }

package/dist/runtime/common/Action0.d.ts

@@ -1 +1,31 @@
+/**
+ * Zero-argument, void-returning callback signature.
+ *
+ * The SDK uses `Action*` aliases throughout the public API as a single,
+ * recognisable shorthand for "callback that the SDK will invoke at some
+ * point". Compared to the inline `() => void` type literal, the alias
+ * gives every signature a stable name that turns up in IDE auto-complete
+ * and in generated `.d.ts` files, which makes it easier for application
+ * code to declare a matching variable type:
+ *
+ * ```ts
+ * const onConnected: Action0 = () => {
+ *     console.log("socket connected");
+ * };
+ * GNNetwork.subscriberOnConnectHandler(onConnected);
+ * GNNetwork.unscriberOnConnectHandler(onConnected); // same reference
+ * ```
+ *
+ * Use `Action0` for fire-and-forget signals where the callback only
+ * needs to know that the event happened (connect, disconnect, generic
+ * "done"). For callbacks that carry data, prefer the corresponding
+ * arity-specific alias: {@link Action1}, {@link Action2},
+ * {@link Action3}, {@link Action4}.
+ *
+ * Return value: callbacks are expected to return `void`. The SDK never
+ * inspects the return value; throwing inside the callback propagates to
+ * the SDK call site, which is usually inside the {@link ServiceUpdate}
+ * tick or an HTTP/socket response dispatch — uncaught throws there are
+ * surfaced through `console.error`.
+ */
 export type Action0 = () => void;

package/dist/runtime/common/Action1.d.ts

@@ -1 +1,33 @@
+/**
+ * Single-argument, void-returning callback signature.
+ *
+ * The SDK uses this alias for every "callback that delivers a value"
+ * pattern. The most common consumers are the typed response callbacks on
+ * the `*Api` wrappers and `GNNetwork.sendVia*` helpers, where the
+ * generic parameter `T` is a {@link OperationResponse} subclass:
+ *
+ * ```ts
+ * const onLogin: Action1<AuthenticateResponseModels.LoginByAccountOperationResponse> =
+ *     response => {
+ *         if (response.hasError()) {
+ *             console.warn("login failed", response.getReturnCode());
+ *             return;
+ *         }
+ *         console.log("authToken =", response.getResponseData().authToken);
+ *     };
+ * GNNetwork.authenticate.loginByAccount(requestData, onLogin);
+ * ```
+ *
+ * @template T  Type of the value that the SDK passes to the callback.
+ *              For response callbacks this is the typed response class;
+ *              for event callbacks it is {@link OperationEvent}; for
+ *              the rare numeric callbacks (`syncTs`) it is `number`.
+ *
+ * Behaviour notes:
+ * - The SDK never inspects the return value.
+ * - When the SDK is asked for a fire-and-forget call (callback is
+ *   `null`) it skips the invocation entirely. Make sure your call site
+ *   is robust to "callback never fires" — typical causes are network
+ *   timeouts, transport disabled, or a `null` decoded payload.
+ */
 export type Action1<T> = (t: T) => void;

package/dist/runtime/common/Action2.d.ts

@@ -1 +1,22 @@
+/**
+ * Two-argument, void-returning callback signature.
+ *
+ * Reserved for callbacks that need to surface two pieces of data
+ * simultaneously without forcing the caller to allocate a tuple or a
+ * dedicated DTO. Most public callbacks in the SDK only carry a single
+ * value (see {@link Action1}) so this alias appears mainly in
+ * lower-level transport wiring and in user-supplied integration code
+ * that wants to extend the SDK with multi-argument hooks.
+ *
+ * @template T1 Type of the first value passed to the callback.
+ * @template T2 Type of the second value passed to the callback.
+ *
+ * Example:
+ * ```ts
+ * type ProgressHandler = Action2<number, number>; // (sentBytes, totalBytes)
+ * ```
+ *
+ * Same return-value contract as {@link Action0}: the SDK never reads
+ * the return value, throws bubble out to the caller.
+ */
 export type Action2<T1, T2> = (t1: T1, t2: T2) => void;

package/dist/runtime/common/Action3.d.ts

@@ -1 +1,17 @@
+/**
+ * Three-argument, void-returning callback signature.
+ *
+ * Companion to {@link Action0}, {@link Action1} and {@link Action2}.
+ * Provided for symmetry so that integration code can declare callbacks
+ * of any arity without inventing local type aliases. The public SDK
+ * surface itself rarely uses arity ≥ 3 callbacks — they appear mostly
+ * in advanced custom transports or testing harnesses.
+ *
+ * @template T1 First argument type.
+ * @template T2 Second argument type.
+ * @template T3 Third argument type.
+ *
+ * Same return-value contract as {@link Action0}: callbacks are expected
+ * to return `void`; throws propagate to the SDK call site.
+ */
 export type Action3<T1, T2, T3> = (t1: T1, t2: T2, t3: T3) => void;

package/dist/runtime/common/Action4.d.ts

@@ -1 +1,18 @@
+/**
+ * Four-argument, void-returning callback signature.
+ *
+ * Highest arity provided by the `Action*` family. The SDK exports it
+ * for completeness — most public APIs use {@link Action0} or
+ * {@link Action1}, but advanced integrations (custom multipart upload
+ * flows, multi-stage progress reporters) occasionally find it
+ * convenient to pass four positional values without first wrapping them
+ * in a DTO.
+ *
+ * @template T1 First argument type.
+ * @template T2 Second argument type.
+ * @template T3 Third argument type.
+ * @template T4 Fourth argument type.
+ *
+ * Same return-value contract as {@link Action0}.
+ */
 export type Action4<T1, T2, T3, T4> = (t1: T1, t2: T2, t3: T3, t4: T4) => void;