async-playfab-web-sdk 1.192.250526-3 → 1.192.250526-5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. package/dist/Addon.d.ts +179 -39
  2. package/dist/Addon.js +2 -2
  3. package/dist/Admin.d.ts +2386 -195
  4. package/dist/Admin.js +2 -2
  5. package/dist/Authentication.d.ts +32 -5
  6. package/dist/Authentication.js +2 -2
  7. package/dist/Client.d.ts +2235 -321
  8. package/dist/Client.js +2 -2
  9. package/dist/CloudScript.d.ts +199 -31
  10. package/dist/CloudScript.js +2 -2
  11. package/dist/Data.d.ts +137 -18
  12. package/dist/Data.js +2 -2
  13. package/dist/Economy.d.ts +1145 -106
  14. package/dist/Economy.js +2 -2
  15. package/dist/Events.d.ts +200 -13
  16. package/dist/Events.js +2 -2
  17. package/dist/Experimentation.d.ts +164 -17
  18. package/dist/Experimentation.js +2 -2
  19. package/dist/Groups.d.ts +267 -28
  20. package/dist/Groups.js +2 -2
  21. package/dist/Insights.d.ts +33 -7
  22. package/dist/Insights.js +2 -2
  23. package/dist/Localization.d.ts +5 -2
  24. package/dist/Localization.js +2 -2
  25. package/dist/Matchmaker.d.ts +271 -0
  26. package/dist/Matchmaker.js +8 -0
  27. package/dist/Matchmaker.js.map +1 -0
  28. package/dist/Multiplayer.d.ts +2697 -169
  29. package/dist/Multiplayer.js +2 -2
  30. package/dist/{PlayFabCommon-BX3jSqGx.d.ts → PlayFabCommon-Dnp_xHg5.d.ts} +3 -5
  31. package/dist/Profiles.d.ts +163 -19
  32. package/dist/Profiles.js +2 -2
  33. package/dist/Progression.d.ts +287 -35
  34. package/dist/Progression.js +2 -2
  35. package/dist/Server.d.ts +1904 -242
  36. package/dist/Server.js +2 -2
  37. package/dist/chunk-3I6ONUUQ.js +237 -0
  38. package/dist/chunk-3I6ONUUQ.js.map +1 -0
  39. package/dist/chunk-3O5QT4SL.js +2477 -0
  40. package/dist/chunk-3O5QT4SL.js.map +1 -0
  41. package/dist/chunk-3OBHYLBF.js +2673 -0
  42. package/dist/chunk-3OBHYLBF.js.map +1 -0
  43. package/dist/chunk-57KYHGBO.js +421 -0
  44. package/dist/chunk-57KYHGBO.js.map +1 -0
  45. package/dist/{chunk-J4QS5VX5.js → chunk-5CWZN75H.js} +6 -3
  46. package/dist/chunk-5CWZN75H.js.map +1 -0
  47. package/dist/chunk-73SVDH45.js +197 -0
  48. package/dist/chunk-73SVDH45.js.map +1 -0
  49. package/dist/chunk-ADHTNFTN.js +175 -0
  50. package/dist/chunk-ADHTNFTN.js.map +1 -0
  51. package/dist/chunk-C7U2JQNZ.js +76 -0
  52. package/dist/chunk-C7U2JQNZ.js.map +1 -0
  53. package/dist/{chunk-SGSEOIKS.js → chunk-GAZYZIK2.js} +34 -8
  54. package/dist/chunk-GAZYZIK2.js.map +1 -0
  55. package/dist/chunk-J54WY4UN.js +413 -0
  56. package/dist/chunk-J54WY4UN.js.map +1 -0
  57. package/dist/chunk-NFWQ4MMZ.js +1048 -0
  58. package/dist/chunk-NFWQ4MMZ.js.map +1 -0
  59. package/dist/{chunk-A7VD6ALV.js → chunk-P7UVG26J.js} +167 -32
  60. package/dist/chunk-P7UVG26J.js.map +1 -0
  61. package/dist/chunk-PFXZB4UN.js +2387 -0
  62. package/dist/chunk-PFXZB4UN.js.map +1 -0
  63. package/dist/{chunk-X34XZJB6.js → chunk-QNGQW3YB.js} +28 -6
  64. package/dist/chunk-QNGQW3YB.js.map +1 -0
  65. package/dist/chunk-SQWILU5T.js +270 -0
  66. package/dist/chunk-SQWILU5T.js.map +1 -0
  67. package/dist/{chunk-JGDO2ZE3.js → chunk-SR2RIRLX.js} +1482 -175
  68. package/dist/chunk-SR2RIRLX.js.map +1 -0
  69. package/dist/{chunk-62SULWOK.js → chunk-XVDYM74A.js} +17 -14
  70. package/dist/chunk-XVDYM74A.js.map +1 -0
  71. package/dist/chunk-ZW4TJ3MQ.js +225 -0
  72. package/dist/chunk-ZW4TJ3MQ.js.map +1 -0
  73. package/dist/index.d.ts +7 -6
  74. package/dist/index.js +29 -25
  75. package/package.json +2 -2
  76. package/dist/chunk-3FCAP7OZ.js +0 -187
  77. package/dist/chunk-3FCAP7OZ.js.map +0 -1
  78. package/dist/chunk-62SULWOK.js.map +0 -1
  79. package/dist/chunk-A7VD6ALV.js.map +0 -1
  80. package/dist/chunk-BX65UND2.js +0 -632
  81. package/dist/chunk-BX65UND2.js.map +0 -1
  82. package/dist/chunk-J4QS5VX5.js.map +0 -1
  83. package/dist/chunk-JGDO2ZE3.js.map +0 -1
  84. package/dist/chunk-POMI7LEF.js +0 -76
  85. package/dist/chunk-POMI7LEF.js.map +0 -1
  86. package/dist/chunk-Q3OF3AOJ.js +0 -97
  87. package/dist/chunk-Q3OF3AOJ.js.map +0 -1
  88. package/dist/chunk-QUZHVSVZ.js +0 -174
  89. package/dist/chunk-QUZHVSVZ.js.map +0 -1
  90. package/dist/chunk-QVLIVSO4.js +0 -1147
  91. package/dist/chunk-QVLIVSO4.js.map +0 -1
  92. package/dist/chunk-R7V7DFCF.js +0 -103
  93. package/dist/chunk-R7V7DFCF.js.map +0 -1
  94. package/dist/chunk-SGSEOIKS.js.map +0 -1
  95. package/dist/chunk-UOHHNVCJ.js +0 -119
  96. package/dist/chunk-UOHHNVCJ.js.map +0 -1
  97. package/dist/chunk-USKFWNQK.js +0 -384
  98. package/dist/chunk-USKFWNQK.js.map +0 -1
  99. package/dist/chunk-UX7LFJCX.js +0 -61
  100. package/dist/chunk-UX7LFJCX.js.map +0 -1
  101. package/dist/chunk-X34XZJB6.js.map +0 -1
  102. package/dist/chunk-YNZF3WXS.js +0 -882
  103. package/dist/chunk-YNZF3WXS.js.map +0 -1
