@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.d.ts
CHANGED
|
@@ -54,7 +54,7 @@ interface ActionsOnPlayersInSegmentTaskSummary {
|
|
|
54
54
|
/** UTC timestamp when the task started. */
|
|
55
55
|
StartedAt: string;
|
|
56
56
|
/** Current status of the task instance. */
|
|
57
|
-
Status?:
|
|
57
|
+
Status?: TaskInstanceStatus;
|
|
58
58
|
/** Identifier of the task this instance belongs to. */
|
|
59
59
|
TaskIdentifier?: NameIdentifier;
|
|
60
60
|
/** ID of the task instance. */
|
|
@@ -86,7 +86,7 @@ interface AdCampaignSegmentFilter {
|
|
|
86
86
|
/** Campaign source. */
|
|
87
87
|
CampaignSource?: string;
|
|
88
88
|
/** Campaign comparison. */
|
|
89
|
-
Comparison?:
|
|
89
|
+
Comparison?: SegmentFilterComparison;
|
|
90
90
|
}
|
|
91
91
|
interface AddInventoryItemsV2SegmentAction {
|
|
92
92
|
/** Amount of the item to be granted to a player */
|
|
@@ -153,7 +153,7 @@ interface AddPlayerTagResult extends IPlayFabResultCommon {
|
|
|
153
153
|
/** @deprecated Do not use */
|
|
154
154
|
interface AddServerBuildRequest extends IPlayFabRequestCommon {
|
|
155
155
|
/** server host regions in which this build should be running and available */
|
|
156
|
-
ActiveRegions?:
|
|
156
|
+
ActiveRegions?: Region[];
|
|
157
157
|
/** unique identifier for the build executable */
|
|
158
158
|
BuildId: string;
|
|
159
159
|
/**
|
|
@@ -181,7 +181,7 @@ interface AddServerBuildRequest extends IPlayFabRequestCommon {
|
|
|
181
181
|
/** @deprecated Do not use */
|
|
182
182
|
interface AddServerBuildResult extends IPlayFabResultCommon {
|
|
183
183
|
/** array of regions where this build can used, when it is active */
|
|
184
|
-
ActiveRegions?:
|
|
184
|
+
ActiveRegions?: Region[];
|
|
185
185
|
/** unique identifier for this build executable */
|
|
186
186
|
BuildId?: string;
|
|
187
187
|
/**
|
|
@@ -204,7 +204,7 @@ interface AddServerBuildResult extends IPlayFabResultCommon {
|
|
|
204
204
|
*/
|
|
205
205
|
MinFreeGameSlots: number;
|
|
206
206
|
/** the current status of the build validation and processing steps */
|
|
207
|
-
Status?:
|
|
207
|
+
Status?: GameBuildStatus;
|
|
208
208
|
/** time this build was last modified (or uploaded, if this build has never been modified) */
|
|
209
209
|
Timestamp: string;
|
|
210
210
|
/**
|
|
@@ -237,8 +237,9 @@ interface AllPlayersSegmentFilter {
|
|
|
237
237
|
}
|
|
238
238
|
interface ApiCondition {
|
|
239
239
|
/** Require that API calls contain an RSA encrypted payload or signed headers. */
|
|
240
|
-
HasSignatureOrEncryption?:
|
|
240
|
+
HasSignatureOrEncryption?: Conditionals;
|
|
241
241
|
}
|
|
242
|
+
type AuthTokenType = "Email";
|
|
242
243
|
interface BanInfo {
|
|
243
244
|
/** The active state of this ban. Expired bans may still have this value set to true but they will have no effect. */
|
|
244
245
|
Active: boolean;
|
|
@@ -302,7 +303,7 @@ interface BanRequest {
|
|
|
302
303
|
/** The reason for this ban. Maximum 140 characters. */
|
|
303
304
|
Reason?: string;
|
|
304
305
|
/** The family type of the user that should be included in the ban if applicable. May affect multiple players. */
|
|
305
|
-
UserFamilyType?:
|
|
306
|
+
UserFamilyType?: UserFamilyType;
|
|
306
307
|
}
|
|
307
308
|
interface BanUsersRequest extends IPlayFabRequestCommon {
|
|
308
309
|
/** List of ban requests to be applied. Maximum 100. */
|
|
@@ -426,10 +427,11 @@ interface CheckLimitedEditionItemAvailabilityResult extends IPlayFabResultCommon
|
|
|
426
427
|
}
|
|
427
428
|
interface ChurnPredictionSegmentFilter {
|
|
428
429
|
/** Comparison */
|
|
429
|
-
Comparison?:
|
|
430
|
+
Comparison?: SegmentFilterComparison;
|
|
430
431
|
/** RiskLevel */
|
|
431
|
-
RiskLevel?:
|
|
432
|
+
RiskLevel?: ChurnRiskLevel;
|
|
432
433
|
}
|
|
434
|
+
type ChurnRiskLevel = "NoData" | "LowRisk" | "MediumRisk" | "HighRisk";
|
|
433
435
|
interface CloudScriptAzureFunctionsTaskParameter {
|
|
434
436
|
/** Argument to pass to the CloudScript function. */
|
|
435
437
|
Argument?: any;
|
|
@@ -452,7 +454,7 @@ interface CloudScriptAzureFunctionsTaskSummary {
|
|
|
452
454
|
/** UTC timestamp when the task started. */
|
|
453
455
|
StartedAt: string;
|
|
454
456
|
/** Current status of the task instance. */
|
|
455
|
-
Status?:
|
|
457
|
+
Status?: TaskInstanceStatus;
|
|
456
458
|
/** Identifier of the task this instance belongs to. */
|
|
457
459
|
TaskIdentifier?: NameIdentifier;
|
|
458
460
|
/** ID of the task instance. */
|
|
@@ -487,7 +489,7 @@ interface CloudScriptTaskSummary {
|
|
|
487
489
|
/** UTC timestamp when the task started. */
|
|
488
490
|
StartedAt: string;
|
|
489
491
|
/** Current status of the task instance. */
|
|
490
|
-
Status?:
|
|
492
|
+
Status?: TaskInstanceStatus;
|
|
491
493
|
/** Identifier of the task this instance belongs to. */
|
|
492
494
|
TaskIdentifier?: NameIdentifier;
|
|
493
495
|
/** ID of the task instance. */
|
|
@@ -501,13 +503,14 @@ interface CloudScriptVersionStatus {
|
|
|
501
503
|
/** Version number */
|
|
502
504
|
Version: number;
|
|
503
505
|
}
|
|
506
|
+
type Conditionals = "Any" | "True" | "False";
|
|
504
507
|
interface ContactEmailInfo {
|
|
505
508
|
/** The email address */
|
|
506
509
|
EmailAddress?: string;
|
|
507
510
|
/** The name of the email info data */
|
|
508
511
|
Name?: string;
|
|
509
512
|
/** The verification status of the email */
|
|
510
|
-
VerificationStatus?:
|
|
513
|
+
VerificationStatus?: EmailVerificationStatus;
|
|
511
514
|
}
|
|
512
515
|
interface ContactEmailInfoModel {
|
|
513
516
|
/** The email address */
|
|
@@ -515,7 +518,7 @@ interface ContactEmailInfoModel {
|
|
|
515
518
|
/** The name of the email info data */
|
|
516
519
|
Name?: string;
|
|
517
520
|
/** The verification status of the email */
|
|
518
|
-
VerificationStatus?:
|
|
521
|
+
VerificationStatus?: EmailVerificationStatus;
|
|
519
522
|
}
|
|
520
523
|
interface ContentInfo {
|
|
521
524
|
/** Key of the content */
|
|
@@ -525,6 +528,8 @@ interface ContentInfo {
|
|
|
525
528
|
/** Size of the content in bytes */
|
|
526
529
|
Size: number;
|
|
527
530
|
}
|
|
531
|
+
type ContinentCode = "AF" | "AN" | "AS" | "EU" | "NA" | "OC" | "SA" | "Unknown";
|
|
532
|
+
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";
|
|
528
533
|
interface CreateActionsOnPlayerSegmentTaskRequest extends IPlayFabRequestCommon {
|
|
529
534
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
530
535
|
CustomTags?: Record<string, string | null>;
|
|
@@ -612,13 +617,13 @@ interface CreatePlayerSharedSecretResult extends IPlayFabResultCommon {
|
|
|
612
617
|
}
|
|
613
618
|
interface CreatePlayerStatisticDefinitionRequest extends IPlayFabRequestCommon {
|
|
614
619
|
/** the aggregation method to use in updating the statistic (defaults to last) */
|
|
615
|
-
AggregationMethod?:
|
|
620
|
+
AggregationMethod?: StatisticAggregationMethod;
|
|
616
621
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
617
622
|
CustomTags?: Record<string, string | null>;
|
|
618
623
|
/** unique name of the statistic */
|
|
619
624
|
StatisticName: string;
|
|
620
625
|
/** interval at which the values of the statistic for all players are reset (resets begin at the next interval boundary) */
|
|
621
|
-
VersionChangeInterval?:
|
|
626
|
+
VersionChangeInterval?: StatisticResetIntervalOption;
|
|
622
627
|
}
|
|
623
628
|
interface CreatePlayerStatisticDefinitionResult extends IPlayFabResultCommon {
|
|
624
629
|
/** created statistic definition */
|
|
@@ -638,9 +643,10 @@ interface CreateTaskResult extends IPlayFabResultCommon {
|
|
|
638
643
|
/** ID of the task */
|
|
639
644
|
TaskId?: string;
|
|
640
645
|
}
|
|
646
|
+
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";
|
|
641
647
|
interface CustomPropertyBooleanSegmentFilter {
|
|
642
648
|
/** Custom property comparison. */
|
|
643
|
-
Comparison?:
|
|
649
|
+
Comparison?: SegmentFilterComparison;
|
|
644
650
|
/** Custom property name. */
|
|
645
651
|
PropertyName?: string;
|
|
646
652
|
/** Custom property boolean value. */
|
|
@@ -648,7 +654,7 @@ interface CustomPropertyBooleanSegmentFilter {
|
|
|
648
654
|
}
|
|
649
655
|
interface CustomPropertyDateTimeSegmentFilter {
|
|
650
656
|
/** Custom property comparison. */
|
|
651
|
-
Comparison?:
|
|
657
|
+
Comparison?: SegmentFilterComparison;
|
|
652
658
|
/** Custom property name. */
|
|
653
659
|
PropertyName?: string;
|
|
654
660
|
/** Custom property datetime value. */
|
|
@@ -662,7 +668,7 @@ interface CustomPropertyDetails {
|
|
|
662
668
|
}
|
|
663
669
|
interface CustomPropertyNumericSegmentFilter {
|
|
664
670
|
/** Custom property comparison. */
|
|
665
|
-
Comparison?:
|
|
671
|
+
Comparison?: SegmentFilterComparison;
|
|
666
672
|
/** Custom property name. */
|
|
667
673
|
PropertyName?: string;
|
|
668
674
|
/** Custom property numeric value. */
|
|
@@ -670,7 +676,7 @@ interface CustomPropertyNumericSegmentFilter {
|
|
|
670
676
|
}
|
|
671
677
|
interface CustomPropertyStringSegmentFilter {
|
|
672
678
|
/** Custom property comparison. */
|
|
673
|
-
Comparison?:
|
|
679
|
+
Comparison?: SegmentFilterComparison;
|
|
674
680
|
/** Custom property name. */
|
|
675
681
|
PropertyName?: string;
|
|
676
682
|
/** Custom property string value. */
|
|
@@ -831,12 +837,14 @@ interface DeleteUsersRequest extends IPlayFabRequestCommon {
|
|
|
831
837
|
/** @deprecated Do not use */
|
|
832
838
|
interface DeleteUsersResult extends IPlayFabResultCommon {
|
|
833
839
|
}
|
|
840
|
+
type EffectType = "Allow" | "Deny";
|
|
834
841
|
interface EmailNotificationSegmentAction {
|
|
835
842
|
/** Email template id. */
|
|
836
843
|
EmailTemplateId?: string;
|
|
837
844
|
/** Email template name. */
|
|
838
845
|
EmailTemplateName?: string;
|
|
839
846
|
}
|
|
847
|
+
type EmailVerificationStatus = "Unverified" | "Pending" | "Confirmed";
|
|
840
848
|
interface EntityKey {
|
|
841
849
|
/** Unique ID of the entity. */
|
|
842
850
|
Id: string;
|
|
@@ -856,7 +864,7 @@ interface ErrorDetails {
|
|
|
856
864
|
}
|
|
857
865
|
interface EventSink {
|
|
858
866
|
/** The type of event sink. Currently only supports AzureBlobStorage. */
|
|
859
|
-
DestinationType:
|
|
867
|
+
DestinationType: ExternalDestinationType;
|
|
860
868
|
/** Error status for the sink. */
|
|
861
869
|
Error?: ErrorDetails;
|
|
862
870
|
/** The usage status of the sink. */
|
|
@@ -969,15 +977,16 @@ interface ExportPlayersInSegmentResult extends IPlayFabResultCommon {
|
|
|
969
977
|
/** Unique identifier of the requested Segment. */
|
|
970
978
|
SegmentId?: string;
|
|
971
979
|
}
|
|
980
|
+
type ExternalDestinationType = "AzureBlobStorage" | "AzureDataExplorer" | "AzureBlobDelta";
|
|
972
981
|
interface FirstLoginDateSegmentFilter {
|
|
973
982
|
/** First player login date comparison. */
|
|
974
|
-
Comparison?:
|
|
983
|
+
Comparison?: SegmentFilterComparison;
|
|
975
984
|
/** First player login date. */
|
|
976
985
|
LogInDate: string;
|
|
977
986
|
}
|
|
978
987
|
interface FirstLoginTimespanSegmentFilter {
|
|
979
988
|
/** First player login duration comparison. */
|
|
980
|
-
Comparison?:
|
|
989
|
+
Comparison?: SegmentFilterComparison;
|
|
981
990
|
/** First player login duration. */
|
|
982
991
|
DurationInMinutes: number;
|
|
983
992
|
}
|
|
@@ -992,6 +1001,7 @@ interface FunctionExecutionError {
|
|
|
992
1001
|
/** Point during the execution of the function at which the error occurred, if any */
|
|
993
1002
|
StackTrace?: string;
|
|
994
1003
|
}
|
|
1004
|
+
type GameBuildStatus = "Available" | "Validating" | "InvalidBuildPackage" | "Processing" | "FailedToProcess";
|
|
995
1005
|
/** @deprecated Do not use */
|
|
996
1006
|
interface GameModeInfo {
|
|
997
1007
|
/** specific game mode type */
|
|
@@ -1003,6 +1013,7 @@ interface GameModeInfo {
|
|
|
1003
1013
|
/** whether to start as an open session, meaning that players can matchmake into it (defaults to true) */
|
|
1004
1014
|
StartOpen?: boolean;
|
|
1005
1015
|
}
|
|
1016
|
+
type GenericErrorCodes = "Success" | "UnkownError" | "InvalidParams" | "AccountNotFound" | "AccountBanned" | "InvalidUsernameOrPassword" | "InvalidTitleId" | "InvalidEmailAddress" | "EmailAddressNotAvailable" | "InvalidUsername" | "InvalidPassword" | "UsernameNotAvailable" | "InvalidSteamTicket" | "AccountAlreadyLinked" | "LinkedAccountAlreadyClaimed" | "InvalidFacebookToken" | "AccountNotLinked" | "FailedByPaymentProvider" | "CouponCodeNotFound" | "InvalidContainerItem" | "ContainerNotOwned" | "KeyNotOwned" | "InvalidItemIdInTable" | "InvalidReceipt" | "ReceiptAlreadyUsed" | "ReceiptCancelled" | "GameNotFound" | "GameModeNotFound" | "InvalidGoogleToken" | "UserIsNotPartOfDeveloper" | "InvalidTitleForDeveloper" | "TitleNameConflicts" | "UserisNotValid" | "ValueAlreadyExists" | "BuildNotFound" | "PlayerNotInGame" | "InvalidTicket" | "InvalidDeveloper" | "InvalidOrderInfo" | "RegistrationIncomplete" | "InvalidPlatform" | "UnknownError" | "SteamApplicationNotOwned" | "WrongSteamAccount" | "TitleNotActivated" | "RegistrationSessionNotFound" | "NoSuchMod" | "FileNotFound" | "DuplicateEmail" | "ItemNotFound" | "ItemNotOwned" | "ItemNotRecycleable" | "ItemNotAffordable" | "InvalidVirtualCurrency" | "WrongVirtualCurrency" | "WrongPrice" | "NonPositiveValue" | "InvalidRegion" | "RegionAtCapacity" | "ServerFailedToStart" | "NameNotAvailable" | "InsufficientFunds" | "InvalidDeviceID" | "InvalidPushNotificationToken" | "NoRemainingUses" | "InvalidPaymentProvider" | "PurchaseInitializationFailure" | "DuplicateUsername" | "InvalidBuyerInfo" | "NoGameModeParamsSet" | "BodyTooLarge" | "ReservedWordInBody" | "InvalidTypeInBody" | "InvalidRequest" | "ReservedEventName" | "InvalidUserStatistics" | "NotAuthenticated" | "StreamAlreadyExists" | "ErrorCreatingStream" | "StreamNotFound" | "InvalidAccount" | "PurchaseDoesNotExist" | "InvalidPurchaseTransactionStatus" | "APINotEnabledForGameClientAccess" | "NoPushNotificationARNForTitle" | "BuildAlreadyExists" | "BuildPackageDoesNotExist" | "CustomAnalyticsEventsNotEnabledForTitle" | "InvalidSharedGroupId" | "NotAuthorized" | "MissingTitleGoogleProperties" | "InvalidItemProperties" | "InvalidPSNAuthCode" | "InvalidItemId" | "PushNotEnabledForAccount" | "PushServiceError" | "ReceiptDoesNotContainInAppItems" | "ReceiptContainsMultipleInAppItems" | "InvalidBundleID" | "JavascriptException" | "InvalidSessionTicket" | "UnableToConnectToDatabase" | "InternalServerError" | "InvalidReportDate" | "DatabaseThroughputExceeded" | "InvalidGameTicket" | "ExpiredGameTicket" | "GameTicketDoesNotMatchLobby" | "LinkedDeviceAlreadyClaimed" | "DeviceAlreadyLinked" | "DeviceNotLinked" | "PartialFailure" | "PublisherNotSet" | "ServiceUnavailable" | "VersionNotFound" | "RevisionNotFound" | "InvalidPublisherId" | "DownstreamServiceUnavailable" | "APINotIncludedInTitleUsageTier" | "DAULimitExceeded" | "APIRequestLimitExceeded" | "InvalidAPIEndpoint" | "BuildNotAvailable" | "ConcurrentEditError" | "ContentNotFound" | "CharacterNotFound" | "CloudScriptNotFound" | "ContentQuotaExceeded" | "InvalidCharacterStatistics" | "PhotonNotEnabledForTitle" | "PhotonApplicationNotFound" | "PhotonApplicationNotAssociatedWithTitle" | "InvalidEmailOrPassword" | "FacebookAPIError" | "InvalidContentType" | "KeyLengthExceeded" | "DataLengthExceeded" | "TooManyKeys" | "FreeTierCannotHaveVirtualCurrency" | "MissingAmazonSharedKey" | "AmazonValidationError" | "InvalidPSNIssuerId" | "PSNInaccessible" | "ExpiredAuthToken" | "FailedToGetEntitlements" | "FailedToConsumeEntitlement" | "TradeAcceptingUserNotAllowed" | "TradeInventoryItemIsAssignedToCharacter" | "TradeInventoryItemIsBundle" | "TradeStatusNotValidForCancelling" | "TradeStatusNotValidForAccepting" | "TradeDoesNotExist" | "TradeCancelled" | "TradeAlreadyFilled" | "TradeWaitForStatusTimeout" | "TradeInventoryItemExpired" | "TradeMissingOfferedAndAcceptedItems" | "TradeAcceptedItemIsBundle" | "TradeAcceptedItemIsStackable" | "TradeInventoryItemInvalidStatus" | "TradeAcceptedCatalogItemInvalid" | "TradeAllowedUsersInvalid" | "TradeInventoryItemDoesNotExist" | "TradeInventoryItemIsConsumed" | "TradeInventoryItemIsStackable" | "TradeAcceptedItemsMismatch" | "InvalidKongregateToken" | "FeatureNotConfiguredForTitle" | "NoMatchingCatalogItemForReceipt" | "InvalidCurrencyCode" | "NoRealMoneyPriceForCatalogItem" | "TradeInventoryItemIsNotTradable" | "TradeAcceptedCatalogItemIsNotTradable" | "UsersAlreadyFriends" | "LinkedIdentifierAlreadyClaimed" | "CustomIdNotLinked" | "TotalDataSizeExceeded" | "DeleteKeyConflict" | "InvalidXboxLiveToken" | "ExpiredXboxLiveToken" | "ResettableStatisticVersionRequired" | "NotAuthorizedByTitle" | "NoPartnerEnabled" | "InvalidPartnerResponse" | "APINotEnabledForGameServerAccess" | "StatisticNotFound" | "StatisticNameConflict" | "StatisticVersionClosedForWrites" | "StatisticVersionInvalid" | "APIClientRequestRateLimitExceeded" | "InvalidJSONContent" | "InvalidDropTable" | "StatisticVersionAlreadyIncrementedForScheduledInterval" | "StatisticCountLimitExceeded" | "StatisticVersionIncrementRateExceeded" | "ContainerKeyInvalid" | "CloudScriptExecutionTimeLimitExceeded" | "NoWritePermissionsForEvent" | "CloudScriptFunctionArgumentSizeExceeded" | "CloudScriptAPIRequestCountExceeded" | "CloudScriptAPIRequestError" | "CloudScriptHTTPRequestError" | "InsufficientGuildRole" | "GuildNotFound" | "OverLimit" | "EventNotFound" | "InvalidEventField" | "InvalidEventName" | "CatalogNotConfigured" | "OperationNotSupportedForPlatform" | "SegmentNotFound" | "StoreNotFound" | "InvalidStatisticName" | "TitleNotQualifiedForLimit" | "InvalidServiceLimitLevel" | "ServiceLimitLevelInTransition" | "CouponAlreadyRedeemed" | "GameServerBuildSizeLimitExceeded" | "GameServerBuildCountLimitExceeded" | "VirtualCurrencyCountLimitExceeded" | "VirtualCurrencyCodeExists" | "TitleNewsItemCountLimitExceeded" | "InvalidTwitchToken" | "TwitchResponseError" | "ProfaneDisplayName" | "UserAlreadyAdded" | "InvalidVirtualCurrencyCode" | "VirtualCurrencyCannotBeDeleted" | "IdentifierAlreadyClaimed" | "IdentifierNotLinked" | "InvalidContinuationToken" | "ExpiredContinuationToken" | "InvalidSegment" | "InvalidSessionId" | "SessionLogNotFound" | "InvalidSearchTerm" | "TwoFactorAuthenticationTokenRequired" | "GameServerHostCountLimitExceeded" | "PlayerTagCountLimitExceeded" | "RequestAlreadyRunning" | "ActionGroupNotFound" | "MaximumSegmentBulkActionJobsRunning" | "NoActionsOnPlayersInSegmentJob" | "DuplicateStatisticName" | "ScheduledTaskNameConflict" | "ScheduledTaskCreateConflict" | "InvalidScheduledTaskName" | "InvalidTaskSchedule" | "SteamNotEnabledForTitle" | "LimitNotAnUpgradeOption" | "NoSecretKeyEnabledForCloudScript" | "TaskNotFound" | "TaskInstanceNotFound" | "InvalidIdentityProviderId" | "MisconfiguredIdentityProvider" | "InvalidScheduledTaskType" | "BillingInformationRequired" | "LimitedEditionItemUnavailable" | "InvalidAdPlacementAndReward" | "AllAdPlacementViewsAlreadyConsumed" | "GoogleOAuthNotConfiguredForTitle" | "GoogleOAuthError" | "UserNotFriend" | "InvalidSignature" | "InvalidPublicKey" | "GoogleOAuthNoIdTokenIncludedInResponse" | "StatisticUpdateInProgress" | "LeaderboardVersionNotAvailable" | "StatisticAlreadyHasPrizeTable" | "PrizeTableHasOverlappingRanks" | "PrizeTableHasMissingRanks" | "PrizeTableRankStartsAtZero" | "InvalidStatistic" | "ExpressionParseFailure" | "ExpressionInvokeFailure" | "ExpressionTooLong" | "DataUpdateRateExceeded" | "RestrictedEmailDomain" | "EncryptionKeyDisabled" | "EncryptionKeyMissing" | "EncryptionKeyBroken" | "NoSharedSecretKeyConfigured" | "SecretKeyNotFound" | "PlayerSecretAlreadyConfigured" | "APIRequestsDisabledForTitle" | "InvalidSharedSecretKey" | "PrizeTableHasNoRanks" | "ProfileDoesNotExist" | "ContentS3OriginBucketNotConfigured" | "InvalidEnvironmentForReceipt" | "EncryptedRequestNotAllowed" | "SignedRequestNotAllowed" | "RequestViewConstraintParamsNotAllowed" | "BadPartnerConfiguration" | "XboxBPCertificateFailure" | "XboxXASSExchangeFailure" | "InvalidEntityId" | "StatisticValueAggregationOverflow" | "EmailMessageFromAddressIsMissing" | "EmailMessageToAddressIsMissing" | "SmtpServerAuthenticationError" | "SmtpServerLimitExceeded" | "SmtpServerInsufficientStorage" | "SmtpServerCommunicationError" | "SmtpServerGeneralFailure" | "EmailClientTimeout" | "EmailClientCanceledTask" | "EmailTemplateMissing" | "InvalidHostForTitleId" | "EmailConfirmationTokenDoesNotExist" | "EmailConfirmationTokenExpired" | "AccountDeleted" | "PlayerSecretNotConfigured" | "InvalidSignatureTime" | "NoContactEmailAddressFound" | "InvalidAuthToken" | "AuthTokenDoesNotExist" | "AuthTokenExpired" | "AuthTokenAlreadyUsedToResetPassword" | "MembershipNameTooLong" | "MembershipNotFound" | "GoogleServiceAccountInvalid" | "GoogleServiceAccountParseFailure" | "EntityTokenMissing" | "EntityTokenInvalid" | "EntityTokenExpired" | "EntityTokenRevoked" | "InvalidProductForSubscription" | "XboxInaccessible" | "SubscriptionAlreadyTaken" | "SmtpAddonNotEnabled" | "APIConcurrentRequestLimitExceeded" | "XboxRejectedXSTSExchangeRequest" | "VariableNotDefined" | "TemplateVersionNotDefined" | "FileTooLarge" | "TitleDeleted" | "TitleContainsUserAccounts" | "TitleDeletionPlayerCleanupFailure" | "EntityFileOperationPending" | "NoEntityFileOperationPending" | "EntityProfileVersionMismatch" | "TemplateVersionTooOld" | "MembershipDefinitionInUse" | "PaymentPageNotConfigured" | "FailedLoginAttemptRateLimitExceeded" | "EntityBlockedByGroup" | "RoleDoesNotExist" | "EntityIsAlreadyMember" | "DuplicateRoleId" | "GroupInvitationNotFound" | "GroupApplicationNotFound" | "OutstandingInvitationAcceptedInstead" | "OutstandingApplicationAcceptedInstead" | "RoleIsGroupDefaultMember" | "RoleIsGroupAdmin" | "RoleNameNotAvailable" | "GroupNameNotAvailable" | "EmailReportAlreadySent" | "EmailReportRecipientBlacklisted" | "EventNamespaceNotAllowed" | "EventEntityNotAllowed" | "InvalidEntityType" | "NullTokenResultFromAad" | "InvalidTokenResultFromAad" | "NoValidCertificateForAad" | "InvalidCertificateForAad" | "DuplicateDropTableId" | "MultiplayerServerError" | "MultiplayerServerTooManyRequests" | "MultiplayerServerNoContent" | "MultiplayerServerBadRequest" | "MultiplayerServerUnauthorized" | "MultiplayerServerForbidden" | "MultiplayerServerNotFound" | "MultiplayerServerConflict" | "MultiplayerServerInternalServerError" | "MultiplayerServerUnavailable" | "ExplicitContentDetected" | "PIIContentDetected" | "InvalidScheduledTaskParameter" | "PerEntityEventRateLimitExceeded" | "TitleDefaultLanguageNotSet" | "EmailTemplateMissingDefaultVersion" | "FacebookInstantGamesIdNotLinked" | "InvalidFacebookInstantGamesSignature" | "FacebookInstantGamesAuthNotConfiguredForTitle" | "EntityProfileConstraintValidationFailed" | "TelemetryIngestionKeyPending" | "TelemetryIngestionKeyNotFound" | "StatisticChildNameInvalid" | "DataIntegrityError" | "VirtualCurrencyCannotBeSetToOlderVersion" | "VirtualCurrencyMustBeWithinIntegerRange" | "EmailTemplateInvalidSyntax" | "EmailTemplateMissingCallback" | "PushNotificationTemplateInvalidPayload" | "InvalidLocalizedPushNotificationLanguage" | "MissingLocalizedPushNotificationMessage" | "PushNotificationTemplateMissingPlatformPayload" | "PushNotificationTemplatePayloadContainsInvalidJson" | "PushNotificationTemplateContainsInvalidIosPayload" | "PushNotificationTemplateContainsInvalidAndroidPayload" | "PushNotificationTemplateIosPayloadMissingNotificationBody" | "PushNotificationTemplateAndroidPayloadMissingNotificationBody" | "PushNotificationTemplateNotFound" | "PushNotificationTemplateMissingDefaultVersion" | "PushNotificationTemplateInvalidSyntax" | "PushNotificationTemplateNoCustomPayloadForV1" | "NoLeaderboardForStatistic" | "TitleNewsMissingDefaultLanguage" | "TitleNewsNotFound" | "TitleNewsDuplicateLanguage" | "TitleNewsMissingTitleOrBody" | "TitleNewsInvalidLanguage" | "EmailRecipientBlacklisted" | "InvalidGameCenterAuthRequest" | "GameCenterAuthenticationFailed" | "CannotEnablePartiesForTitle" | "PartyError" | "PartyRequests" | "PartyNoContent" | "PartyBadRequest" | "PartyUnauthorized" | "PartyForbidden" | "PartyNotFound" | "PartyConflict" | "PartyInternalServerError" | "PartyUnavailable" | "PartyTooManyRequests" | "PushNotificationTemplateMissingName" | "CannotEnableMultiplayerServersForTitle" | "WriteAttemptedDuringExport" | "MultiplayerServerTitleQuotaCoresExceeded" | "AutomationRuleNotFound" | "EntityAPIKeyLimitExceeded" | "EntityAPIKeyNotFound" | "EntityAPIKeyOrSecretInvalid" | "EconomyServiceUnavailable" | "EconomyServiceInternalError" | "QueryRateLimitExceeded" | "EntityAPIKeyCreationDisabledForEntity" | "ForbiddenByEntityPolicy" | "UpdateInventoryRateLimitExceeded" | "StudioCreationRateLimited" | "StudioCreationInProgress" | "DuplicateStudioName" | "StudioNotFound" | "StudioDeleted" | "StudioDeactivated" | "StudioActivated" | "TitleCreationRateLimited" | "TitleCreationInProgress" | "DuplicateTitleName" | "TitleActivationRateLimited" | "TitleActivationInProgress" | "TitleDeactivated" | "TitleActivated" | "CloudScriptAzureFunctionsExecutionTimeLimitExceeded" | "CloudScriptAzureFunctionsArgumentSizeExceeded" | "CloudScriptAzureFunctionsReturnSizeExceeded" | "CloudScriptAzureFunctionsHTTPRequestError" | "VirtualCurrencyBetaGetError" | "VirtualCurrencyBetaCreateError" | "VirtualCurrencyBetaInitialDepositSaveError" | "VirtualCurrencyBetaSaveError" | "VirtualCurrencyBetaDeleteError" | "VirtualCurrencyBetaRestoreError" | "VirtualCurrencyBetaSaveConflict" | "VirtualCurrencyBetaUpdateError" | "InsightsManagementDatabaseNotFound" | "InsightsManagementOperationNotFound" | "InsightsManagementErrorPendingOperationExists" | "InsightsManagementSetPerformanceLevelInvalidParameter" | "InsightsManagementSetStorageRetentionInvalidParameter" | "InsightsManagementGetStorageUsageInvalidParameter" | "InsightsManagementGetOperationStatusInvalidParameter" | "DuplicatePurchaseTransactionId" | "EvaluationModePlayerCountExceeded" | "GetPlayersInSegmentRateLimitExceeded" | "CloudScriptFunctionNameSizeExceeded" | "PaidInsightsFeaturesNotEnabled" | "CloudScriptAzureFunctionsQueueRequestError" | "EvaluationModeTitleCountExceeded" | "InsightsManagementTitleNotInFlight" | "LimitNotFound" | "LimitNotAvailableViaAPI" | "InsightsManagementSetStorageRetentionBelowMinimum" | "InsightsManagementSetStorageRetentionAboveMaximum" | "AppleNotEnabledForTitle" | "InsightsManagementNewActiveEventExportLimitInvalid" | "InsightsManagementSetPerformanceRateLimited" | "PartyRequestsThrottledFromRateLimiter" | "XboxServiceTooManyRequests" | "NintendoSwitchNotEnabledForTitle" | "RequestMultiplayerServersThrottledFromRateLimiter" | "TitleDataOverrideNotFound" | "DuplicateKeys" | "WasNotCreatedWithCloudRoot" | "LegacyMultiplayerServersDeprecated" | "VirtualCurrencyCurrentlyUnavailable" | "SteamUserNotFound" | "ElasticSearchOperationFailed" | "NotImplemented" | "PublisherNotFound" | "PublisherDeleted" | "ApiDisabledForMigration" | "ResourceNameUpdateNotAllowed" | "ApiNotEnabledForTitle" | "DuplicateTitleNameForPublisher" | "AzureTitleCreationInProgress" | "TitleConstraintsPublisherDeletion" | "InvalidPlayerAccountPoolId" | "PlayerAccountPoolNotFound" | "PlayerAccountPoolDeleted" | "TitleCleanupInProgress" | "AzureResourceConcurrentOperationInProgress" | "TitlePublisherUpdateNotAllowed" | "AzureResourceManagerNotSupportedInStamp" | "ApiNotIncludedInAzurePlayFabFeatureSet" | "GoogleServiceAccountFailedAuth" | "GoogleAPIServiceUnavailable" | "GoogleAPIServiceUnknownError" | "NoValidIdentityForAad" | "PlayerIdentityLinkNotFound" | "PhotonApplicationIdAlreadyInUse" | "CloudScriptUnableToDeleteProductionRevision" | "CustomIdNotFound" | "AutomationInvalidInput" | "AutomationInvalidRuleName" | "AutomationRuleAlreadyExists" | "AutomationRuleLimitExceeded" | "InvalidGooglePlayGamesServerAuthCode" | "PlayStreamConnectionFailed" | "InvalidEventContents" | "InsightsV1Deprecated" | "AnalysisSubscriptionNotFound" | "AnalysisSubscriptionFailed" | "AnalysisSubscriptionFoundAlready" | "AnalysisSubscriptionManagementInvalidInput" | "InvalidGameCenterId" | "InvalidNintendoSwitchAccountId" | "EntityAPIKeysNotSupported" | "IpAddressBanned" | "EntityLineageBanned" | "NamespaceMismatch" | "InvalidServiceConfiguration" | "InvalidNamespaceMismatch" | "LeaderboardColumnLengthMismatch" | "InvalidStatisticScore" | "LeaderboardColumnsNotSpecified" | "LeaderboardMaxSizeTooLarge" | "InvalidAttributeStatisticsSpecified" | "LeaderboardNotFound" | "TokenSigningKeyNotFound" | "LeaderboardNameConflict" | "LinkedStatisticColumnMismatch" | "NoLinkedStatisticToLeaderboard" | "StatDefinitionAlreadyLinkedToLeaderboard" | "LinkingStatsNotAllowedForEntityType" | "LeaderboardCountLimitExceeded" | "LeaderboardSizeLimitExceeded" | "LeaderboardDefinitionModificationNotAllowedWhileLinked" | "StatisticDefinitionModificationNotAllowedWhileLinked" | "LeaderboardUpdateNotAllowedWhileLinked" | "CloudScriptAzureFunctionsEventHubRequestError" | "ExternalEntityNotAllowedForTier" | "InvalidBaseTimeForInterval" | "EntityTypeMismatchWithStatDefinition" | "SpecifiedVersionLeaderboardNotFound" | "LeaderboardColumnLengthMismatchWithStatDefinition" | "DuplicateColumnNameFound" | "LinkedStatisticColumnNotFound" | "LinkedStatisticColumnRequired" | "MultipleLinkedStatisticsNotAllowed" | "DuplicateLinkedStatisticColumnNameFound" | "AggregationTypeNotAllowedForMultiColumnStatistic" | "MaxQueryableVersionsValueNotAllowedForTier" | "StatisticDefinitionHasNullOrEmptyVersionConfiguration" | "StatisticColumnLengthMismatch" | "InvalidExternalEntityId" | "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" | "TransactionAlreadyApplied" | "ReportDataNotRetrievedSuccessfully" | "ResetIntervalCannotBeModified" | "VersionIncrementRateExceeded" | "InvalidSteamUsername" | "InvalidVersionResetForLinkedLeaderboard" | "BattleNetNotEnabledForTitle" | "ReportNotProcessed" | "DataNotAvailable" | "InvalidReportName" | "ResourceNotModified" | "StudioCreationLimitExceeded" | "MatchmakingEntityInvalid" | "MatchmakingPlayerAttributesInvalid" | "MatchmakingQueueNotFound" | "MatchmakingMatchNotFound" | "MatchmakingTicketNotFound" | "MatchmakingAlreadyJoinedTicket" | "MatchmakingTicketAlreadyCompleted" | "MatchmakingQueueConfigInvalid" | "MatchmakingMemberProfileInvalid" | "NintendoSwitchDeviceIdNotLinked" | "MatchmakingNotEnabled" | "MatchmakingPlayerAttributesTooLarge" | "MatchmakingNumberOfPlayersInTicketTooLarge" | "MatchmakingAttributeInvalid" | "MatchmakingPlayerHasNotJoinedTicket" | "MatchmakingRateLimitExceeded" | "MatchmakingTicketMembershipLimitExceeded" | "MatchmakingUnauthorized" | "MatchmakingQueueLimitExceeded" | "MatchmakingRequestTypeMismatch" | "MatchmakingBadRequest" | "PubSubFeatureNotEnabledForTitle" | "PubSubTooManyRequests" | "PubSubConnectionNotFoundForEntity" | "PubSubConnectionHandleInvalid" | "PubSubSubscriptionLimitExceeded" | "TitleConfigNotFound" | "TitleConfigUpdateConflict" | "TitleConfigSerializationError" | "CatalogApiNotImplemented" | "CatalogEntityInvalid" | "CatalogTitleIdMissing" | "CatalogPlayerIdMissing" | "CatalogClientIdentityInvalid" | "CatalogOneOrMoreFilesInvalid" | "CatalogItemMetadataInvalid" | "CatalogItemIdInvalid" | "CatalogSearchParameterInvalid" | "CatalogFeatureDisabled" | "CatalogConfigInvalid" | "CatalogItemTypeInvalid" | "CatalogBadRequest" | "CatalogTooManyRequests" | "InvalidCatalogItemConfiguration" | "ExportInvalidStatusUpdate" | "ExportInvalidPrefix" | "ExportBlobContainerDoesNotExist" | "ExportNotFound" | "ExportCouldNotUpdate" | "ExportInvalidStorageType" | "ExportAmazonBucketDoesNotExist" | "ExportInvalidBlobStorage" | "ExportKustoException" | "ExportKustoConnectionFailed" | "ExportUnknownError" | "ExportCantEditPendingExport" | "ExportLimitExports" | "ExportLimitEvents" | "ExportInvalidPartitionStatusModification" | "ExportCouldNotCreate" | "ExportNoBackingDatabaseFound" | "ExportCouldNotDelete" | "ExportCannotDetermineEventQuery" | "ExportInvalidQuerySchemaModification" | "ExportQuerySchemaMissingRequiredColumns" | "ExportCannotParseQuery" | "ExportControlCommandsNotAllowed" | "ExportQueryMissingTableReference" | "ExportInsightsV1Deprecated" | "ExplorerBasicInvalidQueryName" | "ExplorerBasicInvalidQueryDescription" | "ExplorerBasicInvalidQueryConditions" | "ExplorerBasicInvalidQueryStartDate" | "ExplorerBasicInvalidQueryEndDate" | "ExplorerBasicInvalidQueryGroupBy" | "ExplorerBasicInvalidQueryAggregateType" | "ExplorerBasicInvalidQueryAggregateProperty" | "ExplorerBasicLoadQueriesError" | "ExplorerBasicLoadQueryError" | "ExplorerBasicCreateQueryError" | "ExplorerBasicDeleteQueryError" | "ExplorerBasicUpdateQueryError" | "ExplorerBasicSavedQueriesLimit" | "ExplorerBasicSavedQueryNotFound" | "TenantShardMapperShardNotFound" | "TitleNotEnabledForParty" | "PartyVersionNotFound" | "MultiplayerServerBuildReferencedByMatchmakingQueue" | "MultiplayerServerBuildReferencedByBuildAlias" | "MultiplayerServerBuildAliasReferencedByMatchmakingQueue" | "PartySerializationError" | "ExperimentationExperimentStopped" | "ExperimentationExperimentRunning" | "ExperimentationExperimentNotFound" | "ExperimentationExperimentNeverStarted" | "ExperimentationExperimentDeleted" | "ExperimentationClientTimeout" | "ExperimentationInvalidVariantConfiguration" | "ExperimentationInvalidVariableConfiguration" | "ExperimentInvalidId" | "ExperimentationNoScorecard" | "ExperimentationTreatmentAssignmentFailed" | "ExperimentationTreatmentAssignmentDisabled" | "ExperimentationInvalidDuration" | "ExperimentationMaxExperimentsReached" | "ExperimentationExperimentSchedulingInProgress" | "ExperimentationInvalidEndDate" | "ExperimentationInvalidStartDate" | "ExperimentationMaxDurationExceeded" | "ExperimentationExclusionGroupNotFound" | "ExperimentationExclusionGroupInsufficientCapacity" | "ExperimentationExclusionGroupCannotDelete" | "ExperimentationExclusionGroupInvalidTrafficAllocation" | "ExperimentationExclusionGroupInvalidName" | "ExperimentationLegacyExperimentInvalidOperation" | "MaxActionDepthExceeded" | "TitleNotOnUpdatedPricingPlan" | "SegmentManagementTitleNotInFlight" | "SegmentManagementNoExpressionTree" | "SegmentManagementTriggerActionCountOverLimit" | "SegmentManagementSegmentCountOverLimit" | "SegmentManagementInvalidSegmentId" | "SegmentManagementInvalidInput" | "SegmentManagementInvalidSegmentName" | "DeleteSegmentRateLimitExceeded" | "CreateSegmentRateLimitExceeded" | "UpdateSegmentRateLimitExceeded" | "GetSegmentsRateLimitExceeded" | "AsyncExportNotInFlight" | "AsyncExportNotFound" | "AsyncExportRateLimitExceeded" | "AnalyticsSegmentCountOverLimit" | "SnapshotNotFound" | "InventoryApiNotImplemented" | "InventoryCollectionDeletionDisallowed" | "LobbyDoesNotExist" | "LobbyRateLimitExceeded" | "LobbyPlayerAlreadyJoined" | "LobbyNotJoinable" | "LobbyMemberCannotRejoin" | "LobbyCurrentPlayersMoreThanMaxPlayers" | "LobbyPlayerNotPresent" | "LobbyBadRequest" | "LobbyPlayerMaxLobbyLimitExceeded" | "LobbyNewOwnerMustBeConnected" | "LobbyCurrentOwnerStillConnected" | "LobbyMemberIsNotOwner" | "LobbyServerMismatch" | "LobbyServerNotFound" | "LobbyDifferentServerAlreadyJoined" | "LobbyServerAlreadyJoined" | "LobbyIsNotClientOwned" | "LobbyDoesNotUseConnections" | "EventSamplingInvalidRatio" | "EventSamplingInvalidEventNamespace" | "EventSamplingInvalidEventName" | "EventSamplingRatioNotFound" | "TelemetryKeyNotFound" | "TelemetryKeyInvalidName" | "TelemetryKeyAlreadyExists" | "TelemetryKeyInvalid" | "TelemetryKeyCountOverLimit" | "TelemetryKeyDeactivated" | "TelemetryKeyLongInsightsRetentionNotAllowed" | "EventSinkConnectionInvalid" | "EventSinkConnectionUnauthorized" | "EventSinkRegionInvalid" | "EventSinkLimitExceeded" | "EventSinkSasTokenInvalid" | "EventSinkNotFound" | "EventSinkNameInvalid" | "EventSinkSasTokenPermissionInvalid" | "EventSinkSecretInvalid" | "EventSinkTenantNotFound" | "EventSinkAadNotFound" | "EventSinkDatabaseNotFound" | "EventSinkTitleUnauthorized" | "EventSinkInsufficientRoleAssignment" | "EventSinkContainerNotFound" | "EventSinkTenantIdInvalid" | "EventSinkResourceMisconfigured" | "EventSinkAccessDenied" | "EventSinkWriteConflict" | "EventSinkResourceNotFound" | "EventSinkResourceFeatureNotSupported" | "EventSinkBucketNameInvalid" | "EventSinkResourceUnavailable" | "OperationCanceled" | "InvalidDisplayNameRandomSuffixLength" | "AllowNonUniquePlayerDisplayNamesDisableNotAllowed" | "PartitionedEventInvalid" | "PartitionedEventCountOverLimit" | "ManageEventNamespaceInvalid" | "ManageEventNameInvalid" | "ManagedEventNotFound" | "ManageEventsInvalidRatio" | "ManagedEventInvalid" | "PlayerCustomPropertiesPropertyNameTooLong" | "PlayerCustomPropertiesPropertyNameIsInvalid" | "PlayerCustomPropertiesStringPropertyValueTooLong" | "PlayerCustomPropertiesValueIsInvalidType" | "PlayerCustomPropertiesVersionMismatch" | "PlayerCustomPropertiesPropertyCountTooHigh" | "PlayerCustomPropertiesDuplicatePropertyName" | "PlayerCustomPropertiesPropertyDoesNotExist" | "AddonAlreadyExists" | "AddonDoesntExist" | "CopilotDisabled" | "CopilotInvalidRequest" | "TrueSkillUnauthorized" | "TrueSkillInvalidTitleId" | "TrueSkillInvalidScenarioId" | "TrueSkillInvalidModelId" | "TrueSkillInvalidModelName" | "TrueSkillInvalidPlayerIds" | "TrueSkillInvalidEntityKey" | "TrueSkillInvalidConditionKey" | "TrueSkillInvalidConditionValue" | "TrueSkillInvalidConditionAffinityWeight" | "TrueSkillInvalidEventName" | "TrueSkillMatchResultCreated" | "TrueSkillMatchResultAlreadySubmitted" | "TrueSkillBadPlayerIdInMatchResult" | "TrueSkillInvalidBotIdInMatchResult" | "TrueSkillDuplicatePlayerInMatchResult" | "TrueSkillNoPlayerInMatchResultTeam" | "TrueSkillPlayersInMatchResultExceedingLimit" | "TrueSkillInvalidPreMatchPartyInMatchResult" | "TrueSkillInvalidTimestampInMatchResult" | "TrueSkillStartTimeMissingInMatchResult" | "TrueSkillEndTimeMissingInMatchResult" | "TrueSkillInvalidPlayerSecondsPlayedInMatchResult" | "TrueSkillNoTeamInMatchResult" | "TrueSkillNotEnoughTeamsInMatchResult" | "TrueSkillInvalidRanksInMatchResult" | "TrueSkillNoWinnerInMatchResult" | "TrueSkillMissingRequiredCondition" | "TrueSkillMissingRequiredEvent" | "TrueSkillUnknownEventName" | "TrueSkillInvalidEventCount" | "TrueSkillUnknownConditionKey" | "TrueSkillUnknownConditionValue" | "TrueSkillScenarioConfigDoesNotExist" | "TrueSkillUnknownModelId" | "TrueSkillNoModelInScenario" | "TrueSkillNotSupportedForTitle" | "TrueSkillModelIsNotActive" | "TrueSkillUnauthorizedToQueryOtherPlayerSkills" | "TrueSkillInvalidMaxIterations" | "TrueSkillEndTimeBeforeStartTime" | "TrueSkillInvalidJobId" | "TrueSkillInvalidMetadataId" | "TrueSkillMissingBuildVerison" | "TrueSkillJobAlreadyExists" | "TrueSkillJobNotFound" | "TrueSkillOperationCanceled" | "TrueSkillActiveModelLimitExceeded" | "TrueSkillTotalModelLimitExceeded" | "TrueSkillUnknownInitialModelId" | "TrueSkillUnauthorizedForJob" | "TrueSkillInvalidScenarioName" | "TrueSkillConditionStateIsRequired" | "TrueSkillEventStateIsRequired" | "TrueSkillDuplicateEvent" | "TrueSkillDuplicateCondition" | "TrueSkillInvalidAnomalyThreshold" | "TrueSkillConditionKeyLimitExceeded" | "TrueSkillConditionValuePerKeyLimitExceeded" | "TrueSkillInvalidTimestamp" | "TrueSkillEventLimitExceeded" | "TrueSkillInvalidPlayers" | "TrueSkillTrueSkillPlayerNull" | "TrueSkillInvalidPlayerId" | "TrueSkillInvalidSquadSize" | "TrueSkillConditionSetNotInModel" | "TrueSkillModelStateInvalidForOperation" | "TrueSkillScenarioContainsActiveModel" | "TrueSkillInvalidConditionRank" | "TrueSkillTotalScenarioLimitExceeded" | "TrueSkillInvalidConditionsList" | "GameSaveManifestNotFound" | "GameSaveManifestVersionAlreadyExists" | "GameSaveConflictUpdatingManifest" | "GameSaveManifestUpdatesNotAllowed" | "GameSaveFileAlreadyExists" | "GameSaveManifestVersionNotFinalized" | "GameSaveUnknownFileInManifest" | "GameSaveFileExceededReportedSize" | "GameSaveFileNotUploaded" | "GameSaveBadRequest" | "GameSaveOperationNotAllowed" | "GameSaveDataStorageQuotaExceeded" | "GameSaveNewerManifestExists" | "GameSaveBaseVersionNotAvailable" | "GameSaveManifestVersionQuarantined" | "GameSaveManifestUploadProgressUpdateNotAllowed" | "GameSaveNotFinalizedManifestNotEligibleAsKnownGood" | "GameSaveNoUpdatesRequested" | "GameSaveTitleDoesNotExist" | "GameSaveOperationNotAllowedForTitle" | "GameSaveManifestFilesLimitExceeded" | "GameSaveManifestDescriptionUpdateNotAllowed" | "GameSaveTitleConfigNotFound" | "GameSaveTitleAlreadyOnboarded" | "GameSaveServiceNotEnabledForTitle" | "GameSaveServiceOnboardingPending" | "GameSaveManifestNotEligibleAsConflictingVersion" | "GameSaveServiceUnavailable" | "GameSaveConflict" | "GameSaveManifestNotEligibleForRollback" | "StateShareForbidden" | "StateShareTitleNotInFlight" | "StateShareStateNotFound" | "StateShareLinkNotFound" | "StateShareStateRedemptionLimitExceeded" | "StateShareStateRedemptionLimitNotUpdated" | "StateShareCreatedStatesLimitExceeded" | "StateShareIdMissingOrMalformed" | "PlayerCreationDisabled" | "AccountAlreadyExists" | "TagInvalid" | "TagTooLong" | "StatisticColumnAggregationMismatch" | "StatisticResetIntervalMismatch" | "VersionConfigurationCannotBeSpecifiedForLinkedStat" | "VersionConfigurationIsRequired" | "InvalidEntityTypeForAggregation" | "MultiLevelAggregationNotAllowed" | "AggregationTypeNotAllowedForLinkedStat";
|
|
1006
1017
|
/** @deprecated Do not use */
|
|
1007
1018
|
interface GetActionGroupResult {
|
|
1008
1019
|
/** Action Group ID */
|
|
@@ -1146,7 +1157,7 @@ interface GetMatchmakerGameInfoResult extends IPlayFabResultCommon {
|
|
|
1146
1157
|
/** array of unique PlayFab identifiers for users currently connected to this Game Server Instance */
|
|
1147
1158
|
Players?: string[];
|
|
1148
1159
|
/** region in which the Game Server Instance is running */
|
|
1149
|
-
Region?:
|
|
1160
|
+
Region?: Region;
|
|
1150
1161
|
/**
|
|
1151
1162
|
* IPV4 address of the game server instance
|
|
1152
1163
|
* @deprecated Please use ServerIPV4Address instead.
|
|
@@ -1204,7 +1215,7 @@ interface GetPlayerIdFromAuthTokenRequest extends IPlayFabRequestCommon {
|
|
|
1204
1215
|
/** The auth token of the player requesting the password reset. */
|
|
1205
1216
|
Token: string;
|
|
1206
1217
|
/** The type of auth token of the player requesting the password reset. */
|
|
1207
|
-
TokenType:
|
|
1218
|
+
TokenType: AuthTokenType;
|
|
1208
1219
|
}
|
|
1209
1220
|
interface GetPlayerIdFromAuthTokenResult extends IPlayFabResultCommon {
|
|
1210
1221
|
/** The player ID from the token passed in */
|
|
@@ -1371,7 +1382,7 @@ interface GetServerBuildInfoRequest extends IPlayFabRequestCommon {
|
|
|
1371
1382
|
/** @deprecated Do not use */
|
|
1372
1383
|
interface GetServerBuildInfoResult extends IPlayFabResultCommon {
|
|
1373
1384
|
/** array of regions where this build can used, when it is active */
|
|
1374
|
-
ActiveRegions?:
|
|
1385
|
+
ActiveRegions?: Region[];
|
|
1375
1386
|
/** unique identifier for this build executable */
|
|
1376
1387
|
BuildId?: string;
|
|
1377
1388
|
/** developer comment(s) for this build */
|
|
@@ -1386,7 +1397,7 @@ interface GetServerBuildInfoResult extends IPlayFabResultCommon {
|
|
|
1386
1397
|
*/
|
|
1387
1398
|
MinFreeGameSlots: number;
|
|
1388
1399
|
/** the current status of the build validation and processing steps */
|
|
1389
|
-
Status?:
|
|
1400
|
+
Status?: GameBuildStatus;
|
|
1390
1401
|
/** time this build was last modified (or uploaded, if this build has never been modified) */
|
|
1391
1402
|
Timestamp: string;
|
|
1392
1403
|
/**
|
|
@@ -1407,7 +1418,7 @@ interface GetStoreItemsResult extends IPlayFabResultCommon {
|
|
|
1407
1418
|
/** Additional data about the store. */
|
|
1408
1419
|
MarketingData?: StoreMarketingModel;
|
|
1409
1420
|
/** How the store was last updated (Admin or a third party). */
|
|
1410
|
-
Source?:
|
|
1421
|
+
Source?: SourceType;
|
|
1411
1422
|
/** Array of items which can be purchased from this store. */
|
|
1412
1423
|
Store?: StoreItem[];
|
|
1413
1424
|
/** The ID of this store. */
|
|
@@ -1423,7 +1434,7 @@ interface GetTaskInstancesRequest extends IPlayFabRequestCommon {
|
|
|
1423
1434
|
/** Optional range-to filter for task instances' StartedAt timestamp. */
|
|
1424
1435
|
StartedAtRangeTo?: string;
|
|
1425
1436
|
/** Optional filter for task instances that are of a specific status. */
|
|
1426
|
-
StatusFilter?:
|
|
1437
|
+
StatusFilter?: TaskInstanceStatus;
|
|
1427
1438
|
/**
|
|
1428
1439
|
* Name or ID of the task whose instances are being queried. If not specified, return all task instances that satisfy
|
|
1429
1440
|
* conditions set by other filters.
|
|
@@ -1687,13 +1698,13 @@ interface ItemInstance {
|
|
|
1687
1698
|
}
|
|
1688
1699
|
interface LastLoginDateSegmentFilter {
|
|
1689
1700
|
/** Last player login date comparison. */
|
|
1690
|
-
Comparison?:
|
|
1701
|
+
Comparison?: SegmentFilterComparison;
|
|
1691
1702
|
/** Last player login date. */
|
|
1692
1703
|
LogInDate: string;
|
|
1693
1704
|
}
|
|
1694
1705
|
interface LastLoginTimespanSegmentFilter {
|
|
1695
1706
|
/** Last player login duration comparison. */
|
|
1696
|
-
Comparison?:
|
|
1707
|
+
Comparison?: SegmentFilterComparison;
|
|
1697
1708
|
/** Last player login duration. */
|
|
1698
1709
|
DurationInMinutes: number;
|
|
1699
1710
|
}
|
|
@@ -1701,7 +1712,7 @@ interface LinkedPlatformAccountModel {
|
|
|
1701
1712
|
/** Linked account email of the user on the platform, if available */
|
|
1702
1713
|
Email?: string;
|
|
1703
1714
|
/** Authentication platform */
|
|
1704
|
-
Platform?:
|
|
1715
|
+
Platform?: LoginIdentityProvider;
|
|
1705
1716
|
/** Unique account identifier of the user on the platform */
|
|
1706
1717
|
PlatformUserId?: string;
|
|
1707
1718
|
/** Linked account username of the user on the platform, if available */
|
|
@@ -1709,13 +1720,13 @@ interface LinkedPlatformAccountModel {
|
|
|
1709
1720
|
}
|
|
1710
1721
|
interface LinkedUserAccountHasEmailSegmentFilter {
|
|
1711
1722
|
/** Login provider comparison. */
|
|
1712
|
-
Comparison?:
|
|
1723
|
+
Comparison?: SegmentFilterComparison;
|
|
1713
1724
|
/** Login provider. */
|
|
1714
|
-
LoginProvider?:
|
|
1725
|
+
LoginProvider?: SegmentLoginIdentityProvider;
|
|
1715
1726
|
}
|
|
1716
1727
|
interface LinkedUserAccountSegmentFilter {
|
|
1717
1728
|
/** Login provider. */
|
|
1718
|
-
LoginProvider?:
|
|
1729
|
+
LoginProvider?: SegmentLoginIdentityProvider;
|
|
1719
1730
|
}
|
|
1720
1731
|
/** @deprecated Do not use */
|
|
1721
1732
|
interface ListBuildsRequest extends IPlayFabRequestCommon {
|
|
@@ -1756,9 +1767,9 @@ interface LocationModel {
|
|
|
1756
1767
|
/** City name. */
|
|
1757
1768
|
City?: string;
|
|
1758
1769
|
/** The two-character continent code for this location */
|
|
1759
|
-
ContinentCode?:
|
|
1770
|
+
ContinentCode?: ContinentCode;
|
|
1760
1771
|
/** The two-character ISO 3166-1 country code for the country associated with the location */
|
|
1761
|
-
CountryCode?:
|
|
1772
|
+
CountryCode?: CountryCode;
|
|
1762
1773
|
/** Latitude coordinate of the geographic location. */
|
|
1763
1774
|
Latitude?: number;
|
|
1764
1775
|
/** Longitude coordinate of the geographic location. */
|
|
@@ -1766,8 +1777,9 @@ interface LocationModel {
|
|
|
1766
1777
|
}
|
|
1767
1778
|
interface LocationSegmentFilter {
|
|
1768
1779
|
/** Segment country code. */
|
|
1769
|
-
CountryCode?:
|
|
1780
|
+
CountryCode?: SegmentCountryCode;
|
|
1770
1781
|
}
|
|
1782
|
+
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";
|
|
1771
1783
|
interface LogStatement {
|
|
1772
1784
|
/** Optional object accompanying the message as contextual information */
|
|
1773
1785
|
Data?: any;
|
|
@@ -1819,7 +1831,7 @@ interface ModifyMatchmakerGameModesResult extends IPlayFabResultCommon {
|
|
|
1819
1831
|
/** @deprecated Do not use */
|
|
1820
1832
|
interface ModifyServerBuildRequest extends IPlayFabRequestCommon {
|
|
1821
1833
|
/** array of regions where this build can used, when it is active */
|
|
1822
|
-
ActiveRegions?:
|
|
1834
|
+
ActiveRegions?: Region[];
|
|
1823
1835
|
/** unique identifier of the previously uploaded build executable to be updated */
|
|
1824
1836
|
BuildId: string;
|
|
1825
1837
|
/** appended to the end of the command line when starting game servers */
|
|
@@ -1843,7 +1855,7 @@ interface ModifyServerBuildRequest extends IPlayFabRequestCommon {
|
|
|
1843
1855
|
/** @deprecated Do not use */
|
|
1844
1856
|
interface ModifyServerBuildResult extends IPlayFabResultCommon {
|
|
1845
1857
|
/** array of regions where this build can used, when it is active */
|
|
1846
|
-
ActiveRegions?:
|
|
1858
|
+
ActiveRegions?: Region[];
|
|
1847
1859
|
/** unique identifier for this build executable */
|
|
1848
1860
|
BuildId?: string;
|
|
1849
1861
|
/** appended to the end of the command line when starting game servers */
|
|
@@ -1860,7 +1872,7 @@ interface ModifyServerBuildResult extends IPlayFabResultCommon {
|
|
|
1860
1872
|
*/
|
|
1861
1873
|
MinFreeGameSlots: number;
|
|
1862
1874
|
/** the current status of the build validation and processing steps */
|
|
1863
|
-
Status?:
|
|
1875
|
+
Status?: GameBuildStatus;
|
|
1864
1876
|
/** time this build was last modified (or uploaded, if this build has never been modified) */
|
|
1865
1877
|
Timestamp: string;
|
|
1866
1878
|
/**
|
|
@@ -1922,7 +1934,7 @@ interface PermissionStatement {
|
|
|
1922
1934
|
/** A comment about the statement. Intended solely for bookkeeping and debugging. */
|
|
1923
1935
|
Comment?: string;
|
|
1924
1936
|
/** The effect this statement will have. It could be either Allow or Deny */
|
|
1925
|
-
Effect:
|
|
1937
|
+
Effect: EffectType;
|
|
1926
1938
|
/** The principal this statement will effect. The only supported principal is '*'. */
|
|
1927
1939
|
Principal: string;
|
|
1928
1940
|
/**
|
|
@@ -1933,27 +1945,27 @@ interface PermissionStatement {
|
|
|
1933
1945
|
}
|
|
1934
1946
|
interface PlayerChurnPredictionSegmentFilter {
|
|
1935
1947
|
/** Comparison */
|
|
1936
|
-
Comparison?:
|
|
1948
|
+
Comparison?: SegmentFilterComparison;
|
|
1937
1949
|
/** RiskLevel */
|
|
1938
|
-
RiskLevel?:
|
|
1950
|
+
RiskLevel?: ChurnRiskLevel;
|
|
1939
1951
|
}
|
|
1940
1952
|
interface PlayerChurnPredictionTimeSegmentFilter {
|
|
1941
1953
|
/** Comparison */
|
|
1942
|
-
Comparison?:
|
|
1954
|
+
Comparison?: SegmentFilterComparison;
|
|
1943
1955
|
/** DurationInDays */
|
|
1944
1956
|
DurationInDays: number;
|
|
1945
1957
|
}
|
|
1946
1958
|
interface PlayerChurnPreviousPredictionSegmentFilter {
|
|
1947
1959
|
/** Comparison */
|
|
1948
|
-
Comparison?:
|
|
1960
|
+
Comparison?: SegmentFilterComparison;
|
|
1949
1961
|
/** RiskLevel */
|
|
1950
|
-
RiskLevel?:
|
|
1962
|
+
RiskLevel?: ChurnRiskLevel;
|
|
1951
1963
|
}
|
|
1952
1964
|
interface PlayerLinkedAccount {
|
|
1953
1965
|
/** Linked account's email */
|
|
1954
1966
|
Email?: string;
|
|
1955
1967
|
/** Authentication platform */
|
|
1956
|
-
Platform?:
|
|
1968
|
+
Platform?: LoginIdentityProvider;
|
|
1957
1969
|
/** Platform user identifier */
|
|
1958
1970
|
PlatformUserId?: string;
|
|
1959
1971
|
/** Linked account's username */
|
|
@@ -1963,9 +1975,9 @@ interface PlayerLocation {
|
|
|
1963
1975
|
/** City of the player's geographic location. */
|
|
1964
1976
|
City?: string;
|
|
1965
1977
|
/** The two-character continent code for this location */
|
|
1966
|
-
ContinentCode:
|
|
1978
|
+
ContinentCode: ContinentCode;
|
|
1967
1979
|
/** The two-character ISO 3166-1 country code for the country associated with the location */
|
|
1968
|
-
CountryCode:
|
|
1980
|
+
CountryCode: CountryCode;
|
|
1969
1981
|
/** Latitude coordinate of the player's geographic location. */
|
|
1970
1982
|
Latitude?: number;
|
|
1971
1983
|
/** Longitude coordinate of the player's geographic location. */
|
|
@@ -1979,7 +1991,7 @@ interface PlayerProfile {
|
|
|
1979
1991
|
/** Banned until UTC Date. If permanent ban this is set for 20 years after the original ban date. */
|
|
1980
1992
|
BannedUntil?: string;
|
|
1981
1993
|
/** The prediction of the player to churn within the next seven days. */
|
|
1982
|
-
ChurnPrediction?:
|
|
1994
|
+
ChurnPrediction?: ChurnRiskLevel;
|
|
1983
1995
|
/** Array of contact email addresses associated with the player */
|
|
1984
1996
|
ContactEmailAddresses?: ContactEmailInfo[];
|
|
1985
1997
|
/** Player record created */
|
|
@@ -1995,7 +2007,7 @@ interface PlayerProfile {
|
|
|
1995
2007
|
/** Dictionary of player's locations by type. */
|
|
1996
2008
|
Locations?: Record<string, PlayerLocation>;
|
|
1997
2009
|
/** Player account origination */
|
|
1998
|
-
Origination?:
|
|
2010
|
+
Origination?: LoginIdentityProvider;
|
|
1999
2011
|
/** List of player variants for experimentation */
|
|
2000
2012
|
PlayerExperimentVariants?: string[];
|
|
2001
2013
|
/** PlayFab Player ID */
|
|
@@ -2047,7 +2059,7 @@ interface PlayerProfileModel {
|
|
|
2047
2059
|
/** List of memberships for the player, along with whether are expired. */
|
|
2048
2060
|
Memberships?: MembershipModel[];
|
|
2049
2061
|
/** Player account origination */
|
|
2050
|
-
Origination?:
|
|
2062
|
+
Origination?: LoginIdentityProvider;
|
|
2051
2063
|
/** PlayFab player account unique identifier */
|
|
2052
2064
|
PlayerId?: string;
|
|
2053
2065
|
/** Publisher this player belongs to */
|
|
@@ -2116,13 +2128,13 @@ interface PlayerStatistic {
|
|
|
2116
2128
|
}
|
|
2117
2129
|
interface PlayerStatisticDefinition {
|
|
2118
2130
|
/** the aggregation method to use in updating the statistic (defaults to last) */
|
|
2119
|
-
AggregationMethod?:
|
|
2131
|
+
AggregationMethod?: StatisticAggregationMethod;
|
|
2120
2132
|
/** current active version of the statistic, incremented each time the statistic resets */
|
|
2121
2133
|
CurrentVersion: number;
|
|
2122
2134
|
/** unique name of the statistic */
|
|
2123
2135
|
StatisticName?: string;
|
|
2124
2136
|
/** interval at which the values of the statistic for all players are reset automatically */
|
|
2125
|
-
VersionChangeInterval?:
|
|
2137
|
+
VersionChangeInterval?: StatisticResetIntervalOption;
|
|
2126
2138
|
}
|
|
2127
2139
|
interface PlayerStatisticVersion {
|
|
2128
2140
|
/** time when the statistic version became active */
|
|
@@ -2131,7 +2143,7 @@ interface PlayerStatisticVersion {
|
|
|
2131
2143
|
* status of the process of saving player statistic values of the previous version to a downloadable archive
|
|
2132
2144
|
* @deprecated Please use Status instead.
|
|
2133
2145
|
*/
|
|
2134
|
-
ArchivalStatus?:
|
|
2146
|
+
ArchivalStatus?: StatisticVersionArchivalStatus;
|
|
2135
2147
|
/** URL for the downloadable archive of player statistic values, if available */
|
|
2136
2148
|
ArchiveDownloadUrl?: string;
|
|
2137
2149
|
/** time when the statistic version became inactive due to statistic version incrementing */
|
|
@@ -2143,7 +2155,7 @@ interface PlayerStatisticVersion {
|
|
|
2143
2155
|
/** name of the statistic when the version became active */
|
|
2144
2156
|
StatisticName?: string;
|
|
2145
2157
|
/** status of the statistic version */
|
|
2146
|
-
Status?:
|
|
2158
|
+
Status?: StatisticVersionStatus;
|
|
2147
2159
|
/** version of the statistic */
|
|
2148
2160
|
Version: number;
|
|
2149
2161
|
}
|
|
@@ -2155,17 +2167,18 @@ interface PushNotificationContent {
|
|
|
2155
2167
|
/** Subject of message to send (may not be displayed in all platforms) */
|
|
2156
2168
|
Subject?: string;
|
|
2157
2169
|
}
|
|
2170
|
+
type PushNotificationPlatform = "ApplePushNotificationService" | "GoogleCloudMessaging";
|
|
2158
2171
|
interface PushNotificationRegistration {
|
|
2159
2172
|
/** Notification configured endpoint */
|
|
2160
2173
|
NotificationEndpointARN?: string;
|
|
2161
2174
|
/** Push notification platform */
|
|
2162
|
-
Platform?:
|
|
2175
|
+
Platform?: PushNotificationPlatform;
|
|
2163
2176
|
}
|
|
2164
2177
|
interface PushNotificationRegistrationModel {
|
|
2165
2178
|
/** Notification configured endpoint */
|
|
2166
2179
|
NotificationEndpointARN?: string;
|
|
2167
2180
|
/** Push notification platform */
|
|
2168
|
-
Platform?:
|
|
2181
|
+
Platform?: PushNotificationPlatform;
|
|
2169
2182
|
}
|
|
2170
2183
|
interface PushNotificationSegmentAction {
|
|
2171
2184
|
/** Push notification template id. */
|
|
@@ -2173,8 +2186,9 @@ interface PushNotificationSegmentAction {
|
|
|
2173
2186
|
}
|
|
2174
2187
|
interface PushNotificationSegmentFilter {
|
|
2175
2188
|
/** Push notification device platform. */
|
|
2176
|
-
PushNotificationDevicePlatform?:
|
|
2189
|
+
PushNotificationDevicePlatform?: SegmentPushNotificationDevicePlatform;
|
|
2177
2190
|
}
|
|
2191
|
+
type PushSetupPlatform = "GCM" | "APNS" | "APNS_SANDBOX";
|
|
2178
2192
|
interface RandomResultTable {
|
|
2179
2193
|
/** Child nodes that indicate what kind of drop table item this actually is. */
|
|
2180
2194
|
Nodes: ResultTableNode[];
|
|
@@ -2205,6 +2219,7 @@ interface RefundPurchaseResponse extends IPlayFabResultCommon {
|
|
|
2205
2219
|
/** The order's updated purchase status. */
|
|
2206
2220
|
PurchaseStatus?: string;
|
|
2207
2221
|
}
|
|
2222
|
+
type Region = "USCentral" | "USEast" | "EUWest" | "Singapore" | "Japan" | "Brazil" | "Australia";
|
|
2208
2223
|
interface RemovePlayerTagRequest extends IPlayFabRequestCommon {
|
|
2209
2224
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
2210
2225
|
CustomTags?: Record<string, string | null>;
|
|
@@ -2262,6 +2277,7 @@ interface ResetUserStatisticsRequest extends IPlayFabRequestCommon {
|
|
|
2262
2277
|
}
|
|
2263
2278
|
interface ResetUserStatisticsResult extends IPlayFabResultCommon {
|
|
2264
2279
|
}
|
|
2280
|
+
type ResolutionOutcome = "Revoke" | "Reinstate" | "Manual";
|
|
2265
2281
|
interface ResolvePurchaseDisputeRequest extends IPlayFabRequestCommon {
|
|
2266
2282
|
/** Unique order ID for the purchase in question. */
|
|
2267
2283
|
OrderId: string;
|
|
@@ -2269,7 +2285,7 @@ interface ResolvePurchaseDisputeRequest extends IPlayFabRequestCommon {
|
|
|
2269
2285
|
* Enum for the desired purchase result state after notifying the payment provider. Valid values are Revoke, Reinstate and
|
|
2270
2286
|
* Manual. Manual will cause no change to the order state.
|
|
2271
2287
|
*/
|
|
2272
|
-
Outcome:
|
|
2288
|
+
Outcome: ResolutionOutcome;
|
|
2273
2289
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
|
2274
2290
|
PlayFabId: string;
|
|
2275
2291
|
/**
|
|
@@ -2287,10 +2303,11 @@ interface ResultTableNode {
|
|
|
2287
2303
|
/** Either an ItemId, or the TableId of another random result table */
|
|
2288
2304
|
ResultItem: string;
|
|
2289
2305
|
/** Whether this entry in the table is an item or a link to another table */
|
|
2290
|
-
ResultItemType:
|
|
2306
|
+
ResultItemType: ResultTableNodeType;
|
|
2291
2307
|
/** How likely this is to be rolled - larger numbers add more weight */
|
|
2292
2308
|
Weight: number;
|
|
2293
2309
|
}
|
|
2310
|
+
type ResultTableNodeType = "ItemId" | "TableId";
|
|
2294
2311
|
interface RevokeAllBansForUserRequest extends IPlayFabRequestCommon {
|
|
2295
2312
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
|
2296
2313
|
PlayFabId: string;
|
|
@@ -2335,7 +2352,7 @@ interface RevokeInventoryResult extends IPlayFabResultCommon {
|
|
|
2335
2352
|
}
|
|
2336
2353
|
interface RevokeItemError {
|
|
2337
2354
|
/** Specific error that was encountered. */
|
|
2338
|
-
Error?:
|
|
2355
|
+
Error?: GenericErrorCodes;
|
|
2339
2356
|
/** Item information that failed to be revoked. */
|
|
2340
2357
|
Item?: RevokeInventoryItem;
|
|
2341
2358
|
}
|
|
@@ -2373,8 +2390,9 @@ interface ScheduledTask {
|
|
|
2373
2390
|
/** ID of the task */
|
|
2374
2391
|
TaskId?: string;
|
|
2375
2392
|
/** Task type. */
|
|
2376
|
-
Type?:
|
|
2393
|
+
Type?: ScheduledTaskType;
|
|
2377
2394
|
}
|
|
2395
|
+
type ScheduledTaskType = "CloudScript" | "ActionsOnPlayerSegment" | "CloudScriptAzureFunctions" | "InsightsScheduledScaling";
|
|
2378
2396
|
interface ScriptExecutionError {
|
|
2379
2397
|
/**
|
|
2380
2398
|
* Error code, such as CloudScriptNotFound, JavascriptException, CloudScriptFunctionArgumentSizeExceeded,
|
|
@@ -2436,6 +2454,10 @@ interface SegmentAndDefinition {
|
|
|
2436
2454
|
/** Filter property for virtual currency. */
|
|
2437
2455
|
VirtualCurrencyBalanceFilter?: VirtualCurrencyBalanceSegmentFilter;
|
|
2438
2456
|
}
|
|
2457
|
+
type SegmentCountryCode = "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";
|
|
2458
|
+
type SegmentCurrency = "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";
|
|
2459
|
+
type SegmentFilterComparison = "GreaterThan" | "LessThan" | "EqualTo" | "NotEqualTo" | "GreaterThanOrEqual" | "LessThanOrEqual" | "Exists" | "Contains" | "NotContains";
|
|
2460
|
+
type SegmentLoginIdentityProvider = "Unknown" | "PlayFab" | "Custom" | "GameCenter" | "GooglePlay" | "Steam" | "XBoxLive" | "PSN" | "Kongregate" | "Facebook" | "IOSDevice" | "AndroidDevice" | "Twitch" | "WindowsHello" | "GameServer" | "CustomServer" | "NintendoSwitch" | "FacebookInstantGames" | "OpenIdConnect" | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames";
|
|
2439
2461
|
interface SegmentModel {
|
|
2440
2462
|
/** Segment description. */
|
|
2441
2463
|
Description?: string;
|
|
@@ -2456,6 +2478,7 @@ interface SegmentOrDefinition {
|
|
|
2456
2478
|
/** List of segment and definitions. */
|
|
2457
2479
|
SegmentAndDefinitions?: SegmentAndDefinition[];
|
|
2458
2480
|
}
|
|
2481
|
+
type SegmentPushNotificationDevicePlatform = "ApplePushNotificationService" | "GoogleCloudMessaging";
|
|
2459
2482
|
interface SegmentTrigger {
|
|
2460
2483
|
/** Add inventory item v2 segment trigger action. */
|
|
2461
2484
|
AddInventoryItemsV2Action?: AddInventoryItemsV2SegmentAction;
|
|
@@ -2583,7 +2606,7 @@ interface SetupPushNotificationRequest extends IPlayFabRequestCommon {
|
|
|
2583
2606
|
* supported notification platforms are Apple Push Notification Service (APNS and APNS_SANDBOX) for iOS and Google Cloud
|
|
2584
2607
|
* Messaging (GCM) for Android
|
|
2585
2608
|
*/
|
|
2586
|
-
Platform:
|
|
2609
|
+
Platform: PushSetupPlatform;
|
|
2587
2610
|
}
|
|
2588
2611
|
interface SetupPushNotificationResult extends IPlayFabResultCommon {
|
|
2589
2612
|
/** Amazon Resource Name for the created notification topic. */
|
|
@@ -2597,6 +2620,8 @@ interface SharedSecret {
|
|
|
2597
2620
|
/** The player shared secret to use when calling Client/GetTitlePublicKey */
|
|
2598
2621
|
SecretKey?: string;
|
|
2599
2622
|
}
|
|
2623
|
+
type SourceType = "Admin" | "BackEnd" | "GameClient" | "GameServer" | "Partner" | "Custom" | "API";
|
|
2624
|
+
type StatisticAggregationMethod = "Last" | "Min" | "Max" | "Sum";
|
|
2600
2625
|
interface StatisticModel {
|
|
2601
2626
|
/** Statistic name */
|
|
2602
2627
|
Name?: string;
|
|
@@ -2605,9 +2630,10 @@ interface StatisticModel {
|
|
|
2605
2630
|
/** Statistic version (0 if not a versioned statistic) */
|
|
2606
2631
|
Version: number;
|
|
2607
2632
|
}
|
|
2633
|
+
type StatisticResetIntervalOption = "Never" | "Hour" | "Day" | "Week" | "Month";
|
|
2608
2634
|
interface StatisticSegmentFilter {
|
|
2609
2635
|
/** Statistic filter comparison. */
|
|
2610
|
-
Comparison?:
|
|
2636
|
+
Comparison?: SegmentFilterComparison;
|
|
2611
2637
|
/** Statistic filter value. */
|
|
2612
2638
|
FilterValue?: string;
|
|
2613
2639
|
/** Statistic name. */
|
|
@@ -2617,6 +2643,8 @@ interface StatisticSegmentFilter {
|
|
|
2617
2643
|
/** Statistic version. */
|
|
2618
2644
|
Version?: number;
|
|
2619
2645
|
}
|
|
2646
|
+
type StatisticVersionArchivalStatus = "NotScheduled" | "Scheduled" | "Queued" | "InProgress" | "Complete";
|
|
2647
|
+
type StatisticVersionStatus = "Active" | "SnapshotPending" | "Snapshot" | "ArchivalPending" | "Archived";
|
|
2620
2648
|
interface StoreItem {
|
|
2621
2649
|
/** Store specific custom data. The data only exists as part of this store; it is not transferred to item instances */
|
|
2622
2650
|
CustomData?: any;
|
|
@@ -2648,7 +2676,7 @@ interface SubscriptionModel {
|
|
|
2648
2676
|
/** Whether this subscription is currently active. That is, if Expiration > now. */
|
|
2649
2677
|
IsActive: boolean;
|
|
2650
2678
|
/** The status of this subscription, according to the subscription provider. */
|
|
2651
|
-
Status?:
|
|
2679
|
+
Status?: SubscriptionProviderStatus;
|
|
2652
2680
|
/** The id for this subscription */
|
|
2653
2681
|
SubscriptionId?: string;
|
|
2654
2682
|
/** The item id for this subscription from the primary catalog */
|
|
@@ -2656,6 +2684,7 @@ interface SubscriptionModel {
|
|
|
2656
2684
|
/** The provider for this subscription. Apple or Google Play are supported today. */
|
|
2657
2685
|
SubscriptionProvider?: string;
|
|
2658
2686
|
}
|
|
2687
|
+
type SubscriptionProviderStatus = "NoError" | "Cancelled" | "UnknownError" | "BillingError" | "ProductUnavailable" | "CustomerDidNotAcceptPriceChange" | "FreeTrial" | "PaymentPending";
|
|
2659
2688
|
interface SubtractInventoryItemsV2SegmentAction {
|
|
2660
2689
|
/** Amount of the item to removed from the player */
|
|
2661
2690
|
Amount?: number;
|
|
@@ -2696,7 +2725,7 @@ interface TagModel {
|
|
|
2696
2725
|
}
|
|
2697
2726
|
interface TagSegmentFilter {
|
|
2698
2727
|
/** Tag comparison. */
|
|
2699
|
-
Comparison?:
|
|
2728
|
+
Comparison?: SegmentFilterComparison;
|
|
2700
2729
|
/** Tag value. */
|
|
2701
2730
|
TagValue?: string;
|
|
2702
2731
|
}
|
|
@@ -2714,14 +2743,16 @@ interface TaskInstanceBasicSummary {
|
|
|
2714
2743
|
/** UTC timestamp when the task started. */
|
|
2715
2744
|
StartedAt: string;
|
|
2716
2745
|
/** Current status of the task instance. */
|
|
2717
|
-
Status?:
|
|
2746
|
+
Status?: TaskInstanceStatus;
|
|
2718
2747
|
/** Identifier of the task this instance belongs to. */
|
|
2719
2748
|
TaskIdentifier?: NameIdentifier;
|
|
2720
2749
|
/** ID of the task instance. */
|
|
2721
2750
|
TaskInstanceId?: string;
|
|
2722
2751
|
/** Type of the task. */
|
|
2723
|
-
Type?:
|
|
2752
|
+
Type?: ScheduledTaskType;
|
|
2724
2753
|
}
|
|
2754
|
+
type TaskInstanceStatus = "Succeeded" | "Starting" | "InProgress" | "Failed" | "Aborted" | "Stalled";
|
|
2755
|
+
type TitleActivationStatus = "None" | "ActivatedTitleKey" | "PendingSteam" | "ActivatedSteam" | "RevokedSteam";
|
|
2725
2756
|
interface TitleDataKeyValue {
|
|
2726
2757
|
/**
|
|
2727
2758
|
* Key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same
|
|
@@ -2735,7 +2766,7 @@ interface TotalValueToDateInUSDSegmentFilter {
|
|
|
2735
2766
|
/** Total value to date USD amount. */
|
|
2736
2767
|
Amount?: string;
|
|
2737
2768
|
/** Total value to date USD comparison. */
|
|
2738
|
-
Comparison?:
|
|
2769
|
+
Comparison?: SegmentFilterComparison;
|
|
2739
2770
|
}
|
|
2740
2771
|
interface UpdateBanRequest {
|
|
2741
2772
|
/** The updated active state for the ban. Null for no change. */
|
|
@@ -2762,7 +2793,7 @@ interface UpdateBanRequest {
|
|
|
2762
2793
|
/** The updated reason for the ban to be updated. Maximum 140 characters. Null for no change. */
|
|
2763
2794
|
Reason?: string;
|
|
2764
2795
|
/** The updated family type of the user that should be included in the ban. Null for no change. */
|
|
2765
|
-
UserFamilyType?:
|
|
2796
|
+
UserFamilyType?: UserFamilyType;
|
|
2766
2797
|
}
|
|
2767
2798
|
interface UpdateBansRequest extends IPlayFabRequestCommon {
|
|
2768
2799
|
/** List of bans to be updated. Maximum 100. */
|
|
@@ -2861,14 +2892,14 @@ interface UpdatePlayerSharedSecretResult extends IPlayFabResultCommon {
|
|
|
2861
2892
|
}
|
|
2862
2893
|
interface UpdatePlayerStatisticDefinitionRequest extends IPlayFabRequestCommon {
|
|
2863
2894
|
/** the aggregation method to use in updating the statistic (defaults to last) */
|
|
2864
|
-
AggregationMethod?:
|
|
2895
|
+
AggregationMethod?: StatisticAggregationMethod;
|
|
2865
2896
|
/** unique name of the statistic */
|
|
2866
2897
|
StatisticName: string;
|
|
2867
2898
|
/**
|
|
2868
2899
|
* interval at which the values of the statistic for all players are reset (changes are effective at the next occurance of
|
|
2869
2900
|
* the new interval boundary)
|
|
2870
2901
|
*/
|
|
2871
|
-
VersionChangeInterval?:
|
|
2902
|
+
VersionChangeInterval?: StatisticResetIntervalOption;
|
|
2872
2903
|
}
|
|
2873
2904
|
interface UpdatePlayerStatisticDefinitionResult extends IPlayFabResultCommon {
|
|
2874
2905
|
/** updated statistic definition */
|
|
@@ -2949,7 +2980,7 @@ interface UpdateTaskRequest extends IPlayFabRequestCommon {
|
|
|
2949
2980
|
/** Cron expression for the run schedule of the task. The expression should be in UTC. */
|
|
2950
2981
|
Schedule?: string;
|
|
2951
2982
|
/** Task type. */
|
|
2952
|
-
Type:
|
|
2983
|
+
Type: ScheduledTaskType;
|
|
2953
2984
|
}
|
|
2954
2985
|
interface UpdateUserDataRequest extends IPlayFabRequestCommon {
|
|
2955
2986
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
|
@@ -2965,7 +2996,7 @@ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
|
|
|
2965
2996
|
*/
|
|
2966
2997
|
KeysToRemove?: string[];
|
|
2967
2998
|
/** Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. */
|
|
2968
|
-
Permission?:
|
|
2999
|
+
Permission?: UserDataPermission;
|
|
2969
3000
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
|
2970
3001
|
PlayFabId: string;
|
|
2971
3002
|
}
|
|
@@ -3082,6 +3113,7 @@ interface UserCustomIdInfo {
|
|
|
3082
3113
|
/** Custom ID */
|
|
3083
3114
|
CustomId?: string;
|
|
3084
3115
|
}
|
|
3116
|
+
type UserDataPermission = "Private" | "Public";
|
|
3085
3117
|
interface UserDataRecord {
|
|
3086
3118
|
/** Timestamp for when this data was last updated. */
|
|
3087
3119
|
LastUpdated: string;
|
|
@@ -3089,7 +3121,7 @@ interface UserDataRecord {
|
|
|
3089
3121
|
* Indicates whether this data can be read by all users (public) or only the user (private). This is used for GetUserData
|
|
3090
3122
|
* requests being made by one player about another player.
|
|
3091
3123
|
*/
|
|
3092
|
-
Permission?:
|
|
3124
|
+
Permission?: UserDataPermission;
|
|
3093
3125
|
/** Data stored for the specified user data key. */
|
|
3094
3126
|
Value?: string;
|
|
3095
3127
|
}
|
|
@@ -3103,6 +3135,7 @@ interface UserFacebookInstantGamesIdInfo {
|
|
|
3103
3135
|
/** Facebook Instant Games ID */
|
|
3104
3136
|
FacebookInstantGamesId?: string;
|
|
3105
3137
|
}
|
|
3138
|
+
type UserFamilyType = "None" | "Xbox" | "Steam";
|
|
3106
3139
|
interface UserGameCenterInfo {
|
|
3107
3140
|
/** Gamecenter identifier */
|
|
3108
3141
|
GameCenterId?: string;
|
|
@@ -3153,9 +3186,10 @@ interface UserOpenIdInfo {
|
|
|
3153
3186
|
/** OpenID Subject */
|
|
3154
3187
|
Subject?: string;
|
|
3155
3188
|
}
|
|
3189
|
+
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";
|
|
3156
3190
|
interface UserOriginationSegmentFilter {
|
|
3157
3191
|
/** User login provider. */
|
|
3158
|
-
LoginProvider?:
|
|
3192
|
+
LoginProvider?: SegmentLoginIdentityProvider;
|
|
3159
3193
|
}
|
|
3160
3194
|
interface UserPrivateAccountInfo {
|
|
3161
3195
|
/** user email address */
|
|
@@ -3173,11 +3207,11 @@ interface UserServerCustomIdInfo {
|
|
|
3173
3207
|
}
|
|
3174
3208
|
interface UserSteamInfo {
|
|
3175
3209
|
/** what stage of game ownership the user is listed as being in, from Steam */
|
|
3176
|
-
SteamActivationStatus?:
|
|
3210
|
+
SteamActivationStatus?: TitleActivationStatus;
|
|
3177
3211
|
/** the country in which the player resides, from Steam data */
|
|
3178
3212
|
SteamCountry?: string;
|
|
3179
3213
|
/** currency type set in the user Steam account */
|
|
3180
|
-
SteamCurrency?:
|
|
3214
|
+
SteamCurrency?: Currency;
|
|
3181
3215
|
/** Steam identifier */
|
|
3182
3216
|
SteamId?: string;
|
|
3183
3217
|
/** Steam display name */
|
|
@@ -3203,7 +3237,7 @@ interface UserTitleInfo {
|
|
|
3203
3237
|
/** timestamp for the last user login for this title */
|
|
3204
3238
|
LastLogin?: string;
|
|
3205
3239
|
/** source by which the user first joined the game, if known */
|
|
3206
|
-
Origination?:
|
|
3240
|
+
Origination?: UserOrigination;
|
|
3207
3241
|
/** Title player account entity for this user */
|
|
3208
3242
|
TitlePlayerAccount?: EntityKey;
|
|
3209
3243
|
}
|
|
@@ -3237,15 +3271,15 @@ interface ValueToDateSegmentFilter {
|
|
|
3237
3271
|
/** Value to date amount. */
|
|
3238
3272
|
Amount?: string;
|
|
3239
3273
|
/** Value to date comparison. */
|
|
3240
|
-
Comparison?:
|
|
3274
|
+
Comparison?: SegmentFilterComparison;
|
|
3241
3275
|
/** Currency using for filter. */
|
|
3242
|
-
Currency?:
|
|
3276
|
+
Currency?: SegmentCurrency;
|
|
3243
3277
|
}
|
|
3244
3278
|
interface VirtualCurrencyBalanceSegmentFilter {
|
|
3245
3279
|
/** Total amount. */
|
|
3246
3280
|
Amount: number;
|
|
3247
3281
|
/** Amount comparison. */
|
|
3248
|
-
Comparison?:
|
|
3282
|
+
Comparison?: SegmentFilterComparison;
|
|
3249
3283
|
/** Currency code. */
|
|
3250
3284
|
CurrencyCode?: string;
|
|
3251
3285
|
}
|