@community-fabs/playfab-web-sdk 1.193.250606-1 → 1.194.250620
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/dist/Addon.js +2 -2
- package/dist/Admin.d.ts +117 -83
- package/dist/Admin.js +2 -2
- package/dist/Authentication.d.ts +4 -2
- package/dist/Authentication.js +2 -2
- package/dist/Client.d.ts +51 -32
- package/dist/Client.js +2 -2
- package/dist/CloudScript.d.ts +15 -8
- package/dist/CloudScript.js +2 -2
- package/dist/Data.d.ts +2 -1
- package/dist/Data.js +2 -2
- package/dist/Economy.d.ts +26 -16
- package/dist/Economy.js +2 -2
- package/dist/Events.d.ts +5 -3
- package/dist/Events.js +2 -2
- package/dist/Experimentation.d.ts +8 -5
- package/dist/Experimentation.js +2 -2
- package/dist/Groups.d.ts +3 -2
- package/dist/Groups.js +2 -2
- package/dist/Insights.js +2 -2
- package/dist/Localization.js +2 -2
- package/dist/Matchmaker.d.ts +3 -2
- package/dist/Matchmaker.js +2 -2
- package/dist/Multiplayer.d.ts +68 -53
- package/dist/Multiplayer.js +2 -2
- package/dist/Profiles.d.ts +6 -4
- package/dist/Profiles.js +2 -2
- package/dist/Progression.d.ts +8 -4
- package/dist/Progression.js +2 -2
- package/dist/Server.d.ts +55 -35
- package/dist/Server.js +2 -2
- package/dist/{chunk-IFBBLD7Q.js → chunk-25WD3CAR.js} +2 -2
- package/dist/{chunk-QJRCYM7I.js → chunk-2KENN6K4.js} +2 -2
- package/dist/{chunk-MHSKIHSG.js → chunk-3FN2QIKG.js} +2 -2
- package/dist/{chunk-YI4OQ74L.js → chunk-4WIXXA2D.js} +2 -2
- package/dist/{chunk-6OZSERVG.js → chunk-5VL2MDQH.js} +3 -3
- package/dist/{chunk-6OZSERVG.js.map → chunk-5VL2MDQH.js.map} +1 -1
- package/dist/{chunk-K2I6VCQK.js → chunk-6CD37OTG.js} +2 -2
- package/dist/{chunk-QHQBHTHP.js → chunk-6OSVAJM6.js} +2 -2
- package/dist/{chunk-SZJQBNVS.js → chunk-DDOQH64N.js} +2 -2
- package/dist/{chunk-P4FCADAY.js → chunk-DEKC3RGM.js} +2 -2
- package/dist/{chunk-RVBFE5D5.js → chunk-DUFJF5YI.js} +2 -2
- package/dist/{chunk-3DU2LYBT.js → chunk-EMAR3JI6.js} +2 -2
- package/dist/{chunk-WBPWV6H3.js → chunk-FJ7CVV4B.js} +2 -2
- package/dist/{chunk-BD7SF6AA.js → chunk-JHVT2GUV.js} +2 -2
- package/dist/{chunk-CPJ6FMQ3.js → chunk-KEM5M5YI.js} +2 -2
- package/dist/{chunk-SF5NNTLE.js → chunk-OGEK5XJO.js} +2 -2
- package/dist/{chunk-OZLGFCPU.js → chunk-P3PBVZBN.js} +2 -2
- package/dist/{chunk-MQZCB76F.js → chunk-PE3HZUZR.js} +2 -2
- package/dist/{chunk-J2KKGAWN.js → chunk-QNR3Z4UZ.js} +6 -6
- package/dist/{chunk-J2KKGAWN.js.map → chunk-QNR3Z4UZ.js.map} +1 -1
- package/dist/index.js +18 -18
- package/package.json +6 -5
- /package/dist/{chunk-IFBBLD7Q.js.map → chunk-25WD3CAR.js.map} +0 -0
- /package/dist/{chunk-QJRCYM7I.js.map → chunk-2KENN6K4.js.map} +0 -0
- /package/dist/{chunk-MHSKIHSG.js.map → chunk-3FN2QIKG.js.map} +0 -0
- /package/dist/{chunk-YI4OQ74L.js.map → chunk-4WIXXA2D.js.map} +0 -0
- /package/dist/{chunk-K2I6VCQK.js.map → chunk-6CD37OTG.js.map} +0 -0
- /package/dist/{chunk-QHQBHTHP.js.map → chunk-6OSVAJM6.js.map} +0 -0
- /package/dist/{chunk-SZJQBNVS.js.map → chunk-DDOQH64N.js.map} +0 -0
- /package/dist/{chunk-P4FCADAY.js.map → chunk-DEKC3RGM.js.map} +0 -0
- /package/dist/{chunk-RVBFE5D5.js.map → chunk-DUFJF5YI.js.map} +0 -0
- /package/dist/{chunk-3DU2LYBT.js.map → chunk-EMAR3JI6.js.map} +0 -0
- /package/dist/{chunk-WBPWV6H3.js.map → chunk-FJ7CVV4B.js.map} +0 -0
- /package/dist/{chunk-BD7SF6AA.js.map → chunk-JHVT2GUV.js.map} +0 -0
- /package/dist/{chunk-CPJ6FMQ3.js.map → chunk-KEM5M5YI.js.map} +0 -0
- /package/dist/{chunk-SF5NNTLE.js.map → chunk-OGEK5XJO.js.map} +0 -0
- /package/dist/{chunk-OZLGFCPU.js.map → chunk-P3PBVZBN.js.map} +0 -0
- /package/dist/{chunk-MQZCB76F.js.map → chunk-PE3HZUZR.js.map} +0 -0
package/dist/Admin.js
CHANGED
package/dist/Authentication.d.ts
CHANGED
|
@@ -68,6 +68,8 @@ interface GetEntityTokenResponse extends IPlayFabResultCommon {
|
|
|
68
68
|
/** The time the token will expire, if it is an expiring token, in UTC. */
|
|
69
69
|
TokenExpiration?: string;
|
|
70
70
|
}
|
|
71
|
+
type IdentifiedDeviceType = "Unknown" | "XboxOne" | "Scarlett" | "WindowsOneCore" | "WindowsOneCoreMobile" | "Win32" | "android" | "iOS" | "PlayStation" | "Nintendo";
|
|
72
|
+
type LoginIdentityProvider = "Unknown" | "PlayFab" | "Custom" | "GameCenter" | "GooglePlay" | "Steam" | "XBoxLive" | "PSN" | "Kongregate" | "Facebook" | "IOSDevice" | "AndroidDevice" | "Twitch" | "WindowsHello" | "GameServer" | "CustomServer" | "NintendoSwitch" | "FacebookInstantGames" | "OpenIdConnect" | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" | "XboxMobileStore" | "King" | "BattleNet";
|
|
71
73
|
interface ValidateEntityTokenRequest extends IPlayFabRequestCommon {
|
|
72
74
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
73
75
|
CustomTags?: Record<string, string | null>;
|
|
@@ -78,9 +80,9 @@ interface ValidateEntityTokenResponse extends IPlayFabResultCommon {
|
|
|
78
80
|
/** The entity id and type. */
|
|
79
81
|
Entity?: EntityKey;
|
|
80
82
|
/** The authenticated device for this entity, for the given login */
|
|
81
|
-
IdentifiedDeviceType?:
|
|
83
|
+
IdentifiedDeviceType?: IdentifiedDeviceType;
|
|
82
84
|
/** The identity provider for this entity, for the given login */
|
|
83
|
-
IdentityProvider?:
|
|
85
|
+
IdentityProvider?: LoginIdentityProvider;
|
|
84
86
|
/** The ID issued by the identity provider, e.g. a XUID on Xbox Live */
|
|
85
87
|
IdentityProviderIssuedId?: string;
|
|
86
88
|
/** The lineage of this profile. */
|
package/dist/Authentication.js
CHANGED
package/dist/Client.d.ts
CHANGED
|
@@ -15,6 +15,7 @@ interface AcceptTradeResponse extends IPlayFabResultCommon {
|
|
|
15
15
|
/** Details about trade which was just accepted. */
|
|
16
16
|
Trade?: TradeInfo;
|
|
17
17
|
}
|
|
18
|
+
type AdActivity = "Opened" | "Closed" | "Start" | "End";
|
|
18
19
|
interface AdCampaignAttributionModel {
|
|
19
20
|
/** UTC time stamp of attribution */
|
|
20
21
|
AttributedAt: string;
|
|
@@ -303,6 +304,7 @@ interface CharacterResult {
|
|
|
303
304
|
/** The type-string that was given to this character on creation. */
|
|
304
305
|
CharacterType?: string;
|
|
305
306
|
}
|
|
307
|
+
type CloudScriptRevisionOption = "Live" | "Latest" | "Specific";
|
|
306
308
|
/** @deprecated Do not use */
|
|
307
309
|
interface CollectionFilter {
|
|
308
310
|
/** List of Exclude rules, with any of which if a collection matches, it is excluded by the filter. */
|
|
@@ -397,13 +399,15 @@ interface ContactEmailInfoModel {
|
|
|
397
399
|
/** The name of the email info data */
|
|
398
400
|
Name?: string;
|
|
399
401
|
/** The verification status of the email */
|
|
400
|
-
VerificationStatus?:
|
|
402
|
+
VerificationStatus?: EmailVerificationStatus;
|
|
401
403
|
}
|
|
402
404
|
/** @deprecated Do not use */
|
|
403
405
|
interface Container_Dictionary_String_String {
|
|
404
406
|
/** Content of data */
|
|
405
407
|
Data?: Record<string, string | null>;
|
|
406
408
|
}
|
|
409
|
+
type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA" | "Unknown";
|
|
410
|
+
type CountryCode = "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW" | "Unknown";
|
|
407
411
|
interface CreateSharedGroupRequest extends IPlayFabRequestCommon {
|
|
408
412
|
/** Unique identifier for the shared group (a random identifier will be assigned, if one is not specified). */
|
|
409
413
|
SharedGroupId?: string;
|
|
@@ -412,6 +416,7 @@ interface CreateSharedGroupResult extends IPlayFabResultCommon {
|
|
|
412
416
|
/** Unique identifier for the shared group. */
|
|
413
417
|
SharedGroupId?: string;
|
|
414
418
|
}
|
|
419
|
+
type Currency = "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW" | "ZWD";
|
|
415
420
|
/** @deprecated Do not use */
|
|
416
421
|
interface CurrentGamesRequest extends IPlayFabRequestCommon {
|
|
417
422
|
/** Build to match against. */
|
|
@@ -419,7 +424,7 @@ interface CurrentGamesRequest extends IPlayFabRequestCommon {
|
|
|
419
424
|
/** Game mode to look for. */
|
|
420
425
|
GameMode?: string;
|
|
421
426
|
/** Region to check for Game Server Instances. */
|
|
422
|
-
Region?:
|
|
427
|
+
Region?: Region;
|
|
423
428
|
/** Statistic name to find statistic-based matches. */
|
|
424
429
|
StatisticName?: string;
|
|
425
430
|
/** Filter to include and/or exclude Game Server Instances associated with certain tags. */
|
|
@@ -470,6 +475,7 @@ interface DeviceInfoRequest extends IPlayFabRequestCommon {
|
|
|
470
475
|
/** Information posted to the PlayStream Event. Currently arbitrary, and specific to the environment sending it. */
|
|
471
476
|
Info?: Record<string, any>;
|
|
472
477
|
}
|
|
478
|
+
type EmailVerificationStatus = "Unverified" | "Pending" | "Confirmed";
|
|
473
479
|
interface EmptyResult extends IPlayFabResultCommon {
|
|
474
480
|
}
|
|
475
481
|
interface EntityKey {
|
|
@@ -508,7 +514,7 @@ interface ExecuteCloudScriptRequest extends IPlayFabRequestCommon {
|
|
|
508
514
|
* executes the current live, published revision, and 'Specific' executes the specified revision. The default value is
|
|
509
515
|
* 'Specific', if the SpeificRevision parameter is specified, otherwise it is 'Live'.
|
|
510
516
|
*/
|
|
511
|
-
RevisionSelection?:
|
|
517
|
+
RevisionSelection?: CloudScriptRevisionOption;
|
|
512
518
|
/** The specivic revision to execute, when RevisionSelection is set to 'Specific' */
|
|
513
519
|
SpecificRevision?: number;
|
|
514
520
|
}
|
|
@@ -548,6 +554,7 @@ interface ExecuteCloudScriptResult extends IPlayFabResultCommon {
|
|
|
548
554
|
/** The revision of the CloudScript that executed */
|
|
549
555
|
Revision: number;
|
|
550
556
|
}
|
|
557
|
+
type ExternalFriendSources = "None" | "Steam" | "Facebook" | "Xbox" | "Psn" | "All";
|
|
551
558
|
interface FacebookInstantGamesPlayFabIdPair {
|
|
552
559
|
/** Unique Facebook Instant Games identifier for a user. */
|
|
553
560
|
FacebookInstantGamesId?: string;
|
|
@@ -613,7 +620,7 @@ interface GameInfo {
|
|
|
613
620
|
*/
|
|
614
621
|
GameServerState?: number;
|
|
615
622
|
/** game specific string denoting server configuration */
|
|
616
|
-
GameServerStateEnum?:
|
|
623
|
+
GameServerStateEnum?: GameInstanceState;
|
|
617
624
|
/** last heartbeat of the game server instance, used in external game server provider mode */
|
|
618
625
|
LastHeartbeat?: string;
|
|
619
626
|
/** unique lobby identifier for this game server */
|
|
@@ -623,7 +630,7 @@ interface GameInfo {
|
|
|
623
630
|
/** array of current player IDs on this server */
|
|
624
631
|
PlayerUserIds?: string[];
|
|
625
632
|
/** region to which this server is associated */
|
|
626
|
-
Region?:
|
|
633
|
+
Region?: Region;
|
|
627
634
|
/** duration in seconds this server has been running */
|
|
628
635
|
RunTime: number;
|
|
629
636
|
/**
|
|
@@ -644,6 +651,7 @@ interface GameInfo {
|
|
|
644
651
|
/** game session tags */
|
|
645
652
|
Tags?: Record<string, string | null>;
|
|
646
653
|
}
|
|
654
|
+
type GameInstanceState = "Open" | "Closed";
|
|
647
655
|
/** @deprecated Do not use */
|
|
648
656
|
interface GameServerRegionsRequest extends IPlayFabRequestCommon {
|
|
649
657
|
/** version of game server for which stats are being requested */
|
|
@@ -814,7 +822,7 @@ interface GetFriendLeaderboardAroundCurrentUserRequest extends IPlayFabRequestCo
|
|
|
814
822
|
* Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
|
|
815
823
|
* comma-separated list of platforms.
|
|
816
824
|
*/
|
|
817
|
-
ExternalPlatformFriends?:
|
|
825
|
+
ExternalPlatformFriends?: ExternalFriendSources;
|
|
818
826
|
/**
|
|
819
827
|
* Indicates whether Facebook friends should be included in the response. Default is true.
|
|
820
828
|
* @deprecated Please use ExternalPlatformFriends instead.
|
|
@@ -848,7 +856,7 @@ interface GetFriendLeaderboardAroundPlayerRequest extends IPlayFabRequestCommon
|
|
|
848
856
|
* Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
|
|
849
857
|
* comma-separated list of platforms.
|
|
850
858
|
*/
|
|
851
|
-
ExternalPlatformFriends?:
|
|
859
|
+
ExternalPlatformFriends?: ExternalFriendSources;
|
|
852
860
|
/**
|
|
853
861
|
* Indicates whether Facebook friends should be included in the response. Default is true.
|
|
854
862
|
* @deprecated Please use ExternalPlatformFriends instead.
|
|
@@ -893,7 +901,7 @@ interface GetFriendLeaderboardRequest extends IPlayFabRequestCommon {
|
|
|
893
901
|
* Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
|
|
894
902
|
* comma-separated list of platforms.
|
|
895
903
|
*/
|
|
896
|
-
ExternalPlatformFriends?:
|
|
904
|
+
ExternalPlatformFriends?: ExternalFriendSources;
|
|
897
905
|
/**
|
|
898
906
|
* Indicates whether Facebook friends should be included in the response. Default is true.
|
|
899
907
|
* @deprecated Please use ExternalPlatformFriends instead.
|
|
@@ -930,7 +938,7 @@ interface GetFriendsListRequest extends IPlayFabRequestCommon {
|
|
|
930
938
|
* Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
|
|
931
939
|
* comma-separated list of platforms.
|
|
932
940
|
*/
|
|
933
|
-
ExternalPlatformFriends?:
|
|
941
|
+
ExternalPlatformFriends?: ExternalFriendSources;
|
|
934
942
|
/**
|
|
935
943
|
* Indicates whether Facebook friends should be included in the response. Default is true.
|
|
936
944
|
* @deprecated Please use ExternalPlatformFriends instead.
|
|
@@ -1235,7 +1243,7 @@ interface GetPlayerTagsResult extends IPlayFabResultCommon {
|
|
|
1235
1243
|
}
|
|
1236
1244
|
interface GetPlayerTradesRequest extends IPlayFabRequestCommon {
|
|
1237
1245
|
/** Returns only trades with the given status. If null, returns all trades. */
|
|
1238
|
-
StatusFilter?:
|
|
1246
|
+
StatusFilter?: TradeStatus;
|
|
1239
1247
|
}
|
|
1240
1248
|
interface GetPlayerTradesResponse extends IPlayFabResultCommon {
|
|
1241
1249
|
/** History of trades which this player has accepted. */
|
|
@@ -1496,7 +1504,7 @@ interface GetStoreItemsResult extends IPlayFabResultCommon {
|
|
|
1496
1504
|
/** Additional data about the store. */
|
|
1497
1505
|
MarketingData?: StoreMarketingModel;
|
|
1498
1506
|
/** How the store was last updated (Admin or a third party). */
|
|
1499
|
-
Source?:
|
|
1507
|
+
Source?: SourceType;
|
|
1500
1508
|
/** Array of items which can be purchased from this store. */
|
|
1501
1509
|
Store?: StoreItem[];
|
|
1502
1510
|
/** The ID of this store. */
|
|
@@ -1794,7 +1802,7 @@ interface LinkedPlatformAccountModel {
|
|
|
1794
1802
|
/** Linked account email of the user on the platform, if available */
|
|
1795
1803
|
Email?: string;
|
|
1796
1804
|
/** Authentication platform */
|
|
1797
|
-
Platform?:
|
|
1805
|
+
Platform?: LoginIdentityProvider;
|
|
1798
1806
|
/** Unique account identifier of the user on the platform */
|
|
1799
1807
|
PlatformUserId?: string;
|
|
1800
1808
|
/** Linked account username of the user on the platform, if available */
|
|
@@ -2018,9 +2026,9 @@ interface LocationModel {
|
|
|
2018
2026
|
/** City name. */
|
|
2019
2027
|
City?: string;
|
|
2020
2028
|
/** The two-character continent code for this location */
|
|
2021
|
-
ContinentCode?:
|
|
2029
|
+
ContinentCode?: ContinentCode;
|
|
2022
2030
|
/** The two-character ISO 3166-1 country code for the country associated with the location */
|
|
2023
|
-
CountryCode?:
|
|
2031
|
+
CountryCode?: CountryCode;
|
|
2024
2032
|
/** Latitude coordinate of the geographic location. */
|
|
2025
2033
|
Latitude?: number;
|
|
2026
2034
|
/** Longitude coordinate of the geographic location. */
|
|
@@ -2050,6 +2058,7 @@ interface LogEventRequest extends IPlayFabRequestCommon {
|
|
|
2050
2058
|
/** @deprecated Do not use */
|
|
2051
2059
|
interface LogEventResult extends IPlayFabResultCommon {
|
|
2052
2060
|
}
|
|
2061
|
+
type LoginIdentityProvider = "Unknown" | "PlayFab" | "Custom" | "GameCenter" | "GooglePlay" | "Steam" | "XBoxLive" | "PSN" | "Kongregate" | "Facebook" | "IOSDevice" | "AndroidDevice" | "Twitch" | "WindowsHello" | "GameServer" | "CustomServer" | "NintendoSwitch" | "FacebookInstantGames" | "OpenIdConnect" | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" | "XboxMobileStore" | "King" | "BattleNet";
|
|
2053
2062
|
interface LoginResult extends IPlayFabResultCommon {
|
|
2054
2063
|
/**
|
|
2055
2064
|
* If LoginTitlePlayerAccountEntity flag is set on the login request the title_player_account will also be logged in and
|
|
@@ -2630,7 +2639,7 @@ interface MatchmakeRequest extends IPlayFabRequestCommon {
|
|
|
2630
2639
|
/** Lobby identifier to match make against. This is used to select a specific Game Server Instance. */
|
|
2631
2640
|
LobbyId?: string;
|
|
2632
2641
|
/** Region to match make against. [Note: Required if LobbyId is not specified] */
|
|
2633
|
-
Region?:
|
|
2642
|
+
Region?: Region;
|
|
2634
2643
|
/** Start a game session if one with an open slot is not found. Defaults to true. */
|
|
2635
2644
|
StartNewIfNoneFound?: boolean;
|
|
2636
2645
|
/** Player statistic to use in finding a match. May be null for no stat-based matching. */
|
|
@@ -2660,10 +2669,11 @@ interface MatchmakeResult extends IPlayFabResultCommon {
|
|
|
2660
2669
|
/** Public DNS name (if any) of the server */
|
|
2661
2670
|
ServerPublicDNSName?: string;
|
|
2662
2671
|
/** result of match making process */
|
|
2663
|
-
Status?:
|
|
2672
|
+
Status?: MatchmakeStatus;
|
|
2664
2673
|
/** server authorization ticket (used by RedeemMatchmakerTicket to validate user insertion into the game) */
|
|
2665
2674
|
Ticket?: string;
|
|
2666
2675
|
}
|
|
2676
|
+
type MatchmakeStatus = "Complete" | "Waiting" | "GameNotFound" | "NoAvailableSlots" | "SessionClosed";
|
|
2667
2677
|
interface MembershipModel {
|
|
2668
2678
|
/** Whether this membership is active. That is, whether the MembershipExpiration time has been reached. */
|
|
2669
2679
|
IsActive: boolean;
|
|
@@ -2769,7 +2779,7 @@ interface PayForPurchaseResult extends IPlayFabResultCommon {
|
|
|
2769
2779
|
/** Cost of the transaction. */
|
|
2770
2780
|
PurchasePrice: number;
|
|
2771
2781
|
/** Status of the transaction. */
|
|
2772
|
-
Status?:
|
|
2782
|
+
Status?: TransactionStatus;
|
|
2773
2783
|
/** Virtual currencies granted by the transaction, if any. */
|
|
2774
2784
|
VCAmount?: Record<string, number>;
|
|
2775
2785
|
/** Current virtual currency balances for the user. */
|
|
@@ -2825,7 +2835,7 @@ interface PlayerProfileModel {
|
|
|
2825
2835
|
/** List of memberships for the player, along with whether are expired. */
|
|
2826
2836
|
Memberships?: MembershipModel[];
|
|
2827
2837
|
/** Player account origination */
|
|
2828
|
-
Origination?:
|
|
2838
|
+
Origination?: LoginIdentityProvider;
|
|
2829
2839
|
/** PlayFab player account unique identifier */
|
|
2830
2840
|
PlayerId?: string;
|
|
2831
2841
|
/** Publisher this player belongs to */
|
|
@@ -2955,11 +2965,12 @@ interface PurchaseReceiptFulfillment {
|
|
|
2955
2965
|
/** Amount of the stated currency paid for the items, in centesimal units */
|
|
2956
2966
|
RecordedTransactionTotal?: number;
|
|
2957
2967
|
}
|
|
2968
|
+
type PushNotificationPlatform = "ApplePushNotificationService" | "GoogleCloudMessaging";
|
|
2958
2969
|
interface PushNotificationRegistrationModel {
|
|
2959
2970
|
/** Notification configured endpoint */
|
|
2960
2971
|
NotificationEndpointARN?: string;
|
|
2961
2972
|
/** Push notification platform */
|
|
2962
|
-
Platform?:
|
|
2973
|
+
Platform?: PushNotificationPlatform;
|
|
2963
2974
|
}
|
|
2964
2975
|
interface RedeemCouponRequest extends IPlayFabRequestCommon {
|
|
2965
2976
|
/** Catalog version of the coupon. If null, uses the default catalog */
|
|
@@ -2983,6 +2994,7 @@ interface RefreshPSNAuthTokenRequest extends IPlayFabRequestCommon {
|
|
|
2983
2994
|
/** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */
|
|
2984
2995
|
RedirectUri: string;
|
|
2985
2996
|
}
|
|
2997
|
+
type Region = "USCentral" | "USEast" | "EUWest" | "Singapore" | "Japan" | "Brazil" | "Australia";
|
|
2986
2998
|
/** @deprecated Do not use */
|
|
2987
2999
|
interface RegionInfo {
|
|
2988
3000
|
/** indicates whether the server specified is available in this region */
|
|
@@ -2992,7 +3004,7 @@ interface RegionInfo {
|
|
|
2992
3004
|
/** url to ping to get roundtrip time */
|
|
2993
3005
|
PingUrl?: string;
|
|
2994
3006
|
/** unique identifier for the region */
|
|
2995
|
-
Region?:
|
|
3007
|
+
Region?: Region;
|
|
2996
3008
|
}
|
|
2997
3009
|
interface RegisterForIOSPushNotificationRequest extends IPlayFabRequestCommon {
|
|
2998
3010
|
/** Message to display when confirming push notification. */
|
|
@@ -3087,7 +3099,7 @@ interface RemoveSharedGroupMembersResult extends IPlayFabResultCommon {
|
|
|
3087
3099
|
}
|
|
3088
3100
|
interface ReportAdActivityRequest extends IPlayFabRequestCommon {
|
|
3089
3101
|
/** Type of activity, may be Opened, Closed, Start or End */
|
|
3090
|
-
Activity:
|
|
3102
|
+
Activity: AdActivity;
|
|
3091
3103
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
3092
3104
|
CustomTags?: Record<string, string | null>;
|
|
3093
3105
|
/** Unique ID of the placement to report for */
|
|
@@ -3229,10 +3241,11 @@ interface SharedGroupDataRecord {
|
|
|
3229
3241
|
/** Unique PlayFab identifier of the user to last update this value. */
|
|
3230
3242
|
LastUpdatedBy?: string;
|
|
3231
3243
|
/** Indicates whether this data can be read by all users (public) or only members of the group (private). */
|
|
3232
|
-
Permission?:
|
|
3244
|
+
Permission?: UserDataPermission;
|
|
3233
3245
|
/** Data stored for the specified group data key. */
|
|
3234
3246
|
Value?: string;
|
|
3235
3247
|
}
|
|
3248
|
+
type SourceType = "Admin" | "BackEnd" | "GameClient" | "GameServer" | "Partner" | "Custom" | "API";
|
|
3236
3249
|
/** @deprecated Do not use */
|
|
3237
3250
|
interface StartGameRequest extends IPlayFabRequestCommon {
|
|
3238
3251
|
/** version information for the build of the game server which is to be started */
|
|
@@ -3246,7 +3259,7 @@ interface StartGameRequest extends IPlayFabRequestCommon {
|
|
|
3246
3259
|
/** the title-defined game mode this server is to be running (defaults to 0 if there is only one mode) */
|
|
3247
3260
|
GameMode: string;
|
|
3248
3261
|
/** the region to associate this server with for match filtering */
|
|
3249
|
-
Region:
|
|
3262
|
+
Region: Region;
|
|
3250
3263
|
/** player statistic for others to use in finding this game. May be null for no stat-based matching */
|
|
3251
3264
|
StatisticName?: string;
|
|
3252
3265
|
}
|
|
@@ -3375,7 +3388,7 @@ interface SubscriptionModel {
|
|
|
3375
3388
|
/** Whether this subscription is currently active. That is, if Expiration > now. */
|
|
3376
3389
|
IsActive: boolean;
|
|
3377
3390
|
/** The status of this subscription, according to the subscription provider. */
|
|
3378
|
-
Status?:
|
|
3391
|
+
Status?: SubscriptionProviderStatus;
|
|
3379
3392
|
/** The id for this subscription */
|
|
3380
3393
|
SubscriptionId?: string;
|
|
3381
3394
|
/** The item id for this subscription from the primary catalog */
|
|
@@ -3383,6 +3396,7 @@ interface SubscriptionModel {
|
|
|
3383
3396
|
/** The provider for this subscription. Apple or Google Play are supported today. */
|
|
3384
3397
|
SubscriptionProvider?: string;
|
|
3385
3398
|
}
|
|
3399
|
+
type SubscriptionProviderStatus = "NoError" | "Cancelled" | "UnknownError" | "BillingError" | "ProductUnavailable" | "CustomerDidNotAcceptPriceChange" | "FreeTrial" | "PaymentPending";
|
|
3386
3400
|
interface SubtractUserVirtualCurrencyRequest extends IPlayFabRequestCommon {
|
|
3387
3401
|
/** Amount to be subtracted from the user balance of the specified virtual currency. */
|
|
3388
3402
|
Amount: number;
|
|
@@ -3395,6 +3409,7 @@ interface TagModel {
|
|
|
3395
3409
|
/** Full value of the tag, including namespace */
|
|
3396
3410
|
TagValue?: string;
|
|
3397
3411
|
}
|
|
3412
|
+
type TitleActivationStatus = "None" | "ActivatedTitleKey" | "PendingSteam" | "ActivatedSteam" | "RevokedSteam";
|
|
3398
3413
|
interface TitleNewsItem {
|
|
3399
3414
|
/** News item text. */
|
|
3400
3415
|
Body?: string;
|
|
@@ -3429,10 +3444,12 @@ interface TradeInfo {
|
|
|
3429
3444
|
/** The catalogItem Ids requested in exchange. */
|
|
3430
3445
|
RequestedCatalogItemIds?: string[];
|
|
3431
3446
|
/** Describes the current state of this trade. */
|
|
3432
|
-
Status?:
|
|
3447
|
+
Status?: TradeStatus;
|
|
3433
3448
|
/** The identifier for this trade. */
|
|
3434
3449
|
TradeId?: string;
|
|
3435
3450
|
}
|
|
3451
|
+
type TradeStatus = "Invalid" | "Opening" | "Open" | "Accepting" | "Accepted" | "Filled" | "Cancelled";
|
|
3452
|
+
type TransactionStatus = "CreateCart" | "Init" | "Approved" | "Succeeded" | "FailedByProvider" | "DisputePending" | "RefundPending" | "Refunded" | "RefundFailed" | "ChargedBack" | "FailedByUber" | "FailedByPlayFab" | "Revoked" | "TradePending" | "Traded" | "Upgraded" | "StackPending" | "Stacked" | "Other" | "Failed";
|
|
3436
3453
|
interface TreatmentAssignment {
|
|
3437
3454
|
/** List of the experiment variables. */
|
|
3438
3455
|
Variables?: Variable[];
|
|
@@ -3637,7 +3654,7 @@ interface UpdateCharacterDataRequest extends IPlayFabRequestCommon {
|
|
|
3637
3654
|
*/
|
|
3638
3655
|
KeysToRemove?: string[];
|
|
3639
3656
|
/** Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. */
|
|
3640
|
-
Permission?:
|
|
3657
|
+
Permission?: UserDataPermission;
|
|
3641
3658
|
}
|
|
3642
3659
|
interface UpdateCharacterDataResult extends IPlayFabResultCommon {
|
|
3643
3660
|
/**
|
|
@@ -3702,7 +3719,7 @@ interface UpdateSharedGroupDataRequest extends IPlayFabRequestCommon {
|
|
|
3702
3719
|
*/
|
|
3703
3720
|
KeysToRemove?: string[];
|
|
3704
3721
|
/** Permission to be applied to all user data keys in this request. */
|
|
3705
|
-
Permission?:
|
|
3722
|
+
Permission?: UserDataPermission;
|
|
3706
3723
|
/** Unique identifier for the shared group. */
|
|
3707
3724
|
SharedGroupId: string;
|
|
3708
3725
|
}
|
|
@@ -3725,7 +3742,7 @@ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
|
|
|
3725
3742
|
* Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. This is used
|
|
3726
3743
|
* for requests by one player for information about another player; those requests will only return Public keys.
|
|
3727
3744
|
*/
|
|
3728
|
-
Permission?:
|
|
3745
|
+
Permission?: UserDataPermission;
|
|
3729
3746
|
}
|
|
3730
3747
|
interface UpdateUserDataResult extends IPlayFabResultCommon {
|
|
3731
3748
|
/**
|
|
@@ -3825,6 +3842,7 @@ interface UserCustomIdInfo {
|
|
|
3825
3842
|
/** Custom ID */
|
|
3826
3843
|
CustomId?: string;
|
|
3827
3844
|
}
|
|
3845
|
+
type UserDataPermission = "Private" | "Public";
|
|
3828
3846
|
interface UserDataRecord {
|
|
3829
3847
|
/** Timestamp for when this data was last updated. */
|
|
3830
3848
|
LastUpdated: string;
|
|
@@ -3832,7 +3850,7 @@ interface UserDataRecord {
|
|
|
3832
3850
|
* Indicates whether this data can be read by all users (public) or only the user (private). This is used for GetUserData
|
|
3833
3851
|
* requests being made by one player about another player.
|
|
3834
3852
|
*/
|
|
3835
|
-
Permission?:
|
|
3853
|
+
Permission?: UserDataPermission;
|
|
3836
3854
|
/** Data stored for the specified user data key. */
|
|
3837
3855
|
Value?: string;
|
|
3838
3856
|
}
|
|
@@ -3896,6 +3914,7 @@ interface UserOpenIdInfo {
|
|
|
3896
3914
|
/** OpenID Subject */
|
|
3897
3915
|
Subject?: string;
|
|
3898
3916
|
}
|
|
3917
|
+
type UserOrigination = "Organic" | "Steam" | "Google" | "Amazon" | "Facebook" | "Kongregate" | "GamersFirst" | "Unknown" | "IOS" | "LoadTest" | "Android" | "PSN" | "GameCenter" | "CustomId" | "XboxLive" | "Parse" | "Twitch" | "ServerCustomId" | "NintendoSwitchDeviceId" | "FacebookInstantGamesId" | "OpenIdConnect" | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" | "XboxMobileStore" | "King" | "BattleNet";
|
|
3899
3918
|
interface UserPrivateAccountInfo {
|
|
3900
3919
|
/** user email address */
|
|
3901
3920
|
Email?: string;
|
|
@@ -3920,11 +3939,11 @@ interface UserSettings {
|
|
|
3920
3939
|
}
|
|
3921
3940
|
interface UserSteamInfo {
|
|
3922
3941
|
/** what stage of game ownership the user is listed as being in, from Steam */
|
|
3923
|
-
SteamActivationStatus?:
|
|
3942
|
+
SteamActivationStatus?: TitleActivationStatus;
|
|
3924
3943
|
/** the country in which the player resides, from Steam data */
|
|
3925
3944
|
SteamCountry?: string;
|
|
3926
3945
|
/** currency type set in the user Steam account */
|
|
3927
|
-
SteamCurrency?:
|
|
3946
|
+
SteamCurrency?: Currency;
|
|
3928
3947
|
/** Steam identifier */
|
|
3929
3948
|
SteamId?: string;
|
|
3930
3949
|
/** Steam display name */
|
|
@@ -3950,7 +3969,7 @@ interface UserTitleInfo {
|
|
|
3950
3969
|
/** timestamp for the last user login for this title */
|
|
3951
3970
|
LastLogin?: string;
|
|
3952
3971
|
/** source by which the user first joined the game, if known */
|
|
3953
|
-
Origination?:
|
|
3972
|
+
Origination?: UserOrigination;
|
|
3954
3973
|
/** Title player account entity for this user */
|
|
3955
3974
|
TitlePlayerAccount?: EntityKey;
|
|
3956
3975
|
}
|
package/dist/Client.js
CHANGED
package/dist/CloudScript.d.ts
CHANGED
|
@@ -8,14 +8,18 @@ interface AdCampaignAttributionModel {
|
|
|
8
8
|
/** Attribution network name */
|
|
9
9
|
Platform?: string;
|
|
10
10
|
}
|
|
11
|
+
type CloudScriptRevisionOption = "Live" | "Latest" | "Specific";
|
|
11
12
|
interface ContactEmailInfoModel {
|
|
12
13
|
/** The email address */
|
|
13
14
|
EmailAddress?: string;
|
|
14
15
|
/** The name of the email info data */
|
|
15
16
|
Name?: string;
|
|
16
17
|
/** The verification status of the email */
|
|
17
|
-
VerificationStatus?:
|
|
18
|
+
VerificationStatus?: EmailVerificationStatus;
|
|
18
19
|
}
|
|
20
|
+
type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA" | "Unknown";
|
|
21
|
+
type CountryCode = "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW" | "Unknown";
|
|
22
|
+
type EmailVerificationStatus = "Unverified" | "Pending" | "Confirmed";
|
|
19
23
|
interface EmptyResult extends IPlayFabResultCommon {
|
|
20
24
|
}
|
|
21
25
|
interface EntityKey {
|
|
@@ -92,7 +96,7 @@ interface ExecuteEntityCloudScriptRequest extends IPlayFabRequestCommon {
|
|
|
92
96
|
* executes the current live, published revision, and 'Specific' executes the specified revision. The default value is
|
|
93
97
|
* 'Specific', if the SpecificRevision parameter is specified, otherwise it is 'Live'.
|
|
94
98
|
*/
|
|
95
|
-
RevisionSelection?:
|
|
99
|
+
RevisionSelection?: CloudScriptRevisionOption;
|
|
96
100
|
/** The specific revision to execute, when RevisionSelection is set to 'Specific' */
|
|
97
101
|
SpecificRevision?: number;
|
|
98
102
|
}
|
|
@@ -168,7 +172,7 @@ interface LinkedPlatformAccountModel {
|
|
|
168
172
|
/** Linked account email of the user on the platform, if available */
|
|
169
173
|
Email?: string;
|
|
170
174
|
/** Authentication platform */
|
|
171
|
-
Platform?:
|
|
175
|
+
Platform?: LoginIdentityProvider;
|
|
172
176
|
/** Unique account identifier of the user on the platform */
|
|
173
177
|
PlatformUserId?: string;
|
|
174
178
|
/** Linked account username of the user on the platform, if available */
|
|
@@ -198,14 +202,15 @@ interface LocationModel {
|
|
|
198
202
|
/** City name. */
|
|
199
203
|
City?: string;
|
|
200
204
|
/** The two-character continent code for this location */
|
|
201
|
-
ContinentCode?:
|
|
205
|
+
ContinentCode?: ContinentCode;
|
|
202
206
|
/** The two-character ISO 3166-1 country code for the country associated with the location */
|
|
203
|
-
CountryCode?:
|
|
207
|
+
CountryCode?: CountryCode;
|
|
204
208
|
/** Latitude coordinate of the geographic location. */
|
|
205
209
|
Latitude?: number;
|
|
206
210
|
/** Longitude coordinate of the geographic location. */
|
|
207
211
|
Longitude?: number;
|
|
208
212
|
}
|
|
213
|
+
type LoginIdentityProvider = "Unknown" | "PlayFab" | "Custom" | "GameCenter" | "GooglePlay" | "Steam" | "XBoxLive" | "PSN" | "Kongregate" | "Facebook" | "IOSDevice" | "AndroidDevice" | "Twitch" | "WindowsHello" | "GameServer" | "CustomServer" | "NintendoSwitch" | "FacebookInstantGames" | "OpenIdConnect" | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" | "XboxMobileStore" | "King" | "BattleNet";
|
|
209
214
|
interface LogStatement {
|
|
210
215
|
/** Optional object accompanying the message as contextual information */
|
|
211
216
|
Data?: any;
|
|
@@ -264,7 +269,7 @@ interface PlayerProfileModel {
|
|
|
264
269
|
/** List of memberships for the player, along with whether are expired. */
|
|
265
270
|
Memberships?: MembershipModel[];
|
|
266
271
|
/** Player account origination */
|
|
267
|
-
Origination?:
|
|
272
|
+
Origination?: LoginIdentityProvider;
|
|
268
273
|
/** PlayFab player account unique identifier */
|
|
269
274
|
PlayerId?: string;
|
|
270
275
|
/** Publisher this player belongs to */
|
|
@@ -343,11 +348,12 @@ interface PostFunctionResultForScheduledTaskRequest extends IPlayFabRequestCommo
|
|
|
343
348
|
/** The id of the scheduled task that invoked the function. */
|
|
344
349
|
ScheduledTaskId: NameIdentifier;
|
|
345
350
|
}
|
|
351
|
+
type PushNotificationPlatform = "ApplePushNotificationService" | "GoogleCloudMessaging";
|
|
346
352
|
interface PushNotificationRegistrationModel {
|
|
347
353
|
/** Notification configured endpoint */
|
|
348
354
|
NotificationEndpointARN?: string;
|
|
349
355
|
/** Push notification platform */
|
|
350
|
-
Platform?:
|
|
356
|
+
Platform?: PushNotificationPlatform;
|
|
351
357
|
}
|
|
352
358
|
interface QueuedFunctionModel {
|
|
353
359
|
/** The connection string for the Azure Storage Account that hosts the queue. */
|
|
@@ -412,7 +418,7 @@ interface SubscriptionModel {
|
|
|
412
418
|
/** Whether this subscription is currently active. That is, if Expiration > now. */
|
|
413
419
|
IsActive: boolean;
|
|
414
420
|
/** The status of this subscription, according to the subscription provider. */
|
|
415
|
-
Status?:
|
|
421
|
+
Status?: SubscriptionProviderStatus;
|
|
416
422
|
/** The id for this subscription */
|
|
417
423
|
SubscriptionId?: string;
|
|
418
424
|
/** The item id for this subscription from the primary catalog */
|
|
@@ -420,6 +426,7 @@ interface SubscriptionModel {
|
|
|
420
426
|
/** The provider for this subscription. Apple or Google Play are supported today. */
|
|
421
427
|
SubscriptionProvider?: string;
|
|
422
428
|
}
|
|
429
|
+
type SubscriptionProviderStatus = "NoError" | "Cancelled" | "UnknownError" | "BillingError" | "ProductUnavailable" | "CustomerDidNotAcceptPriceChange" | "FreeTrial" | "PaymentPending";
|
|
423
430
|
interface TagModel {
|
|
424
431
|
/** Full value of the tag, including namespace */
|
|
425
432
|
TagValue?: string;
|
package/dist/CloudScript.js
CHANGED
package/dist/Data.d.ts
CHANGED
|
@@ -147,6 +147,7 @@ interface ObjectResult {
|
|
|
147
147
|
/** Name of the object. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' */
|
|
148
148
|
ObjectName?: string;
|
|
149
149
|
}
|
|
150
|
+
type OperationTypes = "Created" | "Updated" | "Deleted" | "None";
|
|
150
151
|
interface SetObject {
|
|
151
152
|
/**
|
|
152
153
|
* Body of the object to be saved. If empty and DeleteObject is true object will be deleted if it exists, or no operation
|
|
@@ -169,7 +170,7 @@ interface SetObjectInfo {
|
|
|
169
170
|
/** Optional reason to explain why the operation was the result that it was. */
|
|
170
171
|
OperationReason?: string;
|
|
171
172
|
/** Indicates which operation was completed, either Created, Updated, Deleted or None. */
|
|
172
|
-
SetResult?:
|
|
173
|
+
SetResult?: OperationTypes;
|
|
173
174
|
}
|
|
174
175
|
interface SetObjectsRequest extends IPlayFabRequestCommon {
|
|
175
176
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|