async-playfab-web-sdk 1.192.250526-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/dist/Addon.d.ts +591 -0
  2. package/dist/Addon.js +452 -0
  3. package/dist/Addon.js.map +1 -0
  4. package/dist/Admin.d.ts +3484 -0
  5. package/dist/Admin.js +1112 -0
  6. package/dist/Admin.js.map +1 -0
  7. package/dist/Authentication.d.ts +109 -0
  8. package/dist/Authentication.js +290 -0
  9. package/dist/Authentication.js.map +1 -0
  10. package/dist/Client.d.ts +4482 -0
  11. package/dist/Client.js +1893 -0
  12. package/dist/Client.js.map +1 -0
  13. package/dist/CloudScript.d.ts +511 -0
  14. package/dist/CloudScript.js +349 -0
  15. package/dist/CloudScript.js.map +1 -0
  16. package/dist/Data.d.ts +228 -0
  17. package/dist/Data.js +291 -0
  18. package/dist/Data.js.map +1 -0
  19. package/dist/Economy.d.ts +1865 -0
  20. package/dist/Economy.js +614 -0
  21. package/dist/Economy.js.map +1 -0
  22. package/dist/Events.d.ts +307 -0
  23. package/dist/Events.js +327 -0
  24. package/dist/Events.js.map +1 -0
  25. package/dist/Experimentation.d.ts +357 -0
  26. package/dist/Experimentation.js +333 -0
  27. package/dist/Experimentation.js.map +1 -0
  28. package/dist/Groups.d.ts +546 -0
  29. package/dist/Groups.js +417 -0
  30. package/dist/Groups.js.map +1 -0
  31. package/dist/Insights.d.ts +141 -0
  32. package/dist/Insights.js +286 -0
  33. package/dist/Insights.js.map +1 -0
  34. package/dist/Localization.d.ts +20 -0
  35. package/dist/Localization.js +249 -0
  36. package/dist/Localization.js.map +1 -0
  37. package/dist/Multiplayer.d.ts +3059 -0
  38. package/dist/Multiplayer.js +862 -0
  39. package/dist/Multiplayer.js.map +1 -0
  40. package/dist/PlayFabCommon-BUv4zqXf.d.ts +72 -0
  41. package/dist/Profiles.d.ts +278 -0
  42. package/dist/Profiles.js +306 -0
  43. package/dist/Profiles.js.map +1 -0
  44. package/dist/Progression.d.ts +598 -0
  45. package/dist/Progression.js +404 -0
  46. package/dist/Progression.js.map +1 -0
  47. package/dist/Server.d.ts +3889 -0
  48. package/dist/Server.js +1377 -0
  49. package/dist/Server.js.map +1 -0
  50. package/dist/index.d.ts +17 -0
  51. package/dist/index.js +6007 -0
  52. package/dist/index.js.map +1 -0
  53. package/package.json +23 -0
  54. package/readme.md +25 -0
