async-playfab-web-sdk 1.192.250526-1

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.
Files changed (54) hide show
  1. package/dist/Addon.d.ts +591 -0
  2. package/dist/Addon.js +452 -0
  3. package/dist/Addon.js.map +1 -0
  4. package/dist/Admin.d.ts +3484 -0
  5. package/dist/Admin.js +1112 -0
  6. package/dist/Admin.js.map +1 -0
  7. package/dist/Authentication.d.ts +109 -0
  8. package/dist/Authentication.js +290 -0
  9. package/dist/Authentication.js.map +1 -0
  10. package/dist/Client.d.ts +4482 -0
  11. package/dist/Client.js +1893 -0
  12. package/dist/Client.js.map +1 -0
  13. package/dist/CloudScript.d.ts +511 -0
  14. package/dist/CloudScript.js +349 -0
  15. package/dist/CloudScript.js.map +1 -0
  16. package/dist/Data.d.ts +228 -0
  17. package/dist/Data.js +291 -0
  18. package/dist/Data.js.map +1 -0
  19. package/dist/Economy.d.ts +1865 -0
  20. package/dist/Economy.js +614 -0
  21. package/dist/Economy.js.map +1 -0
  22. package/dist/Events.d.ts +307 -0
  23. package/dist/Events.js +327 -0
  24. package/dist/Events.js.map +1 -0
  25. package/dist/Experimentation.d.ts +357 -0
  26. package/dist/Experimentation.js +333 -0
  27. package/dist/Experimentation.js.map +1 -0
  28. package/dist/Groups.d.ts +546 -0
  29. package/dist/Groups.js +417 -0
  30. package/dist/Groups.js.map +1 -0
  31. package/dist/Insights.d.ts +141 -0
  32. package/dist/Insights.js +286 -0
  33. package/dist/Insights.js.map +1 -0
  34. package/dist/Localization.d.ts +20 -0
  35. package/dist/Localization.js +249 -0
  36. package/dist/Localization.js.map +1 -0
  37. package/dist/Multiplayer.d.ts +3059 -0
  38. package/dist/Multiplayer.js +862 -0
  39. package/dist/Multiplayer.js.map +1 -0
  40. package/dist/PlayFabCommon-BUv4zqXf.d.ts +72 -0
  41. package/dist/Profiles.d.ts +278 -0
  42. package/dist/Profiles.js +306 -0
  43. package/dist/Profiles.js.map +1 -0
  44. package/dist/Progression.d.ts +598 -0
  45. package/dist/Progression.js +404 -0
  46. package/dist/Progression.js.map +1 -0
  47. package/dist/Server.d.ts +3889 -0
  48. package/dist/Server.js +1377 -0
  49. package/dist/Server.js.map +1 -0
  50. package/dist/index.d.ts +17 -0
  51. package/dist/index.js +6007 -0
  52. package/dist/index.js.map +1 -0
  53. package/package.json +23 -0
  54. package/readme.md +25 -0
