@community-fabs/playfab-web-sdk 1.197.250801 → 1.198.250815
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.d.ts +18 -0
- package/dist/Addon.js +2 -2
- package/dist/Admin.d.ts +58 -7
- package/dist/Admin.js +2 -2
- package/dist/Authentication.js +2 -2
- package/dist/Client.js +2 -2
- package/dist/CloudScript.js +2 -2
- package/dist/Data.js +2 -2
- package/dist/Economy.d.ts +10 -6
- package/dist/Economy.js +2 -2
- package/dist/Events.js +2 -2
- package/dist/Experimentation.js +2 -2
- package/dist/Groups.js +2 -2
- package/dist/Insights.js +2 -2
- package/dist/Localization.js +2 -2
- package/dist/Matchmaker.js +2 -2
- package/dist/Multiplayer.d.ts +4 -4
- package/dist/Multiplayer.js +2 -2
- package/dist/Profiles.js +2 -2
- package/dist/Progression.d.ts +41 -0
- package/dist/Progression.js +2 -2
- package/dist/Server.d.ts +10 -6
- package/dist/Server.js +2 -2
- package/dist/{chunk-HCKS7F77.js → chunk-4HGNSVTS.js} +2 -2
- package/dist/{chunk-3MFAHZTQ.js → chunk-6MDX6D7D.js} +22 -9
- package/dist/chunk-6MDX6D7D.js.map +1 -0
- package/dist/{chunk-VAYRJ7OJ.js → chunk-77Y3NHC6.js} +2 -2
- package/dist/{chunk-TXZQRPI7.js → chunk-HM7AU6FM.js} +2 -2
- package/dist/{chunk-GZIXWXGQ.js → chunk-IAZGH7JX.js} +3 -3
- package/dist/{chunk-GZIXWXGQ.js.map → chunk-IAZGH7JX.js.map} +1 -1
- package/dist/{chunk-3GX5SJS4.js → chunk-KAABU64P.js} +8 -2
- package/dist/chunk-KAABU64P.js.map +1 -0
- package/dist/{chunk-ORZ4O5SW.js → chunk-KHOZPK5D.js} +2 -2
- package/dist/{chunk-GQ3M36YS.js → chunk-KSDYONJB.js} +2 -2
- package/dist/{chunk-3CP3J4TI.js → chunk-LW3SN4ZL.js} +2 -2
- package/dist/{chunk-277C7C7D.js → chunk-MNDPXQR2.js} +2 -2
- package/dist/{chunk-CVFKWZOR.js → chunk-MUKO37TV.js} +2 -2
- package/dist/{chunk-4ADEPX2D.js → chunk-OC2TN3PB.js} +2 -2
- package/dist/{chunk-EVQUDVAZ.js → chunk-OVQM2GRZ.js} +6 -6
- package/dist/{chunk-EVQUDVAZ.js.map → chunk-OVQM2GRZ.js.map} +1 -1
- package/dist/{chunk-3AF4MCTX.js → chunk-PI6BLO4J.js} +2 -2
- package/dist/{chunk-2CU26HDG.js → chunk-QQ3D5JIO.js} +2 -2
- package/dist/{chunk-NZ64VN7C.js → chunk-TL2RWNAZ.js} +2 -2
- package/dist/{chunk-NB24SSF5.js → chunk-W5HAUQKD.js} +2 -2
- package/dist/{chunk-3XNOVXHN.js → chunk-ZMFL37MO.js} +3 -8
- package/dist/chunk-ZMFL37MO.js.map +1 -0
- package/dist/index.js +18 -18
- package/package.json +1 -1
- package/dist/chunk-3GX5SJS4.js.map +0 -1
- package/dist/chunk-3MFAHZTQ.js.map +0 -1
- package/dist/chunk-3XNOVXHN.js.map +0 -1
- /package/dist/{chunk-HCKS7F77.js.map → chunk-4HGNSVTS.js.map} +0 -0
- /package/dist/{chunk-VAYRJ7OJ.js.map → chunk-77Y3NHC6.js.map} +0 -0
- /package/dist/{chunk-TXZQRPI7.js.map → chunk-HM7AU6FM.js.map} +0 -0
- /package/dist/{chunk-ORZ4O5SW.js.map → chunk-KHOZPK5D.js.map} +0 -0
- /package/dist/{chunk-GQ3M36YS.js.map → chunk-KSDYONJB.js.map} +0 -0
- /package/dist/{chunk-3CP3J4TI.js.map → chunk-LW3SN4ZL.js.map} +0 -0
- /package/dist/{chunk-277C7C7D.js.map → chunk-MNDPXQR2.js.map} +0 -0
- /package/dist/{chunk-CVFKWZOR.js.map → chunk-MUKO37TV.js.map} +0 -0
- /package/dist/{chunk-4ADEPX2D.js.map → chunk-OC2TN3PB.js.map} +0 -0
- /package/dist/{chunk-3AF4MCTX.js.map → chunk-PI6BLO4J.js.map} +0 -0
- /package/dist/{chunk-2CU26HDG.js.map → chunk-QQ3D5JIO.js.map} +0 -0
- /package/dist/{chunk-NZ64VN7C.js.map → chunk-TL2RWNAZ.js.map} +0 -0
- /package/dist/{chunk-NB24SSF5.js.map → chunk-W5HAUQKD.js.map} +0 -0
package/dist/Addon.d.ts
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
|
|
2
2
|
|
|
3
3
|
interface CreateOrUpdateAppleRequest extends IPlayFabRequestCommon {
|
|
4
|
+
/** Allow validation of receipts from the Apple production environment. Required for app releases. */
|
|
5
|
+
AllowProduction?: boolean;
|
|
6
|
+
/** Allow validation of receipts from the Apple sandbox environment. Typically used while testing. */
|
|
7
|
+
AllowSandbox?: boolean;
|
|
4
8
|
/** iOS App Bundle ID obtained after setting up your app in the App Store. */
|
|
5
9
|
AppBundleId: string;
|
|
10
|
+
/** AppId obtained after setting up your app in the App Store. */
|
|
11
|
+
AppId?: string;
|
|
6
12
|
/** iOS App Shared Secret obtained after setting up your app in the App Store. */
|
|
7
13
|
AppSharedSecret?: string;
|
|
8
14
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
@@ -16,6 +22,12 @@ interface CreateOrUpdateAppleRequest extends IPlayFabRequestCommon {
|
|
|
16
22
|
* case where Apple rotates their signing keys.
|
|
17
23
|
*/
|
|
18
24
|
IgnoreExpirationDate?: boolean;
|
|
25
|
+
/** IssuerId obtained after setting up your app in the App Store. */
|
|
26
|
+
IssuerId?: string;
|
|
27
|
+
/** KeyId obtained after setting up your app in the App Store. */
|
|
28
|
+
KeyId?: string;
|
|
29
|
+
/** PrivateKey obtained after setting up your app in the App Store. */
|
|
30
|
+
PrivateKey?: string;
|
|
19
31
|
/** Require secure authentication only for this app. */
|
|
20
32
|
RequireSecureAuthentication?: boolean;
|
|
21
33
|
}
|
|
@@ -449,6 +461,12 @@ declare class PlayFabAddonApi extends PlayFabCommon {
|
|
|
449
461
|
* await addonClient.CreateOrUpdateApple({
|
|
450
462
|
* "AppBundleId": "123456",
|
|
451
463
|
* "AppSharedSecret": "654321",
|
|
464
|
+
* "AppId": "78901",
|
|
465
|
+
* "IssuerId": "345678",
|
|
466
|
+
* "KeyId": "901234",
|
|
467
|
+
* "PrivateKey": "567890",
|
|
468
|
+
* "AllowSandbox": true,
|
|
469
|
+
* "AllowProduction": true,
|
|
452
470
|
* "RequireSecureAuthentication": true
|
|
453
471
|
* });
|
|
454
472
|
*/
|
package/dist/Addon.js
CHANGED
package/dist/Admin.d.ts
CHANGED
|
@@ -64,6 +64,7 @@ interface ActionsOnPlayersInSegmentTaskSummary {
|
|
|
64
64
|
/** Total number of players that have had the actions applied to. */
|
|
65
65
|
TotalPlayersProcessed?: number;
|
|
66
66
|
}
|
|
67
|
+
/** @deprecated Do not use */
|
|
67
68
|
interface AdCampaignAttribution {
|
|
68
69
|
/** UTC time stamp of attribution */
|
|
69
70
|
AttributedAt: string;
|
|
@@ -504,6 +505,7 @@ interface CloudScriptVersionStatus {
|
|
|
504
505
|
Version: number;
|
|
505
506
|
}
|
|
506
507
|
type Conditionals = "Any" | "True" | "False";
|
|
508
|
+
/** @deprecated Do not use */
|
|
507
509
|
interface ContactEmailInfo {
|
|
508
510
|
/** The email address */
|
|
509
511
|
EmailAddress?: string;
|
|
@@ -837,6 +839,28 @@ interface DeleteUsersRequest extends IPlayFabRequestCommon {
|
|
|
837
839
|
/** @deprecated Do not use */
|
|
838
840
|
interface DeleteUsersResult extends IPlayFabResultCommon {
|
|
839
841
|
}
|
|
842
|
+
interface DimensionFilters {
|
|
843
|
+
/** Store metric age group */
|
|
844
|
+
AgeGroup?: string;
|
|
845
|
+
/** Store campaign. */
|
|
846
|
+
Campaign?: string;
|
|
847
|
+
/** Store user country. */
|
|
848
|
+
Country?: string;
|
|
849
|
+
/** Purchase currency. */
|
|
850
|
+
Currency?: string;
|
|
851
|
+
/** User device type. */
|
|
852
|
+
DeviceType?: string;
|
|
853
|
+
/** Is the product in sale? */
|
|
854
|
+
HasInSale?: string;
|
|
855
|
+
/** Product id. */
|
|
856
|
+
ProductId?: string;
|
|
857
|
+
/** Source page of the user presence. */
|
|
858
|
+
Source?: string;
|
|
859
|
+
/** Xbox store front. */
|
|
860
|
+
StoreFront?: string;
|
|
861
|
+
/** Xbox title id. */
|
|
862
|
+
XboxTitleId?: string;
|
|
863
|
+
}
|
|
840
864
|
type EffectType = "Allow" | "Deny";
|
|
841
865
|
interface EmailNotificationSegmentAction {
|
|
842
866
|
/** Email template id. */
|
|
@@ -1262,6 +1286,7 @@ interface GetPlayersInSegmentExportResponse extends IPlayFabResultCommon {
|
|
|
1262
1286
|
/** Shows the current status of the export */
|
|
1263
1287
|
State?: string;
|
|
1264
1288
|
}
|
|
1289
|
+
/** @deprecated Do not use */
|
|
1265
1290
|
interface GetPlayersInSegmentRequest extends IPlayFabRequestCommon {
|
|
1266
1291
|
/** Continuation token if retrieving subsequent pages of results. */
|
|
1267
1292
|
ContinuationToken?: string;
|
|
@@ -1286,6 +1311,7 @@ interface GetPlayersInSegmentRequest extends IPlayFabRequestCommon {
|
|
|
1286
1311
|
/** Unique identifier for this segment. */
|
|
1287
1312
|
SegmentId: string;
|
|
1288
1313
|
}
|
|
1314
|
+
/** @deprecated Do not use */
|
|
1289
1315
|
interface GetPlayersInSegmentResult extends IPlayFabResultCommon {
|
|
1290
1316
|
/** Continuation token to use to retrieve subsequent pages of results. If token returns null there are no more results. */
|
|
1291
1317
|
ContinuationToken?: string;
|
|
@@ -1976,6 +2002,7 @@ interface PlayerChurnPreviousPredictionSegmentFilter {
|
|
|
1976
2002
|
/** RiskLevel */
|
|
1977
2003
|
RiskLevel?: ChurnRiskLevel;
|
|
1978
2004
|
}
|
|
2005
|
+
/** @deprecated Do not use */
|
|
1979
2006
|
interface PlayerLinkedAccount {
|
|
1980
2007
|
/** Linked account's email */
|
|
1981
2008
|
Email?: string;
|
|
@@ -1986,6 +2013,7 @@ interface PlayerLinkedAccount {
|
|
|
1986
2013
|
/** Linked account's username */
|
|
1987
2014
|
Username?: string;
|
|
1988
2015
|
}
|
|
2016
|
+
/** @deprecated Do not use */
|
|
1989
2017
|
interface PlayerLocation {
|
|
1990
2018
|
/** City of the player's geographic location. */
|
|
1991
2019
|
City?: string;
|
|
@@ -1998,6 +2026,7 @@ interface PlayerLocation {
|
|
|
1998
2026
|
/** Longitude coordinate of the player's geographic location. */
|
|
1999
2027
|
Longitude?: number;
|
|
2000
2028
|
}
|
|
2029
|
+
/** @deprecated Do not use */
|
|
2001
2030
|
interface PlayerProfile {
|
|
2002
2031
|
/** Array of ad campaigns player has been attributed to */
|
|
2003
2032
|
AdCampaignAttributions?: AdCampaignAttribution[];
|
|
@@ -2131,6 +2160,7 @@ interface PlayerProfileViewConstraints {
|
|
|
2131
2160
|
/** Whether to show the values to date. Defaults to false */
|
|
2132
2161
|
ShowValuesToDate: boolean;
|
|
2133
2162
|
}
|
|
2163
|
+
/** @deprecated Do not use */
|
|
2134
2164
|
interface PlayerStatistic {
|
|
2135
2165
|
/** Statistic ID */
|
|
2136
2166
|
Id?: string;
|
|
@@ -2183,6 +2213,7 @@ interface PushNotificationContent {
|
|
|
2183
2213
|
Subject?: string;
|
|
2184
2214
|
}
|
|
2185
2215
|
type PushNotificationPlatform = "ApplePushNotificationService" | "GoogleCloudMessaging";
|
|
2216
|
+
/** @deprecated Do not use */
|
|
2186
2217
|
interface PushNotificationRegistration {
|
|
2187
2218
|
/** Notification configured endpoint */
|
|
2188
2219
|
NotificationEndpointARN?: string;
|
|
@@ -2684,7 +2715,14 @@ interface StoreMarketingModel {
|
|
|
2684
2715
|
Metadata?: any;
|
|
2685
2716
|
}
|
|
2686
2717
|
interface StoreMetricsRequest extends IPlayFabRequestCommon {
|
|
2718
|
+
/** Dimension filters. */
|
|
2719
|
+
DimensionFilters?: DimensionFilters;
|
|
2720
|
+
/**
|
|
2721
|
+
* Store metric name. page_view_count, purchase_count, purchase_revenue, unique_user_count, wish_list_add_count are
|
|
2722
|
+
* supported metrics.
|
|
2723
|
+
*/
|
|
2687
2724
|
MetricName?: string;
|
|
2725
|
+
/** Store metric period. 1h, 24h, 2d, 7d, 30d are supported periods. */
|
|
2688
2726
|
MetricPeriod?: string;
|
|
2689
2727
|
}
|
|
2690
2728
|
interface StoreMetricsResponse extends IPlayFabResultCommon {
|
|
@@ -4003,12 +4041,7 @@ declare class PlayFabAdminApi extends PlayFabCommon {
|
|
|
4003
4041
|
* called 30 times in one minute. You will be returned an error if you exceed this threshold.
|
|
4004
4042
|
*
|
|
4005
4043
|
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersinsegment Microsoft Documentation}
|
|
4006
|
-
* @
|
|
4007
|
-
* await adminClient.GetPlayersInSegment({
|
|
4008
|
-
* "SegmentId": "1337AA00",
|
|
4009
|
-
* "SecondsToLive": 5,
|
|
4010
|
-
* "MaxBatchSize": 500
|
|
4011
|
-
* });
|
|
4044
|
+
* @deprecated Please use ExportPlayersInSegment instead.
|
|
4012
4045
|
*/
|
|
4013
4046
|
GetPlayersInSegment(request: GetPlayersInSegmentRequest, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentResult>;
|
|
4014
4047
|
/**
|
|
@@ -4118,9 +4151,27 @@ declare class PlayFabAdminApi extends PlayFabCommon {
|
|
|
4118
4151
|
*/
|
|
4119
4152
|
GetStoreItems(request: GetStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
|
|
4120
4153
|
/**
|
|
4121
|
-
* Retrieves Xbox Store metric data for the authenticated title, based on the specified metric name
|
|
4154
|
+
* Retrieves Xbox Store metric data for the authenticated title, based on the specified metric name, reporting period and
|
|
4155
|
+
* metric dimension values.
|
|
4122
4156
|
*
|
|
4123
4157
|
* {@link https://docs.microsoft.com/rest/api/playfab/admin/xbox-store/getstoremetrics Microsoft Documentation}
|
|
4158
|
+
* @example
|
|
4159
|
+
* await adminClient.GetStoreMetrics({
|
|
4160
|
+
* "MetricName": "page_view_count",
|
|
4161
|
+
* "MetricPeriod": "24h",
|
|
4162
|
+
* "DimensionFilters": {
|
|
4163
|
+
* "AgeGroup": "Youth",
|
|
4164
|
+
* "Campaign": "Summer Sale",
|
|
4165
|
+
* "Country": "USA",
|
|
4166
|
+
* "Currency": "USD",
|
|
4167
|
+
* "DeviceType": "PC",
|
|
4168
|
+
* "ProductId": "ABC123",
|
|
4169
|
+
* "Source": "Homepage",
|
|
4170
|
+
* "StoreFront": "Xbox",
|
|
4171
|
+
* "HasInSale": "true",
|
|
4172
|
+
* "XboxTitleId": "XYZ456"
|
|
4173
|
+
* }
|
|
4174
|
+
* });
|
|
4124
4175
|
*/
|
|
4125
4176
|
GetStoreMetrics(request: StoreMetricsRequest, extraHeaders?: Record<string, string>): Promise<StoreMetricsResponse>;
|
|
4126
4177
|
/**
|
package/dist/Admin.js
CHANGED
package/dist/Authentication.js
CHANGED
package/dist/Client.js
CHANGED
package/dist/CloudScript.js
CHANGED
package/dist/Data.js
CHANGED
package/dist/Economy.d.ts
CHANGED
|
@@ -1653,6 +1653,10 @@ interface TransactionOperation {
|
|
|
1653
1653
|
Type?: string;
|
|
1654
1654
|
}
|
|
1655
1655
|
interface TransactionPurchaseDetails {
|
|
1656
|
+
/** The friendly id of the item that was purchased. */
|
|
1657
|
+
ItemFriendlyId?: string;
|
|
1658
|
+
/** The id of the item that was purchased. */
|
|
1659
|
+
ItemId?: string;
|
|
1656
1660
|
/** The friendly id of the Store the item was purchased from or null. */
|
|
1657
1661
|
StoreFriendlyId?: string;
|
|
1658
1662
|
/** The id of the Store the item was purchased from or null. */
|
|
@@ -1959,16 +1963,16 @@ interface VersionedCatalogItemPriceInstance {
|
|
|
1959
1963
|
/** The per-unit duration this price can be used to purchase. The maximum duration is 100 years. */
|
|
1960
1964
|
UnitDurationInSeconds?: number;
|
|
1961
1965
|
}
|
|
1962
|
-
interface
|
|
1963
|
-
/** The currency amounts utilized in the override for a singular price. */
|
|
1964
|
-
Amounts?: VersionedCatalogItemOverride[];
|
|
1965
|
-
}
|
|
1966
|
-
interface VersionedCatalogItemPricesOverride {
|
|
1966
|
+
interface VersionedCatalogItemPriceOptionsOverride {
|
|
1967
1967
|
/** The payout amount utilized in the override. */
|
|
1968
1968
|
PayoutAmount?: VersionedCatalogItemOverride;
|
|
1969
1969
|
/** The prices utilized in the override. */
|
|
1970
1970
|
Prices?: VersionedCatalogItemPriceOverride[];
|
|
1971
1971
|
}
|
|
1972
|
+
interface VersionedCatalogItemPriceOverride {
|
|
1973
|
+
/** The currency amounts utilized in the override for a singular price. */
|
|
1974
|
+
Amounts?: VersionedCatalogItemOverride[];
|
|
1975
|
+
}
|
|
1972
1976
|
interface VersionedCatalogItemRealMoneyPriceDetails {
|
|
1973
1977
|
/** The 'AppleAppStore' price amount per CurrencyCode. 'USD' supported only. */
|
|
1974
1978
|
AppleAppStorePrices?: Record<string, number>;
|
|
@@ -2001,7 +2005,7 @@ interface VersionedCatalogItemStoreDetails {
|
|
|
2001
2005
|
/** The permissions that control which players can purchase from the store. */
|
|
2002
2006
|
Permissions?: VersionedCatalogItemPermissions;
|
|
2003
2007
|
/** The global prices utilized in the store. These options are mutually exclusive with price options in item references. */
|
|
2004
|
-
|
|
2008
|
+
PriceOptionsOverride?: VersionedCatalogItemPriceOptionsOverride;
|
|
2005
2009
|
}
|
|
2006
2010
|
type ViewFileFormat = "Unknown" | "Json" | "JsonLines" | "GZippedJson" | "GZippedJsonLines";
|
|
2007
2011
|
|
package/dist/Economy.js
CHANGED
package/dist/Events.js
CHANGED
package/dist/Experimentation.js
CHANGED
package/dist/Groups.js
CHANGED
package/dist/Insights.js
CHANGED
package/dist/Localization.js
CHANGED
package/dist/Matchmaker.js
CHANGED
package/dist/Multiplayer.d.ts
CHANGED
|
@@ -3557,8 +3557,8 @@ declare class PlayFabMultiplayerApi extends PlayFabCommon {
|
|
|
3557
3557
|
* "Deaths"
|
|
3558
3558
|
* ],
|
|
3559
3559
|
* "InitialSettingsModelId": "73a2506e-9fd3-4d84-8dd7-570c8e9e02cf",
|
|
3560
|
-
* "MatchResultStartTimeUtc": "2025-08-
|
|
3561
|
-
* "MatchResultEndTimeUtc": "2025-08-
|
|
3560
|
+
* "MatchResultStartTimeUtc": "2025-08-15T13:31:26.125Z",
|
|
3561
|
+
* "MatchResultEndTimeUtc": "2025-08-15T14:01:26.125Z",
|
|
3562
3562
|
* "MaxIterations": 100,
|
|
3563
3563
|
* "AnomalousMatchResultIgnoreThreshold": -20.0
|
|
3564
3564
|
* });
|
|
@@ -5576,8 +5576,8 @@ declare class PlayFabMultiplayerApi extends PlayFabCommon {
|
|
|
5576
5576
|
* "Rank": 1
|
|
5577
5577
|
* }
|
|
5578
5578
|
* ],
|
|
5579
|
-
* "StartDateTimeUtc": "2025-08-
|
|
5580
|
-
* "EndDateTimeUtc": "2025-08-
|
|
5579
|
+
* "StartDateTimeUtc": "2025-08-15T13:31:26.115Z",
|
|
5580
|
+
* "EndDateTimeUtc": "2025-08-15T14:01:26.115Z"
|
|
5581
5581
|
* }
|
|
5582
5582
|
* });
|
|
5583
5583
|
*/
|
package/dist/Multiplayer.js
CHANGED
package/dist/Profiles.js
CHANGED
package/dist/Progression.d.ts
CHANGED
|
@@ -13,6 +13,8 @@ interface CreateLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
|
|
|
13
13
|
* 'external' as the type.
|
|
14
14
|
*/
|
|
15
15
|
EntityType: string;
|
|
16
|
+
/** [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted. */
|
|
17
|
+
EventEmissionConfig?: LeaderboardEventEmissionConfig;
|
|
16
18
|
/** A name for the leaderboard, unique per title. */
|
|
17
19
|
Name: string;
|
|
18
20
|
/** Maximum number of entries on this leaderboard */
|
|
@@ -33,6 +35,8 @@ interface CreateStatisticDefinitionRequest extends IPlayFabRequestCommon {
|
|
|
33
35
|
CustomTags?: Record<string, string | null>;
|
|
34
36
|
/** The entity type allowed to have score(s) for this statistic. */
|
|
35
37
|
EntityType?: string;
|
|
38
|
+
/** [In Preview]: Configurations for different Statistics events that can be emitted by the service. */
|
|
39
|
+
EventEmissionConfig?: StatisticsEventEmissionConfig;
|
|
36
40
|
/** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */
|
|
37
41
|
Name: string;
|
|
38
42
|
/** The version reset configuration for the statistic definition. */
|
|
@@ -111,6 +115,7 @@ interface EntityStatisticValue {
|
|
|
111
115
|
/** Statistic version */
|
|
112
116
|
Version: number;
|
|
113
117
|
}
|
|
118
|
+
type EventType = "None" | "Telemetry" | "PlayStream";
|
|
114
119
|
type ExternalFriendSources = "None" | "Steam" | "Facebook" | "Xbox" | "Psn" | "All";
|
|
115
120
|
interface GetEntityLeaderboardRequest extends IPlayFabRequestCommon {
|
|
116
121
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
@@ -187,6 +192,8 @@ interface GetLeaderboardDefinitionResponse extends IPlayFabResultCommon {
|
|
|
187
192
|
* 'external' as the type.
|
|
188
193
|
*/
|
|
189
194
|
EntityType: string;
|
|
195
|
+
/** [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted. */
|
|
196
|
+
EventEmissionConfig?: LeaderboardEventEmissionConfig;
|
|
190
197
|
/** Last time, in UTC, leaderboard version was incremented. */
|
|
191
198
|
LastResetTime?: string;
|
|
192
199
|
/** A name for the leaderboard, unique per title. */
|
|
@@ -229,6 +236,8 @@ interface GetStatisticDefinitionResponse extends IPlayFabResultCommon {
|
|
|
229
236
|
Created: string;
|
|
230
237
|
/** The entity type that can have this statistic. */
|
|
231
238
|
EntityType?: string;
|
|
239
|
+
/** [In Preview]: Configurations for different Statistics events that can be emitted by the service. */
|
|
240
|
+
EventEmissionConfig?: StatisticsEventEmissionConfig;
|
|
232
241
|
/** Last time, in UTC, statistic version was incremented. */
|
|
233
242
|
LastResetTime?: string;
|
|
234
243
|
/** The list of leaderboards that are linked to this statistic definition. */
|
|
@@ -321,6 +330,8 @@ interface LeaderboardDefinition {
|
|
|
321
330
|
* 'external' as the type.
|
|
322
331
|
*/
|
|
323
332
|
EntityType: string;
|
|
333
|
+
/** [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted. */
|
|
334
|
+
EventEmissionConfig?: LeaderboardEventEmissionConfig;
|
|
324
335
|
/** Last time, in UTC, leaderboard version was incremented. */
|
|
325
336
|
LastResetTime?: string;
|
|
326
337
|
/** A name for the leaderboard, unique per title. */
|
|
@@ -332,6 +343,12 @@ interface LeaderboardDefinition {
|
|
|
332
343
|
/** The version reset configuration for the leaderboard definition. */
|
|
333
344
|
VersionConfiguration: VersionConfiguration;
|
|
334
345
|
}
|
|
346
|
+
interface LeaderboardEntityRankOnVersionEndConfig {
|
|
347
|
+
/** The type of event to emit when the leaderboard version end. */
|
|
348
|
+
EventType: EventType;
|
|
349
|
+
/** The maximum number of entity to return on leaderboard version end. Range is 1 to 1000. */
|
|
350
|
+
RankLimit: number;
|
|
351
|
+
}
|
|
335
352
|
interface LeaderboardEntryUpdate {
|
|
336
353
|
/** The unique Id for the entry. If using PlayFab Entities, this would be the entityId of the entity. */
|
|
337
354
|
EntityId: string;
|
|
@@ -346,7 +363,17 @@ interface LeaderboardEntryUpdate {
|
|
|
346
363
|
*/
|
|
347
364
|
Scores?: string[];
|
|
348
365
|
}
|
|
366
|
+
interface LeaderboardEventEmissionConfig {
|
|
367
|
+
/** This event emits the top ranks of the leaderboard when the leaderboard version end. */
|
|
368
|
+
EntityRankOnVersionEndConfig?: LeaderboardEntityRankOnVersionEndConfig;
|
|
369
|
+
/** This event is emitted when the leaderboard version end. */
|
|
370
|
+
VersionEndConfig?: LeaderboardVersionEndConfig;
|
|
371
|
+
}
|
|
349
372
|
type LeaderboardSortDirection = "Descending" | "Ascending";
|
|
373
|
+
interface LeaderboardVersionEndConfig {
|
|
374
|
+
/** The type of event to emit when the leaderboard version end. */
|
|
375
|
+
EventType: EventType;
|
|
376
|
+
}
|
|
350
377
|
interface LinkedStatisticColumn {
|
|
351
378
|
/** The name of the statistic column that this leaderboard column is sourced from. */
|
|
352
379
|
LinkedStatisticColumnName: string;
|
|
@@ -398,6 +425,8 @@ interface StatisticDefinition {
|
|
|
398
425
|
Created: string;
|
|
399
426
|
/** The entity type that can have this statistic. */
|
|
400
427
|
EntityType?: string;
|
|
428
|
+
/** [In Preview]: Configurations for different Statistics events that can be emitted by the service. */
|
|
429
|
+
EventEmissionConfig?: StatisticsEventEmissionConfig;
|
|
401
430
|
/** Last time, in UTC, statistic version was incremented. */
|
|
402
431
|
LastResetTime?: string;
|
|
403
432
|
/** The list of leaderboards that are linked to this statistic definition. */
|
|
@@ -413,6 +442,14 @@ interface StatisticDelete {
|
|
|
413
442
|
/** Name of the statistic, as originally configured. */
|
|
414
443
|
Name: string;
|
|
415
444
|
}
|
|
445
|
+
interface StatisticsEventEmissionConfig {
|
|
446
|
+
/** Emitted when statistics are updated. */
|
|
447
|
+
UpdateEventConfig?: StatisticsUpdateEventConfig;
|
|
448
|
+
}
|
|
449
|
+
interface StatisticsUpdateEventConfig {
|
|
450
|
+
/** The event type to emit when statistics are updated. */
|
|
451
|
+
EventType: EventType;
|
|
452
|
+
}
|
|
416
453
|
interface StatisticUpdate {
|
|
417
454
|
/**
|
|
418
455
|
* Arbitrary metadata to store along side the statistic, will be returned by all Leaderboard APIs. Must be less than 50
|
|
@@ -442,6 +479,8 @@ interface UnlinkLeaderboardFromStatisticRequest extends IPlayFabRequestCommon {
|
|
|
442
479
|
interface UpdateLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
|
|
443
480
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
444
481
|
CustomTags?: Record<string, string | null>;
|
|
482
|
+
/** [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted. */
|
|
483
|
+
EventEmissionConfig?: LeaderboardEventEmissionConfig;
|
|
445
484
|
/** The name of the leaderboard to update the definition for. */
|
|
446
485
|
Name: string;
|
|
447
486
|
/** Maximum number of entries on this leaderboard */
|
|
@@ -460,6 +499,8 @@ interface UpdateLeaderboardEntriesRequest extends IPlayFabRequestCommon {
|
|
|
460
499
|
interface UpdateStatisticDefinitionRequest extends IPlayFabRequestCommon {
|
|
461
500
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
462
501
|
CustomTags?: Record<string, string | null>;
|
|
502
|
+
/** [In Preview]: Configurations for different Statistics events that can be emitted by the service. */
|
|
503
|
+
EventEmissionConfig?: StatisticsEventEmissionConfig;
|
|
463
504
|
/** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */
|
|
464
505
|
Name: string;
|
|
465
506
|
/** The version reset configuration for the statistic definition. */
|
package/dist/Progression.js
CHANGED
package/dist/Server.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
|
|
2
2
|
|
|
3
|
+
/** @deprecated Do not use */
|
|
3
4
|
interface AdCampaignAttribution {
|
|
4
5
|
/** UTC time stamp of attribution */
|
|
5
6
|
AttributedAt: string;
|
|
@@ -334,6 +335,7 @@ interface ConsumeItemResult extends IPlayFabResultCommon {
|
|
|
334
335
|
/** Number of uses remaining on the item. */
|
|
335
336
|
RemainingUses: number;
|
|
336
337
|
}
|
|
338
|
+
/** @deprecated Do not use */
|
|
337
339
|
interface ContactEmailInfo {
|
|
338
340
|
/** The email address */
|
|
339
341
|
EmailAddress?: string;
|
|
@@ -1007,6 +1009,7 @@ interface GetPlayerSegmentsResult extends IPlayFabResultCommon {
|
|
|
1007
1009
|
/** Array of segments the requested player currently belongs to. */
|
|
1008
1010
|
Segments?: GetSegmentResult[];
|
|
1009
1011
|
}
|
|
1012
|
+
/** @deprecated Do not use */
|
|
1010
1013
|
interface GetPlayersInSegmentRequest extends IPlayFabRequestCommon {
|
|
1011
1014
|
/** Continuation token if retrieving subsequent pages of results. */
|
|
1012
1015
|
ContinuationToken?: string;
|
|
@@ -1031,6 +1034,7 @@ interface GetPlayersInSegmentRequest extends IPlayFabRequestCommon {
|
|
|
1031
1034
|
/** Unique identifier for this segment. */
|
|
1032
1035
|
SegmentId: string;
|
|
1033
1036
|
}
|
|
1037
|
+
/** @deprecated Do not use */
|
|
1034
1038
|
interface GetPlayersInSegmentResult extends IPlayFabResultCommon {
|
|
1035
1039
|
/** Continuation token to use to retrieve subsequent pages of results. If token returns null there are no more results. */
|
|
1036
1040
|
ContinuationToken?: string;
|
|
@@ -2041,6 +2045,7 @@ interface PlayerLeaderboardEntry {
|
|
|
2041
2045
|
/** Specific value of the user's statistic. */
|
|
2042
2046
|
StatValue: number;
|
|
2043
2047
|
}
|
|
2048
|
+
/** @deprecated Do not use */
|
|
2044
2049
|
interface PlayerLinkedAccount {
|
|
2045
2050
|
/** Linked account's email */
|
|
2046
2051
|
Email?: string;
|
|
@@ -2051,6 +2056,7 @@ interface PlayerLinkedAccount {
|
|
|
2051
2056
|
/** Linked account's username */
|
|
2052
2057
|
Username?: string;
|
|
2053
2058
|
}
|
|
2059
|
+
/** @deprecated Do not use */
|
|
2054
2060
|
interface PlayerLocation {
|
|
2055
2061
|
/** City of the player's geographic location. */
|
|
2056
2062
|
City?: string;
|
|
@@ -2063,6 +2069,7 @@ interface PlayerLocation {
|
|
|
2063
2069
|
/** Longitude coordinate of the player's geographic location. */
|
|
2064
2070
|
Longitude?: number;
|
|
2065
2071
|
}
|
|
2072
|
+
/** @deprecated Do not use */
|
|
2066
2073
|
interface PlayerProfile {
|
|
2067
2074
|
/** Array of ad campaigns player has been attributed to */
|
|
2068
2075
|
AdCampaignAttributions?: AdCampaignAttribution[];
|
|
@@ -2196,6 +2203,7 @@ interface PlayerProfileViewConstraints {
|
|
|
2196
2203
|
/** Whether to show the values to date. Defaults to false */
|
|
2197
2204
|
ShowValuesToDate: boolean;
|
|
2198
2205
|
}
|
|
2206
|
+
/** @deprecated Do not use */
|
|
2199
2207
|
interface PlayerStatistic {
|
|
2200
2208
|
/** Statistic ID */
|
|
2201
2209
|
Id?: string;
|
|
@@ -2259,6 +2267,7 @@ interface PushNotificationPackage {
|
|
|
2259
2267
|
Title: string;
|
|
2260
2268
|
}
|
|
2261
2269
|
type PushNotificationPlatform = "ApplePushNotificationService" | "GoogleCloudMessaging";
|
|
2270
|
+
/** @deprecated Do not use */
|
|
2262
2271
|
interface PushNotificationRegistration {
|
|
2263
2272
|
/** Notification configured endpoint */
|
|
2264
2273
|
NotificationEndpointARN?: string;
|
|
@@ -3969,12 +3978,7 @@ declare class PlayFabServerApi extends PlayFabCommon {
|
|
|
3969
3978
|
* called 30 times in one minute. You will be returned an error if you exceed this threshold.
|
|
3970
3979
|
*
|
|
3971
3980
|
* {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersinsegment Microsoft Documentation}
|
|
3972
|
-
* @
|
|
3973
|
-
* await serverClient.GetPlayersInSegment({
|
|
3974
|
-
* "SegmentId": "1337AA00",
|
|
3975
|
-
* "SecondsToLive": 5,
|
|
3976
|
-
* "MaxBatchSize": 500
|
|
3977
|
-
* });
|
|
3981
|
+
* @deprecated Do not use
|
|
3978
3982
|
*/
|
|
3979
3983
|
GetPlayersInSegment(request: GetPlayersInSegmentRequest, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentResult>;
|
|
3980
3984
|
/**
|