async-playfab-web-sdk 1.192.250526-4 → 1.192.250526-5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Addon.d.ts +178 -38
- package/dist/Addon.js +2 -2
- package/dist/Admin.d.ts +2385 -194
- package/dist/Admin.js +2 -2
- package/dist/Authentication.d.ts +31 -4
- package/dist/Authentication.js +2 -2
- package/dist/Client.d.ts +2234 -320
- package/dist/Client.js +2 -2
- package/dist/CloudScript.d.ts +198 -30
- package/dist/CloudScript.js +2 -2
- package/dist/Data.d.ts +136 -17
- package/dist/Data.js +2 -2
- package/dist/Economy.d.ts +1145 -106
- package/dist/Economy.js +2 -2
- package/dist/Events.d.ts +199 -12
- package/dist/Events.js +2 -2
- package/dist/Experimentation.d.ts +163 -16
- package/dist/Experimentation.js +2 -2
- package/dist/Groups.d.ts +266 -27
- package/dist/Groups.js +2 -2
- package/dist/Insights.d.ts +32 -6
- package/dist/Insights.js +2 -2
- package/dist/Localization.d.ts +4 -1
- package/dist/Localization.js +2 -2
- package/dist/Matchmaker.d.ts +271 -0
- package/dist/Matchmaker.js +8 -0
- package/dist/Matchmaker.js.map +1 -0
- package/dist/Multiplayer.d.ts +2696 -168
- package/dist/Multiplayer.js +2 -2
- package/dist/Profiles.d.ts +162 -18
- package/dist/Profiles.js +2 -2
- package/dist/Progression.d.ts +286 -34
- package/dist/Progression.js +2 -2
- package/dist/Server.d.ts +1903 -241
- package/dist/Server.js +2 -2
- package/dist/chunk-3I6ONUUQ.js +237 -0
- package/dist/chunk-3I6ONUUQ.js.map +1 -0
- package/dist/chunk-3O5QT4SL.js +2477 -0
- package/dist/chunk-3O5QT4SL.js.map +1 -0
- package/dist/chunk-3OBHYLBF.js +2673 -0
- package/dist/chunk-3OBHYLBF.js.map +1 -0
- package/dist/chunk-57KYHGBO.js +421 -0
- package/dist/chunk-57KYHGBO.js.map +1 -0
- package/dist/{chunk-CLMINF57.js → chunk-5CWZN75H.js} +6 -3
- package/dist/chunk-5CWZN75H.js.map +1 -0
- package/dist/chunk-73SVDH45.js +197 -0
- package/dist/chunk-73SVDH45.js.map +1 -0
- package/dist/chunk-ADHTNFTN.js +175 -0
- package/dist/chunk-ADHTNFTN.js.map +1 -0
- package/dist/chunk-C7U2JQNZ.js +76 -0
- package/dist/chunk-C7U2JQNZ.js.map +1 -0
- package/dist/{chunk-PXPOK2QU.js → chunk-GAZYZIK2.js} +34 -8
- package/dist/chunk-GAZYZIK2.js.map +1 -0
- package/dist/chunk-J54WY4UN.js +413 -0
- package/dist/chunk-J54WY4UN.js.map +1 -0
- package/dist/chunk-NFWQ4MMZ.js +1048 -0
- package/dist/chunk-NFWQ4MMZ.js.map +1 -0
- package/dist/{chunk-7UQYMDJQ.js → chunk-P7UVG26J.js} +167 -32
- package/dist/chunk-P7UVG26J.js.map +1 -0
- package/dist/chunk-PFXZB4UN.js +2387 -0
- package/dist/chunk-PFXZB4UN.js.map +1 -0
- package/dist/{chunk-RJPMKD7P.js → chunk-QNGQW3YB.js} +28 -6
- package/dist/chunk-QNGQW3YB.js.map +1 -0
- package/dist/chunk-SQWILU5T.js +270 -0
- package/dist/chunk-SQWILU5T.js.map +1 -0
- package/dist/{chunk-FEEE3PRD.js → chunk-SR2RIRLX.js} +1482 -175
- package/dist/chunk-SR2RIRLX.js.map +1 -0
- package/dist/{chunk-6TH6EJYH.js → chunk-XVDYM74A.js} +4 -4
- package/dist/chunk-XVDYM74A.js.map +1 -0
- package/dist/chunk-ZW4TJ3MQ.js +225 -0
- package/dist/chunk-ZW4TJ3MQ.js.map +1 -0
- package/dist/index.d.ts +6 -5
- package/dist/index.js +29 -25
- package/package.json +2 -2
- package/dist/chunk-2IBLMNAQ.js +0 -882
- package/dist/chunk-2IBLMNAQ.js.map +0 -1
- package/dist/chunk-3TRLETD6.js +0 -119
- package/dist/chunk-3TRLETD6.js.map +0 -1
- package/dist/chunk-4LT3OUQD.js +0 -632
- package/dist/chunk-4LT3OUQD.js.map +0 -1
- package/dist/chunk-6TH6EJYH.js.map +0 -1
- package/dist/chunk-7UQYMDJQ.js.map +0 -1
- package/dist/chunk-CLMINF57.js.map +0 -1
- package/dist/chunk-F5NRBD4O.js +0 -174
- package/dist/chunk-F5NRBD4O.js.map +0 -1
- package/dist/chunk-FEEE3PRD.js.map +0 -1
- package/dist/chunk-HKZJ4H4O.js +0 -97
- package/dist/chunk-HKZJ4H4O.js.map +0 -1
- package/dist/chunk-NJQCK4TL.js +0 -61
- package/dist/chunk-NJQCK4TL.js.map +0 -1
- package/dist/chunk-ONCBQLGS.js +0 -1147
- package/dist/chunk-ONCBQLGS.js.map +0 -1
- package/dist/chunk-PXPOK2QU.js.map +0 -1
- package/dist/chunk-Q22JHX4G.js +0 -76
- package/dist/chunk-Q22JHX4G.js.map +0 -1
- package/dist/chunk-RJPMKD7P.js.map +0 -1
- package/dist/chunk-WROXLFDZ.js +0 -103
- package/dist/chunk-WROXLFDZ.js.map +0 -1
- package/dist/chunk-XAI5IWL4.js +0 -187
- package/dist/chunk-XAI5IWL4.js.map +0 -1
- package/dist/chunk-XM26BUTO.js +0 -384
- package/dist/chunk-XM26BUTO.js.map +0 -1
package/dist/Economy.d.ts
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
|
1
|
+
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
|
2
2
|
|
3
3
|
interface AddInventoryItemsOperation {
|
4
4
|
/** The amount to add to the current item amount. */
|
@@ -14,7 +14,7 @@ interface AddInventoryItemsRequest extends IPlayFabRequestCommon {
|
|
14
14
|
/** The amount to add for the current item. */
|
15
15
|
Amount?: number;
|
16
16
|
/**
|
17
|
-
* The id of the entity
|
17
|
+
* The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is
|
18
18
|
* unlimited.
|
19
19
|
*/
|
20
20
|
CollectionId?: string;
|
@@ -95,7 +95,7 @@ interface CatalogConfig {
|
|
95
95
|
}
|
96
96
|
interface CatalogItem {
|
97
97
|
/**
|
98
|
-
* The alternate IDs associated with this item. An alternate ID can be set to
|
98
|
+
* The alternate IDs associated with this item. An alternate ID can be set to 'FriendlyId' or any of the supported
|
99
99
|
* marketplace names.
|
100
100
|
*/
|
101
101
|
AlternateIds?: CatalogAlternateId[];
|
@@ -111,8 +111,8 @@ interface CatalogItem {
|
|
111
111
|
DeepLinks?: DeepLink[];
|
112
112
|
/**
|
113
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
|
115
|
-
* Inventory
|
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
116
|
*/
|
117
117
|
DefaultStackId?: string;
|
118
118
|
/**
|
@@ -200,6 +200,8 @@ interface CatalogPriceAmount {
|
|
200
200
|
Amount: number;
|
201
201
|
/** The Item Id of the price. */
|
202
202
|
ItemId?: string;
|
203
|
+
/** Stack Id the client expects to use to purchase the item. */
|
204
|
+
StackId?: string;
|
203
205
|
}
|
204
206
|
interface CatalogPriceAmountOverride {
|
205
207
|
/** The exact value that should be utilized in the override. */
|
@@ -236,10 +238,66 @@ interface CatalogSpecificConfig {
|
|
236
238
|
*/
|
237
239
|
Tags?: string[];
|
238
240
|
}
|
241
|
+
interface CatalogView {
|
242
|
+
/** Number of items to retrieve. If null, all applicable items are returned. */
|
243
|
+
Count?: number;
|
244
|
+
/** The date and time when this view was created. */
|
245
|
+
CreationDate?: string;
|
246
|
+
/** The current ETag value that can be used for optimistic concurrency. */
|
247
|
+
ETag?: string;
|
248
|
+
/**
|
249
|
+
* The format to use when exporting the view file. Supported file formats are: Json, JsonLines, GZippedJson,
|
250
|
+
* GZippedJsonLines
|
251
|
+
*/
|
252
|
+
FileFormat?: string;
|
253
|
+
/** An OData filter used to refine the search query. */
|
254
|
+
Filter?: string;
|
255
|
+
/** An optional alternate friendly ID associated with this view. */
|
256
|
+
FriendlyId?: string;
|
257
|
+
/** The unique ID of the view. */
|
258
|
+
Id?: string;
|
259
|
+
/** Indicates whether the view should be generated for title use or for public use. */
|
260
|
+
IsTitleView?: boolean;
|
261
|
+
/** The localized languages to query and retreive, separated by commas (,). */
|
262
|
+
Language?: string;
|
263
|
+
/** The date and time this view was last updated. */
|
264
|
+
LastModifiedDate?: string;
|
265
|
+
/** Diagnostic information from the last time the view was generated. */
|
266
|
+
LastViewDiagnostics?: CatalogViewDiagnostics;
|
267
|
+
/**
|
268
|
+
* An OData select query option used to augment the search results. If not defined, the default search result metadata will
|
269
|
+
* be returned.
|
270
|
+
*/
|
271
|
+
Select?: string;
|
272
|
+
/** The store to restrict the search request to. */
|
273
|
+
Store?: string;
|
274
|
+
/** The URL of the view file. */
|
275
|
+
Url?: string;
|
276
|
+
}
|
277
|
+
interface CatalogViewDiagnostics {
|
278
|
+
/** The last date and time when this view was generated. */
|
279
|
+
GeneratedDate?: string;
|
280
|
+
/** The last count of items included in the view. */
|
281
|
+
ItemCount?: number;
|
282
|
+
/** The last size of the view in bytes. */
|
283
|
+
SizeInBytes?: number;
|
284
|
+
/** The last status of the view. */
|
285
|
+
Status?: string;
|
286
|
+
}
|
239
287
|
interface CategoryRatingConfig {
|
240
288
|
/** Name of the category. */
|
241
289
|
Name?: string;
|
242
290
|
}
|
291
|
+
interface CompleteVersionedCatalogUploadRequest extends IPlayFabRequestCommon {
|
292
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
293
|
+
CustomTags?: Record<string, string | null>;
|
294
|
+
/** Version of the catalog. */
|
295
|
+
Version?: string;
|
296
|
+
}
|
297
|
+
interface CompleteVersionedCatalogUploadResponse extends IPlayFabResultCommon {
|
298
|
+
/** Version of the catalog. */
|
299
|
+
Version?: string;
|
300
|
+
}
|
243
301
|
interface Content {
|
244
302
|
/** The content unique ID. */
|
245
303
|
Id?: string;
|
@@ -285,6 +343,28 @@ interface CreateUploadUrlsResponse extends IPlayFabResultCommon {
|
|
285
343
|
/** List of URLs metadata for the files to be uploaded by the client. */
|
286
344
|
UploadUrls?: UploadUrlMetadata[];
|
287
345
|
}
|
346
|
+
interface CreateVersionedCatalogUploadURLRequest extends IPlayFabRequestCommon {
|
347
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
348
|
+
CustomTags?: Record<string, string | null>;
|
349
|
+
/** Version of the catalog. */
|
350
|
+
Version?: string;
|
351
|
+
}
|
352
|
+
interface CreateVersionedCatalogUploadURLResponse extends IPlayFabResultCommon {
|
353
|
+
/** Write-only Url for uploading the versioned catalog. */
|
354
|
+
Url?: string;
|
355
|
+
/** Version of the catalog. */
|
356
|
+
Version?: string;
|
357
|
+
}
|
358
|
+
interface CreateViewRequest extends IPlayFabRequestCommon {
|
359
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
360
|
+
CustomTags?: Record<string, string | null>;
|
361
|
+
/** Metadata describing the new catalog view to be created. */
|
362
|
+
View?: CatalogView;
|
363
|
+
}
|
364
|
+
interface CreateViewResponse extends IPlayFabResultCommon {
|
365
|
+
/** Updated metadata describing the catalog view just created. */
|
366
|
+
View?: CatalogView;
|
367
|
+
}
|
288
368
|
interface DeepLink {
|
289
369
|
/** Target platform for this deep link. */
|
290
370
|
Platform?: string;
|
@@ -292,7 +372,7 @@ interface DeepLink {
|
|
292
372
|
Url?: string;
|
293
373
|
}
|
294
374
|
interface DeepLinkFormat {
|
295
|
-
/** The format of the deep link to return. The format should contain
|
375
|
+
/** The format of the deep link to return. The format should contain '{id}' to represent where the item ID should be placed. */
|
296
376
|
Format?: string;
|
297
377
|
/** The target platform for the deep link. */
|
298
378
|
Platform?: string;
|
@@ -326,7 +406,7 @@ interface DeleteInventoryItemsOperation {
|
|
326
406
|
}
|
327
407
|
interface DeleteInventoryItemsRequest extends IPlayFabRequestCommon {
|
328
408
|
/**
|
329
|
-
* The id of the entity
|
409
|
+
* The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is
|
330
410
|
* unlimited.
|
331
411
|
*/
|
332
412
|
CollectionId?: string;
|
@@ -367,8 +447,24 @@ interface DeleteItemRequest extends IPlayFabRequestCommon {
|
|
367
447
|
}
|
368
448
|
interface DeleteItemResponse extends IPlayFabResultCommon {
|
369
449
|
}
|
450
|
+
interface DeleteVersionedCatalogRequest extends IPlayFabRequestCommon {
|
451
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
452
|
+
CustomTags?: Record<string, string | null>;
|
453
|
+
/** Version of the catalog. */
|
454
|
+
Version?: string;
|
455
|
+
}
|
456
|
+
interface DeleteViewRequest extends IPlayFabRequestCommon {
|
457
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
458
|
+
CustomTags?: Record<string, string | null>;
|
459
|
+
/** Friendly ID associated with the view. Mutually exclusive with Id. */
|
460
|
+
FriendlyId?: string;
|
461
|
+
/** The unique ID of the item. Mutually exclusive with FriendlyId. */
|
462
|
+
Id?: string;
|
463
|
+
}
|
464
|
+
interface DeleteViewResponse extends IPlayFabResultCommon {
|
465
|
+
}
|
370
466
|
interface DisplayPropertyIndexInfo {
|
371
|
-
/** The property name in the
|
467
|
+
/** The property name in the 'DisplayProperties' property to be indexed. */
|
372
468
|
Name?: string;
|
373
469
|
/** The type of the property to be indexed. */
|
374
470
|
Type?: string;
|
@@ -378,10 +474,15 @@ interface EntityKey {
|
|
378
474
|
Id: string;
|
379
475
|
/** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
|
380
476
|
Type?: string;
|
477
|
+
/**
|
478
|
+
* Alternate name for Type.
|
479
|
+
* @deprecated Please use Type instead.
|
480
|
+
*/
|
481
|
+
TypeString?: string;
|
381
482
|
}
|
382
483
|
interface ExecuteInventoryOperationsRequest extends IPlayFabRequestCommon {
|
383
484
|
/**
|
384
|
-
* The id of the entity
|
485
|
+
* The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is
|
385
486
|
* unlimited.
|
386
487
|
*/
|
387
488
|
CollectionId?: string;
|
@@ -419,7 +520,7 @@ interface ExecuteInventoryOperationsResponse extends IPlayFabResultCommon {
|
|
419
520
|
interface ExecuteTransferOperationsRequest extends IPlayFabRequestCommon {
|
420
521
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
421
522
|
CustomTags?: Record<string, string | null>;
|
422
|
-
/** The inventory collection id the request is transferring from. (Default
|
523
|
+
/** The inventory collection id the request is transferring from. (Default="default") */
|
423
524
|
GivingCollectionId?: string;
|
424
525
|
/** The entity the request is transferring from. Set to the caller by default. */
|
425
526
|
GivingEntity?: EntityKey;
|
@@ -435,7 +536,7 @@ interface ExecuteTransferOperationsRequest extends IPlayFabRequestCommon {
|
|
435
536
|
* or fail as a batch. Up to 50 operations can be added.
|
436
537
|
*/
|
437
538
|
Operations?: TransferInventoryItemsOperation[];
|
438
|
-
/** The inventory collection id the request is transferring to. (Default
|
539
|
+
/** The inventory collection id the request is transferring to. (Default="default") */
|
439
540
|
ReceivingCollectionId?: string;
|
440
541
|
/** The entity the request is transferring to. Set to the caller by default. */
|
441
542
|
ReceivingEntity?: EntityKey;
|
@@ -447,18 +548,18 @@ interface ExecuteTransferOperationsResponse extends IPlayFabResultCommon {
|
|
447
548
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
|
448
549
|
*/
|
449
550
|
GivingETag?: string;
|
450
|
-
/** The ids of transactions that occurred as a result of the request
|
551
|
+
/** The ids of transactions that occurred as a result of the request's giving action. */
|
451
552
|
GivingTransactionIds?: string[];
|
452
553
|
/** The Idempotency ID for this request. */
|
453
554
|
IdempotencyId?: string;
|
454
555
|
/**
|
455
|
-
* The transfer operation status. Possible values are
|
556
|
+
* The transfer operation status. Possible values are 'InProgress' or 'Completed'. If the operation has completed, the
|
456
557
|
* response code will be 200. Otherwise, it will be 202.
|
457
558
|
*/
|
458
559
|
OperationStatus?: string;
|
459
560
|
/**
|
460
561
|
* The token that can be used to get the status of the transfer operation. This will only have a value if OperationStatus
|
461
|
-
* is
|
562
|
+
* is 'InProgress'.
|
462
563
|
*/
|
463
564
|
OperationToken?: string;
|
464
565
|
/**
|
@@ -466,9 +567,15 @@ interface ExecuteTransferOperationsResponse extends IPlayFabResultCommon {
|
|
466
567
|
* the operation has not completed yet.
|
467
568
|
*/
|
468
569
|
ReceivingETag?: string;
|
469
|
-
/** The ids of transactions that occurred as a result of the request
|
570
|
+
/** The ids of transactions that occurred as a result of the request's receiving action. */
|
470
571
|
ReceivingTransactionIds?: string[];
|
471
572
|
}
|
573
|
+
interface ExportVersionedCatalogRequest extends IPlayFabRequestCommon {
|
574
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
575
|
+
CustomTags?: Record<string, string | null>;
|
576
|
+
/** Version of the catalog. */
|
577
|
+
Version?: string;
|
578
|
+
}
|
472
579
|
interface FileConfig {
|
473
580
|
/**
|
474
581
|
* The set of content types that will be used for validation. Each content type can have a maximum character length of 40
|
@@ -483,11 +590,11 @@ interface FileConfig {
|
|
483
590
|
}
|
484
591
|
interface FilterOptions {
|
485
592
|
/**
|
486
|
-
* The OData filter utilized. Mutually exclusive with
|
593
|
+
* The OData filter utilized. Mutually exclusive with 'IncludeAllItems'. More info about Filter Complexity limits can be
|
487
594
|
* found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search#limits
|
488
595
|
*/
|
489
596
|
Filter?: string;
|
490
|
-
/** The flag that overrides the filter and allows for returning all catalog items. Mutually exclusive with
|
597
|
+
/** The flag that overrides the filter and allows for returning all catalog items. Mutually exclusive with 'Filter'. */
|
491
598
|
IncludeAllItems?: boolean;
|
492
599
|
}
|
493
600
|
interface GetCatalogConfigRequest extends IPlayFabRequestCommon {
|
@@ -541,8 +648,8 @@ interface GetEntityDraftItemsRequest extends IPlayFabRequestCommon {
|
|
541
648
|
/** The entity to perform this action on. */
|
542
649
|
Entity?: EntityKey;
|
543
650
|
/**
|
544
|
-
* OData Filter to refine the items returned. CatalogItem properties
|
545
|
-
* eq
|
651
|
+
* OData Filter to refine the items returned. CatalogItem properties 'type' can be used in the filter. For example: "type
|
652
|
+
* eq 'ugc'"
|
546
653
|
*/
|
547
654
|
Filter?: string;
|
548
655
|
}
|
@@ -583,7 +690,7 @@ interface GetInventoryCollectionIdsResponse extends IPlayFabResultCommon {
|
|
583
690
|
ContinuationToken?: string;
|
584
691
|
}
|
585
692
|
interface GetInventoryItemsRequest extends IPlayFabRequestCommon {
|
586
|
-
/** The id of the entity
|
693
|
+
/** The id of the entity's collection to perform this action on. (Default="default") */
|
587
694
|
CollectionId?: string;
|
588
695
|
/**
|
589
696
|
* An opaque token used to retrieve the next page of items in the inventory, if any are available. Should be null on
|
@@ -597,8 +704,8 @@ interface GetInventoryItemsRequest extends IPlayFabRequestCommon {
|
|
597
704
|
/** The entity to perform this action on. */
|
598
705
|
Entity?: EntityKey;
|
599
706
|
/**
|
600
|
-
* OData Filter to refine the items returned. InventoryItem properties
|
601
|
-
* filter. For example:
|
707
|
+
* OData Filter to refine the items returned. InventoryItem properties 'type', 'id', and 'stackId' can be used in the
|
708
|
+
* filter. For example: "type eq 'currency'"
|
602
709
|
*/
|
603
710
|
Filter?: string;
|
604
711
|
}
|
@@ -614,7 +721,7 @@ interface GetInventoryItemsResponse extends IPlayFabResultCommon {
|
|
614
721
|
Items?: InventoryItem[];
|
615
722
|
}
|
616
723
|
interface GetInventoryOperationStatusRequest extends IPlayFabRequestCommon {
|
617
|
-
/** The id of the entity
|
724
|
+
/** The id of the entity's collection to perform this action on. (Default="default") */
|
618
725
|
CollectionId?: string;
|
619
726
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
620
727
|
CustomTags?: Record<string, string | null>;
|
@@ -703,7 +810,7 @@ interface GetItemReviewsRequest extends IPlayFabRequestCommon {
|
|
703
810
|
Id?: string;
|
704
811
|
/**
|
705
812
|
* An OData orderBy used to order the results of the query. Possible values are Helpfulness, Rating, and Submitted (For
|
706
|
-
* example:
|
813
|
+
* example: "Submitted desc")
|
707
814
|
*/
|
708
815
|
OrderBy?: string;
|
709
816
|
}
|
@@ -759,7 +866,7 @@ interface GetMicrosoftStoreAccessTokensResponse extends IPlayFabResultCommon {
|
|
759
866
|
CollectionsAccessTokenExpirationDate: string;
|
760
867
|
}
|
761
868
|
interface GetTransactionHistoryRequest extends IPlayFabRequestCommon {
|
762
|
-
/** The id of the entity
|
869
|
+
/** The id of the entity's collection to perform this action on. (Default="default") */
|
763
870
|
CollectionId?: string;
|
764
871
|
/** An opaque token used to retrieve the next page of items, if any are available. Should be null on initial request. */
|
765
872
|
ContinuationToken?: string;
|
@@ -770,16 +877,16 @@ interface GetTransactionHistoryRequest extends IPlayFabRequestCommon {
|
|
770
877
|
/** The entity to perform this action on. */
|
771
878
|
Entity?: EntityKey;
|
772
879
|
/**
|
773
|
-
* An OData filter used to refine the TransactionHistory. Transaction properties
|
774
|
-
* and
|
775
|
-
* together in a single request. The
|
776
|
-
* request. For example:
|
777
|
-
* and (apiname eq
|
880
|
+
* An OData filter used to refine the TransactionHistory. Transaction properties 'timestamp', 'transactionid', 'apiname'
|
881
|
+
* and 'operationtype' can be used in the filter. Properties 'transactionid', 'apiname', and 'operationtype' cannot be used
|
882
|
+
* together in a single request. The 'timestamp' property can be combined with 'apiname' or 'operationtype' in a single
|
883
|
+
* request. For example: "timestamp ge 2023-06-20T23:30Z" or "transactionid eq '10'" or "(timestamp ge 2023-06-20T23:30Z)
|
884
|
+
* and (apiname eq 'AddInventoryItems')". By default, a 6 month timespan from the current date is used.
|
778
885
|
*/
|
779
886
|
Filter?: string;
|
780
887
|
/**
|
781
|
-
* An OData orderby to order TransactionHistory results. The only supported values are
|
782
|
-
* Default orderby is
|
888
|
+
* An OData orderby to order TransactionHistory results. The only supported values are 'timestamp asc' or 'timestamp desc'.
|
889
|
+
* Default orderby is 'timestamp asc'
|
783
890
|
*/
|
784
891
|
OrderBy?: string;
|
785
892
|
}
|
@@ -789,12 +896,69 @@ interface GetTransactionHistoryResponse extends IPlayFabResultCommon {
|
|
789
896
|
/** The requested inventory transactions. */
|
790
897
|
Transactions?: Transaction[];
|
791
898
|
}
|
899
|
+
interface GetVersionedCatalogItemRequest extends IPlayFabRequestCommon {
|
900
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
901
|
+
CustomTags?: Record<string, string | null>;
|
902
|
+
/** Id of the item. */
|
903
|
+
Id?: string;
|
904
|
+
/** Version of the catalog. */
|
905
|
+
Version?: string;
|
906
|
+
}
|
907
|
+
interface GetVersionedCatalogItemResponse extends IPlayFabResultCommon {
|
908
|
+
/** The versioned catalog item. */
|
909
|
+
Item?: VersionedCatalogItem;
|
910
|
+
}
|
911
|
+
interface GetVersionedCatalogUploadStatusRequest extends IPlayFabRequestCommon {
|
912
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
913
|
+
CustomTags?: Record<string, string | null>;
|
914
|
+
/** Version of the catalog. */
|
915
|
+
Version?: string;
|
916
|
+
}
|
917
|
+
interface GetVersionedCatalogUploadStatusResponse extends IPlayFabResultCommon {
|
918
|
+
/** Status of the upload. */
|
919
|
+
Status?: string;
|
920
|
+
}
|
921
|
+
interface GetViewRequest extends IPlayFabRequestCommon {
|
922
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
923
|
+
CustomTags?: Record<string, string | null>;
|
924
|
+
/** The entity to perform this action on. */
|
925
|
+
Entity?: EntityKey;
|
926
|
+
/** Friendly ID associated with the view. Mutually exclusive with Id. */
|
927
|
+
FriendlyId?: string;
|
928
|
+
/** The unique ID of the view. Mutually exclusive with FriendlyId. */
|
929
|
+
Id?: string;
|
930
|
+
}
|
931
|
+
interface GetViewResponse extends IPlayFabResultCommon {
|
932
|
+
/** Metadata defining the view. */
|
933
|
+
View?: CatalogView;
|
934
|
+
}
|
935
|
+
interface GetViewsRequest extends IPlayFabRequestCommon {
|
936
|
+
/**
|
937
|
+
* An opaque token used to retrieve the next page of views created by the caller, if any are available. Should be null on
|
938
|
+
* initial request.
|
939
|
+
*/
|
940
|
+
ContinuationToken?: string;
|
941
|
+
/** Number of views to retrieve. This value is optional. Default value is 10. */
|
942
|
+
Count?: number;
|
943
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
944
|
+
CustomTags?: Record<string, string | null>;
|
945
|
+
/** The entity to perform this action on. */
|
946
|
+
Entity?: EntityKey;
|
947
|
+
}
|
948
|
+
interface GetViewsResponse extends IPlayFabResultCommon {
|
949
|
+
/** An opaque token used to retrieve the next page of items, if any are available. */
|
950
|
+
ContinuationToken?: string;
|
951
|
+
/** List of metadata defining the views. */
|
952
|
+
Views?: CatalogView[];
|
953
|
+
}
|
792
954
|
interface GooglePlayProductPurchase {
|
793
955
|
/** The Product ID (SKU) of the InApp product purchased from the Google Play store. */
|
794
956
|
ProductId?: string;
|
795
|
-
/** The token provided to the player
|
957
|
+
/** The token provided to the player's device when the product was purchased */
|
796
958
|
Token?: string;
|
797
959
|
}
|
960
|
+
interface IActionResult extends IPlayFabResultCommon {
|
961
|
+
}
|
798
962
|
interface Image {
|
799
963
|
/** The image unique ID. */
|
800
964
|
Id?: string;
|
@@ -803,7 +967,7 @@ interface Image {
|
|
803
967
|
* images
|
804
968
|
*/
|
805
969
|
Tag?: string;
|
806
|
-
/** Images can be defined as either a
|
970
|
+
/** Images can be defined as either a "thumbnail" or "screenshot". There can only be one "thumbnail" image per item. */
|
807
971
|
Type?: string;
|
808
972
|
/** The URL for retrieval of the image. */
|
809
973
|
Url?: string;
|
@@ -841,7 +1005,7 @@ interface InventoryItemReference {
|
|
841
1005
|
AlternateId?: AlternateId;
|
842
1006
|
/** The inventory item id the request applies to. */
|
843
1007
|
Id?: string;
|
844
|
-
/** The inventory stack id the request should redeem to. (Default
|
1008
|
+
/** The inventory stack id the request should redeem to. (Default="default") */
|
845
1009
|
StackId?: string;
|
846
1010
|
}
|
847
1011
|
interface InventoryOperation {
|
@@ -862,6 +1026,14 @@ interface KeywordSet {
|
|
862
1026
|
/** A list of localized keywords. */
|
863
1027
|
Values?: string[];
|
864
1028
|
}
|
1029
|
+
interface ListVersionedCatalogsRequest extends IPlayFabRequestCommon {
|
1030
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1031
|
+
CustomTags?: Record<string, string | null>;
|
1032
|
+
}
|
1033
|
+
interface ListVersionedCatalogsResponse extends IPlayFabResultCommon {
|
1034
|
+
/** The list of versioned catalogs. */
|
1035
|
+
VersionedCatalogs?: VersionedCatalog[];
|
1036
|
+
}
|
865
1037
|
interface ModerationState {
|
866
1038
|
/** The date and time this moderation state was last updated. */
|
867
1039
|
LastModifiedDate?: string;
|
@@ -921,7 +1093,7 @@ interface PurchaseInventoryItemsRequest extends IPlayFabRequestCommon {
|
|
921
1093
|
/** The amount to purchase. */
|
922
1094
|
Amount?: number;
|
923
1095
|
/**
|
924
|
-
* The id of the entity
|
1096
|
+
* The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is
|
925
1097
|
* unlimited.
|
926
1098
|
*/
|
927
1099
|
CollectionId?: string;
|
@@ -955,6 +1127,8 @@ interface PurchaseInventoryItemsRequest extends IPlayFabRequestCommon {
|
|
955
1127
|
* specified Store.
|
956
1128
|
*/
|
957
1129
|
PriceAmounts?: PurchasePriceAmount[];
|
1130
|
+
/** Details the overrides used in a purchase operation. */
|
1131
|
+
PurchaseOverrides?: PurchaseOverridesInfo;
|
958
1132
|
/** The id of the Store to purchase the item from. */
|
959
1133
|
StoreId?: string;
|
960
1134
|
}
|
@@ -969,12 +1143,14 @@ interface PurchaseInventoryItemsResponse extends IPlayFabResultCommon {
|
|
969
1143
|
/** The ids of transactions that occurred as a result of the request. */
|
970
1144
|
TransactionIds?: string[];
|
971
1145
|
}
|
1146
|
+
interface PurchaseOverridesInfo {
|
1147
|
+
}
|
972
1148
|
interface PurchasePriceAmount {
|
973
1149
|
/** The amount of the inventory item to use in the purchase . */
|
974
1150
|
Amount: number;
|
975
1151
|
/** The inventory item id to use in the purchase . */
|
976
1152
|
ItemId?: string;
|
977
|
-
/** The inventory stack id the to use in the purchase. Set to
|
1153
|
+
/** The inventory stack id the to use in the purchase. Set to "default" by default */
|
978
1154
|
StackId?: string;
|
979
1155
|
}
|
980
1156
|
interface Rating {
|
@@ -994,26 +1170,33 @@ interface Rating {
|
|
994
1170
|
TotalCount?: number;
|
995
1171
|
}
|
996
1172
|
interface RealMoneyPriceDetails {
|
997
|
-
/** The
|
1173
|
+
/** The 'AppleAppStore' price amount per CurrencyCode. 'USD' supported only. */
|
998
1174
|
AppleAppStorePrices?: Record<string, number>;
|
999
|
-
/** The
|
1175
|
+
/** The 'GooglePlay' price amount per CurrencyCode. 'USD' supported only. */
|
1000
1176
|
GooglePlayPrices?: Record<string, number>;
|
1001
|
-
/** The
|
1177
|
+
/** The 'MicrosoftStore' price amount per CurrencyCode. 'USD' supported only. */
|
1002
1178
|
MicrosoftStorePrices?: Record<string, number>;
|
1003
|
-
/** The
|
1179
|
+
/** The 'NintendoEShop' price amount per CurrencyCode. 'USD' supported only. */
|
1004
1180
|
NintendoEShopPrices?: Record<string, number>;
|
1005
|
-
/** The
|
1181
|
+
/** The 'PlayStationStore' price amount per CurrencyCode. 'USD' supported only. */
|
1006
1182
|
PlayStationStorePrices?: Record<string, number>;
|
1007
|
-
/** The
|
1183
|
+
/** The 'Steam' price amount per CurrencyCode. 'USD' supported only. */
|
1008
1184
|
SteamPrices?: Record<string, number>;
|
1009
1185
|
}
|
1010
1186
|
interface RedeemAppleAppStoreInventoryItemsRequest extends IPlayFabRequestCommon {
|
1011
|
-
/** The id of the entity
|
1187
|
+
/** The id of the entity's collection to perform this action on. (Default="default") */
|
1012
1188
|
CollectionId?: string;
|
1189
|
+
/** The country code of the real money transaction. */
|
1190
|
+
CountryCode?: string;
|
1013
1191
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1014
1192
|
CustomTags?: Record<string, string | null>;
|
1015
1193
|
/** The entity to perform this action on. */
|
1016
1194
|
Entity?: EntityKey;
|
1195
|
+
/**
|
1196
|
+
* The inventory items to redeem. These items are required to have an alternate id that corresponds to the marketplace to
|
1197
|
+
* redeem from.
|
1198
|
+
*/
|
1199
|
+
Items?: InventoryItemReference[];
|
1017
1200
|
/** The receipt provided by the Apple marketplace upon successful purchase. */
|
1018
1201
|
Receipt?: string;
|
1019
1202
|
}
|
@@ -1026,12 +1209,19 @@ interface RedeemAppleAppStoreInventoryItemsResponse extends IPlayFabResultCommon
|
|
1026
1209
|
TransactionIds?: string[];
|
1027
1210
|
}
|
1028
1211
|
interface RedeemGooglePlayInventoryItemsRequest extends IPlayFabRequestCommon {
|
1029
|
-
/** The id of the entity
|
1212
|
+
/** The id of the entity's collection to perform this action on. (Default="default") */
|
1030
1213
|
CollectionId?: string;
|
1214
|
+
/** The country code of the real money transaction. */
|
1215
|
+
CountryCode?: string;
|
1031
1216
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1032
1217
|
CustomTags?: Record<string, string | null>;
|
1033
1218
|
/** The entity to perform this action on. */
|
1034
1219
|
Entity?: EntityKey;
|
1220
|
+
/**
|
1221
|
+
* The inventory items to redeem. These items are required to have an alternate id that corresponds to the marketplace to
|
1222
|
+
* redeem from.
|
1223
|
+
*/
|
1224
|
+
Items?: InventoryItemReference[];
|
1035
1225
|
/** The list of purchases to redeem */
|
1036
1226
|
Purchases?: GooglePlayProductPurchase[];
|
1037
1227
|
}
|
@@ -1044,17 +1234,24 @@ interface RedeemGooglePlayInventoryItemsResponse extends IPlayFabResultCommon {
|
|
1044
1234
|
TransactionIds?: string[];
|
1045
1235
|
}
|
1046
1236
|
interface RedeemMicrosoftStoreInventoryItemsRequest extends IPlayFabRequestCommon {
|
1047
|
-
/** The id of the entity
|
1237
|
+
/** The id of the entity's collection to perform this action on. (Default="default") */
|
1048
1238
|
CollectionId?: string;
|
1049
1239
|
/** The OneStore Collections Id Key used for AAD authentication. */
|
1050
1240
|
CollectionsIdKey?: string;
|
1241
|
+
/** The country code of the real money transaction. */
|
1242
|
+
CountryCode?: string;
|
1051
1243
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1052
1244
|
CustomTags?: Record<string, string | null>;
|
1053
1245
|
/** The entity to perform this action on. */
|
1054
1246
|
Entity?: EntityKey;
|
1247
|
+
/**
|
1248
|
+
* The inventory items to redeem. These items are required to have an alternate id that corresponds to the marketplace to
|
1249
|
+
* redeem from.
|
1250
|
+
*/
|
1251
|
+
Items?: InventoryItemReference[];
|
1055
1252
|
/**
|
1056
1253
|
* Xbox Token used for delegated business partner authentication. Token provided by the Xbox Live SDK method
|
1057
|
-
* GetTokenAndSignatureAsync(
|
1254
|
+
* GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", "").
|
1058
1255
|
*/
|
1059
1256
|
XboxToken?: string;
|
1060
1257
|
}
|
@@ -1067,12 +1264,19 @@ interface RedeemMicrosoftStoreInventoryItemsResponse extends IPlayFabResultCommo
|
|
1067
1264
|
TransactionIds?: string[];
|
1068
1265
|
}
|
1069
1266
|
interface RedeemNintendoEShopInventoryItemsRequest extends IPlayFabRequestCommon {
|
1070
|
-
/** The id of the entity
|
1267
|
+
/** The id of the entity's collection to perform this action on. (Default="default") */
|
1071
1268
|
CollectionId?: string;
|
1269
|
+
/** The country code of the real money transaction. */
|
1270
|
+
CountryCode?: string;
|
1072
1271
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1073
1272
|
CustomTags?: Record<string, string | null>;
|
1074
1273
|
/** The entity to perform this action on. */
|
1075
1274
|
Entity?: EntityKey;
|
1275
|
+
/**
|
1276
|
+
* The inventory items to redeem. These items are required to have an alternate id that corresponds to the marketplace to
|
1277
|
+
* redeem from.
|
1278
|
+
*/
|
1279
|
+
Items?: InventoryItemReference[];
|
1076
1280
|
/** The Nintendo provided token authorizing redemption */
|
1077
1281
|
NintendoServiceAccountIdToken?: string;
|
1078
1282
|
}
|
@@ -1087,12 +1291,19 @@ interface RedeemNintendoEShopInventoryItemsResponse extends IPlayFabResultCommon
|
|
1087
1291
|
interface RedeemPlayStationStoreInventoryItemsRequest extends IPlayFabRequestCommon {
|
1088
1292
|
/** Auth code returned by PlayStation :tm: Network OAuth system. */
|
1089
1293
|
AuthorizationCode?: string;
|
1090
|
-
/** The id of the entity
|
1294
|
+
/** The id of the entity's collection to perform this action on. (Default="default") */
|
1091
1295
|
CollectionId?: string;
|
1296
|
+
/** The country code of the real money transaction. */
|
1297
|
+
CountryCode?: string;
|
1092
1298
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1093
1299
|
CustomTags?: Record<string, string | null>;
|
1094
1300
|
/** The entity to perform this action on. */
|
1095
1301
|
Entity?: EntityKey;
|
1302
|
+
/**
|
1303
|
+
* The inventory items to redeem. These items are required to have an alternate id that corresponds to the marketplace to
|
1304
|
+
* redeem from.
|
1305
|
+
*/
|
1306
|
+
Items?: InventoryItemReference[];
|
1096
1307
|
/** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code. */
|
1097
1308
|
RedirectUri?: string;
|
1098
1309
|
/** Optional Service Label to pass into the request. */
|
@@ -1107,12 +1318,19 @@ interface RedeemPlayStationStoreInventoryItemsResponse extends IPlayFabResultCom
|
|
1107
1318
|
TransactionIds?: string[];
|
1108
1319
|
}
|
1109
1320
|
interface RedeemSteamInventoryItemsRequest extends IPlayFabRequestCommon {
|
1110
|
-
/** The id of the entity
|
1321
|
+
/** The id of the entity's collection to perform this action on. (Default="default") */
|
1111
1322
|
CollectionId?: string;
|
1323
|
+
/** The country code of the real money transaction. */
|
1324
|
+
CountryCode?: string;
|
1112
1325
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1113
1326
|
CustomTags?: Record<string, string | null>;
|
1114
1327
|
/** The entity to perform this action on. */
|
1115
1328
|
Entity?: EntityKey;
|
1329
|
+
/**
|
1330
|
+
* The inventory items to redeem. These items are required to have an alternate id that corresponds to the marketplace to
|
1331
|
+
* redeem from.
|
1332
|
+
*/
|
1333
|
+
Items?: InventoryItemReference[];
|
1116
1334
|
}
|
1117
1335
|
interface RedeemSteamInventoryItemsResponse extends IPlayFabResultCommon {
|
1118
1336
|
/** The list of failed redemptions from the external marketplace. */
|
@@ -1238,13 +1456,13 @@ interface SearchItemsRequest extends IPlayFabRequestCommon {
|
|
1238
1456
|
/** The entity to perform this action on. */
|
1239
1457
|
Entity?: EntityKey;
|
1240
1458
|
/**
|
1241
|
-
* An OData filter used to refine the search query (For example:
|
1459
|
+
* An OData filter used to refine the search query (For example: "type eq 'ugc'"). More info about Filter Complexity limits
|
1242
1460
|
* can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search#limits
|
1243
1461
|
*/
|
1244
1462
|
Filter?: string;
|
1245
1463
|
/** The locale to be returned in the result. */
|
1246
1464
|
Language?: string;
|
1247
|
-
/** An OData orderBy used to order the results of the search query. For example:
|
1465
|
+
/** An OData orderBy used to order the results of the search query. For example: "rating/average asc" */
|
1248
1466
|
OrderBy?: string;
|
1249
1467
|
/** The text to search for. */
|
1250
1468
|
Search?: string;
|
@@ -1323,7 +1541,7 @@ interface SubtractInventoryItemsRequest extends IPlayFabRequestCommon {
|
|
1323
1541
|
/** The amount to subtract for the current item. */
|
1324
1542
|
Amount?: number;
|
1325
1543
|
/**
|
1326
|
-
* The id of the entity
|
1544
|
+
* The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is
|
1327
1545
|
* unlimited.
|
1328
1546
|
*/
|
1329
1547
|
CollectionId?: string;
|
@@ -1373,6 +1591,8 @@ interface TakedownItemReviewsResponse extends IPlayFabResultCommon {
|
|
1373
1591
|
interface Transaction {
|
1374
1592
|
/** The API call that caused this transaction. */
|
1375
1593
|
ApiName?: string;
|
1594
|
+
/** The country of the caller of the operation. */
|
1595
|
+
CountryCode?: string;
|
1376
1596
|
/** The type of item that the the operation occurred on. */
|
1377
1597
|
ItemType?: string;
|
1378
1598
|
/** The operations that occurred. */
|
@@ -1457,7 +1677,7 @@ interface TransferInventoryItemsRequest extends IPlayFabRequestCommon {
|
|
1457
1677
|
* false)
|
1458
1678
|
*/
|
1459
1679
|
DeleteEmptyStacks: boolean;
|
1460
|
-
/** The inventory collection id the request is transferring from. (Default
|
1680
|
+
/** The inventory collection id the request is transferring from. (Default="default") */
|
1461
1681
|
GivingCollectionId?: string;
|
1462
1682
|
/** The entity the request is transferring from. Set to the caller by default. */
|
1463
1683
|
GivingEntity?: EntityKey;
|
@@ -1472,7 +1692,7 @@ interface TransferInventoryItemsRequest extends IPlayFabRequestCommon {
|
|
1472
1692
|
IdempotencyId?: string;
|
1473
1693
|
/** The values to apply to a stack newly created by this request. */
|
1474
1694
|
NewStackValues?: InitialValues;
|
1475
|
-
/** The inventory collection id the request is transferring to. (Default
|
1695
|
+
/** The inventory collection id the request is transferring to. (Default="default") */
|
1476
1696
|
ReceivingCollectionId?: string;
|
1477
1697
|
/** The entity the request is transferring to. Set to the caller by default. */
|
1478
1698
|
ReceivingEntity?: EntityKey;
|
@@ -1485,21 +1705,21 @@ interface TransferInventoryItemsResponse extends IPlayFabResultCommon {
|
|
1485
1705
|
* ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags
|
1486
1706
|
*/
|
1487
1707
|
GivingETag?: string;
|
1488
|
-
/** The ids of transactions that occurred as a result of the request
|
1708
|
+
/** The ids of transactions that occurred as a result of the request's giving action. */
|
1489
1709
|
GivingTransactionIds?: string[];
|
1490
1710
|
/** The idempotency id for the request. */
|
1491
1711
|
IdempotencyId?: string;
|
1492
1712
|
/**
|
1493
|
-
* The transfer operation status. Possible values are
|
1713
|
+
* The transfer operation status. Possible values are 'InProgress' or 'Completed'. If the operation has completed, the
|
1494
1714
|
* response code will be 200. Otherwise, it will be 202.
|
1495
1715
|
*/
|
1496
1716
|
OperationStatus?: string;
|
1497
1717
|
/**
|
1498
1718
|
* The token that can be used to get the status of the transfer operation. This will only have a value if OperationStatus
|
1499
|
-
* is
|
1719
|
+
* is 'InProgress'.
|
1500
1720
|
*/
|
1501
1721
|
OperationToken?: string;
|
1502
|
-
/** The ids of transactions that occurred as a result of the request
|
1722
|
+
/** The ids of transactions that occurred as a result of the request's receiving action. */
|
1503
1723
|
ReceivingTransactionIds?: string[];
|
1504
1724
|
}
|
1505
1725
|
interface UpdateCatalogConfigRequest extends IPlayFabRequestCommon {
|
@@ -1528,7 +1748,7 @@ interface UpdateInventoryItemsOperation {
|
|
1528
1748
|
}
|
1529
1749
|
interface UpdateInventoryItemsRequest extends IPlayFabRequestCommon {
|
1530
1750
|
/**
|
1531
|
-
* The id of the entity
|
1751
|
+
* The id of the entity's collection to perform this action on. (Default="default"). The number of inventory collections is
|
1532
1752
|
* unlimited.
|
1533
1753
|
*/
|
1534
1754
|
CollectionId?: string;
|
@@ -1560,6 +1780,16 @@ interface UpdateInventoryItemsResponse extends IPlayFabResultCommon {
|
|
1560
1780
|
/** The ids of transactions that occurred as a result of the request. */
|
1561
1781
|
TransactionIds?: string[];
|
1562
1782
|
}
|
1783
|
+
interface UpdateViewRequest extends IPlayFabRequestCommon {
|
1784
|
+
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
1785
|
+
CustomTags?: Record<string, string | null>;
|
1786
|
+
/** Updated metadata describing the catalog view to be updated. */
|
1787
|
+
View?: CatalogView;
|
1788
|
+
}
|
1789
|
+
interface UpdateViewResponse extends IPlayFabResultCommon {
|
1790
|
+
/** Updated metadata describing the catalog view just updated */
|
1791
|
+
View?: CatalogView;
|
1792
|
+
}
|
1563
1793
|
interface UploadInfo {
|
1564
1794
|
/** Name of the file to be uploaded. */
|
1565
1795
|
FileName?: string;
|
@@ -1578,16 +1808,263 @@ interface UserGeneratedContentSpecificConfig {
|
|
1578
1808
|
/** The set of tags that will be used for validation. */
|
1579
1809
|
Tags?: string[];
|
1580
1810
|
}
|
1811
|
+
interface VersionedCatalog {
|
1812
|
+
/** Version of the catalog. */
|
1813
|
+
Version?: string;
|
1814
|
+
}
|
1815
|
+
interface VersionedCatalogItem {
|
1816
|
+
/** A list of alternate ids for this item. */
|
1817
|
+
AlternateIds?: VersionedCatalogItemAlternateId[];
|
1818
|
+
/** The content type of the item. */
|
1819
|
+
ContentType?: string;
|
1820
|
+
/** The creation date of the item. */
|
1821
|
+
CreationDate?: string;
|
1822
|
+
/** The creator entity of the item. */
|
1823
|
+
CreatorEntity?: VersionedCatalogItemCreatorEntity;
|
1824
|
+
/** The Stack Id that will be used as default for this item in Inventory when an explicit one is not provided. */
|
1825
|
+
DefaultStackId?: string;
|
1826
|
+
/** The description of the item. */
|
1827
|
+
Description?: Record<string, string | null>;
|
1828
|
+
/** The end date of the item. */
|
1829
|
+
EndDate?: string;
|
1830
|
+
/** The friendly id of the item. */
|
1831
|
+
FriendlyId?: string;
|
1832
|
+
/** The id identifying the item. */
|
1833
|
+
Id?: string;
|
1834
|
+
/** Indicates if the item is hidden. */
|
1835
|
+
IsHidden?: boolean;
|
1836
|
+
/** Indicates if the item is for testing. */
|
1837
|
+
IsTest?: boolean;
|
1838
|
+
/** The item references associated with this item. */
|
1839
|
+
ItemReferences?: VersionedCatalogItemReference[];
|
1840
|
+
/** The keywords of the item. */
|
1841
|
+
Keywords?: Record<string, VersionedCatalogItemKeywordSet>;
|
1842
|
+
/** The last modified date of the item. */
|
1843
|
+
LastModifiedDate?: string;
|
1844
|
+
/** The payout information of the payee. */
|
1845
|
+
PayoutInfo?: VersionedCatalogItemPayoutInfo;
|
1846
|
+
/** The platforms of the item. */
|
1847
|
+
Platforms?: string[];
|
1848
|
+
/** The prices the item can be purchased for. */
|
1849
|
+
Price?: VersionedCatalogItemPrice;
|
1850
|
+
/** The real price the item was purchased for per marketplace. */
|
1851
|
+
RealMoneyPriceDetails?: VersionedCatalogItemRealMoneyPriceDetails;
|
1852
|
+
/** The start date of the item. */
|
1853
|
+
StartDate?: string;
|
1854
|
+
/** Optional details for stores items. */
|
1855
|
+
StoreDetails?: VersionedCatalogItemStoreDetails;
|
1856
|
+
/** The tags of the item. */
|
1857
|
+
Tags?: string[];
|
1858
|
+
/** The title of the item. */
|
1859
|
+
Title?: Record<string, string | null>;
|
1860
|
+
/** Whether a non-title entity can interact with the item. */
|
1861
|
+
TitleExclusive?: boolean;
|
1862
|
+
/** The service defined type of the item. */
|
1863
|
+
Type?: string;
|
1864
|
+
}
|
1865
|
+
interface VersionedCatalogItemAlternateId {
|
1866
|
+
/** Type of the Alternate Id. */
|
1867
|
+
Type?: string;
|
1868
|
+
/** Value of the Alternate Id. */
|
1869
|
+
Value?: string;
|
1870
|
+
}
|
1871
|
+
interface VersionedCatalogItemCreatorEntity {
|
1872
|
+
/** The id of the creator entity. */
|
1873
|
+
Id?: string;
|
1874
|
+
/** The type of the creator entity. */
|
1875
|
+
Type?: string;
|
1876
|
+
}
|
1877
|
+
interface VersionedCatalogItemFilterOptions {
|
1878
|
+
/** The OData filter utilized. Mutually exclusive with 'IncludeAllItems'. */
|
1879
|
+
Filter?: string;
|
1880
|
+
/** The flag that overrides the filter and allows for returning all catalog items. Mutually exclusive with 'Filter'. */
|
1881
|
+
IncludeAllItems?: boolean;
|
1882
|
+
}
|
1883
|
+
interface VersionedCatalogItemKeywordSet {
|
1884
|
+
/** A list of localized keywords. */
|
1885
|
+
Values?: string[];
|
1886
|
+
}
|
1887
|
+
interface VersionedCatalogItemOverride {
|
1888
|
+
/** The exact value that should be utilized in the override. */
|
1889
|
+
FixedValue?: number;
|
1890
|
+
/** The id of the item this override should utilize. */
|
1891
|
+
ItemId?: string;
|
1892
|
+
/**
|
1893
|
+
* The multiplier that will be applied to the base Catalog value to determine what value should be utilized in the
|
1894
|
+
* override.
|
1895
|
+
*/
|
1896
|
+
Multiplier?: number;
|
1897
|
+
}
|
1898
|
+
interface VersionedCatalogItemPayoutInfo {
|
1899
|
+
/** The Dev Center account id of the payee. */
|
1900
|
+
AccountSellerId?: string;
|
1901
|
+
/** The tax code for payout calculations. */
|
1902
|
+
TaxCode?: string;
|
1903
|
+
/** The Universal account id of the payee. */
|
1904
|
+
Uaid?: string;
|
1905
|
+
}
|
1906
|
+
interface VersionedCatalogItemPermissions {
|
1907
|
+
/** The list of ids of Segments that the a player can be in to purchase from the store. */
|
1908
|
+
SegmentIds?: string[];
|
1909
|
+
}
|
1910
|
+
interface VersionedCatalogItemPrice {
|
1911
|
+
/** The amount the payee will receive. */
|
1912
|
+
PayoutAmount?: number;
|
1913
|
+
/** Prices of the catalog item. */
|
1914
|
+
Prices?: VersionedCatalogItemPriceInstance[];
|
1915
|
+
/** A standardized sorting key to allow proper sorting between items with prices in different currencies. */
|
1916
|
+
Sort?: number;
|
1917
|
+
}
|
1918
|
+
interface VersionedCatalogItemPriceAmount {
|
1919
|
+
/** The amount of the price. */
|
1920
|
+
Amount?: number;
|
1921
|
+
/** Indicates whether the item this price references is defined at the namespace level or not. */
|
1922
|
+
IsFromNamespace?: boolean;
|
1923
|
+
/** The Item Id of the price. */
|
1924
|
+
ItemId?: string;
|
1925
|
+
/** Stack Id the client expects to use to purchase the item. */
|
1926
|
+
StackId?: string;
|
1927
|
+
}
|
1928
|
+
interface VersionedCatalogItemPriceInstance {
|
1929
|
+
/** The amounts of the catalog item price. Each price can have up to 15 item amounts. */
|
1930
|
+
Amounts?: VersionedCatalogItemPriceAmount[];
|
1931
|
+
/** The per-unit amount this price can be used to purchase. */
|
1932
|
+
UnitAmount?: number;
|
1933
|
+
/** The per-unit duration this price can be used to purchase. The maximum duration is 100 years. */
|
1934
|
+
UnitDurationInSeconds?: number;
|
1935
|
+
}
|
1936
|
+
interface VersionedCatalogItemPriceOverride {
|
1937
|
+
/** The currency amounts utilized in the override for a singular price. */
|
1938
|
+
Amounts?: VersionedCatalogItemOverride[];
|
1939
|
+
}
|
1940
|
+
interface VersionedCatalogItemPricesOverride {
|
1941
|
+
/** The payout amount utilized in the override. */
|
1942
|
+
PayoutAmount?: VersionedCatalogItemOverride;
|
1943
|
+
/** The prices utilized in the override. */
|
1944
|
+
Prices?: VersionedCatalogItemPriceOverride[];
|
1945
|
+
}
|
1946
|
+
interface VersionedCatalogItemRealMoneyPriceDetails {
|
1947
|
+
/** The 'AppleAppStore' price amount per CurrencyCode. 'USD' supported only. */
|
1948
|
+
AppleAppStorePrices?: Record<string, number>;
|
1949
|
+
/** The 'GooglePlay' price amount per CurrencyCode. 'USD' supported only. */
|
1950
|
+
GooglePlayPrices?: Record<string, number>;
|
1951
|
+
/** The 'MicrosoftStore' price amount per CurrencyCode. 'USD' supported only. */
|
1952
|
+
MicrosoftStorePrices?: Record<string, number>;
|
1953
|
+
/** The 'NintendoEShop' price amount per CurrencyCode. 'USD' supported only. */
|
1954
|
+
NintendoEShopPrices?: Record<string, number>;
|
1955
|
+
/** The 'PlayStationStore' price amount per CurrencyCode. 'USD' supported only. */
|
1956
|
+
PlayStationStorePrices?: Record<string, number>;
|
1957
|
+
/** The 'Steam' price amount per CurrencyCode. 'USD' supported only. */
|
1958
|
+
SteamPrices?: Record<string, number>;
|
1959
|
+
}
|
1960
|
+
interface VersionedCatalogItemReference {
|
1961
|
+
/** The amount of the catalog item. */
|
1962
|
+
Amount?: number;
|
1963
|
+
/** The duration in seconds of the catalog item. */
|
1964
|
+
DurationInSeconds?: number;
|
1965
|
+
/** The unique id of the catalog item. */
|
1966
|
+
Id?: string;
|
1967
|
+
/** Indicates whether the item this reference represents is defined at the namespace level or not. */
|
1968
|
+
IsFromNamespace?: boolean;
|
1969
|
+
/** The prices the catalog item can be purchased for. */
|
1970
|
+
Price?: VersionedCatalogItemPrice;
|
1971
|
+
}
|
1972
|
+
interface VersionedCatalogItemStoreDetails {
|
1973
|
+
/** The options for the filter in filter-based stores. These options are mutually exclusive with item references. */
|
1974
|
+
FilterOptions?: VersionedCatalogItemFilterOptions;
|
1975
|
+
/** The permissions that control which players can purchase from the store. */
|
1976
|
+
Permissions?: VersionedCatalogItemPermissions;
|
1977
|
+
/** The global prices utilized in the store. These options are mutually exclusive with price options in item references. */
|
1978
|
+
PricesOverride?: VersionedCatalogItemPricesOverride;
|
1979
|
+
}
|
1581
1980
|
|
1582
1981
|
declare class PlayFabEconomyApi extends PlayFabCommon {
|
1583
1982
|
/**
|
1584
1983
|
* Add inventory items. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is uncapped.
|
1585
|
-
*
|
1984
|
+
*
|
1985
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/addinventoryitems Microsoft Documentation}
|
1986
|
+
* @example
|
1987
|
+
* await inventoryClient.AddInventoryItems({
|
1988
|
+
* "Item": {
|
1989
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
1990
|
+
* },
|
1991
|
+
* "Amount": 3,
|
1992
|
+
* "ReturnInventory": false
|
1993
|
+
* });
|
1586
1994
|
*/
|
1587
1995
|
AddInventoryItems(request: AddInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<AddInventoryItemsResponse>;
|
1996
|
+
/**
|
1997
|
+
* Given an existing Versioned Catalog, begin the process of validating the uploaded JSON and creating the described items.
|
1998
|
+
*
|
1999
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/completeversionedcatalogupload Microsoft Documentation}
|
2000
|
+
* @example
|
2001
|
+
* await versionedcatalogClient.CompleteVersionedCatalogUpload({});
|
2002
|
+
*/
|
2003
|
+
CompleteVersionedCatalogUpload(request: CompleteVersionedCatalogUploadRequest, extraHeaders?: Record<string, string>): Promise<CompleteVersionedCatalogUploadResponse>;
|
1588
2004
|
/**
|
1589
2005
|
* Creates a new item in the working catalog using provided metadata. Note: SAS tokens provided are valid for 1 hour.
|
1590
|
-
*
|
2006
|
+
*
|
2007
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/createdraftitem Microsoft Documentation}
|
2008
|
+
* @example
|
2009
|
+
* await catalogClient.CreateDraftItem({
|
2010
|
+
* "Item": {
|
2011
|
+
* "Type": "ugc",
|
2012
|
+
* "Title": {
|
2013
|
+
* "NEUTRAL": "Neutral title",
|
2014
|
+
* "en-US": "US English title"
|
2015
|
+
* },
|
2016
|
+
* "Description": {
|
2017
|
+
* "NEUTRAL": "Neutral description",
|
2018
|
+
* "en-US": "US English description"
|
2019
|
+
* },
|
2020
|
+
* "Keywords": {
|
2021
|
+
* "NEUTRAL": {
|
2022
|
+
* "Values": [
|
2023
|
+
* "Keyword_1",
|
2024
|
+
* "Keyword_2"
|
2025
|
+
* ]
|
2026
|
+
* }
|
2027
|
+
* },
|
2028
|
+
* "ContentType": "example item",
|
2029
|
+
* "CreatorEntity": {
|
2030
|
+
* "Id": "someId",
|
2031
|
+
* "Type": "title_player_account",
|
2032
|
+
* "TypeString": "title_player_account"
|
2033
|
+
* },
|
2034
|
+
* "IsHidden": false,
|
2035
|
+
* "Tags": [
|
2036
|
+
* "pirates",
|
2037
|
+
* "holiday"
|
2038
|
+
* ],
|
2039
|
+
* "DisplayVersion": "1.0.0",
|
2040
|
+
* "CreationDate": "2018-08-17T22:32:10.472Z",
|
2041
|
+
* "Contents": [
|
2042
|
+
* {
|
2043
|
+
* "Id": "00000000-0000-0000-0000-000000000001",
|
2044
|
+
* "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
|
2045
|
+
* "MaxClientVersion": "2.4.1",
|
2046
|
+
* "MinClientVersion": "2.0.0"
|
2047
|
+
* }
|
2048
|
+
* ],
|
2049
|
+
* "Images": [
|
2050
|
+
* {
|
2051
|
+
* "Id": "00000000-0000-0000-0000-000000000003",
|
2052
|
+
* "Type": "Thumbnail",
|
2053
|
+
* "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
|
2054
|
+
* }
|
2055
|
+
* ],
|
2056
|
+
* "DisplayProperties": {
|
2057
|
+
* "mapDetails": {
|
2058
|
+
* "mapType": "desertIsland",
|
2059
|
+
* "gameMode": "capture",
|
2060
|
+
* "maxPlayers": 16
|
2061
|
+
* },
|
2062
|
+
* "averageMatchLengthInSeconds": 947
|
2063
|
+
* },
|
2064
|
+
* "DefaultStackId": "Static_Default_Stack_Id"
|
2065
|
+
* },
|
2066
|
+
* "Publish": false
|
2067
|
+
* });
|
1591
2068
|
*/
|
1592
2069
|
CreateDraftItem(request: CreateDraftItemRequest, extraHeaders?: Record<string, string>): Promise<CreateDraftItemResponse>;
|
1593
2070
|
/**
|
@@ -1595,36 +2072,141 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1595
2072
|
* content will be garbage collected after 24 hours if not attached to a draft or published item. Detailed pricing info
|
1596
2073
|
* around uploading content can be found here:
|
1597
2074
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/pricing/meters/catalog-meters
|
1598
|
-
*
|
2075
|
+
*
|
2076
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/createuploadurls Microsoft Documentation}
|
2077
|
+
* @example
|
2078
|
+
* await catalogClient.CreateUploadUrls({
|
2079
|
+
* "Files": [
|
2080
|
+
* {
|
2081
|
+
* "FileName": "textures.zip"
|
2082
|
+
* },
|
2083
|
+
* {
|
2084
|
+
* "FileName": "sprites.png"
|
2085
|
+
* }
|
2086
|
+
* ]
|
2087
|
+
* });
|
1599
2088
|
*/
|
1600
2089
|
CreateUploadUrls(request: CreateUploadUrlsRequest, extraHeaders?: Record<string, string>): Promise<CreateUploadUrlsResponse>;
|
2090
|
+
/**
|
2091
|
+
* Given an existing Catalog Version, create an URL location where titles can upload a JSON schema of a catalog, if the
|
2092
|
+
* catalog is empty.
|
2093
|
+
*
|
2094
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/createversionedcataloguploadurl Microsoft Documentation}
|
2095
|
+
* @example
|
2096
|
+
* await versionedcatalogClient.CreateVersionedCatalogUploadURL({});
|
2097
|
+
*/
|
2098
|
+
CreateVersionedCatalogUploadURL(request: CreateVersionedCatalogUploadURLRequest, extraHeaders?: Record<string, string>): Promise<CreateVersionedCatalogUploadURLResponse>;
|
2099
|
+
/**
|
2100
|
+
* Creates a new view in the catalog using provided metadata.
|
2101
|
+
*
|
2102
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/createview Microsoft Documentation}
|
2103
|
+
* @example
|
2104
|
+
* await catalogClient.CreateView({
|
2105
|
+
* "View": {
|
2106
|
+
* "FriendlyId": "exampleView",
|
2107
|
+
* "IsTitleView": false,
|
2108
|
+
* "Count": 10,
|
2109
|
+
* "Filter": "tags/any(t:t eq 'desert') and contentType eq 'map'",
|
2110
|
+
* "Language": "en-US",
|
2111
|
+
* "FileFormat": "JsonLines"
|
2112
|
+
* }
|
2113
|
+
* });
|
2114
|
+
*/
|
2115
|
+
CreateView(request: CreateViewRequest, extraHeaders?: Record<string, string>): Promise<CreateViewResponse>;
|
1601
2116
|
/**
|
1602
2117
|
* Deletes all reviews, helpfulness votes, and ratings submitted by the entity specified.
|
1603
|
-
*
|
2118
|
+
*
|
2119
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/deleteentityitemreviews Microsoft Documentation}
|
2120
|
+
* @example
|
2121
|
+
* await catalogClient.DeleteEntityItemReviews({
|
2122
|
+
* "Entity": {
|
2123
|
+
* "Id": "ABC123",
|
2124
|
+
* "Type": "title_player_account",
|
2125
|
+
* "TypeString": "title_player_account"
|
2126
|
+
* }
|
2127
|
+
* });
|
1604
2128
|
*/
|
1605
2129
|
DeleteEntityItemReviews(request: DeleteEntityItemReviewsRequest, extraHeaders?: Record<string, string>): Promise<DeleteEntityItemReviewsResponse>;
|
1606
2130
|
/**
|
1607
2131
|
* Delete an Inventory Collection. More information about Inventory Collections can be found here:
|
1608
2132
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/collections
|
1609
|
-
*
|
2133
|
+
*
|
2134
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/deleteinventorycollection Microsoft Documentation}
|
2135
|
+
* @example
|
2136
|
+
* await inventoryClient.DeleteInventoryCollection({
|
2137
|
+
* "CollectionId": "backpack"
|
2138
|
+
* });
|
1610
2139
|
*/
|
1611
2140
|
DeleteInventoryCollection(request: DeleteInventoryCollectionRequest, extraHeaders?: Record<string, string>): Promise<DeleteInventoryCollectionResponse>;
|
1612
2141
|
/**
|
1613
2142
|
* Delete inventory items
|
1614
|
-
*
|
2143
|
+
*
|
2144
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/deleteinventoryitems Microsoft Documentation}
|
2145
|
+
* @example
|
2146
|
+
* await inventoryClient.DeleteInventoryItems({
|
2147
|
+
* "Item": {
|
2148
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
2149
|
+
* }
|
2150
|
+
* });
|
1615
2151
|
*/
|
1616
2152
|
DeleteInventoryItems(request: DeleteInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<DeleteInventoryItemsResponse>;
|
1617
2153
|
/**
|
1618
2154
|
* Removes an item from working catalog and all published versions from the public catalog.
|
1619
|
-
*
|
2155
|
+
*
|
2156
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/deleteitem Microsoft Documentation}
|
2157
|
+
* @example
|
2158
|
+
* await catalogClient.DeleteItem({
|
2159
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2160
|
+
* });
|
1620
2161
|
*/
|
1621
2162
|
DeleteItem(request: DeleteItemRequest, extraHeaders?: Record<string, string>): Promise<DeleteItemResponse>;
|
2163
|
+
/**
|
2164
|
+
* Delete versioned catalog.
|
2165
|
+
*
|
2166
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/deleteversionedcatalog Microsoft Documentation}
|
2167
|
+
* @example
|
2168
|
+
* await versionedcatalogClient.DeleteVersionedCatalog({});
|
2169
|
+
*/
|
2170
|
+
DeleteVersionedCatalog(request: DeleteVersionedCatalogRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2171
|
+
/**
|
2172
|
+
* Deletes a catalog view and the associated blob.
|
2173
|
+
*
|
2174
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/deleteview Microsoft Documentation}
|
2175
|
+
* @example
|
2176
|
+
* await catalogClient.DeleteView({
|
2177
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2178
|
+
* });
|
2179
|
+
*/
|
2180
|
+
DeleteView(request: DeleteViewRequest, extraHeaders?: Record<string, string>): Promise<DeleteViewResponse>;
|
1622
2181
|
/**
|
1623
2182
|
* Execute a list of Inventory Operations. A maximum list of 50 operations can be performed by a single request. There is
|
1624
2183
|
* also a limit to 300 items that can be modified/added in a single request. For example, adding a bundle with 50 items
|
1625
2184
|
* counts as 50 items modified. All operations must be done within a single inventory collection. This API has a reduced
|
1626
2185
|
* RPS compared to an individual inventory operation with Player Entities limited to 60 requests in 90 seconds.
|
1627
|
-
*
|
2186
|
+
*
|
2187
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/executeinventoryoperations Microsoft Documentation}
|
2188
|
+
* @example
|
2189
|
+
* await inventoryClient.ExecuteInventoryOperations({
|
2190
|
+
* "Operations": [
|
2191
|
+
* {
|
2192
|
+
* "Add": {
|
2193
|
+
* "Item": {
|
2194
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
2195
|
+
* },
|
2196
|
+
* "Amount": 3
|
2197
|
+
* }
|
2198
|
+
* },
|
2199
|
+
* {
|
2200
|
+
* "Subtract": {
|
2201
|
+
* "Item": {
|
2202
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
2203
|
+
* },
|
2204
|
+
* "Amount": 3,
|
2205
|
+
* "DeleteEmptyStacks": false
|
2206
|
+
* }
|
2207
|
+
* }
|
2208
|
+
* ]
|
2209
|
+
* });
|
1628
2210
|
*/
|
1629
2211
|
ExecuteInventoryOperations(request: ExecuteInventoryOperationsRequest, extraHeaders?: Record<string, string>): Promise<ExecuteInventoryOperationsResponse>;
|
1630
2212
|
/**
|
@@ -1632,14 +2214,55 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1632
2214
|
* response code is 202, one or more operations did not complete within the timeframe of the request. You can identify the
|
1633
2215
|
* pending operations by looking for OperationStatus = 'InProgress'. You can check on the operation status at anytime
|
1634
2216
|
* within 1 day of the request by passing the TransactionToken to the GetInventoryOperationStatus API.
|
1635
|
-
*
|
2217
|
+
*
|
2218
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/executetransferoperations Microsoft Documentation}
|
2219
|
+
* @example
|
2220
|
+
* await inventoryClient.ExecuteTransferOperations({
|
2221
|
+
* "Operations": [
|
2222
|
+
* {
|
2223
|
+
* "GivingItem": {
|
2224
|
+
* "Id": "11111111-1111-1111-1111-111111111111",
|
2225
|
+
* "StackId": "default"
|
2226
|
+
* },
|
2227
|
+
* "ReceivingItem": {
|
2228
|
+
* "Id": "11111111-1111-1111-1111-111111111111",
|
2229
|
+
* "StackId": "default"
|
2230
|
+
* },
|
2231
|
+
* "Amount": 1,
|
2232
|
+
* "DeleteEmptyStacks": false
|
2233
|
+
* }
|
2234
|
+
* ],
|
2235
|
+
* "GivingEntity": {
|
2236
|
+
* "Id": "someId1",
|
2237
|
+
* "Type": "title_player_account",
|
2238
|
+
* "TypeString": "title_player_account"
|
2239
|
+
* },
|
2240
|
+
* "ReceivingEntity": {
|
2241
|
+
* "Id": "someId2",
|
2242
|
+
* "Type": "title_player_account",
|
2243
|
+
* "TypeString": "title_player_account"
|
2244
|
+
* },
|
2245
|
+
* "GivingCollectionId": "default",
|
2246
|
+
* "ReceivingCollectionId": "backpack"
|
2247
|
+
* });
|
1636
2248
|
*/
|
1637
2249
|
ExecuteTransferOperations(request: ExecuteTransferOperationsRequest, extraHeaders?: Record<string, string>): Promise<ExecuteTransferOperationsResponse>;
|
2250
|
+
/**
|
2251
|
+
* Export versioned catalog.
|
2252
|
+
*
|
2253
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/exportversionedcatalog Microsoft Documentation}
|
2254
|
+
* @example
|
2255
|
+
* await versionedcatalogClient.ExportVersionedCatalog({});
|
2256
|
+
*/
|
2257
|
+
ExportVersionedCatalog(request: ExportVersionedCatalogRequest, extraHeaders?: Record<string, string>): Promise<IActionResult>;
|
1638
2258
|
/**
|
1639
2259
|
* Gets the configuration for the catalog. Only Title Entities can call this API. There is a limit of 100 requests in 10
|
1640
2260
|
* seconds for this API. More information about the Catalog Config can be found here:
|
1641
2261
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings
|
1642
|
-
*
|
2262
|
+
*
|
2263
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getcatalogconfig Microsoft Documentation}
|
2264
|
+
* @example
|
2265
|
+
* await catalogClient.GetCatalogConfig({});
|
1643
2266
|
*/
|
1644
2267
|
GetCatalogConfig(request: GetCatalogConfigRequest, extraHeaders?: Record<string, string>): Promise<GetCatalogConfigResponse>;
|
1645
2268
|
/**
|
@@ -1647,52 +2270,98 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1647
2270
|
* does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note
|
1648
2271
|
* that item references data is cached and may take a few moments for changes to propagate. Note: SAS tokens provided are
|
1649
2272
|
* valid for 1 hour.
|
1650
|
-
*
|
2273
|
+
*
|
2274
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getdraftitem Microsoft Documentation}
|
2275
|
+
* @example
|
2276
|
+
* await catalogClient.GetDraftItem({
|
2277
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2278
|
+
* });
|
1651
2279
|
*/
|
1652
2280
|
GetDraftItem(request: GetDraftItemRequest, extraHeaders?: Record<string, string>): Promise<GetDraftItemResponse>;
|
1653
2281
|
/**
|
1654
2282
|
* Retrieves a paginated list of the items from the draft catalog. Up to 50 IDs can be retrieved in a single request.
|
1655
2283
|
* GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. Note:
|
1656
2284
|
* SAS tokens provided are valid for 1 hour.
|
1657
|
-
*
|
2285
|
+
*
|
2286
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getdraftitems Microsoft Documentation}
|
2287
|
+
* @example
|
2288
|
+
* await catalogClient.GetDraftItems({
|
2289
|
+
* "Ids": [
|
2290
|
+
* "dddddddd-dddd-dddd-dddd-dddddddddddd",
|
2291
|
+
* "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"
|
2292
|
+
* ]
|
2293
|
+
* });
|
1658
2294
|
*/
|
1659
2295
|
GetDraftItems(request: GetDraftItemsRequest, extraHeaders?: Record<string, string>): Promise<GetDraftItemsResponse>;
|
1660
2296
|
/**
|
1661
2297
|
* Retrieves a paginated list of the items from the draft catalog created by the Entity. Up to 50 items can be returned at
|
1662
2298
|
* once. You can use continuation tokens to paginate through results that return greater than the limit.
|
1663
2299
|
* GetEntityDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates.
|
1664
|
-
*
|
2300
|
+
*
|
2301
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getentitydraftitems Microsoft Documentation}
|
2302
|
+
* @example
|
2303
|
+
* await catalogClient.GetEntityDraftItems({
|
2304
|
+
* "Count": 2,
|
2305
|
+
* "Entity": {
|
2306
|
+
* "Id": "someId",
|
2307
|
+
* "Type": "title_player_account",
|
2308
|
+
* "TypeString": "title_player_account"
|
2309
|
+
* }
|
2310
|
+
* });
|
1665
2311
|
*/
|
1666
2312
|
GetEntityDraftItems(request: GetEntityDraftItemsRequest, extraHeaders?: Record<string, string>): Promise<GetEntityDraftItemsResponse>;
|
1667
2313
|
/**
|
1668
2314
|
* Gets the submitted review for the specified item by the authenticated entity. Individual ratings and reviews data update
|
1669
2315
|
* in near real time with delays within a few seconds.
|
1670
|
-
*
|
2316
|
+
*
|
2317
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getentityitemreview Microsoft Documentation}
|
2318
|
+
* @example
|
2319
|
+
* await catalogClient.GetEntityItemReview({
|
2320
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2321
|
+
* });
|
1671
2322
|
*/
|
1672
2323
|
GetEntityItemReview(request: GetEntityItemReviewRequest, extraHeaders?: Record<string, string>): Promise<GetEntityItemReviewResponse>;
|
1673
2324
|
/**
|
1674
2325
|
* Get Inventory Collection Ids. Up to 50 Ids can be returned at once (or 250 with response compression enabled). You can
|
1675
2326
|
* use continuation tokens to paginate through results that return greater than the limit. It can take a few seconds for
|
1676
2327
|
* new collection Ids to show up.
|
1677
|
-
*
|
2328
|
+
*
|
2329
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/getinventorycollectionids Microsoft Documentation}
|
2330
|
+
* @example
|
2331
|
+
* await inventoryClient.GetInventoryCollectionIds({
|
2332
|
+
* "Count": 5
|
2333
|
+
* });
|
1678
2334
|
*/
|
1679
2335
|
GetInventoryCollectionIds(request: GetInventoryCollectionIdsRequest, extraHeaders?: Record<string, string>): Promise<GetInventoryCollectionIdsResponse>;
|
1680
2336
|
/**
|
1681
2337
|
* Get current inventory items.
|
1682
|
-
*
|
2338
|
+
*
|
2339
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/getinventoryitems Microsoft Documentation}
|
2340
|
+
* @example
|
2341
|
+
* await inventoryClient.GetInventoryItems({
|
2342
|
+
* "Count": 5
|
2343
|
+
* });
|
1683
2344
|
*/
|
1684
2345
|
GetInventoryItems(request: GetInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<GetInventoryItemsResponse>;
|
1685
2346
|
/**
|
1686
2347
|
* Get the status of an inventory operation using an OperationToken. You can check on the operation status at anytime
|
1687
2348
|
* within 1 day of the request by passing the TransactionToken to the this API.
|
1688
|
-
*
|
2349
|
+
*
|
2350
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/getinventoryoperationstatus Microsoft Documentation}
|
2351
|
+
* @example
|
2352
|
+
* await inventoryClient.GetInventoryOperationStatus({});
|
1689
2353
|
*/
|
1690
2354
|
GetInventoryOperationStatus(request: GetInventoryOperationStatusRequest, extraHeaders?: Record<string, string>): Promise<GetInventoryOperationStatusResponse>;
|
1691
2355
|
/**
|
1692
2356
|
* Retrieves an item from the public catalog. GetItem does not work off a cache of the Catalog and should be used when
|
1693
2357
|
* trying to get recent item updates. However, please note that item references data is cached and may take a few moments
|
1694
2358
|
* for changes to propagate.
|
1695
|
-
*
|
2359
|
+
*
|
2360
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitem Microsoft Documentation}
|
2361
|
+
* @example
|
2362
|
+
* await catalogClient.GetItem({
|
2363
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2364
|
+
* });
|
1696
2365
|
*/
|
1697
2366
|
GetItem(request: GetItemRequest, extraHeaders?: Record<string, string>): Promise<GetItemResponse>;
|
1698
2367
|
/**
|
@@ -1700,108 +2369,286 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1700
2369
|
* once. You can use continuation tokens to paginate through results that return greater than the limit. This API is
|
1701
2370
|
* intended for tooling/automation scenarios and has a reduced RPS with Player Entities limited to 30 requests in 300
|
1702
2371
|
* seconds and Title Entities limited to 100 requests in 10 seconds.
|
1703
|
-
*
|
2372
|
+
*
|
2373
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitemcontainers Microsoft Documentation}
|
2374
|
+
* @example
|
2375
|
+
* await catalogClient.GetItemContainers({
|
2376
|
+
* "Count": 5,
|
2377
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2378
|
+
* });
|
1704
2379
|
*/
|
1705
2380
|
GetItemContainers(request: GetItemContainersRequest, extraHeaders?: Record<string, string>): Promise<GetItemContainersResponse>;
|
1706
2381
|
/**
|
1707
2382
|
* Gets the moderation state for an item, including the concern category and string reason. More information about
|
1708
2383
|
* moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation
|
1709
|
-
*
|
2384
|
+
*
|
2385
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitemmoderationstate Microsoft Documentation}
|
2386
|
+
* @example
|
2387
|
+
* await catalogClient.GetItemModerationState({
|
2388
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2389
|
+
* });
|
1710
2390
|
*/
|
1711
2391
|
GetItemModerationState(request: GetItemModerationStateRequest, extraHeaders?: Record<string, string>): Promise<GetItemModerationStateResponse>;
|
1712
2392
|
/**
|
1713
2393
|
* Gets the status of a publish of an item.
|
1714
|
-
*
|
2394
|
+
*
|
2395
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitempublishstatus Microsoft Documentation}
|
2396
|
+
* @example
|
2397
|
+
* await catalogClient.GetItemPublishStatus({
|
2398
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2399
|
+
* });
|
1715
2400
|
*/
|
1716
2401
|
GetItemPublishStatus(request: GetItemPublishStatusRequest, extraHeaders?: Record<string, string>): Promise<GetItemPublishStatusResponse>;
|
1717
2402
|
/**
|
1718
2403
|
* Get a paginated set of reviews associated with the specified item. Individual ratings and reviews data update in near
|
1719
2404
|
* real time with delays within a few seconds.
|
1720
|
-
*
|
2405
|
+
*
|
2406
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitemreviews Microsoft Documentation}
|
2407
|
+
* @example
|
2408
|
+
* await catalogClient.GetItemReviews({
|
2409
|
+
* "Count": 2,
|
2410
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2411
|
+
* });
|
1721
2412
|
*/
|
1722
2413
|
GetItemReviews(request: GetItemReviewsRequest, extraHeaders?: Record<string, string>): Promise<GetItemReviewsResponse>;
|
1723
2414
|
/**
|
1724
2415
|
* Get a summary of all ratings and reviews associated with the specified item. Summary ratings data is cached with update
|
1725
2416
|
* data coming within 15 minutes.
|
1726
|
-
*
|
2417
|
+
*
|
2418
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitemreviewsummary Microsoft Documentation}
|
2419
|
+
* @example
|
2420
|
+
* await catalogClient.GetItemReviewSummary({
|
2421
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2422
|
+
* });
|
1727
2423
|
*/
|
1728
2424
|
GetItemReviewSummary(request: GetItemReviewSummaryRequest, extraHeaders?: Record<string, string>): Promise<GetItemReviewSummaryResponse>;
|
1729
2425
|
/**
|
1730
2426
|
* Retrieves items from the public catalog. Up to 50 items can be returned at once. GetItems does not work off a cache of
|
1731
2427
|
* the Catalog and should be used when trying to get recent item updates. However, please note that item references data is
|
1732
2428
|
* cached and may take a few moments for changes to propagate.
|
1733
|
-
*
|
2429
|
+
*
|
2430
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getitems Microsoft Documentation}
|
2431
|
+
* @example
|
2432
|
+
* await catalogClient.GetItems({
|
2433
|
+
* "Ids": [
|
2434
|
+
* "dddddddd-dddd-dddd-dddd-dddddddddddd",
|
2435
|
+
* "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"
|
2436
|
+
* ]
|
2437
|
+
* });
|
1734
2438
|
*/
|
1735
2439
|
GetItems(request: GetItemsRequest, extraHeaders?: Record<string, string>): Promise<GetItemsResponse>;
|
1736
2440
|
/**
|
1737
2441
|
* Gets the access tokens.
|
1738
|
-
*
|
2442
|
+
*
|
2443
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/getmicrosoftstoreaccesstokens Microsoft Documentation}
|
2444
|
+
* @example
|
2445
|
+
* await inventoryClient.GetMicrosoftStoreAccessTokens({});
|
1739
2446
|
*/
|
1740
2447
|
GetMicrosoftStoreAccessTokens(request: GetMicrosoftStoreAccessTokensRequest, extraHeaders?: Record<string, string>): Promise<GetMicrosoftStoreAccessTokensResponse>;
|
1741
2448
|
/**
|
1742
2449
|
* Get transaction history for a player. Up to 250 Events can be returned at once. You can use continuation tokens to
|
1743
2450
|
* paginate through results that return greater than the limit. Getting transaction history has a lower RPS limit than
|
1744
2451
|
* getting a Player's inventory with Player Entities having a limit of 30 requests in 300 seconds.
|
1745
|
-
*
|
2452
|
+
*
|
2453
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/gettransactionhistory Microsoft Documentation}
|
2454
|
+
* @example
|
2455
|
+
* await inventoryClient.GetTransactionHistory({
|
2456
|
+
* "Count": 10,
|
2457
|
+
* "CollectionId": "default"
|
2458
|
+
* });
|
1746
2459
|
*/
|
1747
2460
|
GetTransactionHistory(request: GetTransactionHistoryRequest, extraHeaders?: Record<string, string>): Promise<GetTransactionHistoryResponse>;
|
2461
|
+
/**
|
2462
|
+
* Get versioned catalog item.
|
2463
|
+
*
|
2464
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/getversionedcatalogitem Microsoft Documentation}
|
2465
|
+
* @example
|
2466
|
+
* await versionedcatalogClient.GetVersionedCatalogItem({});
|
2467
|
+
*/
|
2468
|
+
GetVersionedCatalogItem(request: GetVersionedCatalogItemRequest, extraHeaders?: Record<string, string>): Promise<GetVersionedCatalogItemResponse>;
|
2469
|
+
/**
|
2470
|
+
* Returns the current status of a Versioned Catalog upload.
|
2471
|
+
*
|
2472
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/getversionedcataloguploadstatus Microsoft Documentation}
|
2473
|
+
* @example
|
2474
|
+
* await versionedcatalogClient.GetVersionedCatalogUploadStatus({});
|
2475
|
+
*/
|
2476
|
+
GetVersionedCatalogUploadStatus(request: GetVersionedCatalogUploadStatusRequest, extraHeaders?: Record<string, string>): Promise<GetVersionedCatalogUploadStatusResponse>;
|
2477
|
+
/**
|
2478
|
+
* Retrieves a specific catalog view.
|
2479
|
+
*
|
2480
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getview Microsoft Documentation}
|
2481
|
+
* @example
|
2482
|
+
* await catalogClient.GetView({
|
2483
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2484
|
+
* });
|
2485
|
+
*/
|
2486
|
+
GetView(request: GetViewRequest, extraHeaders?: Record<string, string>): Promise<GetViewResponse>;
|
2487
|
+
/**
|
2488
|
+
* Retrieves a paginated list of the catalog views.
|
2489
|
+
*
|
2490
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/getviews Microsoft Documentation}
|
2491
|
+
* @example
|
2492
|
+
* await catalogClient.GetViews({
|
2493
|
+
* "Count": 5,
|
2494
|
+
* "Entity": {
|
2495
|
+
* "Id": "someId",
|
2496
|
+
* "Type": "title_player_account",
|
2497
|
+
* "TypeString": "title_player_account"
|
2498
|
+
* }
|
2499
|
+
* });
|
2500
|
+
*/
|
2501
|
+
GetViews(request: GetViewsRequest, extraHeaders?: Record<string, string>): Promise<GetViewsResponse>;
|
2502
|
+
/**
|
2503
|
+
* List versioned catalogs.
|
2504
|
+
*
|
2505
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/versionedcatalog/versionedcatalog/listversionedcatalogs Microsoft Documentation}
|
2506
|
+
* @example
|
2507
|
+
* await versionedcatalogClient.ListVersionedCatalogs({});
|
2508
|
+
*/
|
2509
|
+
ListVersionedCatalogs(request: ListVersionedCatalogsRequest, extraHeaders?: Record<string, string>): Promise<ListVersionedCatalogsResponse>;
|
1748
2510
|
/**
|
1749
2511
|
* Initiates a publish of an item from the working catalog to the public catalog. You can use the GetItemPublishStatus API
|
1750
2512
|
* to track the state of the item publish.
|
1751
|
-
*
|
2513
|
+
*
|
2514
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/publishdraftitem Microsoft Documentation}
|
2515
|
+
* @example
|
2516
|
+
* await catalogClient.PublishDraftItem({
|
2517
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2518
|
+
* });
|
1752
2519
|
*/
|
1753
2520
|
PublishDraftItem(request: PublishDraftItemRequest, extraHeaders?: Record<string, string>): Promise<PublishDraftItemResponse>;
|
1754
2521
|
/**
|
1755
2522
|
* Purchase an item or bundle. Up to 10,000 stacks of items can be added to a single inventory collection. Stack size is
|
1756
2523
|
* uncapped.
|
1757
|
-
*
|
2524
|
+
*
|
2525
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/purchaseinventoryitems Microsoft Documentation}
|
2526
|
+
* @example
|
2527
|
+
* await inventoryClient.PurchaseInventoryItems({
|
2528
|
+
* "Item": {
|
2529
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
2530
|
+
* },
|
2531
|
+
* "Amount": 1,
|
2532
|
+
* "PriceAmounts": [
|
2533
|
+
* {
|
2534
|
+
* "ItemId": "cccccccc-cccc-cccc-cccc-cccccccccccc",
|
2535
|
+
* "Amount": 15
|
2536
|
+
* }
|
2537
|
+
* ],
|
2538
|
+
* "DeleteEmptyStacks": false
|
2539
|
+
* });
|
1758
2540
|
*/
|
1759
2541
|
PurchaseInventoryItems(request: PurchaseInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<PurchaseInventoryItemsResponse>;
|
1760
2542
|
/**
|
1761
2543
|
* Redeem items.
|
1762
|
-
*
|
2544
|
+
*
|
2545
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/redeemappleappstoreinventoryitems Microsoft Documentation}
|
2546
|
+
* @example
|
2547
|
+
* await inventoryClient.RedeemAppleAppStoreInventoryItems({
|
2548
|
+
* "Receipt": "receipt"
|
2549
|
+
* });
|
1763
2550
|
*/
|
1764
2551
|
RedeemAppleAppStoreInventoryItems(request: RedeemAppleAppStoreInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RedeemAppleAppStoreInventoryItemsResponse>;
|
1765
2552
|
/**
|
1766
2553
|
* Redeem items.
|
1767
|
-
*
|
2554
|
+
*
|
2555
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/redeemgoogleplayinventoryitems Microsoft Documentation}
|
2556
|
+
* @example
|
2557
|
+
* await inventoryClient.RedeemGooglePlayInventoryItems({
|
2558
|
+
* "Purchases": [
|
2559
|
+
* {
|
2560
|
+
* "ProductId": "productId",
|
2561
|
+
* "Token": "token"
|
2562
|
+
* }
|
2563
|
+
* ]
|
2564
|
+
* });
|
1768
2565
|
*/
|
1769
2566
|
RedeemGooglePlayInventoryItems(request: RedeemGooglePlayInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RedeemGooglePlayInventoryItemsResponse>;
|
1770
2567
|
/**
|
1771
2568
|
* Redeem items.
|
1772
|
-
*
|
2569
|
+
*
|
2570
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/redeemmicrosoftstoreinventoryitems Microsoft Documentation}
|
2571
|
+
* @example
|
2572
|
+
* await inventoryClient.RedeemMicrosoftStoreInventoryItems({
|
2573
|
+
* "CollectionsIdKey": "collectionsIdKey"
|
2574
|
+
* });
|
1773
2575
|
*/
|
1774
2576
|
RedeemMicrosoftStoreInventoryItems(request: RedeemMicrosoftStoreInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RedeemMicrosoftStoreInventoryItemsResponse>;
|
1775
2577
|
/**
|
1776
2578
|
* Redeem items.
|
1777
|
-
*
|
2579
|
+
*
|
2580
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/redeemnintendoeshopinventoryitems Microsoft Documentation}
|
2581
|
+
* @example
|
2582
|
+
* await inventoryClient.RedeemNintendoEShopInventoryItems({
|
2583
|
+
* "NintendoServiceAccountIdToken": "nsaIdToken"
|
2584
|
+
* });
|
1778
2585
|
*/
|
1779
2586
|
RedeemNintendoEShopInventoryItems(request: RedeemNintendoEShopInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RedeemNintendoEShopInventoryItemsResponse>;
|
1780
2587
|
/**
|
1781
2588
|
* Redeem items.
|
1782
|
-
*
|
2589
|
+
*
|
2590
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/redeemplaystationstoreinventoryitems Microsoft Documentation}
|
2591
|
+
* @example
|
2592
|
+
* await inventoryClient.RedeemPlayStationStoreInventoryItems({
|
2593
|
+
* "AuthorizationCode": "authorizationCode",
|
2594
|
+
* "RedirectUri": "orbis://games",
|
2595
|
+
* "ServiceLabel": "0"
|
2596
|
+
* });
|
1783
2597
|
*/
|
1784
2598
|
RedeemPlayStationStoreInventoryItems(request: RedeemPlayStationStoreInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RedeemPlayStationStoreInventoryItemsResponse>;
|
1785
2599
|
/**
|
1786
2600
|
* Redeem items.
|
1787
|
-
*
|
2601
|
+
*
|
2602
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/redeemsteaminventoryitems Microsoft Documentation}
|
2603
|
+
* @example
|
2604
|
+
* await inventoryClient.RedeemSteamInventoryItems({});
|
1788
2605
|
*/
|
1789
2606
|
RedeemSteamInventoryItems(request: RedeemSteamInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RedeemSteamInventoryItemsResponse>;
|
1790
2607
|
/**
|
1791
2608
|
* Submit a report for an item, indicating in what way the item is inappropriate.
|
1792
|
-
*
|
2609
|
+
*
|
2610
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/reportitem Microsoft Documentation}
|
2611
|
+
* @example
|
2612
|
+
* await catalogClient.ReportItem({
|
2613
|
+
* "ConcernCategory": "Profanity",
|
2614
|
+
* "Reason": "There was swearing in the description.",
|
2615
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2616
|
+
* });
|
1793
2617
|
*/
|
1794
2618
|
ReportItem(request: ReportItemRequest, extraHeaders?: Record<string, string>): Promise<ReportItemResponse>;
|
1795
2619
|
/**
|
1796
2620
|
* Submit a report for a review
|
1797
|
-
*
|
2621
|
+
*
|
2622
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/reportitemreview Microsoft Documentation}
|
2623
|
+
* @example
|
2624
|
+
* await catalogClient.ReportItemReview({
|
2625
|
+
* "ReviewId": "dddddddd-dddd-dddd-dddd-dddddddddddd",
|
2626
|
+
* "ItemId": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
|
2627
|
+
* "ConcernCategory": "OffensiveContent",
|
2628
|
+
* "Reason": "Foul language."
|
2629
|
+
* });
|
1798
2630
|
*/
|
1799
2631
|
ReportItemReview(request: ReportItemReviewRequest, extraHeaders?: Record<string, string>): Promise<ReportItemReviewResponse>;
|
1800
2632
|
/**
|
1801
2633
|
* Creates or updates a review for the specified item. More information around the caching surrounding item ratings and
|
1802
2634
|
* reviews can be found here:
|
1803
2635
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/ratings#ratings-design-and-caching
|
1804
|
-
*
|
2636
|
+
*
|
2637
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/reviewitem Microsoft Documentation}
|
2638
|
+
* @example
|
2639
|
+
* await catalogClient.ReviewItem({
|
2640
|
+
* "Review": {
|
2641
|
+
* "ItemVersion": "2.4.1",
|
2642
|
+
* "Title": "Best Game Ever",
|
2643
|
+
* "ReviewText": "I play this game every day. It's my favorite game yet.",
|
2644
|
+
* "Rating": 5,
|
2645
|
+
* "IsInstalled": true,
|
2646
|
+
* "HelpfulPositive": 0,
|
2647
|
+
* "HelpfulNegative": 0,
|
2648
|
+
* "Submitted": "0001-01-01T00:00:00Z"
|
2649
|
+
* },
|
2650
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2651
|
+
* });
|
1805
2652
|
*/
|
1806
2653
|
ReviewItem(request: ReviewItemRequest, extraHeaders?: Record<string, string>): Promise<ReviewItemResponse>;
|
1807
2654
|
/**
|
@@ -1809,28 +2656,71 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1809
2656
|
* results. SearchItems uses a cache of the catalog with item updates taking up to a few minutes to propagate. You should
|
1810
2657
|
* use the GetItem API for when trying to immediately get recent item updates. More information about the Search API can be
|
1811
2658
|
* found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search
|
1812
|
-
*
|
2659
|
+
*
|
2660
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/searchitems Microsoft Documentation}
|
2661
|
+
* @example
|
2662
|
+
* await catalogClient.SearchItems({
|
2663
|
+
* "Search": "Pirates",
|
2664
|
+
* "Filter": "tags/any(t:t eq 'desert') and contentType eq 'map'",
|
2665
|
+
* "OrderBy": "lastModifiedDate asc",
|
2666
|
+
* "ContinuationToken": "abc=",
|
2667
|
+
* "Count": 2
|
2668
|
+
* });
|
1813
2669
|
*/
|
1814
2670
|
SearchItems(request: SearchItemsRequest, extraHeaders?: Record<string, string>): Promise<SearchItemsResponse>;
|
1815
2671
|
/**
|
1816
2672
|
* Sets the moderation state for an item, including the concern category and string reason. More information about
|
1817
2673
|
* moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation
|
1818
|
-
*
|
2674
|
+
*
|
2675
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/setitemmoderationstate Microsoft Documentation}
|
2676
|
+
* @example
|
2677
|
+
* await catalogClient.SetItemModerationState({
|
2678
|
+
* "Status": "AwaitingModeration",
|
2679
|
+
* "Reason": "User reports over threshold",
|
2680
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2681
|
+
* });
|
1819
2682
|
*/
|
1820
2683
|
SetItemModerationState(request: SetItemModerationStateRequest, extraHeaders?: Record<string, string>): Promise<SetItemModerationStateResponse>;
|
1821
2684
|
/**
|
1822
2685
|
* Submit a vote for a review, indicating whether the review was helpful or unhelpful.
|
1823
|
-
*
|
2686
|
+
*
|
2687
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/submititemreviewvote Microsoft Documentation}
|
2688
|
+
* @example
|
2689
|
+
* await catalogClient.SubmitItemReviewVote({
|
2690
|
+
* "ReviewId": "dddddddd-dddd-dddd-dddd-dddddddddddd",
|
2691
|
+
* "ItemId": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
|
2692
|
+
* "Vote": "Helpful"
|
2693
|
+
* });
|
1824
2694
|
*/
|
1825
2695
|
SubmitItemReviewVote(request: SubmitItemReviewVoteRequest, extraHeaders?: Record<string, string>): Promise<SubmitItemReviewVoteResponse>;
|
1826
2696
|
/**
|
1827
2697
|
* Subtract inventory items.
|
1828
|
-
*
|
2698
|
+
*
|
2699
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/subtractinventoryitems Microsoft Documentation}
|
2700
|
+
* @example
|
2701
|
+
* await inventoryClient.SubtractInventoryItems({
|
2702
|
+
* "Item": {
|
2703
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
2704
|
+
* },
|
2705
|
+
* "Amount": 3,
|
2706
|
+
* "DeleteEmptyStacks": false,
|
2707
|
+
* "ReturnInventory": false
|
2708
|
+
* });
|
1829
2709
|
*/
|
1830
2710
|
SubtractInventoryItems(request: SubtractInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<SubtractInventoryItemsResponse>;
|
1831
2711
|
/**
|
1832
2712
|
* Submit a request to takedown one or more reviews.
|
1833
|
-
*
|
2713
|
+
*
|
2714
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/takedownitemreviews Microsoft Documentation}
|
2715
|
+
* @example
|
2716
|
+
* await catalogClient.TakedownItemReviews({
|
2717
|
+
* "Reviews": [
|
2718
|
+
* {
|
2719
|
+
* "ItemId": "00000000-0000-0000-0000-000000000003",
|
2720
|
+
* "ReviewId": "dddddddd-dddd-dddd-dddd-dddddddddddd"
|
2721
|
+
* }
|
2722
|
+
* ]
|
2723
|
+
* });
|
1834
2724
|
*/
|
1835
2725
|
TakedownItemReviews(request: TakedownItemReviewsRequest, extraHeaders?: Record<string, string>): Promise<TakedownItemReviewsResponse>;
|
1836
2726
|
/**
|
@@ -1840,26 +2730,175 @@ declare class PlayFabEconomyApi extends PlayFabCommon {
|
|
1840
2730
|
* TransactionToken to the GetInventoryOperationStatus API. More information about item transfer scenarios can be found
|
1841
2731
|
* here:
|
1842
2732
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/?tabs=inventory-game-manager#transfer-inventory-items
|
1843
|
-
*
|
2733
|
+
*
|
2734
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/transferinventoryitems Microsoft Documentation}
|
2735
|
+
* @example
|
2736
|
+
* await inventoryClient.TransferInventoryItems({
|
2737
|
+
* "GivingItem": {
|
2738
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
2739
|
+
* },
|
2740
|
+
* "ReceivingItem": {
|
2741
|
+
* "Id": "11111111-1111-1111-1111-111111111111"
|
2742
|
+
* },
|
2743
|
+
* "Amount": 1,
|
2744
|
+
* "DeleteEmptyStacks": false,
|
2745
|
+
* "GivingCollectionId": "default",
|
2746
|
+
* "ReceivingCollectionId": "backpack"
|
2747
|
+
* });
|
1844
2748
|
*/
|
1845
2749
|
TransferInventoryItems(request: TransferInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<TransferInventoryItemsResponse>;
|
1846
2750
|
/**
|
1847
2751
|
* Updates the configuration for the catalog. Only Title Entities can call this API. There is a limit of 10 requests in 10
|
1848
2752
|
* seconds for this API. More information about the Catalog Config can be found here:
|
1849
2753
|
* https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings
|
1850
|
-
*
|
2754
|
+
*
|
2755
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/updatecatalogconfig Microsoft Documentation}
|
2756
|
+
* @example
|
2757
|
+
* await catalogClient.UpdateCatalogConfig({
|
2758
|
+
* "Config": {
|
2759
|
+
* "IsCatalogEnabled": true,
|
2760
|
+
* "AdminEntities": [
|
2761
|
+
* {
|
2762
|
+
* "Id": "ABC123",
|
2763
|
+
* "Type": "title_player_account",
|
2764
|
+
* "TypeString": "title_player_account"
|
2765
|
+
* }
|
2766
|
+
* ],
|
2767
|
+
* "DisplayPropertyIndexInfos": [
|
2768
|
+
* {
|
2769
|
+
* "Name": "damage",
|
2770
|
+
* "Type": "QueryDouble"
|
2771
|
+
* }
|
2772
|
+
* ],
|
2773
|
+
* "ReviewerEntities": [
|
2774
|
+
* {
|
2775
|
+
* "Id": "ABC123",
|
2776
|
+
* "Type": "title_player_account",
|
2777
|
+
* "TypeString": "title_player_account"
|
2778
|
+
* }
|
2779
|
+
* ],
|
2780
|
+
* "UserGeneratedContent": {
|
2781
|
+
* "ContentTypes": [
|
2782
|
+
* "skin",
|
2783
|
+
* "map",
|
2784
|
+
* "example item"
|
2785
|
+
* ],
|
2786
|
+
* "Tags": [
|
2787
|
+
* "pirate",
|
2788
|
+
* "holiday"
|
2789
|
+
* ]
|
2790
|
+
* }
|
2791
|
+
* }
|
2792
|
+
* });
|
1851
2793
|
*/
|
1852
2794
|
UpdateCatalogConfig(request: UpdateCatalogConfigRequest, extraHeaders?: Record<string, string>): Promise<UpdateCatalogConfigResponse>;
|
1853
2795
|
/**
|
1854
2796
|
* Update the metadata for an item in the working catalog. Note: SAS tokens provided are valid for 1 hour.
|
1855
|
-
*
|
2797
|
+
*
|
2798
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/updatedraftitem Microsoft Documentation}
|
2799
|
+
* @example
|
2800
|
+
* await catalogClient.UpdateDraftItem({
|
2801
|
+
* "Item": {
|
2802
|
+
* "Id": "qqqqqqqq-qqqq-qqqq-qqqq-qqqqqqqqqqqq",
|
2803
|
+
* "Type": "ugc",
|
2804
|
+
* "Title": {
|
2805
|
+
* "NEUTRAL": "Neutral title",
|
2806
|
+
* "en-US": "US English title"
|
2807
|
+
* },
|
2808
|
+
* "Description": {
|
2809
|
+
* "NEUTRAL": "Neutral description",
|
2810
|
+
* "en-US": "US English description"
|
2811
|
+
* },
|
2812
|
+
* "Keywords": {
|
2813
|
+
* "NEUTRAL": {
|
2814
|
+
* "Values": [
|
2815
|
+
* "Keyword_1",
|
2816
|
+
* "Keyword_2"
|
2817
|
+
* ]
|
2818
|
+
* }
|
2819
|
+
* },
|
2820
|
+
* "ContentType": "example item",
|
2821
|
+
* "CreatorEntity": {
|
2822
|
+
* "Id": "someId",
|
2823
|
+
* "Type": "title_player_account",
|
2824
|
+
* "TypeString": "title_player_account"
|
2825
|
+
* },
|
2826
|
+
* "IsHidden": false,
|
2827
|
+
* "Tags": [
|
2828
|
+
* "pirates",
|
2829
|
+
* "holiday"
|
2830
|
+
* ],
|
2831
|
+
* "DisplayVersion": "1.0.0",
|
2832
|
+
* "CreationDate": "2018-08-17T22:32:10.472Z",
|
2833
|
+
* "Contents": [
|
2834
|
+
* {
|
2835
|
+
* "Id": "00000000-0000-0000-0000-000000000001",
|
2836
|
+
* "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip",
|
2837
|
+
* "MaxClientVersion": "2.4.1",
|
2838
|
+
* "MinClientVersion": "2.0.0"
|
2839
|
+
* }
|
2840
|
+
* ],
|
2841
|
+
* "Images": [
|
2842
|
+
* {
|
2843
|
+
* "Id": "00000000-0000-0000-0000-000000000003",
|
2844
|
+
* "Type": "Thumbnail",
|
2845
|
+
* "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg"
|
2846
|
+
* }
|
2847
|
+
* ],
|
2848
|
+
* "DisplayProperties": {
|
2849
|
+
* "mapDetails": {
|
2850
|
+
* "mapType": "desertIsland",
|
2851
|
+
* "gameMode": "capture",
|
2852
|
+
* "maxPlayers": 16
|
2853
|
+
* },
|
2854
|
+
* "averageMatchLengthInSeconds": 947
|
2855
|
+
* },
|
2856
|
+
* "DefaultStackId": "Static_Default_Stack_Id"
|
2857
|
+
* },
|
2858
|
+
* "Publish": false
|
2859
|
+
* });
|
1856
2860
|
*/
|
1857
2861
|
UpdateDraftItem(request: UpdateDraftItemRequest, extraHeaders?: Record<string, string>): Promise<UpdateDraftItemResponse>;
|
1858
2862
|
/**
|
1859
2863
|
* Update inventory items
|
1860
|
-
*
|
2864
|
+
*
|
2865
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/inventory/inventory/updateinventoryitems Microsoft Documentation}
|
2866
|
+
* @example
|
2867
|
+
* await inventoryClient.UpdateInventoryItems({
|
2868
|
+
* "Item": {
|
2869
|
+
* "Id": "11111111-1111-1111-1111-111111111111",
|
2870
|
+
* "Amount": 3
|
2871
|
+
* },
|
2872
|
+
* "ReturnInventory": false
|
2873
|
+
* });
|
1861
2874
|
*/
|
1862
2875
|
UpdateInventoryItems(request: UpdateInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateInventoryItemsResponse>;
|
2876
|
+
/**
|
2877
|
+
* Updates an existing view in the catalog using provided metadata.
|
2878
|
+
*
|
2879
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/catalog/catalog/updateview Microsoft Documentation}
|
2880
|
+
* @example
|
2881
|
+
* await catalogClient.UpdateView({
|
2882
|
+
* "View": {
|
2883
|
+
* "Id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
|
2884
|
+
* "FriendlyId": "exampleView",
|
2885
|
+
* "IsTitleView": false,
|
2886
|
+
* "Count": 10,
|
2887
|
+
* "Filter": "tags/any(t:t eq 'desert') and contentType eq 'map'",
|
2888
|
+
* "Language": "en-US",
|
2889
|
+
* "FileFormat": "JsonLines",
|
2890
|
+
* "Url": "https://views.prod.catalog.playfab.com/title-identifier/dddddddd-dddd-dddd-dddd-dddddddddddd.json",
|
2891
|
+
* "LastModifiedDate": "2023-08-17T22:32:31.911Z",
|
2892
|
+
* "CreationDate": "2023-08-17T22:32:10.472Z",
|
2893
|
+
* "LastViewDiagnostics": {
|
2894
|
+
* "GeneratedDate": "2023-08-18T23:32:10.322Z",
|
2895
|
+
* "Status": "Unknown"
|
2896
|
+
* },
|
2897
|
+
* "ETag": "opaqueString"
|
2898
|
+
* }
|
2899
|
+
* });
|
2900
|
+
*/
|
2901
|
+
UpdateView(request: UpdateViewRequest, extraHeaders?: Record<string, string>): Promise<UpdateViewResponse>;
|
1863
2902
|
}
|
1864
2903
|
|
1865
2904
|
export { PlayFabEconomyApi as default };
|