@@ -0,0 +1,1865 @@
1
+ import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-BUv4zqXf.js';
2
+
3
+ interface AddInventoryItemsOperation {
4
+ /** The amount to add to the current item amount. */
5
+ Amount?: number;
6
+ /** The duration to add to the current item expiration date. */
7
+ DurationInSeconds?: number;
8
+ /** The inventory item the operation applies to. */
9
+ Item?: InventoryItemReference;
10
+ /** The values to apply to a stack newly created by this operation. */
11
+ NewStackValues?: InitialValues;
12
+ }
13
+ interface AddInventoryItemsRequest extends IPlayFabRequestCommon {
14
+ /** The amount to add for the current item. */
15
+ Amount?: number;
16
+ /**
17
+ * The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is
18
+ * unlimited.
19
+ */
20
+ CollectionId?: string;
21
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
22
+ CustomTags?: Record<string, string | null>;
23
+ /** The duration to add to the current item expiration date. */
24
+ DurationInSeconds?: number;
25
+ /** The entity to perform this action on. */
26
+ Entity?: EntityKey;
27
+ /**
28
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
29
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
30
+ */
31
+ ETag?: string;
32
+ /**
33
+ * The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will
34
+ * be garbage collected eventually.
35
+ */
36
+ IdempotencyId?: string;
37
+ /** The inventory item the request applies to. */
38
+ Item?: InventoryItemReference;
39
+ /** The values to apply to a stack newly created by this request. */
40
+ NewStackValues?: InitialValues;
41
+ }
42
+ interface AddInventoryItemsResponse extends IPlayFabResultCommon {
43
+ /**
44
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
45
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
46
+ */
47
+ ETag?: string;
48
+ /** The idempotency id used in the request. */
49
+ IdempotencyId?: string;
50
+ /** The ids of transactions that occurred as a result of the request. */
51
+ TransactionIds?: string[];
52
+ }
53
+ interface AlternateId {
54
+ /** Type of the alternate ID. */
55
+ Type?: string;
56
+ /** Value of the alternate ID. */
57
+ Value?: string;
58
+ }
59
+ interface CatalogAlternateId {
60
+ /** Type of the alternate ID. */
61
+ Type?: string;
62
+ /** Value of the alternate ID. */
63
+ Value?: string;
64
+ }
65
+ interface CatalogConfig {
66
+ /** A list of player entity keys that will have admin permissions. There is a maximum of 64 entities that can be added. */
67
+ AdminEntities?: EntityKey[];
68
+ /** The set of configuration that only applies to catalog items. */
69
+ Catalog?: CatalogSpecificConfig;
70
+ /** A list of deep link formats. Up to 10 can be added. */
71
+ DeepLinkFormats?: DeepLinkFormat[];
72
+ /**
73
+ * A list of display properties to index. Up to 5 mappings can be added per Display Property Type. More info on display
74
+ * properties can be found here:
75
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/content-types-tags-and-properties#displayproperties
76
+ */
77
+ DisplayPropertyIndexInfos?: DisplayPropertyIndexInfo[];
78
+ /** The set of configuration that only applies to Files. */
79
+ File?: FileConfig;
80
+ /** The set of configuration that only applies to Images. */
81
+ Image?: ImageConfig;
82
+ /** Flag defining whether catalog is enabled. */
83
+ IsCatalogEnabled: boolean;
84
+ /**
85
+ * A list of Platforms that can be applied to catalog items. Each platform can have a maximum character length of 40 and up
86
+ * to 128 platforms can be listed.
87
+ */
88
+ Platforms?: string[];
89
+ /** The set of configuration that only applies to Ratings and Reviews. */
90
+ Review?: ReviewConfig;
91
+ /** A set of player entity keys that are allowed to review content. There is a maximum of 128 entities that can be added. */
92
+ ReviewerEntities?: EntityKey[];
93
+ /** The set of configuration that only applies to user generated contents. */
94
+ UserGeneratedContent?: UserGeneratedContentSpecificConfig;
95
+ }
96
+ interface CatalogItem {
97
+ /**
98
+ * The alternate IDs associated with this item. An alternate ID can be set to 'FriendlyId' or any of the supported
99
+ * marketplace names.
100
+ */
101
+ AlternateIds?: CatalogAlternateId[];
102
+ /** The set of content/files associated with this item. Up to 100 files can be added to an item. */
103
+ Contents?: Content[];
104
+ /** The client-defined type of the item. */
105
+ ContentType?: string;
106
+ /** The date and time when this item was created. */
107
+ CreationDate?: string;
108
+ /** The ID of the creator of this catalog item. */
109
+ CreatorEntity?: EntityKey;
110
+ /** The set of platform specific deep links for this item. */
111
+ DeepLinks?: DeepLink[];
112
+ /**
113
+ * The Stack Id that will be used as default for this item in Inventory when an explicit one is not provided. This
114
+ * DefaultStackId can be a static stack id or '{guid}', which will generate a unique stack id for the item. If null,
115
+ * Inventory's default stack id will be used.
116
+ */
117
+ DefaultStackId?: string;
118
+ /**
119
+ * A dictionary of localized descriptions. Key is language code and localized string is the value. The NEUTRAL locale is
120
+ * required. Descriptions have a 10000 character limit per country code.
121
+ */
122
+ Description?: Record<string, string | null>;
123
+ /**
124
+ * Game specific properties for display purposes. This is an arbitrary JSON blob. The Display Properties field has a 10000
125
+ * byte limit per item.
126
+ */
127
+ DisplayProperties?: any;
128
+ /** The user provided version of the item for display purposes. Maximum character length of 50. */
129
+ DisplayVersion?: string;
130
+ /** The date of when the item will cease to be available. If not provided then the product will be available indefinitely. */
131
+ EndDate?: string;
132
+ /** The current ETag value that can be used for optimistic concurrency in the If-None-Match header. */
133
+ ETag?: string;
134
+ /** The unique ID of the item. */
135
+ Id?: string;
136
+ /**
137
+ * The images associated with this item. Images can be thumbnails or screenshots. Up to 100 images can be added to an item.
138
+ * Only .png, .jpg, .gif, and .bmp file types can be uploaded
139
+ */
140
+ Images?: Image[];
141
+ /** Indicates if the item is hidden. */
142
+ IsHidden?: boolean;
143
+ /**
144
+ * The item references associated with this item. For example, the items in a Bundle/Store/Subscription. Every item can
145
+ * have up to 50 item references.
146
+ */
147
+ ItemReferences?: CatalogItemReference[];
148
+ /**
149
+ * A dictionary of localized keywords. Key is language code and localized list of keywords is the value. Keywords have a 50
150
+ * character limit per keyword and up to 32 keywords can be added per country code.
151
+ */
152
+ Keywords?: Record<string, KeywordSet>;
153
+ /** The date and time this item was last updated. */
154
+ LastModifiedDate?: string;
155
+ /** The moderation state for this item. */
156
+ Moderation?: ModerationState;
157
+ /** The platforms supported by this item. */
158
+ Platforms?: string[];
159
+ /** The prices the item can be purchased for. */
160
+ PriceOptions?: CatalogPriceOptions;
161
+ /** Rating summary for this item. */
162
+ Rating?: Rating;
163
+ /** The real price the item was purchased for per marketplace. */
164
+ RealMoneyPriceDetails?: RealMoneyPriceDetails;
165
+ /** The date of when the item will be available. If not provided then the product will appear immediately. */
166
+ StartDate?: string;
167
+ /** Optional details for stores items. */
168
+ StoreDetails?: StoreDetails;
169
+ /** The list of tags that are associated with this item. Up to 32 tags can be added to an item. */
170
+ Tags?: string[];
171
+ /**
172
+ * A dictionary of localized titles. Key is language code and localized string is the value. The NEUTRAL locale is
173
+ * required. Titles have a 512 character limit per country code.
174
+ */
175
+ Title?: Record<string, string | null>;
176
+ /**
177
+ * The high-level type of the item. The following item types are supported: bundle, catalogItem, currency, store, ugc,
178
+ * subscription.
179
+ */
180
+ Type?: string;
181
+ }
182
+ interface CatalogItemReference {
183
+ /** The amount of the catalog item. */
184
+ Amount?: number;
185
+ /** The unique ID of the catalog item. */
186
+ Id?: string;
187
+ /** The prices the catalog item can be purchased for. */
188
+ PriceOptions?: CatalogPriceOptions;
189
+ }
190
+ interface CatalogPrice {
191
+ /** The amounts of the catalog item price. Each price can have up to 15 item amounts. */
192
+ Amounts?: CatalogPriceAmount[];
193
+ /** The per-unit amount this price can be used to purchase. */
194
+ UnitAmount?: number;
195
+ /** The per-unit duration this price can be used to purchase. The maximum duration is 100 years. */
196
+ UnitDurationInSeconds?: number;
197
+ }
198
+ interface CatalogPriceAmount {
199
+ /** The amount of the price. */
200
+ Amount: number;
201
+ /** The Item Id of the price. */
202
+ ItemId?: string;
203
+ }
204
+ interface CatalogPriceAmountOverride {
205
+ /** The exact value that should be utilized in the override. */
206
+ FixedValue?: number;
207
+ /** The id of the item this override should utilize. */
208
+ ItemId?: string;
209
+ /**
210
+ * The multiplier that will be applied to the base Catalog value to determine what value should be utilized in the
211
+ * override.
212
+ */
213
+ Multiplier?: number;
214
+ }
215
+ interface CatalogPriceOptions {
216
+ /** Prices of the catalog item. An item can have up to 15 prices */
217
+ Prices?: CatalogPrice[];
218
+ }
219
+ interface CatalogPriceOptionsOverride {
220
+ /** The prices utilized in the override. */
221
+ Prices?: CatalogPriceOverride[];
222
+ }
223
+ interface CatalogPriceOverride {
224
+ /** The currency amounts utilized in the override for a singular price. */
225
+ Amounts?: CatalogPriceAmountOverride[];
226
+ }
227
+ interface CatalogSpecificConfig {
228
+ /**
229
+ * The set of content types that will be used for validation. Each content type can have a maximum character length of 40
230
+ * and up to 128 types can be listed.
231
+ */
232
+ ContentTypes?: string[];
233
+ /**
234
+ * The set of tags that will be used for validation. Each tag can have a maximum character length of 32 and up to 1024 tags
235
+ * can be listed.
236
+ */
237
+ Tags?: string[];
238
+ }
239
+ interface CategoryRatingConfig {
240
+ /** Name of the category. */
241
+ Name?: string;
242
+ }
243
+ interface Content {
244
+ /** The content unique ID. */
245
+ Id?: string;
246
+ /**
247
+ * The maximum client version that this content is compatible with. Client Versions can be up to 3 segments separated by
248
+ * periods(.) and each segment can have a maximum value of 65535.
249
+ */
250
+ MaxClientVersion?: string;
251
+ /**
252
+ * The minimum client version that this content is compatible with. Client Versions can be up to 3 segments separated by
253
+ * periods(.) and each segment can have a maximum value of 65535.
254
+ */
255
+ MinClientVersion?: string;
256
+ /**
257
+ * The list of tags that are associated with this content. Tags must be defined in the Catalog Config before being used in
258
+ * content.
259
+ */
260
+ Tags?: string[];
261
+ /** The client-defined type of the content. Content Types must be defined in the Catalog Config before being used. */
262
+ Type?: string;
263
+ /** The Azure CDN URL for retrieval of the catalog item binary content. */
264
+ Url?: string;
265
+ }
266
+ interface CreateDraftItemRequest extends IPlayFabRequestCommon {
267
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
268
+ CustomTags?: Record<string, string | null>;
269
+ /** Metadata describing the new catalog item to be created. */
270
+ Item?: CatalogItem;
271
+ /** Whether the item should be published immediately. This value is optional, defaults to false. */
272
+ Publish: boolean;
273
+ }
274
+ interface CreateDraftItemResponse extends IPlayFabResultCommon {
275
+ /** Updated metadata describing the catalog item just created. */
276
+ Item?: CatalogItem;
277
+ }
278
+ interface CreateUploadUrlsRequest extends IPlayFabRequestCommon {
279
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
280
+ CustomTags?: Record<string, string | null>;
281
+ /** Description of the files to be uploaded by the client. */
282
+ Files?: UploadInfo[];
283
+ }
284
+ interface CreateUploadUrlsResponse extends IPlayFabResultCommon {
285
+ /** List of URLs metadata for the files to be uploaded by the client. */
286
+ UploadUrls?: UploadUrlMetadata[];
287
+ }
288
+ interface DeepLink {
289
+ /** Target platform for this deep link. */
290
+ Platform?: string;
291
+ /** The deep link for this platform. */
292
+ Url?: string;
293
+ }
294
+ interface DeepLinkFormat {
295
+ /** The format of the deep link to return. The format should contain '{id}' to represent where the item ID should be placed. */
296
+ Format?: string;
297
+ /** The target platform for the deep link. */
298
+ Platform?: string;
299
+ }
300
+ interface DeleteEntityItemReviewsRequest extends IPlayFabRequestCommon {
301
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
302
+ CustomTags?: Record<string, string | null>;
303
+ /** The entity to perform this action on. */
304
+ Entity?: EntityKey;
305
+ }
306
+ interface DeleteEntityItemReviewsResponse extends IPlayFabResultCommon {
307
+ }
308
+ interface DeleteInventoryCollectionRequest extends IPlayFabRequestCommon {
309
+ /** The inventory collection id the request applies to. */
310
+ CollectionId?: string;
311
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
312
+ CustomTags?: Record<string, string | null>;
313
+ /** The entity the request is about. Set to the caller by default. */
314
+ Entity?: EntityKey;
315
+ /**
316
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
317
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
318
+ */
319
+ ETag?: string;
320
+ }
321
+ interface DeleteInventoryCollectionResponse extends IPlayFabResultCommon {
322
+ }
323
+ interface DeleteInventoryItemsOperation {
324
+ /** The inventory item the operation applies to. */
325
+ Item?: InventoryItemReference;
326
+ }
327
+ interface DeleteInventoryItemsRequest extends IPlayFabRequestCommon {
328
+ /**
329
+ * The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is
330
+ * unlimited.
331
+ */
332
+ CollectionId?: string;
333
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
334
+ CustomTags?: Record<string, string | null>;
335
+ /** The entity to perform this action on. */
336
+ Entity?: EntityKey;
337
+ /**
338
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
339
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
340
+ */
341
+ ETag?: string;
342
+ /**
343
+ * The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will
344
+ * be garbage collected eventually.
345
+ */
346
+ IdempotencyId?: string;
347
+ /** The inventory item the request applies to. */
348
+ Item?: InventoryItemReference;
349
+ }
350
+ interface DeleteInventoryItemsResponse extends IPlayFabResultCommon {
351
+ /** ETags are used for concurrency checking when updating resources. */
352
+ ETag?: string;
353
+ /** The idempotency id used in the request. */
354
+ IdempotencyId?: string;
355
+ /** The ids of transactions that occurred as a result of the request. */
356
+ TransactionIds?: string[];
357
+ }
358
+ interface DeleteItemRequest extends IPlayFabRequestCommon {
359
+ /** An alternate ID associated with this item. */
360
+ AlternateId?: CatalogAlternateId;
361
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
362
+ CustomTags?: Record<string, string | null>;
363
+ /** The entity to perform this action on. */
364
+ Entity?: EntityKey;
365
+ /** The unique ID of the item. */
366
+ Id?: string;
367
+ }
368
+ interface DeleteItemResponse extends IPlayFabResultCommon {
369
+ }
370
+ interface DisplayPropertyIndexInfo {
371
+ /** The property name in the 'DisplayProperties' property to be indexed. */
372
+ Name?: string;
373
+ /** The type of the property to be indexed. */
374
+ Type?: string;
375
+ }
376
+ interface EntityKey {
377
+ /** Unique ID of the entity. */
378
+ Id: string;
379
+ /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
380
+ Type?: string;
381
+ }
382
+ interface ExecuteInventoryOperationsRequest extends IPlayFabRequestCommon {
383
+ /**
384
+ * The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is
385
+ * unlimited.
386
+ */
387
+ CollectionId?: string;
388
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
389
+ CustomTags?: Record<string, string | null>;
390
+ /** The entity to perform this action on. */
391
+ Entity?: EntityKey;
392
+ /**
393
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
394
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
395
+ */
396
+ ETag?: string;
397
+ /**
398
+ * The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will
399
+ * be garbage collected eventually.
400
+ */
401
+ IdempotencyId?: string;
402
+ /**
403
+ * The operations to run transactionally. The operations will be executed in-order sequentially and will succeed or fail as
404
+ * a batch. Up to 50 operations can be added.
405
+ */
406
+ Operations?: InventoryOperation[];
407
+ }
408
+ interface ExecuteInventoryOperationsResponse extends IPlayFabResultCommon {
409
+ /**
410
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
411
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
412
+ */
413
+ ETag?: string;
414
+ /** The idempotency id used in the request. */
415
+ IdempotencyId?: string;
416
+ /** The ids of the transactions that occurred as a result of the request. */
417
+ TransactionIds?: string[];
418
+ }
419
+ interface ExecuteTransferOperationsRequest extends IPlayFabRequestCommon {
420
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
421
+ CustomTags?: Record<string, string | null>;
422
+ /** The inventory collection id the request is transferring from. (Default="default") */
423
+ GivingCollectionId?: string;
424
+ /** The entity the request is transferring from. Set to the caller by default. */
425
+ GivingEntity?: EntityKey;
426
+ /**
427
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
428
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
429
+ */
430
+ GivingETag?: string;
431
+ /** The idempotency id for the request. */
432
+ IdempotencyId?: string;
433
+ /**
434
+ * The transfer operations to run transactionally. The operations will be executed in-order sequentially and will succeed
435
+ * or fail as a batch. Up to 50 operations can be added.
436
+ */
437
+ Operations?: TransferInventoryItemsOperation[];
438
+ /** The inventory collection id the request is transferring to. (Default="default") */
439
+ ReceivingCollectionId?: string;
440
+ /** The entity the request is transferring to. Set to the caller by default. */
441
+ ReceivingEntity?: EntityKey;
442
+ }
443
+ interface ExecuteTransferOperationsResponse extends IPlayFabResultCommon {
444
+ /**
445
+ * ETags are used for concurrency checking when updating resources (before transferring from). This value will be empty if
446
+ * the operation has not completed yet. More information about using ETags can be found here:
447
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
448
+ */
449
+ GivingETag?: string;
450
+ /** The ids of transactions that occurred as a result of the request's giving action. */
451
+ GivingTransactionIds?: string[];
452
+ /** The Idempotency ID for this request. */
453
+ IdempotencyId?: string;
454
+ /**
455
+ * The transfer operation status. Possible values are 'InProgress' or 'Completed'. If the operation has completed, the
456
+ * response code will be 200. Otherwise, it will be 202.
457
+ */
458
+ OperationStatus?: string;
459
+ /**
460
+ * The token that can be used to get the status of the transfer operation. This will only have a value if OperationStatus
461
+ * is 'InProgress'.
462
+ */
463
+ OperationToken?: string;
464
+ /**
465
+ * ETags are used for concurrency checking when updating resources (before transferring to). This value will be empty if
466
+ * the operation has not completed yet.
467
+ */
468
+ ReceivingETag?: string;
469
+ /** The ids of transactions that occurred as a result of the request's receiving action. */
470
+ ReceivingTransactionIds?: string[];
471
+ }
472
+ interface FileConfig {
473
+ /**
474
+ * The set of content types that will be used for validation. Each content type can have a maximum character length of 40
475
+ * and up to 128 types can be listed.
476
+ */
477
+ ContentTypes?: string[];
478
+ /**
479
+ * The set of tags that will be used for validation. Each tag can have a maximum character length of 32 and up to 1024 tags
480
+ * can be listed.
481
+ */
482
+ Tags?: string[];
483
+ }
484
+ interface FilterOptions {
485
+ /**
486
+ * The OData filter utilized. Mutually exclusive with 'IncludeAllItems'. More info about Filter Complexity limits can be
487
+ * found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search#limits
488
+ */
489
+ Filter?: string;
490
+ /** The flag that overrides the filter and allows for returning all catalog items. Mutually exclusive with 'Filter'. */
491
+ IncludeAllItems?: boolean;
492
+ }
493
+ interface GetCatalogConfigRequest extends IPlayFabRequestCommon {
494
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
495
+ CustomTags?: Record<string, string | null>;
496
+ }
497
+ interface GetCatalogConfigResponse extends IPlayFabResultCommon {
498
+ /** The catalog configuration. */
499
+ Config?: CatalogConfig;
500
+ }
501
+ interface GetDraftItemRequest extends IPlayFabRequestCommon {
502
+ /** An alternate ID associated with this item. */
503
+ AlternateId?: CatalogAlternateId;
504
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
505
+ CustomTags?: Record<string, string | null>;
506
+ /** The entity to perform this action on. */
507
+ Entity?: EntityKey;
508
+ /** The unique ID of the item. */
509
+ Id?: string;
510
+ }
511
+ interface GetDraftItemResponse extends IPlayFabResultCommon {
512
+ /** Full metadata of the catalog item requested. */
513
+ Item?: CatalogItem;
514
+ }
515
+ interface GetDraftItemsRequest extends IPlayFabRequestCommon {
516
+ /** List of item alternate IDs. */
517
+ AlternateIds?: CatalogAlternateId[];
518
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
519
+ CustomTags?: Record<string, string | null>;
520
+ /** The entity to perform this action on. */
521
+ Entity?: EntityKey;
522
+ /** List of Item Ids. */
523
+ Ids?: string[];
524
+ }
525
+ interface GetDraftItemsResponse extends IPlayFabResultCommon {
526
+ /** An opaque token used to retrieve the next page of items, if any are available. */
527
+ ContinuationToken?: string;
528
+ /** A set of items created by the entity. */
529
+ Items?: CatalogItem[];
530
+ }
531
+ interface GetEntityDraftItemsRequest extends IPlayFabRequestCommon {
532
+ /**
533
+ * An opaque token used to retrieve the next page of items created by the caller, if any are available. Should be null on
534
+ * initial request.
535
+ */
536
+ ContinuationToken?: string;
537
+ /** Number of items to retrieve. This value is optional. Default value is 10. */
538
+ Count: number;
539
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
540
+ CustomTags?: Record<string, string | null>;
541
+ /** The entity to perform this action on. */
542
+ Entity?: EntityKey;
543
+ /**
544
+ * OData Filter to refine the items returned. CatalogItem properties 'type' can be used in the filter. For example: "type
545
+ * eq 'ugc'"
546
+ */
547
+ Filter?: string;
548
+ }
549
+ interface GetEntityDraftItemsResponse extends IPlayFabResultCommon {
550
+ /** An opaque token used to retrieve the next page of items, if any are available. */
551
+ ContinuationToken?: string;
552
+ /** A set of items created by the entity. */
553
+ Items?: CatalogItem[];
554
+ }
555
+ interface GetEntityItemReviewRequest extends IPlayFabRequestCommon {
556
+ /** An alternate ID associated with this item. */
557
+ AlternateId?: CatalogAlternateId;
558
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
559
+ CustomTags?: Record<string, string | null>;
560
+ /** The entity to perform this action on. */
561
+ Entity?: EntityKey;
562
+ /** The unique ID of the item. */
563
+ Id?: string;
564
+ }
565
+ interface GetEntityItemReviewResponse extends IPlayFabResultCommon {
566
+ /** The review the entity submitted for the requested item. */
567
+ Review?: Review;
568
+ }
569
+ interface GetInventoryCollectionIdsRequest extends IPlayFabRequestCommon {
570
+ /** An opaque token used to retrieve the next page of collection ids, if any are available. */
571
+ ContinuationToken?: string;
572
+ /** Number of items to retrieve. This value is optional. The default value is 10 */
573
+ Count: number;
574
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
575
+ CustomTags?: Record<string, string | null>;
576
+ /** The entity the request is about. Set to the caller by default. */
577
+ Entity?: EntityKey;
578
+ }
579
+ interface GetInventoryCollectionIdsResponse extends IPlayFabResultCommon {
580
+ /** The requested inventory collection ids. */
581
+ CollectionIds?: string[];
582
+ /** An opaque token used to retrieve the next page of collection ids, if any are available. */
583
+ ContinuationToken?: string;
584
+ }
585
+ interface GetInventoryItemsRequest extends IPlayFabRequestCommon {
586
+ /** The id of the entity's collection to perform this action on. (Default="default") */
587
+ CollectionId?: string;
588
+ /**
589
+ * An opaque token used to retrieve the next page of items in the inventory, if any are available. Should be null on
590
+ * initial request.
591
+ */
592
+ ContinuationToken?: string;
593
+ /** Number of items to retrieve. This value is optional. Maximum page size is 50. The default value is 10 */
594
+ Count: number;
595
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
596
+ CustomTags?: Record<string, string | null>;
597
+ /** The entity to perform this action on. */
598
+ Entity?: EntityKey;
599
+ /**
600
+ * OData Filter to refine the items returned. InventoryItem properties 'type', 'id', and 'stackId' can be used in the
601
+ * filter. For example: "type eq 'currency'"
602
+ */
603
+ Filter?: string;
604
+ }
605
+ interface GetInventoryItemsResponse extends IPlayFabResultCommon {
606
+ /** An opaque token used to retrieve the next page of items, if any are available. */
607
+ ContinuationToken?: string;
608
+ /**
609
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
610
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
611
+ */
612
+ ETag?: string;
613
+ /** The requested inventory items. */
614
+ Items?: InventoryItem[];
615
+ }
616
+ interface GetInventoryOperationStatusRequest extends IPlayFabRequestCommon {
617
+ /** The id of the entity's collection to perform this action on. (Default="default") */
618
+ CollectionId?: string;
619
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
620
+ CustomTags?: Record<string, string | null>;
621
+ /** The entity to perform this action on. */
622
+ Entity?: EntityKey;
623
+ }
624
+ interface GetInventoryOperationStatusResponse extends IPlayFabResultCommon {
625
+ /** The inventory operation status. */
626
+ OperationStatus?: string;
627
+ }
628
+ interface GetItemContainersRequest extends IPlayFabRequestCommon {
629
+ /** An alternate ID associated with this item. */
630
+ AlternateId?: CatalogAlternateId;
631
+ /**
632
+ * An opaque token used to retrieve the next page of items in the inventory, if any are available. Should be null on
633
+ * initial request.
634
+ */
635
+ ContinuationToken?: string;
636
+ /** Number of items to retrieve. This value is optional. Default value is 10. */
637
+ Count: number;
638
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
639
+ CustomTags?: Record<string, string | null>;
640
+ /** The entity to perform this action on. */
641
+ Entity?: EntityKey;
642
+ /** The unique ID of the item. */
643
+ Id?: string;
644
+ }
645
+ interface GetItemContainersResponse extends IPlayFabResultCommon {
646
+ /** List of Bundles and Stores containing the requested items. */
647
+ Containers?: CatalogItem[];
648
+ /** An opaque token used to retrieve the next page of items, if any are available. */
649
+ ContinuationToken?: string;
650
+ }
651
+ interface GetItemModerationStateRequest extends IPlayFabRequestCommon {
652
+ /** An alternate ID associated with this item. */
653
+ AlternateId?: CatalogAlternateId;
654
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
655
+ CustomTags?: Record<string, string | null>;
656
+ /** The unique ID of the item. */
657
+ Id?: string;
658
+ }
659
+ interface GetItemModerationStateResponse extends IPlayFabResultCommon {
660
+ /** The current moderation state for the requested item. */
661
+ State?: ModerationState;
662
+ }
663
+ interface GetItemPublishStatusRequest extends IPlayFabRequestCommon {
664
+ /** An alternate ID associated with this item. */
665
+ AlternateId?: CatalogAlternateId;
666
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
667
+ CustomTags?: Record<string, string | null>;
668
+ /** The entity to perform this action on. */
669
+ Entity?: EntityKey;
670
+ /** The unique ID of the item. */
671
+ Id?: string;
672
+ }
673
+ interface GetItemPublishStatusResponse extends IPlayFabResultCommon {
674
+ /** High level status of the published item. */
675
+ Result?: string;
676
+ /** Descriptive message about the current status of the publish. */
677
+ StatusMessage?: string;
678
+ }
679
+ interface GetItemRequest extends IPlayFabRequestCommon {
680
+ /** An alternate ID associated with this item. */
681
+ AlternateId?: CatalogAlternateId;
682
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
683
+ CustomTags?: Record<string, string | null>;
684
+ /** The entity to perform this action on. */
685
+ Entity?: EntityKey;
686
+ /** The unique ID of the item. */
687
+ Id?: string;
688
+ }
689
+ interface GetItemResponse extends IPlayFabResultCommon {
690
+ /** The item result. */
691
+ Item?: CatalogItem;
692
+ }
693
+ interface GetItemReviewsRequest extends IPlayFabRequestCommon {
694
+ /** An alternate ID associated with this item. */
695
+ AlternateId?: CatalogAlternateId;
696
+ /** An opaque token used to retrieve the next page of items, if any are available. */
697
+ ContinuationToken?: string;
698
+ /** Number of items to retrieve. This value is optional. Default value is 10. */
699
+ Count: number;
700
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
701
+ CustomTags?: Record<string, string | null>;
702
+ /** The unique ID of the item. */
703
+ Id?: string;
704
+ /**
705
+ * An OData orderBy used to order the results of the query. Possible values are Helpfulness, Rating, and Submitted (For
706
+ * example: "Submitted desc")
707
+ */
708
+ OrderBy?: string;
709
+ }
710
+ interface GetItemReviewsResponse extends IPlayFabResultCommon {
711
+ /** An opaque token used to retrieve the next page of items, if any are available. */
712
+ ContinuationToken?: string;
713
+ /** The paginated set of results. */
714
+ Reviews?: Review[];
715
+ }
716
+ interface GetItemReviewSummaryRequest extends IPlayFabRequestCommon {
717
+ /** An alternate ID associated with this item. */
718
+ AlternateId?: CatalogAlternateId;
719
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
720
+ CustomTags?: Record<string, string | null>;
721
+ /** The unique ID of the item. */
722
+ Id?: string;
723
+ }
724
+ interface GetItemReviewSummaryResponse extends IPlayFabResultCommon {
725
+ /** The least favorable review for this item. */
726
+ LeastFavorableReview?: Review;
727
+ /** The most favorable review for this item. */
728
+ MostFavorableReview?: Review;
729
+ /** The summary of ratings associated with this item. */
730
+ Rating?: Rating;
731
+ /** The total number of reviews associated with this item. */
732
+ ReviewsCount: number;
733
+ }
734
+ interface GetItemsRequest extends IPlayFabRequestCommon {
735
+ /** List of item alternate IDs. */
736
+ AlternateIds?: CatalogAlternateId[];
737
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
738
+ CustomTags?: Record<string, string | null>;
739
+ /** The entity to perform this action on. */
740
+ Entity?: EntityKey;
741
+ /** List of Item Ids. */
742
+ Ids?: string[];
743
+ }
744
+ interface GetItemsResponse extends IPlayFabResultCommon {
745
+ /** Metadata of set of items. */
746
+ Items?: CatalogItem[];
747
+ }
748
+ interface GetMicrosoftStoreAccessTokensRequest extends IPlayFabRequestCommon {
749
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
750
+ CustomTags?: Record<string, string | null>;
751
+ }
752
+ interface GetMicrosoftStoreAccessTokensResponse extends IPlayFabResultCommon {
753
+ /**
754
+ * The collections access token for calling https://onestore.microsoft.com/b2b/keys/create/collections to obtain a
755
+ * CollectionsIdKey for the user
756
+ */
757
+ CollectionsAccessToken?: string;
758
+ /** The date the collections access token expires */
759
+ CollectionsAccessTokenExpirationDate: string;
760
+ }
761
+ interface GetTransactionHistoryRequest extends IPlayFabRequestCommon {
762
+ /** The id of the entity's collection to perform this action on. (Default="default") */
763
+ CollectionId?: string;
764
+ /** An opaque token used to retrieve the next page of items, if any are available. Should be null on initial request. */
765
+ ContinuationToken?: string;
766
+ /** Number of items to retrieve. This value is optional. The default value is 10 */
767
+ Count: number;
768
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
769
+ CustomTags?: Record<string, string | null>;
770
+ /** The entity to perform this action on. */
771
+ Entity?: EntityKey;
772
+ /**
773
+ * An OData filter used to refine the TransactionHistory. Transaction properties 'timestamp', 'transactionid', 'apiname'
774
+ * and 'operationtype' can be used in the filter. Properties 'transactionid', 'apiname', and 'operationtype' cannot be used
775
+ * together in a single request. The 'timestamp' property can be combined with 'apiname' or 'operationtype' in a single
776
+ * request. For example: "timestamp ge 2023-06-20T23:30Z" or "transactionid eq '10'" or "(timestamp ge 2023-06-20T23:30Z)
777
+ * and (apiname eq 'AddInventoryItems')". By default, a 6 month timespan from the current date is used.
778
+ */
779
+ Filter?: string;
780
+ /**
781
+ * An OData orderby to order TransactionHistory results. The only supported values are 'timestamp asc' or 'timestamp desc'.
782
+ * Default orderby is 'timestamp asc'
783
+ */
784
+ OrderBy?: string;
785
+ }
786
+ interface GetTransactionHistoryResponse extends IPlayFabResultCommon {
787
+ /** An opaque token used to retrieve the next page of items, if any are available. Should be null on initial request. */
788
+ ContinuationToken?: string;
789
+ /** The requested inventory transactions. */
790
+ Transactions?: Transaction[];
791
+ }
792
+ interface GooglePlayProductPurchase {
793
+ /** The Product ID (SKU) of the InApp product purchased from the Google Play store. */
794
+ ProductId?: string;
795
+ /** The token provided to the player's device when the product was purchased */
796
+ Token?: string;
797
+ }
798
+ interface Image {
799
+ /** The image unique ID. */
800
+ Id?: string;
801
+ /**
802
+ * The client-defined tag associated with this image. Tags must be defined in the Catalog Config before being used in
803
+ * images
804
+ */
805
+ Tag?: string;
806
+ /** Images can be defined as either a "thumbnail" or "screenshot". There can only be one "thumbnail" image per item. */
807
+ Type?: string;
808
+ /** The URL for retrieval of the image. */
809
+ Url?: string;
810
+ }
811
+ interface ImageConfig {
812
+ /**
813
+ * The set of tags that will be used for validation. Each tag can have a maximum character length of 32 and up to 1024 tags
814
+ * can be listed.
815
+ */
816
+ Tags?: string[];
817
+ }
818
+ interface InitialValues {
819
+ /** Game specific properties for display purposes. The Display Properties field has a 1000 byte limit. */
820
+ DisplayProperties?: any;
821
+ }
822
+ interface InventoryItem {
823
+ /** The amount of the item. */
824
+ Amount?: number;
825
+ /**
826
+ * Game specific properties for display purposes. This is an arbitrary JSON blob. The Display Properties field has a 1000
827
+ * byte limit.
828
+ */
829
+ DisplayProperties?: any;
830
+ /** Only used for subscriptions. The date of when the item will expire in UTC. */
831
+ ExpirationDate?: string;
832
+ /** The id of the item. This should correspond to the item id in the catalog. */
833
+ Id?: string;
834
+ /** The stack id of the item. */
835
+ StackId?: string;
836
+ /** The type of the item. This should correspond to the item type in the catalog. */
837
+ Type?: string;
838
+ }
839
+ interface InventoryItemReference {
840
+ /** The inventory item alternate id the request applies to. */
841
+ AlternateId?: AlternateId;
842
+ /** The inventory item id the request applies to. */
843
+ Id?: string;
844
+ /** The inventory stack id the request should redeem to. (Default="default") */
845
+ StackId?: string;
846
+ }
847
+ interface InventoryOperation {
848
+ /** The add operation. */
849
+ Add?: AddInventoryItemsOperation;
850
+ /** The delete operation. */
851
+ Delete?: DeleteInventoryItemsOperation;
852
+ /** The purchase operation. */
853
+ Purchase?: PurchaseInventoryItemsOperation;
854
+ /** The subtract operation. */
855
+ Subtract?: SubtractInventoryItemsOperation;
856
+ /** The transfer operation. */
857
+ Transfer?: TransferInventoryItemsOperation;
858
+ /** The update operation. */
859
+ Update?: UpdateInventoryItemsOperation;
860
+ }
861
+ interface KeywordSet {
862
+ /** A list of localized keywords. */
863
+ Values?: string[];
864
+ }
865
+ interface ModerationState {
866
+ /** The date and time this moderation state was last updated. */
867
+ LastModifiedDate?: string;
868
+ /** The current stated reason for the associated item being moderated. */
869
+ Reason?: string;
870
+ /** The current moderation status for the associated item. */
871
+ Status?: string;
872
+ }
873
+ interface Permissions {
874
+ /**
875
+ * The list of ids of Segments that the a player can be in to purchase from the store. When a value is provided, the player
876
+ * must be in at least one of the segments listed for the purchase to be allowed.
877
+ */
878
+ SegmentIds?: string[];
879
+ }
880
+ interface PublishDraftItemRequest extends IPlayFabRequestCommon {
881
+ /** An alternate ID associated with this item. */
882
+ AlternateId?: CatalogAlternateId;
883
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
884
+ CustomTags?: Record<string, string | null>;
885
+ /** The entity to perform this action on. */
886
+ Entity?: EntityKey;
887
+ /**
888
+ * ETag of the catalog item to published from the working catalog to the public catalog. Used for optimistic concurrency.
889
+ * If the provided ETag does not match the ETag in the current working catalog, the request will be rejected. If not
890
+ * provided, the current version of the document in the working catalog will be published.
891
+ */
892
+ ETag?: string;
893
+ /** The unique ID of the item. */
894
+ Id?: string;
895
+ }
896
+ interface PublishDraftItemResponse extends IPlayFabResultCommon {
897
+ }
898
+ interface PurchaseInventoryItemsOperation {
899
+ /** The amount to purchase. */
900
+ Amount?: number;
901
+ /**
902
+ * Indicates whether stacks reduced to an amount of 0 during the operation should be deleted from the inventory. (Default =
903
+ * false)
904
+ */
905
+ DeleteEmptyStacks: boolean;
906
+ /** The duration to purchase. */
907
+ DurationInSeconds?: number;
908
+ /** The inventory item the operation applies to. */
909
+ Item?: InventoryItemReference;
910
+ /** The values to apply to a stack newly created by this operation. */
911
+ NewStackValues?: InitialValues;
912
+ /**
913
+ * The per-item price the item is expected to be purchased at. This must match a value configured in the Catalog or
914
+ * specified Store.
915
+ */
916
+ PriceAmounts?: PurchasePriceAmount[];
917
+ /** The id of the Store to purchase the item from. */
918
+ StoreId?: string;
919
+ }
920
+ interface PurchaseInventoryItemsRequest extends IPlayFabRequestCommon {
921
+ /** The amount to purchase. */
922
+ Amount?: number;
923
+ /**
924
+ * The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is
925
+ * unlimited.
926
+ */
927
+ CollectionId?: string;
928
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
929
+ CustomTags?: Record<string, string | null>;
930
+ /**
931
+ * Indicates whether stacks reduced to an amount of 0 during the request should be deleted from the inventory.
932
+ * (Default=false)
933
+ */
934
+ DeleteEmptyStacks: boolean;
935
+ /** The duration to purchase. */
936
+ DurationInSeconds?: number;
937
+ /** The entity to perform this action on. */
938
+ Entity?: EntityKey;
939
+ /**
940
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
941
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
942
+ */
943
+ ETag?: string;
944
+ /**
945
+ * The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will
946
+ * be garbage collected eventually.
947
+ */
948
+ IdempotencyId?: string;
949
+ /** The inventory item the request applies to. */
950
+ Item?: InventoryItemReference;
951
+ /** The values to apply to a stack newly created by this request. */
952
+ NewStackValues?: InitialValues;
953
+ /**
954
+ * The per-item price the item is expected to be purchased at. This must match a value configured in the Catalog or
955
+ * specified Store.
956
+ */
957
+ PriceAmounts?: PurchasePriceAmount[];
958
+ /** The id of the Store to purchase the item from. */
959
+ StoreId?: string;
960
+ }
961
+ interface PurchaseInventoryItemsResponse extends IPlayFabResultCommon {
962
+ /**
963
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
964
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
965
+ */
966
+ ETag?: string;
967
+ /** The idempotency id used in the request. */
968
+ IdempotencyId?: string;
969
+ /** The ids of transactions that occurred as a result of the request. */
970
+ TransactionIds?: string[];
971
+ }
972
+ interface PurchasePriceAmount {
973
+ /** The amount of the inventory item to use in the purchase . */
974
+ Amount: number;
975
+ /** The inventory item id to use in the purchase . */
976
+ ItemId?: string;
977
+ /** The inventory stack id the to use in the purchase. Set to "default" by default */
978
+ StackId?: string;
979
+ }
980
+ interface Rating {
981
+ /** The average rating for this item. */
982
+ Average?: number;
983
+ /** The total count of 1 star ratings for this item. */
984
+ Count1Star?: number;
985
+ /** The total count of 2 star ratings for this item. */
986
+ Count2Star?: number;
987
+ /** The total count of 3 star ratings for this item. */
988
+ Count3Star?: number;
989
+ /** The total count of 4 star ratings for this item. */
990
+ Count4Star?: number;
991
+ /** The total count of 5 star ratings for this item. */
992
+ Count5Star?: number;
993
+ /** The total count of ratings for this item. */
994
+ TotalCount?: number;
995
+ }
996
+ interface RealMoneyPriceDetails {
997
+ /** The 'AppleAppStore' price amount per CurrencyCode. 'USD' supported only. */
998
+ AppleAppStorePrices?: Record<string, number>;
999
+ /** The 'GooglePlay' price amount per CurrencyCode. 'USD' supported only. */
1000
+ GooglePlayPrices?: Record<string, number>;
1001
+ /** The 'MicrosoftStore' price amount per CurrencyCode. 'USD' supported only. */
1002
+ MicrosoftStorePrices?: Record<string, number>;
1003
+ /** The 'NintendoEShop' price amount per CurrencyCode. 'USD' supported only. */
1004
+ NintendoEShopPrices?: Record<string, number>;
1005
+ /** The 'PlayStationStore' price amount per CurrencyCode. 'USD' supported only. */
1006
+ PlayStationStorePrices?: Record<string, number>;
1007
+ /** The 'Steam' price amount per CurrencyCode. 'USD' supported only. */
1008
+ SteamPrices?: Record<string, number>;
1009
+ }
1010
+ interface RedeemAppleAppStoreInventoryItemsRequest extends IPlayFabRequestCommon {
1011
+ /** The id of the entity's collection to perform this action on. (Default="default") */
1012
+ CollectionId?: string;
1013
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1014
+ CustomTags?: Record<string, string | null>;
1015
+ /** The entity to perform this action on. */
1016
+ Entity?: EntityKey;
1017
+ /** The receipt provided by the Apple marketplace upon successful purchase. */
1018
+ Receipt?: string;
1019
+ }
1020
+ interface RedeemAppleAppStoreInventoryItemsResponse extends IPlayFabResultCommon {
1021
+ /** The list of failed redemptions from the external marketplace. */
1022
+ Failed?: RedemptionFailure[];
1023
+ /** The list of successful redemptions from the external marketplace. */
1024
+ Succeeded?: RedemptionSuccess[];
1025
+ /** The Transaction IDs associated with the inventory modifications */
1026
+ TransactionIds?: string[];
1027
+ }
1028
+ interface RedeemGooglePlayInventoryItemsRequest extends IPlayFabRequestCommon {
1029
+ /** The id of the entity's collection to perform this action on. (Default="default") */
1030
+ CollectionId?: string;
1031
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1032
+ CustomTags?: Record<string, string | null>;
1033
+ /** The entity to perform this action on. */
1034
+ Entity?: EntityKey;
1035
+ /** The list of purchases to redeem */
1036
+ Purchases?: GooglePlayProductPurchase[];
1037
+ }
1038
+ interface RedeemGooglePlayInventoryItemsResponse extends IPlayFabResultCommon {
1039
+ /** The list of failed redemptions from the external marketplace. */
1040
+ Failed?: RedemptionFailure[];
1041
+ /** The list of successful redemptions from the external marketplace. */
1042
+ Succeeded?: RedemptionSuccess[];
1043
+ /** The Transaction IDs associated with the inventory modifications */
1044
+ TransactionIds?: string[];
1045
+ }
1046
+ interface RedeemMicrosoftStoreInventoryItemsRequest extends IPlayFabRequestCommon {
1047
+ /** The id of the entity's collection to perform this action on. (Default="default") */
1048
+ CollectionId?: string;
1049
+ /** The OneStore Collections Id Key used for AAD authentication. */
1050
+ CollectionsIdKey?: string;
1051
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1052
+ CustomTags?: Record<string, string | null>;
1053
+ /** The entity to perform this action on. */
1054
+ Entity?: EntityKey;
1055
+ /**
1056
+ * Xbox Token used for delegated business partner authentication. Token provided by the Xbox Live SDK method
1057
+ * GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", "").
1058
+ */
1059
+ XboxToken?: string;
1060
+ }
1061
+ interface RedeemMicrosoftStoreInventoryItemsResponse extends IPlayFabResultCommon {
1062
+ /** The list of failed redemptions from the external marketplace. */
1063
+ Failed?: RedemptionFailure[];
1064
+ /** The list of successful redemptions from the external marketplace. */
1065
+ Succeeded?: RedemptionSuccess[];
1066
+ /** The Transaction IDs associated with the inventory modifications */
1067
+ TransactionIds?: string[];
1068
+ }
1069
+ interface RedeemNintendoEShopInventoryItemsRequest extends IPlayFabRequestCommon {
1070
+ /** The id of the entity's collection to perform this action on. (Default="default") */
1071
+ CollectionId?: string;
1072
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1073
+ CustomTags?: Record<string, string | null>;
1074
+ /** The entity to perform this action on. */
1075
+ Entity?: EntityKey;
1076
+ /** The Nintendo provided token authorizing redemption */
1077
+ NintendoServiceAccountIdToken?: string;
1078
+ }
1079
+ interface RedeemNintendoEShopInventoryItemsResponse extends IPlayFabResultCommon {
1080
+ /** The list of failed redemptions from the external marketplace. */
1081
+ Failed?: RedemptionFailure[];
1082
+ /** The list of successful redemptions from the external marketplace. */
1083
+ Succeeded?: RedemptionSuccess[];
1084
+ /** The Transaction IDs associated with the inventory modifications */
1085
+ TransactionIds?: string[];
1086
+ }
1087
+ interface RedeemPlayStationStoreInventoryItemsRequest extends IPlayFabRequestCommon {
1088
+ /** Auth code returned by PlayStation :tm: Network OAuth system. */
1089
+ AuthorizationCode?: string;
1090
+ /** The id of the entity's collection to perform this action on. (Default="default") */
1091
+ CollectionId?: string;
1092
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1093
+ CustomTags?: Record<string, string | null>;
1094
+ /** The entity to perform this action on. */
1095
+ Entity?: EntityKey;
1096
+ /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code. */
1097
+ RedirectUri?: string;
1098
+ /** Optional Service Label to pass into the request. */
1099
+ ServiceLabel?: string;
1100
+ }
1101
+ interface RedeemPlayStationStoreInventoryItemsResponse extends IPlayFabResultCommon {
1102
+ /** The list of failed redemptions from the external marketplace. */
1103
+ Failed?: RedemptionFailure[];
1104
+ /** The list of successful redemptions from the external marketplace. */
1105
+ Succeeded?: RedemptionSuccess[];
1106
+ /** The Transaction IDs associated with the inventory modifications */
1107
+ TransactionIds?: string[];
1108
+ }
1109
+ interface RedeemSteamInventoryItemsRequest extends IPlayFabRequestCommon {
1110
+ /** The id of the entity's collection to perform this action on. (Default="default") */
1111
+ CollectionId?: string;
1112
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1113
+ CustomTags?: Record<string, string | null>;
1114
+ /** The entity to perform this action on. */
1115
+ Entity?: EntityKey;
1116
+ }
1117
+ interface RedeemSteamInventoryItemsResponse extends IPlayFabResultCommon {
1118
+ /** The list of failed redemptions from the external marketplace. */
1119
+ Failed?: RedemptionFailure[];
1120
+ /** The list of successful redemptions from the external marketplace. */
1121
+ Succeeded?: RedemptionSuccess[];
1122
+ /** The Transaction IDs associated with the inventory modifications */
1123
+ TransactionIds?: string[];
1124
+ }
1125
+ interface RedemptionFailure {
1126
+ /** The marketplace failure code. */
1127
+ FailureCode?: string;
1128
+ /** The marketplace error details explaining why the offer failed to redeem. */
1129
+ FailureDetails?: string;
1130
+ /** The Marketplace Alternate ID being redeemed. */
1131
+ MarketplaceAlternateId?: string;
1132
+ /** The transaction id in the external marketplace. */
1133
+ MarketplaceTransactionId?: string;
1134
+ }
1135
+ interface RedemptionSuccess {
1136
+ /** The Marketplace Alternate ID being redeemed. */
1137
+ MarketplaceAlternateId?: string;
1138
+ /** The transaction id in the external marketplace. */
1139
+ MarketplaceTransactionId?: string;
1140
+ /** The timestamp for when the redeem was completed. */
1141
+ SuccessTimestamp: string;
1142
+ }
1143
+ interface ReportItemRequest extends IPlayFabRequestCommon {
1144
+ /** An alternate ID associated with this item. */
1145
+ AlternateId?: CatalogAlternateId;
1146
+ /** Category of concern for this report. */
1147
+ ConcernCategory?: string;
1148
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1149
+ CustomTags?: Record<string, string | null>;
1150
+ /** The entity to perform this action on. */
1151
+ Entity?: EntityKey;
1152
+ /** The unique ID of the item. */
1153
+ Id?: string;
1154
+ /** The string reason for this report. */
1155
+ Reason?: string;
1156
+ }
1157
+ interface ReportItemResponse extends IPlayFabResultCommon {
1158
+ }
1159
+ interface ReportItemReviewRequest extends IPlayFabRequestCommon {
1160
+ /** An alternate ID of the item associated with the review. */
1161
+ AlternateId?: CatalogAlternateId;
1162
+ /** The reason this review is being reported. */
1163
+ ConcernCategory?: string;
1164
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1165
+ CustomTags?: Record<string, string | null>;
1166
+ /** The entity to perform this action on. */
1167
+ Entity?: EntityKey;
1168
+ /** The string ID of the item associated with the review. */
1169
+ ItemId?: string;
1170
+ /** The string reason for this report. */
1171
+ Reason?: string;
1172
+ /** The ID of the review to submit a report for. */
1173
+ ReviewId?: string;
1174
+ }
1175
+ interface ReportItemReviewResponse extends IPlayFabResultCommon {
1176
+ }
1177
+ interface Review {
1178
+ /** The star rating associated with each selected category in this review. */
1179
+ CategoryRatings?: Record<string, number>;
1180
+ /** The number of negative helpfulness votes for this review. */
1181
+ HelpfulNegative: number;
1182
+ /** The number of positive helpfulness votes for this review. */
1183
+ HelpfulPositive: number;
1184
+ /** Indicates whether the review author has the item installed. */
1185
+ IsInstalled: boolean;
1186
+ /** The ID of the item being reviewed. */
1187
+ ItemId?: string;
1188
+ /** The version of the item being reviewed. */
1189
+ ItemVersion?: string;
1190
+ /** The locale for which this review was submitted in. */
1191
+ Locale?: string;
1192
+ /** Star rating associated with this review. */
1193
+ Rating: number;
1194
+ /** The ID of the author of the review. */
1195
+ ReviewerEntity?: EntityKey;
1196
+ /** The ID of the review. */
1197
+ ReviewId?: string;
1198
+ /** The full text of this review. */
1199
+ ReviewText?: string;
1200
+ /** The date and time this review was last submitted. */
1201
+ Submitted: string;
1202
+ /** The title of this review. */
1203
+ Title?: string;
1204
+ }
1205
+ interface ReviewConfig {
1206
+ /** A set of categories that can be applied toward ratings and reviews. */
1207
+ CategoryRatings?: CategoryRatingConfig[];
1208
+ }
1209
+ interface ReviewItemRequest extends IPlayFabRequestCommon {
1210
+ /** An alternate ID associated with this item. */
1211
+ AlternateId?: CatalogAlternateId;
1212
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1213
+ CustomTags?: Record<string, string | null>;
1214
+ /** The entity to perform this action on. */
1215
+ Entity?: EntityKey;
1216
+ /** The unique ID of the item. */
1217
+ Id?: string;
1218
+ /** The review to submit. */
1219
+ Review?: Review;
1220
+ }
1221
+ interface ReviewItemResponse extends IPlayFabResultCommon {
1222
+ }
1223
+ interface ReviewTakedown {
1224
+ /** An alternate ID associated with this item. */
1225
+ AlternateId?: CatalogAlternateId;
1226
+ /** The ID of the item associated with the review to take down. */
1227
+ ItemId?: string;
1228
+ /** The ID of the review to take down. */
1229
+ ReviewId?: string;
1230
+ }
1231
+ interface SearchItemsRequest extends IPlayFabRequestCommon {
1232
+ /** An opaque token used to retrieve the next page of items, if any are available. */
1233
+ ContinuationToken?: string;
1234
+ /** Number of items to retrieve. This value is optional. Maximum page size is 50. Default value is 10. */
1235
+ Count: number;
1236
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1237
+ CustomTags?: Record<string, string | null>;
1238
+ /** The entity to perform this action on. */
1239
+ Entity?: EntityKey;
1240
+ /**
1241
+ * An OData filter used to refine the search query (For example: "type eq 'ugc'"). More info about Filter Complexity limits
1242
+ * can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search#limits
1243
+ */
1244
+ Filter?: string;
1245
+ /** The locale to be returned in the result. */
1246
+ Language?: string;
1247
+ /** An OData orderBy used to order the results of the search query. For example: "rating/average asc" */
1248
+ OrderBy?: string;
1249
+ /** The text to search for. */
1250
+ Search?: string;
1251
+ /**
1252
+ * An OData select query option used to augment the search results. If not defined, the default search result metadata will
1253
+ * be returned.
1254
+ */
1255
+ Select?: string;
1256
+ /** The store to restrict the search request to. */
1257
+ Store?: StoreReference;
1258
+ }
1259
+ interface SearchItemsResponse extends IPlayFabResultCommon {
1260
+ /** An opaque token used to retrieve the next page of items, if any are available. */
1261
+ ContinuationToken?: string;
1262
+ /** The paginated set of results for the search query. */
1263
+ Items?: CatalogItem[];
1264
+ }
1265
+ interface SetItemModerationStateRequest extends IPlayFabRequestCommon {
1266
+ /** An alternate ID associated with this item. */
1267
+ AlternateId?: CatalogAlternateId;
1268
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1269
+ CustomTags?: Record<string, string | null>;
1270
+ /** The unique ID of the item. */
1271
+ Id?: string;
1272
+ /** The reason for the moderation state change for the associated item. */
1273
+ Reason?: string;
1274
+ /** The status to set for the associated item. */
1275
+ Status?: string;
1276
+ }
1277
+ interface SetItemModerationStateResponse extends IPlayFabResultCommon {
1278
+ }
1279
+ interface StoreDetails {
1280
+ /** The options for the filter in filter-based stores. These options are mutually exclusive with item references. */
1281
+ FilterOptions?: FilterOptions;
1282
+ /** The permissions that control which players can purchase from the store. */
1283
+ Permissions?: Permissions;
1284
+ /** The global prices utilized in the store. These options are mutually exclusive with price options in item references. */
1285
+ PriceOptionsOverride?: CatalogPriceOptionsOverride;
1286
+ }
1287
+ interface StoreReference {
1288
+ /** An alternate ID of the store. */
1289
+ AlternateId?: CatalogAlternateId;
1290
+ /** The unique ID of the store. */
1291
+ Id?: string;
1292
+ }
1293
+ interface SubmitItemReviewVoteRequest extends IPlayFabRequestCommon {
1294
+ /** An alternate ID of the item associated with the review. */
1295
+ AlternateId?: CatalogAlternateId;
1296
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1297
+ CustomTags?: Record<string, string | null>;
1298
+ /** The entity to perform this action on. */
1299
+ Entity?: EntityKey;
1300
+ /** The string ID of the item associated with the review. */
1301
+ ItemId?: string;
1302
+ /** The ID of the review to submit a helpfulness vote for. */
1303
+ ReviewId?: string;
1304
+ /** The helpfulness vote of the review. */
1305
+ Vote?: string;
1306
+ }
1307
+ interface SubmitItemReviewVoteResponse extends IPlayFabResultCommon {
1308
+ }
1309
+ interface SubtractInventoryItemsOperation {
1310
+ /** The amount to subtract from the current item amount. */
1311
+ Amount?: number;
1312
+ /**
1313
+ * Indicates whether stacks reduced to an amount of 0 during the request should be deleted from the inventory. (Default =
1314
+ * false).
1315
+ */
1316
+ DeleteEmptyStacks: boolean;
1317
+ /** The duration to subtract from the current item expiration date. */
1318
+ DurationInSeconds?: number;
1319
+ /** The inventory item the operation applies to. */
1320
+ Item?: InventoryItemReference;
1321
+ }
1322
+ interface SubtractInventoryItemsRequest extends IPlayFabRequestCommon {
1323
+ /** The amount to subtract for the current item. */
1324
+ Amount?: number;
1325
+ /**
1326
+ * The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is
1327
+ * unlimited.
1328
+ */
1329
+ CollectionId?: string;
1330
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1331
+ CustomTags?: Record<string, string | null>;
1332
+ /**
1333
+ * Indicates whether stacks reduced to an amount of 0 during the request should be deleted from the inventory.
1334
+ * (Default=false)
1335
+ */
1336
+ DeleteEmptyStacks: boolean;
1337
+ /** The duration to subtract from the current item expiration date. */
1338
+ DurationInSeconds?: number;
1339
+ /** The entity to perform this action on. */
1340
+ Entity?: EntityKey;
1341
+ /**
1342
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
1343
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
1344
+ */
1345
+ ETag?: string;
1346
+ /**
1347
+ * The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will
1348
+ * be garbage collected eventually.
1349
+ */
1350
+ IdempotencyId?: string;
1351
+ /** The inventory item the request applies to. */
1352
+ Item?: InventoryItemReference;
1353
+ }
1354
+ interface SubtractInventoryItemsResponse extends IPlayFabResultCommon {
1355
+ /**
1356
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
1357
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
1358
+ */
1359
+ ETag?: string;
1360
+ /** The idempotency id used in the request. */
1361
+ IdempotencyId?: string;
1362
+ /** The ids of transactions that occurred as a result of the request. */
1363
+ TransactionIds?: string[];
1364
+ }
1365
+ interface TakedownItemReviewsRequest extends IPlayFabRequestCommon {
1366
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1367
+ CustomTags?: Record<string, string | null>;
1368
+ /** The set of reviews to take down. */
1369
+ Reviews?: ReviewTakedown[];
1370
+ }
1371
+ interface TakedownItemReviewsResponse extends IPlayFabResultCommon {
1372
+ }
1373
+ interface Transaction {
1374
+ /** The API call that caused this transaction. */
1375
+ ApiName?: string;
1376
+ /** The type of item that the the operation occurred on. */
1377
+ ItemType?: string;
1378
+ /** The operations that occurred. */
1379
+ Operations?: TransactionOperation[];
1380
+ /** The type of operation that was run. */
1381
+ OperationType?: string;
1382
+ /** Additional details about the transaction. Null if it was not a purchase operation. */
1383
+ PurchaseDetails?: TransactionPurchaseDetails;
1384
+ /** Additional details about the transaction. Null if it was not a redeem operation. */
1385
+ RedeemDetails?: TransactionRedeemDetails;
1386
+ /** The time this transaction occurred in UTC. */
1387
+ Timestamp: string;
1388
+ /** The id of the transaction. This should be treated like an opaque token. */
1389
+ TransactionId?: string;
1390
+ /** Additional details about the transaction. Null if it was not a transfer operation. */
1391
+ TransferDetails?: TransactionTransferDetails;
1392
+ }
1393
+ interface TransactionOperation {
1394
+ /** The amount of items in this transaction. */
1395
+ Amount?: number;
1396
+ /** The duration modified in this transaction. */
1397
+ DurationInSeconds?: number;
1398
+ /** The friendly id of the items in this transaction. */
1399
+ ItemFriendlyId?: string;
1400
+ /** The item id of the items in this transaction. */
1401
+ ItemId?: string;
1402
+ /** The type of item that the operation occurred on. */
1403
+ ItemType?: string;
1404
+ /** The stack id of the items in this transaction. */
1405
+ StackId?: string;
1406
+ /** The type of the operation that occurred. */
1407
+ Type?: string;
1408
+ }
1409
+ interface TransactionPurchaseDetails {
1410
+ /** The friendly id of the Store the item was purchased from or null. */
1411
+ StoreFriendlyId?: string;
1412
+ /** The id of the Store the item was purchased from or null. */
1413
+ StoreId?: string;
1414
+ }
1415
+ interface TransactionRedeemDetails {
1416
+ /** The marketplace that the offer is being redeemed from. */
1417
+ Marketplace?: string;
1418
+ /** The transaction Id returned from the marketplace. */
1419
+ MarketplaceTransactionId?: string;
1420
+ /** The offer Id of the item being redeemed. */
1421
+ OfferId?: string;
1422
+ }
1423
+ interface TransactionTransferDetails {
1424
+ /** The collection id the items were transferred from or null if it was the current collection. */
1425
+ GivingCollectionId?: string;
1426
+ /** The entity the items were transferred from or null if it was the current entity. */
1427
+ GivingEntity?: EntityKey;
1428
+ /** The collection id the items were transferred to or null if it was the current collection. */
1429
+ ReceivingCollectionId?: string;
1430
+ /** The entity the items were transferred to or null if it was the current entity. */
1431
+ ReceivingEntity?: EntityKey;
1432
+ /** The id of the transfer that occurred. */
1433
+ TransferId?: string;
1434
+ }
1435
+ interface TransferInventoryItemsOperation {
1436
+ /** The amount to transfer. */
1437
+ Amount?: number;
1438
+ /**
1439
+ * Indicates whether stacks reduced to an amount of 0 during the operation should be deleted from the inventory. (Default =
1440
+ * false)
1441
+ */
1442
+ DeleteEmptyStacks: boolean;
1443
+ /** The inventory item the operation is transferring from. */
1444
+ GivingItem?: InventoryItemReference;
1445
+ /** The values to apply to a stack newly created by this operation. */
1446
+ NewStackValues?: InitialValues;
1447
+ /** The inventory item the operation is transferring to. */
1448
+ ReceivingItem?: InventoryItemReference;
1449
+ }
1450
+ interface TransferInventoryItemsRequest extends IPlayFabRequestCommon {
1451
+ /** The amount to transfer . */
1452
+ Amount?: number;
1453
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1454
+ CustomTags?: Record<string, string | null>;
1455
+ /**
1456
+ * Indicates whether stacks reduced to an amount of 0 during the request should be deleted from the inventory. (Default =
1457
+ * false)
1458
+ */
1459
+ DeleteEmptyStacks: boolean;
1460
+ /** The inventory collection id the request is transferring from. (Default="default") */
1461
+ GivingCollectionId?: string;
1462
+ /** The entity the request is transferring from. Set to the caller by default. */
1463
+ GivingEntity?: EntityKey;
1464
+ /**
1465
+ * ETags are used for concurrency checking when updating resources (before transferring from). More information about using
1466
+ * ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
1467
+ */
1468
+ GivingETag?: string;
1469
+ /** The inventory item the request is transferring from. */
1470
+ GivingItem?: InventoryItemReference;
1471
+ /** The idempotency id for the request. */
1472
+ IdempotencyId?: string;
1473
+ /** The values to apply to a stack newly created by this request. */
1474
+ NewStackValues?: InitialValues;
1475
+ /** The inventory collection id the request is transferring to. (Default="default") */
1476
+ ReceivingCollectionId?: string;
1477
+ /** The entity the request is transferring to. Set to the caller by default. */
1478
+ ReceivingEntity?: EntityKey;
1479
+ /** The inventory item the request is transferring to. */
1480
+ ReceivingItem?: InventoryItemReference;
1481
+ }
1482
+ interface TransferInventoryItemsResponse extends IPlayFabResultCommon {
1483
+ /**
1484
+ * ETags are used for concurrency checking when updating resources (after transferring from). More information about using
1485
+ * ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
1486
+ */
1487
+ GivingETag?: string;
1488
+ /** The ids of transactions that occurred as a result of the request's giving action. */
1489
+ GivingTransactionIds?: string[];
1490
+ /** The idempotency id for the request. */
1491
+ IdempotencyId?: string;
1492
+ /**
1493
+ * The transfer operation status. Possible values are 'InProgress' or 'Completed'. If the operation has completed, the
1494
+ * response code will be 200. Otherwise, it will be 202.
1495
+ */
1496
+ OperationStatus?: string;
1497
+ /**
1498
+ * The token that can be used to get the status of the transfer operation. This will only have a value if OperationStatus
1499
+ * is 'InProgress'.
1500
+ */
1501
+ OperationToken?: string;
1502
+ /** The ids of transactions that occurred as a result of the request's receiving action. */
1503
+ ReceivingTransactionIds?: string[];
1504
+ }
1505
+ interface UpdateCatalogConfigRequest extends IPlayFabRequestCommon {
1506
+ /** The updated catalog configuration. */
1507
+ Config?: CatalogConfig;
1508
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1509
+ CustomTags?: Record<string, string | null>;
1510
+ }
1511
+ interface UpdateCatalogConfigResponse extends IPlayFabResultCommon {
1512
+ }
1513
+ interface UpdateDraftItemRequest extends IPlayFabRequestCommon {
1514
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1515
+ CustomTags?: Record<string, string | null>;
1516
+ /** Updated metadata describing the catalog item to be updated. */
1517
+ Item?: CatalogItem;
1518
+ /** Whether the item should be published immediately. This value is optional, defaults to false. */
1519
+ Publish: boolean;
1520
+ }
1521
+ interface UpdateDraftItemResponse extends IPlayFabResultCommon {
1522
+ /** Updated metadata describing the catalog item just updated. */
1523
+ Item?: CatalogItem;
1524
+ }
1525
+ interface UpdateInventoryItemsOperation {
1526
+ /** The inventory item to update with the specified values. */
1527
+ Item?: InventoryItem;
1528
+ }
1529
+ interface UpdateInventoryItemsRequest extends IPlayFabRequestCommon {
1530
+ /**
1531
+ * The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is
1532
+ * unlimited.
1533
+ */
1534
+ CollectionId?: string;
1535
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1536
+ CustomTags?: Record<string, string | null>;
1537
+ /** The entity to perform this action on. */
1538
+ Entity?: EntityKey;
1539
+ /**
1540
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
1541
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
1542
+ */
1543
+ ETag?: string;
1544
+ /**
1545
+ * The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will
1546
+ * be garbage collected eventually.
1547
+ */
1548
+ IdempotencyId?: string;
1549
+ /** The inventory item to update with the specified values. */
1550
+ Item?: InventoryItem;
1551
+ }
1552
+ interface UpdateInventoryItemsResponse extends IPlayFabResultCommon {
1553
+ /**
1554
+ * ETags are used for concurrency checking when updating resources. More information about using ETags can be found here:
1555
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
1556
+ */
1557
+ ETag?: string;
1558
+ /** The idempotency id used in the request. */
1559
+ IdempotencyId?: string;
1560
+ /** The ids of transactions that occurred as a result of the request. */
1561
+ TransactionIds?: string[];
1562
+ }
1563
+ interface UploadInfo {
1564
+ /** Name of the file to be uploaded. */
1565
+ FileName?: string;
1566
+ }
1567
+ interface UploadUrlMetadata {
1568
+ /** Name of the file for which this upload URL was requested. */
1569
+ FileName?: string;
1570
+ /** Unique ID for the binary content to be uploaded to the target URL. */
1571
+ Id?: string;
1572
+ /** URL for the binary content to be uploaded to. */
1573
+ Url?: string;
1574
+ }
1575
+ interface UserGeneratedContentSpecificConfig {
1576
+ /** The set of content types that will be used for validation. */
1577
+ ContentTypes?: string[];
1578
+ /** The set of tags that will be used for validation. */
1579
+ Tags?: string[];
1580
+ }
1581
+
1582
+ declare class PlayFabEconomyApi extends PlayFabCommon {
1583
+ /**
1584
+ * Add inventory items. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is uncapped.
1585
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/addinventoryitems
1586
+ */
1587
+ AddInventoryItems(request: AddInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddInventoryItemsResponse>;
1588
+ /**
1589
+ * Creates a new item in the working catalog using provided metadata. Note: SAS tokens provided are valid for 1 hour.
1590
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/createdraftitem
1591
+ */
1592
+ CreateDraftItem(request: CreateDraftItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateDraftItemResponse>;
1593
+ /**
1594
+ * Creates one or more upload URLs which can be used by the client to upload raw file data. Content URls and uploaded
1595
+ * content will be garbage collected after 24 hours if not attached to a draft or published item. Detailed pricing info
1596
+ * around uploading content can be found here:
1597
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/pricing/meters/catalog-meters
1598
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/createuploadurls
1599
+ */
1600
+ CreateUploadUrls(request: CreateUploadUrlsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateUploadUrlsResponse>;
1601
+ /**
1602
+ * Deletes all reviews, helpfulness votes, and ratings submitted by the entity specified.
1603
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/deleteentityitemreviews
1604
+ */
1605
+ DeleteEntityItemReviews(request: DeleteEntityItemReviewsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteEntityItemReviewsResponse>;
1606
+ /**
1607
+ * Delete an Inventory Collection. More information about Inventory Collections can be found here:
1608
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/collections
1609
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/deleteinventorycollection
1610
+ */
1611
+ DeleteInventoryCollection(request: DeleteInventoryCollectionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteInventoryCollectionResponse>;
1612
+ /**
1613
+ * Delete inventory items
1614
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/deleteinventoryitems
1615
+ */
1616
+ DeleteInventoryItems(request: DeleteInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteInventoryItemsResponse>;
1617
+ /**
1618
+ * Removes an item from working catalog and all published versions from the public catalog.
1619
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/deleteitem
1620
+ */
1621
+ DeleteItem(request: DeleteItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteItemResponse>;
1622
+ /**
1623
+ * Execute a list of Inventory Operations. A maximum list of 50 operations can be performed by a single request. There is
1624
+ * also a limit to 300 items that can be modified/added in a single request. For example, adding a bundle with 50 items
1625
+ * counts as 50 items modified. All operations must be done within a single inventory collection. This API has a reduced
1626
+ * RPS compared to an individual inventory operation with Player Entities limited to 60 requests in 90 seconds.
1627
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/executeinventoryoperations
1628
+ */
1629
+ ExecuteInventoryOperations(request: ExecuteInventoryOperationsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ExecuteInventoryOperationsResponse>;
1630
+ /**
1631
+ * Transfer a list of inventory items. A maximum list of 50 operations can be performed by a single request. When the
1632
+ * response code is 202, one or more operations did not complete within the timeframe of the request. You can identify the
1633
+ * pending operations by looking for OperationStatus = 'InProgress'. You can check on the operation status at anytime
1634
+ * within 1 day of the request by passing the TransactionToken to the GetInventoryOperationStatus API.
1635
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/executetransferoperations
1636
+ */
1637
+ ExecuteTransferOperations(request: ExecuteTransferOperationsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ExecuteTransferOperationsResponse>;
1638
+ /**
1639
+ * Gets the configuration for the catalog. Only Title Entities can call this API. There is a limit of 100 requests in 10
1640
+ * seconds for this API. More information about the Catalog Config can be found here:
1641
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings
1642
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getcatalogconfig
1643
+ */
1644
+ GetCatalogConfig(request: GetCatalogConfigRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCatalogConfigResponse>;
1645
+ /**
1646
+ * Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem
1647
+ * does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note
1648
+ * that item references data is cached and may take a few moments for changes to propagate. Note: SAS tokens provided are
1649
+ * valid for 1 hour.
1650
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getdraftitem
1651
+ */
1652
+ GetDraftItem(request: GetDraftItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetDraftItemResponse>;
1653
+ /**
1654
+ * Retrieves a paginated list of the items from the draft catalog. Up to 50 IDs can be retrieved in a single request.
1655
+ * GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. Note:
1656
+ * SAS tokens provided are valid for 1 hour.
1657
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getdraftitems
1658
+ */
1659
+ GetDraftItems(request: GetDraftItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetDraftItemsResponse>;
1660
+ /**
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
+ * once. You can use continuation tokens to paginate through results that return greater than the limit.
1663
+ * GetEntityDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates.
1664
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getentitydraftitems
1665
+ */
1666
+ GetEntityDraftItems(request: GetEntityDraftItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetEntityDraftItemsResponse>;
1667
+ /**
1668
+ * Gets the submitted review for the specified item by the authenticated entity. Individual ratings and reviews data update
1669
+ * in near real time with delays within a few seconds.
1670
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getentityitemreview
1671
+ */
1672
+ GetEntityItemReview(request: GetEntityItemReviewRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetEntityItemReviewResponse>;
1673
+ /**
1674
+ * Get Inventory Collection Ids. Up to 50 Ids can be returned at once (or 250 with response compression enabled). You can
1675
+ * use continuation tokens to paginate through results that return greater than the limit. It can take a few seconds for
1676
+ * new collection Ids to show up.
1677
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/getinventorycollectionids
1678
+ */
1679
+ GetInventoryCollectionIds(request: GetInventoryCollectionIdsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetInventoryCollectionIdsResponse>;
1680
+ /**
1681
+ * Get current inventory items.
1682
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/getinventoryitems
1683
+ */
1684
+ GetInventoryItems(request: GetInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetInventoryItemsResponse>;
1685
+ /**
1686
+ * Get the status of an inventory operation using an OperationToken. You can check on the operation status at anytime
1687
+ * within 1 day of the request by passing the TransactionToken to the this API.
1688
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/getinventoryoperationstatus
1689
+ */
1690
+ GetInventoryOperationStatus(request: GetInventoryOperationStatusRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetInventoryOperationStatusResponse>;
1691
+ /**
1692
+ * Retrieves an item from the public catalog. GetItem does not work off a cache of the Catalog and should be used when
1693
+ * trying to get recent item updates. However, please note that item references data is cached and may take a few moments
1694
+ * for changes to propagate.
1695
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitem
1696
+ */
1697
+ GetItem(request: GetItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetItemResponse>;
1698
+ /**
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
+ * once. You can use continuation tokens to paginate through results that return greater than the limit. This API is
1701
+ * intended for tooling/automation scenarios and has a reduced RPS with Player Entities limited to 30 requests in 300
1702
+ * seconds and Title Entities limited to 100 requests in 10 seconds.
1703
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitemcontainers
1704
+ */
1705
+ GetItemContainers(request: GetItemContainersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetItemContainersResponse>;
1706
+ /**
1707
+ * Gets the moderation state for an item, including the concern category and string reason. More information about
1708
+ * moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation
1709
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitemmoderationstate
1710
+ */
1711
+ GetItemModerationState(request: GetItemModerationStateRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetItemModerationStateResponse>;
1712
+ /**
1713
+ * Gets the status of a publish of an item.
1714
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitempublishstatus
1715
+ */
1716
+ GetItemPublishStatus(request: GetItemPublishStatusRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetItemPublishStatusResponse>;
1717
+ /**
1718
+ * Get a paginated set of reviews associated with the specified item. Individual ratings and reviews data update in near
1719
+ * real time with delays within a few seconds.
1720
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitemreviews
1721
+ */
1722
+ GetItemReviews(request: GetItemReviewsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetItemReviewsResponse>;
1723
+ /**
1724
+ * Get a summary of all ratings and reviews associated with the specified item. Summary ratings data is cached with update
1725
+ * data coming within 15 minutes.
1726
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitemreviewsummary
1727
+ */
1728
+ GetItemReviewSummary(request: GetItemReviewSummaryRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetItemReviewSummaryResponse>;
1729
+ /**
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
+ * the Catalog and should be used when trying to get recent item updates. However, please note that item references data is
1732
+ * cached and may take a few moments for changes to propagate.
1733
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitems
1734
+ */
1735
+ GetItems(request: GetItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetItemsResponse>;
1736
+ /**
1737
+ * Gets the access tokens.
1738
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/getmicrosoftstoreaccesstokens
1739
+ */
1740
+ GetMicrosoftStoreAccessTokens(request: GetMicrosoftStoreAccessTokensRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetMicrosoftStoreAccessTokensResponse>;
1741
+ /**
1742
+ * Get transaction history for a player. Up to 250 Events can be returned at once. You can use continuation tokens to
1743
+ * paginate through results that return greater than the limit. Getting transaction history has a lower RPS limit than
1744
+ * getting a Player's inventory with Player Entities having a limit of 30 requests in 300 seconds.
1745
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/gettransactionhistory
1746
+ */
1747
+ GetTransactionHistory(request: GetTransactionHistoryRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTransactionHistoryResponse>;
1748
+ /**
1749
+ * Initiates a publish of an item from the working catalog to the public catalog. You can use the GetItemPublishStatus API
1750
+ * to track the state of the item publish.
1751
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/publishdraftitem
1752
+ */
1753
+ PublishDraftItem(request: PublishDraftItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<PublishDraftItemResponse>;
1754
+ /**
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
+ * uncapped.
1757
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/purchaseinventoryitems
1758
+ */
1759
+ PurchaseInventoryItems(request: PurchaseInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<PurchaseInventoryItemsResponse>;
1760
+ /**
1761
+ * Redeem items.
1762
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemappleappstoreinventoryitems
1763
+ */
1764
+ RedeemAppleAppStoreInventoryItems(request: RedeemAppleAppStoreInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RedeemAppleAppStoreInventoryItemsResponse>;
1765
+ /**
1766
+ * Redeem items.
1767
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemgoogleplayinventoryitems
1768
+ */
1769
+ RedeemGooglePlayInventoryItems(request: RedeemGooglePlayInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RedeemGooglePlayInventoryItemsResponse>;
1770
+ /**
1771
+ * Redeem items.
1772
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemmicrosoftstoreinventoryitems
1773
+ */
1774
+ RedeemMicrosoftStoreInventoryItems(request: RedeemMicrosoftStoreInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RedeemMicrosoftStoreInventoryItemsResponse>;
1775
+ /**
1776
+ * Redeem items.
1777
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemnintendoeshopinventoryitems
1778
+ */
1779
+ RedeemNintendoEShopInventoryItems(request: RedeemNintendoEShopInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RedeemNintendoEShopInventoryItemsResponse>;
1780
+ /**
1781
+ * Redeem items.
1782
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemplaystationstoreinventoryitems
1783
+ */
1784
+ RedeemPlayStationStoreInventoryItems(request: RedeemPlayStationStoreInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RedeemPlayStationStoreInventoryItemsResponse>;
1785
+ /**
1786
+ * Redeem items.
1787
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemsteaminventoryitems
1788
+ */
1789
+ RedeemSteamInventoryItems(request: RedeemSteamInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RedeemSteamInventoryItemsResponse>;
1790
+ /**
1791
+ * Submit a report for an item, indicating in what way the item is inappropriate.
1792
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/reportitem
1793
+ */
1794
+ ReportItem(request: ReportItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ReportItemResponse>;
1795
+ /**
1796
+ * Submit a report for a review
1797
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/reportitemreview
1798
+ */
1799
+ ReportItemReview(request: ReportItemReviewRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ReportItemReviewResponse>;
1800
+ /**
1801
+ * Creates or updates a review for the specified item. More information around the caching surrounding item ratings and
1802
+ * reviews can be found here:
1803
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/ratings#ratings-design-and-caching
1804
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/reviewitem
1805
+ */
1806
+ ReviewItem(request: ReviewItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ReviewItemResponse>;
1807
+ /**
1808
+ * Executes a search against the public catalog using the provided search parameters and returns a set of paginated
1809
+ * results. SearchItems uses a cache of the catalog with item updates taking up to a few minutes to propagate. You should
1810
+ * use the GetItem API for when trying to immediately get recent item updates. More information about the Search API can be
1811
+ * found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search
1812
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/searchitems
1813
+ */
1814
+ SearchItems(request: SearchItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SearchItemsResponse>;
1815
+ /**
1816
+ * Sets the moderation state for an item, including the concern category and string reason. More information about
1817
+ * moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation
1818
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/setitemmoderationstate
1819
+ */
1820
+ SetItemModerationState(request: SetItemModerationStateRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetItemModerationStateResponse>;
1821
+ /**
1822
+ * Submit a vote for a review, indicating whether the review was helpful or unhelpful.
1823
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/submititemreviewvote
1824
+ */
1825
+ SubmitItemReviewVote(request: SubmitItemReviewVoteRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SubmitItemReviewVoteResponse>;
1826
+ /**
1827
+ * Subtract inventory items.
1828
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/subtractinventoryitems
1829
+ */
1830
+ SubtractInventoryItems(request: SubtractInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SubtractInventoryItemsResponse>;
1831
+ /**
1832
+ * Submit a request to takedown one or more reviews.
1833
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/takedownitemreviews
1834
+ */
1835
+ TakedownItemReviews(request: TakedownItemReviewsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<TakedownItemReviewsResponse>;
1836
+ /**
1837
+ * Transfer inventory items. When transferring across collections, a 202 response indicates that the transfer did not
1838
+ * complete within the timeframe of the request. You can identify the pending operations by looking for OperationStatus =
1839
+ * 'InProgress'. You can check on the operation status at anytime within 1 day of the request by passing the
1840
+ * TransactionToken to the GetInventoryOperationStatus API. More information about item transfer scenarios can be found
1841
+ * here:
1842
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/?tabs=inventory-game-manager#transfer-inventory-items
1843
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/transferinventoryitems
1844
+ */
1845
+ TransferInventoryItems(request: TransferInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<TransferInventoryItemsResponse>;
1846
+ /**
1847
+ * Updates the configuration for the catalog. Only Title Entities can call this API. There is a limit of 10 requests in 10
1848
+ * seconds for this API. More information about the Catalog Config can be found here:
1849
+ * https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings
1850
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/updatecatalogconfig
1851
+ */
1852
+ UpdateCatalogConfig(request: UpdateCatalogConfigRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateCatalogConfigResponse>;
1853
+ /**
1854
+ * Update the metadata for an item in the working catalog. Note: SAS tokens provided are valid for 1 hour.
1855
+ * https://docs.microsoft.com/rest/api/playfab/economy/catalog/updatedraftitem
1856
+ */
1857
+ UpdateDraftItem(request: UpdateDraftItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateDraftItemResponse>;
1858
+ /**
1859
+ * Update inventory items
1860
+ * https://docs.microsoft.com/rest/api/playfab/economy/inventory/updateinventoryitems
1861
+ */
1862
+ UpdateInventoryItems(request: UpdateInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateInventoryItemsResponse>;
1863
+ }
1864
+
1865
+ export { PlayFabEconomyApi as default };