async-playfab-web-sdk 1.192.250526-2 → 1.192.250526-4
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 +31 -31
- package/dist/Addon.js +2 -2
- package/dist/Admin.d.ts +118 -118
- package/dist/Admin.js +2 -2
- package/dist/Authentication.d.ts +5 -5
- package/dist/Authentication.js +2 -2
- package/dist/Client.d.ts +174 -174
- package/dist/Client.js +2 -2
- package/dist/CloudScript.d.ts +16 -16
- package/dist/CloudScript.js +2 -2
- package/dist/Data.d.ts +8 -8
- package/dist/Data.js +2 -2
- package/dist/Economy.d.ts +47 -47
- package/dist/Economy.js +2 -2
- package/dist/Events.d.ts +13 -13
- package/dist/Events.js +2 -2
- package/dist/Experimentation.d.ts +14 -14
- package/dist/Experimentation.js +2 -2
- package/dist/Groups.d.ts +26 -26
- package/dist/Groups.js +2 -2
- package/dist/Insights.d.ts +7 -7
- package/dist/Insights.js +2 -2
- package/dist/Localization.d.ts +2 -2
- package/dist/Localization.js +2 -2
- package/dist/Multiplayer.d.ts +88 -88
- package/dist/Multiplayer.js +2 -2
- package/dist/{PlayFabCommon-BUv4zqXf.d.ts → PlayFabCommon-Dnp_xHg5.d.ts} +6 -10
- package/dist/Profiles.d.ts +10 -10
- package/dist/Profiles.js +2 -2
- package/dist/Progression.d.ts +24 -24
- package/dist/Progression.js +2 -2
- package/dist/Server.d.ts +150 -150
- package/dist/Server.js +2 -2
- package/dist/{chunk-FPCXHDA7.js → chunk-2IBLMNAQ.js} +236 -236
- package/dist/chunk-2IBLMNAQ.js.map +1 -0
- package/dist/{chunk-5AAYYQU7.js → chunk-3TRLETD6.js} +32 -32
- package/dist/chunk-3TRLETD6.js.map +1 -0
- package/dist/{chunk-2NRPVFSH.js → chunk-4LT3OUQD.js} +176 -176
- package/dist/chunk-4LT3OUQD.js.map +1 -0
- package/dist/{chunk-CY3H2GBI.js → chunk-6TH6EJYH.js} +37 -78
- package/dist/chunk-6TH6EJYH.js.map +1 -0
- package/dist/{chunk-ZY56RXKC.js → chunk-7UQYMDJQ.js} +62 -62
- package/dist/chunk-7UQYMDJQ.js.map +1 -0
- package/dist/{chunk-D53KEX67.js → chunk-CLMINF57.js} +4 -4
- package/dist/chunk-CLMINF57.js.map +1 -0
- package/dist/{chunk-EY77H23H.js → chunk-F5NRBD4O.js} +48 -48
- package/dist/chunk-F5NRBD4O.js.map +1 -0
- package/dist/{chunk-QCCQJDCR.js → chunk-FEEE3PRD.js} +348 -348
- package/dist/chunk-FEEE3PRD.js.map +1 -0
- package/dist/{chunk-JRE75IDS.js → chunk-HKZJ4H4O.js} +26 -26
- package/dist/chunk-HKZJ4H4O.js.map +1 -0
- package/dist/{chunk-VTCQRNBL.js → chunk-NJQCK4TL.js} +16 -16
- package/dist/chunk-NJQCK4TL.js.map +1 -0
- package/dist/{chunk-BZECCU2H.js → chunk-ONCBQLGS.js} +300 -300
- package/dist/chunk-ONCBQLGS.js.map +1 -0
- package/dist/{chunk-RODJAJP2.js → chunk-PXPOK2QU.js} +14 -14
- package/dist/chunk-PXPOK2QU.js.map +1 -0
- package/dist/{chunk-7VP4SIOQ.js → chunk-Q22JHX4G.js} +20 -20
- package/dist/chunk-Q22JHX4G.js.map +1 -0
- package/dist/{chunk-V56QSAWL.js → chunk-RJPMKD7P.js} +10 -10
- package/dist/chunk-RJPMKD7P.js.map +1 -0
- package/dist/{chunk-42AWSTMK.js → chunk-WROXLFDZ.js} +28 -28
- package/dist/chunk-WROXLFDZ.js.map +1 -0
- package/dist/{chunk-CDBIRT6V.js → chunk-XAI5IWL4.js} +52 -52
- package/dist/chunk-XAI5IWL4.js.map +1 -0
- package/dist/{chunk-RHQFG2EP.js → chunk-XM26BUTO.js} +94 -94
- package/dist/chunk-XM26BUTO.js.map +1 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +17 -17
- package/package.json +1 -1
- package/dist/chunk-2NRPVFSH.js.map +0 -1
- package/dist/chunk-42AWSTMK.js.map +0 -1
- package/dist/chunk-5AAYYQU7.js.map +0 -1
- package/dist/chunk-7VP4SIOQ.js.map +0 -1
- package/dist/chunk-BZECCU2H.js.map +0 -1
- package/dist/chunk-CDBIRT6V.js.map +0 -1
- package/dist/chunk-CY3H2GBI.js.map +0 -1
- package/dist/chunk-D53KEX67.js.map +0 -1
- package/dist/chunk-EY77H23H.js.map +0 -1
- package/dist/chunk-FPCXHDA7.js.map +0 -1
- package/dist/chunk-JRE75IDS.js.map +0 -1
- package/dist/chunk-QCCQJDCR.js.map +0 -1
- package/dist/chunk-RHQFG2EP.js.map +0 -1
- package/dist/chunk-RODJAJP2.js.map +0 -1
- package/dist/chunk-V56QSAWL.js.map +0 -1
- package/dist/chunk-VTCQRNBL.js.map +0 -1
- package/dist/chunk-ZY56RXKC.js.map +0 -1
package/dist/Client.js
CHANGED
package/dist/CloudScript.d.ts
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-
|
1
|
+
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
|
2
2
|
|
3
3
|
interface AdCampaignAttributionModel {
|
4
4
|
/** UTC time stamp of attribution */
|
@@ -434,78 +434,78 @@ declare class PlayFabCloudScriptApi extends PlayFabCommon {
|
|
434
434
|
* custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.
|
435
435
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executeentitycloudscript
|
436
436
|
*/
|
437
|
-
ExecuteEntityCloudScript(request: ExecuteEntityCloudScriptRequest,
|
437
|
+
ExecuteEntityCloudScript(request: ExecuteEntityCloudScriptRequest, extraHeaders?: Record<string, string>): Promise<ExecuteCloudScriptResult>;
|
438
438
|
/**
|
439
439
|
* Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of
|
440
440
|
* custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.
|
441
441
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executefunction
|
442
442
|
*/
|
443
|
-
ExecuteFunction(request: ExecuteFunctionRequest,
|
443
|
+
ExecuteFunction(request: ExecuteFunctionRequest, extraHeaders?: Record<string, string>): Promise<ExecuteFunctionResult>;
|
444
444
|
/**
|
445
445
|
* Gets registered Azure Functions for a given title id and function name.
|
446
446
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/getfunction
|
447
447
|
*/
|
448
|
-
GetFunction(request: GetFunctionRequest,
|
448
|
+
GetFunction(request: GetFunctionRequest, extraHeaders?: Record<string, string>): Promise<GetFunctionResult>;
|
449
449
|
/**
|
450
450
|
* Lists all currently registered Event Hub triggered Azure Functions for a given title.
|
451
451
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listeventhubfunctions
|
452
452
|
*/
|
453
|
-
ListEventHubFunctions(request: ListFunctionsRequest,
|
453
|
+
ListEventHubFunctions(request: ListFunctionsRequest, extraHeaders?: Record<string, string>): Promise<ListEventHubFunctionsResult>;
|
454
454
|
/**
|
455
455
|
* Lists all currently registered Azure Functions for a given title.
|
456
456
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listfunctions
|
457
457
|
*/
|
458
|
-
ListFunctions(request: ListFunctionsRequest,
|
458
|
+
ListFunctions(request: ListFunctionsRequest, extraHeaders?: Record<string, string>): Promise<ListFunctionsResult>;
|
459
459
|
/**
|
460
460
|
* Lists all currently registered HTTP triggered Azure Functions for a given title.
|
461
461
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listhttpfunctions
|
462
462
|
*/
|
463
|
-
ListHttpFunctions(request: ListFunctionsRequest,
|
463
|
+
ListHttpFunctions(request: ListFunctionsRequest, extraHeaders?: Record<string, string>): Promise<ListHttpFunctionsResult>;
|
464
464
|
/**
|
465
465
|
* Lists all currently registered Queue triggered Azure Functions for a given title.
|
466
466
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listqueuedfunctions
|
467
467
|
*/
|
468
|
-
ListQueuedFunctions(request: ListFunctionsRequest,
|
468
|
+
ListQueuedFunctions(request: ListFunctionsRequest, extraHeaders?: Record<string, string>): Promise<ListQueuedFunctionsResult>;
|
469
469
|
/**
|
470
470
|
* Generate an entity PlayStream event for the provided function result.
|
471
471
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforentitytriggeredaction
|
472
472
|
*/
|
473
|
-
PostFunctionResultForEntityTriggeredAction(request: PostFunctionResultForEntityTriggeredActionRequest,
|
473
|
+
PostFunctionResultForEntityTriggeredAction(request: PostFunctionResultForEntityTriggeredActionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
474
474
|
/**
|
475
475
|
* Generate an entity PlayStream event for the provided function result.
|
476
476
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforfunctionexecution
|
477
477
|
*/
|
478
|
-
PostFunctionResultForFunctionExecution(request: PostFunctionResultForFunctionExecutionRequest,
|
478
|
+
PostFunctionResultForFunctionExecution(request: PostFunctionResultForFunctionExecutionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
479
479
|
/**
|
480
480
|
* Generate a player PlayStream event for the provided function result.
|
481
481
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforplayertriggeredaction
|
482
482
|
*/
|
483
|
-
PostFunctionResultForPlayerTriggeredAction(request: PostFunctionResultForPlayerTriggeredActionRequest,
|
483
|
+
PostFunctionResultForPlayerTriggeredAction(request: PostFunctionResultForPlayerTriggeredActionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
484
484
|
/**
|
485
485
|
* Generate a PlayStream event for the provided function result.
|
486
486
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforscheduledtask
|
487
487
|
*/
|
488
|
-
PostFunctionResultForScheduledTask(request: PostFunctionResultForScheduledTaskRequest,
|
488
|
+
PostFunctionResultForScheduledTask(request: PostFunctionResultForScheduledTaskRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
489
489
|
/**
|
490
490
|
* Registers an event hub triggered Azure Function with a title.
|
491
491
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registereventhubfunction
|
492
492
|
*/
|
493
|
-
RegisterEventHubFunction(request: RegisterEventHubFunctionRequest,
|
493
|
+
RegisterEventHubFunction(request: RegisterEventHubFunctionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
494
494
|
/**
|
495
495
|
* Registers an HTTP triggered Azure function with a title.
|
496
496
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerhttpfunction
|
497
497
|
*/
|
498
|
-
RegisterHttpFunction(request: RegisterHttpFunctionRequest,
|
498
|
+
RegisterHttpFunction(request: RegisterHttpFunctionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
499
499
|
/**
|
500
500
|
* Registers a queue triggered Azure Function with a title.
|
501
501
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerqueuedfunction
|
502
502
|
*/
|
503
|
-
RegisterQueuedFunction(request: RegisterQueuedFunctionRequest,
|
503
|
+
RegisterQueuedFunction(request: RegisterQueuedFunctionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
504
504
|
/**
|
505
505
|
* Unregisters an Azure Function with a title.
|
506
506
|
* https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/unregisterfunction
|
507
507
|
*/
|
508
|
-
UnregisterFunction(request: UnregisterFunctionRequest,
|
508
|
+
UnregisterFunction(request: UnregisterFunctionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
|
509
509
|
}
|
510
510
|
|
511
511
|
export { PlayFabCloudScriptApi as default };
|
package/dist/CloudScript.js
CHANGED
package/dist/Data.d.ts
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-
|
1
|
+
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
|
2
2
|
|
3
3
|
interface AbortFileUploadsRequest extends IPlayFabRequestCommon {
|
4
4
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
@@ -192,37 +192,37 @@ declare class PlayFabDataApi extends PlayFabCommon {
|
|
192
192
|
* Abort pending file uploads to an entity's profile.
|
193
193
|
* https://docs.microsoft.com/rest/api/playfab/data/file/abortfileuploads
|
194
194
|
*/
|
195
|
-
AbortFileUploads(request: AbortFileUploadsRequest,
|
195
|
+
AbortFileUploads(request: AbortFileUploadsRequest, extraHeaders?: Record<string, string>): Promise<AbortFileUploadsResponse>;
|
196
196
|
/**
|
197
197
|
* Delete files on an entity's profile.
|
198
198
|
* https://docs.microsoft.com/rest/api/playfab/data/file/deletefiles
|
199
199
|
*/
|
200
|
-
DeleteFiles(request: DeleteFilesRequest,
|
200
|
+
DeleteFiles(request: DeleteFilesRequest, extraHeaders?: Record<string, string>): Promise<DeleteFilesResponse>;
|
201
201
|
/**
|
202
202
|
* Finalize file uploads to an entity's profile.
|
203
203
|
* https://docs.microsoft.com/rest/api/playfab/data/file/finalizefileuploads
|
204
204
|
*/
|
205
|
-
FinalizeFileUploads(request: FinalizeFileUploadsRequest,
|
205
|
+
FinalizeFileUploads(request: FinalizeFileUploadsRequest, extraHeaders?: Record<string, string>): Promise<FinalizeFileUploadsResponse>;
|
206
206
|
/**
|
207
207
|
* Retrieves file metadata from an entity's profile.
|
208
208
|
* https://docs.microsoft.com/rest/api/playfab/data/file/getfiles
|
209
209
|
*/
|
210
|
-
GetFiles(request: GetFilesRequest,
|
210
|
+
GetFiles(request: GetFilesRequest, extraHeaders?: Record<string, string>): Promise<GetFilesResponse>;
|
211
211
|
/**
|
212
212
|
* Retrieves objects from an entity's profile.
|
213
213
|
* https://docs.microsoft.com/rest/api/playfab/data/object/getobjects
|
214
214
|
*/
|
215
|
-
GetObjects(request: GetObjectsRequest,
|
215
|
+
GetObjects(request: GetObjectsRequest, extraHeaders?: Record<string, string>): Promise<GetObjectsResponse>;
|
216
216
|
/**
|
217
217
|
* Initiates file uploads to an entity's profile.
|
218
218
|
* https://docs.microsoft.com/rest/api/playfab/data/file/initiatefileuploads
|
219
219
|
*/
|
220
|
-
InitiateFileUploads(request: InitiateFileUploadsRequest,
|
220
|
+
InitiateFileUploads(request: InitiateFileUploadsRequest, extraHeaders?: Record<string, string>): Promise<InitiateFileUploadsResponse>;
|
221
221
|
/**
|
222
222
|
* Sets objects on an entity's profile.
|
223
223
|
* https://docs.microsoft.com/rest/api/playfab/data/object/setobjects
|
224
224
|
*/
|
225
|
-
SetObjects(request: SetObjectsRequest,
|
225
|
+
SetObjects(request: SetObjectsRequest, extraHeaders?: Record<string, string>): Promise<SetObjectsResponse>;
|
226
226
|
}
|
227
227
|
|
228
228
|
export { PlayFabDataApi as default };
|
package/dist/Data.js
CHANGED
package/dist/Economy.d.ts
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-
|
1
|
+
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
|
2
2
|
|
3
3
|
interface AddInventoryItemsOperation {
|
4
4
|
/** The amount to add to the current item amount. */
|
@@ -1584,12 +1584,12 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1584
1584
|
* Add inventory items. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is uncapped.
|
1585
1585
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/addinventoryitems
|
1586
1586
|
*/
|
1587
|
-
AddInventoryItems(request: AddInventoryItemsRequest,
|
1587
|
+
AddInventoryItems(request: AddInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<AddInventoryItemsResponse>;
|
1588
1588
|
/**
|
1589
1589
|
* Creates a new item in the working catalog using provided metadata. Note: SAS tokens provided are valid for 1 hour.
|
1590
1590
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/createdraftitem
|
1591
1591
|
*/
|
1592
|
-
CreateDraftItem(request: CreateDraftItemRequest,
|
1592
|
+
CreateDraftItem(request: CreateDraftItemRequest, extraHeaders?: Record<string, string>): Promise<CreateDraftItemResponse>;
|
1593
1593
|
/**
|
1594
1594
|
* Creates one or more upload URLs which can be used by the client to upload raw file data. Content URls and uploaded
|
1595
1595
|
* content will be garbage collected after 24 hours if not attached to a draft or published item. Detailed pricing info
|
@@ -1597,28 +1597,28 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1597
1597
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/pricing/meters/catalog-meters
|
1598
1598
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/createuploadurls
|
1599
1599
|
*/
|
1600
|
-
CreateUploadUrls(request: CreateUploadUrlsRequest,
|
1600
|
+
CreateUploadUrls(request: CreateUploadUrlsRequest, extraHeaders?: Record<string, string>): Promise<CreateUploadUrlsResponse>;
|
1601
1601
|
/**
|
1602
1602
|
* Deletes all reviews, helpfulness votes, and ratings submitted by the entity specified.
|
1603
1603
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/deleteentityitemreviews
|
1604
1604
|
*/
|
1605
|
-
DeleteEntityItemReviews(request: DeleteEntityItemReviewsRequest,
|
1605
|
+
DeleteEntityItemReviews(request: DeleteEntityItemReviewsRequest, extraHeaders?: Record<string, string>): Promise<DeleteEntityItemReviewsResponse>;
|
1606
1606
|
/**
|
1607
1607
|
* Delete an Inventory Collection. More information about Inventory Collections can be found here:
|
1608
1608
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/collections
|
1609
1609
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/deleteinventorycollection
|
1610
1610
|
*/
|
1611
|
-
DeleteInventoryCollection(request: DeleteInventoryCollectionRequest,
|
1611
|
+
DeleteInventoryCollection(request: DeleteInventoryCollectionRequest, extraHeaders?: Record<string, string>): Promise<DeleteInventoryCollectionResponse>;
|
1612
1612
|
/**
|
1613
1613
|
* Delete inventory items
|
1614
1614
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/deleteinventoryitems
|
1615
1615
|
*/
|
1616
|
-
DeleteInventoryItems(request: DeleteInventoryItemsRequest,
|
1616
|
+
DeleteInventoryItems(request: DeleteInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<DeleteInventoryItemsResponse>;
|
1617
1617
|
/**
|
1618
1618
|
* Removes an item from working catalog and all published versions from the public catalog.
|
1619
1619
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/deleteitem
|
1620
1620
|
*/
|
1621
|
-
DeleteItem(request: DeleteItemRequest,
|
1621
|
+
DeleteItem(request: DeleteItemRequest, extraHeaders?: Record<string, string>): Promise<DeleteItemResponse>;
|
1622
1622
|
/**
|
1623
1623
|
* Execute a list of Inventory Operations. A maximum list of 50 operations can be performed by a single request. There is
|
1624
1624
|
* also a limit to 300 items that can be modified/added in a single request. For example, adding a bundle with 50 items
|
@@ -1626,7 +1626,7 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1626
1626
|
* RPS compared to an individual inventory operation with Player Entities limited to 60 requests in 90 seconds.
|
1627
1627
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/executeinventoryoperations
|
1628
1628
|
*/
|
1629
|
-
ExecuteInventoryOperations(request: ExecuteInventoryOperationsRequest,
|
1629
|
+
ExecuteInventoryOperations(request: ExecuteInventoryOperationsRequest, extraHeaders?: Record<string, string>): Promise<ExecuteInventoryOperationsResponse>;
|
1630
1630
|
/**
|
1631
1631
|
* Transfer a list of inventory items. A maximum list of 50 operations can be performed by a single request. When the
|
1632
1632
|
* response code is 202, one or more operations did not complete within the timeframe of the request. You can identify the
|
@@ -1634,14 +1634,14 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1634
1634
|
* within 1 day of the request by passing the TransactionToken to the GetInventoryOperationStatus API.
|
1635
1635
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/executetransferoperations
|
1636
1636
|
*/
|
1637
|
-
ExecuteTransferOperations(request: ExecuteTransferOperationsRequest,
|
1637
|
+
ExecuteTransferOperations(request: ExecuteTransferOperationsRequest, extraHeaders?: Record<string, string>): Promise<ExecuteTransferOperationsResponse>;
|
1638
1638
|
/**
|
1639
1639
|
* Gets the configuration for the catalog. Only Title Entities can call this API. There is a limit of 100 requests in 10
|
1640
1640
|
* seconds for this API. More information about the Catalog Config can be found here:
|
1641
1641
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings
|
1642
1642
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/getcatalogconfig
|
1643
1643
|
*/
|
1644
|
-
GetCatalogConfig(request: GetCatalogConfigRequest,
|
1644
|
+
GetCatalogConfig(request: GetCatalogConfigRequest, extraHeaders?: Record<string, string>): Promise<GetCatalogConfigResponse>;
|
1645
1645
|
/**
|
1646
1646
|
* Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem
|
1647
1647
|
* does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note
|
@@ -1649,52 +1649,52 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1649
1649
|
* valid for 1 hour.
|
1650
1650
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/getdraftitem
|
1651
1651
|
*/
|
1652
|
-
GetDraftItem(request: GetDraftItemRequest,
|
1652
|
+
GetDraftItem(request: GetDraftItemRequest, extraHeaders?: Record<string, string>): Promise<GetDraftItemResponse>;
|
1653
1653
|
/**
|
1654
1654
|
* Retrieves a paginated list of the items from the draft catalog. Up to 50 IDs can be retrieved in a single request.
|
1655
1655
|
* GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. Note:
|
1656
1656
|
* SAS tokens provided are valid for 1 hour.
|
1657
1657
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/getdraftitems
|
1658
1658
|
*/
|
1659
|
-
GetDraftItems(request: GetDraftItemsRequest,
|
1659
|
+
GetDraftItems(request: GetDraftItemsRequest, extraHeaders?: Record<string, string>): Promise<GetDraftItemsResponse>;
|
1660
1660
|
/**
|
1661
1661
|
* Retrieves a paginated list of the items from the draft catalog created by the Entity. Up to 50 items can be returned at
|
1662
1662
|
* once. You can use continuation tokens to paginate through results that return greater than the limit.
|
1663
1663
|
* GetEntityDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates.
|
1664
1664
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/getentitydraftitems
|
1665
1665
|
*/
|
1666
|
-
GetEntityDraftItems(request: GetEntityDraftItemsRequest,
|
1666
|
+
GetEntityDraftItems(request: GetEntityDraftItemsRequest, extraHeaders?: Record<string, string>): Promise<GetEntityDraftItemsResponse>;
|
1667
1667
|
/**
|
1668
1668
|
* Gets the submitted review for the specified item by the authenticated entity. Individual ratings and reviews data update
|
1669
1669
|
* in near real time with delays within a few seconds.
|
1670
1670
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/getentityitemreview
|
1671
1671
|
*/
|
1672
|
-
GetEntityItemReview(request: GetEntityItemReviewRequest,
|
1672
|
+
GetEntityItemReview(request: GetEntityItemReviewRequest, extraHeaders?: Record<string, string>): Promise<GetEntityItemReviewResponse>;
|
1673
1673
|
/**
|
1674
1674
|
* Get Inventory Collection Ids. Up to 50 Ids can be returned at once (or 250 with response compression enabled). You can
|
1675
1675
|
* use continuation tokens to paginate through results that return greater than the limit. It can take a few seconds for
|
1676
1676
|
* new collection Ids to show up.
|
1677
1677
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/getinventorycollectionids
|
1678
1678
|
*/
|
1679
|
-
GetInventoryCollectionIds(request: GetInventoryCollectionIdsRequest,
|
1679
|
+
GetInventoryCollectionIds(request: GetInventoryCollectionIdsRequest, extraHeaders?: Record<string, string>): Promise<GetInventoryCollectionIdsResponse>;
|
1680
1680
|
/**
|
1681
1681
|
* Get current inventory items.
|
1682
1682
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/getinventoryitems
|
1683
1683
|
*/
|
1684
|
-
GetInventoryItems(request: GetInventoryItemsRequest,
|
1684
|
+
GetInventoryItems(request: GetInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<GetInventoryItemsResponse>;
|
1685
1685
|
/**
|
1686
1686
|
* Get the status of an inventory operation using an OperationToken. You can check on the operation status at anytime
|
1687
1687
|
* within 1 day of the request by passing the TransactionToken to the this API.
|
1688
1688
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/getinventoryoperationstatus
|
1689
1689
|
*/
|
1690
|
-
GetInventoryOperationStatus(request: GetInventoryOperationStatusRequest,
|
1690
|
+
GetInventoryOperationStatus(request: GetInventoryOperationStatusRequest, extraHeaders?: Record<string, string>): Promise<GetInventoryOperationStatusResponse>;
|
1691
1691
|
/**
|
1692
1692
|
* Retrieves an item from the public catalog. GetItem does not work off a cache of the Catalog and should be used when
|
1693
1693
|
* trying to get recent item updates. However, please note that item references data is cached and may take a few moments
|
1694
1694
|
* for changes to propagate.
|
1695
1695
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitem
|
1696
1696
|
*/
|
1697
|
-
GetItem(request: GetItemRequest,
|
1697
|
+
GetItem(request: GetItemRequest, extraHeaders?: Record<string, string>): Promise<GetItemResponse>;
|
1698
1698
|
/**
|
1699
1699
|
* Search for a given item and return a set of bundles and stores containing the item. Up to 50 items can be returned at
|
1700
1700
|
* once. You can use continuation tokens to paginate through results that return greater than the limit. This API is
|
@@ -1702,108 +1702,108 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1702
1702
|
* seconds and Title Entities limited to 100 requests in 10 seconds.
|
1703
1703
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitemcontainers
|
1704
1704
|
*/
|
1705
|
-
GetItemContainers(request: GetItemContainersRequest,
|
1705
|
+
GetItemContainers(request: GetItemContainersRequest, extraHeaders?: Record<string, string>): Promise<GetItemContainersResponse>;
|
1706
1706
|
/**
|
1707
1707
|
* Gets the moderation state for an item, including the concern category and string reason. More information about
|
1708
1708
|
* moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation
|
1709
1709
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitemmoderationstate
|
1710
1710
|
*/
|
1711
|
-
GetItemModerationState(request: GetItemModerationStateRequest,
|
1711
|
+
GetItemModerationState(request: GetItemModerationStateRequest, extraHeaders?: Record<string, string>): Promise<GetItemModerationStateResponse>;
|
1712
1712
|
/**
|
1713
1713
|
* Gets the status of a publish of an item.
|
1714
1714
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitempublishstatus
|
1715
1715
|
*/
|
1716
|
-
GetItemPublishStatus(request: GetItemPublishStatusRequest,
|
1716
|
+
GetItemPublishStatus(request: GetItemPublishStatusRequest, extraHeaders?: Record<string, string>): Promise<GetItemPublishStatusResponse>;
|
1717
1717
|
/**
|
1718
1718
|
* Get a paginated set of reviews associated with the specified item. Individual ratings and reviews data update in near
|
1719
1719
|
* real time with delays within a few seconds.
|
1720
1720
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitemreviews
|
1721
1721
|
*/
|
1722
|
-
GetItemReviews(request: GetItemReviewsRequest,
|
1722
|
+
GetItemReviews(request: GetItemReviewsRequest, extraHeaders?: Record<string, string>): Promise<GetItemReviewsResponse>;
|
1723
1723
|
/**
|
1724
1724
|
* Get a summary of all ratings and reviews associated with the specified item. Summary ratings data is cached with update
|
1725
1725
|
* data coming within 15 minutes.
|
1726
1726
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitemreviewsummary
|
1727
1727
|
*/
|
1728
|
-
GetItemReviewSummary(request: GetItemReviewSummaryRequest,
|
1728
|
+
GetItemReviewSummary(request: GetItemReviewSummaryRequest, extraHeaders?: Record<string, string>): Promise<GetItemReviewSummaryResponse>;
|
1729
1729
|
/**
|
1730
1730
|
* Retrieves items from the public catalog. Up to 50 items can be returned at once. GetItems does not work off a cache of
|
1731
1731
|
* the Catalog and should be used when trying to get recent item updates. However, please note that item references data is
|
1732
1732
|
* cached and may take a few moments for changes to propagate.
|
1733
1733
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitems
|
1734
1734
|
*/
|
1735
|
-
GetItems(request: GetItemsRequest,
|
1735
|
+
GetItems(request: GetItemsRequest, extraHeaders?: Record<string, string>): Promise<GetItemsResponse>;
|
1736
1736
|
/**
|
1737
1737
|
* Gets the access tokens.
|
1738
1738
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/getmicrosoftstoreaccesstokens
|
1739
1739
|
*/
|
1740
|
-
GetMicrosoftStoreAccessTokens(request: GetMicrosoftStoreAccessTokensRequest,
|
1740
|
+
GetMicrosoftStoreAccessTokens(request: GetMicrosoftStoreAccessTokensRequest, extraHeaders?: Record<string, string>): Promise<GetMicrosoftStoreAccessTokensResponse>;
|
1741
1741
|
/**
|
1742
1742
|
* Get transaction history for a player. Up to 250 Events can be returned at once. You can use continuation tokens to
|
1743
1743
|
* paginate through results that return greater than the limit. Getting transaction history has a lower RPS limit than
|
1744
1744
|
* getting a Player's inventory with Player Entities having a limit of 30 requests in 300 seconds.
|
1745
1745
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/gettransactionhistory
|
1746
1746
|
*/
|
1747
|
-
GetTransactionHistory(request: GetTransactionHistoryRequest,
|
1747
|
+
GetTransactionHistory(request: GetTransactionHistoryRequest, extraHeaders?: Record<string, string>): Promise<GetTransactionHistoryResponse>;
|
1748
1748
|
/**
|
1749
1749
|
* Initiates a publish of an item from the working catalog to the public catalog. You can use the GetItemPublishStatus API
|
1750
1750
|
* to track the state of the item publish.
|
1751
1751
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/publishdraftitem
|
1752
1752
|
*/
|
1753
|
-
PublishDraftItem(request: PublishDraftItemRequest,
|
1753
|
+
PublishDraftItem(request: PublishDraftItemRequest, extraHeaders?: Record<string, string>): Promise<PublishDraftItemResponse>;
|
1754
1754
|
/**
|
1755
1755
|
* Purchase an item or bundle. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is
|
1756
1756
|
* uncapped.
|
1757
1757
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/purchaseinventoryitems
|
1758
1758
|
*/
|
1759
|
-
PurchaseInventoryItems(request: PurchaseInventoryItemsRequest,
|
1759
|
+
PurchaseInventoryItems(request: PurchaseInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<PurchaseInventoryItemsResponse>;
|
1760
1760
|
/**
|
1761
1761
|
* Redeem items.
|
1762
1762
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemappleappstoreinventoryitems
|
1763
1763
|
*/
|
1764
|
-
RedeemAppleAppStoreInventoryItems(request: RedeemAppleAppStoreInventoryItemsRequest,
|
1764
|
+
RedeemAppleAppStoreInventoryItems(request: RedeemAppleAppStoreInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RedeemAppleAppStoreInventoryItemsResponse>;
|
1765
1765
|
/**
|
1766
1766
|
* Redeem items.
|
1767
1767
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemgoogleplayinventoryitems
|
1768
1768
|
*/
|
1769
|
-
RedeemGooglePlayInventoryItems(request: RedeemGooglePlayInventoryItemsRequest,
|
1769
|
+
RedeemGooglePlayInventoryItems(request: RedeemGooglePlayInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RedeemGooglePlayInventoryItemsResponse>;
|
1770
1770
|
/**
|
1771
1771
|
* Redeem items.
|
1772
1772
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemmicrosoftstoreinventoryitems
|
1773
1773
|
*/
|
1774
|
-
RedeemMicrosoftStoreInventoryItems(request: RedeemMicrosoftStoreInventoryItemsRequest,
|
1774
|
+
RedeemMicrosoftStoreInventoryItems(request: RedeemMicrosoftStoreInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RedeemMicrosoftStoreInventoryItemsResponse>;
|
1775
1775
|
/**
|
1776
1776
|
* Redeem items.
|
1777
1777
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemnintendoeshopinventoryitems
|
1778
1778
|
*/
|
1779
|
-
RedeemNintendoEShopInventoryItems(request: RedeemNintendoEShopInventoryItemsRequest,
|
1779
|
+
RedeemNintendoEShopInventoryItems(request: RedeemNintendoEShopInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RedeemNintendoEShopInventoryItemsResponse>;
|
1780
1780
|
/**
|
1781
1781
|
* Redeem items.
|
1782
1782
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemplaystationstoreinventoryitems
|
1783
1783
|
*/
|
1784
|
-
RedeemPlayStationStoreInventoryItems(request: RedeemPlayStationStoreInventoryItemsRequest,
|
1784
|
+
RedeemPlayStationStoreInventoryItems(request: RedeemPlayStationStoreInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RedeemPlayStationStoreInventoryItemsResponse>;
|
1785
1785
|
/**
|
1786
1786
|
* Redeem items.
|
1787
1787
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemsteaminventoryitems
|
1788
1788
|
*/
|
1789
|
-
RedeemSteamInventoryItems(request: RedeemSteamInventoryItemsRequest,
|
1789
|
+
RedeemSteamInventoryItems(request: RedeemSteamInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RedeemSteamInventoryItemsResponse>;
|
1790
1790
|
/**
|
1791
1791
|
* Submit a report for an item, indicating in what way the item is inappropriate.
|
1792
1792
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/reportitem
|
1793
1793
|
*/
|
1794
|
-
ReportItem(request: ReportItemRequest,
|
1794
|
+
ReportItem(request: ReportItemRequest, extraHeaders?: Record<string, string>): Promise<ReportItemResponse>;
|
1795
1795
|
/**
|
1796
1796
|
* Submit a report for a review
|
1797
1797
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/reportitemreview
|
1798
1798
|
*/
|
1799
|
-
ReportItemReview(request: ReportItemReviewRequest,
|
1799
|
+
ReportItemReview(request: ReportItemReviewRequest, extraHeaders?: Record<string, string>): Promise<ReportItemReviewResponse>;
|
1800
1800
|
/**
|
1801
1801
|
* Creates or updates a review for the specified item. More information around the caching surrounding item ratings and
|
1802
1802
|
* reviews can be found here:
|
1803
1803
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/ratings#ratings-design-and-caching
|
1804
1804
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/reviewitem
|
1805
1805
|
*/
|
1806
|
-
ReviewItem(request: ReviewItemRequest,
|
1806
|
+
ReviewItem(request: ReviewItemRequest, extraHeaders?: Record<string, string>): Promise<ReviewItemResponse>;
|
1807
1807
|
/**
|
1808
1808
|
* Executes a search against the public catalog using the provided search parameters and returns a set of paginated
|
1809
1809
|
* results. SearchItems uses a cache of the catalog with item updates taking up to a few minutes to propagate. You should
|
@@ -1811,28 +1811,28 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1811
1811
|
* found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search
|
1812
1812
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/searchitems
|
1813
1813
|
*/
|
1814
|
-
SearchItems(request: SearchItemsRequest,
|
1814
|
+
SearchItems(request: SearchItemsRequest, extraHeaders?: Record<string, string>): Promise<SearchItemsResponse>;
|
1815
1815
|
/**
|
1816
1816
|
* Sets the moderation state for an item, including the concern category and string reason. More information about
|
1817
1817
|
* moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation
|
1818
1818
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/setitemmoderationstate
|
1819
1819
|
*/
|
1820
|
-
SetItemModerationState(request: SetItemModerationStateRequest,
|
1820
|
+
SetItemModerationState(request: SetItemModerationStateRequest, extraHeaders?: Record<string, string>): Promise<SetItemModerationStateResponse>;
|
1821
1821
|
/**
|
1822
1822
|
* Submit a vote for a review, indicating whether the review was helpful or unhelpful.
|
1823
1823
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/submititemreviewvote
|
1824
1824
|
*/
|
1825
|
-
SubmitItemReviewVote(request: SubmitItemReviewVoteRequest,
|
1825
|
+
SubmitItemReviewVote(request: SubmitItemReviewVoteRequest, extraHeaders?: Record<string, string>): Promise<SubmitItemReviewVoteResponse>;
|
1826
1826
|
/**
|
1827
1827
|
* Subtract inventory items.
|
1828
1828
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/subtractinventoryitems
|
1829
1829
|
*/
|
1830
|
-
SubtractInventoryItems(request: SubtractInventoryItemsRequest,
|
1830
|
+
SubtractInventoryItems(request: SubtractInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<SubtractInventoryItemsResponse>;
|
1831
1831
|
/**
|
1832
1832
|
* Submit a request to takedown one or more reviews.
|
1833
1833
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/takedownitemreviews
|
1834
1834
|
*/
|
1835
|
-
TakedownItemReviews(request: TakedownItemReviewsRequest,
|
1835
|
+
TakedownItemReviews(request: TakedownItemReviewsRequest, extraHeaders?: Record<string, string>): Promise<TakedownItemReviewsResponse>;
|
1836
1836
|
/**
|
1837
1837
|
* Transfer inventory items. When transferring across collections, a 202 response indicates that the transfer did not
|
1838
1838
|
* complete within the timeframe of the request. You can identify the pending operations by looking for OperationStatus =
|
@@ -1842,24 +1842,24 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1842
1842
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/?tabs=inventory-game-manager#transfer-inventory-items
|
1843
1843
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/transferinventoryitems
|
1844
1844
|
*/
|
1845
|
-
TransferInventoryItems(request: TransferInventoryItemsRequest,
|
1845
|
+
TransferInventoryItems(request: TransferInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<TransferInventoryItemsResponse>;
|
1846
1846
|
/**
|
1847
1847
|
* Updates the configuration for the catalog. Only Title Entities can call this API. There is a limit of 10 requests in 10
|
1848
1848
|
* seconds for this API. More information about the Catalog Config can be found here:
|
1849
1849
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings
|
1850
1850
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/updatecatalogconfig
|
1851
1851
|
*/
|
1852
|
-
UpdateCatalogConfig(request: UpdateCatalogConfigRequest,
|
1852
|
+
UpdateCatalogConfig(request: UpdateCatalogConfigRequest, extraHeaders?: Record<string, string>): Promise<UpdateCatalogConfigResponse>;
|
1853
1853
|
/**
|
1854
1854
|
* Update the metadata for an item in the working catalog. Note: SAS tokens provided are valid for 1 hour.
|
1855
1855
|
* https://docs.microsoft.com/rest/api/playfab/economy/catalog/updatedraftitem
|
1856
1856
|
*/
|
1857
|
-
UpdateDraftItem(request: UpdateDraftItemRequest,
|
1857
|
+
UpdateDraftItem(request: UpdateDraftItemRequest, extraHeaders?: Record<string, string>): Promise<UpdateDraftItemResponse>;
|
1858
1858
|
/**
|
1859
1859
|
* Update inventory items
|
1860
1860
|
* https://docs.microsoft.com/rest/api/playfab/economy/inventory/updateinventoryitems
|
1861
1861
|
*/
|
1862
|
-
UpdateInventoryItems(request: UpdateInventoryItemsRequest,
|
1862
|
+
UpdateInventoryItems(request: UpdateInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateInventoryItemsResponse>;
|
1863
1863
|
}
|
1864
1864
|
|
1865
1865
|
export { PlayFabEconomyApi as default };
|