async-playfab-web-sdk 1.192.250526-4 → 1.192.250526-5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Addon.d.ts +178 -38
- package/dist/Addon.js +2 -2
- package/dist/Admin.d.ts +2385 -194
- package/dist/Admin.js +2 -2
- package/dist/Authentication.d.ts +31 -4
- package/dist/Authentication.js +2 -2
- package/dist/Client.d.ts +2234 -320
- package/dist/Client.js +2 -2
- package/dist/CloudScript.d.ts +198 -30
- package/dist/CloudScript.js +2 -2
- package/dist/Data.d.ts +136 -17
- package/dist/Data.js +2 -2
- package/dist/Economy.d.ts +1145 -106
- package/dist/Economy.js +2 -2
- package/dist/Events.d.ts +199 -12
- package/dist/Events.js +2 -2
- package/dist/Experimentation.d.ts +163 -16
- package/dist/Experimentation.js +2 -2
- package/dist/Groups.d.ts +266 -27
- package/dist/Groups.js +2 -2
- package/dist/Insights.d.ts +32 -6
- package/dist/Insights.js +2 -2
- package/dist/Localization.d.ts +4 -1
- package/dist/Localization.js +2 -2
- package/dist/Matchmaker.d.ts +271 -0
- package/dist/Matchmaker.js +8 -0
- package/dist/Matchmaker.js.map +1 -0
- package/dist/Multiplayer.d.ts +2696 -168
- package/dist/Multiplayer.js +2 -2
- package/dist/Profiles.d.ts +162 -18
- package/dist/Profiles.js +2 -2
- package/dist/Progression.d.ts +286 -34
- package/dist/Progression.js +2 -2
- package/dist/Server.d.ts +1903 -241
- package/dist/Server.js +2 -2
- package/dist/chunk-3I6ONUUQ.js +237 -0
- package/dist/chunk-3I6ONUUQ.js.map +1 -0
- package/dist/chunk-3O5QT4SL.js +2477 -0
- package/dist/chunk-3O5QT4SL.js.map +1 -0
- package/dist/chunk-3OBHYLBF.js +2673 -0
- package/dist/chunk-3OBHYLBF.js.map +1 -0
- package/dist/chunk-57KYHGBO.js +421 -0
- package/dist/chunk-57KYHGBO.js.map +1 -0
- package/dist/{chunk-CLMINF57.js → chunk-5CWZN75H.js} +6 -3
- package/dist/chunk-5CWZN75H.js.map +1 -0
- package/dist/chunk-73SVDH45.js +197 -0
- package/dist/chunk-73SVDH45.js.map +1 -0
- package/dist/chunk-ADHTNFTN.js +175 -0
- package/dist/chunk-ADHTNFTN.js.map +1 -0
- package/dist/chunk-C7U2JQNZ.js +76 -0
- package/dist/chunk-C7U2JQNZ.js.map +1 -0
- package/dist/{chunk-PXPOK2QU.js → chunk-GAZYZIK2.js} +34 -8
- package/dist/chunk-GAZYZIK2.js.map +1 -0
- package/dist/chunk-J54WY4UN.js +413 -0
- package/dist/chunk-J54WY4UN.js.map +1 -0
- package/dist/chunk-NFWQ4MMZ.js +1048 -0
- package/dist/chunk-NFWQ4MMZ.js.map +1 -0
- package/dist/{chunk-7UQYMDJQ.js → chunk-P7UVG26J.js} +167 -32
- package/dist/chunk-P7UVG26J.js.map +1 -0
- package/dist/chunk-PFXZB4UN.js +2387 -0
- package/dist/chunk-PFXZB4UN.js.map +1 -0
- package/dist/{chunk-RJPMKD7P.js → chunk-QNGQW3YB.js} +28 -6
- package/dist/chunk-QNGQW3YB.js.map +1 -0
- package/dist/chunk-SQWILU5T.js +270 -0
- package/dist/chunk-SQWILU5T.js.map +1 -0
- package/dist/{chunk-FEEE3PRD.js → chunk-SR2RIRLX.js} +1482 -175
- package/dist/chunk-SR2RIRLX.js.map +1 -0
- package/dist/{chunk-6TH6EJYH.js → chunk-XVDYM74A.js} +4 -4
- package/dist/chunk-XVDYM74A.js.map +1 -0
- package/dist/chunk-ZW4TJ3MQ.js +225 -0
- package/dist/chunk-ZW4TJ3MQ.js.map +1 -0
- package/dist/index.d.ts +6 -5
- package/dist/index.js +29 -25
- package/package.json +2 -2
- package/dist/chunk-2IBLMNAQ.js +0 -882
- package/dist/chunk-2IBLMNAQ.js.map +0 -1
- package/dist/chunk-3TRLETD6.js +0 -119
- package/dist/chunk-3TRLETD6.js.map +0 -1
- package/dist/chunk-4LT3OUQD.js +0 -632
- package/dist/chunk-4LT3OUQD.js.map +0 -1
- package/dist/chunk-6TH6EJYH.js.map +0 -1
- package/dist/chunk-7UQYMDJQ.js.map +0 -1
- package/dist/chunk-CLMINF57.js.map +0 -1
- package/dist/chunk-F5NRBD4O.js +0 -174
- package/dist/chunk-F5NRBD4O.js.map +0 -1
- package/dist/chunk-FEEE3PRD.js.map +0 -1
- package/dist/chunk-HKZJ4H4O.js +0 -97
- package/dist/chunk-HKZJ4H4O.js.map +0 -1
- package/dist/chunk-NJQCK4TL.js +0 -61
- package/dist/chunk-NJQCK4TL.js.map +0 -1
- package/dist/chunk-ONCBQLGS.js +0 -1147
- package/dist/chunk-ONCBQLGS.js.map +0 -1
- package/dist/chunk-PXPOK2QU.js.map +0 -1
- package/dist/chunk-Q22JHX4G.js +0 -76
- package/dist/chunk-Q22JHX4G.js.map +0 -1
- package/dist/chunk-RJPMKD7P.js.map +0 -1
- package/dist/chunk-WROXLFDZ.js +0 -103
- package/dist/chunk-WROXLFDZ.js.map +0 -1
- package/dist/chunk-XAI5IWL4.js +0 -187
- package/dist/chunk-XAI5IWL4.js.map +0 -1
- package/dist/chunk-XM26BUTO.js +0 -384
- package/dist/chunk-XM26BUTO.js.map +0 -1
package/dist/Admin.d.ts
CHANGED
@@ -150,6 +150,69 @@ interface AddPlayerTagRequest extends IPlayFabRequestCommon {
|
|
150
150
|
}
|
151
151
|
interface AddPlayerTagResult extends IPlayFabResultCommon {
|
152
152
|
}
|
153
|
+
/** @deprecated Do not use */
|
154
|
+
interface AddServerBuildRequest extends IPlayFabRequestCommon {
|
155
|
+
/** server host regions in which this build should be running and available */
|
156
|
+
ActiveRegions?: string[];
|
157
|
+
/** unique identifier for the build executable */
|
158
|
+
BuildId: string;
|
159
|
+
/**
|
160
|
+
* appended to the end of the command line when starting game servers
|
161
|
+
* @deprecated Do not use
|
162
|
+
*/
|
163
|
+
CommandLineTemplate?: string;
|
164
|
+
/** developer comment(s) for this build */
|
165
|
+
Comment?: string;
|
166
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
167
|
+
CustomTags?: Record<string, string | null>;
|
168
|
+
/**
|
169
|
+
* path to the game server executable. Defaults to gameserver.exe
|
170
|
+
* @deprecated Do not use
|
171
|
+
*/
|
172
|
+
ExecutablePath?: string;
|
173
|
+
/** maximum number of game server instances that can run on a single host machine */
|
174
|
+
MaxGamesPerHost: number;
|
175
|
+
/**
|
176
|
+
* minimum capacity of additional game server instances that can be started before the autoscaling service starts new host
|
177
|
+
* machines (given the number of current running host machines and game server instances)
|
178
|
+
*/
|
179
|
+
MinFreeGameSlots: number;
|
180
|
+
}
|
181
|
+
/** @deprecated Do not use */
|
182
|
+
interface AddServerBuildResult extends IPlayFabResultCommon {
|
183
|
+
/** array of regions where this build can used, when it is active */
|
184
|
+
ActiveRegions?: string[];
|
185
|
+
/** unique identifier for this build executable */
|
186
|
+
BuildId?: string;
|
187
|
+
/**
|
188
|
+
* appended to the end of the command line when starting game servers
|
189
|
+
* @deprecated Do not use
|
190
|
+
*/
|
191
|
+
CommandLineTemplate?: string;
|
192
|
+
/** developer comment(s) for this build */
|
193
|
+
Comment?: string;
|
194
|
+
/**
|
195
|
+
* path to the game server executable. Defaults to gameserver.exe
|
196
|
+
* @deprecated Do not use
|
197
|
+
*/
|
198
|
+
ExecutablePath?: string;
|
199
|
+
/** maximum number of game server instances that can run on a single host machine */
|
200
|
+
MaxGamesPerHost: number;
|
201
|
+
/**
|
202
|
+
* minimum capacity of additional game server instances that can be started before the autoscaling service starts new host
|
203
|
+
* machines (given the number of current running host machines and game server instances)
|
204
|
+
*/
|
205
|
+
MinFreeGameSlots: number;
|
206
|
+
/** the current status of the build validation and processing steps */
|
207
|
+
Status?: string;
|
208
|
+
/** time this build was last modified (or uploaded, if this build has never been modified) */
|
209
|
+
Timestamp: string;
|
210
|
+
/**
|
211
|
+
* Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
|
212
|
+
* title has been selected.
|
213
|
+
*/
|
214
|
+
TitleId?: string;
|
215
|
+
}
|
153
216
|
interface AddUserVirtualCurrencyRequest extends IPlayFabRequestCommon {
|
154
217
|
/**
|
155
218
|
* Amount to be added to the user balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647).
|
@@ -185,8 +248,20 @@ interface BanInfo {
|
|
185
248
|
Created?: string;
|
186
249
|
/** The time when this ban expires. Permanent bans do not have expiration date. */
|
187
250
|
Expires?: string;
|
251
|
+
/**
|
252
|
+
* Whether or not the Microsoft family members are included in the ban. This property is deprecated and does not work
|
253
|
+
* anymore.
|
254
|
+
* @deprecated Please use UserFamilyType instead.
|
255
|
+
*/
|
256
|
+
IncludeMicrosoftFamily?: boolean;
|
188
257
|
/** The IP address on which the ban was applied. May affect multiple players. */
|
189
258
|
IPAddress?: string;
|
259
|
+
/**
|
260
|
+
* The MAC address on which the ban was applied. May affect multiple players. This property is deprecated and does not work
|
261
|
+
* anymore.
|
262
|
+
* @deprecated Do not use
|
263
|
+
*/
|
264
|
+
MACAddress?: string;
|
190
265
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
191
266
|
PlayFabId?: string;
|
192
267
|
/** The reason why this ban was applied. */
|
@@ -209,8 +284,19 @@ interface BanPlayerSegmentAction {
|
|
209
284
|
interface BanRequest {
|
210
285
|
/** The duration in hours for the ban. Leave this blank for a permanent ban. */
|
211
286
|
DurationInHours?: number;
|
287
|
+
/**
|
288
|
+
* Whether the Microsoft family members should be included in the ban. May affect multiple players. This property is
|
289
|
+
* deprecated and does not work anymore.
|
290
|
+
* @deprecated Please use UserFamilyType instead.
|
291
|
+
*/
|
292
|
+
IncludeMicrosoftFamily?: boolean;
|
212
293
|
/** IP address to be banned. May affect multiple players. */
|
213
294
|
IPAddress?: string;
|
295
|
+
/**
|
296
|
+
* MAC address to be banned. May affect multiple players. This property is deprecated and does not work anymore.
|
297
|
+
* @deprecated Do not use
|
298
|
+
*/
|
299
|
+
MACAddress?: string;
|
214
300
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
215
301
|
PlayFabId: string;
|
216
302
|
/** The reason for this ban. Maximum 140 characters. */
|
@@ -283,7 +369,7 @@ interface CatalogItem {
|
|
283
369
|
RealCurrencyPrices?: Record<string, number>;
|
284
370
|
/** list of item tags */
|
285
371
|
Tags?: string[];
|
286
|
-
/** price of this item in virtual currencies and
|
372
|
+
/** price of this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
|
287
373
|
VirtualCurrencyPrices?: Record<string, number>;
|
288
374
|
}
|
289
375
|
interface CatalogItemBundleInfo {
|
@@ -303,7 +389,7 @@ interface CatalogItemConsumableInfo {
|
|
303
389
|
/**
|
304
390
|
* duration in seconds for how long the item will remain in the player inventory - once elapsed, the item will be removed
|
305
391
|
* (recommended minimum value is 5 seconds, as lower values can cause the item to expire before operations depending on
|
306
|
-
* this item
|
392
|
+
* this item's details have completed)
|
307
393
|
*/
|
308
394
|
UsagePeriod?: number;
|
309
395
|
/**
|
@@ -344,6 +430,34 @@ interface ChurnPredictionSegmentFilter {
|
|
344
430
|
/** RiskLevel */
|
345
431
|
RiskLevel?: string;
|
346
432
|
}
|
433
|
+
interface CloudScriptAzureFunctionsTaskParameter {
|
434
|
+
/** Argument to pass to the CloudScript function. */
|
435
|
+
Argument?: any;
|
436
|
+
/** Name of the CloudScript function to execute. */
|
437
|
+
FunctionName?: string;
|
438
|
+
}
|
439
|
+
interface CloudScriptAzureFunctionsTaskSummary {
|
440
|
+
/** UTC timestamp when the task completed. */
|
441
|
+
CompletedAt?: string;
|
442
|
+
/** Error indicating failure to execute the CloudScript Azure Function */
|
443
|
+
Error?: string;
|
444
|
+
/** Estimated time remaining in seconds. */
|
445
|
+
EstimatedSecondsRemaining?: number;
|
446
|
+
/** Progress represented as percentage. */
|
447
|
+
PercentComplete?: number;
|
448
|
+
/** Result of CloudScript Azure Function execution */
|
449
|
+
Result?: ExecuteFunctionResult;
|
450
|
+
/** If manually scheduled, ID of user who scheduled the task. */
|
451
|
+
ScheduledByUserId?: string;
|
452
|
+
/** UTC timestamp when the task started. */
|
453
|
+
StartedAt: string;
|
454
|
+
/** Current status of the task instance. */
|
455
|
+
Status?: string;
|
456
|
+
/** Identifier of the task this instance belongs to. */
|
457
|
+
TaskIdentifier?: NameIdentifier;
|
458
|
+
/** ID of the task instance. */
|
459
|
+
TaskInstanceId?: string;
|
460
|
+
}
|
347
461
|
interface CloudScriptFile {
|
348
462
|
/** Contents of the Cloud Script javascript. Must be string-escaped javascript. */
|
349
463
|
FileContents: string;
|
@@ -425,6 +539,20 @@ interface CreateActionsOnPlayerSegmentTaskRequest extends IPlayFabRequestCommon
|
|
425
539
|
/** Cron expression for the run schedule of the task. The expression should be in UTC. */
|
426
540
|
Schedule?: string;
|
427
541
|
}
|
542
|
+
interface CreateCloudScriptAzureFunctionsTaskRequest extends IPlayFabRequestCommon {
|
543
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
544
|
+
CustomTags?: Record<string, string | null>;
|
545
|
+
/** Description the task */
|
546
|
+
Description?: string;
|
547
|
+
/** Whether the schedule is active. Inactive schedule will not trigger task execution. */
|
548
|
+
IsActive: boolean;
|
549
|
+
/** Name of the task. This is a unique identifier for tasks in the title. */
|
550
|
+
Name: string;
|
551
|
+
/** Task details related to CloudScript */
|
552
|
+
Parameter: CloudScriptAzureFunctionsTaskParameter;
|
553
|
+
/** Cron expression for the run schedule of the task. The expression should be in UTC. */
|
554
|
+
Schedule?: string;
|
555
|
+
}
|
428
556
|
interface CreateCloudScriptTaskRequest extends IPlayFabRequestCommon {
|
429
557
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
430
558
|
CustomTags?: Record<string, string | null>;
|
@@ -460,12 +588,12 @@ interface CreateOpenIdConnectionRequest extends IPlayFabRequestCommon {
|
|
460
588
|
ClientSecret: string;
|
461
589
|
/** A name for the connection that identifies it within the title. */
|
462
590
|
ConnectionId: string;
|
463
|
-
/** Ignore
|
591
|
+
/** Ignore 'nonce' claim in identity tokens. */
|
464
592
|
IgnoreNonce?: boolean;
|
465
593
|
/**
|
466
594
|
* 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
|
468
|
-
*
|
595
|
+
* Configuration document and must be accessible from the internet. If you don't know it, try your issuer URL followed by
|
596
|
+
* "/.well-known/openid-configuration". For example, if the issuer is https://example.com, try
|
469
597
|
* https://example.com/.well-known/openid-configuration
|
470
598
|
*/
|
471
599
|
IssuerDiscoveryUrl?: string;
|
@@ -527,9 +655,9 @@ interface CustomPropertyDateTimeSegmentFilter {
|
|
527
655
|
PropertyValue: string;
|
528
656
|
}
|
529
657
|
interface CustomPropertyDetails {
|
530
|
-
/** The custom property
|
658
|
+
/** The custom property's name. */
|
531
659
|
Name?: string;
|
532
|
-
/** The custom property
|
660
|
+
/** The custom property's value. */
|
533
661
|
Value?: any;
|
534
662
|
}
|
535
663
|
interface CustomPropertyNumericSegmentFilter {
|
@@ -558,6 +686,12 @@ interface DeletedPropertyDetails {
|
|
558
686
|
/** Indicates whether or not the property was deleted. If false, no property with that name existed. */
|
559
687
|
WasDeleted: boolean;
|
560
688
|
}
|
689
|
+
interface DeleteEventSinkRequest extends IPlayFabRequestCommon {
|
690
|
+
/** The sink name to be deleted. */
|
691
|
+
Name: string;
|
692
|
+
}
|
693
|
+
interface DeleteEventSinkResult extends IPlayFabResultCommon {
|
694
|
+
}
|
561
695
|
interface DeleteInventoryItemsV2SegmentAction {
|
562
696
|
/** The collection id for where the item will be removed from the player inventory */
|
563
697
|
CollectionId?: string;
|
@@ -586,7 +720,7 @@ interface DeleteMasterPlayerAccountResult extends IPlayFabResultCommon {
|
|
586
720
|
* complete.
|
587
721
|
*/
|
588
722
|
JobReceiptId?: string;
|
589
|
-
/** List of titles from which the player
|
723
|
+
/** List of titles from which the player's data will be deleted. */
|
590
724
|
TitleIds?: string[];
|
591
725
|
}
|
592
726
|
interface DeleteMasterPlayerEventDataRequest extends IPlayFabRequestCommon {
|
@@ -618,7 +752,7 @@ interface DeletePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
|
|
618
752
|
CustomTags?: Record<string, string | null>;
|
619
753
|
/**
|
620
754
|
* Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the
|
621
|
-
* player
|
755
|
+
* player's properties have not been updated by any other clients since the last version.
|
622
756
|
*/
|
623
757
|
ExpectedPropertiesVersion?: number;
|
624
758
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
@@ -632,7 +766,7 @@ interface DeletePlayerCustomPropertiesResult extends IPlayFabResultCommon {
|
|
632
766
|
/** PlayFab unique identifier of the user whose properties were deleted. */
|
633
767
|
PlayFabId?: string;
|
634
768
|
/**
|
635
|
-
* Indicates the current version of a player
|
769
|
+
* Indicates the current version of a player's properties that have been set. This is incremented after updates and
|
636
770
|
* deletes. This version can be provided in update and delete calls for concurrency control.
|
637
771
|
*/
|
638
772
|
PropertiesVersion: number;
|
@@ -687,6 +821,16 @@ interface DeleteTitleRequest extends IPlayFabRequestCommon {
|
|
687
821
|
}
|
688
822
|
interface DeleteTitleResult extends IPlayFabResultCommon {
|
689
823
|
}
|
824
|
+
/** @deprecated Do not use */
|
825
|
+
interface DeleteUsersRequest extends IPlayFabRequestCommon {
|
826
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
827
|
+
CustomTags?: Record<string, string | null>;
|
828
|
+
/** An array of unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
829
|
+
PlayFabIds: string[];
|
830
|
+
}
|
831
|
+
/** @deprecated Do not use */
|
832
|
+
interface DeleteUsersResult extends IPlayFabResultCommon {
|
833
|
+
}
|
690
834
|
interface EmailNotificationSegmentAction {
|
691
835
|
/** Email template id. */
|
692
836
|
EmailTemplateId?: string;
|
@@ -698,6 +842,29 @@ interface EntityKey {
|
|
698
842
|
Id: string;
|
699
843
|
/** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
|
700
844
|
Type?: string;
|
845
|
+
/**
|
846
|
+
* Alternate name for Type.
|
847
|
+
* @deprecated Please use Type instead.
|
848
|
+
*/
|
849
|
+
TypeString?: string;
|
850
|
+
}
|
851
|
+
interface ErrorDetails {
|
852
|
+
/** The error code of the user configuration error if this data connection is in an error state. */
|
853
|
+
Code?: string;
|
854
|
+
/** Date (in UTC) when the data connection most recently entered an error state. */
|
855
|
+
StartTime: string;
|
856
|
+
}
|
857
|
+
interface EventSink {
|
858
|
+
/** The type of event sink. Currently only supports AzureBlobStorage. */
|
859
|
+
DestinationType: string;
|
860
|
+
/** Error status for the sink. */
|
861
|
+
Error?: ErrorDetails;
|
862
|
+
/** The usage status of the sink. */
|
863
|
+
IsEnabled: boolean;
|
864
|
+
/** Friendly name for the event sink. */
|
865
|
+
Name: string;
|
866
|
+
/** Settings for the sink. */
|
867
|
+
SinkSettings: any;
|
701
868
|
}
|
702
869
|
interface ExecuteAzureFunctionSegmentAction {
|
703
870
|
/** Azure function. */
|
@@ -769,6 +936,18 @@ interface ExecuteFunctionContent {
|
|
769
936
|
/** Publish results from executing the azure function as playstream event */
|
770
937
|
PublishResultsToPlayStream: boolean;
|
771
938
|
}
|
939
|
+
interface ExecuteFunctionResult {
|
940
|
+
/** Error from the CloudScript Azure Function. */
|
941
|
+
Error?: FunctionExecutionError;
|
942
|
+
/** The amount of time the function took to execute */
|
943
|
+
ExecutionTimeMilliseconds: number;
|
944
|
+
/** The name of the function that executed */
|
945
|
+
FunctionName?: string;
|
946
|
+
/** The object returned from the function, if any */
|
947
|
+
FunctionResult?: any;
|
948
|
+
/** Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. */
|
949
|
+
FunctionResultTooLarge?: boolean;
|
950
|
+
}
|
772
951
|
interface ExportMasterPlayerDataRequest extends IPlayFabRequestCommon {
|
773
952
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
774
953
|
PlayFabId: string;
|
@@ -802,12 +981,49 @@ interface FirstLoginTimespanSegmentFilter {
|
|
802
981
|
/** First player login duration. */
|
803
982
|
DurationInMinutes: number;
|
804
983
|
}
|
984
|
+
interface FunctionExecutionError {
|
985
|
+
/**
|
986
|
+
* Error code, such as CloudScriptAzureFunctionsExecutionTimeLimitExceeded, CloudScriptAzureFunctionsArgumentSizeExceeded,
|
987
|
+
* CloudScriptAzureFunctionsReturnSizeExceeded or CloudScriptAzureFunctionsHTTPRequestError
|
988
|
+
*/
|
989
|
+
Error?: string;
|
990
|
+
/** Details about the error */
|
991
|
+
Message?: string;
|
992
|
+
/** Point during the execution of the function at which the error occurred, if any */
|
993
|
+
StackTrace?: string;
|
994
|
+
}
|
995
|
+
/** @deprecated Do not use */
|
996
|
+
interface GameModeInfo {
|
997
|
+
/** specific game mode type */
|
998
|
+
Gamemode: string;
|
999
|
+
/** maximum user count a specific Game Server Instance can support */
|
1000
|
+
MaxPlayerCount: number;
|
1001
|
+
/** minimum user count required for this Game Server Instance to continue (usually 1) */
|
1002
|
+
MinPlayerCount: number;
|
1003
|
+
/** whether to start as an open session, meaning that players can matchmake into it (defaults to true) */
|
1004
|
+
StartOpen?: boolean;
|
1005
|
+
}
|
1006
|
+
/** @deprecated Do not use */
|
1007
|
+
interface GetActionGroupResult {
|
1008
|
+
/** Action Group ID */
|
1009
|
+
Id?: string;
|
1010
|
+
/** Action Group name */
|
1011
|
+
Name: string;
|
1012
|
+
}
|
805
1013
|
interface GetActionsOnPlayersInSegmentTaskInstanceResult extends IPlayFabResultCommon {
|
806
1014
|
/** Parameter of this task instance */
|
807
1015
|
Parameter?: ActionsOnPlayersInSegmentTaskParameter;
|
808
1016
|
/** Status summary of the actions-on-players-in-segment task instance */
|
809
1017
|
Summary?: ActionsOnPlayersInSegmentTaskSummary;
|
810
1018
|
}
|
1019
|
+
/** @deprecated Do not use */
|
1020
|
+
interface GetAllActionGroupsRequest extends IPlayFabRequestCommon {
|
1021
|
+
}
|
1022
|
+
/** @deprecated Do not use */
|
1023
|
+
interface GetAllActionGroupsResult extends IPlayFabResultCommon {
|
1024
|
+
/** List of Action Groups. */
|
1025
|
+
ActionGroups: GetActionGroupResult[];
|
1026
|
+
}
|
811
1027
|
interface GetAllSegmentsRequest extends IPlayFabRequestCommon {
|
812
1028
|
}
|
813
1029
|
interface GetAllSegmentsResult extends IPlayFabResultCommon {
|
@@ -822,6 +1038,12 @@ interface GetCatalogItemsResult extends IPlayFabResultCommon {
|
|
822
1038
|
/** Array of items which can be purchased. */
|
823
1039
|
Catalog?: CatalogItem[];
|
824
1040
|
}
|
1041
|
+
interface GetCloudScriptAzureFunctionsTaskInstanceResult extends IPlayFabResultCommon {
|
1042
|
+
/** Parameter of this task instance */
|
1043
|
+
Parameter?: CloudScriptAzureFunctionsTaskParameter;
|
1044
|
+
/** Status summary of the CloudScript Azure Functions task instance */
|
1045
|
+
Summary?: CloudScriptAzureFunctionsTaskSummary;
|
1046
|
+
}
|
825
1047
|
interface GetCloudScriptRevisionRequest extends IPlayFabRequestCommon {
|
826
1048
|
/** Revision number. If left null, defaults to the latest revision */
|
827
1049
|
Revision?: number;
|
@@ -870,7 +1092,7 @@ interface GetContentListResult extends IPlayFabResultCommon {
|
|
870
1092
|
interface GetContentUploadUrlRequest extends IPlayFabRequestCommon {
|
871
1093
|
/**
|
872
1094
|
* 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
|
1095
|
+
* uploading the content. If not specified, the MIME type is 'binary/octet-stream' by default.
|
874
1096
|
*/
|
875
1097
|
ContentType?: string;
|
876
1098
|
/** Key of the content item to upload, usually formatted as a path, e.g. images/a.png */
|
@@ -878,8 +1100,8 @@ interface GetContentUploadUrlRequest extends IPlayFabRequestCommon {
|
|
878
1100
|
}
|
879
1101
|
interface GetContentUploadUrlResult extends IPlayFabResultCommon {
|
880
1102
|
/**
|
881
|
-
* URL for uploading content via HTTP PUT method. The URL requires the
|
882
|
-
*
|
1103
|
+
* URL for uploading content via HTTP PUT method. The URL requires the 'x-ms-blob-type' header to have the value
|
1104
|
+
* 'BlockBlob'. The URL will expire in approximately one hour.
|
883
1105
|
*/
|
884
1106
|
URL?: string;
|
885
1107
|
}
|
@@ -900,6 +1122,59 @@ interface GetDataReportResult extends IPlayFabResultCommon {
|
|
900
1122
|
*/
|
901
1123
|
DownloadUrl?: string;
|
902
1124
|
}
|
1125
|
+
interface GetEventSinksRequest extends IPlayFabRequestCommon {
|
1126
|
+
}
|
1127
|
+
interface GetEventSinksResult extends IPlayFabResultCommon {
|
1128
|
+
/** The set of sinks to which to route PlayStream and Telemetry event data. */
|
1129
|
+
Sinks: EventSink[];
|
1130
|
+
}
|
1131
|
+
/** @deprecated Do not use */
|
1132
|
+
interface GetMatchmakerGameInfoRequest extends IPlayFabRequestCommon {
|
1133
|
+
/** unique identifier of the lobby for which info is being requested */
|
1134
|
+
LobbyId: string;
|
1135
|
+
}
|
1136
|
+
/** @deprecated Do not use */
|
1137
|
+
interface GetMatchmakerGameInfoResult extends IPlayFabResultCommon {
|
1138
|
+
/** version identifier of the game server executable binary being run */
|
1139
|
+
BuildVersion?: string;
|
1140
|
+
/** time when Game Server Instance is currently scheduled to end */
|
1141
|
+
EndTime?: string;
|
1142
|
+
/** unique identifier of the lobby */
|
1143
|
+
LobbyId?: string;
|
1144
|
+
/** game mode for this Game Server Instance */
|
1145
|
+
Mode?: string;
|
1146
|
+
/** array of unique PlayFab identifiers for users currently connected to this Game Server Instance */
|
1147
|
+
Players?: string[];
|
1148
|
+
/** region in which the Game Server Instance is running */
|
1149
|
+
Region?: string;
|
1150
|
+
/**
|
1151
|
+
* IPV4 address of the game server instance
|
1152
|
+
* @deprecated Please use ServerIPV4Address instead.
|
1153
|
+
*/
|
1154
|
+
ServerAddress?: string;
|
1155
|
+
/** IPV4 address of the server */
|
1156
|
+
ServerIPV4Address?: string;
|
1157
|
+
/** IPV6 address of the server */
|
1158
|
+
ServerIPV6Address?: string;
|
1159
|
+
/** communication port for this Game Server Instance */
|
1160
|
+
ServerPort: number;
|
1161
|
+
/** Public DNS name (if any) of the server */
|
1162
|
+
ServerPublicDNSName?: string;
|
1163
|
+
/** time when the Game Server Instance was created */
|
1164
|
+
StartTime: string;
|
1165
|
+
/** unique identifier of the Game Server Instance for this lobby */
|
1166
|
+
TitleId?: string;
|
1167
|
+
}
|
1168
|
+
/** @deprecated Do not use */
|
1169
|
+
interface GetMatchmakerGameModesRequest extends IPlayFabRequestCommon {
|
1170
|
+
/** previously uploaded build version for which game modes are being requested */
|
1171
|
+
BuildVersion: string;
|
1172
|
+
}
|
1173
|
+
/** @deprecated Do not use */
|
1174
|
+
interface GetMatchmakerGameModesResult extends IPlayFabResultCommon {
|
1175
|
+
/** array of game modes available for the specified build */
|
1176
|
+
GameModes?: GameModeInfo[];
|
1177
|
+
}
|
903
1178
|
interface GetPlayedTitleListRequest extends IPlayFabRequestCommon {
|
904
1179
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
905
1180
|
PlayFabId: string;
|
@@ -911,14 +1186,14 @@ interface GetPlayedTitleListResult extends IPlayFabResultCommon {
|
|
911
1186
|
interface GetPlayerCustomPropertyRequest extends IPlayFabRequestCommon {
|
912
1187
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
913
1188
|
PlayFabId: string;
|
914
|
-
/** Specific property name to search for in the player
|
1189
|
+
/** Specific property name to search for in the player's properties. */
|
915
1190
|
PropertyName: string;
|
916
1191
|
}
|
917
1192
|
interface GetPlayerCustomPropertyResult extends IPlayFabResultCommon {
|
918
1193
|
/** PlayFab unique identifier of the user whose properties are being returned. */
|
919
1194
|
PlayFabId?: string;
|
920
1195
|
/**
|
921
|
-
* Indicates the current version of a player
|
1196
|
+
* Indicates the current version of a player's properties that have been set. This is incremented after updates and
|
922
1197
|
* deletes. This version can be provided in update and delete calls for concurrency control.
|
923
1198
|
*/
|
924
1199
|
PropertiesVersion: number;
|
@@ -943,7 +1218,7 @@ interface GetPlayerProfileRequest extends IPlayFabRequestCommon {
|
|
943
1218
|
/**
|
944
1219
|
* If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
|
945
1220
|
* only the allowed client profile properties for the title may be requested. These allowed properties are configured in
|
946
|
-
* the Game Manager
|
1221
|
+
* the Game Manager "Client Profile Options" tab in the "Settings" section.
|
947
1222
|
*/
|
948
1223
|
ProfileConstraints?: PlayerProfileViewConstraints;
|
949
1224
|
}
|
@@ -1039,11 +1314,11 @@ interface GetPlayerTagsRequest extends IPlayFabRequestCommon {
|
|
1039
1314
|
interface GetPlayerTagsResult extends IPlayFabResultCommon {
|
1040
1315
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
1041
1316
|
PlayFabId: string;
|
1042
|
-
/** Canonical tags (including namespace and tag
|
1317
|
+
/** Canonical tags (including namespace and tag's name) for the requested user */
|
1043
1318
|
Tags: string[];
|
1044
1319
|
}
|
1045
1320
|
interface GetPolicyRequest extends IPlayFabRequestCommon {
|
1046
|
-
/** The name of the policy to read. Only supported name is
|
1321
|
+
/** The name of the policy to read. Only supported name is 'ApiPolicy'. */
|
1047
1322
|
PolicyName?: string;
|
1048
1323
|
}
|
1049
1324
|
interface GetPolicyResponse extends IPlayFabResultCommon {
|
@@ -1088,6 +1363,38 @@ interface GetSegmentsResponse extends IPlayFabResultCommon {
|
|
1088
1363
|
/** List of title segments. */
|
1089
1364
|
Segments?: SegmentModel[];
|
1090
1365
|
}
|
1366
|
+
/** @deprecated Do not use */
|
1367
|
+
interface GetServerBuildInfoRequest extends IPlayFabRequestCommon {
|
1368
|
+
/** unique identifier of the previously uploaded build executable for which information is being requested */
|
1369
|
+
BuildId: string;
|
1370
|
+
}
|
1371
|
+
/** @deprecated Do not use */
|
1372
|
+
interface GetServerBuildInfoResult extends IPlayFabResultCommon {
|
1373
|
+
/** array of regions where this build can used, when it is active */
|
1374
|
+
ActiveRegions?: string[];
|
1375
|
+
/** unique identifier for this build executable */
|
1376
|
+
BuildId?: string;
|
1377
|
+
/** developer comment(s) for this build */
|
1378
|
+
Comment?: string;
|
1379
|
+
/** error message, if any, about this build */
|
1380
|
+
ErrorMessage?: string;
|
1381
|
+
/** maximum number of game server instances that can run on a single host machine */
|
1382
|
+
MaxGamesPerHost: number;
|
1383
|
+
/**
|
1384
|
+
* minimum capacity of additional game server instances that can be started before the autoscaling service starts new host
|
1385
|
+
* machines (given the number of current running host machines and game server instances)
|
1386
|
+
*/
|
1387
|
+
MinFreeGameSlots: number;
|
1388
|
+
/** the current status of the build validation and processing steps */
|
1389
|
+
Status?: string;
|
1390
|
+
/** time this build was last modified (or uploaded, if this build has never been modified) */
|
1391
|
+
Timestamp: string;
|
1392
|
+
/**
|
1393
|
+
* Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
|
1394
|
+
* title has been selected.
|
1395
|
+
*/
|
1396
|
+
TitleId?: string;
|
1397
|
+
}
|
1091
1398
|
interface GetStoreItemsRequest extends IPlayFabRequestCommon {
|
1092
1399
|
/** Catalog version to store items from. Use default catalog version if null */
|
1093
1400
|
CatalogVersion?: string;
|
@@ -1111,9 +1418,9 @@ interface GetTaskInstanceRequest extends IPlayFabRequestCommon {
|
|
1111
1418
|
TaskInstanceId: string;
|
1112
1419
|
}
|
1113
1420
|
interface GetTaskInstancesRequest extends IPlayFabRequestCommon {
|
1114
|
-
/** Optional range-from filter for task instances
|
1421
|
+
/** Optional range-from filter for task instances' StartedAt timestamp. */
|
1115
1422
|
StartedAtRangeFrom?: string;
|
1116
|
-
/** Optional range-to filter for task instances
|
1423
|
+
/** Optional range-to filter for task instances' StartedAt timestamp. */
|
1117
1424
|
StartedAtRangeTo?: string;
|
1118
1425
|
/** Optional filter for task instances that are of a specific status. */
|
1119
1426
|
StatusFilter?: string;
|
@@ -1214,7 +1521,7 @@ interface GrantedItemInstance {
|
|
1214
1521
|
CharacterId?: string;
|
1215
1522
|
/**
|
1216
1523
|
* 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
|
1524
|
+
* item's custom data.
|
1218
1525
|
*/
|
1219
1526
|
CustomData?: Record<string, string | null>;
|
1220
1527
|
/** CatalogItem.DisplayName at the time this item was purchased. */
|
@@ -1327,7 +1634,7 @@ interface ItemGrant {
|
|
1327
1634
|
CharacterId?: string;
|
1328
1635
|
/**
|
1329
1636
|
* 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
|
1637
|
+
* not begin with a '!' character or be null.
|
1331
1638
|
*/
|
1332
1639
|
Data?: Record<string, string | null>;
|
1333
1640
|
/** Unique identifier of the catalog item to be granted to the user. */
|
@@ -1354,7 +1661,7 @@ interface ItemInstance {
|
|
1354
1661
|
CatalogVersion?: string;
|
1355
1662
|
/**
|
1356
1663
|
* 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
|
1664
|
+
* item's custom data.
|
1358
1665
|
*/
|
1359
1666
|
CustomData?: Record<string, string | null>;
|
1360
1667
|
/** CatalogItem.DisplayName at the time this item was purchased. */
|
@@ -1410,6 +1717,14 @@ interface LinkedUserAccountSegmentFilter {
|
|
1410
1717
|
/** Login provider. */
|
1411
1718
|
LoginProvider?: string;
|
1412
1719
|
}
|
1720
|
+
/** @deprecated Do not use */
|
1721
|
+
interface ListBuildsRequest extends IPlayFabRequestCommon {
|
1722
|
+
}
|
1723
|
+
/** @deprecated Do not use */
|
1724
|
+
interface ListBuildsResult extends IPlayFabResultCommon {
|
1725
|
+
/** array of uploaded game server builds */
|
1726
|
+
Builds?: GetServerBuildInfoResult[];
|
1727
|
+
}
|
1413
1728
|
interface ListOpenIdConnectionRequest extends IPlayFabRequestCommon {
|
1414
1729
|
}
|
1415
1730
|
interface ListOpenIdConnectionResponse extends IPlayFabResultCommon {
|
@@ -1426,7 +1741,7 @@ interface ListPlayerCustomPropertiesResult extends IPlayFabResultCommon {
|
|
1426
1741
|
/** Player specific properties and their corresponding values for this title. */
|
1427
1742
|
Properties?: CustomPropertyDetails[];
|
1428
1743
|
/**
|
1429
|
-
* Indicates the current version of a player
|
1744
|
+
* Indicates the current version of a player's properties that have been set. This is incremented after updates and
|
1430
1745
|
* deletes. This version can be provided in update and delete calls for concurrency control.
|
1431
1746
|
*/
|
1432
1747
|
PropertiesVersion: number;
|
@@ -1456,7 +1771,7 @@ interface LocationSegmentFilter {
|
|
1456
1771
|
interface LogStatement {
|
1457
1772
|
/** Optional object accompanying the message as contextual information */
|
1458
1773
|
Data?: any;
|
1459
|
-
/**
|
1774
|
+
/** 'Debug', 'Info', or 'Error' */
|
1460
1775
|
Level?: string;
|
1461
1776
|
Message?: string;
|
1462
1777
|
}
|
@@ -1486,14 +1801,79 @@ interface MembershipModel {
|
|
1486
1801
|
* overridden, this will be the new expiration time.
|
1487
1802
|
*/
|
1488
1803
|
OverrideExpiration?: string;
|
1804
|
+
/** Whether the override expiration is set. */
|
1805
|
+
OverrideIsSet?: boolean;
|
1489
1806
|
/** The list of subscriptions that this player has for this membership */
|
1490
1807
|
Subscriptions?: SubscriptionModel[];
|
1491
1808
|
}
|
1809
|
+
/** @deprecated Do not use */
|
1810
|
+
interface ModifyMatchmakerGameModesRequest extends IPlayFabRequestCommon {
|
1811
|
+
/** previously uploaded build version for which game modes are being specified */
|
1812
|
+
BuildVersion: string;
|
1813
|
+
/** array of game modes (Note: this will replace all game modes for the indicated build version) */
|
1814
|
+
GameModes: GameModeInfo[];
|
1815
|
+
}
|
1816
|
+
/** @deprecated Do not use */
|
1817
|
+
interface ModifyMatchmakerGameModesResult extends IPlayFabResultCommon {
|
1818
|
+
}
|
1819
|
+
/** @deprecated Do not use */
|
1820
|
+
interface ModifyServerBuildRequest extends IPlayFabRequestCommon {
|
1821
|
+
/** array of regions where this build can used, when it is active */
|
1822
|
+
ActiveRegions?: string[];
|
1823
|
+
/** unique identifier of the previously uploaded build executable to be updated */
|
1824
|
+
BuildId: string;
|
1825
|
+
/** appended to the end of the command line when starting game servers */
|
1826
|
+
CommandLineTemplate?: string;
|
1827
|
+
/** developer comment(s) for this build */
|
1828
|
+
Comment?: string;
|
1829
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1830
|
+
CustomTags?: Record<string, string | null>;
|
1831
|
+
/** path to the game server executable. Defaults to gameserver.exe */
|
1832
|
+
ExecutablePath?: string;
|
1833
|
+
/** maximum number of game server instances that can run on a single host machine */
|
1834
|
+
MaxGamesPerHost: number;
|
1835
|
+
/**
|
1836
|
+
* minimum capacity of additional game server instances that can be started before the autoscaling service starts new host
|
1837
|
+
* machines (given the number of current running host machines and game server instances)
|
1838
|
+
*/
|
1839
|
+
MinFreeGameSlots: number;
|
1840
|
+
/** new timestamp */
|
1841
|
+
Timestamp?: string;
|
1842
|
+
}
|
1843
|
+
/** @deprecated Do not use */
|
1844
|
+
interface ModifyServerBuildResult extends IPlayFabResultCommon {
|
1845
|
+
/** array of regions where this build can used, when it is active */
|
1846
|
+
ActiveRegions?: string[];
|
1847
|
+
/** unique identifier for this build executable */
|
1848
|
+
BuildId?: string;
|
1849
|
+
/** appended to the end of the command line when starting game servers */
|
1850
|
+
CommandLineTemplate?: string;
|
1851
|
+
/** developer comment(s) for this build */
|
1852
|
+
Comment?: string;
|
1853
|
+
/** path to the game server executable. Defaults to gameserver.exe */
|
1854
|
+
ExecutablePath?: string;
|
1855
|
+
/** maximum number of game server instances that can run on a single host machine */
|
1856
|
+
MaxGamesPerHost: number;
|
1857
|
+
/**
|
1858
|
+
* minimum capacity of additional game server instances that can be started before the autoscaling service starts new host
|
1859
|
+
* machines (given the number of current running host machines and game server instances)
|
1860
|
+
*/
|
1861
|
+
MinFreeGameSlots: number;
|
1862
|
+
/** the current status of the build validation and processing steps */
|
1863
|
+
Status?: string;
|
1864
|
+
/** time this build was last modified (or uploaded, if this build has never been modified) */
|
1865
|
+
Timestamp: string;
|
1866
|
+
/**
|
1867
|
+
* Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
|
1868
|
+
* title has been selected.
|
1869
|
+
*/
|
1870
|
+
TitleId?: string;
|
1871
|
+
}
|
1492
1872
|
interface ModifyUserVirtualCurrencyResult extends IPlayFabResultCommon {
|
1493
1873
|
/** Balance of the virtual currency after modification. */
|
1494
1874
|
Balance: number;
|
1495
1875
|
/**
|
1496
|
-
* Amount added or subtracted from the user
|
1876
|
+
* Amount added or subtracted from the user's virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase
|
1497
1877
|
* over this value will be discarded.
|
1498
1878
|
*/
|
1499
1879
|
BalanceChange: number;
|
@@ -1515,9 +1895,9 @@ interface OpenIdConnection {
|
|
1515
1895
|
ClientSecret?: string;
|
1516
1896
|
/** A name for the connection to identify it within the title. */
|
1517
1897
|
ConnectionId?: string;
|
1518
|
-
/** Shows if data about the connection will be loaded from the issuer
|
1898
|
+
/** Shows if data about the connection will be loaded from the issuer's discovery document */
|
1519
1899
|
DiscoverConfiguration: boolean;
|
1520
|
-
/** Ignore
|
1900
|
+
/** Ignore 'nonce' claim in identity tokens. */
|
1521
1901
|
IgnoreNonce?: boolean;
|
1522
1902
|
/** Information for an OpenID Connect provider. */
|
1523
1903
|
IssuerInformation?: OpenIdIssuerInformation;
|
@@ -1535,7 +1915,7 @@ interface OpenIdIssuerInformation {
|
|
1535
1915
|
TokenUrl: string;
|
1536
1916
|
}
|
1537
1917
|
interface PermissionStatement {
|
1538
|
-
/** The action this statement effects. The only supported action is
|
1918
|
+
/** The action this statement effects. The only supported action is 'Execute'. */
|
1539
1919
|
Action: string;
|
1540
1920
|
/** Additional conditions to be applied for API Resources. */
|
1541
1921
|
ApiConditions?: ApiCondition;
|
@@ -1543,11 +1923,11 @@ interface PermissionStatement {
|
|
1543
1923
|
Comment?: string;
|
1544
1924
|
/** The effect this statement will have. It could be either Allow or Deny */
|
1545
1925
|
Effect: string;
|
1546
|
-
/** The principal this statement will effect. The only supported principal is
|
1926
|
+
/** The principal this statement will effect. The only supported principal is '*'. */
|
1547
1927
|
Principal: string;
|
1548
1928
|
/**
|
1549
|
-
* The resource this statements effects. The only supported resources look like
|
1550
|
-
*
|
1929
|
+
* The resource this statements effects. The only supported resources look like 'pfrn:api--*' for all apis, or
|
1930
|
+
* 'pfrn:api--/Client/ConfirmPurchase' for specific apis.
|
1551
1931
|
*/
|
1552
1932
|
Resource: string;
|
1553
1933
|
}
|
@@ -1570,31 +1950,31 @@ interface PlayerChurnPreviousPredictionSegmentFilter {
|
|
1570
1950
|
RiskLevel?: string;
|
1571
1951
|
}
|
1572
1952
|
interface PlayerLinkedAccount {
|
1573
|
-
/** Linked account
|
1953
|
+
/** Linked account's email */
|
1574
1954
|
Email?: string;
|
1575
1955
|
/** Authentication platform */
|
1576
1956
|
Platform?: string;
|
1577
1957
|
/** Platform user identifier */
|
1578
1958
|
PlatformUserId?: string;
|
1579
|
-
/** Linked account
|
1959
|
+
/** Linked account's username */
|
1580
1960
|
Username?: string;
|
1581
1961
|
}
|
1582
1962
|
interface PlayerLocation {
|
1583
|
-
/** City of the player
|
1963
|
+
/** City of the player's geographic location. */
|
1584
1964
|
City?: string;
|
1585
1965
|
/** The two-character continent code for this location */
|
1586
1966
|
ContinentCode: string;
|
1587
1967
|
/** The two-character ISO 3166-1 country code for the country associated with the location */
|
1588
1968
|
CountryCode: string;
|
1589
|
-
/** Latitude coordinate of the player
|
1969
|
+
/** Latitude coordinate of the player's geographic location. */
|
1590
1970
|
Latitude?: number;
|
1591
|
-
/** Longitude coordinate of the player
|
1971
|
+
/** Longitude coordinate of the player's geographic location. */
|
1592
1972
|
Longitude?: number;
|
1593
1973
|
}
|
1594
1974
|
interface PlayerProfile {
|
1595
1975
|
/** Array of ad campaigns player has been attributed to */
|
1596
1976
|
AdCampaignAttributions?: AdCampaignAttribution[];
|
1597
|
-
/** Image URL of the player
|
1977
|
+
/** Image URL of the player's avatar. */
|
1598
1978
|
AvatarUrl?: string;
|
1599
1979
|
/** Banned until UTC Date. If permanent ban this is set for 20 years after the original ban date. */
|
1600
1980
|
BannedUntil?: string;
|
@@ -1604,7 +1984,7 @@ interface PlayerProfile {
|
|
1604
1984
|
ContactEmailAddresses?: ContactEmailInfo[];
|
1605
1985
|
/** Player record created */
|
1606
1986
|
Created?: string;
|
1607
|
-
/** Dictionary of player
|
1987
|
+
/** Dictionary of player's custom properties. */
|
1608
1988
|
CustomProperties?: Record<string, any>;
|
1609
1989
|
/** Player Display Name */
|
1610
1990
|
DisplayName?: string;
|
@@ -1612,7 +1992,7 @@ interface PlayerProfile {
|
|
1612
1992
|
LastLogin?: string;
|
1613
1993
|
/** Array of third party accounts linked to this player */
|
1614
1994
|
LinkedAccounts?: PlayerLinkedAccount[];
|
1615
|
-
/** Dictionary of player
|
1995
|
+
/** Dictionary of player's locations by type. */
|
1616
1996
|
Locations?: Record<string, PlayerLocation>;
|
1617
1997
|
/** Player account origination */
|
1618
1998
|
Origination?: string;
|
@@ -1626,23 +2006,23 @@ interface PlayerProfile {
|
|
1626
2006
|
PublisherId?: string;
|
1627
2007
|
/** Array of configured push notification end points */
|
1628
2008
|
PushNotificationRegistrations?: PushNotificationRegistration[];
|
1629
|
-
/** Dictionary of player
|
2009
|
+
/** Dictionary of player's statistics using only the latest version's value */
|
1630
2010
|
Statistics?: Record<string, number>;
|
1631
|
-
/** List of player
|
2011
|
+
/** List of player's tags for segmentation. */
|
1632
2012
|
Tags?: string[];
|
1633
2013
|
/** Title ID this profile applies to */
|
1634
2014
|
TitleId?: string;
|
1635
|
-
/** A sum of player
|
2015
|
+
/** A sum of player's total purchases in USD across all currencies. */
|
1636
2016
|
TotalValueToDateInUSD?: number;
|
1637
|
-
/** Dictionary of player
|
2017
|
+
/** Dictionary of player's total purchases by currency. */
|
1638
2018
|
ValuesToDate?: Record<string, number>;
|
1639
|
-
/** Dictionary of player
|
2019
|
+
/** Dictionary of player's virtual currency balances */
|
1640
2020
|
VirtualCurrencyBalances?: Record<string, number>;
|
1641
2021
|
}
|
1642
2022
|
interface PlayerProfileModel {
|
1643
2023
|
/** List of advertising campaigns the player has been attributed to */
|
1644
2024
|
AdCampaignAttributions?: AdCampaignAttributionModel[];
|
1645
|
-
/** URL of the player
|
2025
|
+
/** URL of the player's avatar image */
|
1646
2026
|
AvatarUrl?: string;
|
1647
2027
|
/** If the player is currently banned, the UTC Date when the ban expires */
|
1648
2028
|
BannedUntil?: string;
|
@@ -1676,20 +2056,20 @@ interface PlayerProfileModel {
|
|
1676
2056
|
PushNotificationRegistrations?: PushNotificationRegistrationModel[];
|
1677
2057
|
/** List of leaderboard statistic values for the player */
|
1678
2058
|
Statistics?: StatisticModel[];
|
1679
|
-
/** List of player
|
2059
|
+
/** List of player's tags for segmentation */
|
1680
2060
|
Tags?: TagModel[];
|
1681
2061
|
/** Title ID this player profile applies to */
|
1682
2062
|
TitleId?: string;
|
1683
2063
|
/**
|
1684
|
-
* Sum of the player
|
2064
|
+
* Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a
|
1685
2065
|
* whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.
|
1686
2066
|
*/
|
1687
2067
|
TotalValueToDateInUSD?: number;
|
1688
|
-
/** List of the player
|
2068
|
+
/** List of the player's lifetime purchase totals, summed by real-money currency */
|
1689
2069
|
ValuesToDate?: ValueToDateModel[];
|
1690
2070
|
}
|
1691
2071
|
interface PlayerProfileViewConstraints {
|
1692
|
-
/** Whether to show player
|
2072
|
+
/** Whether to show player's avatar URL. Defaults to false */
|
1693
2073
|
ShowAvatarUrl: boolean;
|
1694
2074
|
/** Whether to show the banned until time. Defaults to false */
|
1695
2075
|
ShowBannedUntil: boolean;
|
@@ -1701,15 +2081,15 @@ interface PlayerProfileViewConstraints {
|
|
1701
2081
|
ShowCreated: boolean;
|
1702
2082
|
/** Whether to show the display name. Defaults to false */
|
1703
2083
|
ShowDisplayName: boolean;
|
1704
|
-
/** Whether to show player
|
2084
|
+
/** Whether to show player's experiment variants. Defaults to false */
|
1705
2085
|
ShowExperimentVariants: boolean;
|
1706
2086
|
/** Whether to show the last login time. Defaults to false */
|
1707
2087
|
ShowLastLogin: boolean;
|
1708
2088
|
/** Whether to show the linked accounts. Defaults to false */
|
1709
2089
|
ShowLinkedAccounts: boolean;
|
1710
|
-
/** Whether to show player
|
2090
|
+
/** Whether to show player's locations. Defaults to false */
|
1711
2091
|
ShowLocations: boolean;
|
1712
|
-
/** Whether to show player
|
2092
|
+
/** Whether to show player's membership information. Defaults to false */
|
1713
2093
|
ShowMemberships: boolean;
|
1714
2094
|
/** Whether to show origination. Defaults to false */
|
1715
2095
|
ShowOrigination: boolean;
|
@@ -1747,6 +2127,11 @@ interface PlayerStatisticDefinition {
|
|
1747
2127
|
interface PlayerStatisticVersion {
|
1748
2128
|
/** time when the statistic version became active */
|
1749
2129
|
ActivationTime: string;
|
2130
|
+
/**
|
2131
|
+
* status of the process of saving player statistic values of the previous version to a downloadable archive
|
2132
|
+
* @deprecated Please use Status instead.
|
2133
|
+
*/
|
2134
|
+
ArchivalStatus?: string;
|
1750
2135
|
/** URL for the downloadable archive of player statistic values, if available */
|
1751
2136
|
ArchiveDownloadUrl?: string;
|
1752
2137
|
/** time when the statistic version became inactive due to statistic version incrementing */
|
@@ -1817,7 +2202,7 @@ interface RefundPurchaseRequest extends IPlayFabRequestCommon {
|
|
1817
2202
|
Reason?: string;
|
1818
2203
|
}
|
1819
2204
|
interface RefundPurchaseResponse extends IPlayFabResultCommon {
|
1820
|
-
/** The order
|
2205
|
+
/** The order's updated purchase status. */
|
1821
2206
|
PurchaseStatus?: string;
|
1822
2207
|
}
|
1823
2208
|
interface RemovePlayerTagRequest extends IPlayFabRequestCommon {
|
@@ -1830,6 +2215,14 @@ interface RemovePlayerTagRequest extends IPlayFabRequestCommon {
|
|
1830
2215
|
}
|
1831
2216
|
interface RemovePlayerTagResult extends IPlayFabResultCommon {
|
1832
2217
|
}
|
2218
|
+
/** @deprecated Do not use */
|
2219
|
+
interface RemoveServerBuildRequest extends IPlayFabRequestCommon {
|
2220
|
+
/** unique identifier of the previously uploaded build executable to be removed */
|
2221
|
+
BuildId: string;
|
2222
|
+
}
|
2223
|
+
/** @deprecated Do not use */
|
2224
|
+
interface RemoveServerBuildResult extends IPlayFabResultCommon {
|
2225
|
+
}
|
1833
2226
|
interface RemoveVirtualCurrencyTypesRequest extends IPlayFabRequestCommon {
|
1834
2227
|
/** List of virtual currencies to delete */
|
1835
2228
|
VirtualCurrencies: VirtualCurrencyData[];
|
@@ -1854,6 +2247,13 @@ interface ResetPasswordRequest extends IPlayFabRequestCommon {
|
|
1854
2247
|
}
|
1855
2248
|
interface ResetPasswordResult extends IPlayFabResultCommon {
|
1856
2249
|
}
|
2250
|
+
/** @deprecated Do not use */
|
2251
|
+
interface ResetUsersRequest extends IPlayFabRequestCommon {
|
2252
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2253
|
+
CustomTags?: Record<string, string | null>;
|
2254
|
+
/** Array of users to reset */
|
2255
|
+
Users: UserCredentials[];
|
2256
|
+
}
|
1857
2257
|
interface ResetUserStatisticsRequest extends IPlayFabRequestCommon {
|
1858
2258
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1859
2259
|
CustomTags?: Record<string, string | null>;
|
@@ -1880,7 +2280,7 @@ interface ResolvePurchaseDisputeRequest extends IPlayFabRequestCommon {
|
|
1880
2280
|
Reason?: string;
|
1881
2281
|
}
|
1882
2282
|
interface ResolvePurchaseDisputeResponse extends IPlayFabResultCommon {
|
1883
|
-
/** The order
|
2283
|
+
/** The order's updated purchase status. */
|
1884
2284
|
PurchaseStatus?: string;
|
1885
2285
|
}
|
1886
2286
|
interface ResultTableNode {
|
@@ -1964,7 +2364,7 @@ interface ScheduledTask {
|
|
1964
2364
|
/** UTC time of next run */
|
1965
2365
|
NextRunTime?: string;
|
1966
2366
|
/**
|
1967
|
-
* Task parameter. Different types of task have different parameter structure. See each task type
|
2367
|
+
* Task parameter. Different types of task have different parameter structure. See each task type's create API
|
1968
2368
|
* documentation for the details.
|
1969
2369
|
*/
|
1970
2370
|
Parameter?: any;
|
@@ -2098,6 +2498,12 @@ interface SendEmailContent {
|
|
2098
2498
|
/** The email template id of the email template to send. */
|
2099
2499
|
EmailTemplateId: string;
|
2100
2500
|
}
|
2501
|
+
interface SetEventSinkRequest extends IPlayFabRequestCommon {
|
2502
|
+
/** The sink to which to route PlayStream and Telemetry event data. */
|
2503
|
+
Sink: EventSink;
|
2504
|
+
}
|
2505
|
+
interface SetEventSinkResult extends IPlayFabResultCommon {
|
2506
|
+
}
|
2101
2507
|
interface SetMembershipOverrideRequest extends IPlayFabRequestCommon {
|
2102
2508
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
2103
2509
|
CustomTags?: Record<string, string | null>;
|
@@ -2130,8 +2536,8 @@ interface SetPublishedRevisionResult extends IPlayFabResultCommon {
|
|
2130
2536
|
}
|
2131
2537
|
interface SetPublisherDataRequest extends IPlayFabRequestCommon {
|
2132
2538
|
/**
|
2133
|
-
* key we want to set a value on (note, this is additive - will only replace an existing key
|
2134
|
-
* name.) Keys are trimmed of whitespace. Keys may not begin with the
|
2539
|
+
* 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
|
2540
|
+
* name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.
|
2135
2541
|
*/
|
2136
2542
|
Key: string;
|
2137
2543
|
/** new value to set. Set to null to remove a value */
|
@@ -2152,8 +2558,8 @@ interface SetTitleDataAndOverridesResult extends IPlayFabResultCommon {
|
|
2152
2558
|
}
|
2153
2559
|
interface SetTitleDataRequest extends IPlayFabRequestCommon {
|
2154
2560
|
/**
|
2155
|
-
* key we want to set a value on (note, this is additive - will only replace an existing key
|
2156
|
-
* name.) Keys are trimmed of whitespace. Keys may not begin with the
|
2561
|
+
* 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
|
2562
|
+
* name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.
|
2157
2563
|
*/
|
2158
2564
|
Key: string;
|
2159
2565
|
/** new value to set. Set to null to remove a value */
|
@@ -2223,7 +2629,7 @@ interface StoreItem {
|
|
2223
2629
|
ItemId: string;
|
2224
2630
|
/** Override prices for this item for specific currencies */
|
2225
2631
|
RealCurrencyPrices?: Record<string, number>;
|
2226
|
-
/** Override prices for this item in virtual currencies and
|
2632
|
+
/** Override prices for this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
|
2227
2633
|
VirtualCurrencyPrices?: Record<string, number>;
|
2228
2634
|
}
|
2229
2635
|
interface StoreMarketingModel {
|
@@ -2239,7 +2645,7 @@ interface SubscriptionModel {
|
|
2239
2645
|
Expiration: string;
|
2240
2646
|
/** The time the subscription was orignially purchased */
|
2241
2647
|
InitialSubscriptionTime: string;
|
2242
|
-
/** Whether this subscription is currently active. That is, if Expiration
|
2648
|
+
/** Whether this subscription is currently active. That is, if Expiration > now. */
|
2243
2649
|
IsActive: boolean;
|
2244
2650
|
/** The status of this subscription, according to the subscription provider. */
|
2245
2651
|
Status?: string;
|
@@ -2318,8 +2724,8 @@ interface TaskInstanceBasicSummary {
|
|
2318
2724
|
}
|
2319
2725
|
interface TitleDataKeyValue {
|
2320
2726
|
/**
|
2321
|
-
* Key we want to set a value on (note, this is additive - will only replace an existing key
|
2322
|
-
* name.) Keys are trimmed of whitespace. Keys may not begin with the
|
2727
|
+
* 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
|
2728
|
+
* name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.
|
2323
2729
|
*/
|
2324
2730
|
Key?: string;
|
2325
2731
|
/** New value to set. Set to null to remove a value */
|
@@ -2338,8 +2744,19 @@ interface UpdateBanRequest {
|
|
2338
2744
|
BanId: string;
|
2339
2745
|
/** The updated expiration date for the ban. Null for no change. */
|
2340
2746
|
Expires?: string;
|
2747
|
+
/**
|
2748
|
+
* The updated decision to ban the Microsoft family members to be updated. Null for no change. This property is deprecated
|
2749
|
+
* and does not work anymore.
|
2750
|
+
* @deprecated Please use UserFamilyType instead.
|
2751
|
+
*/
|
2752
|
+
IncludeMicrosoftFamily?: boolean;
|
2341
2753
|
/** The updated IP address for the ban. Null for no change. */
|
2342
2754
|
IPAddress?: string;
|
2755
|
+
/**
|
2756
|
+
* The updated MAC address for the ban. Null for no change. This property is deprecated and does not work anymore.
|
2757
|
+
* @deprecated Do not use
|
2758
|
+
*/
|
2759
|
+
MACAddress?: string;
|
2343
2760
|
/** Whether to make this ban permanent. Set to true to make this ban permanent. This will not modify Active state. */
|
2344
2761
|
Permanent?: boolean;
|
2345
2762
|
/** The updated reason for the ban to be updated. Maximum 140 characters. Null for no change. */
|
@@ -2382,6 +2799,11 @@ interface UpdateCloudScriptRequest extends IPlayFabRequestCommon {
|
|
2382
2799
|
Files: CloudScriptFile[];
|
2383
2800
|
/** Immediately publish the new revision */
|
2384
2801
|
Publish: boolean;
|
2802
|
+
/**
|
2803
|
+
* Deprecated - Do not use
|
2804
|
+
* @deprecated Do not use
|
2805
|
+
*/
|
2806
|
+
Version?: number;
|
2385
2807
|
}
|
2386
2808
|
interface UpdateCloudScriptResult extends IPlayFabResultCommon {
|
2387
2809
|
/** New revision number created */
|
@@ -2396,7 +2818,7 @@ interface UpdateOpenIdConnectionRequest extends IPlayFabRequestCommon {
|
|
2396
2818
|
ClientSecret?: string;
|
2397
2819
|
/** A name for the connection that identifies it within the title. */
|
2398
2820
|
ConnectionId: string;
|
2399
|
-
/** Ignore
|
2821
|
+
/** Ignore 'nonce' claim in identity tokens. */
|
2400
2822
|
IgnoreNonce?: boolean;
|
2401
2823
|
/** The issuer URL or discovery document URL to read issuer information from */
|
2402
2824
|
IssuerDiscoveryUrl?: string;
|
@@ -2410,7 +2832,7 @@ interface UpdatePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
|
|
2410
2832
|
CustomTags?: Record<string, string | null>;
|
2411
2833
|
/**
|
2412
2834
|
* Optional field used for concurrency control. One can ensure that the update operation will only be performed if the
|
2413
|
-
* player
|
2835
|
+
* player's properties have not been updated by any other clients since last the version.
|
2414
2836
|
*/
|
2415
2837
|
ExpectedPropertiesVersion?: number;
|
2416
2838
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
@@ -2422,7 +2844,7 @@ interface UpdatePlayerCustomPropertiesResult extends IPlayFabResultCommon {
|
|
2422
2844
|
/** PlayFab unique identifier of the user whose properties were updated. */
|
2423
2845
|
PlayFabId?: string;
|
2424
2846
|
/**
|
2425
|
-
* Indicates the current version of a player
|
2847
|
+
* Indicates the current version of a player's properties that have been set. This is incremented after updates and
|
2426
2848
|
* deletes. This version can be provided in update and delete calls for concurrency control.
|
2427
2849
|
*/
|
2428
2850
|
PropertiesVersion: number;
|
@@ -2455,7 +2877,7 @@ interface UpdatePlayerStatisticDefinitionResult extends IPlayFabResultCommon {
|
|
2455
2877
|
interface UpdatePolicyRequest extends IPlayFabRequestCommon {
|
2456
2878
|
/** Whether to overwrite or append to the existing policy. */
|
2457
2879
|
OverwritePolicy: boolean;
|
2458
|
-
/** The name of the policy being updated. Only supported name is
|
2880
|
+
/** The name of the policy being updated. Only supported name is 'ApiPolicy' */
|
2459
2881
|
PolicyName: string;
|
2460
2882
|
/** Version of the policy to update. Must be the latest (as returned by GetPolicy). */
|
2461
2883
|
PolicyVersion: number;
|
@@ -2522,7 +2944,7 @@ interface UpdateTaskRequest extends IPlayFabRequestCommon {
|
|
2522
2944
|
IsActive: boolean;
|
2523
2945
|
/** Name of the task. This is a unique identifier for tasks in the title. */
|
2524
2946
|
Name: string;
|
2525
|
-
/** Parameter object specific to the task type. See each task type
|
2947
|
+
/** Parameter object specific to the task type. See each task type's create API documentation for details. */
|
2526
2948
|
Parameter?: any;
|
2527
2949
|
/** Cron expression for the run schedule of the task. The expression should be in UTC. */
|
2528
2950
|
Schedule?: string;
|
@@ -2534,7 +2956,7 @@ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
|
|
2534
2956
|
CustomTags?: Record<string, string | null>;
|
2535
2957
|
/**
|
2536
2958
|
* 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
|
2959
|
+
* not begin with a '!' character or be null.
|
2538
2960
|
*/
|
2539
2961
|
Data?: Record<string, string | null>;
|
2540
2962
|
/**
|
@@ -2542,7 +2964,7 @@ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
|
|
2542
2964
|
* constraints. Use this to delete the keys directly.
|
2543
2965
|
*/
|
2544
2966
|
KeysToRemove?: string[];
|
2545
|
-
/** Permission to be applied to all user data keys written in this request. Defaults to
|
2967
|
+
/** Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. */
|
2546
2968
|
Permission?: string;
|
2547
2969
|
/** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
|
2548
2970
|
PlayFabId: string;
|
@@ -2559,7 +2981,7 @@ interface UpdateUserInternalDataRequest extends IPlayFabRequestCommon {
|
|
2559
2981
|
CustomTags?: Record<string, string | null>;
|
2560
2982
|
/**
|
2561
2983
|
* 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
|
2984
|
+
* not begin with a '!' character or be null.
|
2563
2985
|
*/
|
2564
2986
|
Data?: Record<string, string | null>;
|
2565
2987
|
/**
|
@@ -2646,6 +3068,16 @@ interface UserBattleNetInfo {
|
|
2646
3068
|
/** Battle.net display name */
|
2647
3069
|
BattleNetBattleTag?: string;
|
2648
3070
|
}
|
3071
|
+
/** @deprecated Do not use */
|
3072
|
+
interface UserCredentials {
|
3073
|
+
/**
|
3074
|
+
* Password for the PlayFab account
|
3075
|
+
* @deprecated Do not use
|
3076
|
+
*/
|
3077
|
+
Password?: string;
|
3078
|
+
/** Username of user to reset */
|
3079
|
+
Username: string;
|
3080
|
+
}
|
2649
3081
|
interface UserCustomIdInfo {
|
2650
3082
|
/** Custom ID */
|
2651
3083
|
CustomId?: string;
|
@@ -2752,7 +3184,7 @@ interface UserSteamInfo {
|
|
2752
3184
|
SteamName?: string;
|
2753
3185
|
}
|
2754
3186
|
interface UserTitleInfo {
|
2755
|
-
/** URL to the player
|
3187
|
+
/** URL to the player's avatar. */
|
2756
3188
|
AvatarUrl?: string;
|
2757
3189
|
/**
|
2758
3190
|
* timestamp indicating when the user was first associated with this game (this can differ significantly from when the user
|
@@ -2792,12 +3224,12 @@ interface ValueToDateModel {
|
|
2792
3224
|
Currency?: string;
|
2793
3225
|
/**
|
2794
3226
|
* 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
|
3227
|
+
* ninety-nine cents when Currency is 'USD')
|
2796
3228
|
*/
|
2797
3229
|
TotalValue: number;
|
2798
3230
|
/**
|
2799
|
-
* Total value of the purchases in a string representation of decimal monetary units. For example,
|
2800
|
-
* dollars and ninety-nine cents when Currency is
|
3231
|
+
* Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine
|
3232
|
+
* dollars and ninety-nine cents when Currency is 'USD'.
|
2801
3233
|
*/
|
2802
3234
|
TotalValueAsDecimal?: string;
|
2803
3235
|
}
|
@@ -2818,7 +3250,7 @@ interface VirtualCurrencyBalanceSegmentFilter {
|
|
2818
3250
|
CurrencyCode?: string;
|
2819
3251
|
}
|
2820
3252
|
interface VirtualCurrencyData {
|
2821
|
-
/** unique two-character identifier for this currency type (e.g.:
|
3253
|
+
/** unique two-character identifier for this currency type (e.g.: "CC") */
|
2822
3254
|
CurrencyCode: string;
|
2823
3255
|
/** friendly name to show in the developer portal, reports, etc. */
|
2824
3256
|
DisplayName?: string;
|
@@ -2845,243 +3277,666 @@ interface VirtualCurrencyRechargeTime {
|
|
2845
3277
|
declare class PlayFabAdminApi extends PlayFabCommon {
|
2846
3278
|
/**
|
2847
3279
|
* Abort an ongoing task instance.
|
2848
|
-
*
|
3280
|
+
*
|
3281
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/aborttaskinstance Microsoft Documentation}
|
3282
|
+
* @example
|
3283
|
+
* await adminClient.AbortTaskInstance({
|
3284
|
+
* "TaskInstanceId": "E52531B47B1761C7-4"
|
3285
|
+
* });
|
2849
3286
|
*/
|
2850
3287
|
AbortTaskInstance(request: AbortTaskInstanceRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2851
3288
|
/**
|
2852
3289
|
* Update news item to include localized version
|
2853
|
-
*
|
3290
|
+
*
|
3291
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addlocalizednews Microsoft Documentation}
|
3292
|
+
* @example
|
3293
|
+
* await adminClient.AddLocalizedNews({
|
3294
|
+
* "NewsId": "74623b12-6c80-ee4b-7c3b-58e638aa62bd",
|
3295
|
+
* "Language": "en",
|
3296
|
+
* "Title": "News of the Day",
|
3297
|
+
* "Body": "<b>We have a new object to buy!</b>"
|
3298
|
+
* });
|
2854
3299
|
*/
|
2855
3300
|
AddLocalizedNews(request: AddLocalizedNewsRequest, extraHeaders?: Record<string, string>): Promise<AddLocalizedNewsResult>;
|
2856
3301
|
/**
|
2857
3302
|
* Adds a new news item to the title's news feed
|
2858
|
-
*
|
3303
|
+
*
|
3304
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addnews Microsoft Documentation}
|
3305
|
+
* @example
|
3306
|
+
* await adminClient.AddNews({
|
3307
|
+
* "Timestamp": "2014-04-06T00:00:00Z",
|
3308
|
+
* "Title": "News of the Day",
|
3309
|
+
* "Body": "<b>We have a new object to buy!</b>"
|
3310
|
+
* });
|
2859
3311
|
*/
|
2860
3312
|
AddNews(request: AddNewsRequest, extraHeaders?: Record<string, string>): Promise<AddNewsResult>;
|
2861
3313
|
/**
|
2862
3314
|
* Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
|
2863
|
-
*
|
3315
|
+
*
|
3316
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/addplayertag Microsoft Documentation}
|
3317
|
+
* @example
|
3318
|
+
* await adminClient.AddPlayerTag({
|
3319
|
+
* "PlayFabId": "10931252888739651331",
|
3320
|
+
* "TagName": "MostKilled"
|
3321
|
+
* });
|
2864
3322
|
*/
|
2865
3323
|
AddPlayerTag(request: AddPlayerTagRequest, extraHeaders?: Record<string, string>): Promise<AddPlayerTagResult>;
|
3324
|
+
/**
|
3325
|
+
* Adds the game server executable specified (previously uploaded - see GetServerBuildUploadUrl) to the set of those a
|
3326
|
+
* client is permitted to request in a call to StartGame
|
3327
|
+
*
|
3328
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/addserverbuild Microsoft Documentation}
|
3329
|
+
* @deprecated Do not use
|
3330
|
+
*/
|
3331
|
+
AddServerBuild(request: AddServerBuildRequest, extraHeaders?: Record<string, string>): Promise<AddServerBuildResult>;
|
2866
3332
|
/**
|
2867
3333
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
2868
3334
|
* version 2._ Increments the specified virtual currency by the stated amount
|
2869
|
-
*
|
3335
|
+
*
|
3336
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/adduservirtualcurrency Microsoft Documentation}
|
3337
|
+
* @example
|
3338
|
+
* await adminClient.AddUserVirtualCurrency({
|
3339
|
+
* "PlayFabId": "20394883",
|
3340
|
+
* "VirtualCurrency": "GC",
|
3341
|
+
* "Amount": 100
|
3342
|
+
* });
|
2870
3343
|
*/
|
2871
3344
|
AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
|
2872
3345
|
/**
|
2873
3346
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
2874
3347
|
* version 2._ Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum
|
2875
3348
|
* value of 2,147,483,647 when granted to a player. Any value over that will be discarded.
|
2876
|
-
*
|
3349
|
+
*
|
3350
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addvirtualcurrencytypes Microsoft Documentation}
|
3351
|
+
* @example
|
3352
|
+
* await adminClient.AddVirtualCurrencyTypes({
|
3353
|
+
* "VirtualCurrencies": [
|
3354
|
+
* {
|
3355
|
+
* "CurrencyCode": "CC",
|
3356
|
+
* "DisplayName": "Chump Coins",
|
3357
|
+
* "InitialDeposit": 100,
|
3358
|
+
* "RechargeRate": 1000,
|
3359
|
+
* "RechargeMax": 1000
|
3360
|
+
* },
|
3361
|
+
* {
|
3362
|
+
* "CurrencyCode": "GC"
|
3363
|
+
* }
|
3364
|
+
* ]
|
3365
|
+
* });
|
2877
3366
|
*/
|
2878
3367
|
AddVirtualCurrencyTypes(request: AddVirtualCurrencyTypesRequest, extraHeaders?: Record<string, string>): Promise<BlankResult>;
|
2879
3368
|
/**
|
2880
3369
|
* Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
|
2881
|
-
*
|
3370
|
+
*
|
3371
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/banusers Microsoft Documentation}
|
3372
|
+
* @example
|
3373
|
+
* await adminClient.BanUsers({
|
3374
|
+
* "Bans": [
|
3375
|
+
* {
|
3376
|
+
* "PlayFabId": "1679AF5CD04BD838",
|
3377
|
+
* "IPAddress": "192.168.1.1",
|
3378
|
+
* "Reason": "You cheated!",
|
3379
|
+
* "DurationInHours": 7
|
3380
|
+
* },
|
3381
|
+
* {
|
3382
|
+
* "PlayFabId": "2329AF5CD04BF513",
|
3383
|
+
* "Reason": "Caught you using speed hack!"
|
3384
|
+
* }
|
3385
|
+
* ]
|
3386
|
+
* });
|
2882
3387
|
*/
|
2883
3388
|
BanUsers(request: BanUsersRequest, extraHeaders?: Record<string, string>): Promise<BanUsersResult>;
|
2884
3389
|
/**
|
2885
3390
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
2886
3391
|
* version 2._ Checks the global count for the limited edition item.
|
2887
|
-
*
|
3392
|
+
*
|
3393
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/checklimitededitionitemavailability Microsoft Documentation}
|
3394
|
+
* @example
|
3395
|
+
* await adminClient.CheckLimitedEditionItemAvailability({
|
3396
|
+
* "CatalogVersion": "Rares",
|
3397
|
+
* "ItemId": "FreeHoodie"
|
3398
|
+
* });
|
2888
3399
|
*/
|
2889
3400
|
CheckLimitedEditionItemAvailability(request: CheckLimitedEditionItemAvailabilityRequest, extraHeaders?: Record<string, string>): Promise<CheckLimitedEditionItemAvailabilityResult>;
|
2890
3401
|
/**
|
2891
3402
|
* Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.
|
2892
|
-
*
|
3403
|
+
*
|
3404
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createactionsonplayersinsegmenttask Microsoft Documentation}
|
3405
|
+
* @example
|
3406
|
+
* await adminClient.CreateActionsOnPlayersInSegmentTask({
|
3407
|
+
* "Name": "PushNotificationVIP_Halloween",
|
3408
|
+
* "Description": "Send push notification to VIP players about Halloween event",
|
3409
|
+
* "IsActive": false,
|
3410
|
+
* "Parameter": {
|
3411
|
+
* "SegmentId": "274828AF93F13472",
|
3412
|
+
* "Actions": [
|
3413
|
+
* {
|
3414
|
+
* "GrantItemContent": {
|
3415
|
+
* "CatalogVersion": "foo",
|
3416
|
+
* "ItemId": "bar",
|
3417
|
+
* "ItemQuantity": 1
|
3418
|
+
* }
|
3419
|
+
* }
|
3420
|
+
* ]
|
3421
|
+
* }
|
3422
|
+
* });
|
2893
3423
|
*/
|
2894
3424
|
CreateActionsOnPlayersInSegmentTask(request: CreateActionsOnPlayerSegmentTaskRequest, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
|
2895
3425
|
/**
|
2896
3426
|
* Create a CloudScript task, which can run a CloudScript on a schedule.
|
2897
|
-
*
|
3427
|
+
*
|
3428
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createcloudscriptazurefunctionstask Microsoft Documentation}
|
3429
|
+
* @example
|
3430
|
+
* await adminClient.CreateCloudScriptAzureFunctionsTask({
|
3431
|
+
* "Name": "EnableWeekdayHappyHour",
|
3432
|
+
* "Description": "Turn on special pricing for weekday happy hour.",
|
3433
|
+
* "Schedule": "0 17 * * 1-5",
|
3434
|
+
* "IsActive": false,
|
3435
|
+
* "Parameter": {
|
3436
|
+
* "FunctionName": "applyStorePreset",
|
3437
|
+
* "Argument": {
|
3438
|
+
* "preset": "WeekdayHappyHour"
|
3439
|
+
* }
|
3440
|
+
* }
|
3441
|
+
* });
|
3442
|
+
*/
|
3443
|
+
CreateCloudScriptAzureFunctionsTask(request: CreateCloudScriptAzureFunctionsTaskRequest, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
|
3444
|
+
/**
|
3445
|
+
* Create a CloudScript task, which can run a CloudScript on a schedule.
|
3446
|
+
*
|
3447
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createcloudscripttask Microsoft Documentation}
|
3448
|
+
* @example
|
3449
|
+
* await adminClient.CreateCloudScriptTask({
|
3450
|
+
* "Name": "EnableWeekdayHappyHour",
|
3451
|
+
* "Description": "Turn on special pricing for weekday happy hour.",
|
3452
|
+
* "Schedule": "0 17 * * 1-5",
|
3453
|
+
* "IsActive": false,
|
3454
|
+
* "Parameter": {
|
3455
|
+
* "FunctionName": "applyStorePreset",
|
3456
|
+
* "Argument": {
|
3457
|
+
* "preset": "WeekdayHappyHour"
|
3458
|
+
* }
|
3459
|
+
* }
|
3460
|
+
* });
|
2898
3461
|
*/
|
2899
3462
|
CreateCloudScriptTask(request: CreateCloudScriptTaskRequest, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
|
2900
3463
|
/**
|
2901
3464
|
* Create a Insights Scheduled Scaling task, which can scale Insights Performance Units on a schedule
|
2902
|
-
*
|
3465
|
+
*
|
3466
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createinsightsscheduledscalingtask Microsoft Documentation}
|
3467
|
+
* @example
|
3468
|
+
* await adminClient.CreateInsightsScheduledScalingTask({
|
3469
|
+
* "Name": "EnableWeekdayPerformance",
|
3470
|
+
* "Description": "Scale up Insights Performance Units during weekdays.",
|
3471
|
+
* "Schedule": "0 0 * * 1-5",
|
3472
|
+
* "IsActive": false,
|
3473
|
+
* "Parameter": {
|
3474
|
+
* "Level": 3
|
3475
|
+
* }
|
3476
|
+
* });
|
2903
3477
|
*/
|
2904
3478
|
CreateInsightsScheduledScalingTask(request: CreateInsightsScheduledScalingTaskRequest, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
|
2905
3479
|
/**
|
2906
3480
|
* Registers a relationship between a title and an Open ID Connect provider.
|
2907
|
-
*
|
3481
|
+
*
|
3482
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/createopenidconnection Microsoft Documentation}
|
3483
|
+
* @example
|
3484
|
+
* await adminClient.CreateOpenIdConnection({
|
3485
|
+
* "ConnectionId": "oidconnection1",
|
3486
|
+
* "ClientId": "example_id_1",
|
3487
|
+
* "ClientSecret": "example_secret_1",
|
3488
|
+
* "IssuerInformation": {
|
3489
|
+
* "Issuer": "https://issuer.example.com/",
|
3490
|
+
* "AuthorizationUrl": "https://issuer.example.com/authorize",
|
3491
|
+
* "TokenUrl": "https://issuer.example.com/oauth2/token",
|
3492
|
+
* "JsonWebKeySet": {
|
3493
|
+
* "keys": [
|
3494
|
+
* "..."
|
3495
|
+
* ]
|
3496
|
+
* }
|
3497
|
+
* },
|
3498
|
+
* "IssuerOverride": "https://issueroverride.example.com/",
|
3499
|
+
* "IgnoreNonce": true
|
3500
|
+
* });
|
2908
3501
|
*/
|
2909
3502
|
CreateOpenIdConnection(request: CreateOpenIdConnectionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2910
3503
|
/**
|
2911
3504
|
* Creates a new Player Shared Secret Key. It may take up to 5 minutes for this key to become generally available after
|
2912
3505
|
* this API returns.
|
2913
|
-
*
|
3506
|
+
*
|
3507
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/createplayersharedsecret Microsoft Documentation}
|
3508
|
+
* @example
|
3509
|
+
* await adminClient.CreatePlayerSharedSecret({
|
3510
|
+
* "FriendlyName": "iOS Users"
|
3511
|
+
* });
|
2914
3512
|
*/
|
2915
3513
|
CreatePlayerSharedSecret(request: CreatePlayerSharedSecretRequest, extraHeaders?: Record<string, string>): Promise<CreatePlayerSharedSecretResult>;
|
2916
3514
|
/**
|
2917
3515
|
* Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval
|
2918
3516
|
* and an aggregation method.
|
2919
|
-
*
|
3517
|
+
*
|
3518
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/createplayerstatisticdefinition Microsoft Documentation}
|
3519
|
+
* @example
|
3520
|
+
* await adminClient.CreatePlayerStatisticDefinition({
|
3521
|
+
* "StatisticName": "headshots",
|
3522
|
+
* "VersionChangeInterval": "Never",
|
3523
|
+
* "ShouldProvisionLeaderboard": false
|
3524
|
+
* });
|
2920
3525
|
*/
|
2921
3526
|
CreatePlayerStatisticDefinition(request: CreatePlayerStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<CreatePlayerStatisticDefinitionResult>;
|
2922
3527
|
/**
|
2923
3528
|
* Creates a new player segment by defining the conditions on player properties. Also, create actions to target the player
|
2924
3529
|
* segments for a title.
|
2925
|
-
*
|
3530
|
+
*
|
3531
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/segments/createsegment Microsoft Documentation}
|
3532
|
+
* @example
|
3533
|
+
* await adminClient.CreateSegment({
|
3534
|
+
* "SegmentModel": {
|
3535
|
+
* "Name": "My user segment",
|
3536
|
+
* "LastUpdateTime": "0001-01-01T00:00:00Z",
|
3537
|
+
* "SegmentOrDefinitions": [
|
3538
|
+
* {
|
3539
|
+
* "SegmentAndDefinitions": [
|
3540
|
+
* {
|
3541
|
+
* "AllPlayersFilter": {}
|
3542
|
+
* }
|
3543
|
+
* ]
|
3544
|
+
* }
|
3545
|
+
* ],
|
3546
|
+
* "EnteredSegmentActions": [
|
3547
|
+
* {
|
3548
|
+
* "BanPlayerAction": {
|
3549
|
+
* "BanHours": 2,
|
3550
|
+
* "ReasonForBan": "Not played for a year"
|
3551
|
+
* }
|
3552
|
+
* }
|
3553
|
+
* ],
|
3554
|
+
* "LeftSegmentActions": [
|
3555
|
+
* {
|
3556
|
+
* "ExecuteAzureFunctionAction": {
|
3557
|
+
* "AzureFunction": "AzureFunction1",
|
3558
|
+
* "FunctionParameter": "{\"InputParam\": \"1\"}",
|
3559
|
+
* "GenerateFunctionExecutedEvents": false
|
3560
|
+
* }
|
3561
|
+
* }
|
3562
|
+
* ]
|
3563
|
+
* }
|
3564
|
+
* });
|
2926
3565
|
*/
|
2927
3566
|
CreateSegment(request: CreateSegmentRequest, extraHeaders?: Record<string, string>): Promise<CreateSegmentResponse>;
|
2928
3567
|
/**
|
2929
3568
|
* Delete a content file from the title. When deleting a file that does not exist, it returns success.
|
2930
|
-
*
|
3569
|
+
*
|
3570
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/content/deletecontent Microsoft Documentation}
|
3571
|
+
* @example
|
3572
|
+
* await adminClient.DeleteContent({
|
3573
|
+
* "Key": "images/sword_icon.png"
|
3574
|
+
* });
|
2931
3575
|
*/
|
2932
3576
|
DeleteContent(request: DeleteContentRequest, extraHeaders?: Record<string, string>): Promise<BlankResult>;
|
3577
|
+
/**
|
3578
|
+
* Deletes a sink to stop sending PlayStream and Telemetry event data
|
3579
|
+
*
|
3580
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/deleteeventsink Microsoft Documentation}
|
3581
|
+
* @example
|
3582
|
+
* await adminClient.DeleteEventSink({
|
3583
|
+
* "Name": "MyStorage"
|
3584
|
+
* });
|
3585
|
+
*/
|
3586
|
+
DeleteEventSink(request: DeleteEventSinkRequest, extraHeaders?: Record<string, string>): Promise<DeleteEventSinkResult>;
|
2933
3587
|
/**
|
2934
3588
|
* Removes a master player account entirely from all titles and deletes all associated data
|
2935
|
-
*
|
3589
|
+
*
|
3590
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayeraccount Microsoft Documentation}
|
3591
|
+
* @example
|
3592
|
+
* await adminClient.DeleteMasterPlayerAccount({
|
3593
|
+
* "PlayFabId": "A68C908B66C23C5",
|
3594
|
+
* "MetaData": "Identifying info"
|
3595
|
+
* });
|
2936
3596
|
*/
|
2937
3597
|
DeleteMasterPlayerAccount(request: DeleteMasterPlayerAccountRequest, extraHeaders?: Record<string, string>): Promise<DeleteMasterPlayerAccountResult>;
|
2938
3598
|
/**
|
2939
3599
|
* Deletes PlayStream and telemetry event data associated with the master player account from PlayFab storage
|
2940
|
-
*
|
3600
|
+
*
|
3601
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayereventdata Microsoft Documentation}
|
3602
|
+
* @example
|
3603
|
+
* await adminClient.DeleteMasterPlayerEventData({
|
3604
|
+
* "PlayFabId": "A68C908B66C23C5"
|
3605
|
+
* });
|
2941
3606
|
*/
|
2942
3607
|
DeleteMasterPlayerEventData(request: DeleteMasterPlayerEventDataRequest, extraHeaders?: Record<string, string>): Promise<DeleteMasterPlayerEventDataResult>;
|
2943
3608
|
/**
|
2944
3609
|
* Deletes a player's subscription
|
2945
|
-
*
|
3610
|
+
*
|
3611
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemembershipsubscription Microsoft Documentation}
|
3612
|
+
* @example
|
3613
|
+
* await adminClient.DeleteMembershipSubscription({
|
3614
|
+
* "MembershipId": "ShieldBonusMembership",
|
3615
|
+
* "SubscriptionId": "39F6B89A-0F0C-4D96-B12C-BA89543A11A1",
|
3616
|
+
* "PlayFabId": "204883457"
|
3617
|
+
* });
|
2946
3618
|
*/
|
2947
3619
|
DeleteMembershipSubscription(request: DeleteMembershipSubscriptionRequest, extraHeaders?: Record<string, string>): Promise<DeleteMembershipSubscriptionResult>;
|
2948
3620
|
/**
|
2949
3621
|
* Removes a relationship between a title and an OpenID Connect provider.
|
2950
|
-
*
|
3622
|
+
*
|
3623
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteopenidconnection Microsoft Documentation}
|
3624
|
+
* @example
|
3625
|
+
* await adminClient.DeleteOpenIdConnection({
|
3626
|
+
* "ConnectionId": "oidconnection1"
|
3627
|
+
* });
|
2951
3628
|
*/
|
2952
3629
|
DeleteOpenIdConnection(request: DeleteOpenIdConnectionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2953
3630
|
/**
|
2954
3631
|
* Removes a user's player account from a title and deletes all associated data
|
2955
|
-
*
|
3632
|
+
*
|
3633
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deleteplayer Microsoft Documentation}
|
3634
|
+
* @example
|
3635
|
+
* await adminClient.DeletePlayer({
|
3636
|
+
* "PlayFabId": "A68C908B66C23C5"
|
3637
|
+
* });
|
2956
3638
|
*/
|
2957
3639
|
DeletePlayer(request: DeletePlayerRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerResult>;
|
2958
3640
|
/**
|
2959
3641
|
* Deletes title-specific custom properties for a player
|
2960
|
-
*
|
3642
|
+
*
|
3643
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/deleteplayercustomproperties Microsoft Documentation}
|
3644
|
+
* @example
|
3645
|
+
* await adminClient.DeletePlayerCustomProperties({
|
3646
|
+
* "PlayFabId": "2039475",
|
3647
|
+
* "PropertyNames": [
|
3648
|
+
* "level",
|
3649
|
+
* "created"
|
3650
|
+
* ],
|
3651
|
+
* "ExpectedPropertiesVersion": 12
|
3652
|
+
* });
|
2961
3653
|
*/
|
2962
3654
|
DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerCustomPropertiesResult>;
|
2963
3655
|
/**
|
2964
3656
|
* Deletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API
|
2965
3657
|
* returns.
|
2966
|
-
*
|
3658
|
+
*
|
3659
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteplayersharedsecret Microsoft Documentation}
|
3660
|
+
* @example
|
3661
|
+
* await adminClient.DeletePlayerSharedSecret({
|
3662
|
+
* "SecretKey": "keysaresecret"
|
3663
|
+
* });
|
2967
3664
|
*/
|
2968
3665
|
DeletePlayerSharedSecret(request: DeletePlayerSharedSecretRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerSharedSecretResult>;
|
2969
3666
|
/**
|
2970
3667
|
* Deletes an existing player segment and its associated action(s) for a title.
|
2971
|
-
*
|
3668
|
+
*
|
3669
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/segments/deletesegment Microsoft Documentation}
|
3670
|
+
* @example
|
3671
|
+
* await adminClient.DeleteSegment({
|
3672
|
+
* "SegmentId": "97EF0E9302CBE996"
|
3673
|
+
* });
|
2972
3674
|
*/
|
2973
3675
|
DeleteSegment(request: DeleteSegmentRequest, extraHeaders?: Record<string, string>): Promise<DeleteSegmentsResponse>;
|
2974
3676
|
/**
|
2975
3677
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
2976
3678
|
* version 2._ Deletes an existing virtual item store
|
2977
|
-
*
|
3679
|
+
*
|
3680
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletestore Microsoft Documentation}
|
3681
|
+
* @example
|
3682
|
+
* await adminClient.DeleteStore({
|
3683
|
+
* "StoreId": "BonusStore"
|
3684
|
+
* });
|
2978
3685
|
*/
|
2979
3686
|
DeleteStore(request: DeleteStoreRequest, extraHeaders?: Record<string, string>): Promise<DeleteStoreResult>;
|
2980
3687
|
/**
|
2981
3688
|
* Delete a task.
|
2982
|
-
*
|
3689
|
+
*
|
3690
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/deletetask Microsoft Documentation}
|
3691
|
+
* @example
|
3692
|
+
* await adminClient.DeleteTask({
|
3693
|
+
* "Identifier": {
|
3694
|
+
* "Id": "E1772FD927D8539D"
|
3695
|
+
* }
|
3696
|
+
* });
|
2983
3697
|
*/
|
2984
3698
|
DeleteTask(request: DeleteTaskRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2985
3699
|
/**
|
2986
3700
|
* Permanently deletes a title and all associated configuration
|
2987
|
-
*
|
3701
|
+
*
|
3702
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletetitle Microsoft Documentation}
|
3703
|
+
* @example
|
3704
|
+
* await adminClient.DeleteTitle({});
|
2988
3705
|
*/
|
2989
3706
|
DeleteTitle(request: DeleteTitleRequest, extraHeaders?: Record<string, string>): Promise<DeleteTitleResult>;
|
2990
3707
|
/**
|
2991
3708
|
* Deletes a specified set of title data overrides.
|
2992
|
-
*
|
3709
|
+
*
|
3710
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletetitledataoverride Microsoft Documentation}
|
3711
|
+
* @example
|
3712
|
+
* await adminClient.DeleteTitleDataOverride({
|
3713
|
+
* "OverrideLabel": "LaunchData"
|
3714
|
+
* });
|
2993
3715
|
*/
|
2994
3716
|
DeleteTitleDataOverride(request: DeleteTitleDataOverrideRequest, extraHeaders?: Record<string, string>): Promise<DeleteTitleDataOverrideResult>;
|
3717
|
+
/**
|
3718
|
+
* Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics. This method does not
|
3719
|
+
* remove the player's event history, login history, inventory items, nor virtual currencies.
|
3720
|
+
*
|
3721
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/deleteusers Microsoft Documentation}
|
3722
|
+
* @deprecated Please use DeletePlayer instead.
|
3723
|
+
*/
|
3724
|
+
DeleteUsers(request: DeleteUsersRequest, extraHeaders?: Record<string, string>): Promise<DeleteUsersResult>;
|
2995
3725
|
/**
|
2996
3726
|
* Exports all associated data of a master player account
|
2997
|
-
*
|
3727
|
+
*
|
3728
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/exportmasterplayerdata Microsoft Documentation}
|
3729
|
+
* @example
|
3730
|
+
* await adminClient.ExportMasterPlayerData({
|
3731
|
+
* "PlayFabId": "A68C908B66C23C5"
|
3732
|
+
* });
|
2998
3733
|
*/
|
2999
3734
|
ExportMasterPlayerData(request: ExportMasterPlayerDataRequest, extraHeaders?: Record<string, string>): Promise<ExportMasterPlayerDataResult>;
|
3000
3735
|
/**
|
3001
3736
|
* Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which
|
3002
3737
|
* match the segment definition at the time of the API call. Profiles which change while an export is in progress will not
|
3003
3738
|
* be reflected in the results.
|
3004
|
-
*
|
3739
|
+
*
|
3740
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/exportplayersinsegment Microsoft Documentation}
|
3741
|
+
* @example
|
3742
|
+
* await adminClient.ExportPlayersInSegment({
|
3743
|
+
* "SegmentId": "ABCDEF1234567890"
|
3744
|
+
* });
|
3005
3745
|
*/
|
3006
3746
|
ExportPlayersInSegment(request: ExportPlayersInSegmentRequest, extraHeaders?: Record<string, string>): Promise<ExportPlayersInSegmentResult>;
|
3007
3747
|
/**
|
3008
3748
|
* Get information about a ActionsOnPlayersInSegment task instance.
|
3009
|
-
*
|
3749
|
+
*
|
3750
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getactionsonplayersinsegmenttaskinstance Microsoft Documentation}
|
3751
|
+
* @example
|
3752
|
+
* await adminClient.GetActionsOnPlayersInSegmentTaskInstance({
|
3753
|
+
* "TaskInstanceId": "E52531B47B1761C7-4"
|
3754
|
+
* });
|
3010
3755
|
*/
|
3011
3756
|
GetActionsOnPlayersInSegmentTaskInstance(request: GetTaskInstanceRequest, extraHeaders?: Record<string, string>): Promise<GetActionsOnPlayersInSegmentTaskInstanceResult>;
|
3757
|
+
/**
|
3758
|
+
* Retrieve a list of all PlayStream actions groups.
|
3759
|
+
*
|
3760
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getallactiongroups Microsoft Documentation}
|
3761
|
+
* @deprecated Please use GetTasks instead.
|
3762
|
+
*/
|
3763
|
+
GetAllActionGroups(request: GetAllActionGroupsRequest, extraHeaders?: Record<string, string>): Promise<GetAllActionGroupsResult>;
|
3012
3764
|
/**
|
3013
3765
|
* Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as
|
3014
3766
|
* GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
|
3015
|
-
*
|
3767
|
+
*
|
3768
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getallsegments Microsoft Documentation}
|
3769
|
+
* @example
|
3770
|
+
* await adminClient.GetAllSegments({});
|
3016
3771
|
*/
|
3017
3772
|
GetAllSegments(request: GetAllSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetAllSegmentsResult>;
|
3018
3773
|
/**
|
3019
3774
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3020
3775
|
* version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
|
3021
|
-
*
|
3776
|
+
*
|
3777
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getcatalogitems Microsoft Documentation}
|
3778
|
+
* @example
|
3779
|
+
* await adminClient.GetCatalogItems({
|
3780
|
+
* "CatalogVersion": "1"
|
3781
|
+
* });
|
3022
3782
|
*/
|
3023
3783
|
GetCatalogItems(request: GetCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
|
3784
|
+
/**
|
3785
|
+
* Get detail information about a CloudScript Azure Functions task instance.
|
3786
|
+
*
|
3787
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getcloudscriptazurefunctionstaskinstance Microsoft Documentation}
|
3788
|
+
* @example
|
3789
|
+
* await adminClient.GetCloudScriptAzureFunctionsTaskInstance({
|
3790
|
+
* "TaskInstanceId": "E52531B47B1761C7-4"
|
3791
|
+
* });
|
3792
|
+
*/
|
3793
|
+
GetCloudScriptAzureFunctionsTaskInstance(request: GetTaskInstanceRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptAzureFunctionsTaskInstanceResult>;
|
3024
3794
|
/**
|
3025
3795
|
* Gets the contents and information of a specific Cloud Script revision.
|
3026
|
-
*
|
3796
|
+
*
|
3797
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptrevision Microsoft Documentation}
|
3798
|
+
* @example
|
3799
|
+
* await adminClient.GetCloudScriptRevision({
|
3800
|
+
* "Version": 1,
|
3801
|
+
* "Revision": 3
|
3802
|
+
* });
|
3027
3803
|
*/
|
3028
3804
|
GetCloudScriptRevision(request: GetCloudScriptRevisionRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptRevisionResult>;
|
3029
3805
|
/**
|
3030
3806
|
* Get detail information about a CloudScript task instance.
|
3031
|
-
*
|
3807
|
+
*
|
3808
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getcloudscripttaskinstance Microsoft Documentation}
|
3809
|
+
* @example
|
3810
|
+
* await adminClient.GetCloudScriptTaskInstance({
|
3811
|
+
* "TaskInstanceId": "E52531B47B1761C7-4"
|
3812
|
+
* });
|
3032
3813
|
*/
|
3033
3814
|
GetCloudScriptTaskInstance(request: GetTaskInstanceRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptTaskInstanceResult>;
|
3034
3815
|
/**
|
3035
3816
|
* Lists all the current cloud script versions. For each version, information about the current published and latest
|
3036
3817
|
* revisions is also listed.
|
3037
|
-
*
|
3818
|
+
*
|
3819
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptversions Microsoft Documentation}
|
3820
|
+
* @example
|
3821
|
+
* await adminClient.GetCloudScriptVersions({});
|
3038
3822
|
*/
|
3039
3823
|
GetCloudScriptVersions(request: GetCloudScriptVersionsRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptVersionsResult>;
|
3040
3824
|
/**
|
3041
3825
|
* List all contents of the title and get statistics such as size
|
3042
|
-
*
|
3826
|
+
*
|
3827
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentlist Microsoft Documentation}
|
3828
|
+
* @example
|
3829
|
+
* await adminClient.GetContentList({
|
3830
|
+
* "Prefix": "2016/1"
|
3831
|
+
* });
|
3043
3832
|
*/
|
3044
3833
|
GetContentList(request: GetContentListRequest, extraHeaders?: Record<string, string>): Promise<GetContentListResult>;
|
3045
3834
|
/**
|
3046
3835
|
* Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the
|
3047
3836
|
* content. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN
|
3048
3837
|
* rates apply.
|
3049
|
-
*
|
3838
|
+
*
|
3839
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentuploadurl Microsoft Documentation}
|
3840
|
+
* @example
|
3841
|
+
* await adminClient.GetContentUploadUrl({
|
3842
|
+
* "Key": "images/sword_icon.png",
|
3843
|
+
* "ContentType": "image/png"
|
3844
|
+
* });
|
3050
3845
|
*/
|
3051
3846
|
GetContentUploadUrl(request: GetContentUploadUrlRequest, extraHeaders?: Record<string, string>): Promise<GetContentUploadUrlResult>;
|
3052
3847
|
/**
|
3053
3848
|
* Retrieves a download URL for the requested report
|
3054
|
-
*
|
3849
|
+
*
|
3850
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getdatareport Microsoft Documentation}
|
3851
|
+
* @example
|
3852
|
+
* await adminClient.GetDataReport({
|
3853
|
+
* "ReportName": "PurchaseDataReport",
|
3854
|
+
* "Year": 2014,
|
3855
|
+
* "Month": 12,
|
3856
|
+
* "Day": 5
|
3857
|
+
* });
|
3055
3858
|
*/
|
3056
3859
|
GetDataReport(request: GetDataReportRequest, extraHeaders?: Record<string, string>): Promise<GetDataReportResult>;
|
3860
|
+
/**
|
3861
|
+
* Retrieves the set of sinks to which to route PlayStream and Telemetry event data.
|
3862
|
+
*
|
3863
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/geteventsinks Microsoft Documentation}
|
3864
|
+
* @example
|
3865
|
+
* await adminClient.GetEventSinks({});
|
3866
|
+
*/
|
3867
|
+
GetEventSinks(request: GetEventSinksRequest, extraHeaders?: Record<string, string>): Promise<GetEventSinksResult>;
|
3868
|
+
/**
|
3869
|
+
* Retrieves the details for a specific completed session, including links to standard out and standard error logs
|
3870
|
+
*
|
3871
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/matchmaking/getmatchmakergameinfo Microsoft Documentation}
|
3872
|
+
* @deprecated Please use MultiplayerServer/GetMultiplayerSessionLogsBySessionId instead.
|
3873
|
+
*/
|
3874
|
+
GetMatchmakerGameInfo(request: GetMatchmakerGameInfoRequest, extraHeaders?: Record<string, string>): Promise<GetMatchmakerGameInfoResult>;
|
3875
|
+
/**
|
3876
|
+
* Retrieves the details of defined game modes for the specified game server executable
|
3877
|
+
*
|
3878
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/matchmaking/getmatchmakergamemodes Microsoft Documentation}
|
3879
|
+
* @deprecated Do not use
|
3880
|
+
*/
|
3881
|
+
GetMatchmakerGameModes(request: GetMatchmakerGameModesRequest, extraHeaders?: Record<string, string>): Promise<GetMatchmakerGameModesResult>;
|
3057
3882
|
/**
|
3058
3883
|
* Get the list of titles that the player has played
|
3059
|
-
*
|
3884
|
+
*
|
3885
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayedtitlelist Microsoft Documentation}
|
3886
|
+
* @example
|
3887
|
+
* await adminClient.GetPlayedTitleList({
|
3888
|
+
* "PlayFabId": "A68C908B66C23C5"
|
3889
|
+
* });
|
3060
3890
|
*/
|
3061
3891
|
GetPlayedTitleList(request: GetPlayedTitleListRequest, extraHeaders?: Record<string, string>): Promise<GetPlayedTitleListResult>;
|
3062
3892
|
/**
|
3063
3893
|
* Retrieves a title-specific custom property value for a player.
|
3064
|
-
*
|
3894
|
+
*
|
3895
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayercustomproperty Microsoft Documentation}
|
3896
|
+
* @example
|
3897
|
+
* await adminClient.GetPlayerCustomProperty({
|
3898
|
+
* "PlayFabId": "2039475",
|
3899
|
+
* "PropertyName": "level"
|
3900
|
+
* });
|
3065
3901
|
*/
|
3066
3902
|
GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
|
3067
3903
|
/**
|
3068
3904
|
* Gets a player's ID from an auth token.
|
3069
|
-
*
|
3905
|
+
*
|
3906
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayeridfromauthtoken Microsoft Documentation}
|
3907
|
+
* @example
|
3908
|
+
* await adminClient.GetPlayerIdFromAuthToken({
|
3909
|
+
* "Token": "3F584AD0EF943E2",
|
3910
|
+
* "TokenType": "Email"
|
3911
|
+
* });
|
3070
3912
|
*/
|
3071
3913
|
GetPlayerIdFromAuthToken(request: GetPlayerIdFromAuthTokenRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerIdFromAuthTokenResult>;
|
3072
3914
|
/**
|
3073
3915
|
* Retrieves the player's profile
|
3074
|
-
*
|
3916
|
+
*
|
3917
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayerprofile Microsoft Documentation}
|
3918
|
+
* @example
|
3919
|
+
* await adminClient.GetPlayerProfile({
|
3920
|
+
* "PlayFabId": "621EF20237534A44"
|
3921
|
+
* });
|
3075
3922
|
*/
|
3076
3923
|
GetPlayerProfile(request: GetPlayerProfileRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerProfileResult>;
|
3077
3924
|
/**
|
3078
3925
|
* List all segments that a player currently belongs to at this moment in time.
|
3079
|
-
*
|
3926
|
+
*
|
3927
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersegments Microsoft Documentation}
|
3928
|
+
* @example
|
3929
|
+
* await adminClient.GetPlayerSegments({
|
3930
|
+
* "PlayFabId": "1337AA00"
|
3931
|
+
* });
|
3080
3932
|
*/
|
3081
3933
|
GetPlayerSegments(request: GetPlayersSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
|
3082
3934
|
/**
|
3083
3935
|
* Returns all Player Shared Secret Keys including disabled and expired.
|
3084
|
-
*
|
3936
|
+
*
|
3937
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/getplayersharedsecrets Microsoft Documentation}
|
3938
|
+
* @example
|
3939
|
+
* await adminClient.GetPlayerSharedSecrets({});
|
3085
3940
|
*/
|
3086
3941
|
GetPlayerSharedSecrets(request: GetPlayerSharedSecretsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSharedSecretsResult>;
|
3087
3942
|
/**
|
@@ -3090,39 +3945,76 @@ declare class PlayFabAdminApi extends PlayFabCommon {
|
|
3090
3945
|
* on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected
|
3091
3946
|
* in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being
|
3092
3947
|
* called 30 times in one minute. You will be returned an error if you exceed this threshold.
|
3093
|
-
*
|
3948
|
+
*
|
3949
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersinsegment Microsoft Documentation}
|
3950
|
+
* @example
|
3951
|
+
* await adminClient.GetPlayersInSegment({
|
3952
|
+
* "SegmentId": "1337AA00",
|
3953
|
+
* "SecondsToLive": 5,
|
3954
|
+
* "MaxBatchSize": 500
|
3955
|
+
* });
|
3094
3956
|
*/
|
3095
3957
|
GetPlayersInSegment(request: GetPlayersInSegmentRequest, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentResult>;
|
3096
3958
|
/**
|
3097
3959
|
* Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have
|
3098
3960
|
* a reset interval.
|
3099
|
-
*
|
3961
|
+
*
|
3962
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticdefinitions Microsoft Documentation}
|
3963
|
+
* @example
|
3964
|
+
* await adminClient.GetPlayerStatisticDefinitions({});
|
3100
3965
|
*/
|
3101
3966
|
GetPlayerStatisticDefinitions(request: GetPlayerStatisticDefinitionsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticDefinitionsResult>;
|
3102
3967
|
/**
|
3103
3968
|
* Retrieves the information on the available versions of the specified statistic.
|
3104
|
-
*
|
3969
|
+
*
|
3970
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticversions Microsoft Documentation}
|
3971
|
+
* @example
|
3972
|
+
* await adminClient.GetPlayerStatisticVersions({
|
3973
|
+
* "StatisticName": "headshots"
|
3974
|
+
* });
|
3105
3975
|
*/
|
3106
3976
|
GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticVersionsResult>;
|
3107
3977
|
/**
|
3108
3978
|
* Get all tags with a given Namespace (optional) from a player profile.
|
3109
|
-
*
|
3979
|
+
*
|
3980
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayertags Microsoft Documentation}
|
3981
|
+
* @example
|
3982
|
+
* await adminClient.GetPlayerTags({
|
3983
|
+
* "PlayFabId": "10931252888739651331",
|
3984
|
+
* "Namespace": "title.AAA"
|
3985
|
+
* });
|
3110
3986
|
*/
|
3111
3987
|
GetPlayerTags(request: GetPlayerTagsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
|
3112
3988
|
/**
|
3113
3989
|
* Gets the requested policy.
|
3114
|
-
*
|
3990
|
+
*
|
3991
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/getpolicy Microsoft Documentation}
|
3992
|
+
* @example
|
3993
|
+
* await adminClient.GetPolicy({
|
3994
|
+
* "PolicyName": "ApiPolicy"
|
3995
|
+
* });
|
3115
3996
|
*/
|
3116
3997
|
GetPolicy(request: GetPolicyRequest, extraHeaders?: Record<string, string>): Promise<GetPolicyResponse>;
|
3117
3998
|
/**
|
3118
3999
|
* Retrieves the key-value store of custom publisher settings
|
3119
|
-
*
|
4000
|
+
*
|
4001
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getpublisherdata Microsoft Documentation}
|
4002
|
+
* @example
|
4003
|
+
* await adminClient.GetPublisherData({
|
4004
|
+
* "Keys": [
|
4005
|
+
* "color",
|
4006
|
+
* "propertyA"
|
4007
|
+
* ]
|
4008
|
+
* });
|
3120
4009
|
*/
|
3121
4010
|
GetPublisherData(request: GetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<GetPublisherDataResult>;
|
3122
4011
|
/**
|
3123
4012
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3124
4013
|
* version 2._ Retrieves the random drop table configuration for the title
|
3125
|
-
*
|
4014
|
+
*
|
4015
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getrandomresulttables Microsoft Documentation}
|
4016
|
+
* @example
|
4017
|
+
* await adminClient.GetRandomResultTables({});
|
3126
4018
|
*/
|
3127
4019
|
GetRandomResultTables(request: GetRandomResultTablesRequest, extraHeaders?: Record<string, string>): Promise<GetRandomResultTablesResult>;
|
3128
4020
|
/**
|
@@ -3130,221 +4022,895 @@ declare class PlayFabAdminApi extends PlayFabCommon {
|
|
3130
4022
|
* complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls
|
3131
4023
|
* from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of
|
3132
4024
|
* the export
|
3133
|
-
*
|
4025
|
+
*
|
4026
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getsegmentexport Microsoft Documentation}
|
4027
|
+
* @example
|
4028
|
+
* await adminClient.GetSegmentExport({
|
4029
|
+
* "ExportId": "ABCDEF1234567890"
|
4030
|
+
* });
|
3134
4031
|
*/
|
3135
4032
|
GetSegmentExport(request: GetPlayersInSegmentExportRequest, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentExportResponse>;
|
3136
4033
|
/**
|
3137
4034
|
* Get detail information of a segment and its associated definition(s) and action(s) for a title.
|
3138
|
-
*
|
4035
|
+
*
|
4036
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/segments/getsegments Microsoft Documentation}
|
4037
|
+
* @example
|
4038
|
+
* await adminClient.GetSegments({
|
4039
|
+
* "SegmentIds": [
|
4040
|
+
* "B05FC8CB558A6570",
|
4041
|
+
* "97EF0E9302CBE996"
|
4042
|
+
* ]
|
4043
|
+
* });
|
3139
4044
|
*/
|
3140
4045
|
GetSegments(request: GetSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetSegmentsResponse>;
|
4046
|
+
/**
|
4047
|
+
* Retrieves the build details for the specified game server executable
|
4048
|
+
*
|
4049
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/getserverbuildinfo Microsoft Documentation}
|
4050
|
+
* @deprecated Do not use
|
4051
|
+
*/
|
4052
|
+
GetServerBuildInfo(request: GetServerBuildInfoRequest, extraHeaders?: Record<string, string>): Promise<GetServerBuildInfoResult>;
|
3141
4053
|
/**
|
3142
4054
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3143
4055
|
* version 2._ Retrieves the set of items defined for the specified store, including all prices defined
|
3144
|
-
*
|
4056
|
+
*
|
4057
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getstoreitems Microsoft Documentation}
|
4058
|
+
* @example
|
4059
|
+
* await adminClient.GetStoreItems({
|
4060
|
+
* "StoreId": "BonusStore"
|
4061
|
+
* });
|
3145
4062
|
*/
|
3146
4063
|
GetStoreItems(request: GetStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
|
3147
4064
|
/**
|
3148
4065
|
* Query for task instances by task, status, or time range.
|
3149
|
-
*
|
4066
|
+
*
|
4067
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettaskinstances Microsoft Documentation}
|
4068
|
+
* @example
|
4069
|
+
* await adminClient.GetTaskInstances({
|
4070
|
+
* "StatusFilter": "Failed",
|
4071
|
+
* "StartedAtRangeFrom": "2016-08-23T11:00:00Z"
|
4072
|
+
* });
|
3150
4073
|
*/
|
3151
4074
|
GetTaskInstances(request: GetTaskInstancesRequest, extraHeaders?: Record<string, string>): Promise<GetTaskInstancesResult>;
|
3152
4075
|
/**
|
3153
4076
|
* Get definition information on a specified task or all tasks within a title.
|
3154
|
-
*
|
4077
|
+
*
|
4078
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettasks Microsoft Documentation}
|
4079
|
+
* @example
|
4080
|
+
* await adminClient.GetTasks({
|
4081
|
+
* "Identifier": {
|
4082
|
+
* "Name": "EnableDailyHappyHour"
|
4083
|
+
* }
|
4084
|
+
* });
|
3155
4085
|
*/
|
3156
4086
|
GetTasks(request: GetTasksRequest, extraHeaders?: Record<string, string>): Promise<GetTasksResult>;
|
3157
4087
|
/**
|
3158
4088
|
* Retrieves the key-value store of custom title settings which can be read by the client
|
3159
|
-
*
|
4089
|
+
*
|
4090
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitledata Microsoft Documentation}
|
4091
|
+
* @example
|
4092
|
+
* await adminClient.GetTitleData({
|
4093
|
+
* "Keys": [
|
4094
|
+
* "color",
|
4095
|
+
* "propertyA"
|
4096
|
+
* ]
|
4097
|
+
* });
|
3160
4098
|
*/
|
3161
4099
|
GetTitleData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
|
3162
4100
|
/**
|
3163
4101
|
* Retrieves the key-value store of custom title settings which cannot be read by the client
|
3164
|
-
*
|
4102
|
+
*
|
4103
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitleinternaldata Microsoft Documentation}
|
4104
|
+
* @example
|
4105
|
+
* await adminClient.GetTitleInternalData({
|
4106
|
+
* "Keys": [
|
4107
|
+
* "color",
|
4108
|
+
* "propertyA"
|
4109
|
+
* ]
|
4110
|
+
* });
|
3165
4111
|
*/
|
3166
4112
|
GetTitleInternalData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
|
3167
4113
|
/**
|
3168
4114
|
* Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier
|
3169
|
-
*
|
4115
|
+
*
|
4116
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuseraccountinfo Microsoft Documentation}
|
4117
|
+
* @example
|
4118
|
+
* await adminClient.GetUserAccountInfo({
|
4119
|
+
* "PlayFabId": "293753934",
|
4120
|
+
* "IgnoreMissingTitleActivation": false
|
4121
|
+
* });
|
3170
4122
|
*/
|
3171
4123
|
GetUserAccountInfo(request: LookupUserAccountInfoRequest, extraHeaders?: Record<string, string>): Promise<LookupUserAccountInfoResult>;
|
3172
4124
|
/**
|
3173
4125
|
* Gets all bans for a user.
|
3174
|
-
*
|
4126
|
+
*
|
4127
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuserbans Microsoft Documentation}
|
4128
|
+
* @example
|
4129
|
+
* await adminClient.GetUserBans({
|
4130
|
+
* "PlayFabId": "1679AF5CD04BD838"
|
4131
|
+
* });
|
3175
4132
|
*/
|
3176
4133
|
GetUserBans(request: GetUserBansRequest, extraHeaders?: Record<string, string>): Promise<GetUserBansResult>;
|
3177
4134
|
/**
|
3178
4135
|
* Retrieves the title-specific custom data for the user which is readable and writable by the client
|
3179
|
-
*
|
4136
|
+
*
|
4137
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserdata Microsoft Documentation}
|
4138
|
+
* @example
|
4139
|
+
* await adminClient.GetUserData({
|
4140
|
+
* "PlayFabId": "2039475",
|
4141
|
+
* "Keys": [
|
4142
|
+
* "preferences",
|
4143
|
+
* "progress"
|
4144
|
+
* ],
|
4145
|
+
* "IfChangedFromDataVersion": 13
|
4146
|
+
* });
|
3180
4147
|
*/
|
3181
4148
|
GetUserData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3182
4149
|
/**
|
3183
4150
|
* Retrieves the title-specific custom data for the user which cannot be accessed by the client
|
3184
|
-
*
|
4151
|
+
*
|
4152
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserinternaldata Microsoft Documentation}
|
4153
|
+
* @example
|
4154
|
+
* await adminClient.GetUserInternalData({
|
4155
|
+
* "PlayFabId": "2039475",
|
4156
|
+
* "Keys": [
|
4157
|
+
* "preferences",
|
4158
|
+
* "progress"
|
4159
|
+
* ],
|
4160
|
+
* "IfChangedFromDataVersion": 13
|
4161
|
+
* });
|
3185
4162
|
*/
|
3186
4163
|
GetUserInternalData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3187
4164
|
/**
|
3188
4165
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3189
4166
|
* version 2._ Retrieves the specified user's current inventory of virtual goods
|
3190
|
-
*
|
4167
|
+
*
|
4168
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/getuserinventory Microsoft Documentation}
|
4169
|
+
* @example
|
4170
|
+
* await adminClient.GetUserInventory({
|
4171
|
+
* "PlayFabId": "204883457"
|
4172
|
+
* });
|
3191
4173
|
*/
|
3192
4174
|
GetUserInventory(request: GetUserInventoryRequest, extraHeaders?: Record<string, string>): Promise<GetUserInventoryResult>;
|
3193
4175
|
/**
|
3194
4176
|
* Retrieves the publisher-specific custom data for the user which is readable and writable by the client
|
3195
|
-
*
|
4177
|
+
*
|
4178
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherdata Microsoft Documentation}
|
4179
|
+
* @example
|
4180
|
+
* await adminClient.GetUserPublisherData({
|
4181
|
+
* "PlayFabId": "2039475",
|
4182
|
+
* "Keys": [
|
4183
|
+
* "preferences",
|
4184
|
+
* "progress"
|
4185
|
+
* ],
|
4186
|
+
* "IfChangedFromDataVersion": 13
|
4187
|
+
* });
|
3196
4188
|
*/
|
3197
4189
|
GetUserPublisherData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3198
4190
|
/**
|
3199
4191
|
* Retrieves the publisher-specific custom data for the user which cannot be accessed by the client
|
3200
|
-
*
|
4192
|
+
*
|
4193
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherinternaldata Microsoft Documentation}
|
4194
|
+
* @example
|
4195
|
+
* await adminClient.GetUserPublisherInternalData({
|
4196
|
+
* "PlayFabId": "2039475",
|
4197
|
+
* "Keys": [
|
4198
|
+
* "preferences",
|
4199
|
+
* "progress"
|
4200
|
+
* ],
|
4201
|
+
* "IfChangedFromDataVersion": 13
|
4202
|
+
* });
|
3201
4203
|
*/
|
3202
4204
|
GetUserPublisherInternalData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3203
4205
|
/**
|
3204
4206
|
* Retrieves the publisher-specific custom data for the user which can only be read by the client
|
3205
|
-
*
|
4207
|
+
*
|
4208
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherreadonlydata Microsoft Documentation}
|
4209
|
+
* @example
|
4210
|
+
* await adminClient.GetUserPublisherReadOnlyData({
|
4211
|
+
* "PlayFabId": "2039475",
|
4212
|
+
* "Keys": [
|
4213
|
+
* "preferences",
|
4214
|
+
* "progress"
|
4215
|
+
* ],
|
4216
|
+
* "IfChangedFromDataVersion": 13
|
4217
|
+
* });
|
3206
4218
|
*/
|
3207
4219
|
GetUserPublisherReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3208
4220
|
/**
|
3209
4221
|
* Retrieves the title-specific custom data for the user which can only be read by the client
|
3210
|
-
*
|
4222
|
+
*
|
4223
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserreadonlydata Microsoft Documentation}
|
4224
|
+
* @example
|
4225
|
+
* await adminClient.GetUserReadOnlyData({
|
4226
|
+
* "PlayFabId": "2039475",
|
4227
|
+
* "Keys": [
|
4228
|
+
* "preferences",
|
4229
|
+
* "progress"
|
4230
|
+
* ],
|
4231
|
+
* "IfChangedFromDataVersion": 13
|
4232
|
+
* });
|
3211
4233
|
*/
|
3212
4234
|
GetUserReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3213
4235
|
/**
|
3214
4236
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3215
4237
|
* version 2._ Adds the specified items to the specified user inventories
|
3216
|
-
*
|
4238
|
+
*
|
4239
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/grantitemstousers Microsoft Documentation}
|
4240
|
+
* @example
|
4241
|
+
* await adminClient.GrantItemsToUsers({
|
4242
|
+
* "CatalogVersion": "5",
|
4243
|
+
* "ItemGrants": [
|
4244
|
+
* {
|
4245
|
+
* "PlayFabId": "20394883",
|
4246
|
+
* "ItemId": "shield_level_1",
|
4247
|
+
* "Annotation": "Entered Level 2"
|
4248
|
+
* },
|
4249
|
+
* {
|
4250
|
+
* "PlayFabId": "20394883",
|
4251
|
+
* "ItemId": "shield_level_2",
|
4252
|
+
* "Annotation": "Entered Level 2",
|
4253
|
+
* "Data": {
|
4254
|
+
* "Equipped": "True",
|
4255
|
+
* "Slot": "Head"
|
4256
|
+
* }
|
4257
|
+
* }
|
4258
|
+
* ]
|
4259
|
+
* });
|
3217
4260
|
*/
|
3218
4261
|
GrantItemsToUsers(request: GrantItemsToUsersRequest, extraHeaders?: Record<string, string>): Promise<GrantItemsToUsersResult>;
|
3219
4262
|
/**
|
3220
4263
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3221
4264
|
* version 2._ Increases the global count for the given scarce resource.
|
3222
|
-
*
|
4265
|
+
*
|
4266
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/incrementlimitededitionitemavailability Microsoft Documentation}
|
4267
|
+
* @example
|
4268
|
+
* await adminClient.IncrementLimitedEditionItemAvailability({
|
4269
|
+
* "CatalogVersion": "Rares",
|
4270
|
+
* "ItemId": "FreeHoodie",
|
4271
|
+
* "Amount": 50
|
4272
|
+
* });
|
3223
4273
|
*/
|
3224
4274
|
IncrementLimitedEditionItemAvailability(request: IncrementLimitedEditionItemAvailabilityRequest, extraHeaders?: Record<string, string>): Promise<IncrementLimitedEditionItemAvailabilityResult>;
|
3225
4275
|
/**
|
3226
4276
|
* Resets the indicated statistic, removing all player entries for it and backing up the old values.
|
3227
|
-
*
|
4277
|
+
*
|
4278
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/incrementplayerstatisticversion Microsoft Documentation}
|
4279
|
+
* @example
|
4280
|
+
* await adminClient.IncrementPlayerStatisticVersion({
|
4281
|
+
* "StatisticName": "headshots"
|
4282
|
+
* });
|
3228
4283
|
*/
|
3229
4284
|
IncrementPlayerStatisticVersion(request: IncrementPlayerStatisticVersionRequest, extraHeaders?: Record<string, string>): Promise<IncrementPlayerStatisticVersionResult>;
|
3230
4285
|
/**
|
3231
4286
|
* Retrieves a list of all Open ID Connect providers registered to a title.
|
3232
|
-
*
|
4287
|
+
*
|
4288
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/listopenidconnection Microsoft Documentation}
|
4289
|
+
* @example
|
4290
|
+
* await adminClient.ListOpenIdConnection({});
|
3233
4291
|
*/
|
3234
4292
|
ListOpenIdConnection(request: ListOpenIdConnectionRequest, extraHeaders?: Record<string, string>): Promise<ListOpenIdConnectionResponse>;
|
3235
4293
|
/**
|
3236
4294
|
* Retrieves title-specific custom property values for a player.
|
3237
|
-
*
|
4295
|
+
*
|
4296
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/listplayercustomproperties Microsoft Documentation}
|
4297
|
+
* @example
|
4298
|
+
* await adminClient.ListPlayerCustomProperties({
|
4299
|
+
* "PlayFabId": "2039475"
|
4300
|
+
* });
|
3238
4301
|
*/
|
3239
4302
|
ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
|
4303
|
+
/**
|
4304
|
+
* Retrieves the build details for all game server executables which are currently defined for the title
|
4305
|
+
*
|
4306
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/listserverbuilds Microsoft Documentation}
|
4307
|
+
* @deprecated Do not use
|
4308
|
+
*/
|
4309
|
+
ListServerBuilds(request: ListBuildsRequest, extraHeaders?: Record<string, string>): Promise<ListBuildsResult>;
|
3240
4310
|
/**
|
3241
4311
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3242
4312
|
* version 2._ Retuns the list of all defined virtual currencies for the title
|
3243
|
-
*
|
4313
|
+
*
|
4314
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/listvirtualcurrencytypes Microsoft Documentation}
|
4315
|
+
* @example
|
4316
|
+
* await adminClient.ListVirtualCurrencyTypes({});
|
3244
4317
|
*/
|
3245
4318
|
ListVirtualCurrencyTypes(request: ListVirtualCurrencyTypesRequest, extraHeaders?: Record<string, string>): Promise<ListVirtualCurrencyTypesResult>;
|
4319
|
+
/**
|
4320
|
+
* Updates the game server mode details for the specified game server executable
|
4321
|
+
*
|
4322
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/matchmaking/modifymatchmakergamemodes Microsoft Documentation}
|
4323
|
+
* @deprecated Do not use
|
4324
|
+
*/
|
4325
|
+
ModifyMatchmakerGameModes(request: ModifyMatchmakerGameModesRequest, extraHeaders?: Record<string, string>): Promise<ModifyMatchmakerGameModesResult>;
|
4326
|
+
/**
|
4327
|
+
* Updates the build details for the specified game server executable
|
4328
|
+
*
|
4329
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/modifyserverbuild Microsoft Documentation}
|
4330
|
+
* @deprecated Do not use
|
4331
|
+
*/
|
4332
|
+
ModifyServerBuild(request: ModifyServerBuildRequest, extraHeaders?: Record<string, string>): Promise<ModifyServerBuildResult>;
|
3246
4333
|
/**
|
3247
4334
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3248
4335
|
* version 2._ Attempts to process an order refund through the original real money payment provider.
|
3249
|
-
*
|
4336
|
+
*
|
4337
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/refundpurchase Microsoft Documentation}
|
4338
|
+
* @example
|
4339
|
+
* await adminClient.RefundPurchase({
|
4340
|
+
* "PlayFabId": "20394883",
|
4341
|
+
* "OrderId": "B456AE0",
|
4342
|
+
* "Reason": "Customer Request"
|
4343
|
+
* });
|
3250
4344
|
*/
|
3251
4345
|
RefundPurchase(request: RefundPurchaseRequest, extraHeaders?: Record<string, string>): Promise<RefundPurchaseResponse>;
|
3252
4346
|
/**
|
3253
4347
|
* Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
|
3254
|
-
*
|
4348
|
+
*
|
4349
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/removeplayertag Microsoft Documentation}
|
4350
|
+
* @example
|
4351
|
+
* await adminClient.RemovePlayerTag({
|
4352
|
+
* "PlayFabId": "10931252888739651331",
|
4353
|
+
* "TagName": "MostKilled"
|
4354
|
+
* });
|
3255
4355
|
*/
|
3256
4356
|
RemovePlayerTag(request: RemovePlayerTagRequest, extraHeaders?: Record<string, string>): Promise<RemovePlayerTagResult>;
|
4357
|
+
/**
|
4358
|
+
* Removes the game server executable specified from the set of those a client is permitted to request in a call to
|
4359
|
+
* StartGame
|
4360
|
+
*
|
4361
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/removeserverbuild Microsoft Documentation}
|
4362
|
+
* @deprecated Do not use
|
4363
|
+
*/
|
4364
|
+
RemoveServerBuild(request: RemoveServerBuildRequest, extraHeaders?: Record<string, string>): Promise<RemoveServerBuildResult>;
|
3257
4365
|
/**
|
3258
4366
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3259
4367
|
* version 2._ Removes one or more virtual currencies from the set defined for the title.
|
3260
|
-
*
|
4368
|
+
*
|
4369
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/removevirtualcurrencytypes Microsoft Documentation}
|
4370
|
+
* @example
|
4371
|
+
* await adminClient.RemoveVirtualCurrencyTypes({
|
4372
|
+
* "VirtualCurrencies": [
|
4373
|
+
* {
|
4374
|
+
* "CurrencyCode": "CC"
|
4375
|
+
* },
|
4376
|
+
* {
|
4377
|
+
* "CurrencyCode": "GC"
|
4378
|
+
* }
|
4379
|
+
* ]
|
4380
|
+
* });
|
3261
4381
|
*/
|
3262
4382
|
RemoveVirtualCurrencyTypes(request: RemoveVirtualCurrencyTypesRequest, extraHeaders?: Record<string, string>): Promise<BlankResult>;
|
3263
4383
|
/**
|
3264
4384
|
* Completely removes all statistics for the specified character, for the current game
|
3265
|
-
*
|
4385
|
+
*
|
4386
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/characters/resetcharacterstatistics Microsoft Documentation}
|
4387
|
+
* @example
|
4388
|
+
* await adminClient.ResetCharacterStatistics({
|
4389
|
+
* "PlayFabId": "293753934",
|
4390
|
+
* "CharacterId": "7654321"
|
4391
|
+
* });
|
3266
4392
|
*/
|
3267
4393
|
ResetCharacterStatistics(request: ResetCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<ResetCharacterStatisticsResult>;
|
3268
4394
|
/**
|
3269
4395
|
* Reset a player's password for a given title.
|
3270
|
-
*
|
4396
|
+
*
|
4397
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/resetpassword Microsoft Documentation}
|
4398
|
+
* @example
|
4399
|
+
* await adminClient.ResetPassword({
|
4400
|
+
* "Token": "2B584FA1DF645E4",
|
4401
|
+
* "Password": "ExampleSecret@r"
|
4402
|
+
* });
|
3271
4403
|
*/
|
3272
4404
|
ResetPassword(request: ResetPasswordRequest, extraHeaders?: Record<string, string>): Promise<ResetPasswordResult>;
|
4405
|
+
/**
|
4406
|
+
* Resets all title-specific information about a particular account, including user data, virtual currency balances,
|
4407
|
+
* inventory, purchase history, and statistics
|
4408
|
+
*
|
4409
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/resetusers Microsoft Documentation}
|
4410
|
+
* @deprecated Please use DeletePlayer instead.
|
4411
|
+
*/
|
4412
|
+
ResetUsers(request: ResetUsersRequest, extraHeaders?: Record<string, string>): Promise<BlankResult>;
|
3273
4413
|
/**
|
3274
4414
|
* Completely removes all statistics for the specified user, for the current game
|
3275
|
-
*
|
4415
|
+
*
|
4416
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resetuserstatistics Microsoft Documentation}
|
4417
|
+
* @example
|
4418
|
+
* await adminClient.ResetUserStatistics({
|
4419
|
+
* "PlayFabId": "293753934"
|
4420
|
+
* });
|
3276
4421
|
*/
|
3277
4422
|
ResetUserStatistics(request: ResetUserStatisticsRequest, extraHeaders?: Record<string, string>): Promise<ResetUserStatisticsResult>;
|
3278
4423
|
/**
|
3279
4424
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3280
4425
|
* version 2._ Attempts to resolve a dispute with the original order's payment provider.
|
3281
|
-
*
|
4426
|
+
*
|
4427
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resolvepurchasedispute Microsoft Documentation}
|
4428
|
+
* @example
|
4429
|
+
* await adminClient.ResolvePurchaseDispute({
|
4430
|
+
* "PlayFabId": "20394883",
|
4431
|
+
* "OrderId": "B456AE0",
|
4432
|
+
* "Reason": "Customer Request",
|
4433
|
+
* "Outcome": "Reinstate"
|
4434
|
+
* });
|
3282
4435
|
*/
|
3283
4436
|
ResolvePurchaseDispute(request: ResolvePurchaseDisputeRequest, extraHeaders?: Record<string, string>): Promise<ResolvePurchaseDisputeResponse>;
|
3284
4437
|
/**
|
3285
4438
|
* Revoke all active bans for a user.
|
3286
|
-
*
|
4439
|
+
*
|
4440
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokeallbansforuser Microsoft Documentation}
|
4441
|
+
* @example
|
4442
|
+
* await adminClient.RevokeAllBansForUser({
|
4443
|
+
* "PlayFabId": "1679AF5CD04BD838"
|
4444
|
+
* });
|
3287
4445
|
*/
|
3288
4446
|
RevokeAllBansForUser(request: RevokeAllBansForUserRequest, extraHeaders?: Record<string, string>): Promise<RevokeAllBansForUserResult>;
|
3289
4447
|
/**
|
3290
4448
|
* Revoke all active bans specified with BanId.
|
3291
|
-
*
|
4449
|
+
*
|
4450
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokebans Microsoft Documentation}
|
4451
|
+
* @example
|
4452
|
+
* await adminClient.RevokeBans({
|
4453
|
+
* "BanIds": [
|
4454
|
+
* "E0B5FF89542D413C",
|
4455
|
+
* "EF43FF89542G1546"
|
4456
|
+
* ]
|
4457
|
+
* });
|
3292
4458
|
*/
|
3293
4459
|
RevokeBans(request: RevokeBansRequest, extraHeaders?: Record<string, string>): Promise<RevokeBansResult>;
|
3294
4460
|
/**
|
3295
4461
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3296
4462
|
* version 2._ Revokes access to an item in a user's inventory
|
3297
|
-
*
|
4463
|
+
*
|
4464
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitem Microsoft Documentation}
|
4465
|
+
* @example
|
4466
|
+
* await adminClient.RevokeInventoryItem({
|
4467
|
+
* "PlayFabId": "203945882",
|
4468
|
+
* "ItemInstanceId": "2048583045"
|
4469
|
+
* });
|
3298
4470
|
*/
|
3299
4471
|
RevokeInventoryItem(request: RevokeInventoryItemRequest, extraHeaders?: Record<string, string>): Promise<RevokeInventoryResult>;
|
3300
4472
|
/**
|
3301
4473
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3302
4474
|
* version 2._ Revokes access for up to 25 items across multiple users and characters.
|
3303
|
-
*
|
4475
|
+
*
|
4476
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitems Microsoft Documentation}
|
4477
|
+
* @example
|
4478
|
+
* await adminClient.RevokeInventoryItems({
|
4479
|
+
* "Items": [
|
4480
|
+
* {
|
4481
|
+
* "PlayFabId": "203945882",
|
4482
|
+
* "ItemInstanceId": "2048583045"
|
4483
|
+
* }
|
4484
|
+
* ]
|
4485
|
+
* });
|
3304
4486
|
*/
|
3305
4487
|
RevokeInventoryItems(request: RevokeInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RevokeInventoryItemsResult>;
|
3306
4488
|
/**
|
3307
4489
|
* Run a task immediately regardless of its schedule.
|
3308
|
-
*
|
4490
|
+
*
|
4491
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/runtask Microsoft Documentation}
|
4492
|
+
* @example
|
4493
|
+
* await adminClient.RunTask({
|
4494
|
+
* "Identifier": {
|
4495
|
+
* "Id": "E1772FD927D8539D"
|
4496
|
+
* }
|
4497
|
+
* });
|
3309
4498
|
*/
|
3310
4499
|
RunTask(request: RunTaskRequest, extraHeaders?: Record<string, string>): Promise<RunTaskResult>;
|
3311
4500
|
/**
|
3312
4501
|
* Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
|
3313
4502
|
* change the password.If an account recovery email template ID is provided, an email using the custom email template will
|
3314
4503
|
* be used.
|
3315
|
-
*
|
4504
|
+
*
|
4505
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/sendaccountrecoveryemail Microsoft Documentation}
|
4506
|
+
* @example
|
4507
|
+
* await adminClient.SendAccountRecoveryEmail({
|
4508
|
+
* "Email": "assignedemail@here.com",
|
4509
|
+
* "EmailTemplateId": "D53AB15D8F12E330"
|
4510
|
+
* });
|
3316
4511
|
*/
|
3317
4512
|
SendAccountRecoveryEmail(request: SendAccountRecoveryEmailRequest, extraHeaders?: Record<string, string>): Promise<SendAccountRecoveryEmailResult>;
|
3318
4513
|
/**
|
3319
4514
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3320
4515
|
* version 2._ Creates the catalog configuration of all virtual goods for the specified catalog version
|
3321
|
-
*
|
4516
|
+
*
|
4517
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setcatalogitems Microsoft Documentation}
|
4518
|
+
* @example
|
4519
|
+
* await adminClient.SetCatalogItems({
|
4520
|
+
* "CatalogVersion": "5",
|
4521
|
+
* "Catalog": [
|
4522
|
+
* {
|
4523
|
+
* "ItemId": "shield_level_5",
|
4524
|
+
* "ItemClass": "shields",
|
4525
|
+
* "DisplayName": "Level 5 Shield",
|
4526
|
+
* "Description": "Strong defense against projectile attacks",
|
4527
|
+
* "VirtualCurrencyPrices": {
|
4528
|
+
* "RM": 199,
|
4529
|
+
* "GV": 25
|
4530
|
+
* },
|
4531
|
+
* "RealCurrencyPrices": {
|
4532
|
+
* "GBP": 149,
|
4533
|
+
* "EUR": 169
|
4534
|
+
* },
|
4535
|
+
* "CanBecomeCharacter": false,
|
4536
|
+
* "IsStackable": false,
|
4537
|
+
* "IsTradable": false,
|
4538
|
+
* "IsLimitedEdition": false,
|
4539
|
+
* "InitialLimitedEditionCount": 0
|
4540
|
+
* },
|
4541
|
+
* {
|
4542
|
+
* "ItemId": "energy_boost_1",
|
4543
|
+
* "ItemClass": "boosts",
|
4544
|
+
* "DisplayName": "Energy Drink Six-Pack",
|
4545
|
+
* "Description": "Get a quick burst of energy whenever you need it",
|
4546
|
+
* "VirtualCurrencyPrices": {
|
4547
|
+
* "RM": 199,
|
4548
|
+
* "GV": 25
|
4549
|
+
* },
|
4550
|
+
* "CanBecomeCharacter": false,
|
4551
|
+
* "IsStackable": false,
|
4552
|
+
* "IsTradable": false,
|
4553
|
+
* "IsLimitedEdition": false,
|
4554
|
+
* "InitialLimitedEditionCount": 0
|
4555
|
+
* },
|
4556
|
+
* {
|
4557
|
+
* "ItemId": "required_item_for_grant_a_1",
|
4558
|
+
* "ItemClass": "sets",
|
4559
|
+
* "DisplayName": "Grant Set Item 1",
|
4560
|
+
* "Description": "Item 1 from the set of items needed to get Granted Item A for free",
|
4561
|
+
* "VirtualCurrencyPrices": {
|
4562
|
+
* "RM": 249,
|
4563
|
+
* "GV": 1500
|
4564
|
+
* },
|
4565
|
+
* "CanBecomeCharacter": false,
|
4566
|
+
* "IsStackable": false,
|
4567
|
+
* "IsTradable": false,
|
4568
|
+
* "IsLimitedEdition": false,
|
4569
|
+
* "InitialLimitedEditionCount": 0
|
4570
|
+
* },
|
4571
|
+
* {
|
4572
|
+
* "ItemId": "required_item_for_grant_a_2",
|
4573
|
+
* "ItemClass": "sets",
|
4574
|
+
* "DisplayName": "Grant Set Item 2",
|
4575
|
+
* "Description": "Item 2 from the set of items needed to get Granted Item A for free",
|
4576
|
+
* "VirtualCurrencyPrices": {
|
4577
|
+
* "RM": 249,
|
4578
|
+
* "GV": 1500
|
4579
|
+
* },
|
4580
|
+
* "CanBecomeCharacter": false,
|
4581
|
+
* "IsStackable": false,
|
4582
|
+
* "IsTradable": false,
|
4583
|
+
* "IsLimitedEdition": false,
|
4584
|
+
* "InitialLimitedEditionCount": 0
|
4585
|
+
* },
|
4586
|
+
* {
|
4587
|
+
* "ItemId": "required_item_for_grant_a_3",
|
4588
|
+
* "ItemClass": "sets",
|
4589
|
+
* "DisplayName": "Grant Set Item 3",
|
4590
|
+
* "Description": "Item 3 from the set of items needed to get Granted Item A for free",
|
4591
|
+
* "VirtualCurrencyPrices": {
|
4592
|
+
* "RM": 249,
|
4593
|
+
* "GV": 1500
|
4594
|
+
* },
|
4595
|
+
* "CanBecomeCharacter": false,
|
4596
|
+
* "IsStackable": false,
|
4597
|
+
* "IsTradable": false,
|
4598
|
+
* "IsLimitedEdition": false,
|
4599
|
+
* "InitialLimitedEditionCount": 0
|
4600
|
+
* },
|
4601
|
+
* {
|
4602
|
+
* "ItemId": "required_item_for_grant_a_4",
|
4603
|
+
* "ItemClass": "sets",
|
4604
|
+
* "DisplayName": "Grant Set Item 4",
|
4605
|
+
* "Description": "Item 4 from the set of items needed to get Granted Item A for free",
|
4606
|
+
* "VirtualCurrencyPrices": {
|
4607
|
+
* "RM": 249,
|
4608
|
+
* "GV": 1500
|
4609
|
+
* },
|
4610
|
+
* "CanBecomeCharacter": false,
|
4611
|
+
* "IsStackable": false,
|
4612
|
+
* "IsTradable": false,
|
4613
|
+
* "IsLimitedEdition": false,
|
4614
|
+
* "InitialLimitedEditionCount": 0
|
4615
|
+
* },
|
4616
|
+
* {
|
4617
|
+
* "ItemId": "granted_item_a",
|
4618
|
+
* "ItemClass": "sets",
|
4619
|
+
* "DisplayName": "Granted Item A",
|
4620
|
+
* "Description": "Bonus item granted for free once the full set of 4 Grant Set items are collected",
|
4621
|
+
* "CanBecomeCharacter": false,
|
4622
|
+
* "IsStackable": false,
|
4623
|
+
* "IsTradable": false,
|
4624
|
+
* "IsLimitedEdition": false,
|
4625
|
+
* "InitialLimitedEditionCount": 0
|
4626
|
+
* },
|
4627
|
+
* {
|
4628
|
+
* "ItemId": "consumable_item_1",
|
4629
|
+
* "ItemClass": "Consumables",
|
4630
|
+
* "DisplayName": "Consumable Item 1",
|
4631
|
+
* "Description": "Item demonstrating usage-based consumables",
|
4632
|
+
* "VirtualCurrencyPrices": {
|
4633
|
+
* "GV": 500
|
4634
|
+
* },
|
4635
|
+
* "Consumable": {
|
4636
|
+
* "UsageCount": 3
|
4637
|
+
* },
|
4638
|
+
* "CanBecomeCharacter": false,
|
4639
|
+
* "IsStackable": false,
|
4640
|
+
* "IsTradable": false,
|
4641
|
+
* "IsLimitedEdition": false,
|
4642
|
+
* "InitialLimitedEditionCount": 0
|
4643
|
+
* },
|
4644
|
+
* {
|
4645
|
+
* "ItemId": "consumable_item_2",
|
4646
|
+
* "ItemClass": "Consumables",
|
4647
|
+
* "DisplayName": "Consumable Item 2",
|
4648
|
+
* "Description": "Item demonstrating time-based consumables",
|
4649
|
+
* "VirtualCurrencyPrices": {
|
4650
|
+
* "GV": 750
|
4651
|
+
* },
|
4652
|
+
* "Consumable": {
|
4653
|
+
* "UsagePeriod": 3600,
|
4654
|
+
* "UsagePeriodGroup": "usage_group_1"
|
4655
|
+
* },
|
4656
|
+
* "CanBecomeCharacter": false,
|
4657
|
+
* "IsStackable": false,
|
4658
|
+
* "IsTradable": false,
|
4659
|
+
* "IsLimitedEdition": false,
|
4660
|
+
* "InitialLimitedEditionCount": 0
|
4661
|
+
* },
|
4662
|
+
* {
|
4663
|
+
* "ItemId": "sub_bundle_item_1",
|
4664
|
+
* "ItemClass": "Bundles",
|
4665
|
+
* "DisplayName": "Bundled Item 1",
|
4666
|
+
* "Description": "Item which is added to the user inventory as part of a bundle",
|
4667
|
+
* "CanBecomeCharacter": false,
|
4668
|
+
* "IsStackable": false,
|
4669
|
+
* "IsTradable": false,
|
4670
|
+
* "IsLimitedEdition": false,
|
4671
|
+
* "InitialLimitedEditionCount": 0
|
4672
|
+
* },
|
4673
|
+
* {
|
4674
|
+
* "ItemId": "sub_bundle_item_2",
|
4675
|
+
* "ItemClass": "Bundles",
|
4676
|
+
* "DisplayName": "Bundled Item 2",
|
4677
|
+
* "Description": "Item which is added to the user inventory as part of a bundle",
|
4678
|
+
* "CanBecomeCharacter": false,
|
4679
|
+
* "IsStackable": false,
|
4680
|
+
* "IsTradable": false,
|
4681
|
+
* "IsLimitedEdition": false,
|
4682
|
+
* "InitialLimitedEditionCount": 0
|
4683
|
+
* },
|
4684
|
+
* {
|
4685
|
+
* "ItemId": "item_bundle_1",
|
4686
|
+
* "ItemClass": "Bundles",
|
4687
|
+
* "DisplayName": "Item bundle 1",
|
4688
|
+
* "Description": "Item which, when added to the user inventory, also adds other bundled items",
|
4689
|
+
* "VirtualCurrencyPrices": {
|
4690
|
+
* "RM": 599
|
4691
|
+
* },
|
4692
|
+
* "Bundle": {
|
4693
|
+
* "BundledItems": [
|
4694
|
+
* "sub_bundle_item_1",
|
4695
|
+
* "sub_bundle_item_2"
|
4696
|
+
* ],
|
4697
|
+
* "BundledResultTables": [
|
4698
|
+
* "random_result_1"
|
4699
|
+
* ],
|
4700
|
+
* "BundledVirtualCurrencies": {
|
4701
|
+
* "GV": 1000
|
4702
|
+
* }
|
4703
|
+
* },
|
4704
|
+
* "CanBecomeCharacter": false,
|
4705
|
+
* "IsStackable": false,
|
4706
|
+
* "IsTradable": false,
|
4707
|
+
* "IsLimitedEdition": false,
|
4708
|
+
* "InitialLimitedEditionCount": 0
|
4709
|
+
* },
|
4710
|
+
* {
|
4711
|
+
* "ItemId": "key_item_1",
|
4712
|
+
* "ItemClass": "Containers",
|
4713
|
+
* "DisplayName": "Key Item 1",
|
4714
|
+
* "Description": "Key used to unlock Container 1",
|
4715
|
+
* "VirtualCurrencyPrices": {
|
4716
|
+
* "RM": 199
|
4717
|
+
* },
|
4718
|
+
* "CanBecomeCharacter": false,
|
4719
|
+
* "IsStackable": false,
|
4720
|
+
* "IsTradable": false,
|
4721
|
+
* "IsLimitedEdition": false,
|
4722
|
+
* "InitialLimitedEditionCount": 0
|
4723
|
+
* },
|
4724
|
+
* {
|
4725
|
+
* "ItemId": "sub_container_item_1",
|
4726
|
+
* "ItemClass": "Containers",
|
4727
|
+
* "DisplayName": "Container Item 1",
|
4728
|
+
* "Description": "Item which is added to the user inventory as part of opening a container",
|
4729
|
+
* "CanBecomeCharacter": false,
|
4730
|
+
* "IsStackable": false,
|
4731
|
+
* "IsTradable": false,
|
4732
|
+
* "IsLimitedEdition": false,
|
4733
|
+
* "InitialLimitedEditionCount": 0
|
4734
|
+
* },
|
4735
|
+
* {
|
4736
|
+
* "ItemId": "sub_container_item_2",
|
4737
|
+
* "ItemClass": "Containers",
|
4738
|
+
* "DisplayName": "Container Item 2",
|
4739
|
+
* "Description": "Item which is added to the user inventory as part of opening a container",
|
4740
|
+
* "CanBecomeCharacter": false,
|
4741
|
+
* "IsStackable": false,
|
4742
|
+
* "IsTradable": false,
|
4743
|
+
* "IsLimitedEdition": false,
|
4744
|
+
* "InitialLimitedEditionCount": 0
|
4745
|
+
* },
|
4746
|
+
* {
|
4747
|
+
* "ItemId": "item_container_1",
|
4748
|
+
* "ItemClass": "Containers",
|
4749
|
+
* "DisplayName": "Item Container 1",
|
4750
|
+
* "Description": "Item which, when opened with Key Item 1, also adds the items it holds to the user inventory",
|
4751
|
+
* "VirtualCurrencyPrices": {
|
4752
|
+
* "RM": 499
|
4753
|
+
* },
|
4754
|
+
* "Consumable": {
|
4755
|
+
* "UsageCount": 1
|
4756
|
+
* },
|
4757
|
+
* "Container": {
|
4758
|
+
* "KeyItemId": "key_item_1",
|
4759
|
+
* "ItemContents": [
|
4760
|
+
* "sub_container_item_1",
|
4761
|
+
* "sub_container_item_2"
|
4762
|
+
* ],
|
4763
|
+
* "ResultTableContents": [
|
4764
|
+
* "random_result_1"
|
4765
|
+
* ],
|
4766
|
+
* "VirtualCurrencyContents": {
|
4767
|
+
* "GV": 1000
|
4768
|
+
* }
|
4769
|
+
* },
|
4770
|
+
* "CanBecomeCharacter": false,
|
4771
|
+
* "IsStackable": false,
|
4772
|
+
* "IsTradable": false,
|
4773
|
+
* "IsLimitedEdition": false,
|
4774
|
+
* "InitialLimitedEditionCount": 0
|
4775
|
+
* },
|
4776
|
+
* {
|
4777
|
+
* "ItemId": "item_container_2",
|
4778
|
+
* "ItemClass": "Containers",
|
4779
|
+
* "DisplayName": "Item Container 2",
|
4780
|
+
* "Description": "Item which, when opened (no key needed), adds the items it holds to the user inventory",
|
4781
|
+
* "VirtualCurrencyPrices": {
|
4782
|
+
* "RM": 99
|
4783
|
+
* },
|
4784
|
+
* "Consumable": {
|
4785
|
+
* "UsageCount": 1
|
4786
|
+
* },
|
4787
|
+
* "Container": {
|
4788
|
+
* "VirtualCurrencyContents": {
|
4789
|
+
* "GV": 1000
|
4790
|
+
* }
|
4791
|
+
* },
|
4792
|
+
* "CanBecomeCharacter": false,
|
4793
|
+
* "IsStackable": false,
|
4794
|
+
* "IsTradable": false,
|
4795
|
+
* "IsLimitedEdition": false,
|
4796
|
+
* "InitialLimitedEditionCount": 0
|
4797
|
+
* },
|
4798
|
+
* {
|
4799
|
+
* "ItemId": "starterpack_1",
|
4800
|
+
* "ItemClass": "starterpacks",
|
4801
|
+
* "DisplayName": "Super Starter Pack",
|
4802
|
+
* "Description": "Everything you need to get started fast track at the right price",
|
4803
|
+
* "CanBecomeCharacter": false,
|
4804
|
+
* "IsStackable": false,
|
4805
|
+
* "IsTradable": false,
|
4806
|
+
* "IsLimitedEdition": false,
|
4807
|
+
* "InitialLimitedEditionCount": 0
|
4808
|
+
* }
|
4809
|
+
* ]
|
4810
|
+
* });
|
3322
4811
|
*/
|
3323
4812
|
SetCatalogItems(request: UpdateCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateCatalogItemsResult>;
|
4813
|
+
/**
|
4814
|
+
* Updates the sink to which to route PlayStream and Telemetry event data.
|
4815
|
+
*
|
4816
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/seteventsink Microsoft Documentation}
|
4817
|
+
* @example
|
4818
|
+
* await adminClient.SetEventSink({
|
4819
|
+
* "Sink": {
|
4820
|
+
* "Name": "MyStorage",
|
4821
|
+
* "DestinationType": "AzureBlobStorage",
|
4822
|
+
* "IsEnabled": true,
|
4823
|
+
* "SinkSettings": {
|
4824
|
+
* "AccountName": "mystorageaccount",
|
4825
|
+
* "ContainerName": "mycontainername",
|
4826
|
+
* "TenantId": null,
|
4827
|
+
* "Credentials": {
|
4828
|
+
* "Secret": ""
|
4829
|
+
* }
|
4830
|
+
* }
|
4831
|
+
* }
|
4832
|
+
* });
|
4833
|
+
*/
|
4834
|
+
SetEventSink(request: SetEventSinkRequest, extraHeaders?: Record<string, string>): Promise<SetEventSinkResult>;
|
3324
4835
|
/**
|
3325
4836
|
* Sets the override expiration for a membership subscription
|
3326
|
-
*
|
4837
|
+
*
|
4838
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/setmembershipoverride Microsoft Documentation}
|
4839
|
+
* @example
|
4840
|
+
* await adminClient.SetMembershipOverride({
|
4841
|
+
* "ExpirationTime": "2014-04-06T00:00:00Z",
|
4842
|
+
* "MembershipId": "ShieldBonusMembership",
|
4843
|
+
* "PlayFabId": "204883457"
|
4844
|
+
* });
|
3327
4845
|
*/
|
3328
4846
|
SetMembershipOverride(request: SetMembershipOverrideRequest, extraHeaders?: Record<string, string>): Promise<SetMembershipOverrideResult>;
|
3329
4847
|
/**
|
3330
4848
|
* Sets or resets the player's secret. Player secrets are used to sign API requests.
|
3331
|
-
*
|
4849
|
+
*
|
4850
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/setplayersecret Microsoft Documentation}
|
4851
|
+
* @example
|
4852
|
+
* await adminClient.SetPlayerSecret({
|
4853
|
+
* "PlayerSecret": "ExampleSecret",
|
4854
|
+
* "PlayFabId": "ABCD1234"
|
4855
|
+
* });
|
3332
4856
|
*/
|
3333
4857
|
SetPlayerSecret(request: SetPlayerSecretRequest, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
|
3334
4858
|
/**
|
3335
4859
|
* Sets the currently published revision of a title Cloud Script
|
3336
|
-
*
|
4860
|
+
*
|
4861
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/setpublishedrevision Microsoft Documentation}
|
4862
|
+
* @example
|
4863
|
+
* await adminClient.SetPublishedRevision({
|
4864
|
+
* "Version": 1,
|
4865
|
+
* "Revision": 3
|
4866
|
+
* });
|
3337
4867
|
*/
|
3338
4868
|
SetPublishedRevision(request: SetPublishedRevisionRequest, extraHeaders?: Record<string, string>): Promise<SetPublishedRevisionResult>;
|
3339
4869
|
/**
|
3340
4870
|
* Updates the key-value store of custom publisher settings
|
3341
|
-
*
|
4871
|
+
*
|
4872
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/shared-group-data/setpublisherdata Microsoft Documentation}
|
4873
|
+
* @example
|
4874
|
+
* await adminClient.SetPublisherData({
|
4875
|
+
* "Key": "Running Speed",
|
4876
|
+
* "Value": "1.03"
|
4877
|
+
* });
|
3342
4878
|
*/
|
3343
4879
|
SetPublisherData(request: SetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<SetPublisherDataResult>;
|
3344
4880
|
/**
|
3345
4881
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3346
4882
|
* version 2._ Sets all the items in one virtual store
|
3347
|
-
*
|
4883
|
+
*
|
4884
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setstoreitems Microsoft Documentation}
|
4885
|
+
* @example
|
4886
|
+
* await adminClient.SetStoreItems({
|
4887
|
+
* "StoreId": "BonusStore",
|
4888
|
+
* "Store": [
|
4889
|
+
* {
|
4890
|
+
* "ItemId": "shield_level_5",
|
4891
|
+
* "VirtualCurrencyPrices": {
|
4892
|
+
* "RM": 180,
|
4893
|
+
* "GV": 20
|
4894
|
+
* },
|
4895
|
+
* "RealCurrencyPrices": {
|
4896
|
+
* "GBP": 100
|
4897
|
+
* }
|
4898
|
+
* },
|
4899
|
+
* {
|
4900
|
+
* "ItemId": "energy_boost_1",
|
4901
|
+
* "VirtualCurrencyPrices": {
|
4902
|
+
* "RM": 250,
|
4903
|
+
* "GV": 30
|
4904
|
+
* }
|
4905
|
+
* },
|
4906
|
+
* {
|
4907
|
+
* "ItemId": "starterpack_1",
|
4908
|
+
* "VirtualCurrencyPrices": {
|
4909
|
+
* "RM": 399
|
4910
|
+
* }
|
4911
|
+
* }
|
4912
|
+
* ]
|
4913
|
+
* });
|
3348
4914
|
*/
|
3349
4915
|
SetStoreItems(request: UpdateStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateStoreItemsResult>;
|
3350
4916
|
/**
|
@@ -3352,131 +4918,756 @@ declare class PlayFabAdminApi extends PlayFabCommon {
|
|
3352
4918
|
* developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths,
|
3353
4919
|
* movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new
|
3354
4920
|
* build.
|
3355
|
-
*
|
4921
|
+
*
|
4922
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledata Microsoft Documentation}
|
4923
|
+
* @example
|
4924
|
+
* await adminClient.SetTitleData({
|
4925
|
+
* "Key": "Running Speed",
|
4926
|
+
* "Value": "1.03"
|
4927
|
+
* });
|
3356
4928
|
*/
|
3357
4929
|
SetTitleData(request: SetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
|
3358
4930
|
/**
|
3359
4931
|
* Set and delete key-value pairs in a title data override instance.
|
3360
|
-
*
|
4932
|
+
*
|
4933
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledataandoverrides Microsoft Documentation}
|
4934
|
+
* @example
|
4935
|
+
* await adminClient.SetTitleDataAndOverrides({
|
4936
|
+
* "OverrideLabel": "Holiday title data",
|
4937
|
+
* "TitleId": "8FF3A797",
|
4938
|
+
* "KeyValues": [
|
4939
|
+
* {
|
4940
|
+
* "Key": "Running Speed",
|
4941
|
+
* "Value": "1.03"
|
4942
|
+
* },
|
4943
|
+
* {
|
4944
|
+
* "Key": "Walking Speed",
|
4945
|
+
* "Value": "0.05"
|
4946
|
+
* }
|
4947
|
+
* ]
|
4948
|
+
* });
|
3361
4949
|
*/
|
3362
4950
|
SetTitleDataAndOverrides(request: SetTitleDataAndOverridesRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataAndOverridesResult>;
|
3363
4951
|
/**
|
3364
4952
|
* Updates the key-value store of custom title settings which cannot be read by the client. These values can be used to
|
3365
4953
|
* tweak settings used by game servers and Cloud Scripts without the need to update and re-deploy.
|
3366
|
-
*
|
4954
|
+
*
|
4955
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitleinternaldata Microsoft Documentation}
|
4956
|
+
* @example
|
4957
|
+
* await adminClient.SetTitleInternalData({
|
4958
|
+
* "Key": "Running Speed",
|
4959
|
+
* "Value": "1.03"
|
4960
|
+
* });
|
3367
4961
|
*/
|
3368
4962
|
SetTitleInternalData(request: SetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
|
3369
4963
|
/**
|
3370
4964
|
* Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can
|
3371
4965
|
* be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device
|
3372
4966
|
* Messaging is not supported.
|
3373
|
-
*
|
4967
|
+
*
|
4968
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setuppushnotification Microsoft Documentation}
|
4969
|
+
* @example
|
4970
|
+
* await adminClient.SetupPushNotification({
|
4971
|
+
* "Platform": "APNS_SANDBOX",
|
4972
|
+
* "Key": "MyKey123",
|
4973
|
+
* "Credential": "MyCredentialsXYZ",
|
4974
|
+
* "OverwriteOldARN": false
|
4975
|
+
* });
|
3374
4976
|
*/
|
3375
4977
|
SetupPushNotification(request: SetupPushNotificationRequest, extraHeaders?: Record<string, string>): Promise<SetupPushNotificationResult>;
|
3376
4978
|
/**
|
3377
4979
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3378
4980
|
* version 2._ Decrements the specified virtual currency by the stated amount
|
3379
|
-
*
|
4981
|
+
*
|
4982
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/subtractuservirtualcurrency Microsoft Documentation}
|
4983
|
+
* @example
|
4984
|
+
* await adminClient.SubtractUserVirtualCurrency({
|
4985
|
+
* "PlayFabId": "20394883",
|
4986
|
+
* "VirtualCurrency": "GC",
|
4987
|
+
* "Amount": 100
|
4988
|
+
* });
|
3380
4989
|
*/
|
3381
4990
|
SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
|
3382
4991
|
/**
|
3383
4992
|
* Updates information of a list of existing bans specified with Ban Ids.
|
3384
|
-
*
|
4993
|
+
*
|
4994
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/updatebans Microsoft Documentation}
|
4995
|
+
* @example
|
4996
|
+
* await adminClient.UpdateBans({
|
4997
|
+
* "Bans": [
|
4998
|
+
* {
|
4999
|
+
* "BanId": "E0B5FF89542D413C",
|
5000
|
+
* "Permanent": true,
|
5001
|
+
* "Active": true
|
5002
|
+
* },
|
5003
|
+
* {
|
5004
|
+
* "BanId": "EF43FF89542G1546",
|
5005
|
+
* "Reason": "Royal pardon",
|
5006
|
+
* "Expires": "2016-07-04T00:00:00Z"
|
5007
|
+
* }
|
5008
|
+
* ]
|
5009
|
+
* });
|
3385
5010
|
*/
|
3386
5011
|
UpdateBans(request: UpdateBansRequest, extraHeaders?: Record<string, string>): Promise<UpdateBansResult>;
|
3387
5012
|
/**
|
3388
5013
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3389
5014
|
* version 2._ Updates the catalog configuration for virtual goods in the specified catalog version
|
3390
|
-
*
|
5015
|
+
*
|
5016
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatecatalogitems Microsoft Documentation}
|
5017
|
+
* @example
|
5018
|
+
* await adminClient.UpdateCatalogItems({
|
5019
|
+
* "CatalogVersion": "5",
|
5020
|
+
* "Catalog": [
|
5021
|
+
* {
|
5022
|
+
* "ItemId": "shield_level_5",
|
5023
|
+
* "ItemClass": "shields",
|
5024
|
+
* "DisplayName": "Level 5 Shield",
|
5025
|
+
* "Description": "Strong defense against projectile attacks",
|
5026
|
+
* "VirtualCurrencyPrices": {
|
5027
|
+
* "RM": 199,
|
5028
|
+
* "GV": 25
|
5029
|
+
* },
|
5030
|
+
* "RealCurrencyPrices": {
|
5031
|
+
* "GBP": 149,
|
5032
|
+
* "EUR": 169
|
5033
|
+
* },
|
5034
|
+
* "CanBecomeCharacter": false,
|
5035
|
+
* "IsStackable": false,
|
5036
|
+
* "IsTradable": false,
|
5037
|
+
* "IsLimitedEdition": false,
|
5038
|
+
* "InitialLimitedEditionCount": 0
|
5039
|
+
* },
|
5040
|
+
* {
|
5041
|
+
* "ItemId": "energy_boost_1",
|
5042
|
+
* "ItemClass": "boosts",
|
5043
|
+
* "DisplayName": "Energy Drink Six-Pack",
|
5044
|
+
* "Description": "Get a quick burst of energy whenever you need it",
|
5045
|
+
* "VirtualCurrencyPrices": {
|
5046
|
+
* "RM": 199,
|
5047
|
+
* "GV": 25
|
5048
|
+
* },
|
5049
|
+
* "CanBecomeCharacter": false,
|
5050
|
+
* "IsStackable": false,
|
5051
|
+
* "IsTradable": false,
|
5052
|
+
* "IsLimitedEdition": false,
|
5053
|
+
* "InitialLimitedEditionCount": 0
|
5054
|
+
* },
|
5055
|
+
* {
|
5056
|
+
* "ItemId": "required_item_for_grant_a_1",
|
5057
|
+
* "ItemClass": "sets",
|
5058
|
+
* "DisplayName": "Grant Set Item 1",
|
5059
|
+
* "Description": "Item 1 from the set of items needed to get Granted Item A for free",
|
5060
|
+
* "VirtualCurrencyPrices": {
|
5061
|
+
* "RM": 249,
|
5062
|
+
* "GV": 1500
|
5063
|
+
* },
|
5064
|
+
* "CanBecomeCharacter": false,
|
5065
|
+
* "IsStackable": false,
|
5066
|
+
* "IsTradable": false,
|
5067
|
+
* "IsLimitedEdition": false,
|
5068
|
+
* "InitialLimitedEditionCount": 0
|
5069
|
+
* },
|
5070
|
+
* {
|
5071
|
+
* "ItemId": "required_item_for_grant_a_2",
|
5072
|
+
* "ItemClass": "sets",
|
5073
|
+
* "DisplayName": "Grant Set Item 2",
|
5074
|
+
* "Description": "Item 2 from the set of items needed to get Granted Item A for free",
|
5075
|
+
* "VirtualCurrencyPrices": {
|
5076
|
+
* "RM": 249,
|
5077
|
+
* "GV": 1500
|
5078
|
+
* },
|
5079
|
+
* "CanBecomeCharacter": false,
|
5080
|
+
* "IsStackable": false,
|
5081
|
+
* "IsTradable": false,
|
5082
|
+
* "IsLimitedEdition": false,
|
5083
|
+
* "InitialLimitedEditionCount": 0
|
5084
|
+
* },
|
5085
|
+
* {
|
5086
|
+
* "ItemId": "required_item_for_grant_a_3",
|
5087
|
+
* "ItemClass": "sets",
|
5088
|
+
* "DisplayName": "Grant Set Item 3",
|
5089
|
+
* "Description": "Item 3 from the set of items needed to get Granted Item A for free",
|
5090
|
+
* "VirtualCurrencyPrices": {
|
5091
|
+
* "RM": 249,
|
5092
|
+
* "GV": 1500
|
5093
|
+
* },
|
5094
|
+
* "CanBecomeCharacter": false,
|
5095
|
+
* "IsStackable": false,
|
5096
|
+
* "IsTradable": false,
|
5097
|
+
* "IsLimitedEdition": false,
|
5098
|
+
* "InitialLimitedEditionCount": 0
|
5099
|
+
* },
|
5100
|
+
* {
|
5101
|
+
* "ItemId": "required_item_for_grant_a_4",
|
5102
|
+
* "ItemClass": "sets",
|
5103
|
+
* "DisplayName": "Grant Set Item 4",
|
5104
|
+
* "Description": "Item 4 from the set of items needed to get Granted Item A for free",
|
5105
|
+
* "VirtualCurrencyPrices": {
|
5106
|
+
* "RM": 249,
|
5107
|
+
* "GV": 1500
|
5108
|
+
* },
|
5109
|
+
* "CanBecomeCharacter": false,
|
5110
|
+
* "IsStackable": false,
|
5111
|
+
* "IsTradable": false,
|
5112
|
+
* "IsLimitedEdition": false,
|
5113
|
+
* "InitialLimitedEditionCount": 0
|
5114
|
+
* },
|
5115
|
+
* {
|
5116
|
+
* "ItemId": "granted_item_a",
|
5117
|
+
* "ItemClass": "sets",
|
5118
|
+
* "DisplayName": "Granted Item A",
|
5119
|
+
* "Description": "Bonus item granted for free once the full set of 4 Grant Set items are collected",
|
5120
|
+
* "CanBecomeCharacter": false,
|
5121
|
+
* "IsStackable": false,
|
5122
|
+
* "IsTradable": false,
|
5123
|
+
* "IsLimitedEdition": false,
|
5124
|
+
* "InitialLimitedEditionCount": 0
|
5125
|
+
* },
|
5126
|
+
* {
|
5127
|
+
* "ItemId": "consumable_item_1",
|
5128
|
+
* "ItemClass": "Consumables",
|
5129
|
+
* "DisplayName": "Consumable Item 1",
|
5130
|
+
* "Description": "Item demonstrating usage-based consumables",
|
5131
|
+
* "VirtualCurrencyPrices": {
|
5132
|
+
* "GV": 500
|
5133
|
+
* },
|
5134
|
+
* "Consumable": {
|
5135
|
+
* "UsageCount": 3
|
5136
|
+
* },
|
5137
|
+
* "CanBecomeCharacter": false,
|
5138
|
+
* "IsStackable": false,
|
5139
|
+
* "IsTradable": false,
|
5140
|
+
* "IsLimitedEdition": false,
|
5141
|
+
* "InitialLimitedEditionCount": 0
|
5142
|
+
* },
|
5143
|
+
* {
|
5144
|
+
* "ItemId": "consumable_item_2",
|
5145
|
+
* "ItemClass": "Consumables",
|
5146
|
+
* "DisplayName": "Consumable Item 2",
|
5147
|
+
* "Description": "Item demonstrating time-based consumables",
|
5148
|
+
* "VirtualCurrencyPrices": {
|
5149
|
+
* "GV": 750
|
5150
|
+
* },
|
5151
|
+
* "Consumable": {
|
5152
|
+
* "UsagePeriod": 3600,
|
5153
|
+
* "UsagePeriodGroup": "usage_group_1"
|
5154
|
+
* },
|
5155
|
+
* "CanBecomeCharacter": false,
|
5156
|
+
* "IsStackable": false,
|
5157
|
+
* "IsTradable": false,
|
5158
|
+
* "IsLimitedEdition": false,
|
5159
|
+
* "InitialLimitedEditionCount": 0
|
5160
|
+
* },
|
5161
|
+
* {
|
5162
|
+
* "ItemId": "sub_bundle_item_1",
|
5163
|
+
* "ItemClass": "Bundles",
|
5164
|
+
* "DisplayName": "Bundled Item 1",
|
5165
|
+
* "Description": "Item which is added to the user inventory as part of a bundle",
|
5166
|
+
* "CanBecomeCharacter": false,
|
5167
|
+
* "IsStackable": false,
|
5168
|
+
* "IsTradable": false,
|
5169
|
+
* "IsLimitedEdition": false,
|
5170
|
+
* "InitialLimitedEditionCount": 0
|
5171
|
+
* },
|
5172
|
+
* {
|
5173
|
+
* "ItemId": "sub_bundle_item_2",
|
5174
|
+
* "ItemClass": "Bundles",
|
5175
|
+
* "DisplayName": "Bundled Item 2",
|
5176
|
+
* "Description": "Item which is added to the user inventory as part of a bundle",
|
5177
|
+
* "CanBecomeCharacter": false,
|
5178
|
+
* "IsStackable": false,
|
5179
|
+
* "IsTradable": false,
|
5180
|
+
* "IsLimitedEdition": false,
|
5181
|
+
* "InitialLimitedEditionCount": 0
|
5182
|
+
* },
|
5183
|
+
* {
|
5184
|
+
* "ItemId": "item_bundle_1",
|
5185
|
+
* "ItemClass": "Bundles",
|
5186
|
+
* "DisplayName": "Item bundle 1",
|
5187
|
+
* "Description": "Item which, when added to the user inventory, also adds other bundled items",
|
5188
|
+
* "VirtualCurrencyPrices": {
|
5189
|
+
* "RM": 599
|
5190
|
+
* },
|
5191
|
+
* "Bundle": {
|
5192
|
+
* "BundledItems": [
|
5193
|
+
* "sub_bundle_item_1",
|
5194
|
+
* "sub_bundle_item_2"
|
5195
|
+
* ],
|
5196
|
+
* "BundledResultTables": [
|
5197
|
+
* "random_result_1"
|
5198
|
+
* ],
|
5199
|
+
* "BundledVirtualCurrencies": {
|
5200
|
+
* "GV": 1000
|
5201
|
+
* }
|
5202
|
+
* },
|
5203
|
+
* "CanBecomeCharacter": false,
|
5204
|
+
* "IsStackable": false,
|
5205
|
+
* "IsTradable": false,
|
5206
|
+
* "IsLimitedEdition": false,
|
5207
|
+
* "InitialLimitedEditionCount": 0
|
5208
|
+
* },
|
5209
|
+
* {
|
5210
|
+
* "ItemId": "key_item_1",
|
5211
|
+
* "ItemClass": "Containers",
|
5212
|
+
* "DisplayName": "Key Item 1",
|
5213
|
+
* "Description": "Key used to unlock Container 1",
|
5214
|
+
* "VirtualCurrencyPrices": {
|
5215
|
+
* "RM": 199
|
5216
|
+
* },
|
5217
|
+
* "CanBecomeCharacter": false,
|
5218
|
+
* "IsStackable": false,
|
5219
|
+
* "IsTradable": false,
|
5220
|
+
* "IsLimitedEdition": false,
|
5221
|
+
* "InitialLimitedEditionCount": 0
|
5222
|
+
* },
|
5223
|
+
* {
|
5224
|
+
* "ItemId": "sub_container_item_1",
|
5225
|
+
* "ItemClass": "Containers",
|
5226
|
+
* "DisplayName": "Container Item 1",
|
5227
|
+
* "Description": "Item which is added to the user inventory as part of opening a container",
|
5228
|
+
* "CanBecomeCharacter": false,
|
5229
|
+
* "IsStackable": false,
|
5230
|
+
* "IsTradable": false,
|
5231
|
+
* "IsLimitedEdition": false,
|
5232
|
+
* "InitialLimitedEditionCount": 0
|
5233
|
+
* },
|
5234
|
+
* {
|
5235
|
+
* "ItemId": "sub_container_item_2",
|
5236
|
+
* "ItemClass": "Containers",
|
5237
|
+
* "DisplayName": "Container Item 2",
|
5238
|
+
* "Description": "Item which is added to the user inventory as part of opening a container",
|
5239
|
+
* "CanBecomeCharacter": false,
|
5240
|
+
* "IsStackable": false,
|
5241
|
+
* "IsTradable": false,
|
5242
|
+
* "IsLimitedEdition": false,
|
5243
|
+
* "InitialLimitedEditionCount": 0
|
5244
|
+
* },
|
5245
|
+
* {
|
5246
|
+
* "ItemId": "item_container_1",
|
5247
|
+
* "ItemClass": "Containers",
|
5248
|
+
* "DisplayName": "Item Container 1",
|
5249
|
+
* "Description": "Item which, when opened with Key Item 1, also adds the items it holds to the user inventory",
|
5250
|
+
* "VirtualCurrencyPrices": {
|
5251
|
+
* "RM": 499
|
5252
|
+
* },
|
5253
|
+
* "Consumable": {
|
5254
|
+
* "UsageCount": 1
|
5255
|
+
* },
|
5256
|
+
* "Container": {
|
5257
|
+
* "KeyItemId": "key_item_1",
|
5258
|
+
* "ItemContents": [
|
5259
|
+
* "sub_container_item_1",
|
5260
|
+
* "sub_container_item_2"
|
5261
|
+
* ],
|
5262
|
+
* "ResultTableContents": [
|
5263
|
+
* "random_result_1"
|
5264
|
+
* ],
|
5265
|
+
* "VirtualCurrencyContents": {
|
5266
|
+
* "GV": 1000
|
5267
|
+
* }
|
5268
|
+
* },
|
5269
|
+
* "CanBecomeCharacter": false,
|
5270
|
+
* "IsStackable": false,
|
5271
|
+
* "IsTradable": false,
|
5272
|
+
* "IsLimitedEdition": false,
|
5273
|
+
* "InitialLimitedEditionCount": 0
|
5274
|
+
* },
|
5275
|
+
* {
|
5276
|
+
* "ItemId": "item_container_2",
|
5277
|
+
* "ItemClass": "Containers",
|
5278
|
+
* "DisplayName": "Item Container 2",
|
5279
|
+
* "Description": "Item which, when opened (no key needed), adds the items it holds to the user inventory",
|
5280
|
+
* "VirtualCurrencyPrices": {
|
5281
|
+
* "RM": 99
|
5282
|
+
* },
|
5283
|
+
* "Consumable": {
|
5284
|
+
* "UsageCount": 1
|
5285
|
+
* },
|
5286
|
+
* "Container": {
|
5287
|
+
* "VirtualCurrencyContents": {
|
5288
|
+
* "GV": 1000
|
5289
|
+
* }
|
5290
|
+
* },
|
5291
|
+
* "CanBecomeCharacter": false,
|
5292
|
+
* "IsStackable": false,
|
5293
|
+
* "IsTradable": false,
|
5294
|
+
* "IsLimitedEdition": false,
|
5295
|
+
* "InitialLimitedEditionCount": 0
|
5296
|
+
* },
|
5297
|
+
* {
|
5298
|
+
* "ItemId": "starterpack_1",
|
5299
|
+
* "ItemClass": "starterpacks",
|
5300
|
+
* "DisplayName": "Super Starter Pack",
|
5301
|
+
* "Description": "Everything you need to get started fast track at the right price",
|
5302
|
+
* "CanBecomeCharacter": false,
|
5303
|
+
* "IsStackable": false,
|
5304
|
+
* "IsTradable": false,
|
5305
|
+
* "IsLimitedEdition": false,
|
5306
|
+
* "InitialLimitedEditionCount": 0
|
5307
|
+
* }
|
5308
|
+
* ]
|
5309
|
+
* });
|
3391
5310
|
*/
|
3392
5311
|
UpdateCatalogItems(request: UpdateCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateCatalogItemsResult>;
|
3393
5312
|
/**
|
3394
5313
|
* Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be
|
3395
5314
|
* submitted in the revision.
|
3396
|
-
*
|
5315
|
+
*
|
5316
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/updatecloudscript Microsoft Documentation}
|
5317
|
+
* @example
|
5318
|
+
* await adminClient.UpdateCloudScript({
|
5319
|
+
* "Files": [
|
5320
|
+
* {
|
5321
|
+
* "Filename": "main.js",
|
5322
|
+
* "FileContents": "var LevelRewards =\r\n[\r\n\t[\"TestItem1\"],\r\n\t[\"TestItem2\"],\r\n\t[\"TestItem3\"],\r\n\t[\"TestItem1\", \"TestItem2\"],\r\n\t[\"TestItem2\", \"TestItem2\"],\r\n\t[\"TestItem3\", \"TestItem3\"]\r\n]\r\n\r\nhandlers.onLevelComplete = function(args)\r\n{\r\n\tvar levelNum = args.level;\r\n\t\r\n\t// Do some basic input validation\r\n\tif(levelNum < 0 || levelNum >= LevelRewards.length)\r\n\t{\r\n\t\tlog.info(\"Invalid level \"+levelNum+\" completed by \"+currentPlayerId);\r\n\t\treturn {};\r\n\t}\r\n\t\r\n\tvar levelCompleteKey = \"LevelCompleted\"+levelNum;\r\n\t\r\n\t// Get the user's internal data\r\n\tvar playerInternalData = server.GetUserInternalData(\r\n\t{\r\n\t\tPlayFabId: currentPlayerId,\r\n\t\tKeys: [levelCompleteKey]\r\n\t});\r\n\t\r\n\t// Did they already complete this level?\r\n\tif(playerInternalData.Data[levelCompleteKey])\r\n\t{\r\n\t\tlog.info(\"Player \"+currentPlayerId+\" already completed level \"+levelNum);\r\n\t\treturn {};\r\n\t}\r\n\t\r\n\tvar rewards = LevelRewards[levelNum];\r\n\t\r\n\tvar resultItems = null;\r\n\tif(rewards)\r\n\t{\r\n\t\t// Grant reward items to player for completing the level\r\n\t\tvar itemGrantResult = server.GrantItemsToUser(\r\n\t\t{\r\n\t\t\tPlayFabId: currentPlayerId,\r\n\t\t\tAnnotation: \"Given by completing level \"+levelNum,\r\n\t\t\tItemIds: rewards\r\n\t\t});\r\n\t\t\r\n\t\tresultItems = itemGrantResult.ItemGrantResults;\r\n\t}\r\n\t\r\n\t// Mark the level as being completed so they can't get the reward again\r\n\tvar saveData = {};\r\n\tsaveData[levelCompleteKey] = \"true\";\r\n\tserver.UpdateUserInternalData(\r\n\t{\r\n\t\tPlayFabId: currentPlayerId,\r\n\t\tData: saveData\r\n\t});\r\n\r\n\t// Return the results of the item grant so the client can see what they got\r\n\treturn {\r\n\t\trewards: resultItems\r\n\t};\r\n}\r\n\r\nvar monsterRewards =\r\n{\r\n\t\"skrill\" : { \"ChumpCoins\" : 100},\r\n\t\"lumpur\" : { \"ChumpCoins\" : 200}\r\n}\r\n\r\nvar killCoolDown = 60;\r\n\r\nfunction currTimeSeconds()\r\n{\r\n\tvar now = new Date();\r\n\treturn now.getTime() / 1000;\r\n}\r\n\r\nhandlers.monsterKilled = function(args)\r\n{\r\n\tvar monsterType = args.type;\r\n\t\r\n\tvar now = currTimeSeconds();\r\n\t\r\n\t// Get the user's internal data\r\n\tvar playerInternalData = server.GetUserInternalData(\r\n\t{\r\n\t\tPlayFabId: currentPlayerId,\r\n\t\tKeys: [\"lastKill\"]\r\n\t});\r\n\t\r\n\t// Check when the last time they killed a monster was \r\n\tvar lastKill = playerInternalData.Data[\"lastKill\"];\r\n\tif(lastKill)\r\n\t{\r\n\t\t// We have a value, see when it is\r\n\t\tvar lastKillTime = parseInt(lastKill.Value);\r\n\t\tif(now - lastKillTime < killCoolDown)\r\n\t\t{\r\n\t\t\t// In this particular game, it should not be possible to kill a monster more often than once a minute, so they might be cheating\r\n\t\t\tlog.info(\"Player \"+currentPlayerId+\" killed \"+monsterType+\" again too quickly!\");\r\n\t\t\treturn {};\r\n\t\t}\r\n\t}\r\n\t\r\n\tvar killReward = monsterRewards[monsterType];\r\n\t\r\n\tif(killReward)\r\n\t{\r\n\t\tfor(var currency in killReward)\r\n\t\t{\r\n\t\t\tvar amount = killReward[currency];\r\n\t\t\tserver.AddUserVirtualCurrency({ PlayFabId: currentPlayerId, VirtualCurrency: currency, Amount: amount });\r\n\t\t}\r\n\t}\r\n\t\r\n\t// Reset the kill timer\r\n\tserver.UpdateUserInternalData(\r\n\t{\r\n\t\tPlayFabId: currentPlayerId,\r\n\t\tData: {\r\n\t\t\t\"lastKill\" : String(now)\r\n\t\t}\r\n\t});\r\n\t\r\n\treturn {\r\n\t\trewards: killReward\r\n\t};\r\n}"
|
5323
|
+
* }
|
5324
|
+
* ],
|
5325
|
+
* "Publish": false
|
5326
|
+
* });
|
3397
5327
|
*/
|
3398
5328
|
UpdateCloudScript(request: UpdateCloudScriptRequest, extraHeaders?: Record<string, string>): Promise<UpdateCloudScriptResult>;
|
3399
5329
|
/**
|
3400
5330
|
* Modifies data and credentials for an existing relationship between a title and an Open ID Connect provider
|
3401
|
-
*
|
5331
|
+
*
|
5332
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateopenidconnection Microsoft Documentation}
|
5333
|
+
* @example
|
5334
|
+
* await adminClient.UpdateOpenIdConnection({
|
5335
|
+
* "ConnectionId": "oidconnection1",
|
5336
|
+
* "ClientId": "example_id_1",
|
5337
|
+
* "ClientSecret": "new_example_secret",
|
5338
|
+
* "IssuerInformation": {
|
5339
|
+
* "Issuer": "https://issuer.example.com/",
|
5340
|
+
* "AuthorizationUrl": "https://issuer.example.com/authorize",
|
5341
|
+
* "TokenUrl": "https://issuer.example.com/oauth2/token",
|
5342
|
+
* "JsonWebKeySet": {
|
5343
|
+
* "keys": [
|
5344
|
+
* "..."
|
5345
|
+
* ]
|
5346
|
+
* }
|
5347
|
+
* },
|
5348
|
+
* "IssuerOverride": "https://issueroverride.example.com/"
|
5349
|
+
* });
|
3402
5350
|
*/
|
3403
5351
|
UpdateOpenIdConnection(request: UpdateOpenIdConnectionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3404
5352
|
/**
|
3405
5353
|
* Updates the title-specific custom property values for a player
|
3406
|
-
*
|
5354
|
+
*
|
5355
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayercustomproperties Microsoft Documentation}
|
5356
|
+
* @example
|
5357
|
+
* await adminClient.UpdatePlayerCustomProperties({
|
5358
|
+
* "PlayFabId": "2039475",
|
5359
|
+
* "Properties": [
|
5360
|
+
* {
|
5361
|
+
* "Name": "level",
|
5362
|
+
* "Value": 5
|
5363
|
+
* },
|
5364
|
+
* {
|
5365
|
+
* "Name": "created",
|
5366
|
+
* "Value": false
|
5367
|
+
* }
|
5368
|
+
* ],
|
5369
|
+
* "ExpectedPropertiesVersion": 12
|
5370
|
+
* });
|
3407
5371
|
*/
|
3408
5372
|
UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerCustomPropertiesResult>;
|
3409
5373
|
/**
|
3410
5374
|
* Updates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available
|
3411
5375
|
* after this API returns.
|
3412
|
-
*
|
5376
|
+
*
|
5377
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateplayersharedsecret Microsoft Documentation}
|
5378
|
+
* @example
|
5379
|
+
* await adminClient.UpdatePlayerSharedSecret({
|
5380
|
+
* "SecretKey": "keysaresecret",
|
5381
|
+
* "FriendlyName": "XBox Users",
|
5382
|
+
* "Disabled": false
|
5383
|
+
* });
|
3413
5384
|
*/
|
3414
5385
|
UpdatePlayerSharedSecret(request: UpdatePlayerSharedSecretRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerSharedSecretResult>;
|
3415
5386
|
/**
|
3416
5387
|
* Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.
|
3417
|
-
*
|
5388
|
+
*
|
5389
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayerstatisticdefinition Microsoft Documentation}
|
5390
|
+
* @example
|
5391
|
+
* await adminClient.UpdatePlayerStatisticDefinition({
|
5392
|
+
* "StatisticName": "headshots",
|
5393
|
+
* "VersionChangeInterval": "Day",
|
5394
|
+
* "ShouldProvisionLeaderboard": false
|
5395
|
+
* });
|
3418
5396
|
*/
|
3419
5397
|
UpdatePlayerStatisticDefinition(request: UpdatePlayerStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerStatisticDefinitionResult>;
|
3420
5398
|
/**
|
3421
5399
|
* Changes a policy for a title
|
3422
|
-
*
|
5400
|
+
*
|
5401
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/updatepolicy Microsoft Documentation}
|
5402
|
+
* @example
|
5403
|
+
* await adminClient.UpdatePolicy({
|
5404
|
+
* "PolicyName": "ApiPolicy",
|
5405
|
+
* "Statements": [
|
5406
|
+
* {
|
5407
|
+
* "Resource": "pfrn:api--*",
|
5408
|
+
* "Action": "*",
|
5409
|
+
* "Effect": "Allow",
|
5410
|
+
* "Principal": "*",
|
5411
|
+
* "Comment": "The default allow all policy"
|
5412
|
+
* },
|
5413
|
+
* {
|
5414
|
+
* "Resource": "pfrn:api--/Client/ConfirmPurchase",
|
5415
|
+
* "Action": "*",
|
5416
|
+
* "Effect": "Allow",
|
5417
|
+
* "Principal": "*",
|
5418
|
+
* "Comment": "This statement allows only request to ConfirmPurchase"
|
5419
|
+
* }
|
5420
|
+
* ],
|
5421
|
+
* "OverwritePolicy": false,
|
5422
|
+
* "PolicyVersion": 0
|
5423
|
+
* });
|
3423
5424
|
*/
|
3424
5425
|
UpdatePolicy(request: UpdatePolicyRequest, extraHeaders?: Record<string, string>): Promise<UpdatePolicyResponse>;
|
3425
5426
|
/**
|
3426
5427
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3427
5428
|
* version 2._ Updates the random drop table configuration for the title
|
3428
|
-
*
|
5429
|
+
*
|
5430
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updaterandomresulttables Microsoft Documentation}
|
5431
|
+
* @example
|
5432
|
+
* await adminClient.UpdateRandomResultTables({
|
5433
|
+
* "Tables": [
|
5434
|
+
* {
|
5435
|
+
* "TableId": "DropTable 1",
|
5436
|
+
* "Nodes": [
|
5437
|
+
* {
|
5438
|
+
* "ResultItemType": "ItemId",
|
5439
|
+
* "ResultItem": "Gold Crown 1",
|
5440
|
+
* "Weight": 20
|
5441
|
+
* },
|
5442
|
+
* {
|
5443
|
+
* "ResultItemType": "ItemId",
|
5444
|
+
* "ResultItem": "Magic Sword 3",
|
5445
|
+
* "Weight": 50
|
5446
|
+
* },
|
5447
|
+
* {
|
5448
|
+
* "ResultItemType": "ItemId",
|
5449
|
+
* "ResultItem": "Clear Shield 3",
|
5450
|
+
* "Weight": 70
|
5451
|
+
* }
|
5452
|
+
* ]
|
5453
|
+
* }
|
5454
|
+
* ]
|
5455
|
+
* });
|
3429
5456
|
*/
|
3430
5457
|
UpdateRandomResultTables(request: UpdateRandomResultTablesRequest, extraHeaders?: Record<string, string>): Promise<UpdateRandomResultTablesResult>;
|
3431
5458
|
/**
|
3432
5459
|
* Updates an existing player segment and its associated definition(s) and action(s) for a title.
|
3433
|
-
*
|
5460
|
+
*
|
5461
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/segments/updatesegment Microsoft Documentation}
|
5462
|
+
* @example
|
5463
|
+
* await adminClient.UpdateSegment({
|
5464
|
+
* "SegmentModel": {
|
5465
|
+
* "SegmentId": "B05FC8CB558A6570",
|
5466
|
+
* "Name": "My user segment",
|
5467
|
+
* "LastUpdateTime": "0001-01-01T00:00:00Z",
|
5468
|
+
* "SegmentOrDefinitions": [
|
5469
|
+
* {
|
5470
|
+
* "SegmentAndDefinitions": [
|
5471
|
+
* {
|
5472
|
+
* "AllPlayersFilter": {}
|
5473
|
+
* }
|
5474
|
+
* ]
|
5475
|
+
* }
|
5476
|
+
* ],
|
5477
|
+
* "EnteredSegmentActions": [
|
5478
|
+
* {
|
5479
|
+
* "BanPlayerAction": {
|
5480
|
+
* "BanHours": 2,
|
5481
|
+
* "ReasonForBan": "Not played for a year"
|
5482
|
+
* }
|
5483
|
+
* }
|
5484
|
+
* ],
|
5485
|
+
* "LeftSegmentActions": [
|
5486
|
+
* {
|
5487
|
+
* "ExecuteAzureFunctionAction": {
|
5488
|
+
* "AzureFunction": "AzureFunction1",
|
5489
|
+
* "FunctionParameter": "{\"InputParam\": \"1\"}",
|
5490
|
+
* "GenerateFunctionExecutedEvents": false
|
5491
|
+
* }
|
5492
|
+
* }
|
5493
|
+
* ]
|
5494
|
+
* }
|
5495
|
+
* });
|
3434
5496
|
*/
|
3435
5497
|
UpdateSegment(request: UpdateSegmentRequest, extraHeaders?: Record<string, string>): Promise<UpdateSegmentResponse>;
|
3436
5498
|
/**
|
3437
5499
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3438
5500
|
* version 2._ Updates an existing virtual item store with new or modified items
|
3439
|
-
*
|
5501
|
+
*
|
5502
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatestoreitems Microsoft Documentation}
|
5503
|
+
* @example
|
5504
|
+
* await adminClient.UpdateStoreItems({
|
5505
|
+
* "StoreId": "BonusStore",
|
5506
|
+
* "Store": [
|
5507
|
+
* {
|
5508
|
+
* "ItemId": "shield_level_5",
|
5509
|
+
* "VirtualCurrencyPrices": {
|
5510
|
+
* "RM": 180,
|
5511
|
+
* "GV": 20
|
5512
|
+
* },
|
5513
|
+
* "RealCurrencyPrices": {
|
5514
|
+
* "GBP": 100
|
5515
|
+
* }
|
5516
|
+
* },
|
5517
|
+
* {
|
5518
|
+
* "ItemId": "energy_boost_1",
|
5519
|
+
* "VirtualCurrencyPrices": {
|
5520
|
+
* "RM": 250,
|
5521
|
+
* "GV": 30
|
5522
|
+
* }
|
5523
|
+
* },
|
5524
|
+
* {
|
5525
|
+
* "ItemId": "starterpack_1",
|
5526
|
+
* "VirtualCurrencyPrices": {
|
5527
|
+
* "RM": 399
|
5528
|
+
* }
|
5529
|
+
* }
|
5530
|
+
* ]
|
5531
|
+
* });
|
3440
5532
|
*/
|
3441
5533
|
UpdateStoreItems(request: UpdateStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateStoreItemsResult>;
|
3442
5534
|
/**
|
3443
5535
|
* Update an existing task.
|
3444
|
-
*
|
5536
|
+
*
|
5537
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/updatetask Microsoft Documentation}
|
5538
|
+
* @example
|
5539
|
+
* await adminClient.UpdateTask({
|
5540
|
+
* "Identifier": {
|
5541
|
+
* "Name": "PushEventNotificationVIP_Halloween"
|
5542
|
+
* },
|
5543
|
+
* "Name": "PushEventNotificationVIP_Thanksgiving",
|
5544
|
+
* "Description": "Send push notification to VIP about Thanksgiving event",
|
5545
|
+
* "IsActive": false,
|
5546
|
+
* "Type": "ActionsOnPlayerSegment",
|
5547
|
+
* "Parameter": {
|
5548
|
+
* "SegmentId": "E2B0F9C19B02D796",
|
5549
|
+
* "Actions": [
|
5550
|
+
* {
|
5551
|
+
* "GrantItemContent": {
|
5552
|
+
* "CatalogVersion": "foo",
|
5553
|
+
* "ItemId": "bar",
|
5554
|
+
* "ItemQuantity": 1
|
5555
|
+
* }
|
5556
|
+
* }
|
5557
|
+
* ]
|
5558
|
+
* }
|
5559
|
+
* });
|
3445
5560
|
*/
|
3446
5561
|
UpdateTask(request: UpdateTaskRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3447
5562
|
/**
|
3448
5563
|
* Updates the title-specific custom data for the user which is readable and writable by the client
|
3449
|
-
*
|
5564
|
+
*
|
5565
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserdata Microsoft Documentation}
|
5566
|
+
* @example
|
5567
|
+
* await adminClient.UpdateUserData({
|
5568
|
+
* "PlayFabId": "2039475",
|
5569
|
+
* "Data": {
|
5570
|
+
* "Class": "Fighter",
|
5571
|
+
* "Gender": "Female",
|
5572
|
+
* "Icon": "Guard 3",
|
5573
|
+
* "Theme": "Colorful"
|
5574
|
+
* },
|
5575
|
+
* "Permission": "Public"
|
5576
|
+
* });
|
3450
5577
|
*/
|
3451
5578
|
UpdateUserData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3452
5579
|
/**
|
3453
5580
|
* Updates the title-specific custom data for the user which cannot be accessed by the client
|
3454
|
-
*
|
5581
|
+
*
|
5582
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserinternaldata Microsoft Documentation}
|
5583
|
+
* @example
|
5584
|
+
* await adminClient.UpdateUserInternalData({
|
5585
|
+
* "PlayFabId": "2039475",
|
5586
|
+
* "Data": {
|
5587
|
+
* "Class": "Fighter",
|
5588
|
+
* "Gender": "Female",
|
5589
|
+
* "Icon": "Guard 3",
|
5590
|
+
* "Theme": "Colorful"
|
5591
|
+
* }
|
5592
|
+
* });
|
3455
5593
|
*/
|
3456
5594
|
UpdateUserInternalData(request: UpdateUserInternalDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3457
5595
|
/**
|
3458
5596
|
* Updates the publisher-specific custom data for the user which is readable and writable by the client
|
3459
|
-
*
|
5597
|
+
*
|
5598
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherdata Microsoft Documentation}
|
5599
|
+
* @example
|
5600
|
+
* await adminClient.UpdateUserPublisherData({
|
5601
|
+
* "PlayFabId": "2039475",
|
5602
|
+
* "Data": {
|
5603
|
+
* "Class": "Fighter",
|
5604
|
+
* "Gender": "Female",
|
5605
|
+
* "Icon": "Guard 3",
|
5606
|
+
* "Theme": "Colorful"
|
5607
|
+
* },
|
5608
|
+
* "Permission": "Public"
|
5609
|
+
* });
|
3460
5610
|
*/
|
3461
5611
|
UpdateUserPublisherData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3462
5612
|
/**
|
3463
5613
|
* Updates the publisher-specific custom data for the user which cannot be accessed by the client
|
3464
|
-
*
|
5614
|
+
*
|
5615
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherinternaldata Microsoft Documentation}
|
5616
|
+
* @example
|
5617
|
+
* await adminClient.UpdateUserPublisherInternalData({
|
5618
|
+
* "PlayFabId": "2039475",
|
5619
|
+
* "Data": {
|
5620
|
+
* "Class": "Fighter",
|
5621
|
+
* "Gender": "Female",
|
5622
|
+
* "Icon": "Guard 3",
|
5623
|
+
* "Theme": "Colorful"
|
5624
|
+
* }
|
5625
|
+
* });
|
3465
5626
|
*/
|
3466
5627
|
UpdateUserPublisherInternalData(request: UpdateUserInternalDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3467
5628
|
/**
|
3468
5629
|
* Updates the publisher-specific custom data for the user which can only be read by the client
|
3469
|
-
*
|
5630
|
+
*
|
5631
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherreadonlydata Microsoft Documentation}
|
5632
|
+
* @example
|
5633
|
+
* await adminClient.UpdateUserPublisherReadOnlyData({
|
5634
|
+
* "PlayFabId": "2039475",
|
5635
|
+
* "Data": {
|
5636
|
+
* "Class": "Fighter",
|
5637
|
+
* "Gender": "Female",
|
5638
|
+
* "Icon": "Guard 3",
|
5639
|
+
* "Theme": "Colorful"
|
5640
|
+
* },
|
5641
|
+
* "Permission": "Public"
|
5642
|
+
* });
|
3470
5643
|
*/
|
3471
5644
|
UpdateUserPublisherReadOnlyData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3472
5645
|
/**
|
3473
5646
|
* Updates the title-specific custom data for the user which can only be read by the client
|
3474
|
-
*
|
5647
|
+
*
|
5648
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserreadonlydata Microsoft Documentation}
|
5649
|
+
* @example
|
5650
|
+
* await adminClient.UpdateUserReadOnlyData({
|
5651
|
+
* "PlayFabId": "2039475",
|
5652
|
+
* "Data": {
|
5653
|
+
* "Class": "Fighter",
|
5654
|
+
* "Gender": "Female",
|
5655
|
+
* "Icon": "Guard 3",
|
5656
|
+
* "Theme": "Colorful"
|
5657
|
+
* },
|
5658
|
+
* "Permission": "Public"
|
5659
|
+
* });
|
3475
5660
|
*/
|
3476
5661
|
UpdateUserReadOnlyData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3477
5662
|
/**
|
3478
5663
|
* Updates the title specific display name for a user
|
3479
|
-
*
|
5664
|
+
*
|
5665
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/updateusertitledisplayname Microsoft Documentation}
|
5666
|
+
* @example
|
5667
|
+
* await adminClient.UpdateUserTitleDisplayName({
|
5668
|
+
* "PlayFabId": "293438",
|
5669
|
+
* "DisplayName": "New Display Name"
|
5670
|
+
* });
|
3480
5671
|
*/
|
3481
5672
|
UpdateUserTitleDisplayName(request: UpdateUserTitleDisplayNameRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserTitleDisplayNameResult>;
|
3482
5673
|
}
|