package/dist/Data.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-BX3jSqGx.js';
1
+ import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
2
2
 
3
3
  interface AbortFileUploadsRequest extends IPlayFabRequestCommon {
4
4
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
@@ -8,7 +8,7 @@ interface AbortFileUploadsRequest extends IPlayFabRequestCommon {
8
8
  /** Names of the files to have their pending uploads aborted. */
9
9
  FileNames: string[];
10
10
  /**
11
- * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not
11
+ * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not
12
12
  * be performed.
13
13
  */
14
14
  ProfileVersion?: number;
@@ -27,7 +27,7 @@ interface DeleteFilesRequest extends IPlayFabRequestCommon {
27
27
  /** Names of the files to be deleted. */
28
28
  FileNames: string[];
29
29
  /**
30
- * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not
30
+ * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not
31
31
  * be performed.
32
32
  */
33
33
  ProfileVersion?: number;
@@ -43,13 +43,18 @@ interface EntityKey {
43
43
  Id: string;
44
44
  /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
45
45
  Type?: string;
46
+ /**
47
+ * Alternate name for Type.
48
+ * @deprecated Please use Type instead.
49
+ */
50
+ TypeString?: string;
46
51
  }
47
52
  interface FinalizeFileUploadsRequest extends IPlayFabRequestCommon {
48
53
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
49
54
  CustomTags?: Record<string, string | null>;
50
55
  /** The entity to perform this action on. */
51
56
  Entity: EntityKey;
52
- /** Names of the files to be finalized. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' */
57
+ /** Names of the files to be finalized. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39; */
53
58
  FileNames: string[];
54
59
  /** The current version of the profile, can be used for concurrency control during updates. */
55
60
  ProfileVersion: number;
@@ -57,7 +62,7 @@ interface FinalizeFileUploadsRequest extends IPlayFabRequestCommon {
57
62
  interface FinalizeFileUploadsResponse extends IPlayFabResultCommon {
58
63
  /** The entity id and type. */
59
64
  Entity?: EntityKey;
60
- /** Collection of metadata for the entity's files */
65
+ /** Collection of metadata for the entity&#39;s files */
61
66
  Metadata?: Record<string, GetFileMetadata>;
62
67
  /** The current version of the profile, can be used for concurrency control during updates. */
63
68
  ProfileVersion: number;
@@ -71,7 +76,7 @@ interface GetFileMetadata {
71
76
  FileName?: string;
72
77
  /** Last UTC time the file was modified */
73
78
  LastModified: string;
74
- /** Storage service's reported byte count */
79
+ /** Storage service&#39;s reported byte count */
75
80
  Size: number;
76
81
  }
77
82
  interface GetFilesRequest extends IPlayFabRequestCommon {
@@ -83,7 +88,7 @@ interface GetFilesRequest extends IPlayFabRequestCommon {
83
88
  interface GetFilesResponse extends IPlayFabResultCommon {
84
89
  /** The entity id and type. */
85
90
  Entity?: EntityKey;
86
- /** Collection of metadata for the entity's files */
91
+ /** Collection of metadata for the entity&#39;s files */
87
92
  Metadata?: Record<string, GetFileMetadata>;
88
93
  /** The current version of the profile, can be used for concurrency control during updates. */
89
94
  ProfileVersion: number;
@@ -118,10 +123,10 @@ interface InitiateFileUploadsRequest extends IPlayFabRequestCommon {
118
123
  CustomTags?: Record<string, string | null>;
119
124
  /** The entity to perform this action on. */
120
125
  Entity: EntityKey;
121
- /** Names of the files to be set. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' */
126
+ /** Names of the files to be set. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39; */
122
127
  FileNames: string[];
123
128
  /**
124
- * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not
129
+ * The expected version of the profile, if set and doesn&#39;t match the current version of the profile the operation will not
125
130
  * be performed.
126
131
  */
127
132
  ProfileVersion?: number;
@@ -139,7 +144,7 @@ interface ObjectResult {
139
144
  DataObject?: any;
140
145
  /** Escaped string JSON body of the object, if EscapeObject is true. */
141
146
  EscapedDataObject?: string;
142
- /** Name of the object. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' */
147
+ /** Name of the object. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39; */
143
148
  ObjectName?: string;
144
149
  }
145
150
  interface SetObject {
@@ -155,7 +160,7 @@ interface SetObject {
155
160
  * exists, or no operation will occur if it does not exist. Only one of DataObject or EscapedDataObject fields may be used.
156
161
  */
157
162
  EscapedDataObject?: string;
158
- /** Name of object. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */
163
+ /** Name of object. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39;. */
159
164
  ObjectName: string;
160
165
  }
161
166
  interface SetObjectInfo {
@@ -190,37 +195,151 @@ interface SetObjectsResponse extends IPlayFabResultCommon {
190
195
  declare class PlayFabDataApi extends PlayFabCommon {
191
196
  /**
192
197
  * Abort pending file uploads to an entity's profile.
193
- * https://docs.microsoft.com/rest/api/playfab/data/file/abortfileuploads
198
+ *
199
+ * {@link https://docs.microsoft.com/rest/api/playfab/file/file/abortfileuploads Microsoft Documentation}
200
+ * @example
201
+ * await fileClient.AbortFileUploads({
202
+ * "FileNames": [
203
+ * "avatar",
204
+ * "game_state"
205
+ * ],
206
+ * "Entity": {
207
+ * "Id": "ID",
208
+ * "Type": "title_player_account",
209
+ * "TypeString": "title_player_account"
210
+ * }
211
+ * });
194
212
  */
195
213
  AbortFileUploads(request: AbortFileUploadsRequest, extraHeaders?: Record<string, string>): Promise<AbortFileUploadsResponse>;
196
214
  /**
197
215
  * Delete files on an entity's profile.
198
- * https://docs.microsoft.com/rest/api/playfab/data/file/deletefiles
216
+ *
217
+ * {@link https://docs.microsoft.com/rest/api/playfab/file/file/deletefiles Microsoft Documentation}
218
+ * @example
219
+ * await fileClient.DeleteFiles({
220
+ * "FileNames": [
221
+ * "game_state",
222
+ * "avatar"
223
+ * ],
224
+ * "Entity": {
225
+ * "Id": "ID",
226
+ * "Type": "title_player_account",
227
+ * "TypeString": "title_player_account"
228
+ * }
229
+ * });
199
230
  */
200
231
  DeleteFiles(request: DeleteFilesRequest, extraHeaders?: Record<string, string>): Promise<DeleteFilesResponse>;
201
232
  /**
202
233
  * Finalize file uploads to an entity's profile.
203
- * https://docs.microsoft.com/rest/api/playfab/data/file/finalizefileuploads
234
+ *
235
+ * {@link https://docs.microsoft.com/rest/api/playfab/file/file/finalizefileuploads Microsoft Documentation}
236
+ * @example
237
+ * await fileClient.FinalizeFileUploads({
238
+ * "ProfileVersion": 0,
239
+ * "FileNames": [
240
+ * "avatar",
241
+ * "game_state"
242
+ * ],
243
+ * "Entity": {
244
+ * "Id": "ID",
245
+ * "Type": "title_player_account",
246
+ * "TypeString": "title_player_account"
247
+ * }
248
+ * });
204
249
  */
205
250
  FinalizeFileUploads(request: FinalizeFileUploadsRequest, extraHeaders?: Record<string, string>): Promise<FinalizeFileUploadsResponse>;
206
251
  /**
207
252
  * Retrieves file metadata from an entity's profile.
208
- * https://docs.microsoft.com/rest/api/playfab/data/file/getfiles
253
+ *
254
+ * {@link https://docs.microsoft.com/rest/api/playfab/file/file/getfiles Microsoft Documentation}
255
+ * @example
256
+ * await fileClient.GetFiles({
257
+ * "Entity": {
258
+ * "Id": "ID",
259
+ * "Type": "title_player_account",
260
+ * "TypeString": "title_player_account"
261
+ * }
262
+ * });
209
263
  */
210
264
  GetFiles(request: GetFilesRequest, extraHeaders?: Record<string, string>): Promise<GetFilesResponse>;
211
265
  /**
212
266
  * Retrieves objects from an entity's profile.
213
- * https://docs.microsoft.com/rest/api/playfab/data/object/getobjects
267
+ *
268
+ * {@link https://docs.microsoft.com/rest/api/playfab/object/object/getobjects Microsoft Documentation}
269
+ * @example
270
+ * await objectClient.GetObjects({
271
+ * "Entity": {
272
+ * "Id": "ABC90712ABC",
273
+ * "Type": "title_player_account",
274
+ * "TypeString": "title_player_account"
275
+ * }
276
+ * });
214
277
  */
215
278
  GetObjects(request: GetObjectsRequest, extraHeaders?: Record<string, string>): Promise<GetObjectsResponse>;
216
279
  /**
217
280
  * Initiates file uploads to an entity's profile.
218
- * https://docs.microsoft.com/rest/api/playfab/data/file/initiatefileuploads
281
+ *
282
+ * {@link https://docs.microsoft.com/rest/api/playfab/file/file/initiatefileuploads Microsoft Documentation}
283
+ * @example
284
+ * await fileClient.InitiateFileUploads({
285
+ * "FileNames": [
286
+ * "avatar",
287
+ * "game_state"
288
+ * ],
289
+ * "Entity": {
290
+ * "Id": "ID",
291
+ * "Type": "title_player_account",
292
+ * "TypeString": "title_player_account"
293
+ * }
294
+ * });
219
295
  */
220
296
  InitiateFileUploads(request: InitiateFileUploadsRequest, extraHeaders?: Record<string, string>): Promise<InitiateFileUploadsResponse>;
221
297
  /**
222
298
  * Sets objects on an entity's profile.
223
- * https://docs.microsoft.com/rest/api/playfab/data/object/setobjects
299
+ *
300
+ * {@link https://docs.microsoft.com/rest/api/playfab/object/object/setobjects Microsoft Documentation}
301
+ * @example
302
+ * await objectClient.SetObjects({
303
+ * "ExpectedProfileVersion": 5,
304
+ * "Objects": [
305
+ * {
306
+ * "ObjectName": "SaveSate",
307
+ * "DataObject": {
308
+ * "PlayerDetails": {
309
+ * "LastMissionSuccess": "2017-06-15T11:05:19Z",
310
+ * "LastMissionFailure": "2017-06-12T11:05:19Z",
311
+ * "MapPosition": [
312
+ * 22.0,
313
+ * 37.78
314
+ * ],
315
+ * "IsPaidUpgrade": true
316
+ * },
317
+ * "GameSettings": {
318
+ * "Screen": "FriendsList",
319
+ * "Favorites": [
320
+ * "Place 1",
321
+ * "Place 2"
322
+ * ]
323
+ * }
324
+ * },
325
+ * "SimpleStatements": {
326
+ * "Read": [
327
+ * {
328
+ * "Friend": true
329
+ * }
330
+ * ],
331
+ * "Write": [
332
+ * "Self"
333
+ * ]
334
+ * }
335
+ * }
336
+ * ],
337
+ * "Entity": {
338
+ * "Id": "A8140AB9109712B",
339
+ * "Type": "title_player_account",
340
+ * "TypeString": "title_player_account"
341
+ * }
342
+ * });
224
343
  */
225
344
  SetObjects(request: SetObjectsRequest, extraHeaders?: Record<string, string>): Promise<SetObjectsResponse>;
226
345
  }
package/dist/Data.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  PlayFabDataApi
3
- } from "./chunk-UX7LFJCX.js";
4
- import "./chunk-62SULWOK.js";
3
+ } from "./chunk-ADHTNFTN.js";
4
+ import "./chunk-XVDYM74A.js";
5
5
  export {
6
6
  PlayFabDataApi as default
7
7
  };