@@ -0,0 +1,3484 @@
1
+ import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BUv4zqXf.js';
2
+
3
+ interface AbortTaskInstanceRequest extends IPlayFabRequestCommon {
4
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
5
+ CustomTags?: Record<string, string | null>;
6
+ /** ID of a task instance that is being aborted. */
7
+ TaskInstanceId: string;
8
+ }
9
+ interface Action {
10
+ /** Action content to add inventory item v2 */
11
+ AddInventoryItemV2Content?: AddInventoryItemV2Content;
12
+ /** Action content to ban player */
13
+ BanPlayerContent?: BanPlayerContent;
14
+ /** Action content to delete inventory item v2 */
15
+ DeleteInventoryItemV2Content?: DeleteInventoryItemV2Content;
16
+ /** Action content to delete player */
17
+ DeletePlayerContent?: DeletePlayerContent;
18
+ /** Action content to execute cloud script */
19
+ ExecuteCloudScriptContent?: ExecuteCloudScriptContent;
20
+ /** Action content to execute azure function */
21
+ ExecuteFunctionContent?: ExecuteFunctionContent;
22
+ /** Action content to grant item */
23
+ GrantItemContent?: GrantItemContent;
24
+ /** Action content to grant virtual currency */
25
+ GrantVirtualCurrencyContent?: GrantVirtualCurrencyContent;
26
+ /** Action content to increment player statistic */
27
+ IncrementPlayerStatisticContent?: IncrementPlayerStatisticContent;
28
+ /** Action content to send push notification */
29
+ PushNotificationContent?: PushNotificationContent;
30
+ /** Action content to send email */
31
+ SendEmailContent?: SendEmailContent;
32
+ /** Action content to subtract inventory item v2 */
33
+ SubtractInventoryItemV2Content?: SubtractInventoryItemV2Content;
34
+ }
35
+ interface ActionsOnPlayersInSegmentTaskParameter {
36
+ /** List of actions to perform on each player in a segment. Each action object can contain only one action type. */
37
+ Actions?: Action[];
38
+ /** ID of the segment to perform actions on. */
39
+ SegmentId: string;
40
+ }
41
+ interface ActionsOnPlayersInSegmentTaskSummary {
42
+ /** UTC timestamp when the task completed. */
43
+ CompletedAt?: string;
44
+ /** Error message for last processing attempt, if an error occured. */
45
+ ErrorMessage?: string;
46
+ /** Flag indicating if the error was fatal, if false job will be retried. */
47
+ ErrorWasFatal?: boolean;
48
+ /** Estimated time remaining in seconds. */
49
+ EstimatedSecondsRemaining?: number;
50
+ /** Progress represented as percentage. */
51
+ PercentComplete?: number;
52
+ /** If manually scheduled, ID of user who scheduled the task. */
53
+ ScheduledByUserId?: string;
54
+ /** UTC timestamp when the task started. */
55
+ StartedAt: string;
56
+ /** Current status of the task instance. */
57
+ Status?: string;
58
+ /** Identifier of the task this instance belongs to. */
59
+ TaskIdentifier?: NameIdentifier;
60
+ /** ID of the task instance. */
61
+ TaskInstanceId?: string;
62
+ /** Total players in segment when task was started. */
63
+ TotalPlayersInSegment?: number;
64
+ /** Total number of players that have had the actions applied to. */
65
+ TotalPlayersProcessed?: number;
66
+ }
67
+ interface AdCampaignAttribution {
68
+ /** UTC time stamp of attribution */
69
+ AttributedAt: string;
70
+ /** Attribution campaign identifier */
71
+ CampaignId?: string;
72
+ /** Attribution network name */
73
+ Platform?: string;
74
+ }
75
+ interface AdCampaignAttributionModel {
76
+ /** UTC time stamp of attribution */
77
+ AttributedAt: string;
78
+ /** Attribution campaign identifier */
79
+ CampaignId?: string;
80
+ /** Attribution network name */
81
+ Platform?: string;
82
+ }
83
+ interface AdCampaignSegmentFilter {
84
+ /** Campaign id. */
85
+ CampaignId?: string;
86
+ /** Campaign source. */
87
+ CampaignSource?: string;
88
+ /** Campaign comparison. */
89
+ Comparison?: string;
90
+ }
91
+ interface AddInventoryItemsV2SegmentAction {
92
+ /** Amount of the item to be granted to a player */
93
+ Amount?: number;
94
+ /** The collection id for where the item will be granted in the player inventory */
95
+ CollectionId?: string;
96
+ /** The duration in seconds of the subscription to be granted to a player */
97
+ DurationInSeconds?: number;
98
+ /** The id of item to be granted to the player */
99
+ ItemId?: string;
100
+ /** The stack id for where the item will be granted in the player inventory */
101
+ StackId?: string;
102
+ }
103
+ interface AddInventoryItemV2Content {
104
+ /** Amount of the item to be granted to a player */
105
+ Amount?: number;
106
+ /** The collection id for where the item will be granted in the player inventory */
107
+ CollectionId?: string;
108
+ /** The duration in seconds of the subscription to be granted to a player */
109
+ DurationInSeconds?: number;
110
+ /** The id of item to be granted to the player */
111
+ ItemId?: string;
112
+ /** The stack id for where the item will be granted in the player inventory */
113
+ StackId?: string;
114
+ }
115
+ interface AddLocalizedNewsRequest extends IPlayFabRequestCommon {
116
+ /** Localized body text of the news. */
117
+ Body: string;
118
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
119
+ CustomTags?: Record<string, string | null>;
120
+ /** Language of the news item. */
121
+ Language: string;
122
+ /** Unique id of the updated news item. */
123
+ NewsId: string;
124
+ /** Localized title (headline) of the news item. */
125
+ Title: string;
126
+ }
127
+ interface AddLocalizedNewsResult extends IPlayFabResultCommon {
128
+ }
129
+ interface AddNewsRequest extends IPlayFabRequestCommon {
130
+ /** Default body text of the news. */
131
+ Body: string;
132
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
133
+ CustomTags?: Record<string, string | null>;
134
+ /** Time this news was published. If not set, defaults to now. */
135
+ Timestamp?: string;
136
+ /** Default title (headline) of the news item. */
137
+ Title: string;
138
+ }
139
+ interface AddNewsResult extends IPlayFabResultCommon {
140
+ /** Unique id of the new news item */
141
+ NewsId?: string;
142
+ }
143
+ interface AddPlayerTagRequest extends IPlayFabRequestCommon {
144
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
145
+ CustomTags?: Record<string, string | null>;
146
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
147
+ PlayFabId: string;
148
+ /** Unique tag for player profile. */
149
+ TagName: string;
150
+ }
151
+ interface AddPlayerTagResult extends IPlayFabResultCommon {
152
+ }
153
+ interface AddUserVirtualCurrencyRequest extends IPlayFabRequestCommon {
154
+ /**
155
+ * Amount to be added to the user balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647).
156
+ * Any increase over this value will be discarded.
157
+ */
158
+ Amount: number;
159
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
160
+ CustomTags?: Record<string, string | null>;
161
+ /** PlayFab unique identifier of the user whose virtual currency balance is to be increased. */
162
+ PlayFabId: string;
163
+ /** Name of the virtual currency which is to be incremented. */
164
+ VirtualCurrency: string;
165
+ }
166
+ interface AddVirtualCurrencyTypesRequest extends IPlayFabRequestCommon {
167
+ /**
168
+ * List of virtual currencies and their initial deposits (the amount a user is granted when signing in for the first time)
169
+ * to the title
170
+ */
171
+ VirtualCurrencies: VirtualCurrencyData[];
172
+ }
173
+ interface AllPlayersSegmentFilter {
174
+ }
175
+ interface ApiCondition {
176
+ /** Require that API calls contain an RSA encrypted payload or signed headers. */
177
+ HasSignatureOrEncryption?: string;
178
+ }
179
+ interface BanInfo {
180
+ /** The active state of this ban. Expired bans may still have this value set to true but they will have no effect. */
181
+ Active: boolean;
182
+ /** The unique Ban Id associated with this ban. */
183
+ BanId?: string;
184
+ /** The time when this ban was applied. */
185
+ Created?: string;
186
+ /** The time when this ban expires. Permanent bans do not have expiration date. */
187
+ Expires?: string;
188
+ /** The IP address on which the ban was applied. May affect multiple players. */
189
+ IPAddress?: string;
190
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
191
+ PlayFabId?: string;
192
+ /** The reason why this ban was applied. */
193
+ Reason?: string;
194
+ /** The family type of the user that is included in the ban. */
195
+ UserFamilyType?: string;
196
+ }
197
+ interface BanPlayerContent {
198
+ /** Duration(in hours) to ban a player. If not provided, the player will be banned permanently. */
199
+ BanDurationHours?: number;
200
+ /** Reason to ban a player */
201
+ BanReason?: string;
202
+ }
203
+ interface BanPlayerSegmentAction {
204
+ /** Ban hours duration. */
205
+ BanHours?: number;
206
+ /** Reason for ban. */
207
+ ReasonForBan?: string;
208
+ }
209
+ interface BanRequest {
210
+ /** The duration in hours for the ban. Leave this blank for a permanent ban. */
211
+ DurationInHours?: number;
212
+ /** IP address to be banned. May affect multiple players. */
213
+ IPAddress?: string;
214
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
215
+ PlayFabId: string;
216
+ /** The reason for this ban. Maximum 140 characters. */
217
+ Reason?: string;
218
+ /** The family type of the user that should be included in the ban if applicable. May affect multiple players. */
219
+ UserFamilyType?: string;
220
+ }
221
+ interface BanUsersRequest extends IPlayFabRequestCommon {
222
+ /** List of ban requests to be applied. Maximum 100. */
223
+ Bans: BanRequest[];
224
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
225
+ CustomTags?: Record<string, string | null>;
226
+ }
227
+ interface BanUsersResult extends IPlayFabResultCommon {
228
+ /** Information on the bans that were applied */
229
+ BanData?: BanInfo[];
230
+ }
231
+ interface BlankResult extends IPlayFabResultCommon {
232
+ }
233
+ interface CatalogItem {
234
+ /**
235
+ * defines the bundle properties for the item - bundles are items which contain other items, including random drop tables
236
+ * and virtual currencies
237
+ */
238
+ Bundle?: CatalogItemBundleInfo;
239
+ /** if true, then an item instance of this type can be used to grant a character to a user. */
240
+ CanBecomeCharacter: boolean;
241
+ /** catalog version for this item */
242
+ CatalogVersion?: string;
243
+ /** defines the consumable properties (number of uses, timeout) for the item */
244
+ Consumable?: CatalogItemConsumableInfo;
245
+ /**
246
+ * defines the container properties for the item - what items it contains, including random drop tables and virtual
247
+ * currencies, and what item (if any) is required to open it via the UnlockContainerItem API
248
+ */
249
+ Container?: CatalogItemContainerInfo;
250
+ /** game specific custom data */
251
+ CustomData?: string;
252
+ /** text description of item, to show in-game */
253
+ Description?: string;
254
+ /** text name for the item, to show in-game */
255
+ DisplayName?: string;
256
+ /**
257
+ * If the item has IsLImitedEdition set to true, and this is the first time this ItemId has been defined as a limited
258
+ * edition item, this value determines the total number of instances to allocate for the title. Once this limit has been
259
+ * reached, no more instances of this ItemId can be created, and attempts to purchase or grant it will return a Result of
260
+ * false for that ItemId. If the item has already been defined to have a limited edition count, or if this value is less
261
+ * than zero, it will be ignored.
262
+ */
263
+ InitialLimitedEditionCount: number;
264
+ /** BETA: If true, then only a fixed number can ever be granted. */
265
+ IsLimitedEdition: boolean;
266
+ /**
267
+ * if true, then only one item instance of this type will exist and its remaininguses will be incremented instead.
268
+ * RemainingUses will cap out at Int32.Max (2,147,483,647). All subsequent increases will be discarded
269
+ */
270
+ IsStackable: boolean;
271
+ /** if true, then an item instance of this type can be traded between players using the trading APIs */
272
+ IsTradable: boolean;
273
+ /** class to which the item belongs */
274
+ ItemClass?: string;
275
+ /** unique identifier for this item */
276
+ ItemId: string;
277
+ /**
278
+ * URL to the item image. For Facebook purchase to display the image on the item purchase page, this must be set to an HTTP
279
+ * URL.
280
+ */
281
+ ItemImageUrl?: string;
282
+ /** override prices for this item for specific currencies */
283
+ RealCurrencyPrices?: Record<string, number>;
284
+ /** list of item tags */
285
+ Tags?: string[];
286
+ /** price of this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
287
+ VirtualCurrencyPrices?: Record<string, number>;
288
+ }
289
+ interface CatalogItemBundleInfo {
290
+ /** unique ItemId values for all items which will be added to the player inventory when the bundle is added */
291
+ BundledItems?: string[];
292
+ /**
293
+ * unique TableId values for all RandomResultTable objects which are part of the bundle (random tables will be resolved and
294
+ * add the relevant items to the player inventory when the bundle is added)
295
+ */
296
+ BundledResultTables?: string[];
297
+ /** virtual currency types and balances which will be added to the player inventory when the bundle is added */
298
+ BundledVirtualCurrencies?: Record<string, number>;
299
+ }
300
+ interface CatalogItemConsumableInfo {
301
+ /** number of times this object can be used, after which it will be removed from the player inventory */
302
+ UsageCount?: number;
303
+ /**
304
+ * duration in seconds for how long the item will remain in the player inventory - once elapsed, the item will be removed
305
+ * (recommended minimum value is 5 seconds, as lower values can cause the item to expire before operations depending on
306
+ * this item's details have completed)
307
+ */
308
+ UsagePeriod?: number;
309
+ /**
310
+ * all inventory item instances in the player inventory sharing a non-null UsagePeriodGroup have their UsagePeriod values
311
+ * added together, and share the result - when that period has elapsed, all the items in the group will be removed
312
+ */
313
+ UsagePeriodGroup?: string;
314
+ }
315
+ interface CatalogItemContainerInfo {
316
+ /** unique ItemId values for all items which will be added to the player inventory, once the container has been unlocked */
317
+ ItemContents?: string[];
318
+ /**
319
+ * ItemId for the catalog item used to unlock the container, if any (if not specified, a call to UnlockContainerItem will
320
+ * open the container, adding the contents to the player inventory and currency balances)
321
+ */
322
+ KeyItemId?: string;
323
+ /**
324
+ * unique TableId values for all RandomResultTable objects which are part of the container (once unlocked, random tables
325
+ * will be resolved and add the relevant items to the player inventory)
326
+ */
327
+ ResultTableContents?: string[];
328
+ /** virtual currency types and balances which will be added to the player inventory when the container is unlocked */
329
+ VirtualCurrencyContents?: Record<string, number>;
330
+ }
331
+ interface CheckLimitedEditionItemAvailabilityRequest extends IPlayFabRequestCommon {
332
+ /** Which catalog is being updated. If null, uses the default catalog. */
333
+ CatalogVersion?: string;
334
+ /** The item to check for. */
335
+ ItemId: string;
336
+ }
337
+ interface CheckLimitedEditionItemAvailabilityResult extends IPlayFabResultCommon {
338
+ /** The amount of the specified resource remaining. */
339
+ Amount: number;
340
+ }
341
+ interface ChurnPredictionSegmentFilter {
342
+ /** Comparison */
343
+ Comparison?: string;
344
+ /** RiskLevel */
345
+ RiskLevel?: string;
346
+ }
347
+ interface CloudScriptFile {
348
+ /** Contents of the Cloud Script javascript. Must be string-escaped javascript. */
349
+ FileContents: string;
350
+ /**
351
+ * Name of the javascript file. These names are not used internally by the server, they are only for developer
352
+ * organizational purposes.
353
+ */
354
+ Filename: string;
355
+ }
356
+ interface CloudScriptTaskParameter {
357
+ /** Argument to pass to the CloudScript function. */
358
+ Argument?: any;
359
+ /** Name of the CloudScript function to execute. */
360
+ FunctionName?: string;
361
+ }
362
+ interface CloudScriptTaskSummary {
363
+ /** UTC timestamp when the task completed. */
364
+ CompletedAt?: string;
365
+ /** Estimated time remaining in seconds. */
366
+ EstimatedSecondsRemaining?: number;
367
+ /** Progress represented as percentage. */
368
+ PercentComplete?: number;
369
+ /** Result of CloudScript execution */
370
+ Result?: ExecuteCloudScriptResult;
371
+ /** If manually scheduled, ID of user who scheduled the task. */
372
+ ScheduledByUserId?: string;
373
+ /** UTC timestamp when the task started. */
374
+ StartedAt: string;
375
+ /** Current status of the task instance. */
376
+ Status?: string;
377
+ /** Identifier of the task this instance belongs to. */
378
+ TaskIdentifier?: NameIdentifier;
379
+ /** ID of the task instance. */
380
+ TaskInstanceId?: string;
381
+ }
382
+ interface CloudScriptVersionStatus {
383
+ /** Most recent revision for this Cloud Script version */
384
+ LatestRevision: number;
385
+ /** Published code revision for this Cloud Script version */
386
+ PublishedRevision: number;
387
+ /** Version number */
388
+ Version: number;
389
+ }
390
+ interface ContactEmailInfo {
391
+ /** The email address */
392
+ EmailAddress?: string;
393
+ /** The name of the email info data */
394
+ Name?: string;
395
+ /** The verification status of the email */
396
+ VerificationStatus?: string;
397
+ }
398
+ interface ContactEmailInfoModel {
399
+ /** The email address */
400
+ EmailAddress?: string;
401
+ /** The name of the email info data */
402
+ Name?: string;
403
+ /** The verification status of the email */
404
+ VerificationStatus?: string;
405
+ }
406
+ interface ContentInfo {
407
+ /** Key of the content */
408
+ Key?: string;
409
+ /** Last modified time */
410
+ LastModified: string;
411
+ /** Size of the content in bytes */
412
+ Size: number;
413
+ }
414
+ interface CreateActionsOnPlayerSegmentTaskRequest extends IPlayFabRequestCommon {
415
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
416
+ CustomTags?: Record<string, string | null>;
417
+ /** Description the task */
418
+ Description?: string;
419
+ /** Whether the schedule is active. Inactive schedule will not trigger task execution. */
420
+ IsActive: boolean;
421
+ /** Name of the task. This is a unique identifier for tasks in the title. */
422
+ Name: string;
423
+ /** Task details related to segment and action */
424
+ Parameter: ActionsOnPlayersInSegmentTaskParameter;
425
+ /** Cron expression for the run schedule of the task. The expression should be in UTC. */
426
+ Schedule?: string;
427
+ }
428
+ interface CreateCloudScriptTaskRequest extends IPlayFabRequestCommon {
429
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
430
+ CustomTags?: Record<string, string | null>;
431
+ /** Description the task */
432
+ Description?: string;
433
+ /** Whether the schedule is active. Inactive schedule will not trigger task execution. */
434
+ IsActive: boolean;
435
+ /** Name of the task. This is a unique identifier for tasks in the title. */
436
+ Name: string;
437
+ /** Task details related to CloudScript */
438
+ Parameter: CloudScriptTaskParameter;
439
+ /** Cron expression for the run schedule of the task. The expression should be in UTC. */
440
+ Schedule?: string;
441
+ }
442
+ interface CreateInsightsScheduledScalingTaskRequest extends IPlayFabRequestCommon {
443
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
444
+ CustomTags?: Record<string, string | null>;
445
+ /** Description the task */
446
+ Description?: string;
447
+ /** Whether the schedule is active. Inactive schedule will not trigger task execution. */
448
+ IsActive: boolean;
449
+ /** Name of the task. This is a unique identifier for tasks in the title. */
450
+ Name: string;
451
+ /** Task details related to Insights Scaling */
452
+ Parameter: InsightsScalingTaskParameter;
453
+ /** Cron expression for the run schedule of the task. The expression should be in UTC. */
454
+ Schedule?: string;
455
+ }
456
+ interface CreateOpenIdConnectionRequest extends IPlayFabRequestCommon {
457
+ /** The client ID given by the ID provider. */
458
+ ClientId: string;
459
+ /** The client secret given by the ID provider. */
460
+ ClientSecret: string;
461
+ /** A name for the connection that identifies it within the title. */
462
+ ConnectionId: string;
463
+ /** Ignore 'nonce' claim in identity tokens. */
464
+ IgnoreNonce?: boolean;
465
+ /**
466
+ * The discovery document URL to read issuer information from. This must be the absolute URL to the JSON OpenId
467
+ * Configuration document and must be accessible from the internet. If you don't know it, try your issuer URL followed by
468
+ * "/.well-known/openid-configuration". For example, if the issuer is https://example.com, try
469
+ * https://example.com/.well-known/openid-configuration
470
+ */
471
+ IssuerDiscoveryUrl?: string;
472
+ /** Manually specified information for an OpenID Connect issuer. */
473
+ IssuerInformation?: OpenIdIssuerInformation;
474
+ /** Override the issuer name for user indexing and lookup. */
475
+ IssuerOverride?: string;
476
+ }
477
+ interface CreatePlayerSharedSecretRequest extends IPlayFabRequestCommon {
478
+ /** Friendly name for this key */
479
+ FriendlyName?: string;
480
+ }
481
+ interface CreatePlayerSharedSecretResult extends IPlayFabResultCommon {
482
+ /** The player shared secret to use when calling Client/GetTitlePublicKey */
483
+ SecretKey?: string;
484
+ }
485
+ interface CreatePlayerStatisticDefinitionRequest extends IPlayFabRequestCommon {
486
+ /** the aggregation method to use in updating the statistic (defaults to last) */
487
+ AggregationMethod?: string;
488
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
489
+ CustomTags?: Record<string, string | null>;
490
+ /** unique name of the statistic */
491
+ StatisticName: string;
492
+ /** interval at which the values of the statistic for all players are reset (resets begin at the next interval boundary) */
493
+ VersionChangeInterval?: string;
494
+ }
495
+ interface CreatePlayerStatisticDefinitionResult extends IPlayFabResultCommon {
496
+ /** created statistic definition */
497
+ Statistic?: PlayerStatisticDefinition;
498
+ }
499
+ interface CreateSegmentRequest extends IPlayFabRequestCommon {
500
+ /** Segment model with all of the segment properties data. */
501
+ SegmentModel: SegmentModel;
502
+ }
503
+ interface CreateSegmentResponse extends IPlayFabResultCommon {
504
+ /** Error message. */
505
+ ErrorMessage?: string;
506
+ /** Segment id. */
507
+ SegmentId?: string;
508
+ }
509
+ interface CreateTaskResult extends IPlayFabResultCommon {
510
+ /** ID of the task */
511
+ TaskId?: string;
512
+ }
513
+ interface CustomPropertyBooleanSegmentFilter {
514
+ /** Custom property comparison. */
515
+ Comparison?: string;
516
+ /** Custom property name. */
517
+ PropertyName?: string;
518
+ /** Custom property boolean value. */
519
+ PropertyValue: boolean;
520
+ }
521
+ interface CustomPropertyDateTimeSegmentFilter {
522
+ /** Custom property comparison. */
523
+ Comparison?: string;
524
+ /** Custom property name. */
525
+ PropertyName?: string;
526
+ /** Custom property datetime value. */
527
+ PropertyValue: string;
528
+ }
529
+ interface CustomPropertyDetails {
530
+ /** The custom property's name. */
531
+ Name?: string;
532
+ /** The custom property's value. */
533
+ Value?: any;
534
+ }
535
+ interface CustomPropertyNumericSegmentFilter {
536
+ /** Custom property comparison. */
537
+ Comparison?: string;
538
+ /** Custom property name. */
539
+ PropertyName?: string;
540
+ /** Custom property numeric value. */
541
+ PropertyValue: number;
542
+ }
543
+ interface CustomPropertyStringSegmentFilter {
544
+ /** Custom property comparison. */
545
+ Comparison?: string;
546
+ /** Custom property name. */
547
+ PropertyName?: string;
548
+ /** Custom property string value. */
549
+ PropertyValue?: string;
550
+ }
551
+ interface DeleteContentRequest extends IPlayFabRequestCommon {
552
+ /** Key of the content item to be deleted */
553
+ Key: string;
554
+ }
555
+ interface DeletedPropertyDetails {
556
+ /** The name of the property which was requested to be deleted. */
557
+ Name?: string;
558
+ /** Indicates whether or not the property was deleted. If false, no property with that name existed. */
559
+ WasDeleted: boolean;
560
+ }
561
+ interface DeleteInventoryItemsV2SegmentAction {
562
+ /** The collection id for where the item will be removed from the player inventory */
563
+ CollectionId?: string;
564
+ /** The id of item to be removed from the player */
565
+ ItemId?: string;
566
+ /** The stack id for where the item will be removed from the player inventory */
567
+ StackId?: string;
568
+ }
569
+ interface DeleteInventoryItemV2Content {
570
+ /** The collection id for where the item will be removed from the player inventory */
571
+ CollectionId?: string;
572
+ /** The id of item to be removed from the player */
573
+ ItemId?: string;
574
+ /** The stack id for where the item will be removed from the player inventory */
575
+ StackId?: string;
576
+ }
577
+ interface DeleteMasterPlayerAccountRequest extends IPlayFabRequestCommon {
578
+ /** Developer created string to identify a user without PlayFab ID */
579
+ MetaData?: string;
580
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
581
+ PlayFabId: string;
582
+ }
583
+ interface DeleteMasterPlayerAccountResult extends IPlayFabResultCommon {
584
+ /**
585
+ * A notification email with this job receipt Id will be sent to the title notification email address when deletion is
586
+ * complete.
587
+ */
588
+ JobReceiptId?: string;
589
+ /** List of titles from which the player's data will be deleted. */
590
+ TitleIds?: string[];
591
+ }
592
+ interface DeleteMasterPlayerEventDataRequest extends IPlayFabRequestCommon {
593
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
594
+ PlayFabId: string;
595
+ }
596
+ interface DeleteMasterPlayerEventDataResult extends IPlayFabResultCommon {
597
+ }
598
+ interface DeleteMembershipSubscriptionRequest extends IPlayFabRequestCommon {
599
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
600
+ CustomTags?: Record<string, string | null>;
601
+ /** Id of the membership to apply the override expiration date to. */
602
+ MembershipId: string;
603
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
604
+ PlayFabId: string;
605
+ /** Id of the subscription that should be deleted from the membership. */
606
+ SubscriptionId: string;
607
+ }
608
+ interface DeleteMembershipSubscriptionResult extends IPlayFabResultCommon {
609
+ }
610
+ interface DeleteOpenIdConnectionRequest extends IPlayFabRequestCommon {
611
+ /** unique name of the connection */
612
+ ConnectionId: string;
613
+ }
614
+ interface DeletePlayerContent {
615
+ }
616
+ interface DeletePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
617
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
618
+ CustomTags?: Record<string, string | null>;
619
+ /**
620
+ * Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the
621
+ * player's properties have not been updated by any other clients since the last version.
622
+ */
623
+ ExpectedPropertiesVersion?: number;
624
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
625
+ PlayFabId: string;
626
+ /** A list of property names denoting which properties should be deleted. */
627
+ PropertyNames: string[];
628
+ }
629
+ interface DeletePlayerCustomPropertiesResult extends IPlayFabResultCommon {
630
+ /** The list of properties requested to be deleted. */
631
+ DeletedProperties?: DeletedPropertyDetails[];
632
+ /** PlayFab unique identifier of the user whose properties were deleted. */
633
+ PlayFabId?: string;
634
+ /**
635
+ * Indicates the current version of a player's properties that have been set. This is incremented after updates and
636
+ * deletes. This version can be provided in update and delete calls for concurrency control.
637
+ */
638
+ PropertiesVersion: number;
639
+ }
640
+ interface DeletePlayerRequest extends IPlayFabRequestCommon {
641
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
642
+ PlayFabId: string;
643
+ }
644
+ interface DeletePlayerResult extends IPlayFabResultCommon {
645
+ }
646
+ interface DeletePlayerSegmentAction {
647
+ }
648
+ interface DeletePlayerSharedSecretRequest extends IPlayFabRequestCommon {
649
+ /** The shared secret key to delete */
650
+ SecretKey?: string;
651
+ }
652
+ interface DeletePlayerSharedSecretResult extends IPlayFabResultCommon {
653
+ }
654
+ interface DeletePlayerStatisticSegmentAction {
655
+ /** Statistic name. */
656
+ StatisticName?: string;
657
+ }
658
+ interface DeleteSegmentRequest extends IPlayFabRequestCommon {
659
+ /** Segment id. */
660
+ SegmentId: string;
661
+ }
662
+ interface DeleteSegmentsResponse extends IPlayFabResultCommon {
663
+ /** Error message. */
664
+ ErrorMessage?: string;
665
+ }
666
+ interface DeleteStoreRequest extends IPlayFabRequestCommon {
667
+ /** catalog version of the store to delete. If null, uses the default catalog. */
668
+ CatalogVersion?: string;
669
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
670
+ CustomTags?: Record<string, string | null>;
671
+ /** unqiue identifier for the store which is to be deleted */
672
+ StoreId: string;
673
+ }
674
+ interface DeleteStoreResult extends IPlayFabResultCommon {
675
+ }
676
+ interface DeleteTaskRequest extends IPlayFabRequestCommon {
677
+ /** Specify either the task ID or the name of task to be deleted. */
678
+ Identifier?: NameIdentifier;
679
+ }
680
+ interface DeleteTitleDataOverrideRequest extends IPlayFabRequestCommon {
681
+ /** Name of the override. */
682
+ OverrideLabel: string;
683
+ }
684
+ interface DeleteTitleDataOverrideResult extends IPlayFabResultCommon {
685
+ }
686
+ interface DeleteTitleRequest extends IPlayFabRequestCommon {
687
+ }
688
+ interface DeleteTitleResult extends IPlayFabResultCommon {
689
+ }
690
+ interface EmailNotificationSegmentAction {
691
+ /** Email template id. */
692
+ EmailTemplateId?: string;
693
+ /** Email template name. */
694
+ EmailTemplateName?: string;
695
+ }
696
+ interface EntityKey {
697
+ /** Unique ID of the entity. */
698
+ Id: string;
699
+ /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
700
+ Type?: string;
701
+ }
702
+ interface ExecuteAzureFunctionSegmentAction {
703
+ /** Azure function. */
704
+ AzureFunction?: string;
705
+ /** Azure function parameter. */
706
+ FunctionParameter?: any;
707
+ /** Generate play stream event. */
708
+ GenerateFunctionExecutedEvents: boolean;
709
+ }
710
+ interface ExecuteCloudScriptContent {
711
+ /** Arguments(JSON) to be passed into the cloudscript method */
712
+ CloudScriptMethodArguments: string;
713
+ /** Cloudscript method name */
714
+ CloudScriptMethodName: string;
715
+ /** Publish cloudscript results as playstream event */
716
+ PublishResultsToPlayStream: boolean;
717
+ }
718
+ interface ExecuteCloudScriptResult {
719
+ /** Number of PlayFab API requests issued by the CloudScript function */
720
+ APIRequestsIssued: number;
721
+ /** Information about the error, if any, that occurred during execution */
722
+ Error?: ScriptExecutionError;
723
+ ExecutionTimeSeconds: number;
724
+ /** The name of the function that executed */
725
+ FunctionName?: string;
726
+ /** The object returned from the CloudScript function, if any */
727
+ FunctionResult?: any;
728
+ /**
729
+ * Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. This only occurs if
730
+ * the total event size is larger than 350KB.
731
+ */
732
+ FunctionResultTooLarge?: boolean;
733
+ /** Number of external HTTP requests issued by the CloudScript function */
734
+ HttpRequestsIssued: number;
735
+ /**
736
+ * Entries logged during the function execution. These include both entries logged in the function code using log.info()
737
+ * and log.error() and error entries for API and HTTP request failures.
738
+ */
739
+ Logs?: LogStatement[];
740
+ /**
741
+ * Flag indicating if the logs were too large and were subsequently dropped from this event. This only occurs if the total
742
+ * event size is larger than 350KB after the FunctionResult was removed.
743
+ */
744
+ LogsTooLarge?: boolean;
745
+ MemoryConsumedBytes: number;
746
+ /**
747
+ * Processor time consumed while executing the function. This does not include time spent waiting on API calls or HTTP
748
+ * requests.
749
+ */
750
+ ProcessorTimeSeconds: number;
751
+ /** The revision of the CloudScript that executed */
752
+ Revision: number;
753
+ }
754
+ interface ExecuteCloudScriptSegmentAction {
755
+ /** Cloud script function. */
756
+ CloudScriptFunction?: string;
757
+ /** Generate play stream event. */
758
+ CloudScriptPublishResultsToPlayStream: boolean;
759
+ /** Cloud script function parameter. */
760
+ FunctionParameter?: any;
761
+ /** Cloud script function parameter json text. */
762
+ FunctionParameterJson?: string;
763
+ }
764
+ interface ExecuteFunctionContent {
765
+ /** Arguments(JSON) to be passed into the cloudscript azure function */
766
+ CloudScriptFunctionArguments: string;
767
+ /** Cloudscript azure function name */
768
+ CloudScriptFunctionName: string;
769
+ /** Publish results from executing the azure function as playstream event */
770
+ PublishResultsToPlayStream: boolean;
771
+ }
772
+ interface ExportMasterPlayerDataRequest extends IPlayFabRequestCommon {
773
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
774
+ PlayFabId: string;
775
+ }
776
+ interface ExportMasterPlayerDataResult extends IPlayFabResultCommon {
777
+ /**
778
+ * An email with this job receipt Id containing the export download link will be sent to the title notification email
779
+ * address when the export is complete.
780
+ */
781
+ JobReceiptId?: string;
782
+ }
783
+ interface ExportPlayersInSegmentRequest extends IPlayFabRequestCommon {
784
+ /** Unique identifier of the requested segment. */
785
+ SegmentId: string;
786
+ }
787
+ interface ExportPlayersInSegmentResult extends IPlayFabResultCommon {
788
+ /** Unique identifier of the export for the requested Segment. */
789
+ ExportId?: string;
790
+ /** Unique identifier of the requested Segment. */
791
+ SegmentId?: string;
792
+ }
793
+ interface FirstLoginDateSegmentFilter {
794
+ /** First player login date comparison. */
795
+ Comparison?: string;
796
+ /** First player login date. */
797
+ LogInDate: string;
798
+ }
799
+ interface FirstLoginTimespanSegmentFilter {
800
+ /** First player login duration comparison. */
801
+ Comparison?: string;
802
+ /** First player login duration. */
803
+ DurationInMinutes: number;
804
+ }
805
+ interface GetActionsOnPlayersInSegmentTaskInstanceResult extends IPlayFabResultCommon {
806
+ /** Parameter of this task instance */
807
+ Parameter?: ActionsOnPlayersInSegmentTaskParameter;
808
+ /** Status summary of the actions-on-players-in-segment task instance */
809
+ Summary?: ActionsOnPlayersInSegmentTaskSummary;
810
+ }
811
+ interface GetAllSegmentsRequest extends IPlayFabRequestCommon {
812
+ }
813
+ interface GetAllSegmentsResult extends IPlayFabResultCommon {
814
+ /** Array of segments for this title. */
815
+ Segments?: GetSegmentResult[];
816
+ }
817
+ interface GetCatalogItemsRequest extends IPlayFabRequestCommon {
818
+ /** Which catalog is being requested. If null, uses the default catalog. */
819
+ CatalogVersion?: string;
820
+ }
821
+ interface GetCatalogItemsResult extends IPlayFabResultCommon {
822
+ /** Array of items which can be purchased. */
823
+ Catalog?: CatalogItem[];
824
+ }
825
+ interface GetCloudScriptRevisionRequest extends IPlayFabRequestCommon {
826
+ /** Revision number. If left null, defaults to the latest revision */
827
+ Revision?: number;
828
+ /** Version number. If left null, defaults to the latest version */
829
+ Version?: number;
830
+ }
831
+ interface GetCloudScriptRevisionResult extends IPlayFabResultCommon {
832
+ /** Time this revision was created */
833
+ CreatedAt: string;
834
+ /** List of Cloud Script files in this revision. */
835
+ Files?: CloudScriptFile[];
836
+ /** True if this is the currently published revision */
837
+ IsPublished: boolean;
838
+ /** Revision number. */
839
+ Revision: number;
840
+ /** Version number. */
841
+ Version: number;
842
+ }
843
+ interface GetCloudScriptTaskInstanceResult extends IPlayFabResultCommon {
844
+ /** Parameter of this task instance */
845
+ Parameter?: CloudScriptTaskParameter;
846
+ /** Status summary of the CloudScript task instance */
847
+ Summary?: CloudScriptTaskSummary;
848
+ }
849
+ interface GetCloudScriptVersionsRequest extends IPlayFabRequestCommon {
850
+ }
851
+ interface GetCloudScriptVersionsResult extends IPlayFabResultCommon {
852
+ /** List of versions */
853
+ Versions?: CloudScriptVersionStatus[];
854
+ }
855
+ interface GetContentListRequest extends IPlayFabRequestCommon {
856
+ /**
857
+ * Limits the response to keys that begin with the specified prefix. You can use prefixes to list contents under a folder,
858
+ * or for a specified version, etc.
859
+ */
860
+ Prefix?: string;
861
+ }
862
+ interface GetContentListResult extends IPlayFabResultCommon {
863
+ /** List of content items. */
864
+ Contents?: ContentInfo[];
865
+ /** Number of content items returned. We currently have a maximum of 1000 items limit. */
866
+ ItemCount: number;
867
+ /** The total size of listed contents in bytes. */
868
+ TotalSize: number;
869
+ }
870
+ interface GetContentUploadUrlRequest extends IPlayFabRequestCommon {
871
+ /**
872
+ * A standard MIME type describing the format of the contents. The same MIME type has to be set in the header when
873
+ * uploading the content. If not specified, the MIME type is 'binary/octet-stream' by default.
874
+ */
875
+ ContentType?: string;
876
+ /** Key of the content item to upload, usually formatted as a path, e.g. images/a.png */
877
+ Key: string;
878
+ }
879
+ interface GetContentUploadUrlResult extends IPlayFabResultCommon {
880
+ /**
881
+ * URL for uploading content via HTTP PUT method. The URL requires the 'x-ms-blob-type' header to have the value
882
+ * 'BlockBlob'. The URL will expire in approximately one hour.
883
+ */
884
+ URL?: string;
885
+ }
886
+ interface GetDataReportRequest extends IPlayFabRequestCommon {
887
+ /** Reporting year (UTC) */
888
+ Day: number;
889
+ /** Reporting month (UTC) */
890
+ Month: number;
891
+ /** Report name */
892
+ ReportName: string;
893
+ /** Reporting year (UTC) */
894
+ Year: number;
895
+ }
896
+ interface GetDataReportResult extends IPlayFabResultCommon {
897
+ /**
898
+ * The URL where the requested report can be downloaded. This can be any PlayFab generated reports. The full list of
899
+ * reports can be found at: https://docs.microsoft.com/en-us/gaming/playfab/features/analytics/reports/quickstart.
900
+ */
901
+ DownloadUrl?: string;
902
+ }
903
+ interface GetPlayedTitleListRequest extends IPlayFabRequestCommon {
904
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
905
+ PlayFabId: string;
906
+ }
907
+ interface GetPlayedTitleListResult extends IPlayFabResultCommon {
908
+ /** List of titles the player has played */
909
+ TitleIds?: string[];
910
+ }
911
+ interface GetPlayerCustomPropertyRequest extends IPlayFabRequestCommon {
912
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
913
+ PlayFabId: string;
914
+ /** Specific property name to search for in the player's properties. */
915
+ PropertyName: string;
916
+ }
917
+ interface GetPlayerCustomPropertyResult extends IPlayFabResultCommon {
918
+ /** PlayFab unique identifier of the user whose properties are being returned. */
919
+ PlayFabId?: string;
920
+ /**
921
+ * Indicates the current version of a player's properties that have been set. This is incremented after updates and
922
+ * deletes. This version can be provided in update and delete calls for concurrency control.
923
+ */
924
+ PropertiesVersion: number;
925
+ /** Player specific property and its corresponding value. */
926
+ Property?: CustomPropertyDetails;
927
+ }
928
+ interface GetPlayerIdFromAuthTokenRequest extends IPlayFabRequestCommon {
929
+ /** The auth token of the player requesting the password reset. */
930
+ Token: string;
931
+ /** The type of auth token of the player requesting the password reset. */
932
+ TokenType: string;
933
+ }
934
+ interface GetPlayerIdFromAuthTokenResult extends IPlayFabResultCommon {
935
+ /** The player ID from the token passed in */
936
+ PlayFabId?: string;
937
+ }
938
+ interface GetPlayerProfileRequest extends IPlayFabRequestCommon {
939
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
940
+ CustomTags?: Record<string, string | null>;
941
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
942
+ PlayFabId: string;
943
+ /**
944
+ * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
945
+ * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
946
+ * the Game Manager "Client Profile Options" tab in the "Settings" section.
947
+ */
948
+ ProfileConstraints?: PlayerProfileViewConstraints;
949
+ }
950
+ interface GetPlayerProfileResult extends IPlayFabResultCommon {
951
+ /**
952
+ * The profile of the player. This profile is not guaranteed to be up-to-date. For a new player, this profile will not
953
+ * exist.
954
+ */
955
+ PlayerProfile?: PlayerProfileModel;
956
+ }
957
+ interface GetPlayerSegmentsResult extends IPlayFabResultCommon {
958
+ /** Array of segments the requested player currently belongs to. */
959
+ Segments?: GetSegmentResult[];
960
+ }
961
+ interface GetPlayerSharedSecretsRequest extends IPlayFabRequestCommon {
962
+ }
963
+ interface GetPlayerSharedSecretsResult extends IPlayFabResultCommon {
964
+ /** The player shared secret to use when calling Client/GetTitlePublicKey */
965
+ SharedSecrets?: SharedSecret[];
966
+ }
967
+ interface GetPlayersInSegmentExportRequest extends IPlayFabRequestCommon {
968
+ /** Unique identifier of the export for the requested Segment. */
969
+ ExportId: string;
970
+ }
971
+ interface GetPlayersInSegmentExportResponse extends IPlayFabResultCommon {
972
+ /** Url from which the index file can be downloaded. */
973
+ IndexUrl?: string;
974
+ /** Shows the current status of the export */
975
+ State?: string;
976
+ }
977
+ interface GetPlayersInSegmentRequest extends IPlayFabRequestCommon {
978
+ /** Continuation token if retrieving subsequent pages of results. */
979
+ ContinuationToken?: string;
980
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
981
+ CustomTags?: Record<string, string | null>;
982
+ /**
983
+ * If set to true, the profiles are loaded asynchronously and the response will include a continuation token and
984
+ * approximate profile count until the first batch of profiles is loaded. Use this parameter to help avoid network
985
+ * timeouts.
986
+ */
987
+ GetProfilesAsync?: boolean;
988
+ /**
989
+ * Maximum is 10,000. The value 0 will prevent loading any profiles and return only the count of profiles matching this
990
+ * segment.
991
+ */
992
+ MaxBatchSize?: number;
993
+ /**
994
+ * Number of seconds to keep the continuation token active. After token expiration it is not possible to continue paging
995
+ * results. Default is 300 (5 minutes). Maximum is 5,400 (90 minutes).
996
+ */
997
+ SecondsToLive?: number;
998
+ /** Unique identifier for this segment. */
999
+ SegmentId: string;
1000
+ }
1001
+ interface GetPlayersInSegmentResult extends IPlayFabResultCommon {
1002
+ /** Continuation token to use to retrieve subsequent pages of results. If token returns null there are no more results. */
1003
+ ContinuationToken?: string;
1004
+ /** Array of player profiles in this segment. */
1005
+ PlayerProfiles?: PlayerProfile[];
1006
+ /** Count of profiles matching this segment. */
1007
+ ProfilesInSegment: number;
1008
+ }
1009
+ interface GetPlayersSegmentsRequest extends IPlayFabRequestCommon {
1010
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1011
+ CustomTags?: Record<string, string | null>;
1012
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1013
+ PlayFabId: string;
1014
+ }
1015
+ interface GetPlayerStatisticDefinitionsRequest extends IPlayFabRequestCommon {
1016
+ }
1017
+ interface GetPlayerStatisticDefinitionsResult extends IPlayFabResultCommon {
1018
+ /** the player statistic definitions for the title */
1019
+ Statistics?: PlayerStatisticDefinition[];
1020
+ }
1021
+ interface GetPlayerStatisticVersionsRequest extends IPlayFabRequestCommon {
1022
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1023
+ CustomTags?: Record<string, string | null>;
1024
+ /** unique name of the statistic */
1025
+ StatisticName?: string;
1026
+ }
1027
+ interface GetPlayerStatisticVersionsResult extends IPlayFabResultCommon {
1028
+ /** version change history of the statistic */
1029
+ StatisticVersions?: PlayerStatisticVersion[];
1030
+ }
1031
+ interface GetPlayerTagsRequest extends IPlayFabRequestCommon {
1032
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1033
+ CustomTags?: Record<string, string | null>;
1034
+ /** Optional namespace to filter results by */
1035
+ Namespace?: string;
1036
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1037
+ PlayFabId: string;
1038
+ }
1039
+ interface GetPlayerTagsResult extends IPlayFabResultCommon {
1040
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1041
+ PlayFabId: string;
1042
+ /** Canonical tags (including namespace and tag's name) for the requested user */
1043
+ Tags: string[];
1044
+ }
1045
+ interface GetPolicyRequest extends IPlayFabRequestCommon {
1046
+ /** The name of the policy to read. Only supported name is 'ApiPolicy'. */
1047
+ PolicyName?: string;
1048
+ }
1049
+ interface GetPolicyResponse extends IPlayFabResultCommon {
1050
+ /** The name of the policy read. */
1051
+ PolicyName?: string;
1052
+ /** Policy version. */
1053
+ PolicyVersion: number;
1054
+ /** The statements in the requested policy. */
1055
+ Statements?: PermissionStatement[];
1056
+ }
1057
+ interface GetPublisherDataRequest extends IPlayFabRequestCommon {
1058
+ /** array of keys to get back data from the Publisher data blob, set by the admin tools */
1059
+ Keys: string[];
1060
+ }
1061
+ interface GetPublisherDataResult extends IPlayFabResultCommon {
1062
+ /** a dictionary object of key / value pairs */
1063
+ Data?: Record<string, string | null>;
1064
+ }
1065
+ interface GetRandomResultTablesRequest extends IPlayFabRequestCommon {
1066
+ /** catalog version to fetch tables from. Use default catalog version if null */
1067
+ CatalogVersion?: string;
1068
+ }
1069
+ interface GetRandomResultTablesResult extends IPlayFabResultCommon {
1070
+ /** array of random result tables currently available */
1071
+ Tables?: Record<string, RandomResultTableListing>;
1072
+ }
1073
+ interface GetSegmentResult {
1074
+ /** Identifier of the segments AB Test, if it is attached to one. */
1075
+ ABTestParent?: string;
1076
+ /** Unique identifier for this segment. */
1077
+ Id: string;
1078
+ /** Segment name. */
1079
+ Name?: string;
1080
+ }
1081
+ interface GetSegmentsRequest extends IPlayFabRequestCommon {
1082
+ /** Segment ids to filter title segments. */
1083
+ SegmentIds: string[];
1084
+ }
1085
+ interface GetSegmentsResponse extends IPlayFabResultCommon {
1086
+ /** Error message. */
1087
+ ErrorMessage?: string;
1088
+ /** List of title segments. */
1089
+ Segments?: SegmentModel[];
1090
+ }
1091
+ interface GetStoreItemsRequest extends IPlayFabRequestCommon {
1092
+ /** Catalog version to store items from. Use default catalog version if null */
1093
+ CatalogVersion?: string;
1094
+ /** Unqiue identifier for the store which is being requested. */
1095
+ StoreId: string;
1096
+ }
1097
+ interface GetStoreItemsResult extends IPlayFabResultCommon {
1098
+ /** The base catalog that this store is a part of. */
1099
+ CatalogVersion?: string;
1100
+ /** Additional data about the store. */
1101
+ MarketingData?: StoreMarketingModel;
1102
+ /** How the store was last updated (Admin or a third party). */
1103
+ Source?: string;
1104
+ /** Array of items which can be purchased from this store. */
1105
+ Store?: StoreItem[];
1106
+ /** The ID of this store. */
1107
+ StoreId?: string;
1108
+ }
1109
+ interface GetTaskInstanceRequest extends IPlayFabRequestCommon {
1110
+ /** ID of the requested task instance. */
1111
+ TaskInstanceId: string;
1112
+ }
1113
+ interface GetTaskInstancesRequest extends IPlayFabRequestCommon {
1114
+ /** Optional range-from filter for task instances' StartedAt timestamp. */
1115
+ StartedAtRangeFrom?: string;
1116
+ /** Optional range-to filter for task instances' StartedAt timestamp. */
1117
+ StartedAtRangeTo?: string;
1118
+ /** Optional filter for task instances that are of a specific status. */
1119
+ StatusFilter?: string;
1120
+ /**
1121
+ * Name or ID of the task whose instances are being queried. If not specified, return all task instances that satisfy
1122
+ * conditions set by other filters.
1123
+ */
1124
+ TaskIdentifier?: NameIdentifier;
1125
+ }
1126
+ interface GetTaskInstancesResult extends IPlayFabResultCommon {
1127
+ /**
1128
+ * Basic status summaries of the queried task instances. Empty If no task instances meets the filter criteria. To get
1129
+ * detailed status summary, use Get*TaskInstance API according to task type (e.g.
1130
+ * GetActionsOnPlayersInSegmentTaskInstance).
1131
+ */
1132
+ Summaries?: TaskInstanceBasicSummary[];
1133
+ }
1134
+ interface GetTasksRequest extends IPlayFabRequestCommon {
1135
+ /** Provide either the task ID or the task name to get a specific task. If not specified, return all defined tasks. */
1136
+ Identifier?: NameIdentifier;
1137
+ }
1138
+ interface GetTasksResult extends IPlayFabResultCommon {
1139
+ /** Result tasks. Empty if there is no task found. */
1140
+ Tasks?: ScheduledTask[];
1141
+ }
1142
+ interface GetTitleDataRequest extends IPlayFabRequestCommon {
1143
+ /** Specific keys to search for in the title data (leave null to get all keys) */
1144
+ Keys?: string[];
1145
+ /**
1146
+ * Optional field that specifies the name of an override. This value is ignored when used by the game client; otherwise,
1147
+ * the overrides are applied automatically to the title data.
1148
+ */
1149
+ OverrideLabel?: string;
1150
+ }
1151
+ interface GetTitleDataResult extends IPlayFabResultCommon {
1152
+ /** a dictionary object of key / value pairs */
1153
+ Data?: Record<string, string | null>;
1154
+ }
1155
+ interface GetUserBansRequest extends IPlayFabRequestCommon {
1156
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1157
+ PlayFabId: string;
1158
+ }
1159
+ interface GetUserBansResult extends IPlayFabResultCommon {
1160
+ /** Information about the bans */
1161
+ BanData?: BanInfo[];
1162
+ }
1163
+ interface GetUserDataRequest extends IPlayFabRequestCommon {
1164
+ /**
1165
+ * The version that currently exists according to the caller. The call will return the data for all of the keys if the
1166
+ * version in the system is greater than this.
1167
+ */
1168
+ IfChangedFromDataVersion?: number;
1169
+ /** Specific keys to search for in the custom user data. */
1170
+ Keys?: string[];
1171
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1172
+ PlayFabId: string;
1173
+ }
1174
+ interface GetUserDataResult extends IPlayFabResultCommon {
1175
+ /** User specific data for this title. */
1176
+ Data?: Record<string, UserDataRecord>;
1177
+ /**
1178
+ * Indicates the current version of the data that has been set. This is incremented with every set call for that type of
1179
+ * data (read-only, internal, etc). This version can be provided in Get calls to find updated data.
1180
+ */
1181
+ DataVersion: number;
1182
+ /** PlayFab unique identifier of the user whose custom data is being returned. */
1183
+ PlayFabId?: string;
1184
+ }
1185
+ interface GetUserInventoryRequest extends IPlayFabRequestCommon {
1186
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1187
+ CustomTags?: Record<string, string | null>;
1188
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1189
+ PlayFabId: string;
1190
+ }
1191
+ interface GetUserInventoryResult extends IPlayFabResultCommon {
1192
+ /** Array of inventory items belonging to the user. */
1193
+ Inventory?: ItemInstance[];
1194
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1195
+ PlayFabId?: string;
1196
+ /** Array of virtual currency balance(s) belonging to the user. */
1197
+ VirtualCurrency?: Record<string, number>;
1198
+ /** Array of remaining times and timestamps for virtual currencies. */
1199
+ VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
1200
+ }
1201
+ interface GrantedItemInstance {
1202
+ /** Game specific comment associated with this instance when it was added to the user inventory. */
1203
+ Annotation?: string;
1204
+ /** Array of unique items that were awarded when this catalog item was purchased. */
1205
+ BundleContents?: string[];
1206
+ /**
1207
+ * Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or
1208
+ * container.
1209
+ */
1210
+ BundleParent?: string;
1211
+ /** Catalog version for the inventory item, when this instance was created. */
1212
+ CatalogVersion?: string;
1213
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
1214
+ CharacterId?: string;
1215
+ /**
1216
+ * A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog
1217
+ * item's custom data.
1218
+ */
1219
+ CustomData?: Record<string, string | null>;
1220
+ /** CatalogItem.DisplayName at the time this item was purchased. */
1221
+ DisplayName?: string;
1222
+ /** Timestamp for when this instance will expire. */
1223
+ Expiration?: string;
1224
+ /** Class name for the inventory item, as defined in the catalog. */
1225
+ ItemClass?: string;
1226
+ /** Unique identifier for the inventory item, as defined in the catalog. */
1227
+ ItemId?: string;
1228
+ /** Unique item identifier for this specific instance of the item. */
1229
+ ItemInstanceId?: string;
1230
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1231
+ PlayFabId?: string;
1232
+ /** Timestamp for when this instance was purchased. */
1233
+ PurchaseDate?: string;
1234
+ /** Total number of remaining uses, if this is a consumable item. */
1235
+ RemainingUses?: number;
1236
+ /** Result of this operation. */
1237
+ Result: boolean;
1238
+ /** Currency type for the cost of the catalog item. Not available when granting items. */
1239
+ UnitCurrency?: string;
1240
+ /** Cost of the catalog item in the given currency. Not available when granting items. */
1241
+ UnitPrice: number;
1242
+ /** The number of uses that were added or removed to this item in this call. */
1243
+ UsesIncrementedBy?: number;
1244
+ }
1245
+ interface GrantItemContent {
1246
+ /** The catalog version of the item to be granted to the player */
1247
+ CatalogVersion?: string;
1248
+ /** The id of item to be granted to the player */
1249
+ ItemId?: string;
1250
+ /** Quantity of the item to be granted to a player */
1251
+ ItemQuantity: number;
1252
+ }
1253
+ interface GrantItemSegmentAction {
1254
+ /** Item catalog id. */
1255
+ CatelogId?: string;
1256
+ /** Item id. */
1257
+ ItemId?: string;
1258
+ /** Item quantity. */
1259
+ Quantity: number;
1260
+ }
1261
+ interface GrantItemsToUsersRequest extends IPlayFabRequestCommon {
1262
+ /** Catalog version from which items are to be granted. */
1263
+ CatalogVersion?: string;
1264
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1265
+ CustomTags?: Record<string, string | null>;
1266
+ /** Array of items to grant and the users to whom the items are to be granted. */
1267
+ ItemGrants: ItemGrant[];
1268
+ }
1269
+ interface GrantItemsToUsersResult extends IPlayFabResultCommon {
1270
+ /** Array of items granted to users. */
1271
+ ItemGrantResults?: GrantedItemInstance[];
1272
+ }
1273
+ interface GrantVirtualCurrencyContent {
1274
+ /** Amount of currency to be granted to a player */
1275
+ CurrencyAmount: number;
1276
+ /** Code of the currency to be granted to a player */
1277
+ CurrencyCode: string;
1278
+ }
1279
+ interface GrantVirtualCurrencySegmentAction {
1280
+ /** Virtual currency amount. */
1281
+ Amount: number;
1282
+ /** Virtual currency code. */
1283
+ CurrencyCode?: string;
1284
+ }
1285
+ interface IncrementLimitedEditionItemAvailabilityRequest extends IPlayFabRequestCommon {
1286
+ /** Amount to increase availability by. */
1287
+ Amount: number;
1288
+ /** Which catalog is being updated. If null, uses the default catalog. */
1289
+ CatalogVersion?: string;
1290
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1291
+ CustomTags?: Record<string, string | null>;
1292
+ /** The item which needs more availability. */
1293
+ ItemId: string;
1294
+ }
1295
+ interface IncrementLimitedEditionItemAvailabilityResult extends IPlayFabResultCommon {
1296
+ }
1297
+ interface IncrementPlayerStatisticContent {
1298
+ /** Amount(in whole number) to increase the player statistic by */
1299
+ StatisticChangeBy: number;
1300
+ /** Name of the player statistic to be incremented */
1301
+ StatisticName: string;
1302
+ }
1303
+ interface IncrementPlayerStatisticSegmentAction {
1304
+ /** Increment value. */
1305
+ IncrementValue: number;
1306
+ /** Statistic name. */
1307
+ StatisticName?: string;
1308
+ }
1309
+ interface IncrementPlayerStatisticVersionRequest extends IPlayFabRequestCommon {
1310
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1311
+ CustomTags?: Record<string, string | null>;
1312
+ /** unique name of the statistic */
1313
+ StatisticName?: string;
1314
+ }
1315
+ interface IncrementPlayerStatisticVersionResult extends IPlayFabResultCommon {
1316
+ /** version change history of the statistic */
1317
+ StatisticVersion?: PlayerStatisticVersion;
1318
+ }
1319
+ interface InsightsScalingTaskParameter {
1320
+ /** Insights Performance Level to scale to. */
1321
+ Level: number;
1322
+ }
1323
+ interface ItemGrant {
1324
+ /** String detailing any additional information concerning this operation. */
1325
+ Annotation?: string;
1326
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
1327
+ CharacterId?: string;
1328
+ /**
1329
+ * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
1330
+ * not begin with a '!' character or be null.
1331
+ */
1332
+ Data?: Record<string, string | null>;
1333
+ /** Unique identifier of the catalog item to be granted to the user. */
1334
+ ItemId: string;
1335
+ /**
1336
+ * Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
1337
+ * constraints. Use this to delete the keys directly.
1338
+ */
1339
+ KeysToRemove?: string[];
1340
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1341
+ PlayFabId: string;
1342
+ }
1343
+ interface ItemInstance {
1344
+ /** Game specific comment associated with this instance when it was added to the user inventory. */
1345
+ Annotation?: string;
1346
+ /** Array of unique items that were awarded when this catalog item was purchased. */
1347
+ BundleContents?: string[];
1348
+ /**
1349
+ * Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or
1350
+ * container.
1351
+ */
1352
+ BundleParent?: string;
1353
+ /** Catalog version for the inventory item, when this instance was created. */
1354
+ CatalogVersion?: string;
1355
+ /**
1356
+ * A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog
1357
+ * item's custom data.
1358
+ */
1359
+ CustomData?: Record<string, string | null>;
1360
+ /** CatalogItem.DisplayName at the time this item was purchased. */
1361
+ DisplayName?: string;
1362
+ /** Timestamp for when this instance will expire. */
1363
+ Expiration?: string;
1364
+ /** Class name for the inventory item, as defined in the catalog. */
1365
+ ItemClass?: string;
1366
+ /** Unique identifier for the inventory item, as defined in the catalog. */
1367
+ ItemId?: string;
1368
+ /** Unique item identifier for this specific instance of the item. */
1369
+ ItemInstanceId?: string;
1370
+ /** Timestamp for when this instance was purchased. */
1371
+ PurchaseDate?: string;
1372
+ /** Total number of remaining uses, if this is a consumable item. */
1373
+ RemainingUses?: number;
1374
+ /** Currency type for the cost of the catalog item. Not available when granting items. */
1375
+ UnitCurrency?: string;
1376
+ /** Cost of the catalog item in the given currency. Not available when granting items. */
1377
+ UnitPrice: number;
1378
+ /** The number of uses that were added or removed to this item in this call. */
1379
+ UsesIncrementedBy?: number;
1380
+ }
1381
+ interface LastLoginDateSegmentFilter {
1382
+ /** Last player login date comparison. */
1383
+ Comparison?: string;
1384
+ /** Last player login date. */
1385
+ LogInDate: string;
1386
+ }
1387
+ interface LastLoginTimespanSegmentFilter {
1388
+ /** Last player login duration comparison. */
1389
+ Comparison?: string;
1390
+ /** Last player login duration. */
1391
+ DurationInMinutes: number;
1392
+ }
1393
+ interface LinkedPlatformAccountModel {
1394
+ /** Linked account email of the user on the platform, if available */
1395
+ Email?: string;
1396
+ /** Authentication platform */
1397
+ Platform?: string;
1398
+ /** Unique account identifier of the user on the platform */
1399
+ PlatformUserId?: string;
1400
+ /** Linked account username of the user on the platform, if available */
1401
+ Username?: string;
1402
+ }
1403
+ interface LinkedUserAccountHasEmailSegmentFilter {
1404
+ /** Login provider comparison. */
1405
+ Comparison?: string;
1406
+ /** Login provider. */
1407
+ LoginProvider?: string;
1408
+ }
1409
+ interface LinkedUserAccountSegmentFilter {
1410
+ /** Login provider. */
1411
+ LoginProvider?: string;
1412
+ }
1413
+ interface ListOpenIdConnectionRequest extends IPlayFabRequestCommon {
1414
+ }
1415
+ interface ListOpenIdConnectionResponse extends IPlayFabResultCommon {
1416
+ /** The list of Open ID Connections */
1417
+ Connections?: OpenIdConnection[];
1418
+ }
1419
+ interface ListPlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
1420
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1421
+ PlayFabId: string;
1422
+ }
1423
+ interface ListPlayerCustomPropertiesResult extends IPlayFabResultCommon {
1424
+ /** PlayFab unique identifier of the user whose properties are being returned. */
1425
+ PlayFabId?: string;
1426
+ /** Player specific properties and their corresponding values for this title. */
1427
+ Properties?: CustomPropertyDetails[];
1428
+ /**
1429
+ * Indicates the current version of a player's properties that have been set. This is incremented after updates and
1430
+ * deletes. This version can be provided in update and delete calls for concurrency control.
1431
+ */
1432
+ PropertiesVersion: number;
1433
+ }
1434
+ interface ListVirtualCurrencyTypesRequest extends IPlayFabRequestCommon {
1435
+ }
1436
+ interface ListVirtualCurrencyTypesResult extends IPlayFabResultCommon {
1437
+ /** List of virtual currency names defined for this title */
1438
+ VirtualCurrencies?: VirtualCurrencyData[];
1439
+ }
1440
+ interface LocationModel {
1441
+ /** City name. */
1442
+ City?: string;
1443
+ /** The two-character continent code for this location */
1444
+ ContinentCode?: string;
1445
+ /** The two-character ISO 3166-1 country code for the country associated with the location */
1446
+ CountryCode?: string;
1447
+ /** Latitude coordinate of the geographic location. */
1448
+ Latitude?: number;
1449
+ /** Longitude coordinate of the geographic location. */
1450
+ Longitude?: number;
1451
+ }
1452
+ interface LocationSegmentFilter {
1453
+ /** Segment country code. */
1454
+ CountryCode?: string;
1455
+ }
1456
+ interface LogStatement {
1457
+ /** Optional object accompanying the message as contextual information */
1458
+ Data?: any;
1459
+ /** 'Debug', 'Info', or 'Error' */
1460
+ Level?: string;
1461
+ Message?: string;
1462
+ }
1463
+ interface LookupUserAccountInfoRequest extends IPlayFabRequestCommon {
1464
+ /** User email address attached to their account */
1465
+ Email?: string;
1466
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1467
+ PlayFabId?: string;
1468
+ /** Title specific username to match against existing user accounts */
1469
+ TitleDisplayName?: string;
1470
+ /** PlayFab username for the account (3-20 characters) */
1471
+ Username?: string;
1472
+ }
1473
+ interface LookupUserAccountInfoResult extends IPlayFabResultCommon {
1474
+ /** User info for the user matching the request */
1475
+ UserInfo?: UserAccountInfo;
1476
+ }
1477
+ interface MembershipModel {
1478
+ /** Whether this membership is active. That is, whether the MembershipExpiration time has been reached. */
1479
+ IsActive: boolean;
1480
+ /** The time this membership expires */
1481
+ MembershipExpiration: string;
1482
+ /** The id of the membership */
1483
+ MembershipId?: string;
1484
+ /**
1485
+ * Membership expirations can be explicitly overridden (via game manager or the admin api). If this membership has been
1486
+ * overridden, this will be the new expiration time.
1487
+ */
1488
+ OverrideExpiration?: string;
1489
+ /** The list of subscriptions that this player has for this membership */
1490
+ Subscriptions?: SubscriptionModel[];
1491
+ }
1492
+ interface ModifyUserVirtualCurrencyResult extends IPlayFabResultCommon {
1493
+ /** Balance of the virtual currency after modification. */
1494
+ Balance: number;
1495
+ /**
1496
+ * Amount added or subtracted from the user's virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase
1497
+ * over this value will be discarded.
1498
+ */
1499
+ BalanceChange: number;
1500
+ /** User currency was subtracted from. */
1501
+ PlayFabId?: string;
1502
+ /** Name of the virtual currency which was modified. */
1503
+ VirtualCurrency?: string;
1504
+ }
1505
+ interface NameIdentifier {
1506
+ /** Id Identifier, if present */
1507
+ Id?: string;
1508
+ /** Name Identifier, if present */
1509
+ Name?: string;
1510
+ }
1511
+ interface OpenIdConnection {
1512
+ /** The client ID given by the ID provider. */
1513
+ ClientId?: string;
1514
+ /** The client secret given by the ID provider. */
1515
+ ClientSecret?: string;
1516
+ /** A name for the connection to identify it within the title. */
1517
+ ConnectionId?: string;
1518
+ /** Shows if data about the connection will be loaded from the issuer's discovery document */
1519
+ DiscoverConfiguration: boolean;
1520
+ /** Ignore 'nonce' claim in identity tokens. */
1521
+ IgnoreNonce?: boolean;
1522
+ /** Information for an OpenID Connect provider. */
1523
+ IssuerInformation?: OpenIdIssuerInformation;
1524
+ /** Override the issuer name for user indexing and lookup. */
1525
+ IssuerOverride?: string;
1526
+ }
1527
+ interface OpenIdIssuerInformation {
1528
+ /** Authorization endpoint URL to direct users to for signin. */
1529
+ AuthorizationUrl: string;
1530
+ /** The URL of the issuer of the tokens. This must match the exact URL of the issuer field in tokens. */
1531
+ Issuer: string;
1532
+ /** JSON Web Key Set for validating the signature of tokens. */
1533
+ JsonWebKeySet: any;
1534
+ /** Token endpoint URL for code verification. */
1535
+ TokenUrl: string;
1536
+ }
1537
+ interface PermissionStatement {
1538
+ /** The action this statement effects. The only supported action is 'Execute'. */
1539
+ Action: string;
1540
+ /** Additional conditions to be applied for API Resources. */
1541
+ ApiConditions?: ApiCondition;
1542
+ /** A comment about the statement. Intended solely for bookkeeping and debugging. */
1543
+ Comment?: string;
1544
+ /** The effect this statement will have. It could be either Allow or Deny */
1545
+ Effect: string;
1546
+ /** The principal this statement will effect. The only supported principal is '*'. */
1547
+ Principal: string;
1548
+ /**
1549
+ * The resource this statements effects. The only supported resources look like 'pfrn:api--*' for all apis, or
1550
+ * 'pfrn:api--/Client/ConfirmPurchase' for specific apis.
1551
+ */
1552
+ Resource: string;
1553
+ }
1554
+ interface PlayerChurnPredictionSegmentFilter {
1555
+ /** Comparison */
1556
+ Comparison?: string;
1557
+ /** RiskLevel */
1558
+ RiskLevel?: string;
1559
+ }
1560
+ interface PlayerChurnPredictionTimeSegmentFilter {
1561
+ /** Comparison */
1562
+ Comparison?: string;
1563
+ /** DurationInDays */
1564
+ DurationInDays: number;
1565
+ }
1566
+ interface PlayerChurnPreviousPredictionSegmentFilter {
1567
+ /** Comparison */
1568
+ Comparison?: string;
1569
+ /** RiskLevel */
1570
+ RiskLevel?: string;
1571
+ }
1572
+ interface PlayerLinkedAccount {
1573
+ /** Linked account's email */
1574
+ Email?: string;
1575
+ /** Authentication platform */
1576
+ Platform?: string;
1577
+ /** Platform user identifier */
1578
+ PlatformUserId?: string;
1579
+ /** Linked account's username */
1580
+ Username?: string;
1581
+ }
1582
+ interface PlayerLocation {
1583
+ /** City of the player's geographic location. */
1584
+ City?: string;
1585
+ /** The two-character continent code for this location */
1586
+ ContinentCode: string;
1587
+ /** The two-character ISO 3166-1 country code for the country associated with the location */
1588
+ CountryCode: string;
1589
+ /** Latitude coordinate of the player's geographic location. */
1590
+ Latitude?: number;
1591
+ /** Longitude coordinate of the player's geographic location. */
1592
+ Longitude?: number;
1593
+ }
1594
+ interface PlayerProfile {
1595
+ /** Array of ad campaigns player has been attributed to */
1596
+ AdCampaignAttributions?: AdCampaignAttribution[];
1597
+ /** Image URL of the player's avatar. */
1598
+ AvatarUrl?: string;
1599
+ /** Banned until UTC Date. If permanent ban this is set for 20 years after the original ban date. */
1600
+ BannedUntil?: string;
1601
+ /** The prediction of the player to churn within the next seven days. */
1602
+ ChurnPrediction?: string;
1603
+ /** Array of contact email addresses associated with the player */
1604
+ ContactEmailAddresses?: ContactEmailInfo[];
1605
+ /** Player record created */
1606
+ Created?: string;
1607
+ /** Dictionary of player's custom properties. */
1608
+ CustomProperties?: Record<string, any>;
1609
+ /** Player Display Name */
1610
+ DisplayName?: string;
1611
+ /** Last login */
1612
+ LastLogin?: string;
1613
+ /** Array of third party accounts linked to this player */
1614
+ LinkedAccounts?: PlayerLinkedAccount[];
1615
+ /** Dictionary of player's locations by type. */
1616
+ Locations?: Record<string, PlayerLocation>;
1617
+ /** Player account origination */
1618
+ Origination?: string;
1619
+ /** List of player variants for experimentation */
1620
+ PlayerExperimentVariants?: string[];
1621
+ /** PlayFab Player ID */
1622
+ PlayerId?: string;
1623
+ /** Array of player statistics */
1624
+ PlayerStatistics?: PlayerStatistic[];
1625
+ /** Publisher this player belongs to */
1626
+ PublisherId?: string;
1627
+ /** Array of configured push notification end points */
1628
+ PushNotificationRegistrations?: PushNotificationRegistration[];
1629
+ /** Dictionary of player's statistics using only the latest version's value */
1630
+ Statistics?: Record<string, number>;
1631
+ /** List of player's tags for segmentation. */
1632
+ Tags?: string[];
1633
+ /** Title ID this profile applies to */
1634
+ TitleId?: string;
1635
+ /** A sum of player's total purchases in USD across all currencies. */
1636
+ TotalValueToDateInUSD?: number;
1637
+ /** Dictionary of player's total purchases by currency. */
1638
+ ValuesToDate?: Record<string, number>;
1639
+ /** Dictionary of player's virtual currency balances */
1640
+ VirtualCurrencyBalances?: Record<string, number>;
1641
+ }
1642
+ interface PlayerProfileModel {
1643
+ /** List of advertising campaigns the player has been attributed to */
1644
+ AdCampaignAttributions?: AdCampaignAttributionModel[];
1645
+ /** URL of the player's avatar image */
1646
+ AvatarUrl?: string;
1647
+ /** If the player is currently banned, the UTC Date when the ban expires */
1648
+ BannedUntil?: string;
1649
+ /** List of all contact email info associated with the player account */
1650
+ ContactEmailAddresses?: ContactEmailInfoModel[];
1651
+ /** Player record created */
1652
+ Created?: string;
1653
+ /** Player display name */
1654
+ DisplayName?: string;
1655
+ /**
1656
+ * List of experiment variants for the player. Note that these variants are not guaranteed to be up-to-date when returned
1657
+ * during login because the player profile is updated only after login. Instead, use the LoginResult.TreatmentAssignment
1658
+ * property during login to get the correct variants and variables.
1659
+ */
1660
+ ExperimentVariants?: string[];
1661
+ /** UTC time when the player most recently logged in to the title */
1662
+ LastLogin?: string;
1663
+ /** List of all authentication systems linked to this player account */
1664
+ LinkedAccounts?: LinkedPlatformAccountModel[];
1665
+ /** List of geographic locations from which the player has logged in to the title */
1666
+ Locations?: LocationModel[];
1667
+ /** List of memberships for the player, along with whether are expired. */
1668
+ Memberships?: MembershipModel[];
1669
+ /** Player account origination */
1670
+ Origination?: string;
1671
+ /** PlayFab player account unique identifier */
1672
+ PlayerId?: string;
1673
+ /** Publisher this player belongs to */
1674
+ PublisherId?: string;
1675
+ /** List of configured end points registered for sending the player push notifications */
1676
+ PushNotificationRegistrations?: PushNotificationRegistrationModel[];
1677
+ /** List of leaderboard statistic values for the player */
1678
+ Statistics?: StatisticModel[];
1679
+ /** List of player's tags for segmentation */
1680
+ Tags?: TagModel[];
1681
+ /** Title ID this player profile applies to */
1682
+ TitleId?: string;
1683
+ /**
1684
+ * Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a
1685
+ * whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.
1686
+ */
1687
+ TotalValueToDateInUSD?: number;
1688
+ /** List of the player's lifetime purchase totals, summed by real-money currency */
1689
+ ValuesToDate?: ValueToDateModel[];
1690
+ }
1691
+ interface PlayerProfileViewConstraints {
1692
+ /** Whether to show player's avatar URL. Defaults to false */
1693
+ ShowAvatarUrl: boolean;
1694
+ /** Whether to show the banned until time. Defaults to false */
1695
+ ShowBannedUntil: boolean;
1696
+ /** Whether to show campaign attributions. Defaults to false */
1697
+ ShowCampaignAttributions: boolean;
1698
+ /** Whether to show contact email addresses. Defaults to false */
1699
+ ShowContactEmailAddresses: boolean;
1700
+ /** Whether to show the created date. Defaults to false */
1701
+ ShowCreated: boolean;
1702
+ /** Whether to show the display name. Defaults to false */
1703
+ ShowDisplayName: boolean;
1704
+ /** Whether to show player's experiment variants. Defaults to false */
1705
+ ShowExperimentVariants: boolean;
1706
+ /** Whether to show the last login time. Defaults to false */
1707
+ ShowLastLogin: boolean;
1708
+ /** Whether to show the linked accounts. Defaults to false */
1709
+ ShowLinkedAccounts: boolean;
1710
+ /** Whether to show player's locations. Defaults to false */
1711
+ ShowLocations: boolean;
1712
+ /** Whether to show player's membership information. Defaults to false */
1713
+ ShowMemberships: boolean;
1714
+ /** Whether to show origination. Defaults to false */
1715
+ ShowOrigination: boolean;
1716
+ /** Whether to show push notification registrations. Defaults to false */
1717
+ ShowPushNotificationRegistrations: boolean;
1718
+ /** Reserved for future development */
1719
+ ShowStatistics: boolean;
1720
+ /** Whether to show tags. Defaults to false */
1721
+ ShowTags: boolean;
1722
+ /** Whether to show the total value to date in usd. Defaults to false */
1723
+ ShowTotalValueToDateInUsd: boolean;
1724
+ /** Whether to show the values to date. Defaults to false */
1725
+ ShowValuesToDate: boolean;
1726
+ }
1727
+ interface PlayerStatistic {
1728
+ /** Statistic ID */
1729
+ Id?: string;
1730
+ /** Statistic name */
1731
+ Name?: string;
1732
+ /** Current statistic value */
1733
+ StatisticValue: number;
1734
+ /** Statistic version (0 if not a versioned statistic) */
1735
+ StatisticVersion: number;
1736
+ }
1737
+ interface PlayerStatisticDefinition {
1738
+ /** the aggregation method to use in updating the statistic (defaults to last) */
1739
+ AggregationMethod?: string;
1740
+ /** current active version of the statistic, incremented each time the statistic resets */
1741
+ CurrentVersion: number;
1742
+ /** unique name of the statistic */
1743
+ StatisticName?: string;
1744
+ /** interval at which the values of the statistic for all players are reset automatically */
1745
+ VersionChangeInterval?: string;
1746
+ }
1747
+ interface PlayerStatisticVersion {
1748
+ /** time when the statistic version became active */
1749
+ ActivationTime: string;
1750
+ /** URL for the downloadable archive of player statistic values, if available */
1751
+ ArchiveDownloadUrl?: string;
1752
+ /** time when the statistic version became inactive due to statistic version incrementing */
1753
+ DeactivationTime?: string;
1754
+ /** time at which the statistic version was scheduled to become active, based on the configured ResetInterval */
1755
+ ScheduledActivationTime?: string;
1756
+ /** time at which the statistic version was scheduled to become inactive, based on the configured ResetInterval */
1757
+ ScheduledDeactivationTime?: string;
1758
+ /** name of the statistic when the version became active */
1759
+ StatisticName?: string;
1760
+ /** status of the statistic version */
1761
+ Status?: string;
1762
+ /** version of the statistic */
1763
+ Version: number;
1764
+ }
1765
+ interface PushNotificationContent {
1766
+ /** Text of message to send. */
1767
+ Message?: string;
1768
+ /** Id of the push notification template. */
1769
+ PushNotificationTemplateId?: string;
1770
+ /** Subject of message to send (may not be displayed in all platforms) */
1771
+ Subject?: string;
1772
+ }
1773
+ interface PushNotificationRegistration {
1774
+ /** Notification configured endpoint */
1775
+ NotificationEndpointARN?: string;
1776
+ /** Push notification platform */
1777
+ Platform?: string;
1778
+ }
1779
+ interface PushNotificationRegistrationModel {
1780
+ /** Notification configured endpoint */
1781
+ NotificationEndpointARN?: string;
1782
+ /** Push notification platform */
1783
+ Platform?: string;
1784
+ }
1785
+ interface PushNotificationSegmentAction {
1786
+ /** Push notification template id. */
1787
+ PushNotificationTemplateId?: string;
1788
+ }
1789
+ interface PushNotificationSegmentFilter {
1790
+ /** Push notification device platform. */
1791
+ PushNotificationDevicePlatform?: string;
1792
+ }
1793
+ interface RandomResultTable {
1794
+ /** Child nodes that indicate what kind of drop table item this actually is. */
1795
+ Nodes: ResultTableNode[];
1796
+ /** Unique name for this drop table */
1797
+ TableId: string;
1798
+ }
1799
+ interface RandomResultTableListing {
1800
+ /** Catalog version this table is associated with */
1801
+ CatalogVersion?: string;
1802
+ /** Child nodes that indicate what kind of drop table item this actually is. */
1803
+ Nodes: ResultTableNode[];
1804
+ /** Unique name for this drop table */
1805
+ TableId: string;
1806
+ }
1807
+ interface RefundPurchaseRequest extends IPlayFabRequestCommon {
1808
+ /** Unique order ID for the purchase in question. */
1809
+ OrderId: string;
1810
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1811
+ PlayFabId: string;
1812
+ /**
1813
+ * The Reason parameter should correspond with the payment providers reason field, if they require one such as Facebook. In
1814
+ * the case of Facebook this must match one of their refund or dispute resolution enums (See:
1815
+ * https://developers.facebook.com/docs/payments/implementation-guide/handling-disputes-refunds)
1816
+ */
1817
+ Reason?: string;
1818
+ }
1819
+ interface RefundPurchaseResponse extends IPlayFabResultCommon {
1820
+ /** The order's updated purchase status. */
1821
+ PurchaseStatus?: string;
1822
+ }
1823
+ interface RemovePlayerTagRequest extends IPlayFabRequestCommon {
1824
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1825
+ CustomTags?: Record<string, string | null>;
1826
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1827
+ PlayFabId: string;
1828
+ /** Unique tag for player profile. */
1829
+ TagName: string;
1830
+ }
1831
+ interface RemovePlayerTagResult extends IPlayFabResultCommon {
1832
+ }
1833
+ interface RemoveVirtualCurrencyTypesRequest extends IPlayFabRequestCommon {
1834
+ /** List of virtual currencies to delete */
1835
+ VirtualCurrencies: VirtualCurrencyData[];
1836
+ }
1837
+ interface ResetCharacterStatisticsRequest extends IPlayFabRequestCommon {
1838
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
1839
+ CharacterId: string;
1840
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1841
+ CustomTags?: Record<string, string | null>;
1842
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1843
+ PlayFabId: string;
1844
+ }
1845
+ interface ResetCharacterStatisticsResult extends IPlayFabResultCommon {
1846
+ }
1847
+ interface ResetPasswordRequest extends IPlayFabRequestCommon {
1848
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1849
+ CustomTags?: Record<string, string | null>;
1850
+ /** The new password for the player. */
1851
+ Password: string;
1852
+ /** The token of the player requesting the password reset. */
1853
+ Token: string;
1854
+ }
1855
+ interface ResetPasswordResult extends IPlayFabResultCommon {
1856
+ }
1857
+ interface ResetUserStatisticsRequest extends IPlayFabRequestCommon {
1858
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1859
+ CustomTags?: Record<string, string | null>;
1860
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1861
+ PlayFabId: string;
1862
+ }
1863
+ interface ResetUserStatisticsResult extends IPlayFabResultCommon {
1864
+ }
1865
+ interface ResolvePurchaseDisputeRequest extends IPlayFabRequestCommon {
1866
+ /** Unique order ID for the purchase in question. */
1867
+ OrderId: string;
1868
+ /**
1869
+ * Enum for the desired purchase result state after notifying the payment provider. Valid values are Revoke, Reinstate and
1870
+ * Manual. Manual will cause no change to the order state.
1871
+ */
1872
+ Outcome: string;
1873
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1874
+ PlayFabId: string;
1875
+ /**
1876
+ * The Reason parameter should correspond with the payment providers reason field, if they require one such as Facebook. In
1877
+ * the case of Facebook this must match one of their refund or dispute resolution enums (See:
1878
+ * https://developers.facebook.com/docs/payments/implementation-guide/handling-disputes-refunds)
1879
+ */
1880
+ Reason?: string;
1881
+ }
1882
+ interface ResolvePurchaseDisputeResponse extends IPlayFabResultCommon {
1883
+ /** The order's updated purchase status. */
1884
+ PurchaseStatus?: string;
1885
+ }
1886
+ interface ResultTableNode {
1887
+ /** Either an ItemId, or the TableId of another random result table */
1888
+ ResultItem: string;
1889
+ /** Whether this entry in the table is an item or a link to another table */
1890
+ ResultItemType: string;
1891
+ /** How likely this is to be rolled - larger numbers add more weight */
1892
+ Weight: number;
1893
+ }
1894
+ interface RevokeAllBansForUserRequest extends IPlayFabRequestCommon {
1895
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1896
+ PlayFabId: string;
1897
+ }
1898
+ interface RevokeAllBansForUserResult extends IPlayFabResultCommon {
1899
+ /** Information on the bans that were revoked. */
1900
+ BanData?: BanInfo[];
1901
+ }
1902
+ interface RevokeBansRequest extends IPlayFabRequestCommon {
1903
+ /** Ids of the bans to be revoked. Maximum 100. */
1904
+ BanIds: string[];
1905
+ }
1906
+ interface RevokeBansResult extends IPlayFabResultCommon {
1907
+ /** Information on the bans that were revoked */
1908
+ BanData?: BanInfo[];
1909
+ }
1910
+ interface RevokeInventoryItem {
1911
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
1912
+ CharacterId?: string;
1913
+ /** Unique PlayFab assigned instance identifier of the item */
1914
+ ItemInstanceId: string;
1915
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1916
+ PlayFabId: string;
1917
+ }
1918
+ interface RevokeInventoryItemRequest extends IPlayFabRequestCommon {
1919
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
1920
+ CharacterId?: string;
1921
+ /** Unique PlayFab assigned instance identifier of the item */
1922
+ ItemInstanceId: string;
1923
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1924
+ PlayFabId: string;
1925
+ }
1926
+ interface RevokeInventoryItemsRequest extends IPlayFabRequestCommon {
1927
+ /** Array of player items to revoke, between 1 and 25 items. */
1928
+ Items: RevokeInventoryItem[];
1929
+ }
1930
+ interface RevokeInventoryItemsResult extends IPlayFabResultCommon {
1931
+ /** Collection of any errors that occurred during processing. */
1932
+ Errors?: RevokeItemError[];
1933
+ }
1934
+ interface RevokeInventoryResult extends IPlayFabResultCommon {
1935
+ }
1936
+ interface RevokeItemError {
1937
+ /** Specific error that was encountered. */
1938
+ Error?: string;
1939
+ /** Item information that failed to be revoked. */
1940
+ Item?: RevokeInventoryItem;
1941
+ }
1942
+ interface RunTaskRequest extends IPlayFabRequestCommon {
1943
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1944
+ CustomTags?: Record<string, string | null>;
1945
+ /** Provide either the task ID or the task name to run a task. */
1946
+ Identifier?: NameIdentifier;
1947
+ }
1948
+ interface RunTaskResult extends IPlayFabResultCommon {
1949
+ /**
1950
+ * ID of the task instance that is started. This can be used in Get*TaskInstance (e.g. GetCloudScriptTaskInstance) API call
1951
+ * to retrieve status for the task instance.
1952
+ */
1953
+ TaskInstanceId?: string;
1954
+ }
1955
+ interface ScheduledTask {
1956
+ /** Description the task */
1957
+ Description?: string;
1958
+ /** Whether the schedule is active. Inactive schedule will not trigger task execution. */
1959
+ IsActive: boolean;
1960
+ /** UTC time of last run */
1961
+ LastRunTime?: string;
1962
+ /** Name of the task. This is a unique identifier for tasks in the title. */
1963
+ Name: string;
1964
+ /** UTC time of next run */
1965
+ NextRunTime?: string;
1966
+ /**
1967
+ * Task parameter. Different types of task have different parameter structure. See each task type's create API
1968
+ * documentation for the details.
1969
+ */
1970
+ Parameter?: any;
1971
+ /** Cron expression for the run schedule of the task. The expression should be in UTC. */
1972
+ Schedule?: string;
1973
+ /** ID of the task */
1974
+ TaskId?: string;
1975
+ /** Task type. */
1976
+ Type?: string;
1977
+ }
1978
+ interface ScriptExecutionError {
1979
+ /**
1980
+ * Error code, such as CloudScriptNotFound, JavascriptException, CloudScriptFunctionArgumentSizeExceeded,
1981
+ * CloudScriptAPIRequestCountExceeded, CloudScriptAPIRequestError, or CloudScriptHTTPRequestError
1982
+ */
1983
+ Error?: string;
1984
+ /** Details about the error */
1985
+ Message?: string;
1986
+ /** Point during the execution of the script at which the error occurred, if any */
1987
+ StackTrace?: string;
1988
+ }
1989
+ interface SegmentAndDefinition {
1990
+ /** Filter property for ad campaign filter. */
1991
+ AdCampaignFilter?: AdCampaignSegmentFilter;
1992
+ /** property for all player filter. */
1993
+ AllPlayersFilter?: AllPlayersSegmentFilter;
1994
+ /** Filter property for player churn risk level. */
1995
+ ChurnPredictionFilter?: ChurnPredictionSegmentFilter;
1996
+ /** Filter property for boolean custom properties. */
1997
+ CustomPropertyBooleanFilter?: CustomPropertyBooleanSegmentFilter;
1998
+ /** Filter property for datetime custom properties. */
1999
+ CustomPropertyDateTimeFilter?: CustomPropertyDateTimeSegmentFilter;
2000
+ /** Filter property for numeric custom properties. */
2001
+ CustomPropertyNumericFilter?: CustomPropertyNumericSegmentFilter;
2002
+ /** Filter property for string custom properties. */
2003
+ CustomPropertyStringFilter?: CustomPropertyStringSegmentFilter;
2004
+ /** Filter property for first login date. */
2005
+ FirstLoginDateFilter?: FirstLoginDateSegmentFilter;
2006
+ /** Filter property for first login timespan. */
2007
+ FirstLoginFilter?: FirstLoginTimespanSegmentFilter;
2008
+ /** Filter property for last login date. */
2009
+ LastLoginDateFilter?: LastLoginDateSegmentFilter;
2010
+ /** Filter property for last login timespan. */
2011
+ LastLoginFilter?: LastLoginTimespanSegmentFilter;
2012
+ /** Filter property for linked in user account. */
2013
+ LinkedUserAccountFilter?: LinkedUserAccountSegmentFilter;
2014
+ /** Filter property for linked in user account has email. */
2015
+ LinkedUserAccountHasEmailFilter?: LinkedUserAccountHasEmailSegmentFilter;
2016
+ /** Filter property for location. */
2017
+ LocationFilter?: LocationSegmentFilter;
2018
+ /** Filter property for current player churn value. */
2019
+ PlayerChurnPredictionFilter?: PlayerChurnPredictionSegmentFilter;
2020
+ /** Filter property for player churn timespan. */
2021
+ PlayerChurnPredictionTimeFilter?: PlayerChurnPredictionTimeSegmentFilter;
2022
+ /** Filter property for previous player churn value. */
2023
+ PlayerChurnPreviousPredictionFilter?: PlayerChurnPreviousPredictionSegmentFilter;
2024
+ /** Filter property for push notification. */
2025
+ PushNotificationFilter?: PushNotificationSegmentFilter;
2026
+ /** Filter property for statistics. */
2027
+ StatisticFilter?: StatisticSegmentFilter;
2028
+ /** Filter property for tags. */
2029
+ TagFilter?: TagSegmentFilter;
2030
+ /** Filter property for total value to date in USD. */
2031
+ TotalValueToDateInUSDFilter?: TotalValueToDateInUSDSegmentFilter;
2032
+ /** Filter property for user origination. */
2033
+ UserOriginationFilter?: UserOriginationSegmentFilter;
2034
+ /** Filter property for value to date. */
2035
+ ValueToDateFilter?: ValueToDateSegmentFilter;
2036
+ /** Filter property for virtual currency. */
2037
+ VirtualCurrencyBalanceFilter?: VirtualCurrencyBalanceSegmentFilter;
2038
+ }
2039
+ interface SegmentModel {
2040
+ /** Segment description. */
2041
+ Description?: string;
2042
+ /** Segment actions for current entered segment players. */
2043
+ EnteredSegmentActions?: SegmentTrigger[];
2044
+ /** Segment last updated date time. */
2045
+ LastUpdateTime: string;
2046
+ /** Segment actions for current left segment players. */
2047
+ LeftSegmentActions?: SegmentTrigger[];
2048
+ /** Segment name. */
2049
+ Name?: string;
2050
+ /** Segment id in hex. */
2051
+ SegmentId?: string;
2052
+ /** Segment or definitions. This includes segment and definitions and filters. */
2053
+ SegmentOrDefinitions?: SegmentOrDefinition[];
2054
+ }
2055
+ interface SegmentOrDefinition {
2056
+ /** List of segment and definitions. */
2057
+ SegmentAndDefinitions?: SegmentAndDefinition[];
2058
+ }
2059
+ interface SegmentTrigger {
2060
+ /** Add inventory item v2 segment trigger action. */
2061
+ AddInventoryItemsV2Action?: AddInventoryItemsV2SegmentAction;
2062
+ /** Ban player segment trigger action. */
2063
+ BanPlayerAction?: BanPlayerSegmentAction;
2064
+ /** Delete inventory item v2 segment trigger action. */
2065
+ DeleteInventoryItemsV2Action?: DeleteInventoryItemsV2SegmentAction;
2066
+ /** Delete player segment trigger action. */
2067
+ DeletePlayerAction?: DeletePlayerSegmentAction;
2068
+ /** Delete player statistic segment trigger action. */
2069
+ DeletePlayerStatisticAction?: DeletePlayerStatisticSegmentAction;
2070
+ /** Email notification segment trigger action. */
2071
+ EmailNotificationAction?: EmailNotificationSegmentAction;
2072
+ /** Execute azure function segment trigger action. */
2073
+ ExecuteAzureFunctionAction?: ExecuteAzureFunctionSegmentAction;
2074
+ /** Execute cloud script segment trigger action. */
2075
+ ExecuteCloudScriptAction?: ExecuteCloudScriptSegmentAction;
2076
+ /** Grant item segment trigger action. */
2077
+ GrantItemAction?: GrantItemSegmentAction;
2078
+ /** Grant virtual currency segment trigger action. */
2079
+ GrantVirtualCurrencyAction?: GrantVirtualCurrencySegmentAction;
2080
+ /** Increment player statistic segment trigger action. */
2081
+ IncrementPlayerStatisticAction?: IncrementPlayerStatisticSegmentAction;
2082
+ /** Push notification segment trigger action. */
2083
+ PushNotificationAction?: PushNotificationSegmentAction;
2084
+ /** Subtract inventory item v2 segment trigger action. */
2085
+ SubtractInventoryItemsV2Action?: SubtractInventoryItemsV2SegmentAction;
2086
+ }
2087
+ interface SendAccountRecoveryEmailRequest extends IPlayFabRequestCommon {
2088
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2089
+ CustomTags?: Record<string, string | null>;
2090
+ /** User email address attached to their account */
2091
+ Email: string;
2092
+ /** The email template id of the account recovery email template to send. */
2093
+ EmailTemplateId?: string;
2094
+ }
2095
+ interface SendAccountRecoveryEmailResult extends IPlayFabResultCommon {
2096
+ }
2097
+ interface SendEmailContent {
2098
+ /** The email template id of the email template to send. */
2099
+ EmailTemplateId: string;
2100
+ }
2101
+ interface SetMembershipOverrideRequest extends IPlayFabRequestCommon {
2102
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2103
+ CustomTags?: Record<string, string | null>;
2104
+ /** Expiration time for the membership in DateTime format, will override any subscription expirations. */
2105
+ ExpirationTime: string;
2106
+ /** Id of the membership to apply the override expiration date to. */
2107
+ MembershipId: string;
2108
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2109
+ PlayFabId: string;
2110
+ }
2111
+ interface SetMembershipOverrideResult extends IPlayFabResultCommon {
2112
+ }
2113
+ interface SetPlayerSecretRequest extends IPlayFabRequestCommon {
2114
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
2115
+ PlayerSecret?: string;
2116
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2117
+ PlayFabId: string;
2118
+ }
2119
+ interface SetPlayerSecretResult extends IPlayFabResultCommon {
2120
+ }
2121
+ interface SetPublishedRevisionRequest extends IPlayFabRequestCommon {
2122
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2123
+ CustomTags?: Record<string, string | null>;
2124
+ /** Revision to make the current published revision */
2125
+ Revision: number;
2126
+ /** Version number */
2127
+ Version: number;
2128
+ }
2129
+ interface SetPublishedRevisionResult extends IPlayFabResultCommon {
2130
+ }
2131
+ interface SetPublisherDataRequest extends IPlayFabRequestCommon {
2132
+ /**
2133
+ * 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
2134
+ * name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.
2135
+ */
2136
+ Key: string;
2137
+ /** new value to set. Set to null to remove a value */
2138
+ Value?: string;
2139
+ }
2140
+ interface SetPublisherDataResult extends IPlayFabResultCommon {
2141
+ }
2142
+ interface SetTitleDataAndOverridesRequest extends IPlayFabRequestCommon {
2143
+ /**
2144
+ * List of titleData key-value pairs to set/delete. Use an empty value to delete an existing key; use a non-empty value to
2145
+ * create/update a key.
2146
+ */
2147
+ KeyValues: TitleDataKeyValue[];
2148
+ /** Name of the override. */
2149
+ OverrideLabel?: string;
2150
+ }
2151
+ interface SetTitleDataAndOverridesResult extends IPlayFabResultCommon {
2152
+ }
2153
+ interface SetTitleDataRequest extends IPlayFabRequestCommon {
2154
+ /**
2155
+ * 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
2156
+ * name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.
2157
+ */
2158
+ Key: string;
2159
+ /** new value to set. Set to null to remove a value */
2160
+ Value?: string;
2161
+ }
2162
+ interface SetTitleDataResult extends IPlayFabResultCommon {
2163
+ }
2164
+ interface SetupPushNotificationRequest extends IPlayFabRequestCommon {
2165
+ /** Credential is the Private Key for APNS/APNS_SANDBOX, and the API Key for GCM */
2166
+ Credential: string;
2167
+ /** for APNS, this is the PlatformPrincipal (SSL Certificate) */
2168
+ Key?: string;
2169
+ /** This field is deprecated and any usage of this will cause the API to fail. */
2170
+ Name?: string;
2171
+ /**
2172
+ * replace any existing ARN with the newly generated one. If this is set to false, an error will be returned if
2173
+ * notifications have already setup for this platform.
2174
+ */
2175
+ OverwriteOldARN: boolean;
2176
+ /**
2177
+ * supported notification platforms are Apple Push Notification Service (APNS and APNS_SANDBOX) for iOS and Google Cloud
2178
+ * Messaging (GCM) for Android
2179
+ */
2180
+ Platform: string;
2181
+ }
2182
+ interface SetupPushNotificationResult extends IPlayFabResultCommon {
2183
+ /** Amazon Resource Name for the created notification topic. */
2184
+ ARN?: string;
2185
+ }
2186
+ interface SharedSecret {
2187
+ /** Flag to indicate if this key is disabled */
2188
+ Disabled: boolean;
2189
+ /** Friendly name for this key */
2190
+ FriendlyName?: string;
2191
+ /** The player shared secret to use when calling Client/GetTitlePublicKey */
2192
+ SecretKey?: string;
2193
+ }
2194
+ interface StatisticModel {
2195
+ /** Statistic name */
2196
+ Name?: string;
2197
+ /** Statistic value */
2198
+ Value: number;
2199
+ /** Statistic version (0 if not a versioned statistic) */
2200
+ Version: number;
2201
+ }
2202
+ interface StatisticSegmentFilter {
2203
+ /** Statistic filter comparison. */
2204
+ Comparison?: string;
2205
+ /** Statistic filter value. */
2206
+ FilterValue?: string;
2207
+ /** Statistic name. */
2208
+ Name?: string;
2209
+ /** Use current version of statistic? */
2210
+ UseCurrentVersion?: boolean;
2211
+ /** Statistic version. */
2212
+ Version?: number;
2213
+ }
2214
+ interface StoreItem {
2215
+ /** Store specific custom data. The data only exists as part of this store; it is not transferred to item instances */
2216
+ CustomData?: any;
2217
+ /** Intended display position for this item. Note that 0 is the first position */
2218
+ DisplayPosition?: number;
2219
+ /**
2220
+ * Unique identifier of the item as it exists in the catalog - note that this must exactly match the ItemId from the
2221
+ * catalog
2222
+ */
2223
+ ItemId: string;
2224
+ /** Override prices for this item for specific currencies */
2225
+ RealCurrencyPrices?: Record<string, number>;
2226
+ /** Override prices for this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
2227
+ VirtualCurrencyPrices?: Record<string, number>;
2228
+ }
2229
+ interface StoreMarketingModel {
2230
+ /** Tagline for a store. */
2231
+ Description?: string;
2232
+ /** Display name of a store as it will appear to users. */
2233
+ DisplayName?: string;
2234
+ /** Custom data about a store. */
2235
+ Metadata?: any;
2236
+ }
2237
+ interface SubscriptionModel {
2238
+ /** When this subscription expires. */
2239
+ Expiration: string;
2240
+ /** The time the subscription was orignially purchased */
2241
+ InitialSubscriptionTime: string;
2242
+ /** Whether this subscription is currently active. That is, if Expiration > now. */
2243
+ IsActive: boolean;
2244
+ /** The status of this subscription, according to the subscription provider. */
2245
+ Status?: string;
2246
+ /** The id for this subscription */
2247
+ SubscriptionId?: string;
2248
+ /** The item id for this subscription from the primary catalog */
2249
+ SubscriptionItemId?: string;
2250
+ /** The provider for this subscription. Apple or Google Play are supported today. */
2251
+ SubscriptionProvider?: string;
2252
+ }
2253
+ interface SubtractInventoryItemsV2SegmentAction {
2254
+ /** Amount of the item to removed from the player */
2255
+ Amount?: number;
2256
+ /** The collection id for where the item will be removed from the player inventory */
2257
+ CollectionId?: string;
2258
+ /** The duration in seconds to be removed from the subscription in the players inventory */
2259
+ DurationInSeconds?: number;
2260
+ /** The id of item to be removed from the player */
2261
+ ItemId?: string;
2262
+ /** The stack id for where the item will be removed from the player inventory */
2263
+ StackId?: string;
2264
+ }
2265
+ interface SubtractInventoryItemV2Content {
2266
+ /** Amount of the item to removed from the player */
2267
+ Amount?: number;
2268
+ /** The collection id for where the item will be removed from the player inventory */
2269
+ CollectionId?: string;
2270
+ /** The duration in seconds to be removed from the subscription in the players inventory */
2271
+ DurationInSeconds?: number;
2272
+ /** The id of item to be removed from the player */
2273
+ ItemId?: string;
2274
+ /** The stack id for where the item will be removed from the player inventory */
2275
+ StackId?: string;
2276
+ }
2277
+ interface SubtractUserVirtualCurrencyRequest extends IPlayFabRequestCommon {
2278
+ /** Amount to be subtracted from the user balance of the specified virtual currency. */
2279
+ Amount: number;
2280
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2281
+ CustomTags?: Record<string, string | null>;
2282
+ /** PlayFab unique identifier of the user whose virtual currency balance is to be decreased. */
2283
+ PlayFabId: string;
2284
+ /** Name of the virtual currency which is to be decremented. */
2285
+ VirtualCurrency: string;
2286
+ }
2287
+ interface TagModel {
2288
+ /** Full value of the tag, including namespace */
2289
+ TagValue?: string;
2290
+ }
2291
+ interface TagSegmentFilter {
2292
+ /** Tag comparison. */
2293
+ Comparison?: string;
2294
+ /** Tag value. */
2295
+ TagValue?: string;
2296
+ }
2297
+ interface TaskInstanceBasicSummary {
2298
+ /** UTC timestamp when the task completed. */
2299
+ CompletedAt?: string;
2300
+ /** Error message for last processing attempt, if an error occured. */
2301
+ ErrorMessage?: string;
2302
+ /** Estimated time remaining in seconds. */
2303
+ EstimatedSecondsRemaining?: number;
2304
+ /** Progress represented as percentage. */
2305
+ PercentComplete?: number;
2306
+ /** If manually scheduled, ID of user who scheduled the task. */
2307
+ ScheduledByUserId?: string;
2308
+ /** UTC timestamp when the task started. */
2309
+ StartedAt: string;
2310
+ /** Current status of the task instance. */
2311
+ Status?: string;
2312
+ /** Identifier of the task this instance belongs to. */
2313
+ TaskIdentifier?: NameIdentifier;
2314
+ /** ID of the task instance. */
2315
+ TaskInstanceId?: string;
2316
+ /** Type of the task. */
2317
+ Type?: string;
2318
+ }
2319
+ interface TitleDataKeyValue {
2320
+ /**
2321
+ * 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
2322
+ * name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.
2323
+ */
2324
+ Key?: string;
2325
+ /** New value to set. Set to null to remove a value */
2326
+ Value?: string;
2327
+ }
2328
+ interface TotalValueToDateInUSDSegmentFilter {
2329
+ /** Total value to date USD amount. */
2330
+ Amount?: string;
2331
+ /** Total value to date USD comparison. */
2332
+ Comparison?: string;
2333
+ }
2334
+ interface UpdateBanRequest {
2335
+ /** The updated active state for the ban. Null for no change. */
2336
+ Active?: boolean;
2337
+ /** The id of the ban to be updated. */
2338
+ BanId: string;
2339
+ /** The updated expiration date for the ban. Null for no change. */
2340
+ Expires?: string;
2341
+ /** The updated IP address for the ban. Null for no change. */
2342
+ IPAddress?: string;
2343
+ /** Whether to make this ban permanent. Set to true to make this ban permanent. This will not modify Active state. */
2344
+ Permanent?: boolean;
2345
+ /** The updated reason for the ban to be updated. Maximum 140 characters. Null for no change. */
2346
+ Reason?: string;
2347
+ /** The updated family type of the user that should be included in the ban. Null for no change. */
2348
+ UserFamilyType?: string;
2349
+ }
2350
+ interface UpdateBansRequest extends IPlayFabRequestCommon {
2351
+ /** List of bans to be updated. Maximum 100. */
2352
+ Bans: UpdateBanRequest[];
2353
+ }
2354
+ interface UpdateBansResult extends IPlayFabResultCommon {
2355
+ /** Information on the bans that were updated */
2356
+ BanData?: BanInfo[];
2357
+ }
2358
+ interface UpdateCatalogItemsRequest extends IPlayFabRequestCommon {
2359
+ /**
2360
+ * Array of catalog items to be submitted. Note that while CatalogItem has a parameter for CatalogVersion, it is not
2361
+ * required and ignored in this call.
2362
+ */
2363
+ Catalog?: CatalogItem[];
2364
+ /** Which catalog is being updated. If null, uses the default catalog. */
2365
+ CatalogVersion?: string;
2366
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2367
+ CustomTags?: Record<string, string | null>;
2368
+ /**
2369
+ * Should this catalog be set as the default catalog. Defaults to true. If there is currently no default catalog, this will
2370
+ * always set it.
2371
+ */
2372
+ SetAsDefaultCatalog?: boolean;
2373
+ }
2374
+ interface UpdateCatalogItemsResult extends IPlayFabResultCommon {
2375
+ }
2376
+ interface UpdateCloudScriptRequest extends IPlayFabRequestCommon {
2377
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2378
+ CustomTags?: Record<string, string | null>;
2379
+ /** PlayFab user ID of the developer initiating the request. */
2380
+ DeveloperPlayFabId?: string;
2381
+ /** List of Cloud Script files to upload to create the new revision. Must have at least one file. */
2382
+ Files: CloudScriptFile[];
2383
+ /** Immediately publish the new revision */
2384
+ Publish: boolean;
2385
+ }
2386
+ interface UpdateCloudScriptResult extends IPlayFabResultCommon {
2387
+ /** New revision number created */
2388
+ Revision: number;
2389
+ /** Cloud Script version updated */
2390
+ Version: number;
2391
+ }
2392
+ interface UpdateOpenIdConnectionRequest extends IPlayFabRequestCommon {
2393
+ /** The client ID given by the ID provider. */
2394
+ ClientId?: string;
2395
+ /** The client secret given by the ID provider. */
2396
+ ClientSecret?: string;
2397
+ /** A name for the connection that identifies it within the title. */
2398
+ ConnectionId: string;
2399
+ /** Ignore 'nonce' claim in identity tokens. */
2400
+ IgnoreNonce?: boolean;
2401
+ /** The issuer URL or discovery document URL to read issuer information from */
2402
+ IssuerDiscoveryUrl?: string;
2403
+ /** Manually specified information for an OpenID Connect issuer. */
2404
+ IssuerInformation?: OpenIdIssuerInformation;
2405
+ /** Override the issuer name for user indexing and lookup. */
2406
+ IssuerOverride?: string;
2407
+ }
2408
+ interface UpdatePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
2409
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2410
+ CustomTags?: Record<string, string | null>;
2411
+ /**
2412
+ * Optional field used for concurrency control. One can ensure that the update operation will only be performed if the
2413
+ * player's properties have not been updated by any other clients since last the version.
2414
+ */
2415
+ ExpectedPropertiesVersion?: number;
2416
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2417
+ PlayFabId: string;
2418
+ /** Collection of properties to be set for a player. */
2419
+ Properties: UpdateProperty[];
2420
+ }
2421
+ interface UpdatePlayerCustomPropertiesResult extends IPlayFabResultCommon {
2422
+ /** PlayFab unique identifier of the user whose properties were updated. */
2423
+ PlayFabId?: string;
2424
+ /**
2425
+ * Indicates the current version of a player's properties that have been set. This is incremented after updates and
2426
+ * deletes. This version can be provided in update and delete calls for concurrency control.
2427
+ */
2428
+ PropertiesVersion: number;
2429
+ }
2430
+ interface UpdatePlayerSharedSecretRequest extends IPlayFabRequestCommon {
2431
+ /** Disable or Enable this key */
2432
+ Disabled: boolean;
2433
+ /** Friendly name for this key */
2434
+ FriendlyName?: string;
2435
+ /** The shared secret key to update */
2436
+ SecretKey?: string;
2437
+ }
2438
+ interface UpdatePlayerSharedSecretResult extends IPlayFabResultCommon {
2439
+ }
2440
+ interface UpdatePlayerStatisticDefinitionRequest extends IPlayFabRequestCommon {
2441
+ /** the aggregation method to use in updating the statistic (defaults to last) */
2442
+ AggregationMethod?: string;
2443
+ /** unique name of the statistic */
2444
+ StatisticName: string;
2445
+ /**
2446
+ * interval at which the values of the statistic for all players are reset (changes are effective at the next occurance of
2447
+ * the new interval boundary)
2448
+ */
2449
+ VersionChangeInterval?: string;
2450
+ }
2451
+ interface UpdatePlayerStatisticDefinitionResult extends IPlayFabResultCommon {
2452
+ /** updated statistic definition */
2453
+ Statistic?: PlayerStatisticDefinition;
2454
+ }
2455
+ interface UpdatePolicyRequest extends IPlayFabRequestCommon {
2456
+ /** Whether to overwrite or append to the existing policy. */
2457
+ OverwritePolicy: boolean;
2458
+ /** The name of the policy being updated. Only supported name is 'ApiPolicy' */
2459
+ PolicyName: string;
2460
+ /** Version of the policy to update. Must be the latest (as returned by GetPolicy). */
2461
+ PolicyVersion: number;
2462
+ /** The new statements to include in the policy. */
2463
+ Statements: PermissionStatement[];
2464
+ }
2465
+ interface UpdatePolicyResponse extends IPlayFabResultCommon {
2466
+ /** The name of the policy that was updated. */
2467
+ PolicyName?: string;
2468
+ /** The statements included in the new version of the policy. */
2469
+ Statements?: PermissionStatement[];
2470
+ }
2471
+ interface UpdateProperty {
2472
+ /** Name of the custom property. Can contain Unicode letters and digits. They are limited in size. */
2473
+ Name: string;
2474
+ /** Value of the custom property. Limited to booleans, numbers, and strings. */
2475
+ Value: any;
2476
+ }
2477
+ interface UpdateRandomResultTablesRequest extends IPlayFabRequestCommon {
2478
+ /** which catalog is being updated. If null, update the current default catalog version */
2479
+ CatalogVersion?: string;
2480
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2481
+ CustomTags?: Record<string, string | null>;
2482
+ /**
2483
+ * array of random result tables to make available (Note: specifying an existing TableId will result in overwriting that
2484
+ * table, while any others will be added to the available set)
2485
+ */
2486
+ Tables?: RandomResultTable[];
2487
+ }
2488
+ interface UpdateRandomResultTablesResult extends IPlayFabResultCommon {
2489
+ }
2490
+ interface UpdateSegmentRequest extends IPlayFabRequestCommon {
2491
+ /** Segment model with all of the segment properties data. */
2492
+ SegmentModel: SegmentModel;
2493
+ }
2494
+ interface UpdateSegmentResponse extends IPlayFabResultCommon {
2495
+ /** Error message. */
2496
+ ErrorMessage?: string;
2497
+ /** Segment id. */
2498
+ SegmentId?: string;
2499
+ }
2500
+ interface UpdateStoreItemsRequest extends IPlayFabRequestCommon {
2501
+ /** Catalog version of the store to update. If null, uses the default catalog. */
2502
+ CatalogVersion?: string;
2503
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2504
+ CustomTags?: Record<string, string | null>;
2505
+ /** Additional data about the store */
2506
+ MarketingData?: StoreMarketingModel;
2507
+ /** Array of store items - references to catalog items, with specific pricing - to be added */
2508
+ Store?: StoreItem[];
2509
+ /** Unique identifier for the store which is to be updated */
2510
+ StoreId: string;
2511
+ }
2512
+ interface UpdateStoreItemsResult extends IPlayFabResultCommon {
2513
+ }
2514
+ interface UpdateTaskRequest extends IPlayFabRequestCommon {
2515
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2516
+ CustomTags?: Record<string, string | null>;
2517
+ /** Description the task */
2518
+ Description?: string;
2519
+ /** Specify either the task ID or the name of the task to be updated. */
2520
+ Identifier?: NameIdentifier;
2521
+ /** Whether the schedule is active. Inactive schedule will not trigger task execution. */
2522
+ IsActive: boolean;
2523
+ /** Name of the task. This is a unique identifier for tasks in the title. */
2524
+ Name: string;
2525
+ /** Parameter object specific to the task type. See each task type's create API documentation for details. */
2526
+ Parameter?: any;
2527
+ /** Cron expression for the run schedule of the task. The expression should be in UTC. */
2528
+ Schedule?: string;
2529
+ /** Task type. */
2530
+ Type: string;
2531
+ }
2532
+ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
2533
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2534
+ CustomTags?: Record<string, string | null>;
2535
+ /**
2536
+ * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
2537
+ * not begin with a '!' character or be null.
2538
+ */
2539
+ Data?: Record<string, string | null>;
2540
+ /**
2541
+ * Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
2542
+ * constraints. Use this to delete the keys directly.
2543
+ */
2544
+ KeysToRemove?: string[];
2545
+ /** Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. */
2546
+ Permission?: string;
2547
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2548
+ PlayFabId: string;
2549
+ }
2550
+ interface UpdateUserDataResult extends IPlayFabResultCommon {
2551
+ /**
2552
+ * Indicates the current version of the data that has been set. This is incremented with every set call for that type of
2553
+ * data (read-only, internal, etc). This version can be provided in Get calls to find updated data.
2554
+ */
2555
+ DataVersion: number;
2556
+ }
2557
+ interface UpdateUserInternalDataRequest extends IPlayFabRequestCommon {
2558
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2559
+ CustomTags?: Record<string, string | null>;
2560
+ /**
2561
+ * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
2562
+ * not begin with a '!' character or be null.
2563
+ */
2564
+ Data?: Record<string, string | null>;
2565
+ /**
2566
+ * Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
2567
+ * constraints. Use this to delete the keys directly.
2568
+ */
2569
+ KeysToRemove?: string[];
2570
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2571
+ PlayFabId: string;
2572
+ }
2573
+ interface UpdateUserTitleDisplayNameRequest extends IPlayFabRequestCommon {
2574
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2575
+ CustomTags?: Record<string, string | null>;
2576
+ /** New title display name for the user - must be between 3 and 25 characters */
2577
+ DisplayName: string;
2578
+ /** PlayFab unique identifier of the user whose title specific display name is to be changed */
2579
+ PlayFabId: string;
2580
+ }
2581
+ interface UpdateUserTitleDisplayNameResult extends IPlayFabResultCommon {
2582
+ /** current title display name for the user (this will be the original display name if the rename attempt failed) */
2583
+ DisplayName?: string;
2584
+ }
2585
+ interface UserAccountInfo {
2586
+ /** User Android device information, if an Android device has been linked */
2587
+ AndroidDeviceInfo?: UserAndroidDeviceInfo;
2588
+ /** Sign in with Apple account information, if an Apple account has been linked */
2589
+ AppleAccountInfo?: UserAppleIdInfo;
2590
+ /** Battle.net account information, if a Battle.net account has been linked */
2591
+ BattleNetAccountInfo?: UserBattleNetInfo;
2592
+ /** Timestamp indicating when the user account was created */
2593
+ Created: string;
2594
+ /** Custom ID information, if a custom ID has been assigned */
2595
+ CustomIdInfo?: UserCustomIdInfo;
2596
+ /** User Facebook information, if a Facebook account has been linked */
2597
+ FacebookInfo?: UserFacebookInfo;
2598
+ /** Facebook Instant Games account information, if a Facebook Instant Games account has been linked */
2599
+ FacebookInstantGamesIdInfo?: UserFacebookInstantGamesIdInfo;
2600
+ /** User Gamecenter information, if a Gamecenter account has been linked */
2601
+ GameCenterInfo?: UserGameCenterInfo;
2602
+ /** User Google account information, if a Google account has been linked */
2603
+ GoogleInfo?: UserGoogleInfo;
2604
+ /** User Google Play Games account information, if a Google Play Games account has been linked */
2605
+ GooglePlayGamesInfo?: UserGooglePlayGamesInfo;
2606
+ /** User iOS device information, if an iOS device has been linked */
2607
+ IosDeviceInfo?: UserIosDeviceInfo;
2608
+ /** User Kongregate account information, if a Kongregate account has been linked */
2609
+ KongregateInfo?: UserKongregateInfo;
2610
+ /** Nintendo Switch account information, if a Nintendo Switch account has been linked */
2611
+ NintendoSwitchAccountInfo?: UserNintendoSwitchAccountIdInfo;
2612
+ /** Nintendo Switch device information, if a Nintendo Switch device has been linked */
2613
+ NintendoSwitchDeviceIdInfo?: UserNintendoSwitchDeviceIdInfo;
2614
+ /** OpenID Connect information, if any OpenID Connect accounts have been linked */
2615
+ OpenIdInfo?: UserOpenIdInfo[];
2616
+ /** Unique identifier for the user account */
2617
+ PlayFabId?: string;
2618
+ /** Personal information for the user which is considered more sensitive */
2619
+ PrivateInfo?: UserPrivateAccountInfo;
2620
+ /** User PlayStation :tm: Network account information, if a PlayStation :tm: Network account has been linked */
2621
+ PsnInfo?: UserPsnInfo;
2622
+ /** Server Custom ID information, if a server custom ID has been assigned */
2623
+ ServerCustomIdInfo?: UserServerCustomIdInfo;
2624
+ /** User Steam information, if a Steam account has been linked */
2625
+ SteamInfo?: UserSteamInfo;
2626
+ /** Title-specific information for the user account */
2627
+ TitleInfo?: UserTitleInfo;
2628
+ /** User Twitch account information, if a Twitch account has been linked */
2629
+ TwitchInfo?: UserTwitchInfo;
2630
+ /** User account name in the PlayFab service */
2631
+ Username?: string;
2632
+ /** User XBox account information, if a XBox account has been linked */
2633
+ XboxInfo?: UserXboxInfo;
2634
+ }
2635
+ interface UserAndroidDeviceInfo {
2636
+ /** Android device ID */
2637
+ AndroidDeviceId?: string;
2638
+ }
2639
+ interface UserAppleIdInfo {
2640
+ /** Apple subject ID */
2641
+ AppleSubjectId?: string;
2642
+ }
2643
+ interface UserBattleNetInfo {
2644
+ /** Battle.net identifier */
2645
+ BattleNetAccountId?: string;
2646
+ /** Battle.net display name */
2647
+ BattleNetBattleTag?: string;
2648
+ }
2649
+ interface UserCustomIdInfo {
2650
+ /** Custom ID */
2651
+ CustomId?: string;
2652
+ }
2653
+ interface UserDataRecord {
2654
+ /** Timestamp for when this data was last updated. */
2655
+ LastUpdated: string;
2656
+ /**
2657
+ * Indicates whether this data can be read by all users (public) or only the user (private). This is used for GetUserData
2658
+ * requests being made by one player about another player.
2659
+ */
2660
+ Permission?: string;
2661
+ /** Data stored for the specified user data key. */
2662
+ Value?: string;
2663
+ }
2664
+ interface UserFacebookInfo {
2665
+ /** Facebook identifier */
2666
+ FacebookId?: string;
2667
+ /** Facebook full name */
2668
+ FullName?: string;
2669
+ }
2670
+ interface UserFacebookInstantGamesIdInfo {
2671
+ /** Facebook Instant Games ID */
2672
+ FacebookInstantGamesId?: string;
2673
+ }
2674
+ interface UserGameCenterInfo {
2675
+ /** Gamecenter identifier */
2676
+ GameCenterId?: string;
2677
+ }
2678
+ interface UserGoogleInfo {
2679
+ /** Email address of the Google account */
2680
+ GoogleEmail?: string;
2681
+ /** Gender information of the Google account */
2682
+ GoogleGender?: string;
2683
+ /** Google ID */
2684
+ GoogleId?: string;
2685
+ /** Locale of the Google account */
2686
+ GoogleLocale?: string;
2687
+ /** Name of the Google account user */
2688
+ GoogleName?: string;
2689
+ }
2690
+ interface UserGooglePlayGamesInfo {
2691
+ /** Avatar image url of the Google Play Games player */
2692
+ GooglePlayGamesPlayerAvatarImageUrl?: string;
2693
+ /** Display name of the Google Play Games player */
2694
+ GooglePlayGamesPlayerDisplayName?: string;
2695
+ /** Google Play Games player ID */
2696
+ GooglePlayGamesPlayerId?: string;
2697
+ }
2698
+ interface UserIosDeviceInfo {
2699
+ /** iOS device ID */
2700
+ IosDeviceId?: string;
2701
+ }
2702
+ interface UserKongregateInfo {
2703
+ /** Kongregate ID */
2704
+ KongregateId?: string;
2705
+ /** Kongregate Username */
2706
+ KongregateName?: string;
2707
+ }
2708
+ interface UserNintendoSwitchAccountIdInfo {
2709
+ /** Nintendo Switch account subject ID */
2710
+ NintendoSwitchAccountSubjectId?: string;
2711
+ }
2712
+ interface UserNintendoSwitchDeviceIdInfo {
2713
+ /** Nintendo Switch Device ID */
2714
+ NintendoSwitchDeviceId?: string;
2715
+ }
2716
+ interface UserOpenIdInfo {
2717
+ /** OpenID Connection ID */
2718
+ ConnectionId?: string;
2719
+ /** OpenID Issuer */
2720
+ Issuer?: string;
2721
+ /** OpenID Subject */
2722
+ Subject?: string;
2723
+ }
2724
+ interface UserOriginationSegmentFilter {
2725
+ /** User login provider. */
2726
+ LoginProvider?: string;
2727
+ }
2728
+ interface UserPrivateAccountInfo {
2729
+ /** user email address */
2730
+ Email?: string;
2731
+ }
2732
+ interface UserPsnInfo {
2733
+ /** PlayStation :tm: Network account ID */
2734
+ PsnAccountId?: string;
2735
+ /** PlayStation :tm: Network online ID */
2736
+ PsnOnlineId?: string;
2737
+ }
2738
+ interface UserServerCustomIdInfo {
2739
+ /** Custom ID */
2740
+ CustomId?: string;
2741
+ }
2742
+ interface UserSteamInfo {
2743
+ /** what stage of game ownership the user is listed as being in, from Steam */
2744
+ SteamActivationStatus?: string;
2745
+ /** the country in which the player resides, from Steam data */
2746
+ SteamCountry?: string;
2747
+ /** currency type set in the user Steam account */
2748
+ SteamCurrency?: string;
2749
+ /** Steam identifier */
2750
+ SteamId?: string;
2751
+ /** Steam display name */
2752
+ SteamName?: string;
2753
+ }
2754
+ interface UserTitleInfo {
2755
+ /** URL to the player's avatar. */
2756
+ AvatarUrl?: string;
2757
+ /**
2758
+ * timestamp indicating when the user was first associated with this game (this can differ significantly from when the user
2759
+ * first registered with PlayFab)
2760
+ */
2761
+ Created: string;
2762
+ /** name of the user, as it is displayed in-game */
2763
+ DisplayName?: string;
2764
+ /**
2765
+ * timestamp indicating when the user first signed into this game (this can differ from the Created timestamp, as other
2766
+ * events, such as issuing a beta key to the user, can associate the title to the user)
2767
+ */
2768
+ FirstLogin?: string;
2769
+ /** boolean indicating whether or not the user is currently banned for a title */
2770
+ isBanned?: boolean;
2771
+ /** timestamp for the last user login for this title */
2772
+ LastLogin?: string;
2773
+ /** source by which the user first joined the game, if known */
2774
+ Origination?: string;
2775
+ /** Title player account entity for this user */
2776
+ TitlePlayerAccount?: EntityKey;
2777
+ }
2778
+ interface UserTwitchInfo {
2779
+ /** Twitch ID */
2780
+ TwitchId?: string;
2781
+ /** Twitch Username */
2782
+ TwitchUserName?: string;
2783
+ }
2784
+ interface UserXboxInfo {
2785
+ /** XBox user ID */
2786
+ XboxUserId?: string;
2787
+ /** XBox user sandbox */
2788
+ XboxUserSandbox?: string;
2789
+ }
2790
+ interface ValueToDateModel {
2791
+ /** ISO 4217 code of the currency used in the purchases */
2792
+ Currency?: string;
2793
+ /**
2794
+ * Total value of the purchases in a whole number of 1/100 monetary units. For example, 999 indicates nine dollars and
2795
+ * ninety-nine cents when Currency is 'USD')
2796
+ */
2797
+ TotalValue: number;
2798
+ /**
2799
+ * Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine
2800
+ * dollars and ninety-nine cents when Currency is 'USD'.
2801
+ */
2802
+ TotalValueAsDecimal?: string;
2803
+ }
2804
+ interface ValueToDateSegmentFilter {
2805
+ /** Value to date amount. */
2806
+ Amount?: string;
2807
+ /** Value to date comparison. */
2808
+ Comparison?: string;
2809
+ /** Currency using for filter. */
2810
+ Currency?: string;
2811
+ }
2812
+ interface VirtualCurrencyBalanceSegmentFilter {
2813
+ /** Total amount. */
2814
+ Amount: number;
2815
+ /** Amount comparison. */
2816
+ Comparison?: string;
2817
+ /** Currency code. */
2818
+ CurrencyCode?: string;
2819
+ }
2820
+ interface VirtualCurrencyData {
2821
+ /** unique two-character identifier for this currency type (e.g.: "CC") */
2822
+ CurrencyCode: string;
2823
+ /** friendly name to show in the developer portal, reports, etc. */
2824
+ DisplayName?: string;
2825
+ /** amount to automatically grant users upon first login to the title */
2826
+ InitialDeposit?: number;
2827
+ /** maximum amount to which the currency will recharge (cannot exceed MaxAmount, but can be less) */
2828
+ RechargeMax?: number;
2829
+ /** rate at which the currency automatically be added to over time, in units per day (24 hours) */
2830
+ RechargeRate?: number;
2831
+ }
2832
+ interface VirtualCurrencyRechargeTime {
2833
+ /**
2834
+ * Maximum value to which the regenerating currency will automatically increment. Note that it can exceed this value
2835
+ * through use of the AddUserVirtualCurrency API call. However, it will not regenerate automatically until it has fallen
2836
+ * below this value.
2837
+ */
2838
+ RechargeMax: number;
2839
+ /** Server timestamp in UTC indicating the next time the virtual currency will be incremented. */
2840
+ RechargeTime: string;
2841
+ /** Time remaining (in seconds) before the next recharge increment of the virtual currency. */
2842
+ SecondsToRecharge: number;
2843
+ }
2844
+
2845
+ declare class PlayFabAdminApi extends PlayFabCommon {
2846
+ /**
2847
+ * Abort an ongoing task instance.
2848
+ * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/aborttaskinstance
2849
+ */
2850
+ AbortTaskInstance(request: AbortTaskInstanceRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2851
+ /**
2852
+ * Update news item to include localized version
2853
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addlocalizednews
2854
+ */
2855
+ AddLocalizedNews(request: AddLocalizedNewsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddLocalizedNewsResult>;
2856
+ /**
2857
+ * Adds a new news item to the title's news feed
2858
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addnews
2859
+ */
2860
+ AddNews(request: AddNewsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddNewsResult>;
2861
+ /**
2862
+ * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
2863
+ * https://docs.microsoft.com/rest/api/playfab/admin/playstream/addplayertag
2864
+ */
2865
+ AddPlayerTag(request: AddPlayerTagRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddPlayerTagResult>;
2866
+ /**
2867
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2868
+ * version 2._ Increments the specified virtual currency by the stated amount
2869
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/adduservirtualcurrency
2870
+ */
2871
+ AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
2872
+ /**
2873
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2874
+ * version 2._ Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum
2875
+ * value of 2,147,483,647 when granted to a player. Any value over that will be discarded.
2876
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addvirtualcurrencytypes
2877
+ */
2878
+ AddVirtualCurrencyTypes(request: AddVirtualCurrencyTypesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<BlankResult>;
2879
+ /**
2880
+ * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
2881
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/banusers
2882
+ */
2883
+ BanUsers(request: BanUsersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<BanUsersResult>;
2884
+ /**
2885
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2886
+ * version 2._ Checks the global count for the limited edition item.
2887
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/checklimitededitionitemavailability
2888
+ */
2889
+ CheckLimitedEditionItemAvailability(request: CheckLimitedEditionItemAvailabilityRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CheckLimitedEditionItemAvailabilityResult>;
2890
+ /**
2891
+ * Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.
2892
+ * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createactionsonplayersinsegmenttask
2893
+ */
2894
+ CreateActionsOnPlayersInSegmentTask(request: CreateActionsOnPlayerSegmentTaskRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
2895
+ /**
2896
+ * Create a CloudScript task, which can run a CloudScript on a schedule.
2897
+ * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createcloudscripttask
2898
+ */
2899
+ CreateCloudScriptTask(request: CreateCloudScriptTaskRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
2900
+ /**
2901
+ * Create a Insights Scheduled Scaling task, which can scale Insights Performance Units on a schedule
2902
+ * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createinsightsscheduledscalingtask
2903
+ */
2904
+ CreateInsightsScheduledScalingTask(request: CreateInsightsScheduledScalingTaskRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
2905
+ /**
2906
+ * Registers a relationship between a title and an Open ID Connect provider.
2907
+ * https://docs.microsoft.com/rest/api/playfab/admin/authentication/createopenidconnection
2908
+ */
2909
+ CreateOpenIdConnection(request: CreateOpenIdConnectionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2910
+ /**
2911
+ * Creates a new Player Shared Secret Key. It may take up to 5 minutes for this key to become generally available after
2912
+ * this API returns.
2913
+ * https://docs.microsoft.com/rest/api/playfab/admin/authentication/createplayersharedsecret
2914
+ */
2915
+ CreatePlayerSharedSecret(request: CreatePlayerSharedSecretRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreatePlayerSharedSecretResult>;
2916
+ /**
2917
+ * Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval
2918
+ * and an aggregation method.
2919
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/createplayerstatisticdefinition
2920
+ */
2921
+ CreatePlayerStatisticDefinition(request: CreatePlayerStatisticDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreatePlayerStatisticDefinitionResult>;
2922
+ /**
2923
+ * Creates a new player segment by defining the conditions on player properties. Also, create actions to target the player
2924
+ * segments for a title.
2925
+ * https://docs.microsoft.com/rest/api/playfab/admin/segments/createsegment
2926
+ */
2927
+ CreateSegment(request: CreateSegmentRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateSegmentResponse>;
2928
+ /**
2929
+ * Delete a content file from the title. When deleting a file that does not exist, it returns success.
2930
+ * https://docs.microsoft.com/rest/api/playfab/admin/content/deletecontent
2931
+ */
2932
+ DeleteContent(request: DeleteContentRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<BlankResult>;
2933
+ /**
2934
+ * Removes a master player account entirely from all titles and deletes all associated data
2935
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayeraccount
2936
+ */
2937
+ DeleteMasterPlayerAccount(request: DeleteMasterPlayerAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteMasterPlayerAccountResult>;
2938
+ /**
2939
+ * Deletes PlayStream and telemetry event data associated with the master player account from PlayFab storage
2940
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayereventdata
2941
+ */
2942
+ DeleteMasterPlayerEventData(request: DeleteMasterPlayerEventDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteMasterPlayerEventDataResult>;
2943
+ /**
2944
+ * Deletes a player's subscription
2945
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemembershipsubscription
2946
+ */
2947
+ DeleteMembershipSubscription(request: DeleteMembershipSubscriptionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteMembershipSubscriptionResult>;
2948
+ /**
2949
+ * Removes a relationship between a title and an OpenID Connect provider.
2950
+ * https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteopenidconnection
2951
+ */
2952
+ DeleteOpenIdConnection(request: DeleteOpenIdConnectionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2953
+ /**
2954
+ * Removes a user's player account from a title and deletes all associated data
2955
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/deleteplayer
2956
+ */
2957
+ DeletePlayer(request: DeletePlayerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeletePlayerResult>;
2958
+ /**
2959
+ * Deletes title-specific custom properties for a player
2960
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/deleteplayercustomproperties
2961
+ */
2962
+ DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeletePlayerCustomPropertiesResult>;
2963
+ /**
2964
+ * Deletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API
2965
+ * returns.
2966
+ * https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteplayersharedsecret
2967
+ */
2968
+ DeletePlayerSharedSecret(request: DeletePlayerSharedSecretRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeletePlayerSharedSecretResult>;
2969
+ /**
2970
+ * Deletes an existing player segment and its associated action(s) for a title.
2971
+ * https://docs.microsoft.com/rest/api/playfab/admin/segments/deletesegment
2972
+ */
2973
+ DeleteSegment(request: DeleteSegmentRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteSegmentsResponse>;
2974
+ /**
2975
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2976
+ * version 2._ Deletes an existing virtual item store
2977
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletestore
2978
+ */
2979
+ DeleteStore(request: DeleteStoreRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteStoreResult>;
2980
+ /**
2981
+ * Delete a task.
2982
+ * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/deletetask
2983
+ */
2984
+ DeleteTask(request: DeleteTaskRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2985
+ /**
2986
+ * Permanently deletes a title and all associated configuration
2987
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletetitle
2988
+ */
2989
+ DeleteTitle(request: DeleteTitleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteTitleResult>;
2990
+ /**
2991
+ * Deletes a specified set of title data overrides.
2992
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletetitledataoverride
2993
+ */
2994
+ DeleteTitleDataOverride(request: DeleteTitleDataOverrideRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteTitleDataOverrideResult>;
2995
+ /**
2996
+ * Exports all associated data of a master player account
2997
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/exportmasterplayerdata
2998
+ */
2999
+ ExportMasterPlayerData(request: ExportMasterPlayerDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ExportMasterPlayerDataResult>;
3000
+ /**
3001
+ * Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which
3002
+ * match the segment definition at the time of the API call. Profiles which change while an export is in progress will not
3003
+ * be reflected in the results.
3004
+ * https://docs.microsoft.com/rest/api/playfab/admin/playstream/exportplayersinsegment
3005
+ */
3006
+ ExportPlayersInSegment(request: ExportPlayersInSegmentRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ExportPlayersInSegmentResult>;
3007
+ /**
3008
+ * Get information about a ActionsOnPlayersInSegment task instance.
3009
+ * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getactionsonplayersinsegmenttaskinstance
3010
+ */
3011
+ GetActionsOnPlayersInSegmentTaskInstance(request: GetTaskInstanceRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetActionsOnPlayersInSegmentTaskInstanceResult>;
3012
+ /**
3013
+ * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as
3014
+ * GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
3015
+ * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getallsegments
3016
+ */
3017
+ GetAllSegments(request: GetAllSegmentsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetAllSegmentsResult>;
3018
+ /**
3019
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3020
+ * version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
3021
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getcatalogitems
3022
+ */
3023
+ GetCatalogItems(request: GetCatalogItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
3024
+ /**
3025
+ * Gets the contents and information of a specific Cloud Script revision.
3026
+ * https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptrevision
3027
+ */
3028
+ GetCloudScriptRevision(request: GetCloudScriptRevisionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCloudScriptRevisionResult>;
3029
+ /**
3030
+ * Get detail information about a CloudScript task instance.
3031
+ * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getcloudscripttaskinstance
3032
+ */
3033
+ GetCloudScriptTaskInstance(request: GetTaskInstanceRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCloudScriptTaskInstanceResult>;
3034
+ /**
3035
+ * Lists all the current cloud script versions. For each version, information about the current published and latest
3036
+ * revisions is also listed.
3037
+ * https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptversions
3038
+ */
3039
+ GetCloudScriptVersions(request: GetCloudScriptVersionsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCloudScriptVersionsResult>;
3040
+ /**
3041
+ * List all contents of the title and get statistics such as size
3042
+ * https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentlist
3043
+ */
3044
+ GetContentList(request: GetContentListRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetContentListResult>;
3045
+ /**
3046
+ * Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the
3047
+ * content. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN
3048
+ * rates apply.
3049
+ * https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentuploadurl
3050
+ */
3051
+ GetContentUploadUrl(request: GetContentUploadUrlRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetContentUploadUrlResult>;
3052
+ /**
3053
+ * Retrieves a download URL for the requested report
3054
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getdatareport
3055
+ */
3056
+ GetDataReport(request: GetDataReportRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetDataReportResult>;
3057
+ /**
3058
+ * Get the list of titles that the player has played
3059
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayedtitlelist
3060
+ */
3061
+ GetPlayedTitleList(request: GetPlayedTitleListRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayedTitleListResult>;
3062
+ /**
3063
+ * Retrieves a title-specific custom property value for a player.
3064
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayercustomproperty
3065
+ */
3066
+ GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
3067
+ /**
3068
+ * Gets a player's ID from an auth token.
3069
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayeridfromauthtoken
3070
+ */
3071
+ GetPlayerIdFromAuthToken(request: GetPlayerIdFromAuthTokenRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerIdFromAuthTokenResult>;
3072
+ /**
3073
+ * Retrieves the player's profile
3074
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayerprofile
3075
+ */
3076
+ GetPlayerProfile(request: GetPlayerProfileRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerProfileResult>;
3077
+ /**
3078
+ * List all segments that a player currently belongs to at this moment in time.
3079
+ * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersegments
3080
+ */
3081
+ GetPlayerSegments(request: GetPlayersSegmentsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
3082
+ /**
3083
+ * Returns all Player Shared Secret Keys including disabled and expired.
3084
+ * https://docs.microsoft.com/rest/api/playfab/admin/authentication/getplayersharedsecrets
3085
+ */
3086
+ GetPlayerSharedSecrets(request: GetPlayerSharedSecretsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerSharedSecretsResult>;
3087
+ /**
3088
+ * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match
3089
+ * the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span
3090
+ * on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected
3091
+ * in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being
3092
+ * called 30 times in one minute. You will be returned an error if you exceed this threshold.
3093
+ * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersinsegment
3094
+ */
3095
+ GetPlayersInSegment(request: GetPlayersInSegmentRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentResult>;
3096
+ /**
3097
+ * Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have
3098
+ * a reset interval.
3099
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticdefinitions
3100
+ */
3101
+ GetPlayerStatisticDefinitions(request: GetPlayerStatisticDefinitionsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticDefinitionsResult>;
3102
+ /**
3103
+ * Retrieves the information on the available versions of the specified statistic.
3104
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticversions
3105
+ */
3106
+ GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticVersionsResult>;
3107
+ /**
3108
+ * Get all tags with a given Namespace (optional) from a player profile.
3109
+ * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayertags
3110
+ */
3111
+ GetPlayerTags(request: GetPlayerTagsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
3112
+ /**
3113
+ * Gets the requested policy.
3114
+ * https://docs.microsoft.com/rest/api/playfab/admin/authentication/getpolicy
3115
+ */
3116
+ GetPolicy(request: GetPolicyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPolicyResponse>;
3117
+ /**
3118
+ * Retrieves the key-value store of custom publisher settings
3119
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getpublisherdata
3120
+ */
3121
+ GetPublisherData(request: GetPublisherDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPublisherDataResult>;
3122
+ /**
3123
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3124
+ * version 2._ Retrieves the random drop table configuration for the title
3125
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getrandomresulttables
3126
+ */
3127
+ GetRandomResultTables(request: GetRandomResultTablesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetRandomResultTablesResult>;
3128
+ /**
3129
+ * Retrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and
3130
+ * complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls
3131
+ * from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of
3132
+ * the export
3133
+ * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getsegmentexport
3134
+ */
3135
+ GetSegmentExport(request: GetPlayersInSegmentExportRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentExportResponse>;
3136
+ /**
3137
+ * Get detail information of a segment and its associated definition(s) and action(s) for a title.
3138
+ * https://docs.microsoft.com/rest/api/playfab/admin/segments/getsegments
3139
+ */
3140
+ GetSegments(request: GetSegmentsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetSegmentsResponse>;
3141
+ /**
3142
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3143
+ * version 2._ Retrieves the set of items defined for the specified store, including all prices defined
3144
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getstoreitems
3145
+ */
3146
+ GetStoreItems(request: GetStoreItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
3147
+ /**
3148
+ * Query for task instances by task, status, or time range.
3149
+ * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettaskinstances
3150
+ */
3151
+ GetTaskInstances(request: GetTaskInstancesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTaskInstancesResult>;
3152
+ /**
3153
+ * Get definition information on a specified task or all tasks within a title.
3154
+ * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettasks
3155
+ */
3156
+ GetTasks(request: GetTasksRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTasksResult>;
3157
+ /**
3158
+ * Retrieves the key-value store of custom title settings which can be read by the client
3159
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitledata
3160
+ */
3161
+ GetTitleData(request: GetTitleDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
3162
+ /**
3163
+ * Retrieves the key-value store of custom title settings which cannot be read by the client
3164
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitleinternaldata
3165
+ */
3166
+ GetTitleInternalData(request: GetTitleDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
3167
+ /**
3168
+ * Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier
3169
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuseraccountinfo
3170
+ */
3171
+ GetUserAccountInfo(request: LookupUserAccountInfoRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LookupUserAccountInfoResult>;
3172
+ /**
3173
+ * Gets all bans for a user.
3174
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuserbans
3175
+ */
3176
+ GetUserBans(request: GetUserBansRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserBansResult>;
3177
+ /**
3178
+ * Retrieves the title-specific custom data for the user which is readable and writable by the client
3179
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserdata
3180
+ */
3181
+ GetUserData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3182
+ /**
3183
+ * Retrieves the title-specific custom data for the user which cannot be accessed by the client
3184
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserinternaldata
3185
+ */
3186
+ GetUserInternalData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3187
+ /**
3188
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3189
+ * version 2._ Retrieves the specified user's current inventory of virtual goods
3190
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/getuserinventory
3191
+ */
3192
+ GetUserInventory(request: GetUserInventoryRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserInventoryResult>;
3193
+ /**
3194
+ * Retrieves the publisher-specific custom data for the user which is readable and writable by the client
3195
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherdata
3196
+ */
3197
+ GetUserPublisherData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3198
+ /**
3199
+ * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client
3200
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherinternaldata
3201
+ */
3202
+ GetUserPublisherInternalData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3203
+ /**
3204
+ * Retrieves the publisher-specific custom data for the user which can only be read by the client
3205
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherreadonlydata
3206
+ */
3207
+ GetUserPublisherReadOnlyData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3208
+ /**
3209
+ * Retrieves the title-specific custom data for the user which can only be read by the client
3210
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserreadonlydata
3211
+ */
3212
+ GetUserReadOnlyData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3213
+ /**
3214
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3215
+ * version 2._ Adds the specified items to the specified user inventories
3216
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/grantitemstousers
3217
+ */
3218
+ GrantItemsToUsers(request: GrantItemsToUsersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GrantItemsToUsersResult>;
3219
+ /**
3220
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3221
+ * version 2._ Increases the global count for the given scarce resource.
3222
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/incrementlimitededitionitemavailability
3223
+ */
3224
+ IncrementLimitedEditionItemAvailability(request: IncrementLimitedEditionItemAvailabilityRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<IncrementLimitedEditionItemAvailabilityResult>;
3225
+ /**
3226
+ * Resets the indicated statistic, removing all player entries for it and backing up the old values.
3227
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/incrementplayerstatisticversion
3228
+ */
3229
+ IncrementPlayerStatisticVersion(request: IncrementPlayerStatisticVersionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<IncrementPlayerStatisticVersionResult>;
3230
+ /**
3231
+ * Retrieves a list of all Open ID Connect providers registered to a title.
3232
+ * https://docs.microsoft.com/rest/api/playfab/admin/authentication/listopenidconnection
3233
+ */
3234
+ ListOpenIdConnection(request: ListOpenIdConnectionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListOpenIdConnectionResponse>;
3235
+ /**
3236
+ * Retrieves title-specific custom property values for a player.
3237
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/listplayercustomproperties
3238
+ */
3239
+ ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
3240
+ /**
3241
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3242
+ * version 2._ Retuns the list of all defined virtual currencies for the title
3243
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/listvirtualcurrencytypes
3244
+ */
3245
+ ListVirtualCurrencyTypes(request: ListVirtualCurrencyTypesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListVirtualCurrencyTypesResult>;
3246
+ /**
3247
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3248
+ * version 2._ Attempts to process an order refund through the original real money payment provider.
3249
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/refundpurchase
3250
+ */
3251
+ RefundPurchase(request: RefundPurchaseRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RefundPurchaseResponse>;
3252
+ /**
3253
+ * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
3254
+ * https://docs.microsoft.com/rest/api/playfab/admin/playstream/removeplayertag
3255
+ */
3256
+ RemovePlayerTag(request: RemovePlayerTagRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RemovePlayerTagResult>;
3257
+ /**
3258
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3259
+ * version 2._ Removes one or more virtual currencies from the set defined for the title.
3260
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/removevirtualcurrencytypes
3261
+ */
3262
+ RemoveVirtualCurrencyTypes(request: RemoveVirtualCurrencyTypesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<BlankResult>;
3263
+ /**
3264
+ * Completely removes all statistics for the specified character, for the current game
3265
+ * https://docs.microsoft.com/rest/api/playfab/admin/characters/resetcharacterstatistics
3266
+ */
3267
+ ResetCharacterStatistics(request: ResetCharacterStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ResetCharacterStatisticsResult>;
3268
+ /**
3269
+ * Reset a player's password for a given title.
3270
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/resetpassword
3271
+ */
3272
+ ResetPassword(request: ResetPasswordRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ResetPasswordResult>;
3273
+ /**
3274
+ * Completely removes all statistics for the specified user, for the current game
3275
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resetuserstatistics
3276
+ */
3277
+ ResetUserStatistics(request: ResetUserStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ResetUserStatisticsResult>;
3278
+ /**
3279
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3280
+ * version 2._ Attempts to resolve a dispute with the original order's payment provider.
3281
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resolvepurchasedispute
3282
+ */
3283
+ ResolvePurchaseDispute(request: ResolvePurchaseDisputeRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ResolvePurchaseDisputeResponse>;
3284
+ /**
3285
+ * Revoke all active bans for a user.
3286
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokeallbansforuser
3287
+ */
3288
+ RevokeAllBansForUser(request: RevokeAllBansForUserRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RevokeAllBansForUserResult>;
3289
+ /**
3290
+ * Revoke all active bans specified with BanId.
3291
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokebans
3292
+ */
3293
+ RevokeBans(request: RevokeBansRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RevokeBansResult>;
3294
+ /**
3295
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3296
+ * version 2._ Revokes access to an item in a user's inventory
3297
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitem
3298
+ */
3299
+ RevokeInventoryItem(request: RevokeInventoryItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RevokeInventoryResult>;
3300
+ /**
3301
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3302
+ * version 2._ Revokes access for up to 25 items across multiple users and characters.
3303
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitems
3304
+ */
3305
+ RevokeInventoryItems(request: RevokeInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RevokeInventoryItemsResult>;
3306
+ /**
3307
+ * Run a task immediately regardless of its schedule.
3308
+ * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/runtask
3309
+ */
3310
+ RunTask(request: RunTaskRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RunTaskResult>;
3311
+ /**
3312
+ * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
3313
+ * change the password.If an account recovery email template ID is provided, an email using the custom email template will
3314
+ * be used.
3315
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/sendaccountrecoveryemail
3316
+ */
3317
+ SendAccountRecoveryEmail(request: SendAccountRecoveryEmailRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SendAccountRecoveryEmailResult>;
3318
+ /**
3319
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3320
+ * version 2._ Creates the catalog configuration of all virtual goods for the specified catalog version
3321
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setcatalogitems
3322
+ */
3323
+ SetCatalogItems(request: UpdateCatalogItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateCatalogItemsResult>;
3324
+ /**
3325
+ * Sets the override expiration for a membership subscription
3326
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/setmembershipoverride
3327
+ */
3328
+ SetMembershipOverride(request: SetMembershipOverrideRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetMembershipOverrideResult>;
3329
+ /**
3330
+ * Sets or resets the player's secret. Player secrets are used to sign API requests.
3331
+ * https://docs.microsoft.com/rest/api/playfab/admin/authentication/setplayersecret
3332
+ */
3333
+ SetPlayerSecret(request: SetPlayerSecretRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
3334
+ /**
3335
+ * Sets the currently published revision of a title Cloud Script
3336
+ * https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/setpublishedrevision
3337
+ */
3338
+ SetPublishedRevision(request: SetPublishedRevisionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetPublishedRevisionResult>;
3339
+ /**
3340
+ * Updates the key-value store of custom publisher settings
3341
+ * https://docs.microsoft.com/rest/api/playfab/admin/shared-group-data/setpublisherdata
3342
+ */
3343
+ SetPublisherData(request: SetPublisherDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetPublisherDataResult>;
3344
+ /**
3345
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3346
+ * version 2._ Sets all the items in one virtual store
3347
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setstoreitems
3348
+ */
3349
+ SetStoreItems(request: UpdateStoreItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateStoreItemsResult>;
3350
+ /**
3351
+ * Creates and updates the key-value store of custom title settings which can be read by the client. For example, a
3352
+ * developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths,
3353
+ * movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new
3354
+ * build.
3355
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledata
3356
+ */
3357
+ SetTitleData(request: SetTitleDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
3358
+ /**
3359
+ * Set and delete key-value pairs in a title data override instance.
3360
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledataandoverrides
3361
+ */
3362
+ SetTitleDataAndOverrides(request: SetTitleDataAndOverridesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetTitleDataAndOverridesResult>;
3363
+ /**
3364
+ * Updates the key-value store of custom title settings which cannot be read by the client. These values can be used to
3365
+ * tweak settings used by game servers and Cloud Scripts without the need to update and re-deploy.
3366
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitleinternaldata
3367
+ */
3368
+ SetTitleInternalData(request: SetTitleDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
3369
+ /**
3370
+ * Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can
3371
+ * be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device
3372
+ * Messaging is not supported.
3373
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setuppushnotification
3374
+ */
3375
+ SetupPushNotification(request: SetupPushNotificationRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetupPushNotificationResult>;
3376
+ /**
3377
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3378
+ * version 2._ Decrements the specified virtual currency by the stated amount
3379
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/subtractuservirtualcurrency
3380
+ */
3381
+ SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
3382
+ /**
3383
+ * Updates information of a list of existing bans specified with Ban Ids.
3384
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/updatebans
3385
+ */
3386
+ UpdateBans(request: UpdateBansRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateBansResult>;
3387
+ /**
3388
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3389
+ * version 2._ Updates the catalog configuration for virtual goods in the specified catalog version
3390
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatecatalogitems
3391
+ */
3392
+ UpdateCatalogItems(request: UpdateCatalogItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateCatalogItemsResult>;
3393
+ /**
3394
+ * Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be
3395
+ * submitted in the revision.
3396
+ * https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/updatecloudscript
3397
+ */
3398
+ UpdateCloudScript(request: UpdateCloudScriptRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateCloudScriptResult>;
3399
+ /**
3400
+ * Modifies data and credentials for an existing relationship between a title and an Open ID Connect provider
3401
+ * https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateopenidconnection
3402
+ */
3403
+ UpdateOpenIdConnection(request: UpdateOpenIdConnectionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3404
+ /**
3405
+ * Updates the title-specific custom property values for a player
3406
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayercustomproperties
3407
+ */
3408
+ UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdatePlayerCustomPropertiesResult>;
3409
+ /**
3410
+ * Updates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available
3411
+ * after this API returns.
3412
+ * https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateplayersharedsecret
3413
+ */
3414
+ UpdatePlayerSharedSecret(request: UpdatePlayerSharedSecretRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdatePlayerSharedSecretResult>;
3415
+ /**
3416
+ * Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.
3417
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayerstatisticdefinition
3418
+ */
3419
+ UpdatePlayerStatisticDefinition(request: UpdatePlayerStatisticDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdatePlayerStatisticDefinitionResult>;
3420
+ /**
3421
+ * Changes a policy for a title
3422
+ * https://docs.microsoft.com/rest/api/playfab/admin/authentication/updatepolicy
3423
+ */
3424
+ UpdatePolicy(request: UpdatePolicyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdatePolicyResponse>;
3425
+ /**
3426
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3427
+ * version 2._ Updates the random drop table configuration for the title
3428
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updaterandomresulttables
3429
+ */
3430
+ UpdateRandomResultTables(request: UpdateRandomResultTablesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateRandomResultTablesResult>;
3431
+ /**
3432
+ * Updates an existing player segment and its associated definition(s) and action(s) for a title.
3433
+ * https://docs.microsoft.com/rest/api/playfab/admin/segments/updatesegment
3434
+ */
3435
+ UpdateSegment(request: UpdateSegmentRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateSegmentResponse>;
3436
+ /**
3437
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3438
+ * version 2._ Updates an existing virtual item store with new or modified items
3439
+ * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatestoreitems
3440
+ */
3441
+ UpdateStoreItems(request: UpdateStoreItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateStoreItemsResult>;
3442
+ /**
3443
+ * Update an existing task.
3444
+ * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/updatetask
3445
+ */
3446
+ UpdateTask(request: UpdateTaskRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3447
+ /**
3448
+ * Updates the title-specific custom data for the user which is readable and writable by the client
3449
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserdata
3450
+ */
3451
+ UpdateUserData(request: UpdateUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
3452
+ /**
3453
+ * Updates the title-specific custom data for the user which cannot be accessed by the client
3454
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserinternaldata
3455
+ */
3456
+ UpdateUserInternalData(request: UpdateUserInternalDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
3457
+ /**
3458
+ * Updates the publisher-specific custom data for the user which is readable and writable by the client
3459
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherdata
3460
+ */
3461
+ UpdateUserPublisherData(request: UpdateUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
3462
+ /**
3463
+ * Updates the publisher-specific custom data for the user which cannot be accessed by the client
3464
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherinternaldata
3465
+ */
3466
+ UpdateUserPublisherInternalData(request: UpdateUserInternalDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
3467
+ /**
3468
+ * Updates the publisher-specific custom data for the user which can only be read by the client
3469
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherreadonlydata
3470
+ */
3471
+ UpdateUserPublisherReadOnlyData(request: UpdateUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
3472
+ /**
3473
+ * Updates the title-specific custom data for the user which can only be read by the client
3474
+ * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserreadonlydata
3475
+ */
3476
+ UpdateUserReadOnlyData(request: UpdateUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
3477
+ /**
3478
+ * Updates the title specific display name for a user
3479
+ * https://docs.microsoft.com/rest/api/playfab/admin/account-management/updateusertitledisplayname
3480
+ */
3481
+ UpdateUserTitleDisplayName(request: UpdateUserTitleDisplayNameRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserTitleDisplayNameResult>;
3482
+ }
3483
+
3484
+ export { PlayFabAdminApi as default };