async-playfab-web-sdk 1.192.250526-3 → 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 +179 -39
- package/dist/Addon.js +2 -2
- package/dist/Admin.d.ts +2386 -195
- package/dist/Admin.js +2 -2
- package/dist/Authentication.d.ts +32 -5
- package/dist/Authentication.js +2 -2
- package/dist/Client.d.ts +2235 -321
- package/dist/Client.js +2 -2
- package/dist/CloudScript.d.ts +199 -31
- package/dist/CloudScript.js +2 -2
- package/dist/Data.d.ts +137 -18
- package/dist/Data.js +2 -2
- package/dist/Economy.d.ts +1145 -106
- package/dist/Economy.js +2 -2
- package/dist/Events.d.ts +200 -13
- package/dist/Events.js +2 -2
- package/dist/Experimentation.d.ts +164 -17
- package/dist/Experimentation.js +2 -2
- package/dist/Groups.d.ts +267 -28
- package/dist/Groups.js +2 -2
- package/dist/Insights.d.ts +33 -7
- package/dist/Insights.js +2 -2
- package/dist/Localization.d.ts +5 -2
- 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 +2697 -169
- package/dist/Multiplayer.js +2 -2
- package/dist/{PlayFabCommon-BX3jSqGx.d.ts → PlayFabCommon-Dnp_xHg5.d.ts} +3 -5
- package/dist/Profiles.d.ts +163 -19
- package/dist/Profiles.js +2 -2
- package/dist/Progression.d.ts +287 -35
- package/dist/Progression.js +2 -2
- package/dist/Server.d.ts +1904 -242
- 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-J4QS5VX5.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-SGSEOIKS.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-A7VD6ALV.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-X34XZJB6.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-JGDO2ZE3.js → chunk-SR2RIRLX.js} +1482 -175
- package/dist/chunk-SR2RIRLX.js.map +1 -0
- package/dist/{chunk-62SULWOK.js → chunk-XVDYM74A.js} +17 -14
- 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 +7 -6
- package/dist/index.js +29 -25
- package/package.json +2 -2
- package/dist/chunk-3FCAP7OZ.js +0 -187
- package/dist/chunk-3FCAP7OZ.js.map +0 -1
- package/dist/chunk-62SULWOK.js.map +0 -1
- package/dist/chunk-A7VD6ALV.js.map +0 -1
- package/dist/chunk-BX65UND2.js +0 -632
- package/dist/chunk-BX65UND2.js.map +0 -1
- package/dist/chunk-J4QS5VX5.js.map +0 -1
- package/dist/chunk-JGDO2ZE3.js.map +0 -1
- package/dist/chunk-POMI7LEF.js +0 -76
- package/dist/chunk-POMI7LEF.js.map +0 -1
- package/dist/chunk-Q3OF3AOJ.js +0 -97
- package/dist/chunk-Q3OF3AOJ.js.map +0 -1
- package/dist/chunk-QUZHVSVZ.js +0 -174
- package/dist/chunk-QUZHVSVZ.js.map +0 -1
- package/dist/chunk-QVLIVSO4.js +0 -1147
- package/dist/chunk-QVLIVSO4.js.map +0 -1
- package/dist/chunk-R7V7DFCF.js +0 -103
- package/dist/chunk-R7V7DFCF.js.map +0 -1
- package/dist/chunk-SGSEOIKS.js.map +0 -1
- package/dist/chunk-UOHHNVCJ.js +0 -119
- package/dist/chunk-UOHHNVCJ.js.map +0 -1
- package/dist/chunk-USKFWNQK.js +0 -384
- package/dist/chunk-USKFWNQK.js.map +0 -1
- package/dist/chunk-UX7LFJCX.js +0 -61
- package/dist/chunk-UX7LFJCX.js.map +0 -1
- package/dist/chunk-X34XZJB6.js.map +0 -1
- package/dist/chunk-YNZF3WXS.js +0 -882
- package/dist/chunk-YNZF3WXS.js.map +0 -1
@@ -0,0 +1,1048 @@
|
|
1
|
+
import {
|
2
|
+
PlayFabCommon
|
3
|
+
} from "./chunk-XVDYM74A.js";
|
4
|
+
|
5
|
+
// src/apis/PlayFabEconomyApi.ts
|
6
|
+
var PlayFabEconomyApi = class extends PlayFabCommon {
|
7
|
+
/**
|
8
|
+
* Add inventory items. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is uncapped.
|
9
|
+
*
|
10
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/addinventoryitems Microsoft Documentation}
|
11
|
+
* @example
|
12
|
+
* await inventoryClient.AddInventoryItems({
|
13
|
+
* "Item": {
|
14
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
15
|
+
* },
|
16
|
+
* "Amount": 3,
|
17
|
+
* "ReturnInventory": false
|
18
|
+
* });
|
19
|
+
*/
|
20
|
+
AddInventoryItems(request, extraHeaders) {
|
21
|
+
return this.ExecuteRequestWrapper("/Inventory/AddInventoryItems", request, "X-EntityToken", extraHeaders);
|
22
|
+
}
|
23
|
+
/**
|
24
|
+
* Given an existing Versioned Catalog, begin the process of validating the uploaded JSON and creating the described items.
|
25
|
+
*
|
26
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/completeversionedcatalogupload Microsoft Documentation}
|
27
|
+
* @example
|
28
|
+
* await versionedcatalogClient.CompleteVersionedCatalogUpload({});
|
29
|
+
*/
|
30
|
+
CompleteVersionedCatalogUpload(request, extraHeaders) {
|
31
|
+
return this.ExecuteRequestWrapper("/VersionedCatalog/CompleteVersionedCatalogUpload", request, "X-EntityToken", extraHeaders);
|
32
|
+
}
|
33
|
+
/**
|
34
|
+
* Creates a new item in the working catalog using provided metadata. Note: SAS tokens provided are valid for 1 hour.
|
35
|
+
*
|
36
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/createdraftitem Microsoft Documentation}
|
37
|
+
* @example
|
38
|
+
* await catalogClient.CreateDraftItem({
|
39
|
+
* "Item": {
|
40
|
+
* "Type": "ugc",
|
41
|
+
* "Title": {
|
42
|
+
* "NEUTRAL": "Neutral title",
|
43
|
+
* "en-US": "US English title"
|
44
|
+
* },
|
45
|
+
* "Description": {
|
46
|
+
* "NEUTRAL": "Neutral description",
|
47
|
+
* "en-US": "US English description"
|
48
|
+
* },
|
49
|
+
* "Keywords": {
|
50
|
+
* "NEUTRAL": {
|
51
|
+
* "Values": [
|
52
|
+
* "Keyword_1",
|
53
|
+
* "Keyword_2"
|
54
|
+
* ]
|
55
|
+
* }
|
56
|
+
* },
|
57
|
+
* "ContentType": "example item",
|
58
|
+
* "CreatorEntity": {
|
59
|
+
* "Id": "someId",
|
60
|
+
* "Type": "title_player_account",
|
61
|
+
* "TypeString": "title_player_account"
|
62
|
+
* },
|
63
|
+
* "IsHidden": false,
|
64
|
+
* "Tags": [
|
65
|
+
* "pirates",
|
66
|
+
* "holiday"
|
67
|
+
* ],
|
68
|
+
* "DisplayVersion": "1.0.0",
|
69
|
+
* "CreationDate": "2018-08-17T22:32:10.472Z",
|
70
|
+
* "Contents": [
|
71
|
+
* {
|
72
|
+
* "Id": "00000000-0000-0000-0000-000000000001",
|
73
|
+
* "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
|
74
|
+
* "MaxClientVersion": "2.4.1",
|
75
|
+
* "MinClientVersion": "2.0.0"
|
76
|
+
* }
|
77
|
+
* ],
|
78
|
+
* "Images": [
|
79
|
+
* {
|
80
|
+
* "Id": "00000000-0000-0000-0000-000000000003",
|
81
|
+
* "Type": "Thumbnail",
|
82
|
+
* "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
|
83
|
+
* }
|
84
|
+
* ],
|
85
|
+
* "DisplayProperties": {
|
86
|
+
* "mapDetails": {
|
87
|
+
* "mapType": "desertIsland",
|
88
|
+
* "gameMode": "capture",
|
89
|
+
* "maxPlayers": 16
|
90
|
+
* },
|
91
|
+
* "averageMatchLengthInSeconds": 947
|
92
|
+
* },
|
93
|
+
* "DefaultStackId": "Static_Default_Stack_Id"
|
94
|
+
* },
|
95
|
+
* "Publish": false
|
96
|
+
* });
|
97
|
+
*/
|
98
|
+
CreateDraftItem(request, extraHeaders) {
|
99
|
+
return this.ExecuteRequestWrapper("/Catalog/CreateDraftItem", request, "X-EntityToken", extraHeaders);
|
100
|
+
}
|
101
|
+
/**
|
102
|
+
* Creates one or more upload URLs which can be used by the client to upload raw file data. Content URls and uploaded
|
103
|
+
* content will be garbage collected after 24 hours if not attached to a draft or published item. Detailed pricing info
|
104
|
+
* around uploading content can be found here:
|
105
|
+
* https://learn.microsoft.com/en-us/gaming/playfab/features/pricing/meters/catalog-meters
|
106
|
+
*
|
107
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/createuploadurls Microsoft Documentation}
|
108
|
+
* @example
|
109
|
+
* await catalogClient.CreateUploadUrls({
|
110
|
+
* "Files": [
|
111
|
+
* {
|
112
|
+
* "FileName": "textures.zip"
|
113
|
+
* },
|
114
|
+
* {
|
115
|
+
* "FileName": "sprites.png"
|
116
|
+
* }
|
117
|
+
* ]
|
118
|
+
* });
|
119
|
+
*/
|
120
|
+
CreateUploadUrls(request, extraHeaders) {
|
121
|
+
return this.ExecuteRequestWrapper("/Catalog/CreateUploadUrls", request, "X-EntityToken", extraHeaders);
|
122
|
+
}
|
123
|
+
/**
|
124
|
+
* Given an existing Catalog Version, create an URL location where titles can upload a JSON schema of a catalog, if the
|
125
|
+
* catalog is empty.
|
126
|
+
*
|
127
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/createversionedcataloguploadurl Microsoft Documentation}
|
128
|
+
* @example
|
129
|
+
* await versionedcatalogClient.CreateVersionedCatalogUploadURL({});
|
130
|
+
*/
|
131
|
+
CreateVersionedCatalogUploadURL(request, extraHeaders) {
|
132
|
+
return this.ExecuteRequestWrapper("/VersionedCatalog/CreateVersionedCatalogUploadURL", request, "X-EntityToken", extraHeaders);
|
133
|
+
}
|
134
|
+
/**
|
135
|
+
* Creates a new view in the catalog using provided metadata.
|
136
|
+
*
|
137
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/createview Microsoft Documentation}
|
138
|
+
* @example
|
139
|
+
* await catalogClient.CreateView({
|
140
|
+
* "View": {
|
141
|
+
* "FriendlyId": "exampleView",
|
142
|
+
* "IsTitleView": false,
|
143
|
+
* "Count": 10,
|
144
|
+
* "Filter": "tags/any(t:t eq 'desert') and contentType eq 'map'",
|
145
|
+
* "Language": "en-US",
|
146
|
+
* "FileFormat": "JsonLines"
|
147
|
+
* }
|
148
|
+
* });
|
149
|
+
*/
|
150
|
+
CreateView(request, extraHeaders) {
|
151
|
+
return this.ExecuteRequestWrapper("/Catalog/CreateView", request, "X-EntityToken", extraHeaders);
|
152
|
+
}
|
153
|
+
/**
|
154
|
+
* Deletes all reviews, helpfulness votes, and ratings submitted by the entity specified.
|
155
|
+
*
|
156
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/deleteentityitemreviews Microsoft Documentation}
|
157
|
+
* @example
|
158
|
+
* await catalogClient.DeleteEntityItemReviews({
|
159
|
+
* "Entity": {
|
160
|
+
* "Id": "ABC123",
|
161
|
+
* "Type": "title_player_account",
|
162
|
+
* "TypeString": "title_player_account"
|
163
|
+
* }
|
164
|
+
* });
|
165
|
+
*/
|
166
|
+
DeleteEntityItemReviews(request, extraHeaders) {
|
167
|
+
return this.ExecuteRequestWrapper("/Catalog/DeleteEntityItemReviews", request, "X-EntityToken", extraHeaders);
|
168
|
+
}
|
169
|
+
/**
|
170
|
+
* Delete an Inventory Collection. More information about Inventory Collections can be found here:
|
171
|
+
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/collections
|
172
|
+
*
|
173
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/deleteinventorycollection Microsoft Documentation}
|
174
|
+
* @example
|
175
|
+
* await inventoryClient.DeleteInventoryCollection({
|
176
|
+
* "CollectionId": "backpack"
|
177
|
+
* });
|
178
|
+
*/
|
179
|
+
DeleteInventoryCollection(request, extraHeaders) {
|
180
|
+
return this.ExecuteRequestWrapper("/Inventory/DeleteInventoryCollection", request, "X-EntityToken", extraHeaders);
|
181
|
+
}
|
182
|
+
/**
|
183
|
+
* Delete inventory items
|
184
|
+
*
|
185
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/deleteinventoryitems Microsoft Documentation}
|
186
|
+
* @example
|
187
|
+
* await inventoryClient.DeleteInventoryItems({
|
188
|
+
* "Item": {
|
189
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
190
|
+
* }
|
191
|
+
* });
|
192
|
+
*/
|
193
|
+
DeleteInventoryItems(request, extraHeaders) {
|
194
|
+
return this.ExecuteRequestWrapper("/Inventory/DeleteInventoryItems", request, "X-EntityToken", extraHeaders);
|
195
|
+
}
|
196
|
+
/**
|
197
|
+
* Removes an item from working catalog and all published versions from the public catalog.
|
198
|
+
*
|
199
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/deleteitem Microsoft Documentation}
|
200
|
+
* @example
|
201
|
+
* await catalogClient.DeleteItem({
|
202
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
203
|
+
* });
|
204
|
+
*/
|
205
|
+
DeleteItem(request, extraHeaders) {
|
206
|
+
return this.ExecuteRequestWrapper("/Catalog/DeleteItem", request, "X-EntityToken", extraHeaders);
|
207
|
+
}
|
208
|
+
/**
|
209
|
+
* Delete versioned catalog.
|
210
|
+
*
|
211
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/deleteversionedcatalog Microsoft Documentation}
|
212
|
+
* @example
|
213
|
+
* await versionedcatalogClient.DeleteVersionedCatalog({});
|
214
|
+
*/
|
215
|
+
DeleteVersionedCatalog(request, extraHeaders) {
|
216
|
+
return this.ExecuteRequestWrapper("/VersionedCatalog/DeleteVersionedCatalog", request, "X-EntityToken", extraHeaders);
|
217
|
+
}
|
218
|
+
/**
|
219
|
+
* Deletes a catalog view and the associated blob.
|
220
|
+
*
|
221
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/deleteview Microsoft Documentation}
|
222
|
+
* @example
|
223
|
+
* await catalogClient.DeleteView({
|
224
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
225
|
+
* });
|
226
|
+
*/
|
227
|
+
DeleteView(request, extraHeaders) {
|
228
|
+
return this.ExecuteRequestWrapper("/Catalog/DeleteView", request, "X-EntityToken", extraHeaders);
|
229
|
+
}
|
230
|
+
/**
|
231
|
+
* Execute a list of Inventory Operations. A maximum list of 50 operations can be performed by a single request. There is
|
232
|
+
* also a limit to 300 items that can be modified/added in a single request. For example, adding a bundle with 50 items
|
233
|
+
* counts as 50 items modified. All operations must be done within a single inventory collection. This API has a reduced
|
234
|
+
* RPS compared to an individual inventory operation with Player Entities limited to 60 requests in 90 seconds.
|
235
|
+
*
|
236
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/executeinventoryoperations Microsoft Documentation}
|
237
|
+
* @example
|
238
|
+
* await inventoryClient.ExecuteInventoryOperations({
|
239
|
+
* "Operations": [
|
240
|
+
* {
|
241
|
+
* "Add": {
|
242
|
+
* "Item": {
|
243
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
244
|
+
* },
|
245
|
+
* "Amount": 3
|
246
|
+
* }
|
247
|
+
* },
|
248
|
+
* {
|
249
|
+
* "Subtract": {
|
250
|
+
* "Item": {
|
251
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
252
|
+
* },
|
253
|
+
* "Amount": 3,
|
254
|
+
* "DeleteEmptyStacks": false
|
255
|
+
* }
|
256
|
+
* }
|
257
|
+
* ]
|
258
|
+
* });
|
259
|
+
*/
|
260
|
+
ExecuteInventoryOperations(request, extraHeaders) {
|
261
|
+
return this.ExecuteRequestWrapper("/Inventory/ExecuteInventoryOperations", request, "X-EntityToken", extraHeaders);
|
262
|
+
}
|
263
|
+
/**
|
264
|
+
* Transfer a list of inventory items. A maximum list of 50 operations can be performed by a single request. When the
|
265
|
+
* response code is 202, one or more operations did not complete within the timeframe of the request. You can identify the
|
266
|
+
* pending operations by looking for OperationStatus = 'InProgress'. You can check on the operation status at anytime
|
267
|
+
* within 1 day of the request by passing the TransactionToken to the GetInventoryOperationStatus API.
|
268
|
+
*
|
269
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/executetransferoperations Microsoft Documentation}
|
270
|
+
* @example
|
271
|
+
* await inventoryClient.ExecuteTransferOperations({
|
272
|
+
* "Operations": [
|
273
|
+
* {
|
274
|
+
* "GivingItem": {
|
275
|
+
* "Id": "11111111-1111-1111-1111-111111111111",
|
276
|
+
* "StackId": "default"
|
277
|
+
* },
|
278
|
+
* "ReceivingItem": {
|
279
|
+
* "Id": "11111111-1111-1111-1111-111111111111",
|
280
|
+
* "StackId": "default"
|
281
|
+
* },
|
282
|
+
* "Amount": 1,
|
283
|
+
* "DeleteEmptyStacks": false
|
284
|
+
* }
|
285
|
+
* ],
|
286
|
+
* "GivingEntity": {
|
287
|
+
* "Id": "someId1",
|
288
|
+
* "Type": "title_player_account",
|
289
|
+
* "TypeString": "title_player_account"
|
290
|
+
* },
|
291
|
+
* "ReceivingEntity": {
|
292
|
+
* "Id": "someId2",
|
293
|
+
* "Type": "title_player_account",
|
294
|
+
* "TypeString": "title_player_account"
|
295
|
+
* },
|
296
|
+
* "GivingCollectionId": "default",
|
297
|
+
* "ReceivingCollectionId": "backpack"
|
298
|
+
* });
|
299
|
+
*/
|
300
|
+
ExecuteTransferOperations(request, extraHeaders) {
|
301
|
+
return this.ExecuteRequestWrapper("/Inventory/ExecuteTransferOperations", request, "X-EntityToken", extraHeaders);
|
302
|
+
}
|
303
|
+
/**
|
304
|
+
* Export versioned catalog.
|
305
|
+
*
|
306
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/exportversionedcatalog Microsoft Documentation}
|
307
|
+
* @example
|
308
|
+
* await versionedcatalogClient.ExportVersionedCatalog({});
|
309
|
+
*/
|
310
|
+
ExportVersionedCatalog(request, extraHeaders) {
|
311
|
+
return this.ExecuteRequestWrapper("/VersionedCatalog/ExportVersionedCatalog", request, "X-EntityToken", extraHeaders);
|
312
|
+
}
|
313
|
+
/**
|
314
|
+
* Gets the configuration for the catalog. Only Title Entities can call this API. There is a limit of 100 requests in 10
|
315
|
+
* seconds for this API. More information about the Catalog Config can be found here:
|
316
|
+
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings
|
317
|
+
*
|
318
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getcatalogconfig Microsoft Documentation}
|
319
|
+
* @example
|
320
|
+
* await catalogClient.GetCatalogConfig({});
|
321
|
+
*/
|
322
|
+
GetCatalogConfig(request, extraHeaders) {
|
323
|
+
return this.ExecuteRequestWrapper("/Catalog/GetCatalogConfig", request, "X-EntityToken", extraHeaders);
|
324
|
+
}
|
325
|
+
/**
|
326
|
+
* Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem
|
327
|
+
* does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note
|
328
|
+
* that item references data is cached and may take a few moments for changes to propagate. Note: SAS tokens provided are
|
329
|
+
* valid for 1 hour.
|
330
|
+
*
|
331
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getdraftitem Microsoft Documentation}
|
332
|
+
* @example
|
333
|
+
* await catalogClient.GetDraftItem({
|
334
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
335
|
+
* });
|
336
|
+
*/
|
337
|
+
GetDraftItem(request, extraHeaders) {
|
338
|
+
return this.ExecuteRequestWrapper("/Catalog/GetDraftItem", request, "X-EntityToken", extraHeaders);
|
339
|
+
}
|
340
|
+
/**
|
341
|
+
* Retrieves a paginated list of the items from the draft catalog. Up to 50 IDs can be retrieved in a single request.
|
342
|
+
* GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. Note:
|
343
|
+
* SAS tokens provided are valid for 1 hour.
|
344
|
+
*
|
345
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getdraftitems Microsoft Documentation}
|
346
|
+
* @example
|
347
|
+
* await catalogClient.GetDraftItems({
|
348
|
+
* "Ids": [
|
349
|
+
* "dddddddd-dddd-dddd-dddd-dddddddddddd",
|
350
|
+
* "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"
|
351
|
+
* ]
|
352
|
+
* });
|
353
|
+
*/
|
354
|
+
GetDraftItems(request, extraHeaders) {
|
355
|
+
return this.ExecuteRequestWrapper("/Catalog/GetDraftItems", request, "X-EntityToken", extraHeaders);
|
356
|
+
}
|
357
|
+
/**
|
358
|
+
* Retrieves a paginated list of the items from the draft catalog created by the Entity. Up to 50 items can be returned at
|
359
|
+
* once. You can use continuation tokens to paginate through results that return greater than the limit.
|
360
|
+
* GetEntityDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates.
|
361
|
+
*
|
362
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getentitydraftitems Microsoft Documentation}
|
363
|
+
* @example
|
364
|
+
* await catalogClient.GetEntityDraftItems({
|
365
|
+
* "Count": 2,
|
366
|
+
* "Entity": {
|
367
|
+
* "Id": "someId",
|
368
|
+
* "Type": "title_player_account",
|
369
|
+
* "TypeString": "title_player_account"
|
370
|
+
* }
|
371
|
+
* });
|
372
|
+
*/
|
373
|
+
GetEntityDraftItems(request, extraHeaders) {
|
374
|
+
return this.ExecuteRequestWrapper("/Catalog/GetEntityDraftItems", request, "X-EntityToken", extraHeaders);
|
375
|
+
}
|
376
|
+
/**
|
377
|
+
* Gets the submitted review for the specified item by the authenticated entity. Individual ratings and reviews data update
|
378
|
+
* in near real time with delays within a few seconds.
|
379
|
+
*
|
380
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getentityitemreview Microsoft Documentation}
|
381
|
+
* @example
|
382
|
+
* await catalogClient.GetEntityItemReview({
|
383
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
384
|
+
* });
|
385
|
+
*/
|
386
|
+
GetEntityItemReview(request, extraHeaders) {
|
387
|
+
return this.ExecuteRequestWrapper("/Catalog/GetEntityItemReview", request, "X-EntityToken", extraHeaders);
|
388
|
+
}
|
389
|
+
/**
|
390
|
+
* Get Inventory Collection Ids. Up to 50 Ids can be returned at once (or 250 with response compression enabled). You can
|
391
|
+
* use continuation tokens to paginate through results that return greater than the limit. It can take a few seconds for
|
392
|
+
* new collection Ids to show up.
|
393
|
+
*
|
394
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/getinventorycollectionids Microsoft Documentation}
|
395
|
+
* @example
|
396
|
+
* await inventoryClient.GetInventoryCollectionIds({
|
397
|
+
* "Count": 5
|
398
|
+
* });
|
399
|
+
*/
|
400
|
+
GetInventoryCollectionIds(request, extraHeaders) {
|
401
|
+
return this.ExecuteRequestWrapper("/Inventory/GetInventoryCollectionIds", request, "X-EntityToken", extraHeaders);
|
402
|
+
}
|
403
|
+
/**
|
404
|
+
* Get current inventory items.
|
405
|
+
*
|
406
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/getinventoryitems Microsoft Documentation}
|
407
|
+
* @example
|
408
|
+
* await inventoryClient.GetInventoryItems({
|
409
|
+
* "Count": 5
|
410
|
+
* });
|
411
|
+
*/
|
412
|
+
GetInventoryItems(request, extraHeaders) {
|
413
|
+
return this.ExecuteRequestWrapper("/Inventory/GetInventoryItems", request, "X-EntityToken", extraHeaders);
|
414
|
+
}
|
415
|
+
/**
|
416
|
+
* Get the status of an inventory operation using an OperationToken. You can check on the operation status at anytime
|
417
|
+
* within 1 day of the request by passing the TransactionToken to the this API.
|
418
|
+
*
|
419
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/getinventoryoperationstatus Microsoft Documentation}
|
420
|
+
* @example
|
421
|
+
* await inventoryClient.GetInventoryOperationStatus({});
|
422
|
+
*/
|
423
|
+
GetInventoryOperationStatus(request, extraHeaders) {
|
424
|
+
return this.ExecuteRequestWrapper("/Inventory/GetInventoryOperationStatus", request, "X-EntityToken", extraHeaders);
|
425
|
+
}
|
426
|
+
/**
|
427
|
+
* Retrieves an item from the public catalog. GetItem does not work off a cache of the Catalog and should be used when
|
428
|
+
* trying to get recent item updates. However, please note that item references data is cached and may take a few moments
|
429
|
+
* for changes to propagate.
|
430
|
+
*
|
431
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitem Microsoft Documentation}
|
432
|
+
* @example
|
433
|
+
* await catalogClient.GetItem({
|
434
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
435
|
+
* });
|
436
|
+
*/
|
437
|
+
GetItem(request, extraHeaders) {
|
438
|
+
return this.ExecuteRequestWrapper("/Catalog/GetItem", request, "X-EntityToken", extraHeaders);
|
439
|
+
}
|
440
|
+
/**
|
441
|
+
* Search for a given item and return a set of bundles and stores containing the item. Up to 50 items can be returned at
|
442
|
+
* once. You can use continuation tokens to paginate through results that return greater than the limit. This API is
|
443
|
+
* intended for tooling/automation scenarios and has a reduced RPS with Player Entities limited to 30 requests in 300
|
444
|
+
* seconds and Title Entities limited to 100 requests in 10 seconds.
|
445
|
+
*
|
446
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitemcontainers Microsoft Documentation}
|
447
|
+
* @example
|
448
|
+
* await catalogClient.GetItemContainers({
|
449
|
+
* "Count": 5,
|
450
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
451
|
+
* });
|
452
|
+
*/
|
453
|
+
GetItemContainers(request, extraHeaders) {
|
454
|
+
return this.ExecuteRequestWrapper("/Catalog/GetItemContainers", request, "X-EntityToken", extraHeaders);
|
455
|
+
}
|
456
|
+
/**
|
457
|
+
* Gets the moderation state for an item, including the concern category and string reason. More information about
|
458
|
+
* moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation
|
459
|
+
*
|
460
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitemmoderationstate Microsoft Documentation}
|
461
|
+
* @example
|
462
|
+
* await catalogClient.GetItemModerationState({
|
463
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
464
|
+
* });
|
465
|
+
*/
|
466
|
+
GetItemModerationState(request, extraHeaders) {
|
467
|
+
return this.ExecuteRequestWrapper("/Catalog/GetItemModerationState", request, "X-EntityToken", extraHeaders);
|
468
|
+
}
|
469
|
+
/**
|
470
|
+
* Gets the status of a publish of an item.
|
471
|
+
*
|
472
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitempublishstatus Microsoft Documentation}
|
473
|
+
* @example
|
474
|
+
* await catalogClient.GetItemPublishStatus({
|
475
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
476
|
+
* });
|
477
|
+
*/
|
478
|
+
GetItemPublishStatus(request, extraHeaders) {
|
479
|
+
return this.ExecuteRequestWrapper("/Catalog/GetItemPublishStatus", request, "X-EntityToken", extraHeaders);
|
480
|
+
}
|
481
|
+
/**
|
482
|
+
* Get a paginated set of reviews associated with the specified item. Individual ratings and reviews data update in near
|
483
|
+
* real time with delays within a few seconds.
|
484
|
+
*
|
485
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitemreviews Microsoft Documentation}
|
486
|
+
* @example
|
487
|
+
* await catalogClient.GetItemReviews({
|
488
|
+
* "Count": 2,
|
489
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
490
|
+
* });
|
491
|
+
*/
|
492
|
+
GetItemReviews(request, extraHeaders) {
|
493
|
+
return this.ExecuteRequestWrapper("/Catalog/GetItemReviews", request, "X-EntityToken", extraHeaders);
|
494
|
+
}
|
495
|
+
/**
|
496
|
+
* Get a summary of all ratings and reviews associated with the specified item. Summary ratings data is cached with update
|
497
|
+
* data coming within 15 minutes.
|
498
|
+
*
|
499
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitemreviewsummary Microsoft Documentation}
|
500
|
+
* @example
|
501
|
+
* await catalogClient.GetItemReviewSummary({
|
502
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
503
|
+
* });
|
504
|
+
*/
|
505
|
+
GetItemReviewSummary(request, extraHeaders) {
|
506
|
+
return this.ExecuteRequestWrapper("/Catalog/GetItemReviewSummary", request, "X-EntityToken", extraHeaders);
|
507
|
+
}
|
508
|
+
/**
|
509
|
+
* Retrieves items from the public catalog. Up to 50 items can be returned at once. GetItems does not work off a cache of
|
510
|
+
* the Catalog and should be used when trying to get recent item updates. However, please note that item references data is
|
511
|
+
* cached and may take a few moments for changes to propagate.
|
512
|
+
*
|
513
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitems Microsoft Documentation}
|
514
|
+
* @example
|
515
|
+
* await catalogClient.GetItems({
|
516
|
+
* "Ids": [
|
517
|
+
* "dddddddd-dddd-dddd-dddd-dddddddddddd",
|
518
|
+
* "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"
|
519
|
+
* ]
|
520
|
+
* });
|
521
|
+
*/
|
522
|
+
GetItems(request, extraHeaders) {
|
523
|
+
return this.ExecuteRequestWrapper("/Catalog/GetItems", request, "X-EntityToken", extraHeaders);
|
524
|
+
}
|
525
|
+
/**
|
526
|
+
* Gets the access tokens.
|
527
|
+
*
|
528
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/getmicrosoftstoreaccesstokens Microsoft Documentation}
|
529
|
+
* @example
|
530
|
+
* await inventoryClient.GetMicrosoftStoreAccessTokens({});
|
531
|
+
*/
|
532
|
+
GetMicrosoftStoreAccessTokens(request, extraHeaders) {
|
533
|
+
return this.ExecuteRequestWrapper("/Inventory/GetMicrosoftStoreAccessTokens", request, "X-EntityToken", extraHeaders);
|
534
|
+
}
|
535
|
+
/**
|
536
|
+
* Get transaction history for a player. Up to 250 Events can be returned at once. You can use continuation tokens to
|
537
|
+
* paginate through results that return greater than the limit. Getting transaction history has a lower RPS limit than
|
538
|
+
* getting a Player's inventory with Player Entities having a limit of 30 requests in 300 seconds.
|
539
|
+
*
|
540
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/gettransactionhistory Microsoft Documentation}
|
541
|
+
* @example
|
542
|
+
* await inventoryClient.GetTransactionHistory({
|
543
|
+
* "Count": 10,
|
544
|
+
* "CollectionId": "default"
|
545
|
+
* });
|
546
|
+
*/
|
547
|
+
GetTransactionHistory(request, extraHeaders) {
|
548
|
+
return this.ExecuteRequestWrapper("/Inventory/GetTransactionHistory", request, "X-EntityToken", extraHeaders);
|
549
|
+
}
|
550
|
+
/**
|
551
|
+
* Get versioned catalog item.
|
552
|
+
*
|
553
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/getversionedcatalogitem Microsoft Documentation}
|
554
|
+
* @example
|
555
|
+
* await versionedcatalogClient.GetVersionedCatalogItem({});
|
556
|
+
*/
|
557
|
+
GetVersionedCatalogItem(request, extraHeaders) {
|
558
|
+
return this.ExecuteRequestWrapper("/VersionedCatalog/GetVersionedCatalogItem", request, "X-EntityToken", extraHeaders);
|
559
|
+
}
|
560
|
+
/**
|
561
|
+
* Returns the current status of a Versioned Catalog upload.
|
562
|
+
*
|
563
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/getversionedcataloguploadstatus Microsoft Documentation}
|
564
|
+
* @example
|
565
|
+
* await versionedcatalogClient.GetVersionedCatalogUploadStatus({});
|
566
|
+
*/
|
567
|
+
GetVersionedCatalogUploadStatus(request, extraHeaders) {
|
568
|
+
return this.ExecuteRequestWrapper("/VersionedCatalog/GetVersionedCatalogUploadStatus", request, "X-EntityToken", extraHeaders);
|
569
|
+
}
|
570
|
+
/**
|
571
|
+
* Retrieves a specific catalog view.
|
572
|
+
*
|
573
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getview Microsoft Documentation}
|
574
|
+
* @example
|
575
|
+
* await catalogClient.GetView({
|
576
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
577
|
+
* });
|
578
|
+
*/
|
579
|
+
GetView(request, extraHeaders) {
|
580
|
+
return this.ExecuteRequestWrapper("/Catalog/GetView", request, "X-EntityToken", extraHeaders);
|
581
|
+
}
|
582
|
+
/**
|
583
|
+
* Retrieves a paginated list of the catalog views.
|
584
|
+
*
|
585
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getviews Microsoft Documentation}
|
586
|
+
* @example
|
587
|
+
* await catalogClient.GetViews({
|
588
|
+
* "Count": 5,
|
589
|
+
* "Entity": {
|
590
|
+
* "Id": "someId",
|
591
|
+
* "Type": "title_player_account",
|
592
|
+
* "TypeString": "title_player_account"
|
593
|
+
* }
|
594
|
+
* });
|
595
|
+
*/
|
596
|
+
GetViews(request, extraHeaders) {
|
597
|
+
return this.ExecuteRequestWrapper("/Catalog/GetViews", request, "X-EntityToken", extraHeaders);
|
598
|
+
}
|
599
|
+
/**
|
600
|
+
* List versioned catalogs.
|
601
|
+
*
|
602
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/listversionedcatalogs Microsoft Documentation}
|
603
|
+
* @example
|
604
|
+
* await versionedcatalogClient.ListVersionedCatalogs({});
|
605
|
+
*/
|
606
|
+
ListVersionedCatalogs(request, extraHeaders) {
|
607
|
+
return this.ExecuteRequestWrapper("/VersionedCatalog/ListVersionedCatalogs", request, "X-EntityToken", extraHeaders);
|
608
|
+
}
|
609
|
+
/**
|
610
|
+
* Initiates a publish of an item from the working catalog to the public catalog. You can use the GetItemPublishStatus API
|
611
|
+
* to track the state of the item publish.
|
612
|
+
*
|
613
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/publishdraftitem Microsoft Documentation}
|
614
|
+
* @example
|
615
|
+
* await catalogClient.PublishDraftItem({
|
616
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
617
|
+
* });
|
618
|
+
*/
|
619
|
+
PublishDraftItem(request, extraHeaders) {
|
620
|
+
return this.ExecuteRequestWrapper("/Catalog/PublishDraftItem", request, "X-EntityToken", extraHeaders);
|
621
|
+
}
|
622
|
+
/**
|
623
|
+
* Purchase an item or bundle. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is
|
624
|
+
* uncapped.
|
625
|
+
*
|
626
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/purchaseinventoryitems Microsoft Documentation}
|
627
|
+
* @example
|
628
|
+
* await inventoryClient.PurchaseInventoryItems({
|
629
|
+
* "Item": {
|
630
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
631
|
+
* },
|
632
|
+
* "Amount": 1,
|
633
|
+
* "PriceAmounts": [
|
634
|
+
* {
|
635
|
+
* "ItemId": "cccccccc-cccc-cccc-cccc-cccccccccccc",
|
636
|
+
* "Amount": 15
|
637
|
+
* }
|
638
|
+
* ],
|
639
|
+
* "DeleteEmptyStacks": false
|
640
|
+
* });
|
641
|
+
*/
|
642
|
+
PurchaseInventoryItems(request, extraHeaders) {
|
643
|
+
return this.ExecuteRequestWrapper("/Inventory/PurchaseInventoryItems", request, "X-EntityToken", extraHeaders);
|
644
|
+
}
|
645
|
+
/**
|
646
|
+
* Redeem items.
|
647
|
+
*
|
648
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/redeemappleappstoreinventoryitems Microsoft Documentation}
|
649
|
+
* @example
|
650
|
+
* await inventoryClient.RedeemAppleAppStoreInventoryItems({
|
651
|
+
* "Receipt": "receipt"
|
652
|
+
* });
|
653
|
+
*/
|
654
|
+
RedeemAppleAppStoreInventoryItems(request, extraHeaders) {
|
655
|
+
return this.ExecuteRequestWrapper("/Inventory/RedeemAppleAppStoreInventoryItems", request, "X-EntityToken", extraHeaders);
|
656
|
+
}
|
657
|
+
/**
|
658
|
+
* Redeem items.
|
659
|
+
*
|
660
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/redeemgoogleplayinventoryitems Microsoft Documentation}
|
661
|
+
* @example
|
662
|
+
* await inventoryClient.RedeemGooglePlayInventoryItems({
|
663
|
+
* "Purchases": [
|
664
|
+
* {
|
665
|
+
* "ProductId": "productId",
|
666
|
+
* "Token": "token"
|
667
|
+
* }
|
668
|
+
* ]
|
669
|
+
* });
|
670
|
+
*/
|
671
|
+
RedeemGooglePlayInventoryItems(request, extraHeaders) {
|
672
|
+
return this.ExecuteRequestWrapper("/Inventory/RedeemGooglePlayInventoryItems", request, "X-EntityToken", extraHeaders);
|
673
|
+
}
|
674
|
+
/**
|
675
|
+
* Redeem items.
|
676
|
+
*
|
677
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/redeemmicrosoftstoreinventoryitems Microsoft Documentation}
|
678
|
+
* @example
|
679
|
+
* await inventoryClient.RedeemMicrosoftStoreInventoryItems({
|
680
|
+
* "CollectionsIdKey": "collectionsIdKey"
|
681
|
+
* });
|
682
|
+
*/
|
683
|
+
RedeemMicrosoftStoreInventoryItems(request, extraHeaders) {
|
684
|
+
return this.ExecuteRequestWrapper("/Inventory/RedeemMicrosoftStoreInventoryItems", request, "X-EntityToken", extraHeaders);
|
685
|
+
}
|
686
|
+
/**
|
687
|
+
* Redeem items.
|
688
|
+
*
|
689
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/redeemnintendoeshopinventoryitems Microsoft Documentation}
|
690
|
+
* @example
|
691
|
+
* await inventoryClient.RedeemNintendoEShopInventoryItems({
|
692
|
+
* "NintendoServiceAccountIdToken": "nsaIdToken"
|
693
|
+
* });
|
694
|
+
*/
|
695
|
+
RedeemNintendoEShopInventoryItems(request, extraHeaders) {
|
696
|
+
return this.ExecuteRequestWrapper("/Inventory/RedeemNintendoEShopInventoryItems", request, "X-EntityToken", extraHeaders);
|
697
|
+
}
|
698
|
+
/**
|
699
|
+
* Redeem items.
|
700
|
+
*
|
701
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/redeemplaystationstoreinventoryitems Microsoft Documentation}
|
702
|
+
* @example
|
703
|
+
* await inventoryClient.RedeemPlayStationStoreInventoryItems({
|
704
|
+
* "AuthorizationCode": "authorizationCode",
|
705
|
+
* "RedirectUri": "orbis://games",
|
706
|
+
* "ServiceLabel": "0"
|
707
|
+
* });
|
708
|
+
*/
|
709
|
+
RedeemPlayStationStoreInventoryItems(request, extraHeaders) {
|
710
|
+
return this.ExecuteRequestWrapper("/Inventory/RedeemPlayStationStoreInventoryItems", request, "X-EntityToken", extraHeaders);
|
711
|
+
}
|
712
|
+
/**
|
713
|
+
* Redeem items.
|
714
|
+
*
|
715
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/redeemsteaminventoryitems Microsoft Documentation}
|
716
|
+
* @example
|
717
|
+
* await inventoryClient.RedeemSteamInventoryItems({});
|
718
|
+
*/
|
719
|
+
RedeemSteamInventoryItems(request, extraHeaders) {
|
720
|
+
return this.ExecuteRequestWrapper("/Inventory/RedeemSteamInventoryItems", request, "X-EntityToken", extraHeaders);
|
721
|
+
}
|
722
|
+
/**
|
723
|
+
* Submit a report for an item, indicating in what way the item is inappropriate.
|
724
|
+
*
|
725
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/reportitem Microsoft Documentation}
|
726
|
+
* @example
|
727
|
+
* await catalogClient.ReportItem({
|
728
|
+
* "ConcernCategory": "Profanity",
|
729
|
+
* "Reason": "There was swearing in the description.",
|
730
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
731
|
+
* });
|
732
|
+
*/
|
733
|
+
ReportItem(request, extraHeaders) {
|
734
|
+
return this.ExecuteRequestWrapper("/Catalog/ReportItem", request, "X-EntityToken", extraHeaders);
|
735
|
+
}
|
736
|
+
/**
|
737
|
+
* Submit a report for a review
|
738
|
+
*
|
739
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/reportitemreview Microsoft Documentation}
|
740
|
+
* @example
|
741
|
+
* await catalogClient.ReportItemReview({
|
742
|
+
* "ReviewId": "dddddddd-dddd-dddd-dddd-dddddddddddd",
|
743
|
+
* "ItemId": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
|
744
|
+
* "ConcernCategory": "OffensiveContent",
|
745
|
+
* "Reason": "Foul language."
|
746
|
+
* });
|
747
|
+
*/
|
748
|
+
ReportItemReview(request, extraHeaders) {
|
749
|
+
return this.ExecuteRequestWrapper("/Catalog/ReportItemReview", request, "X-EntityToken", extraHeaders);
|
750
|
+
}
|
751
|
+
/**
|
752
|
+
* Creates or updates a review for the specified item. More information around the caching surrounding item ratings and
|
753
|
+
* reviews can be found here:
|
754
|
+
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/ratings#ratings-design-and-caching
|
755
|
+
*
|
756
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/reviewitem Microsoft Documentation}
|
757
|
+
* @example
|
758
|
+
* await catalogClient.ReviewItem({
|
759
|
+
* "Review": {
|
760
|
+
* "ItemVersion": "2.4.1",
|
761
|
+
* "Title": "Best Game Ever",
|
762
|
+
* "ReviewText": "I play this game every day. It's my favorite game yet.",
|
763
|
+
* "Rating": 5,
|
764
|
+
* "IsInstalled": true,
|
765
|
+
* "HelpfulPositive": 0,
|
766
|
+
* "HelpfulNegative": 0,
|
767
|
+
* "Submitted": "0001-01-01T00:00:00Z"
|
768
|
+
* },
|
769
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
770
|
+
* });
|
771
|
+
*/
|
772
|
+
ReviewItem(request, extraHeaders) {
|
773
|
+
return this.ExecuteRequestWrapper("/Catalog/ReviewItem", request, "X-EntityToken", extraHeaders);
|
774
|
+
}
|
775
|
+
/**
|
776
|
+
* Executes a search against the public catalog using the provided search parameters and returns a set of paginated
|
777
|
+
* results. SearchItems uses a cache of the catalog with item updates taking up to a few minutes to propagate. You should
|
778
|
+
* use the GetItem API for when trying to immediately get recent item updates. More information about the Search API can be
|
779
|
+
* found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search
|
780
|
+
*
|
781
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/searchitems Microsoft Documentation}
|
782
|
+
* @example
|
783
|
+
* await catalogClient.SearchItems({
|
784
|
+
* "Search": "Pirates",
|
785
|
+
* "Filter": "tags/any(t:t eq 'desert') and contentType eq 'map'",
|
786
|
+
* "OrderBy": "lastModifiedDate asc",
|
787
|
+
* "ContinuationToken": "abc=",
|
788
|
+
* "Count": 2
|
789
|
+
* });
|
790
|
+
*/
|
791
|
+
SearchItems(request, extraHeaders) {
|
792
|
+
return this.ExecuteRequestWrapper("/Catalog/SearchItems", request, "X-EntityToken", extraHeaders);
|
793
|
+
}
|
794
|
+
/**
|
795
|
+
* Sets the moderation state for an item, including the concern category and string reason. More information about
|
796
|
+
* moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation
|
797
|
+
*
|
798
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/setitemmoderationstate Microsoft Documentation}
|
799
|
+
* @example
|
800
|
+
* await catalogClient.SetItemModerationState({
|
801
|
+
* "Status": "AwaitingModeration",
|
802
|
+
* "Reason": "User reports over threshold",
|
803
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
804
|
+
* });
|
805
|
+
*/
|
806
|
+
SetItemModerationState(request, extraHeaders) {
|
807
|
+
return this.ExecuteRequestWrapper("/Catalog/SetItemModerationState", request, "X-EntityToken", extraHeaders);
|
808
|
+
}
|
809
|
+
/**
|
810
|
+
* Submit a vote for a review, indicating whether the review was helpful or unhelpful.
|
811
|
+
*
|
812
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/submititemreviewvote Microsoft Documentation}
|
813
|
+
* @example
|
814
|
+
* await catalogClient.SubmitItemReviewVote({
|
815
|
+
* "ReviewId": "dddddddd-dddd-dddd-dddd-dddddddddddd",
|
816
|
+
* "ItemId": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
|
817
|
+
* "Vote": "Helpful"
|
818
|
+
* });
|
819
|
+
*/
|
820
|
+
SubmitItemReviewVote(request, extraHeaders) {
|
821
|
+
return this.ExecuteRequestWrapper("/Catalog/SubmitItemReviewVote", request, "X-EntityToken", extraHeaders);
|
822
|
+
}
|
823
|
+
/**
|
824
|
+
* Subtract inventory items.
|
825
|
+
*
|
826
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/subtractinventoryitems Microsoft Documentation}
|
827
|
+
* @example
|
828
|
+
* await inventoryClient.SubtractInventoryItems({
|
829
|
+
* "Item": {
|
830
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
831
|
+
* },
|
832
|
+
* "Amount": 3,
|
833
|
+
* "DeleteEmptyStacks": false,
|
834
|
+
* "ReturnInventory": false
|
835
|
+
* });
|
836
|
+
*/
|
837
|
+
SubtractInventoryItems(request, extraHeaders) {
|
838
|
+
return this.ExecuteRequestWrapper("/Inventory/SubtractInventoryItems", request, "X-EntityToken", extraHeaders);
|
839
|
+
}
|
840
|
+
/**
|
841
|
+
* Submit a request to takedown one or more reviews.
|
842
|
+
*
|
843
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/takedownitemreviews Microsoft Documentation}
|
844
|
+
* @example
|
845
|
+
* await catalogClient.TakedownItemReviews({
|
846
|
+
* "Reviews": [
|
847
|
+
* {
|
848
|
+
* "ItemId": "00000000-0000-0000-0000-000000000003",
|
849
|
+
* "ReviewId": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
850
|
+
* }
|
851
|
+
* ]
|
852
|
+
* });
|
853
|
+
*/
|
854
|
+
TakedownItemReviews(request, extraHeaders) {
|
855
|
+
return this.ExecuteRequestWrapper("/Catalog/TakedownItemReviews", request, "X-EntityToken", extraHeaders);
|
856
|
+
}
|
857
|
+
/**
|
858
|
+
* Transfer inventory items. When transferring across collections, a 202 response indicates that the transfer did not
|
859
|
+
* complete within the timeframe of the request. You can identify the pending operations by looking for OperationStatus =
|
860
|
+
* 'InProgress'. You can check on the operation status at anytime within 1 day of the request by passing the
|
861
|
+
* TransactionToken to the GetInventoryOperationStatus API. More information about item transfer scenarios can be found
|
862
|
+
* here:
|
863
|
+
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/?tabs=inventory-game-manager#transfer-inventory-items
|
864
|
+
*
|
865
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/transferinventoryitems Microsoft Documentation}
|
866
|
+
* @example
|
867
|
+
* await inventoryClient.TransferInventoryItems({
|
868
|
+
* "GivingItem": {
|
869
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
870
|
+
* },
|
871
|
+
* "ReceivingItem": {
|
872
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
873
|
+
* },
|
874
|
+
* "Amount": 1,
|
875
|
+
* "DeleteEmptyStacks": false,
|
876
|
+
* "GivingCollectionId": "default",
|
877
|
+
* "ReceivingCollectionId": "backpack"
|
878
|
+
* });
|
879
|
+
*/
|
880
|
+
TransferInventoryItems(request, extraHeaders) {
|
881
|
+
return this.ExecuteRequestWrapper("/Inventory/TransferInventoryItems", request, "X-EntityToken", extraHeaders);
|
882
|
+
}
|
883
|
+
/**
|
884
|
+
* Updates the configuration for the catalog. Only Title Entities can call this API. There is a limit of 10 requests in 10
|
885
|
+
* seconds for this API. More information about the Catalog Config can be found here:
|
886
|
+
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings
|
887
|
+
*
|
888
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/updatecatalogconfig Microsoft Documentation}
|
889
|
+
* @example
|
890
|
+
* await catalogClient.UpdateCatalogConfig({
|
891
|
+
* "Config": {
|
892
|
+
* "IsCatalogEnabled": true,
|
893
|
+
* "AdminEntities": [
|
894
|
+
* {
|
895
|
+
* "Id": "ABC123",
|
896
|
+
* "Type": "title_player_account",
|
897
|
+
* "TypeString": "title_player_account"
|
898
|
+
* }
|
899
|
+
* ],
|
900
|
+
* "DisplayPropertyIndexInfos": [
|
901
|
+
* {
|
902
|
+
* "Name": "damage",
|
903
|
+
* "Type": "QueryDouble"
|
904
|
+
* }
|
905
|
+
* ],
|
906
|
+
* "ReviewerEntities": [
|
907
|
+
* {
|
908
|
+
* "Id": "ABC123",
|
909
|
+
* "Type": "title_player_account",
|
910
|
+
* "TypeString": "title_player_account"
|
911
|
+
* }
|
912
|
+
* ],
|
913
|
+
* "UserGeneratedContent": {
|
914
|
+
* "ContentTypes": [
|
915
|
+
* "skin",
|
916
|
+
* "map",
|
917
|
+
* "example item"
|
918
|
+
* ],
|
919
|
+
* "Tags": [
|
920
|
+
* "pirate",
|
921
|
+
* "holiday"
|
922
|
+
* ]
|
923
|
+
* }
|
924
|
+
* }
|
925
|
+
* });
|
926
|
+
*/
|
927
|
+
UpdateCatalogConfig(request, extraHeaders) {
|
928
|
+
return this.ExecuteRequestWrapper("/Catalog/UpdateCatalogConfig", request, "X-EntityToken", extraHeaders);
|
929
|
+
}
|
930
|
+
/**
|
931
|
+
* Update the metadata for an item in the working catalog. Note: SAS tokens provided are valid for 1 hour.
|
932
|
+
*
|
933
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/updatedraftitem Microsoft Documentation}
|
934
|
+
* @example
|
935
|
+
* await catalogClient.UpdateDraftItem({
|
936
|
+
* "Item": {
|
937
|
+
* "Id": "qqqqqqqq-qqqq-qqqq-qqqq-qqqqqqqqqqqq",
|
938
|
+
* "Type": "ugc",
|
939
|
+
* "Title": {
|
940
|
+
* "NEUTRAL": "Neutral title",
|
941
|
+
* "en-US": "US English title"
|
942
|
+
* },
|
943
|
+
* "Description": {
|
944
|
+
* "NEUTRAL": "Neutral description",
|
945
|
+
* "en-US": "US English description"
|
946
|
+
* },
|
947
|
+
* "Keywords": {
|
948
|
+
* "NEUTRAL": {
|
949
|
+
* "Values": [
|
950
|
+
* "Keyword_1",
|
951
|
+
* "Keyword_2"
|
952
|
+
* ]
|
953
|
+
* }
|
954
|
+
* },
|
955
|
+
* "ContentType": "example item",
|
956
|
+
* "CreatorEntity": {
|
957
|
+
* "Id": "someId",
|
958
|
+
* "Type": "title_player_account",
|
959
|
+
* "TypeString": "title_player_account"
|
960
|
+
* },
|
961
|
+
* "IsHidden": false,
|
962
|
+
* "Tags": [
|
963
|
+
* "pirates",
|
964
|
+
* "holiday"
|
965
|
+
* ],
|
966
|
+
* "DisplayVersion": "1.0.0",
|
967
|
+
* "CreationDate": "2018-08-17T22:32:10.472Z",
|
968
|
+
* "Contents": [
|
969
|
+
* {
|
970
|
+
* "Id": "00000000-0000-0000-0000-000000000001",
|
971
|
+
* "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
|
972
|
+
* "MaxClientVersion": "2.4.1",
|
973
|
+
* "MinClientVersion": "2.0.0"
|
974
|
+
* }
|
975
|
+
* ],
|
976
|
+
* "Images": [
|
977
|
+
* {
|
978
|
+
* "Id": "00000000-0000-0000-0000-000000000003",
|
979
|
+
* "Type": "Thumbnail",
|
980
|
+
* "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
|
981
|
+
* }
|
982
|
+
* ],
|
983
|
+
* "DisplayProperties": {
|
984
|
+
* "mapDetails": {
|
985
|
+
* "mapType": "desertIsland",
|
986
|
+
* "gameMode": "capture",
|
987
|
+
* "maxPlayers": 16
|
988
|
+
* },
|
989
|
+
* "averageMatchLengthInSeconds": 947
|
990
|
+
* },
|
991
|
+
* "DefaultStackId": "Static_Default_Stack_Id"
|
992
|
+
* },
|
993
|
+
* "Publish": false
|
994
|
+
* });
|
995
|
+
*/
|
996
|
+
UpdateDraftItem(request, extraHeaders) {
|
997
|
+
return this.ExecuteRequestWrapper("/Catalog/UpdateDraftItem", request, "X-EntityToken", extraHeaders);
|
998
|
+
}
|
999
|
+
/**
|
1000
|
+
* Update inventory items
|
1001
|
+
*
|
1002
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/updateinventoryitems Microsoft Documentation}
|
1003
|
+
* @example
|
1004
|
+
* await inventoryClient.UpdateInventoryItems({
|
1005
|
+
* "Item": {
|
1006
|
+
* "Id": "11111111-1111-1111-1111-111111111111",
|
1007
|
+
* "Amount": 3
|
1008
|
+
* },
|
1009
|
+
* "ReturnInventory": false
|
1010
|
+
* });
|
1011
|
+
*/
|
1012
|
+
UpdateInventoryItems(request, extraHeaders) {
|
1013
|
+
return this.ExecuteRequestWrapper("/Inventory/UpdateInventoryItems", request, "X-EntityToken", extraHeaders);
|
1014
|
+
}
|
1015
|
+
/**
|
1016
|
+
* Updates an existing view in the catalog using provided metadata.
|
1017
|
+
*
|
1018
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/updateview Microsoft Documentation}
|
1019
|
+
* @example
|
1020
|
+
* await catalogClient.UpdateView({
|
1021
|
+
* "View": {
|
1022
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
|
1023
|
+
* "FriendlyId": "exampleView",
|
1024
|
+
* "IsTitleView": false,
|
1025
|
+
* "Count": 10,
|
1026
|
+
* "Filter": "tags/any(t:t eq 'desert') and contentType eq 'map'",
|
1027
|
+
* "Language": "en-US",
|
1028
|
+
* "FileFormat": "JsonLines",
|
1029
|
+
* "Url": "https://views.prod.catalog.playfab.com/title-identifier/dddddddd-dddd-dddd-dddd-dddddddddddd.json",
|
1030
|
+
* "LastModifiedDate": "2023-08-17T22:32:31.911Z",
|
1031
|
+
* "CreationDate": "2023-08-17T22:32:10.472Z",
|
1032
|
+
* "LastViewDiagnostics": {
|
1033
|
+
* "GeneratedDate": "2023-08-18T23:32:10.322Z",
|
1034
|
+
* "Status": "Unknown"
|
1035
|
+
* },
|
1036
|
+
* "ETag": "opaqueString"
|
1037
|
+
* }
|
1038
|
+
* });
|
1039
|
+
*/
|
1040
|
+
UpdateView(request, extraHeaders) {
|
1041
|
+
return this.ExecuteRequestWrapper("/Catalog/UpdateView", request, "X-EntityToken", extraHeaders);
|
1042
|
+
}
|
1043
|
+
};
|
1044
|
+
|
1045
|
+
export {
|
1046
|
+
PlayFabEconomyApi
|
1047
|
+
};
|
1048
|
+
//# sourceMappingURL=chunk-NFWQ4MMZ.js.map
|