@idosgames/core 0.6.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +72 -0
- package/dist/index.cjs +2 -2
- package/dist/index.d.cts +350 -33
- package/dist/index.d.ts +350 -33
- package/dist/index.js +2 -2
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -45,9 +45,39 @@ declare const ResourceEntryType: {
|
|
|
45
45
|
readonly Item: "Item";
|
|
46
46
|
readonly VirtualCurrency: "VirtualCurrency";
|
|
47
47
|
readonly CryptoCurrency: "CryptoCurrency";
|
|
48
|
-
|
|
48
|
+
/** Rewarded-video credit: one verified ad view, spendable in ad-gated actions. */
|
|
49
|
+
readonly RewardedVideoCredit: "RewardedVideoCredit";
|
|
50
|
+
/**
|
|
51
|
+
* Real-money payment in a store. Only `ProductID` is populated — the amount and currency come
|
|
52
|
+
* from the SKU price tier, not from us. Never a stored resource: the money is paid outside,
|
|
53
|
+
* and the server settles the receipt before the resource operation runs.
|
|
54
|
+
*/
|
|
55
|
+
readonly Purchase: "Purchase";
|
|
49
56
|
};
|
|
50
57
|
type ResourceEntryType = (typeof ResourceEntryType)[keyof typeof ResourceEntryType];
|
|
58
|
+
/**
|
|
59
|
+
* Platform the client runs on. Sent with every request (header `X-IG-Platform`) because the set
|
|
60
|
+
* of available payment options depends on it: an App Store build must not offer payment outside
|
|
61
|
+
* IAP. `Unknown` is a value of its own, not a synonym for `Web` — a client that does not report
|
|
62
|
+
* its platform only gets options that are safe everywhere.
|
|
63
|
+
*/
|
|
64
|
+
declare const ClientPlatform: {
|
|
65
|
+
readonly Unknown: "Unknown";
|
|
66
|
+
readonly Web: "Web";
|
|
67
|
+
readonly Android: "Android";
|
|
68
|
+
readonly Ios: "Ios";
|
|
69
|
+
};
|
|
70
|
+
type ClientPlatform = (typeof ClientPlatform)[keyof typeof ClientPlatform];
|
|
71
|
+
/** Store that issued a receipt. Must match a key in the title's `Purchase.Stores`. */
|
|
72
|
+
declare const IapStore$1: {
|
|
73
|
+
readonly GooglePlay: "GooglePlay";
|
|
74
|
+
readonly AppleAppStore: "AppleAppStore";
|
|
75
|
+
};
|
|
76
|
+
type IapStore$1 = (typeof IapStore$1)[keyof typeof IapStore$1];
|
|
77
|
+
declare const zIapStore: z.ZodEnum<{
|
|
78
|
+
GooglePlay: "GooglePlay";
|
|
79
|
+
AppleAppStore: "AppleAppStore";
|
|
80
|
+
}>;
|
|
51
81
|
declare const EventTokenType: {
|
|
52
82
|
readonly TimedEvent: "TimedEvent";
|
|
53
83
|
readonly Quest: "Quest";
|
|
@@ -208,6 +238,9 @@ interface UserEventTokensState {
|
|
|
208
238
|
CoopEvent?: Record<string, UserEventTokenProgress>;
|
|
209
239
|
Season?: Record<string, UserEventTokenProgress>;
|
|
210
240
|
}
|
|
241
|
+
type PriceOption = { OptionID?: null | string; Name?: null | string; Cost?: null | ResourceConsume; AllowedPlatforms?: null | Array<'Unknown' | 'Web' | 'Android' | 'Ios'>; AssetPaths?: null | Record<string, string>; [key: string]: unknown; };
|
|
242
|
+
type PriceOptions = Record<string, PriceOption>;
|
|
243
|
+
type PaymentProof = { Store: 'GooglePlay' | 'AppleAppStore'; Receipt: string; Signature?: null | string; [key: string]: unknown; };
|
|
211
244
|
|
|
212
245
|
interface StorePurchaseState {
|
|
213
246
|
OfferID: string;
|
|
@@ -222,7 +255,7 @@ interface UserStoreState {
|
|
|
222
255
|
type StorePurchaseResponse = { ServerTimeUtc: string; OfferID: string; Count: number; Resources?: null | ResourceOperation; };
|
|
223
256
|
type PurchaseBatchResponse = Array<{ Id: string; Success: boolean; Error?: null | string; Data?: null | StorePurchaseResponse; }>;
|
|
224
257
|
type StoreDefinition = { StoreID: string; Type?: null | string; Name?: null | string; Description?: null | string; Rules?: null | { StartUtc?: null | string; EndUtc?: null | string; RequiredFlags?: null | Array<string>; [key: string]: unknown; }; AssetPaths?: null | Record<string, string>; [key: string]: unknown; };
|
|
225
|
-
type StoreOfferDefinition = { OfferID: string; StoreIDs?: null | Array<string>; Name?: null | string;
|
|
258
|
+
type StoreOfferDefinition = { OfferID: string; StoreIDs?: null | Array<string>; Name?: null | string; PriceOptions?: null | PriceOptions; Rewards?: null | ResourceGrant; Rules?: null | { StartUtc?: null | string; EndUtc?: null | string; Gate?: null | SegmentGate; Limits?: null | LimitSpec; [key: string]: unknown; }; AssetPaths?: null | Record<string, string>; [key: string]: unknown; };
|
|
226
259
|
/** The title's shop system (config), returned by getStoreDefinitions(). */
|
|
227
260
|
interface StoreDefinitions {
|
|
228
261
|
Stores?: Record<string, StoreDefinition> | null;
|
|
@@ -232,10 +265,19 @@ interface StoreDefinitions {
|
|
|
232
265
|
interface StorePurchaseRef {
|
|
233
266
|
OfferID?: string;
|
|
234
267
|
Count?: number;
|
|
268
|
+
/** Chosen payment option. Empty = first one available on this platform. */
|
|
269
|
+
SelectedOptionID?: string;
|
|
235
270
|
}
|
|
236
271
|
interface StoreRequest extends BaseRequest {
|
|
237
272
|
OfferID?: string;
|
|
238
273
|
Count?: number;
|
|
274
|
+
/** Chosen payment option (`PriceOption.OptionID`). Empty = first one available here. */
|
|
275
|
+
SelectedOptionID?: string;
|
|
276
|
+
/**
|
|
277
|
+
* Store receipt. Required exactly when the chosen option is paid with real money
|
|
278
|
+
* (a `Purchase` entry in its cost); ignored for resource prices.
|
|
279
|
+
*/
|
|
280
|
+
Payment?: PaymentProof;
|
|
239
281
|
/** PurchaseBatch: per-offer purchase counts (deduped by OfferID). */
|
|
240
282
|
Purchases?: StorePurchaseRef[];
|
|
241
283
|
}
|
|
@@ -292,7 +334,8 @@ interface UserLootboxState {
|
|
|
292
334
|
Pity?: Record<string, UserLootboxPityCounter>;
|
|
293
335
|
}
|
|
294
336
|
type LootboxPityTriggerResponse = { RuleID: string; BoxIndex?: null | number; };
|
|
295
|
-
type LootboxOpenResponse = { ServerTimeUtc: string; LootboxID: string; OpenedCount?: null | number; SelectedOptionID?: null |
|
|
337
|
+
type LootboxOpenResponse = { ServerTimeUtc: string; LootboxID: string; OpenedCount?: null | number; SelectedOptionID?: null | string; Resources?: null | ResourceOperation; Inventory?: null | InventoryDelta; Results?: null | Array<ResourceOperation>; TriggeredPity?: null | Array<LootboxPityTriggerResponse>; };
|
|
338
|
+
/** One opening price option: an idempotent option ID and its consume-only cost. */
|
|
296
339
|
/**
|
|
297
340
|
* Container of preset wiring for a lootbox — one PresetBinding per block. Inline data
|
|
298
341
|
* (RewardSlots/PityRules) lives on LootboxDefinition. null = presets unused.
|
|
@@ -302,7 +345,7 @@ interface LootboxPresetBindings {
|
|
|
302
345
|
PityRules?: PresetBinding | null;
|
|
303
346
|
}
|
|
304
347
|
type LootboxSupplyRule = { CatalogID?: null | string; ItemID?: null | string; MaxDrops?: null | number; [key: string]: unknown; };
|
|
305
|
-
type LootboxDefinition = { LootboxID: string; AssetPaths?: null | Record<string, string>; PriceOptions?: null |
|
|
348
|
+
type LootboxDefinition = { LootboxID: string; AssetPaths?: null | Record<string, string>; PriceOptions?: null | PriceOptions; RewardSlots?: null | Array<LootboxRewardSlot>; PityRules?: null | Array<LootboxPityRule>; Presets?: null | LootboxPresetBindings; RewardMultiplier?: null | RewardProgressionMultiplierSpec; SupplyLimits?: null | Array<LootboxSupplyRule>; MaxOpenCount?: null | number; [key: string]: unknown; };
|
|
306
349
|
/** The title's lootbox catalog (config), returned by getDefinitions(). */
|
|
307
350
|
/** Module-wide Lootbox settings shared by every lootbox of the title. */
|
|
308
351
|
interface LootboxGlobalSettings {
|
|
@@ -322,7 +365,10 @@ type LootboxDefinitionsResponse = { LootboxDefinitions?: null | LootboxDefinitio
|
|
|
322
365
|
interface LootboxRequest extends BaseRequest {
|
|
323
366
|
LootboxID?: string;
|
|
324
367
|
Count?: number;
|
|
325
|
-
|
|
368
|
+
/** Chosen payment option. Empty = first one available on this platform. */
|
|
369
|
+
SelectedOptionID?: string;
|
|
370
|
+
/** Store receipt — required when the chosen option is paid with real money. */
|
|
371
|
+
Payment?: PaymentProof;
|
|
326
372
|
}
|
|
327
373
|
declare const LootboxAction: {
|
|
328
374
|
readonly GetDefinitions: "GetDefinitions";
|
|
@@ -412,7 +458,7 @@ declare const TutorialGateMode: {
|
|
|
412
458
|
};
|
|
413
459
|
type TutorialGateMode = (typeof TutorialGateMode)[keyof typeof TutorialGateMode];
|
|
414
460
|
type TutorialGateCondition = { FlowIDs?: null | Array<string>; Mode?: null | 'Completed' | 'Started' | 'StepReached'; StepID?: null | string; Negate?: null | boolean; SkippedCountsAsCompleted?: null | boolean; [key: string]: unknown; };
|
|
415
|
-
type SegmentGate = { Segments?: null | Array<string>; MinPremiumTier?: null | number; RequiredPremiumIDs?: null | Array<string>; MinLevel?: null | number; MaxLevel?: null | number; Countries?: null | Array<string>; RegisteredWithinDays?: null | number; ActiveWithinDays?: null | number; Experiment?: null | ExperimentVariantCondition; Tutorial?: null | TutorialGateCondition; [key: string]: unknown; };
|
|
461
|
+
type SegmentGate = { Segments?: null | Array<string>; MinPremiumTier?: null | number; RequiredPremiumIDs?: null | Array<string>; MinLevel?: null | number; MaxLevel?: null | number; Countries?: null | Array<string>; RegisteredWithinDays?: null | number; ActiveWithinDays?: null | number; Experiment?: null | ExperimentVariantCondition; Tutorial?: null | TutorialGateCondition; Platforms?: null | Array<'Unknown' | 'Web' | 'Android' | 'Ios'>; [key: string]: unknown; };
|
|
416
462
|
type RelativeWindow = { OffsetSecondsFromParentStart?: null | number; DurationSeconds?: null | number; AllowEarningAfterEnd?: null | boolean; ClaimGraceHours?: null | number; [key: string]: unknown; };
|
|
417
463
|
type ScheduledWindow = { StartUtc?: null | string; EndUtc?: null | string; AllowEarningAfterEnd?: null | boolean; ClaimGraceHours?: null | number; [key: string]: unknown; };
|
|
418
464
|
type ScheduleChain = { AnchorUtc?: null | string; MaxCycles?: null | number; PauseBetweenPhasesSec?: null | number; PauseBetweenCyclesSec?: null | number; [key: string]: unknown; };
|
|
@@ -658,7 +704,7 @@ declare const TutorialAction: {
|
|
|
658
704
|
readonly ResetFlow: "ResetFlow";
|
|
659
705
|
};
|
|
660
706
|
type TutorialAction = (typeof TutorialAction)[keyof typeof TutorialAction];
|
|
661
|
-
type ResourceEntry = { Type?: null | 'Item' | 'VirtualCurrency' | 'CryptoCurrency' | '
|
|
707
|
+
type ResourceEntry = { Type?: null | 'Item' | 'VirtualCurrency' | 'CryptoCurrency' | 'RewardedVideoCredit' | 'Purchase'; CurrencyID?: null | string; Amount?: null | number; CatalogID?: null | string; ItemID?: null | string; ProductID?: null | string; };
|
|
662
708
|
type EventTokenAddress = { EntityID: string; Type?: null | 'TimedEvent' | 'Quest' | 'Leaderboard' | 'CoopEvent' | 'Season'; };
|
|
663
709
|
type EventTokenOperation = { Address?: null | EventTokenAddress; Amount?: null | number; Source?: null | string; };
|
|
664
710
|
type ResourceBundle = { Entries?: null | Array<ResourceEntry>; EventTokens?: null | Array<EventTokenOperation>; };
|
|
@@ -876,7 +922,7 @@ interface UserPremiumState {
|
|
|
876
922
|
ActivatedTrialIDs?: string[];
|
|
877
923
|
MaxActiveTier?: number;
|
|
878
924
|
}
|
|
879
|
-
type PremiumDefinition = { PremiumID?: null | string; DisplayName?: null | string; Tier?: null | number; DurationDays?: null | number; TrialDurationDays?: null | number; PriceOptions?: null |
|
|
925
|
+
type PremiumDefinition = { PremiumID?: null | string; DisplayName?: null | string; Tier?: null | number; DurationDays?: null | number; TrialDurationDays?: null | number; PriceOptions?: null | PriceOptions; AppleProductID?: null | string; GoogleProductID?: null | string; Benefits?: null | Record<string, string>; [key: string]: unknown; };
|
|
880
926
|
interface PremiumDefinitions {
|
|
881
927
|
Definitions?: Record<string, PremiumDefinition> | null;
|
|
882
928
|
}
|
|
@@ -926,13 +972,13 @@ type UnlockCharactersBatchResponse = { ServerTimeUtc: string; Items: Array<{ Id:
|
|
|
926
972
|
type UpgradeCharacterLevelsBatchResponse = { ServerTimeUtc: string; Items: Array<{ Id: string; Success: boolean; Error?: null | string; Data?: null | UpgradeCharacterLevelResponse; }>; Resources?: null | ResourceOperation; };
|
|
927
973
|
type UpgradeStatLevelsBatchResponse = { ServerTimeUtc: string; Items: Array<{ Id: string; Success: boolean; Error?: null | string; Data?: null | UpgradeStatLevelResponse; }>; Resources?: null | ResourceOperation; };
|
|
928
974
|
type StatRequirement = { RequiredStatID: string; RequiredLevel: number; [key: string]: unknown; };
|
|
929
|
-
type StatDefinition = { StatID: string; TypeID?: null | string; DisplayName?: null | string; Description?: null | string; MaxLevel?: null | number; Weight?: null | number;
|
|
930
|
-
type CharacterLevelDefinition = { Level?: null | number;
|
|
975
|
+
type StatDefinition = { StatID: string; TypeID?: null | string; DisplayName?: null | string; Description?: null | string; MaxLevel?: null | number; Weight?: null | number; PriceOptions?: null | PriceOptions; CostScalingFactor?: null | number; BaseStatValue?: null | number; StatScalingFactor?: null | number; CharacterLevelScalingFactor?: null | number; Requirements?: null | Array<StatRequirement>; AssetPaths?: null | Record<string, string>; [key: string]: unknown; };
|
|
976
|
+
type CharacterLevelDefinition = { Level?: null | number; PriceOptions?: null | PriceOptions; GlobalStatMultiplier?: null | number; StatMaxLevelMultiplier?: null | number; AssetPaths?: null | Record<string, string>; [key: string]: unknown; };
|
|
931
977
|
type CharacterEquipmentSlot = { SlotID: string; MinCharacterLevel?: null | number; StatRequirements?: null | Array<StatRequirement>; AllowedRarityIDs?: null | Array<string>; AllowedItemTags?: null | Array<string>; MinItemLevel?: null | number; MaxItemLevel?: null | number; [key: string]: unknown; };
|
|
932
978
|
type CharacterEquipment = { Slots?: null | Record<string, CharacterEquipmentSlot>; [key: string]: unknown; };
|
|
933
979
|
type CharacterIdentity = { DisplayName?: null | string; Description?: null | string; Lore?: null | string; SortOrder?: null | number; AssetPaths?: null | Record<string, string>; [key: string]: unknown; };
|
|
934
980
|
type CharacterClassification = { ClassID?: null | string; RarityID?: null | string; Tags?: null | Array<string>; [key: string]: unknown; };
|
|
935
|
-
type CharacterUnlock = { UnlockedByDefault?: null | boolean;
|
|
981
|
+
type CharacterUnlock = { UnlockedByDefault?: null | boolean; PriceOptions?: null | PriceOptions; [key: string]: unknown; };
|
|
936
982
|
type CharacterDefinition = { CharacterID: string; Identity?: null | CharacterIdentity; Classification?: null | CharacterClassification; Unlock?: null | CharacterUnlock; Presets?: null | { Stats?: null | PresetBinding; Levels?: null | PresetBinding; Equipment?: null | PresetBinding; [key: string]: unknown; }; Equipment?: null | CharacterEquipment; Stats?: null | Record<string, StatDefinition>; Levels?: null | Record<string, CharacterLevelDefinition>; [key: string]: unknown; };
|
|
937
983
|
type StatsPreset = { Stats?: null | Record<string, StatDefinition>; [key: string]: unknown; };
|
|
938
984
|
type LevelsPreset = { Levels?: null | Record<string, CharacterLevelDefinition>; [key: string]: unknown; };
|
|
@@ -975,6 +1021,13 @@ interface CharacterStatRef {
|
|
|
975
1021
|
}
|
|
976
1022
|
interface CharacterRequest extends BaseRequest {
|
|
977
1023
|
CharacterID?: string;
|
|
1024
|
+
/**
|
|
1025
|
+
* Chosen way to pay (`PriceOption.OptionID`). Empty = the first option available on this
|
|
1026
|
+
* player's platform, which is what keeps single-price entities working unchanged.
|
|
1027
|
+
*/
|
|
1028
|
+
SelectedOptionID?: string;
|
|
1029
|
+
/** Store receipt. Required exactly when the chosen option is paid in a store. */
|
|
1030
|
+
Payment?: PaymentProof;
|
|
978
1031
|
StatID?: string;
|
|
979
1032
|
ItemsToEquip?: EquipSlotPair[];
|
|
980
1033
|
UnequipSlotIDs?: string[];
|
|
@@ -1035,6 +1088,11 @@ type InstantBattleResponse = { Battle?: null | BattleResult; Resources?: null |
|
|
|
1035
1088
|
type MatchesPageResponse = { Matches?: null | Array<PvPMatch>; Page?: null | number; PageSize?: null | number; HasMore?: null | boolean; };
|
|
1036
1089
|
interface MatchRequest extends BaseRequest {
|
|
1037
1090
|
MatchID?: string;
|
|
1091
|
+
/**
|
|
1092
|
+
* Chosen way to pay (`PriceOption.OptionID`). Empty = the first option available on this
|
|
1093
|
+
* player's platform, which keeps single-price entities working unchanged.
|
|
1094
|
+
*/
|
|
1095
|
+
SelectedOptionID?: string;
|
|
1038
1096
|
TargetUserID?: string;
|
|
1039
1097
|
/** Entry stake for one side (currencies / stackable items / event tokens). */
|
|
1040
1098
|
Entry?: ResourceBundle;
|
|
@@ -1062,7 +1120,7 @@ type MatchAction = (typeof MatchAction)[keyof typeof MatchAction];
|
|
|
1062
1120
|
type InstantBattleSettings = { StatMapping?: null | { HealthStatID?: null | string; DamageStatID?: null | string; ArmorStatID?: null | string; AttackSpeedStatID?: null | string; CritChanceStatID?: null | string; CritDamageStatID?: null | string; DodgeStatID?: null | string; AllMightStatID?: null | string; [key: string]: unknown; }; Combat?: null | { MaxRounds?: null | number; BlockDamageMultiplier?: null | number; MinHitDamage?: null | number; DefaultCritMultiplier?: null | number; MaxCritChance?: null | number; MaxDodgeChance?: null | number; [key: string]: unknown; }; Formula?: null | { Health?: null | { Terms?: null | Array<{ Coefficient?: null | number; Factors?: null | Array<{ Source?: null | 'Constant' | 'Stat' | 'RankMultiplier' | 'AllMight' | 'GearFlat' | 'GearPercent'; StatID?: null | string; Value?: null | number; OnePlus?: null | boolean; [key: string]: unknown; }>; [key: string]: unknown; }>; [key: string]: unknown; }; Damage?: null | { Terms?: null | Array<{ Coefficient?: null | number; Factors?: null | Array<{ Source?: null | 'Constant' | 'Stat' | 'RankMultiplier' | 'AllMight' | 'GearFlat' | 'GearPercent'; StatID?: null | string; Value?: null | number; OnePlus?: null | boolean; [key: string]: unknown; }>; [key: string]: unknown; }>; [key: string]: unknown; }; Armor?: null | { Terms?: null | Array<{ Coefficient?: null | number; Factors?: null | Array<{ Source?: null | 'Constant' | 'Stat' | 'RankMultiplier' | 'AllMight' | 'GearFlat' | 'GearPercent'; StatID?: null | string; Value?: null | number; OnePlus?: null | boolean; [key: string]: unknown; }>; [key: string]: unknown; }>; [key: string]: unknown; }; AttackSpeed?: null | { Terms?: null | Array<{ Coefficient?: null | number; Factors?: null | Array<{ Source?: null | 'Constant' | 'Stat' | 'RankMultiplier' | 'AllMight' | 'GearFlat' | 'GearPercent'; StatID?: null | string; Value?: null | number; OnePlus?: null | boolean; [key: string]: unknown; }>; [key: string]: unknown; }>; [key: string]: unknown; }; CritChance?: null | { Terms?: null | Array<{ Coefficient?: null | number; Factors?: null | Array<{ Source?: null | 'Constant' | 'Stat' | 'RankMultiplier' | 'AllMight' | 'GearFlat' | 'GearPercent'; StatID?: null | string; Value?: null | number; OnePlus?: null | boolean; [key: string]: unknown; }>; [key: string]: unknown; }>; [key: string]: unknown; }; CritDamage?: null | { Terms?: null | Array<{ Coefficient?: null | number; Factors?: null | Array<{ Source?: null | 'Constant' | 'Stat' | 'RankMultiplier' | 'AllMight' | 'GearFlat' | 'GearPercent'; StatID?: null | string; Value?: null | number; OnePlus?: null | boolean; [key: string]: unknown; }>; [key: string]: unknown; }>; [key: string]: unknown; }; Dodge?: null | { Terms?: null | Array<{ Coefficient?: null | number; Factors?: null | Array<{ Source?: null | 'Constant' | 'Stat' | 'RankMultiplier' | 'AllMight' | 'GearFlat' | 'GearPercent'; StatID?: null | string; Value?: null | number; OnePlus?: null | boolean; [key: string]: unknown; }>; [key: string]: unknown; }>; [key: string]: unknown; }; [key: string]: unknown; }; [key: string]: unknown; };
|
|
1063
1121
|
type MatchEconomySettings = { BurnRate?: null | number; [key: string]: unknown; };
|
|
1064
1122
|
type MatchEntrySettings = { AllowVirtualCurrency?: null | boolean; AllowItems?: null | boolean; AllowEventTokens?: null | boolean; Allowed?: null | Array<{ Kind?: null | 'Item' | 'VirtualCurrency' | 'EventToken'; CurrencyID?: null | string; CatalogID?: null | string; ItemID?: null | string; TokenType?: null | 'TimedEvent' | 'Quest' | 'Leaderboard' | 'CoopEvent' | 'Season'; EntityID?: null | string; MinAmount?: null | number; MaxAmount?: null | number; [key: string]: unknown; }>; MaxPositions?: null | number; [key: string]: unknown; };
|
|
1065
|
-
type MatchCreationSettings = {
|
|
1123
|
+
type MatchCreationSettings = { PriceOptions?: null | PriceOptions; RefundCostOnCancel?: null | boolean; MaxOpenMatches?: null | number; Limits?: null | LimitSpec; AllowPrivateMatches?: null | boolean; MaxMatchesPerOpponentPerDay?: null | number; [key: string]: unknown; };
|
|
1066
1124
|
/** One instant-battle rule, keyed by RuleID in InstantBattleDefinitions.Rules. */
|
|
1067
1125
|
interface InstantBattleRule {
|
|
1068
1126
|
RuleID?: string | null;
|
|
@@ -1131,7 +1189,7 @@ type AcceptTradeOfferResponse = { OfferID: string; ReceivedCollectibleID?: null
|
|
|
1131
1189
|
type DeclineTradeOfferResponse = { OfferID: string; Resources?: null | ResourceOperation; };
|
|
1132
1190
|
type GetTradeOffersResponse = { Offers?: null | Array<CollectionTradeOfferDocument>; };
|
|
1133
1191
|
type CollectionDefinition = { CollectionID?: null | string; DisplayName?: null | string; Description?: null | string; AssetPaths?: null | Record<string, string>; SeasonChainID?: null | string; Sets?: null | Array<{ SetID?: null | string; DisplayName?: null | string; AssetPaths?: null | Record<string, string>; SortOrder?: null | number; Collectibles?: null | Array<{ CollectibleID?: null | string; DisplayName?: null | string; AssetPaths?: null | Record<string, string>; Rarity?: null | number; HasSpecialVersion?: null | boolean; SortOrder?: null | number; [key: string]: unknown; }>; SetCompletionReward?: null | ResourceGrant; [key: string]: unknown; }>; GrandPrize?: null | ResourceGrant; [key: string]: unknown; };
|
|
1134
|
-
type CollectionPackTypeDefinition = { PackTypeID?: null | string;
|
|
1192
|
+
type CollectionPackTypeDefinition = { PackTypeID?: null | string; PriceOptions?: null | PriceOptions; BonusRewardSlots?: null | Array<LootboxRewardSlot>; PityRules?: null | Array<LootboxPityRule>; Presets?: null | { BonusRewardSlots?: null | PresetBinding; PityRules?: null | PresetBinding; [key: string]: unknown; }; DisplayName?: null | string; AssetPaths?: null | Record<string, string>; CollectibleCount?: null | number; MaxOpenCount?: null | number; GuaranteedMinRarity?: null | number; GuaranteeMaxRarity?: null | boolean; RarityWeights?: null | Record<string, number>; ColorTier?: null | number; [key: string]: unknown; };
|
|
1135
1193
|
type DuplicateCollectionCurrencyConversion = { Rarity?: null | number; CollectionCurrencyGranted?: null | number; [key: string]: unknown; };
|
|
1136
1194
|
type CollectionChestDefinition = { CollectionChestID?: null | string; DisplayName?: null | string; AssetPaths?: null | Record<string, string>; CollectionCurrencyCost?: null | number; MaxOpenCount?: null | number; MinCollectibleCount?: null | number; MaxCollectibleCount?: null | number; GuaranteedMinRarity?: null | number; BonusRewardSlots?: null | Array<LootboxRewardSlot>; PityRules?: null | Array<LootboxPityRule>; Presets?: null | { BonusRewardSlots?: null | PresetBinding; PityRules?: null | PresetBinding; [key: string]: unknown; }; Tier?: null | number; [key: string]: unknown; };
|
|
1137
1195
|
type SpecialTradeEventDefinition = { SpecialTradeEventID?: null | string; StartUtc?: null | string; EndUtc?: null | string; AllowedSpecialCollectibleIDs?: null | Array<string>; SpecialTradeEventDailyTradeLimit?: null | number; [key: string]: unknown; };
|
|
@@ -1163,6 +1221,13 @@ interface CollectionSetRef {
|
|
|
1163
1221
|
}
|
|
1164
1222
|
interface CollectionRequest extends BaseRequest {
|
|
1165
1223
|
CollectionID?: string;
|
|
1224
|
+
/**
|
|
1225
|
+
* Chosen way to pay (`PriceOption.OptionID`). Empty = the first option available on this
|
|
1226
|
+
* player's platform, which is what keeps single-price entities working unchanged.
|
|
1227
|
+
*/
|
|
1228
|
+
SelectedOptionID?: string;
|
|
1229
|
+
/** Store receipt. Required exactly when the chosen option is paid in a store. */
|
|
1230
|
+
Payment?: PaymentProof;
|
|
1166
1231
|
CollectibleID?: string;
|
|
1167
1232
|
PackTypeID?: string;
|
|
1168
1233
|
CollectionChestID?: string;
|
|
@@ -1235,7 +1300,7 @@ type CoopPartnerObjectState = { Index?: null | number; OwnerUserID?: null | stri
|
|
|
1235
1300
|
type CoopBuildObjectsState = { Objects?: null | Array<CoopPartnerObjectState>; [key: string]: unknown; };
|
|
1236
1301
|
type CoopGroupDocument = { GroupID?: null | string; TitleID?: null | string; CoopChainID?: null | string; CoopEventID?: null | string; CycleIndex?: null | number; Members?: null | Array<CoopGroupMember>; BuildObjectsState?: null | CoopBuildObjectsState; Status?: null | string; CreatedAtUtc?: null | string; ExpiresAtUtc?: null | string; Version?: null | number; [key: string]: unknown; };
|
|
1237
1302
|
type ActiveCoopEventInfo = { CoopChainID: string; [key: string]: unknown; };
|
|
1238
|
-
type CoopEventDefinition = { CoopEventID?: null | string; Order?: null | number; DurationSec?: null | number; DisplayName?: null | string; Description?: null | string; AssetPaths?: null | Record<string, string>; EventType?: null | string; PartnerCount?: null | number; MatchmakingTimeoutMinutes?: null | number; MemberGracePeriodMinutes?: null | number; BuildObjects?: null | { Objects?: null | Array<{ Index?: null | number; DisplayName?: null | string; AssetPaths?: null | Record<string, string>; MaxProgress?: null | number; CompletionReward?: null | ResourceGrant; [key: string]: unknown; }>;
|
|
1303
|
+
type CoopEventDefinition = { CoopEventID?: null | string; Order?: null | number; DurationSec?: null | number; DisplayName?: null | string; Description?: null | string; AssetPaths?: null | Record<string, string>; EventType?: null | string; PartnerCount?: null | number; MatchmakingTimeoutMinutes?: null | number; MemberGracePeriodMinutes?: null | number; BuildObjects?: null | { Objects?: null | Array<{ Index?: null | number; DisplayName?: null | string; AssetPaths?: null | Record<string, string>; MaxProgress?: null | number; CompletionReward?: null | ResourceGrant; [key: string]: unknown; }>; PriceOptions?: null | PriceOptions; SpinnerTable?: null | Array<{ DisplayName?: null | string; AssetPaths?: null | Record<string, string>; Weight?: null | number; MinProgress?: null | number; MaxProgress?: null | number; [key: string]: unknown; }>; MaxSpinsPerCall?: null | number; [key: string]: unknown; }; GrandPrize?: null | ResourceGrant; [key: string]: unknown; };
|
|
1239
1304
|
/** A coop event chain: cyclic schedule + ordered events + audience gate. */
|
|
1240
1305
|
interface CoopEventChainDefinition {
|
|
1241
1306
|
CoopChainID?: string | null;
|
|
@@ -1258,6 +1323,11 @@ interface CoopEventDefinitions {
|
|
|
1258
1323
|
}
|
|
1259
1324
|
interface CoopEventRequest extends BaseRequest {
|
|
1260
1325
|
CoopChainID?: string;
|
|
1326
|
+
/**
|
|
1327
|
+
* Chosen way to pay (`PriceOption.OptionID`). Empty = the first option available on this
|
|
1328
|
+
* player's platform, which keeps single-price entities working unchanged.
|
|
1329
|
+
*/
|
|
1330
|
+
SelectedOptionID?: string;
|
|
1261
1331
|
GroupID?: string;
|
|
1262
1332
|
/**
|
|
1263
1333
|
* How many spins to perform in a single Spin call. Default 1. Clamped to
|
|
@@ -1309,7 +1379,7 @@ interface UserDealOffersState {
|
|
|
1309
1379
|
LastUpdatedUtc?: string | null;
|
|
1310
1380
|
}
|
|
1311
1381
|
type DealSlotDefinition = { SlotID?: null | string; Enabled?: null | boolean; SortOrder?: null | number; Queue?: null | Array<{ Order?: null | number; OfferID?: null | string; DurationSec?: null | number; DelayBeforeActivationSec?: null | number; [key: string]: unknown; }>; Schedule?: null | ScheduleSpec; Gate?: null | SegmentGate; AllowDismissSkip?: null | boolean; DismissSkipDelaySec?: null | number; [key: string]: unknown; };
|
|
1312
|
-
type DealNodeActionDefinition = { Purchase?: null | { StoreOfferID?: null | string; BillingProductID?: null | string;
|
|
1382
|
+
type DealNodeActionDefinition = { Purchase?: null | { StoreOfferID?: null | string; BillingProductID?: null | string; PriceOptions?: null | PriceOptions; UseExternalRewards?: null | boolean; [key: string]: unknown; }; RewardedVideo?: null | { AdPlacementID?: null | string; ViewsRequiredToComplete?: null | number; MaxViewsPerActivation?: null | number; CooldownSecondsBetweenViews?: null | number; RequireServerVerification?: null | boolean; GrantRewardsPerView?: null | boolean; [key: string]: unknown; }; [key: string]: unknown; };
|
|
1313
1383
|
/**
|
|
1314
1384
|
* Container of preset wiring for an offer — one PresetBinding per block. Inline data (Milestones)
|
|
1315
1385
|
* lives on DealOfferDefinition. null = presets unused.
|
|
@@ -1407,6 +1477,13 @@ type ClaimDealMilestoneResponse = { ServerTimeUtc?: null | string; SlotID?: null
|
|
|
1407
1477
|
type ClaimDealMilestonesBatchResponse = { ServerTimeUtc?: null | string; SlotID?: null | string; ClaimedIDs?: null | Array<string>; Rejected?: null | Record<string, string>; Resources?: null | ResourceOperation; };
|
|
1408
1478
|
interface DealOfferRequest extends BaseRequest {
|
|
1409
1479
|
SlotID?: string;
|
|
1480
|
+
/**
|
|
1481
|
+
* Chosen way to pay (`PriceOption.OptionID`). Empty = the first option available on this
|
|
1482
|
+
* player's platform, which keeps single-price entities working unchanged.
|
|
1483
|
+
*/
|
|
1484
|
+
SelectedOptionID?: string;
|
|
1485
|
+
/** Store receipt. Required exactly when the chosen option is paid in a store. */
|
|
1486
|
+
Payment?: PaymentProof;
|
|
1410
1487
|
NodeID?: string;
|
|
1411
1488
|
MilestoneID?: string;
|
|
1412
1489
|
MilestoneIDs?: string[];
|
|
@@ -1520,7 +1597,7 @@ declare const TimedBoostStackingPolicy: {
|
|
|
1520
1597
|
readonly Stack: "Stack";
|
|
1521
1598
|
};
|
|
1522
1599
|
type TimedBoostStackingPolicy = (typeof TimedBoostStackingPolicy)[keyof typeof TimedBoostStackingPolicy];
|
|
1523
|
-
type TimedBoostDefinition = { BoostID?: null | string; DisplayName?: null | string; Description?: null | string; AssetPaths?: null | Record<string, string>;
|
|
1600
|
+
type TimedBoostDefinition = { BoostID?: null | string; DisplayName?: null | string; Description?: null | string; AssetPaths?: null | Record<string, string>; PriceOptions?: null | PriceOptions; Effect?: null | { Target?: null | string; Operation?: null | string; Value?: null | number; [key: string]: unknown; }; DurationSeconds?: null | number; Charges?: null | number; StackingPolicy?: null | string; MaxActiveInstances?: null | number; Tags?: null | Array<string>; [key: string]: unknown; };
|
|
1524
1601
|
type ScheduledBoostDefinition = { ScheduledBoostID?: null | string; DisplayName?: null | string; Description?: null | string; AssetPaths?: null | Record<string, string>; Tags?: null | Array<string>; Schedule?: null | ScheduleSpec; Effects?: null | Array<{ Target?: null | string; Operation?: null | string; Value?: null | number; [key: string]: unknown; }>; Gate?: null | SegmentGate; CustomParams?: null | Record<string, string>; [key: string]: unknown; };
|
|
1525
1602
|
type BoostChainDefinition = { ChainID?: null | string; DisplayName?: null | string; Description?: null | string; AssetPaths?: null | Record<string, string>; Schedule?: null | ScheduleSpec; Phases?: null | Array<{ ChainedBoostID?: null | string; Order?: null | number; DurationSec?: null | number; Effects?: null | Array<{ Target?: null | string; Operation?: null | string; Value?: null | number; [key: string]: unknown; }>; CustomParams?: null | Record<string, string>; [key: string]: unknown; }>; Gate?: null | SegmentGate; CustomParams?: null | Record<string, string>; [key: string]: unknown; };
|
|
1526
1603
|
type TriggeredBoostDefinition = { TriggeredBoostID?: null | string; DisplayName?: null | string; AssetPaths?: null | Record<string, string>; Tags?: null | Array<string>; Sources?: null | Array<TriggerSource>; Effects?: null | Array<{ Target?: null | string; Operation?: null | string; Value?: null | number; [key: string]: unknown; }>; DurationSeconds?: null | number; Charges?: null | number; StackingPolicy?: null | string; MaxActiveInstances?: null | number; Gate?: null | SegmentGate; [key: string]: unknown; };
|
|
@@ -1551,6 +1628,13 @@ type ActiveBoostWindowInfo = { Kind?: null | string; SourceID?: null | string; P
|
|
|
1551
1628
|
type GetActiveBoostWindowsResponse = { ServerTimeUtc?: null | string; Windows?: null | Array<ActiveBoostWindowInfo>; };
|
|
1552
1629
|
interface TimedBoostRequest extends BaseRequest {
|
|
1553
1630
|
BoostID?: string;
|
|
1631
|
+
/**
|
|
1632
|
+
* Chosen way to pay (`PriceOption.OptionID`). Empty = the first option available on this
|
|
1633
|
+
* player's platform, which keeps single-price entities working unchanged.
|
|
1634
|
+
*/
|
|
1635
|
+
SelectedOptionID?: string;
|
|
1636
|
+
/** Store receipt. Required exactly when the chosen option is paid in a store. */
|
|
1637
|
+
Payment?: PaymentProof;
|
|
1554
1638
|
}
|
|
1555
1639
|
declare const TimedBoostAction: {
|
|
1556
1640
|
readonly GetDefinitions: "GetDefinitions";
|
|
@@ -1817,7 +1901,7 @@ interface GameLoopDefinitions {
|
|
|
1817
1901
|
[key: string]: unknown;
|
|
1818
1902
|
}
|
|
1819
1903
|
type RollActionData = { TargetUserID?: null | string; IsBot?: null | boolean; PublicData?: null | UserPublicDataModel; TargetBuildingStates?: null | Array<BuildingState>; TargetHasShield?: null | boolean; [key: string]: unknown; };
|
|
1820
|
-
type SpecialModeOfferData = { ModeID?: null | string; Choices?: null | Array<{ ChoiceID?: null | string; Mode?: null | string; Reward?: null | ScaledResourceOperation; DurationSeconds?: null | number;
|
|
1904
|
+
type SpecialModeOfferData = { ModeID?: null | string; Choices?: null | Array<{ ChoiceID?: null | string; Mode?: null | string; Reward?: null | ScaledResourceOperation; DurationSeconds?: null | number; PriceOptions?: null | PriceOptions; Multipliers?: null | SpecialClaimMultipliers; [key: string]: unknown; }>; [key: string]: unknown; };
|
|
1821
1905
|
type CommunityChestContributionResult = { GroupID?: null | string; Delta?: null | number; NewProgress?: null | number; MaxProgress?: null | number; UnlockedMilestoneIDs?: null | Array<string>; Completed?: null | boolean; [key: string]: unknown; };
|
|
1822
1906
|
interface BoardRollResponse {
|
|
1823
1907
|
UsedMultiplier?: number | null;
|
|
@@ -1865,6 +1949,11 @@ type CommunityChestClaimResponse = { ServerTimeUtc?: null | string; GroupID?: nu
|
|
|
1865
1949
|
type CommunityChestLeaveResponse = { ServerTimeUtc?: null | string; GroupID?: null | string; Success?: null | boolean; };
|
|
1866
1950
|
interface GameLoopRequest extends BaseRequest {
|
|
1867
1951
|
RollMultiplier?: number;
|
|
1952
|
+
/**
|
|
1953
|
+
* Chosen way to pay (`PriceOption.OptionID`). Empty = the first option available on this
|
|
1954
|
+
* player's platform, which keeps single-price entities working unchanged.
|
|
1955
|
+
*/
|
|
1956
|
+
SelectedOptionID?: string;
|
|
1868
1957
|
BuildingIndex?: number;
|
|
1869
1958
|
DigIndex?: number;
|
|
1870
1959
|
StageLevel?: number;
|
|
@@ -1927,14 +2016,14 @@ type MarketplaceCommissionOverride = { Percent?: null | number; MinPerPosition?:
|
|
|
1927
2016
|
type MarketplacePricePolicy = { AllowVirtualCurrency?: null | boolean; AllowItems?: null | boolean; AllowEventTokens?: null | boolean; Allowed?: null | Array<{ Kind?: null | 'Item' | 'VirtualCurrency' | 'EventToken'; CurrencyID?: null | string; CatalogID?: null | string; ItemID?: null | string; TokenType?: null | 'TimedEvent' | 'Quest' | 'Leaderboard' | 'CoopEvent' | 'Season'; EntityID?: null | string; MinAmount?: null | number; MaxAmount?: null | number; [key: string]: unknown; }>; MaxPositions?: null | number; [key: string]: unknown; };
|
|
1928
2017
|
type MarketplaceCommissionPolicy = { Percent?: null | number; MinPerPosition?: null | number; Sink?: null | 'Burn' | 'Ledger'; LedgerAccountID?: null | string; PerCatalogOverrides?: null | Record<string, MarketplaceCommissionOverride>; ApplyToDirectTrades?: null | boolean; [key: string]: unknown; };
|
|
1929
2018
|
type MarketplaceTradabilityPolicy = { AllowedCatalogIDs?: null | Array<string>; DeniedCatalogIDs?: null | Array<string>; DeniedItemIDs?: null | Array<string>; AllowUnstackableWithState?: null | boolean; [key: string]: unknown; };
|
|
1930
|
-
type MarketplaceListingSettings = { Enabled?: null | boolean; AllowedDurationsHours?: null | Array<number>; MaxActiveListings?: null | number; CreateLimits?: null | LimitSpec; BuyLimits?: null | LimitSpec;
|
|
2019
|
+
type MarketplaceListingSettings = { Enabled?: null | boolean; AllowedDurationsHours?: null | Array<number>; MaxActiveListings?: null | number; CreateLimits?: null | LimitSpec; BuyLimits?: null | LimitSpec; ListingFeeOptions?: null | PriceOptions; RefundListingFeeOnCancel?: null | boolean; [key: string]: unknown; };
|
|
1931
2020
|
type MarketplaceAuctionSettings = { Enabled?: null | boolean; MinDurationHours?: null | number; MaxDurationHours?: null | number; AntiSnipeWindowSeconds?: null | number; AntiSnipeExtensionSeconds?: null | number; MaxAntiSnipeExtensions?: null | number; MinBidStepPercent?: null | number; MinBidStepAbsolute?: null | number; BidLimits?: null | LimitSpec; [key: string]: unknown; };
|
|
1932
2021
|
type MarketplaceBuyOrderSettings = { Enabled?: null | boolean; MaxActiveOrders?: null | number; AllowedDurationsHours?: null | Array<number>; CreateLimits?: null | LimitSpec; FillLimits?: null | LimitSpec; [key: string]: unknown; };
|
|
1933
2022
|
type MarketplaceDirectTradeSettings = { Enabled?: null | boolean; OfferExpirationHours?: null | number; MaxPendingOutgoing?: null | number; AllowGifts?: null | boolean; CreateLimits?: null | LimitSpec; [key: string]: unknown; };
|
|
1934
2023
|
type MarketplaceMatchingSettings = { Enabled?: null | boolean; [key: string]: unknown; };
|
|
1935
2024
|
type MarketplaceDefinitions = { Enabled?: null | boolean; Gate?: null | SegmentGate; Schedule?: null | ScheduleSpec; PricePolicy?: null | MarketplacePricePolicy; Commission?: null | MarketplaceCommissionPolicy; Tradability?: null | MarketplaceTradabilityPolicy; Listings?: null | MarketplaceListingSettings; Auctions?: null | MarketplaceAuctionSettings; BuyOrders?: null | MarketplaceBuyOrderSettings; DirectTrades?: null | MarketplaceDirectTradeSettings; Matching?: null | MarketplaceMatchingSettings; [key: string]: unknown; };
|
|
1936
2025
|
type MarketplaceBidRefund = { BidIndex?: null | number; UserID?: null | string; Amount?: null | number; Settled?: null | boolean; SettledAt?: null | string; [key: string]: unknown; };
|
|
1937
|
-
type MarketplaceAuctionState = { BidAxisType?: null | 'Item' | 'VirtualCurrency' | 'CryptoCurrency' | '
|
|
2026
|
+
type MarketplaceAuctionState = { BidAxisType?: null | 'Item' | 'VirtualCurrency' | 'CryptoCurrency' | 'RewardedVideoCredit' | 'Purchase'; BidCurrencyID?: null | string; BidCatalogID?: null | string; BidItemID?: null | string; StartingBid?: null | number; CurrentBid?: null | number; CurrentBidderID?: null | string; BidCount?: null | number; ExtensionCount?: null | number; PendingRefunds?: null | Array<MarketplaceBidRefund>; [key: string]: unknown; };
|
|
1938
2027
|
type MarketplaceActionCounter = { LastAt?: null | string; DailyCount?: null | number; DailyResetUtc?: null | string; [key: string]: unknown; };
|
|
1939
2028
|
type UserMarketplaceState = { Create?: null | MarketplaceActionCounter; Buy?: null | MarketplaceActionCounter; Sell?: null | MarketplaceActionCounter; Bid?: null | MarketplaceActionCounter; [key: string]: unknown; };
|
|
1940
2029
|
type MarketplaceOfferView = { OfferID?: null | string; OfferType?: null | 'Listing' | 'Auction' | 'BuyOrder' | 'DirectTrade'; Status?: null | 'Active' | 'Completed' | 'Expired' | 'Cancelled' | 'Declined'; CreatorUserID?: null | string; CreatorPublicData?: null | UserPublicDataModel; TargetUserID?: null | string; GoodsType?: null | 'Item' | 'VirtualCurrency'; GoodsCatalogID?: null | string; GoodsItemID?: null | string; GoodsCurrencyID?: null | string; GoodsAmount?: null | number; GoodsInstances?: null | Array<UnstackableItemInstanceState>; Price?: null | ResourceBundle; Auction?: null | MarketplaceAuctionState; CreatedAt?: null | string; ExpiresAt?: null | string; [key: string]: unknown; };
|
|
@@ -1955,6 +2044,11 @@ type MarketplaceHistoryEntryView = { OfferID?: null | string; OfferType?: null |
|
|
|
1955
2044
|
type MarketplaceHistoryResponse = { Entries?: null | Array<MarketplaceHistoryEntryView>; ContinuationToken?: null | string; [key: string]: unknown; };
|
|
1956
2045
|
interface MarketplaceRequest extends BaseRequest {
|
|
1957
2046
|
OfferID?: string;
|
|
2047
|
+
/**
|
|
2048
|
+
* Chosen way to pay (`PriceOption.OptionID`). Empty = the first option available on this
|
|
2049
|
+
* player's platform, which keeps single-price entities working unchanged.
|
|
2050
|
+
*/
|
|
2051
|
+
SelectedOptionID?: string;
|
|
1958
2052
|
/**
|
|
1959
2053
|
* Item (default) or VirtualCurrency. For Create actions / MarketBuy / MarketSell: what's
|
|
1960
2054
|
* traded. For browsing (GetOffersByItem/GetBuyOrders): a storefront filter.
|
|
@@ -2652,6 +2746,11 @@ interface ItemUpgradeRef {
|
|
|
2652
2746
|
}
|
|
2653
2747
|
interface ItemRequest extends BaseRequest {
|
|
2654
2748
|
ItemInstanceID?: string;
|
|
2749
|
+
/**
|
|
2750
|
+
* Chosen way to pay (`PriceOption.OptionID`). Empty = the first option available on this
|
|
2751
|
+
* player's platform, which keeps single-price entities working unchanged.
|
|
2752
|
+
*/
|
|
2753
|
+
SelectedOptionID?: string;
|
|
2655
2754
|
Levels?: number;
|
|
2656
2755
|
TargetLevel?: number;
|
|
2657
2756
|
FodderInstanceIDs?: string[];
|
|
@@ -2680,7 +2779,7 @@ type NFTModel = { Networks?: null | Record<string, NFTNetworkBinding>; MetadataU
|
|
|
2680
2779
|
type ItemStats = { FlatBonuses?: null | Record<string, number>; PercentBonuses?: null | Record<string, number>; Power?: null | number; [key: string]: unknown; };
|
|
2681
2780
|
type ItemEquipment = { MinCharacterLevel?: null | number; UseRequirements?: null | Record<string, number>; AllowedCharacterIDs?: null | Array<string>; AllowedSlotIDs?: null | Array<string>; [key: string]: unknown; };
|
|
2682
2781
|
type ItemUpgradeFodder = { ValuationMode?: null | 'FlatCount' | 'Merge' | 'InvestmentRefund'; MergeRatio?: null | number; Selection?: null | 'ProtectLeveled' | 'CheapestFirst' | 'ClientSelected'; [key: string]: unknown; };
|
|
2683
|
-
type ItemUpgrade = { MaxLevel?: null | number;
|
|
2782
|
+
type ItemUpgrade = { MaxLevel?: null | number; PriceOptions?: null | PriceOptions; CostScalingFactor?: null | number; FlatScalingFactor?: null | number; PercentScalingFactor?: null | number; PowerScalingFactor?: null | number; Fodder?: null | ItemUpgradeFodder; [key: string]: unknown; };
|
|
2684
2783
|
type ItemMetadata = { RarityID?: null | string; CollectionID?: null | string; AuthorID?: null | string; [key: string]: unknown; };
|
|
2685
2784
|
type ItemDefinition = { ItemID: string; CatalogID: string; ItemClass?: null | string; DisplayName?: null | string; Description?: null | string; Tags?: null | Array<string>; CustomData?: null | string; IsStackable?: null | boolean; IsTradable?: null | boolean; Weight?: null | number; AssetPaths?: null | Record<string, string>; NFT?: null | NFTModel; Stats?: null | ItemStats; Equipment?: null | ItemEquipment; Upgrade?: null | ItemUpgrade; Metadata?: null | ItemMetadata; ExpirationDurationSeconds?: null | number; [key: string]: unknown; };
|
|
2686
2785
|
/** Catalog: a set of items of one thematic group. Key of `Items` is ItemID. */
|
|
@@ -2842,7 +2941,7 @@ declare const CraftType: {
|
|
|
2842
2941
|
type CraftType = (typeof CraftType)[keyof typeof CraftType];
|
|
2843
2942
|
type CraftSingleResult = { Index?: null | number; BurnedItemIDs?: null | Array<string>; RolledCollectionID?: null | string; UsedCollections?: null | Record<string, number>; Output?: null | ResourceEntry; };
|
|
2844
2943
|
type CraftResponse = { ServerTimeUtc: string; CraftID: string; Type?: null | 'TradeUpRarity' | 'TradeUpCollection'; CraftedCount?: null | number; SelectedOptionID?: null | string; InputRarity?: null | string; OutputRarity?: null | string; Resources?: null | ResourceOperation; Results?: null | Array<CraftSingleResult>; };
|
|
2845
|
-
type CraftDefinition = { CraftID?: null | string; Type?: null | 'TradeUpRarity' | 'TradeUpCollection'; CatalogID?: null | string; CollectionID?: null | string; InputRarityID?: null | string; OutputRarityID?: null | string; RequiredItemCount?: null | number; PriceOptions?: null |
|
|
2944
|
+
type CraftDefinition = { CraftID?: null | string; Type?: null | 'TradeUpRarity' | 'TradeUpCollection'; CatalogID?: null | string; CollectionID?: null | string; InputRarityID?: null | string; OutputRarityID?: null | string; RequiredItemCount?: null | number; PriceOptions?: null | PriceOptions; [key: string]: unknown; };
|
|
2846
2945
|
/** The title's craft catalog (config), returned by getDefinitions(). */
|
|
2847
2946
|
interface CraftDefinitions {
|
|
2848
2947
|
Definitions?: Record<string, CraftDefinition> | null;
|
|
@@ -3729,7 +3828,7 @@ declare class ItemService {
|
|
|
3729
3828
|
* Upgrade an item instance's level, optionally consuming fodder instances. On success the
|
|
3730
3829
|
* server-authoritative inventory is re-fetched (mirrors the C# GetUserInventory call).
|
|
3731
3830
|
*/
|
|
3732
|
-
upgradeLevel(itemInstanceID: string, fodderInstanceIDs?: readonly string[]): Promise<OperationResult<UpgradeItemLevelResponse>>;
|
|
3831
|
+
upgradeLevel(itemInstanceID: string, fodderInstanceIDs?: readonly string[], selectedOptionID?: string): Promise<OperationResult<UpgradeItemLevelResponse>>;
|
|
3733
3832
|
/**
|
|
3734
3833
|
* Upgrade several item instances (+1 level each, or a multi-level/target-level upgrade per
|
|
3735
3834
|
* ref) in one atomic operation. On success the server-authoritative inventory is re-fetched.
|
|
@@ -3741,7 +3840,17 @@ declare class ItemService {
|
|
|
3741
3840
|
declare class StoreService {
|
|
3742
3841
|
private readonly ctx;
|
|
3743
3842
|
constructor(ctx: ClientContext);
|
|
3744
|
-
|
|
3843
|
+
/**
|
|
3844
|
+
* Buys an offer.
|
|
3845
|
+
*
|
|
3846
|
+
* `selectedOptionID` picks the way to pay; omitting it takes the first option available on this
|
|
3847
|
+
* platform, which is what keeps single-price offers working without any client change.
|
|
3848
|
+
* `payment` is required exactly when the chosen option is paid in a store — see CheckoutService.
|
|
3849
|
+
*/
|
|
3850
|
+
purchase(offerID: string, count?: number, options?: {
|
|
3851
|
+
selectedOptionID?: string;
|
|
3852
|
+
payment?: PaymentProof;
|
|
3853
|
+
}): Promise<OperationResult<StorePurchaseResponse>>;
|
|
3745
3854
|
/** Buy several offers in one atomic operation. Each ref is `{ OfferID, Count }`. */
|
|
3746
3855
|
purchaseBatch(purchases: StorePurchaseRef[]): Promise<OperationResult<PurchaseBatchResponse>>;
|
|
3747
3856
|
getDefinitions(): Promise<OperationResult<StoreDefinitions>>;
|
|
@@ -3749,12 +3858,165 @@ declare class StoreService {
|
|
|
3749
3858
|
private baseRequest;
|
|
3750
3859
|
}
|
|
3751
3860
|
|
|
3861
|
+
/** What happens after a receipt is verified. */
|
|
3862
|
+
declare const IapProductType: {
|
|
3863
|
+
readonly Consumable: "Consumable";
|
|
3864
|
+
readonly NonConsumable: "NonConsumable";
|
|
3865
|
+
readonly Subscription: "Subscription";
|
|
3866
|
+
};
|
|
3867
|
+
type IapProductType = (typeof IapProductType)[keyof typeof IapProductType];
|
|
3868
|
+
type IapProductRules = { StartUtc?: null | string; EndUtc?: null | string; Gate?: null | SegmentGate; Limits?: null | LimitSpec; [key: string]: unknown; };
|
|
3869
|
+
type IapProductDefinition = { ProductID?: null | string; Name?: null | string; Type?: null | 'Subscription' | 'Consumable' | 'NonConsumable'; Enabled?: null | boolean; StoreProductIDs?: null | Record<string, string>; Rewards?: null | ResourceGrant; PriceUsdCents?: null | number; Rules?: null | IapProductRules; AssetPaths?: null | Record<string, string>; CustomParams?: null | Record<string, string>; [key: string]: unknown; };
|
|
3870
|
+
type PurchaseDefinitions = { Enabled?: null | boolean; Products?: null | Record<string, IapProductDefinition>; [key: string]: unknown; };
|
|
3871
|
+
type IapProductPurchaseState = { ProductID?: null | string; TotalPurchases?: null | number; DailyPurchases?: null | number; DailyResetUtc?: null | string; LastPurchasedAt?: null | string; Owned?: null | boolean; [key: string]: unknown; };
|
|
3872
|
+
type UserPurchaseState = { Products?: null | Record<string, IapProductPurchaseState>; LifetimeSpendUsdCents?: null | number; [key: string]: unknown; };
|
|
3873
|
+
/** How the server treated the receipt. */
|
|
3874
|
+
declare const IapPurchaseStatus: {
|
|
3875
|
+
readonly Granted: "Granted";
|
|
3876
|
+
readonly Restored: "Restored";
|
|
3877
|
+
readonly AlreadyProcessed: "AlreadyProcessed";
|
|
3878
|
+
};
|
|
3879
|
+
type IapPurchaseStatus = (typeof IapPurchaseStatus)[keyof typeof IapPurchaseStatus];
|
|
3880
|
+
type PurchaseValidationResponse = { ServerTimeUtc: string; Store?: null | 'GooglePlay' | 'AppleAppStore'; ProductID?: null | string; TransactionID?: null | string; Status?: null | 'Granted' | 'Restored' | 'AlreadyProcessed'; Granted?: null | boolean; Quantity?: null | number; Resources?: null | ResourceOperation; ProductState?: null | IapProductPurchaseState; [key: string]: unknown; };
|
|
3881
|
+
type PurchaseValidationBatchResponse = { ServerTimeUtc: string; Items: Array<{ Id: string; Success: boolean; Error?: null | string; Data?: null | PurchaseValidationResponse; }>; Resources?: null | ResourceOperation; };
|
|
3882
|
+
interface PurchaseReceiptRef {
|
|
3883
|
+
Store?: IapStore;
|
|
3884
|
+
Receipt?: string;
|
|
3885
|
+
Signature?: string;
|
|
3886
|
+
/** Only used when the receipt itself is opaque (legacy Apple app receipt). */
|
|
3887
|
+
ProductID?: string;
|
|
3888
|
+
}
|
|
3889
|
+
interface PurchaseRequest extends BaseRequest {
|
|
3890
|
+
Store?: IapStore;
|
|
3891
|
+
Receipt?: string;
|
|
3892
|
+
Signature?: string;
|
|
3893
|
+
ProductID?: string;
|
|
3894
|
+
/** ValidatePurchasesBatch: receipts to restore after a reinstall. */
|
|
3895
|
+
Receipts?: PurchaseReceiptRef[];
|
|
3896
|
+
}
|
|
3897
|
+
type IapStore = 'GooglePlay' | 'AppleAppStore';
|
|
3898
|
+
declare const PurchaseAction: {
|
|
3899
|
+
readonly GetDefinitions: "GetDefinitions";
|
|
3900
|
+
readonly GetUserState: "GetUserState";
|
|
3901
|
+
readonly ValidatePurchase: "ValidatePurchase";
|
|
3902
|
+
readonly ValidatePurchasesBatch: "ValidatePurchasesBatch";
|
|
3903
|
+
};
|
|
3904
|
+
type PurchaseAction = (typeof PurchaseAction)[keyof typeof PurchaseAction];
|
|
3905
|
+
|
|
3906
|
+
/**
|
|
3907
|
+
* Real-money purchases (IAP) — the catalog of store products and receipt validation.
|
|
3908
|
+
*
|
|
3909
|
+
* The money is paid in the store BEFORE the server hears about it, so a refusal here is an
|
|
3910
|
+
* incident, not "not enough funds": every refusal is recorded in the title's transaction ledger.
|
|
3911
|
+
* That is also why the client must hand every receipt it receives to `validatePurchase`, including
|
|
3912
|
+
* the ones the store re-delivers on startup — an order confirmed to the store but never delivered
|
|
3913
|
+
* to us is a purchase the player paid for and will never get.
|
|
3914
|
+
*
|
|
3915
|
+
* This service covers products that ARE the goods. When a store product is used as the *price* of
|
|
3916
|
+
* something else (an offer, a lootbox, a deal), the purchase goes through that module instead —
|
|
3917
|
+
* see `CheckoutService`.
|
|
3918
|
+
*/
|
|
3919
|
+
declare class PurchaseService {
|
|
3920
|
+
private readonly ctx;
|
|
3921
|
+
constructor(ctx: ClientContext);
|
|
3922
|
+
/** Product catalog with per-player availability. */
|
|
3923
|
+
getDefinitions(): Promise<OperationResult<PurchaseDefinitions>>;
|
|
3924
|
+
/** Player's IAP state: per-product counters, ownership, lifetime spend. */
|
|
3925
|
+
getUserState(): Promise<OperationResult<UserPurchaseState>>;
|
|
3926
|
+
/**
|
|
3927
|
+
* Verifies a receipt and grants the product.
|
|
3928
|
+
*
|
|
3929
|
+
* `productID` is only a hint for stores whose receipt is opaque (legacy Apple app receipt): in
|
|
3930
|
+
* every other case the SKU is read from the receipt itself, because the client's claim about
|
|
3931
|
+
* what was bought cannot be trusted.
|
|
3932
|
+
*/
|
|
3933
|
+
validatePurchase(store: IapStore, receipt: string, options?: {
|
|
3934
|
+
signature?: string;
|
|
3935
|
+
productID?: string;
|
|
3936
|
+
}): Promise<OperationResult<PurchaseValidationResponse>>;
|
|
3937
|
+
/**
|
|
3938
|
+
* Restores purchases after a reinstall: several receipts in one call.
|
|
3939
|
+
*
|
|
3940
|
+
* Non-consumables come back as `Restored` (ownership confirmed, nothing granted twice), while a
|
|
3941
|
+
* consumable that never reached us is granted now.
|
|
3942
|
+
*/
|
|
3943
|
+
validatePurchasesBatch(receipts: PurchaseReceiptRef[]): Promise<OperationResult<PurchaseValidationBatchResponse>>;
|
|
3944
|
+
}
|
|
3945
|
+
|
|
3946
|
+
/** What a price option needs before it can be paid. */
|
|
3947
|
+
interface PaymentRequirement {
|
|
3948
|
+
/** The option itself — pass its `OptionID` to the module that sells the entity. */
|
|
3949
|
+
option: PriceOption;
|
|
3950
|
+
/** `store` = a receipt is required; `resources` = the server charges the player's balances. */
|
|
3951
|
+
kind: "store" | "resources";
|
|
3952
|
+
/** IAP product to buy in the store. Set only when `kind` is `"store"`. */
|
|
3953
|
+
productID?: string;
|
|
3954
|
+
/** Crypto shortfall, if this option is paid with an on-chain currency the player is short on. */
|
|
3955
|
+
shortfall?: CryptoShortfall;
|
|
3956
|
+
}
|
|
3957
|
+
/** How much of a crypto currency is missing to pay for an option. */
|
|
3958
|
+
interface CryptoShortfall {
|
|
3959
|
+
currencyID: string;
|
|
3960
|
+
/** Price of the option in that currency. */
|
|
3961
|
+
required: number;
|
|
3962
|
+
/** What the player currently holds in-game. */
|
|
3963
|
+
available: number;
|
|
3964
|
+
/** `required - available` — what a deposit has to cover. */
|
|
3965
|
+
missing: number;
|
|
3966
|
+
}
|
|
3967
|
+
/**
|
|
3968
|
+
* Helper layer over prices: which options this client may show, what each of them needs, and how
|
|
3969
|
+
* much crypto is missing to pay one.
|
|
3970
|
+
*
|
|
3971
|
+
* It deliberately does NOT buy anything. Buying belongs to the module that owns the entity
|
|
3972
|
+
* (`client.store.purchase`, `client.lootbox.open`, …), because only that module knows the rest of
|
|
3973
|
+
* the request — count, target ids, idempotency key. This service answers the question that comes
|
|
3974
|
+
* *before* the call: which option, and what does it need.
|
|
3975
|
+
*
|
|
3976
|
+
* Depositing crypto lives in `@idosgames/wallet`: `core` never imports a wallet stack, so a game
|
|
3977
|
+
* that pays only with in-game currencies does not ship one.
|
|
3978
|
+
*/
|
|
3979
|
+
declare class CheckoutService {
|
|
3980
|
+
private readonly ctx;
|
|
3981
|
+
constructor(ctx: ClientContext);
|
|
3982
|
+
/** Platform this client reports to the server. */
|
|
3983
|
+
get platform(): ClientPlatform;
|
|
3984
|
+
/**
|
|
3985
|
+
* Options this client may show, in the order the server would pick them (by `OptionID`).
|
|
3986
|
+
*
|
|
3987
|
+
* ⚠ Filtering here is what the player SEES. The server re-checks the platform when charging, so
|
|
3988
|
+
* a hidden option cannot be paid anyway — but showing one that a store forbids is itself a
|
|
3989
|
+
* policy violation, which is why the filter exists on the client at all.
|
|
3990
|
+
*/
|
|
3991
|
+
availableOptions(options: PriceOptions | null | undefined): PriceOption[];
|
|
3992
|
+
/** Is this option offered on the current platform? Empty `AllowedPlatforms` = everywhere. */
|
|
3993
|
+
isAvailable(option: PriceOption | null | undefined): boolean;
|
|
3994
|
+
/**
|
|
3995
|
+
* What the option needs before it can be paid: a store receipt, or just the player's balances.
|
|
3996
|
+
*
|
|
3997
|
+
* For a crypto price it also reports the shortfall — the number a deposit has to cover. The
|
|
3998
|
+
* balance comes from the cached player state, so it is as fresh as the last server response.
|
|
3999
|
+
*/
|
|
4000
|
+
requirementOf(option: PriceOption): PaymentRequirement;
|
|
4001
|
+
/** IAP product this option is paid with, or `null` when it is a resource price. */
|
|
4002
|
+
storeProductOf(cost: ResourceConsume | null | undefined): string | null;
|
|
4003
|
+
/**
|
|
4004
|
+
* Crypto shortfall of a price, or `null` when the player can already afford it.
|
|
4005
|
+
*
|
|
4006
|
+
* Only the first crypto entry is reported: a price mixing two on-chain currencies would need two
|
|
4007
|
+
* deposits, and no wallet flow does that in one go — such a price is a config mistake, not a
|
|
4008
|
+
* case to paper over here.
|
|
4009
|
+
*/
|
|
4010
|
+
cryptoShortfallOf(cost: ResourceConsume | null | undefined): CryptoShortfall | null;
|
|
4011
|
+
private cryptoBalance;
|
|
4012
|
+
}
|
|
4013
|
+
|
|
3752
4014
|
/** Port of LootboxService.cs. */
|
|
3753
4015
|
declare class LootboxService {
|
|
3754
4016
|
private readonly ctx;
|
|
3755
4017
|
constructor(ctx: ClientContext);
|
|
3756
4018
|
getDefinitions(): Promise<OperationResult<LootboxDefinitionsResponse>>;
|
|
3757
|
-
open(lootboxID: string, count: number, selectedOptionID
|
|
4019
|
+
open(lootboxID: string, count: number, selectedOptionID?: string, payment?: PaymentProof): Promise<OperationResult<LootboxOpenResponse>>;
|
|
3758
4020
|
private baseRequest;
|
|
3759
4021
|
}
|
|
3760
4022
|
|
|
@@ -4085,7 +4347,16 @@ declare class CharacterService {
|
|
|
4085
4347
|
constructor(ctx: ClientContext);
|
|
4086
4348
|
getCharacterDefinitions(): Promise<OperationResult<CharacterDefinitions>>;
|
|
4087
4349
|
getUserCharacters(): Promise<OperationResult<GetCharactersResponse>>;
|
|
4088
|
-
|
|
4350
|
+
/**
|
|
4351
|
+
* Unlocks a character.
|
|
4352
|
+
*
|
|
4353
|
+
* `options.selectedOptionID` picks the way to pay; omitting it takes the first option available
|
|
4354
|
+
* on this platform. `options.payment` is required exactly when that option is paid in a store.
|
|
4355
|
+
*/
|
|
4356
|
+
unlockCharacter(characterID: string, options?: {
|
|
4357
|
+
selectedOptionID?: string;
|
|
4358
|
+
payment?: PaymentProof;
|
|
4359
|
+
}): Promise<OperationResult<UnlockCharacterResponse>>;
|
|
4089
4360
|
upgradeStatLevel(characterID: string, statID: string, opts?: UpgradeLevelsOptions): Promise<OperationResult<UpgradeStatLevelResponse>>;
|
|
4090
4361
|
upgradeCharacterLevel(characterID: string, opts?: UpgradeLevelsOptions): Promise<OperationResult<UpgradeCharacterLevelResponse>>;
|
|
4091
4362
|
equipItems(characterID: string, itemsToEquip: EquipSlotPair[]): Promise<OperationResult<EquipItemsResponse>>;
|
|
@@ -4127,7 +4398,7 @@ declare class CharacterService {
|
|
|
4127
4398
|
declare class MatchService {
|
|
4128
4399
|
private readonly ctx;
|
|
4129
4400
|
constructor(ctx: ClientContext);
|
|
4130
|
-
createMatch(entry: ResourceBundle, ruleID: string, characterID?: string, battleStrategy?: BattleStepConfig[], targetUserID?: string): Promise<OperationResult<CreateMatchResponse>>;
|
|
4401
|
+
createMatch(entry: ResourceBundle, ruleID: string, characterID?: string, battleStrategy?: BattleStepConfig[], targetUserID?: string, selectedOptionID?: string): Promise<OperationResult<CreateMatchResponse>>;
|
|
4131
4402
|
/** Edit an open match's own fields (e.g. privacy) before anyone joins. */
|
|
4132
4403
|
updateMatch(matchID: string, fields?: {
|
|
4133
4404
|
targetUserID?: string;
|
|
@@ -4169,7 +4440,10 @@ declare class CollectionService {
|
|
|
4169
4440
|
* ceiling (pack type → module setting → platform default); the response reports what actually
|
|
4170
4441
|
* happened in `OpenedCount` and breaks it down per pack in `Packs`.
|
|
4171
4442
|
*/
|
|
4172
|
-
openPack(collectionID: string, packTypeID: string, count?: number
|
|
4443
|
+
openPack(collectionID: string, packTypeID: string, count?: number, options?: {
|
|
4444
|
+
selectedOptionID?: string;
|
|
4445
|
+
payment?: PaymentProof;
|
|
4446
|
+
}): Promise<OperationResult<OpenPackResponse>>;
|
|
4173
4447
|
/** Opens `count` chests in ONE atomic operation. See openPack() for the multi-open contract. */
|
|
4174
4448
|
openCollectionChest(collectionID: string, collectionChestID: string, count?: number): Promise<OperationResult<OpenCollectionChestResponse>>;
|
|
4175
4449
|
useCollectibleJoker(collectionID: string, collectibleID: string): Promise<OperationResult<UseCollectibleJokerResponse>>;
|
|
@@ -4202,7 +4476,7 @@ declare class CoopEventService {
|
|
|
4202
4476
|
* object, and the remainder is neither rolled nor billed — check `SpinsUsed` against
|
|
4203
4477
|
* `RequestedSpins`. `count` is clamped server-side to `MaxSpinsPerCall`.
|
|
4204
4478
|
*/
|
|
4205
|
-
spin(coopChainID: string, groupID: string, count?: number): Promise<OperationResult<CoopSpinResponse>>;
|
|
4479
|
+
spin(coopChainID: string, groupID: string, count?: number, selectedOptionID?: string): Promise<OperationResult<CoopSpinResponse>>;
|
|
4206
4480
|
claimObjectReward(groupID: string): Promise<OperationResult<CoopClaimRewardResponse>>;
|
|
4207
4481
|
claimGrandPrize(groupID: string): Promise<OperationResult<CoopClaimRewardResponse>>;
|
|
4208
4482
|
leaveGroup(groupID?: string): Promise<OperationResult<CoopLeaveGroupResponse>>;
|
|
@@ -4217,7 +4491,17 @@ declare class DealOfferService {
|
|
|
4217
4491
|
getUserState(): Promise<OperationResult<UserDealOffersStateResponse>>;
|
|
4218
4492
|
getActiveDeals(): Promise<OperationResult<GetActiveDealsResponse>>;
|
|
4219
4493
|
dismissDeal(slotID: string): Promise<OperationResult<DismissDealResponse>>;
|
|
4220
|
-
|
|
4494
|
+
/**
|
|
4495
|
+
* Executes a node of an active deal.
|
|
4496
|
+
*
|
|
4497
|
+
* `options.selectedOptionID` picks the way to pay the node; `options.payment` carries the store
|
|
4498
|
+
* receipt and is required exactly when that option is paid in a store — the main monetization
|
|
4499
|
+
* path of deal offers.
|
|
4500
|
+
*/
|
|
4501
|
+
executeNode(slotID: string, nodeID: string, externalRefID?: string, options?: {
|
|
4502
|
+
selectedOptionID?: string;
|
|
4503
|
+
payment?: PaymentProof;
|
|
4504
|
+
}): Promise<OperationResult<ExecuteNodeResponse>>;
|
|
4221
4505
|
recordShow(slotID: string): Promise<OperationResult<RecordShowResponse>>;
|
|
4222
4506
|
claimMilestone(slotID: string, milestoneID: string): Promise<OperationResult<ClaimDealMilestoneResponse>>;
|
|
4223
4507
|
claimMilestonesBatch(slotID: string, milestoneIDs: string[]): Promise<OperationResult<ClaimDealMilestonesBatchResponse>>;
|
|
@@ -4266,7 +4550,10 @@ declare class TimedBoostService {
|
|
|
4266
4550
|
getDefinitions(): Promise<OperationResult<TimedBoostDefinitions>>;
|
|
4267
4551
|
getActive(): Promise<OperationResult<GetActiveTimedBoostsResponse>>;
|
|
4268
4552
|
getActiveWindows(): Promise<OperationResult<GetActiveBoostWindowsResponse>>;
|
|
4269
|
-
activate(boostID: string
|
|
4553
|
+
activate(boostID: string, options?: {
|
|
4554
|
+
selectedOptionID?: string;
|
|
4555
|
+
payment?: PaymentProof;
|
|
4556
|
+
}): Promise<OperationResult<ActivateTimedBoostResponse>>;
|
|
4270
4557
|
cleanupExpired(): Promise<OperationResult<SuccessResponse>>;
|
|
4271
4558
|
private baseRequest;
|
|
4272
4559
|
}
|
|
@@ -4357,7 +4644,7 @@ declare class GameLoopService {
|
|
|
4357
4644
|
boardLoopRaid(digIndex: number, existingRelatedEntityID?: string): Promise<OperationResult<RaidResponse>>;
|
|
4358
4645
|
boardLoopRaidFast(digIndices: number[]): Promise<OperationResult<RaidResponse>>;
|
|
4359
4646
|
boardLoopBuild(buildingIndex: number): Promise<OperationResult<BuildResponse>>;
|
|
4360
|
-
boardSpecialChoose(choiceID: string): Promise<OperationResult<SpecialChooseResponse>>;
|
|
4647
|
+
boardSpecialChoose(choiceID: string, selectedOptionID?: string): Promise<OperationResult<SpecialChooseResponse>>;
|
|
4361
4648
|
boardSpecialApplyMultiplier(existingRelatedEntityID?: string): Promise<OperationResult<SpecialApplyMultiplierResponse>>;
|
|
4362
4649
|
boardSpecialClaim(): Promise<OperationResult<SpecialClaimResponse>>;
|
|
4363
4650
|
/** Fetch this player's Community Chest state (active group, if any) + seconds remaining. */
|
|
@@ -4417,7 +4704,7 @@ declare class MarketplaceService {
|
|
|
4417
4704
|
getBuyOrders(itemID?: string, continuationToken?: string, pageSize?: number): Promise<OperationResult<MarketplaceBrowseResponse>>;
|
|
4418
4705
|
getMyState(): Promise<OperationResult<MarketplaceMyStateResponse>>;
|
|
4419
4706
|
getHistory(continuationToken?: string, pageSize?: number): Promise<OperationResult<MarketplaceHistoryResponse>>;
|
|
4420
|
-
createListing(itemID: string, catalogID: string, goodsAmount: number, priceBundle: ResourceBundle, durationHours: number, itemInstanceIDs?: string[]): Promise<OperationResult<MarketplaceCreateOfferResponse>>;
|
|
4707
|
+
createListing(itemID: string, catalogID: string, goodsAmount: number, priceBundle: ResourceBundle, durationHours: number, itemInstanceIDs?: string[], selectedOptionID?: string): Promise<OperationResult<MarketplaceCreateOfferResponse>>;
|
|
4421
4708
|
cancelListing(offerID: string): Promise<OperationResult<MarketplaceSettlementResponse>>;
|
|
4422
4709
|
buy(offerID: string): Promise<OperationResult<MarketplaceSettlementResponse>>;
|
|
4423
4710
|
/** Immediate-or-cancel market buy against the best matching active Listing (no resting order left behind on miss). */
|
|
@@ -4439,6 +4726,8 @@ declare class MarketplaceService {
|
|
|
4439
4726
|
bidCatalogID?: string;
|
|
4440
4727
|
bidItemID?: string;
|
|
4441
4728
|
itemInstanceIDs?: string[];
|
|
4729
|
+
/** Way to pay the listing fee (`PriceOption.OptionID`). */
|
|
4730
|
+
selectedOptionID?: string;
|
|
4442
4731
|
}): Promise<OperationResult<MarketplaceCreateOfferResponse>>;
|
|
4443
4732
|
placeBid(offerID: string, bidAmount: number): Promise<OperationResult<MarketplacePlaceBidResponse>>;
|
|
4444
4733
|
/** Role-dependent lazy finalization: winner claims goods, seller claims proceeds (net). */
|
|
@@ -4570,6 +4859,17 @@ declare class StoreApi {
|
|
|
4570
4859
|
getUserState(request: StoreRequest): Promise<OperationResult<UserStoreState>>;
|
|
4571
4860
|
}
|
|
4572
4861
|
|
|
4862
|
+
/** Thin transport wrapper for the Purchase feature (port of PurchaseAPI.cs). */
|
|
4863
|
+
declare class PurchaseApi {
|
|
4864
|
+
private readonly ctx;
|
|
4865
|
+
constructor(ctx: ClientContext);
|
|
4866
|
+
private send;
|
|
4867
|
+
getDefinitions(request: PurchaseRequest): Promise<OperationResult<PurchaseDefinitions>>;
|
|
4868
|
+
getUserState(request: PurchaseRequest): Promise<OperationResult<UserPurchaseState>>;
|
|
4869
|
+
validatePurchase(request: PurchaseRequest): Promise<OperationResult<PurchaseValidationResponse>>;
|
|
4870
|
+
validatePurchasesBatch(request: PurchaseRequest): Promise<OperationResult<PurchaseValidationBatchResponse>>;
|
|
4871
|
+
}
|
|
4872
|
+
|
|
4573
4873
|
/** Thin transport wrapper for the Lootbox feature (port of LootboxAPI.cs). */
|
|
4574
4874
|
declare class LootboxApi {
|
|
4575
4875
|
private readonly ctx;
|
|
@@ -4982,6 +5282,11 @@ declare class MultiplayerApi {
|
|
|
4982
5282
|
interface IDosGamesClientConfig extends SettingsInput {
|
|
4983
5283
|
/** Platform adapter (defaults to BrowserPlatformAdapter). Inject NoopPlatformAdapter in tests. */
|
|
4984
5284
|
platform?: PlatformAdapter;
|
|
5285
|
+
/**
|
|
5286
|
+
* Platform reported to the server (`X-IG-Platform`). Auto-detected when omitted; set it
|
|
5287
|
+
* explicitly in a native wrapper — the wrapper knows for certain, sniffing does not.
|
|
5288
|
+
*/
|
|
5289
|
+
clientPlatform?: ClientPlatform;
|
|
4985
5290
|
/** Custom fetch (defaults to global fetch). Inject a mock in tests. */
|
|
4986
5291
|
fetch?: typeof fetch;
|
|
4987
5292
|
/** Override the per-endpoint throttle window (ms). Default 600. */
|
|
@@ -4996,6 +5301,8 @@ declare class ClientContext {
|
|
|
4996
5301
|
readonly settings: IDosGamesSettings;
|
|
4997
5302
|
readonly emitter: TypedEmitter<SdkEvents>;
|
|
4998
5303
|
readonly platform: PlatformAdapter;
|
|
5304
|
+
/** Platform reported to the server; services read it to filter payment options. */
|
|
5305
|
+
readonly clientPlatform: ClientPlatform;
|
|
4999
5306
|
readonly data: IDosGamesData;
|
|
5000
5307
|
readonly authStore: AuthStore;
|
|
5001
5308
|
readonly api: {
|
|
@@ -5004,6 +5311,7 @@ declare class ClientContext {
|
|
|
5004
5311
|
currency: CurrencyApi;
|
|
5005
5312
|
item: ItemApi;
|
|
5006
5313
|
store: StoreApi;
|
|
5314
|
+
purchase: PurchaseApi;
|
|
5007
5315
|
lootbox: LootboxApi;
|
|
5008
5316
|
reward: RewardApi;
|
|
5009
5317
|
quest: QuestApi;
|
|
@@ -5036,6 +5344,8 @@ declare class ClientContext {
|
|
|
5036
5344
|
readonly currency: CurrencyService;
|
|
5037
5345
|
readonly item: ItemService;
|
|
5038
5346
|
readonly store: StoreService;
|
|
5347
|
+
readonly purchase: PurchaseService;
|
|
5348
|
+
readonly checkout: CheckoutService;
|
|
5039
5349
|
readonly lootbox: LootboxService;
|
|
5040
5350
|
readonly reward: RewardService;
|
|
5041
5351
|
readonly quest: QuestService;
|
|
@@ -5082,6 +5392,13 @@ declare class IDosGamesClient {
|
|
|
5082
5392
|
get currency(): CurrencyService;
|
|
5083
5393
|
get item(): ItemService;
|
|
5084
5394
|
get store(): StoreService;
|
|
5395
|
+
/** Real-money purchases: the store product catalog and receipt validation. */
|
|
5396
|
+
get purchase(): PurchaseService;
|
|
5397
|
+
/**
|
|
5398
|
+
* Price options: what this client may show, what each option needs, how much crypto is missing.
|
|
5399
|
+
* Buying itself stays in the module that owns the entity — see the service docs.
|
|
5400
|
+
*/
|
|
5401
|
+
get checkout(): CheckoutService;
|
|
5085
5402
|
get lootbox(): LootboxService;
|
|
5086
5403
|
get reward(): RewardService;
|
|
5087
5404
|
get quest(): QuestService;
|
|
@@ -5271,4 +5588,4 @@ declare class LocalizationCache {
|
|
|
5271
5588
|
private versionsKey;
|
|
5272
5589
|
}
|
|
5273
5590
|
|
|
5274
|
-
export { type AcceptTradeOfferResponse, type ActivateReferralCodeResponse, type ActivateTimedBoostResponse, type ActiveBoostWindowInfo, type ActiveCoopEventInfo, type ActiveDealSlotInfo, type ActiveEventInfo, type ActiveSeasonInfo, type ActiveTimedBoost, type AdConsentSettings, type AdConsentState, type AdCreditsData, type AdDailyData, type AdFraudFlags, type AdFrequencyCappingSettings, type AdPendingRequest, type AdPlacementDefinition, type AdPlacementUserState, type AdProviderDefinition, type AdSessionData, AdType, type AdUnitConfig, type AdVerificationSettings, type AddQuestProgressResponse, type AdvertisingDefinitions, type AppOpenSettings, AttackOutcome, type AttackResponse, type AttributionInput, type AuthContext, AuthType, AuthenticationAction, type AuthenticationRequest, AuthenticationService, BannerPosition, type BannerSettings, type BaseRequest, type BatchDeleteUserCustomDataResponse, type BatchGetPublicUserCustomDataResponse, type BatchItemResult, type BatchResponse, type BatchSetUserCustomDataResponse, type BattleResult, type BattleStepConfig, type BlockchainAccountSafetyPolicy, BlockchainAction, type BlockchainConfigResponse, type BlockchainDefinitions, type BlockchainNetworkDefinition, BlockchainNetworkType, type BlockchainNftCollectionBinding, BlockchainOperationCategory, type BlockchainRequest, BlockchainService, type BlockchainStats, type BlockchainSystemState, BlockchainTransactionStatus, BlockchainTransactionType, type BoardLoopDefinition, type BoardLoopState, type BoardPendingInteraction, type BoardRollResponse, BodyPart, type BoostTriggerCounter, BoostWindowKind, BroadcastStatus, type BuildResponse, type BuildingState, type CancelMatchResponse, type CancelTradeOfferResponse, type ChangeUsernameResponse, CharacterAction, type CharacterClassification, type CharacterDefinition, type CharacterDefinitions, type CharacterEquipment, type CharacterEquipmentSlot, type CharacterIdentity, type CharacterLevelDefinition, type CharacterLevelRef, type CharacterModel, type CharacterRequest, CharacterService, type CharacterStatRef, type CharacterUnequipResult, type CharacterUnlock, type ClaimAllRewardsBatchResponse, type ClaimAllRewardsResult, type ClaimComebackRewardResponse, type ClaimCycleRewardResponse, type ClaimCycleRewardsBatchResponse, type ClaimDailyRewardResponse, type ClaimDealMilestoneResponse, type ClaimDealMilestonesBatchResponse, type ClaimGrandPrizeResponse, type ClaimGroupCompletionRewardResponse, type ClaimInviteRewardResponse, type ClaimInviteRewardsBatchResponse, type ClaimLeaderboardMilestoneResponse, type ClaimLeaderboardMilestonesBatchResponse, type ClaimMilestoneRewardResponse, type ClaimMilestoneRewardsBatchResponse, type ClaimMilestonesBatchResponse, type ClaimQuestRewardResponse, type ClaimQuestRewardsBatchResponse, type ClaimRewardResponse, type ClaimSetRewardResponse, type ClaimSetRewardsBatchResponse, type ClaimTierRewardResponse, type ClaimTierRewardsBatchResponse, type ClientState, CloudCodeAction, CloudCodeErrorCode, type CloudCodeLogEntry, CloudCodeLogLevel, type CloudCodeRequest, CloudCodeRevisionSelection, CloudCodeService, type CodeExecutionError, type CollectIdleAccrualResponse, CollectionAction, type CollectionDefinitions, type CollectionGlobalSettings, type CollectionRequest, CollectionService, type CollectionSetRef, type CollectionTradeOfferDocument, CommissionSink, type CommunityChestClaimResponse, type CommunityChestGroupDocument, type CommunityChestGroupStateResponse, type CommunityChestHistoryEntry, type CommunityChestLeaveResponse, type CommunityChestMember, CommunityChestMemberStatus, type CommunityChestSharedState, CommunityChestStatus, type CommunityChestUserStateResponse, type ConfirmWithdrawalResponse, type ConversionDailyCounter, ConversionRateMode, type ConversionTarget, type ConvertResponse, type CoopBuildObjectsMemberState, type CoopBuildObjectsState, type CoopClaimRewardResponse, CoopEventAction, type CoopEventDefinitions, type CoopEventRequest, CoopEventService, type CoopGroupDocument, type CoopGroupMember, type CoopGroupStateResponse, CoopGroupStatus, type CoopLeaveGroupResponse, CoopMemberStatus, type CoopPartnerObjectState, type CoopSpinResponse, type CoopUserStateResponse, CraftAction, type CraftDefinitions, type CraftDefinitionsResponse, type CraftRequest, type CraftResponse, CraftService, type CraftSingleResult, CraftType, type CreateMatchResponse, type CryptoConvertResponse, type CryptoCurrencyDefinition, type CryptoCurrencyPermissions, type CryptoLimits, type CryptoNetworkBinding, CurrencyAction, type CurrencyAudit, type CurrencyConversion, type CurrencyDefinitions, type CurrencyRequest, CurrencyService, CurrencyStatus, CurrencyType, CustomDataBucket, CustomDataValueType, CustomDataWriter, type CyclicSchedule, DEFAULT_BASE_URL, type DailyUsageRecord, type DealMilestoneProgressInfo, DealNodeRuntimeStatus, DealOfferAction, DealOfferActivationStatus, type DealOfferDefinitions, type DealOfferRequest, DealOfferService, type DealOffersDefinitionResponse, type DeclineTradeOfferResponse, type DepositNFTResponse, type DepositTokenResponse, type DismissDealResponse, type DonationResponse, EnvelopeType, type EquipItemsResponse, type EquipSlotPair, type EquipmentPreset, type EquipmentSlot, type EquippedItem, type EventMap, type EventMilestoneClaimResponse, type EventTokenAddress, type EventTokenConversion, type EventTokenDefinition, type EventTokenGrantResponse, type EventTokenOperation, type EventTokenSpendResponse, EventTokenType, type ExecuteCloudCodeResponse, type ExecuteNodeResponse, type ExperimentDefinition, type ExperimentDefinitions, type ExperimentVariant, type ExperimentVariantCondition, type FodderConsumedEntry, FodderSelectionMode, FodderValuationMode, type FriendActionResponse, FriendActionStatus, type FriendPublicProfile, type FriendsListResponse, GameLoopAction, type GameLoopDefinitions, type GameLoopRequest, GameLoopService, type GetActiveBoostWindowsResponse, type GetActiveDealsResponse, type GetActiveEventsResponse, type GetActiveTimedBoostsResponse, type GetCharactersResponse, type GetLeaderboardResponse, type GetLeaderboardsBatchResponse, type GetMatchDefinitionsResponse, type GetMilestoneRewardMultiplierResponse, type GetMyProgressResponse, type GetMyUserCustomDataResponse, type GetOverviewBatchResponse, type GetProgressBatchResponse, type GetPublicTitleDataResponse, type GetPublicUserCustomDataResponse, type GetTradeOffersResponse, type GetUserQuestStateResponse, type GetUserTutorialStateResponse, type GrantStatusTokensResponse, type GrantTokensBatchResponse, type GrantedCollectible, type HeistCell, IDosGamesClient, type IDosGamesClientConfig, IDosGamesData, type IDosGamesSettings, type IceServer, type InstantBattleDefinitions, type InstantBattleResponse, type InstantBattleRule, type InterstitialSettings, type InventoryDelta, ItemAction, type ItemCatalog, type ItemDefinition, type ItemDefinitions, type ItemEquipment, type ItemMetadata, type ItemRequest, ItemService, type ItemStats, type ItemTotals, type ItemUpgrade, type ItemUpgradeFodder, type ItemUpgradeRef, type JsonValue, KeyValueStorage, KycStatus, KycTier, LeaderboardAction, type LeaderboardDefinitions, type LeaderboardMilestoneRef, type LeaderboardOverview, type LeaderboardRequest, type LeaderboardScoreRef, LeaderboardService, type LeaderboardUserEntry, type LeaveRoomResponse, type LevelsPreset, type LimitSpec, type LinkedWalletInfo, type Listener, LocalizationAction, LocalizationCache, type LocalizationDefinitions, type LocalizationLocaleDefinition, type LocalizationLocaleInfo, type LocalizationManifestResponse, LocalizationMissingKeyMode, type LocalizationParams, type LocalizationRequest, LocalizationService, type LocalizationState, type LocalizationTableRef, type LocalizationTableResponse, LootboxAction, type LootboxAmountRange, type LootboxDefinitions, type LootboxDefinitionsResponse, type LootboxGlobalSettings, type LootboxOpenResponse, type LootboxPityRule, type LootboxPityTriggerResponse, type LootboxRequest, type LootboxRewardRoll, type LootboxRewardSlot, LootboxService, type LootboxSupplyRule, type MailboxBroadcastDocument, type MailboxDefinition, type MailboxMessageDocument, MailboxMessageSource, MailboxMessageStatus, type MailboxMessageTypeDefinition, type MailboxSegmentDefinition, MarketGoodsType, MarketOfferStatus, MarketOfferType, MarketplaceAction, type MarketplaceActionCounter, type MarketplaceAuctionSettings, type MarketplaceAuctionState, type MarketplaceBidRefund, type MarketplaceBrowseResponse, type MarketplaceBuyOrderSettings, type MarketplaceCommissionOverride, type MarketplaceCommissionPolicy, type MarketplaceCreateOfferResponse, type MarketplaceDefinitions, type MarketplaceDirectTradeSettings, type MarketplaceGetDefinitionsResponse, type MarketplaceGroupedOfferView, type MarketplaceGroupedOffersResponse, type MarketplaceHistoryEntryView, type MarketplaceHistoryResponse, type MarketplaceListingSettings, type MarketplaceMatchingSettings, type MarketplaceMyStateResponse, type MarketplaceOfferResponse, type MarketplaceOfferView, type MarketplacePlaceBidResponse, type MarketplacePricePolicy, type MarketplaceRequest, MarketplaceService, type MarketplaceSettlementResponse, type MarketplaceTradabilityPolicy, MatchAction, type MatchDefinitions, type MatchRequest, MatchService, MatchStatus, type MatchesPageResponse, type MilestoneClaimRef, type MilestoneDefinition, MultiplayerAction, MultiplayerChatMode, type MultiplayerDefinitions, type MultiplayerRequest, MultiplayerService, type MultiplayerSystemState, MultiplayerTopology, type NFTModel, type NFTNetworkBinding, type NFTTransactionDocument, type NFTWithdrawalResponse, type NftCollectionStats, type NftStatsContainer, type OpenCollectionChestResponse, type OpenPackResponse, type OperationFailure, type OperationFailureReason, type OperationResult, type OperationSuccess, type PackOpenResult, type PendingWithdrawalRef, PlatformAdapter, type PlatformBlockchainState, type PlatformLoginResponse, type PlayerEconomyTuningState, type PollResponse, PremiumAction, type PremiumAdReduction, type PremiumDefinitions, type PremiumDefinitionsResponse, type PremiumPurchaseResponse, type PremiumRequest, PremiumService, type PremiumStateResponse, type PremiumSubscription, type PublishResponse, type PurchaseBatchResponse, type PvPMatch, QuestAction, type QuestAvailability, type QuestClaimRef, type QuestCycleDefinition, type QuestDefinition, type QuestDefinitions, type QuestGroupCompletionDefinition, type QuestIdentity, type QuestLinking, type QuestObjectiveDefinition, QuestObjectiveSource, type QuestPhaseDefinition, type QuestPointsTrackView, QuestPrerequisiteMode, type QuestPresetBindings, type QuestPresetRegistry, type QuestProgressUpdate, type QuestRequest, type QuestReward, QuestService, QuestStatus, RaidMode, type RaidResponse, type RealtimeEnvelope, type RechargeConfig, type RecordShowResponse, ReferralAction, type ReferralDefinitions, type ReferralDefinitionsResponse, type ReferralInviteRewardState, type ReferralRequest, ReferralService, type RelativeWindow, type ResourceBundle, type ResourceConsume, type ResourceDualPartyResult, type ResourceEntry, ResourceEntryType, type ResourceGrant, type ResourceOperation, type ResourceTransferResult, type RetryWithdrawalResponse, RewardAction, type RewardDefinitions, type RewardDefinitionsResponse, type RewardRequest, RewardService, type RewardedVideoSettings, type RollActionData, type RoomListItem, type RoomMemberView, type RoomSnapshotResponse, RoomVisibility, type RoomsPageResponse, type ScheduleChain, type ScheduleChainPhase, ScheduleMode, type ScheduleSpec, type ScheduledWindow, type SdkEvents, SeasonAction, type SeasonDefinitions, type SeasonRequest, SeasonService, type SeasonTierRewardBundle, type SeasonTierRewardMultiplier, type SeasonTierRewardSet, type SegmentGate, type SendTradeOfferResponse, type SetUserCustomDataResponse, type SettingsInput, SocialAction, type SocialCounters, type SocialRequest, SocialService, type SocialTimelineEvent, type SolanaWithdrawalSignature, type SpecialApplyMultiplierResponse, SpecialChoiceMode, type SpecialChooseResponse, type SpecialClaimResponse, type SpecialModeOfferData, type SpecialPendingState, type SpendRewardDefinition, type SpendTokensBatchResponse, type SsoCodeFromUrl, type StatDefinition, type StatRequirement, type StatsPreset, StoreAction, type StoreDefinitions, type StorePurchaseRef, type StorePurchaseResponse, type StorePurchaseState, type StoreRequest, StoreService, StoreType, type StoredLocalizationTable, type SubmitScoreResponse, type SubmitScoresBatchResponse, type SuccessResponse, TimedBoostAction, type TimedBoostDefinitions, type TimedBoostRequest, TimedBoostService, TimedBoostStackingPolicy, TimedEventAction, type TimedEventDefinitions, type TimedEventGrantRef, type TimedEventInstanceRef, type TimedEventMilestoneRef, type TimedEventRequest, TimedEventService, type TimedEventSpendRef, TimelineEventType, type TimelineResponse, TitleAction, TitleConfig, TitleCustomDataAction, type TitleCustomDataDefinitions, type TitleCustomDataKeyDefinition, type TitleCustomDataRecord, type TitleCustomDataRequest, TitleCustomDataService, TitleDataBucket, TitleDataScope, type TitlePublicConfigurationModel, type TitleRequest, TitleService, type TokenCurrencyStats, type TokenStatsContainer, type TokenTransactionDocument, type TokenWithdrawalResponse, TradeOfferStatus, TransactionDirection, type TransactionHistoryResponse, type TriggerContext, type TriggerSource, TutorialAction, type TutorialAvailability, type TutorialBlockingPolicy, TutorialBoardAction, type TutorialBoardScript, type TutorialClaimResponse, type TutorialDefinitions, type TutorialFlowBatchResponse, type TutorialFlowDefinition, type TutorialFlowPolicy, type TutorialFlowResponse, TutorialFlowStatus, type TutorialFlowView, type TutorialGateCondition, TutorialGateMode, type TutorialGlobalSettings, type TutorialIdentity, type TutorialPresetBindings, type TutorialPresetRegistry, type TutorialRequest, TutorialRestartPolicy, type TutorialReward, TutorialScriptModule, type TutorialScriptedOutcome, type TutorialStepCompletion, TutorialStepCompletionMode, type TutorialStepDefinition, type TutorialStepEffects, type TutorialStepIdentity, type TutorialStepPolicy, type TutorialStepProgress, TypedEmitter, type UnequipAllCharactersResponse, type UnequipItemsResponse, type UnlockCharacterResponse, type UnlockCharactersBatchResponse, type UnstackableItemInstanceState, type Unsubscribe, type UpdateMatchResponse, type UpgradeCharacterLevelResponse, type UpgradeCharacterLevelsBatchResponse, type UpgradeItemLevelResponse, type UpgradeLevelsBatchResponse, type UpgradeLevelsOptions, type UpgradeStatLevelResponse, type UpgradeStatLevelsBatchResponse, type UsageReactivationEvent, type UsageTimeStats, type UseCollectibleJokerResponse, UserAction, type UserAdvertisingState, type UserBlockchainState, type UserBlockchainStateResponse, type UserCharactersState, type UserClaimRewardState, type UserCollectionState, type UserComebackState, type UserCommunityChestState, type UserCoopEventState, type UserCryptoComplianceCounters, type UserCryptoCurrencyState, UserCustomDataAction, type UserCustomDataBatchDeleteItem, type UserCustomDataBatchSetItem, type UserCustomDataDefinitions, type UserCustomDataKeyDefinition, type UserCustomDataRecord, type UserCustomDataRequest, UserCustomDataService, type UserCustomDataState, type UserDailyCalendarState, type UserDailyCounters, UserData, type UserDealNodeLifetimeCounts, type UserDealNodeState, type UserDealOfferActivationState, type UserDealOfferHistory, type UserDealOffersState, type UserDealOffersStateResponse, type UserDealSlotState, type UserDealTrackState, type UserDepositAddress, type UserEventTokenProgress, type UserEventTokensState, type UserGameLoopsState, type UserIdleAccrualState, type UserInventoryState, type UserKycState, type UserLeaderboardProgress, type UserLeaderboardsState, type UserLootboxPityCounter, type UserLootboxState, type UserMailboxState, type UserMarketplaceState, type UserMatchCreationLimitState, type UserMatchState, type UserPremiumState, type UserPublicDataModel, type UserQuestCycleState, type UserQuestObjectiveProgress, type UserQuestProgress, type UserQuestState, type UserReferralState, type UserReferralStateResponse, type UserRequest, type UserRewardState, type UserRewardsStateResponse, type UserSeasonState, type UserSeasonStateResponse, type UserSeasonsState, UserService, type UserSocialState, type UserState, type UserStateSlice, type UserStateVersions, type UserStoreState, type UserTimedBoostsState, type UserTimedEventStateResponse, type UserTutorialFlowState, type UserTutorialState, type UserTutorialStepState, type UserUsageState, type UserVirtualCurrencyState, type VirtualCurrencyDefinition, type VirtualCurrencyEconomy, type VirtualCurrencyPermissions, type WalletChallengeResponse, WalletLinkType, type WithdrawalSignatureResponse, type WithdrawalSplit, beginSsoRedirect, createIDosGamesClient, isFail, isOk, normalizeBlockchainCategory, readSsoCodeFromUrl };
|
|
5591
|
+
export { type AcceptTradeOfferResponse, type ActivateReferralCodeResponse, type ActivateTimedBoostResponse, type ActiveBoostWindowInfo, type ActiveCoopEventInfo, type ActiveDealSlotInfo, type ActiveEventInfo, type ActiveSeasonInfo, type ActiveTimedBoost, type AdConsentSettings, type AdConsentState, type AdCreditsData, type AdDailyData, type AdFraudFlags, type AdFrequencyCappingSettings, type AdPendingRequest, type AdPlacementDefinition, type AdPlacementUserState, type AdProviderDefinition, type AdSessionData, AdType, type AdUnitConfig, type AdVerificationSettings, type AddQuestProgressResponse, type AdvertisingDefinitions, type AppOpenSettings, AttackOutcome, type AttackResponse, type AttributionInput, type AuthContext, AuthType, AuthenticationAction, type AuthenticationRequest, AuthenticationService, BannerPosition, type BannerSettings, type BaseRequest, type BatchDeleteUserCustomDataResponse, type BatchGetPublicUserCustomDataResponse, type BatchItemResult, type BatchResponse, type BatchSetUserCustomDataResponse, type BattleResult, type BattleStepConfig, type BlockchainAccountSafetyPolicy, BlockchainAction, type BlockchainConfigResponse, type BlockchainDefinitions, type BlockchainNetworkDefinition, BlockchainNetworkType, type BlockchainNftCollectionBinding, BlockchainOperationCategory, type BlockchainRequest, BlockchainService, type BlockchainStats, type BlockchainSystemState, BlockchainTransactionStatus, BlockchainTransactionType, type BoardLoopDefinition, type BoardLoopState, type BoardPendingInteraction, type BoardRollResponse, BodyPart, type BoostTriggerCounter, BoostWindowKind, BroadcastStatus, type BuildResponse, type BuildingState, type CancelMatchResponse, type CancelTradeOfferResponse, type ChangeUsernameResponse, CharacterAction, type CharacterClassification, type CharacterDefinition, type CharacterDefinitions, type CharacterEquipment, type CharacterEquipmentSlot, type CharacterIdentity, type CharacterLevelDefinition, type CharacterLevelRef, type CharacterModel, type CharacterRequest, CharacterService, type CharacterStatRef, type CharacterUnequipResult, type CharacterUnlock, CheckoutService, type ClaimAllRewardsBatchResponse, type ClaimAllRewardsResult, type ClaimComebackRewardResponse, type ClaimCycleRewardResponse, type ClaimCycleRewardsBatchResponse, type ClaimDailyRewardResponse, type ClaimDealMilestoneResponse, type ClaimDealMilestonesBatchResponse, type ClaimGrandPrizeResponse, type ClaimGroupCompletionRewardResponse, type ClaimInviteRewardResponse, type ClaimInviteRewardsBatchResponse, type ClaimLeaderboardMilestoneResponse, type ClaimLeaderboardMilestonesBatchResponse, type ClaimMilestoneRewardResponse, type ClaimMilestoneRewardsBatchResponse, type ClaimMilestonesBatchResponse, type ClaimQuestRewardResponse, type ClaimQuestRewardsBatchResponse, type ClaimRewardResponse, type ClaimSetRewardResponse, type ClaimSetRewardsBatchResponse, type ClaimTierRewardResponse, type ClaimTierRewardsBatchResponse, ClientPlatform, type ClientState, CloudCodeAction, CloudCodeErrorCode, type CloudCodeLogEntry, CloudCodeLogLevel, type CloudCodeRequest, CloudCodeRevisionSelection, CloudCodeService, type CodeExecutionError, type CollectIdleAccrualResponse, CollectionAction, type CollectionDefinitions, type CollectionGlobalSettings, type CollectionRequest, CollectionService, type CollectionSetRef, type CollectionTradeOfferDocument, CommissionSink, type CommunityChestClaimResponse, type CommunityChestGroupDocument, type CommunityChestGroupStateResponse, type CommunityChestHistoryEntry, type CommunityChestLeaveResponse, type CommunityChestMember, CommunityChestMemberStatus, type CommunityChestSharedState, CommunityChestStatus, type CommunityChestUserStateResponse, type ConfirmWithdrawalResponse, type ConversionDailyCounter, ConversionRateMode, type ConversionTarget, type ConvertResponse, type CoopBuildObjectsMemberState, type CoopBuildObjectsState, type CoopClaimRewardResponse, CoopEventAction, type CoopEventDefinitions, type CoopEventRequest, CoopEventService, type CoopGroupDocument, type CoopGroupMember, type CoopGroupStateResponse, CoopGroupStatus, type CoopLeaveGroupResponse, CoopMemberStatus, type CoopPartnerObjectState, type CoopSpinResponse, type CoopUserStateResponse, CraftAction, type CraftDefinitions, type CraftDefinitionsResponse, type CraftRequest, type CraftResponse, CraftService, type CraftSingleResult, CraftType, type CreateMatchResponse, type CryptoConvertResponse, type CryptoCurrencyDefinition, type CryptoCurrencyPermissions, type CryptoLimits, type CryptoNetworkBinding, type CryptoShortfall, CurrencyAction, type CurrencyAudit, type CurrencyConversion, type CurrencyDefinitions, type CurrencyRequest, CurrencyService, CurrencyStatus, CurrencyType, CustomDataBucket, CustomDataValueType, CustomDataWriter, type CyclicSchedule, DEFAULT_BASE_URL, type DailyUsageRecord, type DealMilestoneProgressInfo, DealNodeRuntimeStatus, DealOfferAction, DealOfferActivationStatus, type DealOfferDefinitions, type DealOfferRequest, DealOfferService, type DealOffersDefinitionResponse, type DeclineTradeOfferResponse, type DepositNFTResponse, type DepositTokenResponse, type DismissDealResponse, type DonationResponse, EnvelopeType, type EquipItemsResponse, type EquipSlotPair, type EquipmentPreset, type EquipmentSlot, type EquippedItem, type EventMap, type EventMilestoneClaimResponse, type EventTokenAddress, type EventTokenConversion, type EventTokenDefinition, type EventTokenGrantResponse, type EventTokenOperation, type EventTokenSpendResponse, EventTokenType, type ExecuteCloudCodeResponse, type ExecuteNodeResponse, type ExperimentDefinition, type ExperimentDefinitions, type ExperimentVariant, type ExperimentVariantCondition, type FodderConsumedEntry, FodderSelectionMode, FodderValuationMode, type FriendActionResponse, FriendActionStatus, type FriendPublicProfile, type FriendsListResponse, GameLoopAction, type GameLoopDefinitions, type GameLoopRequest, GameLoopService, type GetActiveBoostWindowsResponse, type GetActiveDealsResponse, type GetActiveEventsResponse, type GetActiveTimedBoostsResponse, type GetCharactersResponse, type GetLeaderboardResponse, type GetLeaderboardsBatchResponse, type GetMatchDefinitionsResponse, type GetMilestoneRewardMultiplierResponse, type GetMyProgressResponse, type GetMyUserCustomDataResponse, type GetOverviewBatchResponse, type GetProgressBatchResponse, type GetPublicTitleDataResponse, type GetPublicUserCustomDataResponse, type GetTradeOffersResponse, type GetUserQuestStateResponse, type GetUserTutorialStateResponse, type GrantStatusTokensResponse, type GrantTokensBatchResponse, type GrantedCollectible, type HeistCell, IDosGamesClient, type IDosGamesClientConfig, IDosGamesData, type IDosGamesSettings, type IapProductDefinition, type IapProductPurchaseState, type IapProductRules, IapProductType, IapPurchaseStatus, type IapStore, IapStore$1 as IapStoreValues, type IceServer, type InstantBattleDefinitions, type InstantBattleResponse, type InstantBattleRule, type InterstitialSettings, type InventoryDelta, ItemAction, type ItemCatalog, type ItemDefinition, type ItemDefinitions, type ItemEquipment, type ItemMetadata, type ItemRequest, ItemService, type ItemStats, type ItemTotals, type ItemUpgrade, type ItemUpgradeFodder, type ItemUpgradeRef, type JsonValue, KeyValueStorage, KycStatus, KycTier, LeaderboardAction, type LeaderboardDefinitions, type LeaderboardMilestoneRef, type LeaderboardOverview, type LeaderboardRequest, type LeaderboardScoreRef, LeaderboardService, type LeaderboardUserEntry, type LeaveRoomResponse, type LevelsPreset, type LimitSpec, type LinkedWalletInfo, type Listener, LocalizationAction, LocalizationCache, type LocalizationDefinitions, type LocalizationLocaleDefinition, type LocalizationLocaleInfo, type LocalizationManifestResponse, LocalizationMissingKeyMode, type LocalizationParams, type LocalizationRequest, LocalizationService, type LocalizationState, type LocalizationTableRef, type LocalizationTableResponse, LootboxAction, type LootboxAmountRange, type LootboxDefinitions, type LootboxDefinitionsResponse, type LootboxGlobalSettings, type LootboxOpenResponse, type LootboxPityRule, type LootboxPityTriggerResponse, type LootboxRequest, type LootboxRewardRoll, type LootboxRewardSlot, LootboxService, type LootboxSupplyRule, type MailboxBroadcastDocument, type MailboxDefinition, type MailboxMessageDocument, MailboxMessageSource, MailboxMessageStatus, type MailboxMessageTypeDefinition, type MailboxSegmentDefinition, MarketGoodsType, MarketOfferStatus, MarketOfferType, MarketplaceAction, type MarketplaceActionCounter, type MarketplaceAuctionSettings, type MarketplaceAuctionState, type MarketplaceBidRefund, type MarketplaceBrowseResponse, type MarketplaceBuyOrderSettings, type MarketplaceCommissionOverride, type MarketplaceCommissionPolicy, type MarketplaceCreateOfferResponse, type MarketplaceDefinitions, type MarketplaceDirectTradeSettings, type MarketplaceGetDefinitionsResponse, type MarketplaceGroupedOfferView, type MarketplaceGroupedOffersResponse, type MarketplaceHistoryEntryView, type MarketplaceHistoryResponse, type MarketplaceListingSettings, type MarketplaceMatchingSettings, type MarketplaceMyStateResponse, type MarketplaceOfferResponse, type MarketplaceOfferView, type MarketplacePlaceBidResponse, type MarketplacePricePolicy, type MarketplaceRequest, MarketplaceService, type MarketplaceSettlementResponse, type MarketplaceTradabilityPolicy, MatchAction, type MatchDefinitions, type MatchRequest, MatchService, MatchStatus, type MatchesPageResponse, type MilestoneClaimRef, type MilestoneDefinition, MultiplayerAction, MultiplayerChatMode, type MultiplayerDefinitions, type MultiplayerRequest, MultiplayerService, type MultiplayerSystemState, MultiplayerTopology, type NFTModel, type NFTNetworkBinding, type NFTTransactionDocument, type NFTWithdrawalResponse, type NftCollectionStats, type NftStatsContainer, type OpenCollectionChestResponse, type OpenPackResponse, type OperationFailure, type OperationFailureReason, type OperationResult, type OperationSuccess, type PackOpenResult, type PaymentProof, type PaymentRequirement, type PendingWithdrawalRef, PlatformAdapter, type PlatformBlockchainState, type PlatformLoginResponse, type PlayerEconomyTuningState, type PollResponse, PremiumAction, type PremiumAdReduction, type PremiumDefinitions, type PremiumDefinitionsResponse, type PremiumPurchaseResponse, type PremiumRequest, PremiumService, type PremiumStateResponse, type PremiumSubscription, type PriceOption, type PriceOptions, type PublishResponse, PurchaseAction, type PurchaseBatchResponse, type PurchaseDefinitions, type PurchaseReceiptRef, type PurchaseRequest, PurchaseService, type PurchaseValidationBatchResponse, type PurchaseValidationResponse, type PvPMatch, QuestAction, type QuestAvailability, type QuestClaimRef, type QuestCycleDefinition, type QuestDefinition, type QuestDefinitions, type QuestGroupCompletionDefinition, type QuestIdentity, type QuestLinking, type QuestObjectiveDefinition, QuestObjectiveSource, type QuestPhaseDefinition, type QuestPointsTrackView, QuestPrerequisiteMode, type QuestPresetBindings, type QuestPresetRegistry, type QuestProgressUpdate, type QuestRequest, type QuestReward, QuestService, QuestStatus, RaidMode, type RaidResponse, type RealtimeEnvelope, type RechargeConfig, type RecordShowResponse, ReferralAction, type ReferralDefinitions, type ReferralDefinitionsResponse, type ReferralInviteRewardState, type ReferralRequest, ReferralService, type RelativeWindow, type ResourceBundle, type ResourceConsume, type ResourceDualPartyResult, type ResourceEntry, ResourceEntryType, type ResourceGrant, type ResourceOperation, type ResourceTransferResult, type RetryWithdrawalResponse, RewardAction, type RewardDefinitions, type RewardDefinitionsResponse, type RewardRequest, RewardService, type RewardedVideoSettings, type RollActionData, type RoomListItem, type RoomMemberView, type RoomSnapshotResponse, RoomVisibility, type RoomsPageResponse, type ScheduleChain, type ScheduleChainPhase, ScheduleMode, type ScheduleSpec, type ScheduledWindow, type SdkEvents, SeasonAction, type SeasonDefinitions, type SeasonRequest, SeasonService, type SeasonTierRewardBundle, type SeasonTierRewardMultiplier, type SeasonTierRewardSet, type SegmentGate, type SendTradeOfferResponse, type SetUserCustomDataResponse, type SettingsInput, SocialAction, type SocialCounters, type SocialRequest, SocialService, type SocialTimelineEvent, type SolanaWithdrawalSignature, type SpecialApplyMultiplierResponse, SpecialChoiceMode, type SpecialChooseResponse, type SpecialClaimResponse, type SpecialModeOfferData, type SpecialPendingState, type SpendRewardDefinition, type SpendTokensBatchResponse, type SsoCodeFromUrl, type StatDefinition, type StatRequirement, type StatsPreset, StoreAction, type StoreDefinitions, type StorePurchaseRef, type StorePurchaseResponse, type StorePurchaseState, type StoreRequest, StoreService, StoreType, type StoredLocalizationTable, type SubmitScoreResponse, type SubmitScoresBatchResponse, type SuccessResponse, TimedBoostAction, type TimedBoostDefinitions, type TimedBoostRequest, TimedBoostService, TimedBoostStackingPolicy, TimedEventAction, type TimedEventDefinitions, type TimedEventGrantRef, type TimedEventInstanceRef, type TimedEventMilestoneRef, type TimedEventRequest, TimedEventService, type TimedEventSpendRef, TimelineEventType, type TimelineResponse, TitleAction, TitleConfig, TitleCustomDataAction, type TitleCustomDataDefinitions, type TitleCustomDataKeyDefinition, type TitleCustomDataRecord, type TitleCustomDataRequest, TitleCustomDataService, TitleDataBucket, TitleDataScope, type TitlePublicConfigurationModel, type TitleRequest, TitleService, type TokenCurrencyStats, type TokenStatsContainer, type TokenTransactionDocument, type TokenWithdrawalResponse, TradeOfferStatus, TransactionDirection, type TransactionHistoryResponse, type TriggerContext, type TriggerSource, TutorialAction, type TutorialAvailability, type TutorialBlockingPolicy, TutorialBoardAction, type TutorialBoardScript, type TutorialClaimResponse, type TutorialDefinitions, type TutorialFlowBatchResponse, type TutorialFlowDefinition, type TutorialFlowPolicy, type TutorialFlowResponse, TutorialFlowStatus, type TutorialFlowView, type TutorialGateCondition, TutorialGateMode, type TutorialGlobalSettings, type TutorialIdentity, type TutorialPresetBindings, type TutorialPresetRegistry, type TutorialRequest, TutorialRestartPolicy, type TutorialReward, TutorialScriptModule, type TutorialScriptedOutcome, type TutorialStepCompletion, TutorialStepCompletionMode, type TutorialStepDefinition, type TutorialStepEffects, type TutorialStepIdentity, type TutorialStepPolicy, type TutorialStepProgress, TypedEmitter, type UnequipAllCharactersResponse, type UnequipItemsResponse, type UnlockCharacterResponse, type UnlockCharactersBatchResponse, type UnstackableItemInstanceState, type Unsubscribe, type UpdateMatchResponse, type UpgradeCharacterLevelResponse, type UpgradeCharacterLevelsBatchResponse, type UpgradeItemLevelResponse, type UpgradeLevelsBatchResponse, type UpgradeLevelsOptions, type UpgradeStatLevelResponse, type UpgradeStatLevelsBatchResponse, type UsageReactivationEvent, type UsageTimeStats, type UseCollectibleJokerResponse, UserAction, type UserAdvertisingState, type UserBlockchainState, type UserBlockchainStateResponse, type UserCharactersState, type UserClaimRewardState, type UserCollectionState, type UserComebackState, type UserCommunityChestState, type UserCoopEventState, type UserCryptoComplianceCounters, type UserCryptoCurrencyState, UserCustomDataAction, type UserCustomDataBatchDeleteItem, type UserCustomDataBatchSetItem, type UserCustomDataDefinitions, type UserCustomDataKeyDefinition, type UserCustomDataRecord, type UserCustomDataRequest, UserCustomDataService, type UserCustomDataState, type UserDailyCalendarState, type UserDailyCounters, UserData, type UserDealNodeLifetimeCounts, type UserDealNodeState, type UserDealOfferActivationState, type UserDealOfferHistory, type UserDealOffersState, type UserDealOffersStateResponse, type UserDealSlotState, type UserDealTrackState, type UserDepositAddress, type UserEventTokenProgress, type UserEventTokensState, type UserGameLoopsState, type UserIdleAccrualState, type UserInventoryState, type UserKycState, type UserLeaderboardProgress, type UserLeaderboardsState, type UserLootboxPityCounter, type UserLootboxState, type UserMailboxState, type UserMarketplaceState, type UserMatchCreationLimitState, type UserMatchState, type UserPremiumState, type UserPublicDataModel, type UserPurchaseState, type UserQuestCycleState, type UserQuestObjectiveProgress, type UserQuestProgress, type UserQuestState, type UserReferralState, type UserReferralStateResponse, type UserRequest, type UserRewardState, type UserRewardsStateResponse, type UserSeasonState, type UserSeasonStateResponse, type UserSeasonsState, UserService, type UserSocialState, type UserState, type UserStateSlice, type UserStateVersions, type UserStoreState, type UserTimedBoostsState, type UserTimedEventStateResponse, type UserTutorialFlowState, type UserTutorialState, type UserTutorialStepState, type UserUsageState, type UserVirtualCurrencyState, type VirtualCurrencyDefinition, type VirtualCurrencyEconomy, type VirtualCurrencyPermissions, type WalletChallengeResponse, WalletLinkType, type WithdrawalSignatureResponse, type WithdrawalSplit, beginSsoRedirect, createIDosGamesClient, isFail, isOk, normalizeBlockchainCategory, readSsoCodeFromUrl, zPaymentProof, zPriceOption, zPriceOptions };
|