async-playfab-web-sdk 1.192.250526-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/dist/Addon.d.ts +591 -0
  2. package/dist/Addon.js +452 -0
  3. package/dist/Addon.js.map +1 -0
  4. package/dist/Admin.d.ts +3484 -0
  5. package/dist/Admin.js +1112 -0
  6. package/dist/Admin.js.map +1 -0
  7. package/dist/Authentication.d.ts +109 -0
  8. package/dist/Authentication.js +290 -0
  9. package/dist/Authentication.js.map +1 -0
  10. package/dist/Client.d.ts +4482 -0
  11. package/dist/Client.js +1893 -0
  12. package/dist/Client.js.map +1 -0
  13. package/dist/CloudScript.d.ts +511 -0
  14. package/dist/CloudScript.js +349 -0
  15. package/dist/CloudScript.js.map +1 -0
  16. package/dist/Data.d.ts +228 -0
  17. package/dist/Data.js +291 -0
  18. package/dist/Data.js.map +1 -0
  19. package/dist/Economy.d.ts +1865 -0
  20. package/dist/Economy.js +614 -0
  21. package/dist/Economy.js.map +1 -0
  22. package/dist/Events.d.ts +307 -0
  23. package/dist/Events.js +327 -0
  24. package/dist/Events.js.map +1 -0
  25. package/dist/Experimentation.d.ts +357 -0
  26. package/dist/Experimentation.js +333 -0
  27. package/dist/Experimentation.js.map +1 -0
  28. package/dist/Groups.d.ts +546 -0
  29. package/dist/Groups.js +417 -0
  30. package/dist/Groups.js.map +1 -0
  31. package/dist/Insights.d.ts +141 -0
  32. package/dist/Insights.js +286 -0
  33. package/dist/Insights.js.map +1 -0
  34. package/dist/Localization.d.ts +20 -0
  35. package/dist/Localization.js +249 -0
  36. package/dist/Localization.js.map +1 -0
  37. package/dist/Multiplayer.d.ts +3059 -0
  38. package/dist/Multiplayer.js +862 -0
  39. package/dist/Multiplayer.js.map +1 -0
  40. package/dist/PlayFabCommon-BUv4zqXf.d.ts +72 -0
  41. package/dist/Profiles.d.ts +278 -0
  42. package/dist/Profiles.js +306 -0
  43. package/dist/Profiles.js.map +1 -0
  44. package/dist/Progression.d.ts +598 -0
  45. package/dist/Progression.js +404 -0
  46. package/dist/Progression.js.map +1 -0
  47. package/dist/Server.d.ts +3889 -0
  48. package/dist/Server.js +1377 -0
  49. package/dist/Server.js.map +1 -0
  50. package/dist/index.d.ts +17 -0
  51. package/dist/index.js +6007 -0
  52. package/dist/index.js.map +1 -0
  53. package/package.json +23 -0
  54. package/readme.md +25 -0
@@ -0,0 +1,591 @@
1
+ import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-BUv4zqXf.js';
2
+
3
+ interface CreateOrUpdateAppleRequest extends IPlayFabRequestCommon {
4
+ /** iOS App Bundle ID obtained after setting up your app in the App Store. */
5
+ AppBundleId: string;
6
+ /** iOS App Shared Secret obtained after setting up your app in the App Store. */
7
+ AppSharedSecret?: string;
8
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
9
+ CustomTags?: Record<string, string | null>;
10
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
11
+ Entity?: EntityKey;
12
+ /** If an error should be returned if the addon already exists. */
13
+ ErrorIfExists?: boolean;
14
+ /**
15
+ * Ignore expiration date for identity tokens. Be aware that when set to true this can invalidate expired tokens in the
16
+ * case where Apple rotates their signing keys.
17
+ */
18
+ IgnoreExpirationDate?: boolean;
19
+ /** Require secure authentication only for this app. */
20
+ RequireSecureAuthentication?: boolean;
21
+ }
22
+ interface CreateOrUpdateAppleResponse extends IPlayFabResultCommon {
23
+ }
24
+ interface CreateOrUpdateFacebookInstantGamesRequest extends IPlayFabRequestCommon {
25
+ /** Facebook App ID obtained after setting up your app in Facebook Instant Games. */
26
+ AppID: string;
27
+ /** Facebook App Secret obtained after setting up your app in Facebook Instant Games. */
28
+ AppSecret: string;
29
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
30
+ CustomTags?: Record<string, string | null>;
31
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
32
+ Entity?: EntityKey;
33
+ /** If an error should be returned if the addon already exists. */
34
+ ErrorIfExists?: boolean;
35
+ }
36
+ interface CreateOrUpdateFacebookInstantGamesResponse extends IPlayFabResultCommon {
37
+ }
38
+ interface CreateOrUpdateFacebookRequest extends IPlayFabRequestCommon {
39
+ /** Facebook App ID obtained after setting up your app in Facebook. */
40
+ AppID: string;
41
+ /** Facebook App Secret obtained after setting up your app in Facebook. */
42
+ AppSecret: string;
43
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
44
+ CustomTags?: Record<string, string | null>;
45
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
46
+ Entity?: EntityKey;
47
+ /** If an error should be returned if the addon already exists. */
48
+ ErrorIfExists?: boolean;
49
+ /** Email address for purchase dispute notifications. */
50
+ NotificationEmail: string;
51
+ }
52
+ interface CreateOrUpdateFacebookResponse extends IPlayFabResultCommon {
53
+ }
54
+ interface CreateOrUpdateGoogleRequest extends IPlayFabRequestCommon {
55
+ /**
56
+ * Google App License Key obtained after setting up your app in the Google Play developer portal. Required if using Google
57
+ * receipt validation.
58
+ */
59
+ AppLicenseKey?: string;
60
+ /**
61
+ * Google App Package ID obtained after setting up your app in the Google Play developer portal. Required if using Google
62
+ * receipt validation.
63
+ */
64
+ AppPackageID?: string;
65
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
66
+ CustomTags?: Record<string, string | null>;
67
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
68
+ Entity?: EntityKey;
69
+ /** If an error should be returned if the addon already exists. */
70
+ ErrorIfExists?: boolean;
71
+ /**
72
+ * Google OAuth Client ID obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
73
+ * Required if using Google Authentication.
74
+ */
75
+ OAuthClientID?: string;
76
+ /**
77
+ * Google OAuth Client Secret obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
78
+ * Required if using Google Authentication.
79
+ */
80
+ OAuthClientSecret?: string;
81
+ /**
82
+ * Authorized Redirect Uri obtained through the Google Developer Console. This currently defaults to
83
+ * https://oauth.playfab.com/oauth2/google. If you are authenticating players via browser, please update this to your own
84
+ * domain.
85
+ */
86
+ OAuthCustomRedirectUri?: string;
87
+ /** Needed to enable pending purchase handling and subscription processing. */
88
+ ServiceAccountKey?: string;
89
+ }
90
+ interface CreateOrUpdateGoogleResponse extends IPlayFabResultCommon {
91
+ }
92
+ interface CreateOrUpdateKongregateRequest extends IPlayFabRequestCommon {
93
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
94
+ CustomTags?: Record<string, string | null>;
95
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
96
+ Entity?: EntityKey;
97
+ /** If an error should be returned if the addon already exists. */
98
+ ErrorIfExists?: boolean;
99
+ /** Kongregate Secret API Key obtained after setting up your game in your Kongregate developer account. */
100
+ SecretAPIKey: string;
101
+ }
102
+ interface CreateOrUpdateKongregateResponse extends IPlayFabResultCommon {
103
+ }
104
+ interface CreateOrUpdateNintendoRequest extends IPlayFabRequestCommon {
105
+ /** Nintendo Switch Application ID, without the "0x" prefix. */
106
+ ApplicationID?: string;
107
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
108
+ CustomTags?: Record<string, string | null>;
109
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
110
+ Entity?: EntityKey;
111
+ /** List of Nintendo Environments, currently supporting up to 4. Needs Catalog enabled. */
112
+ Environments?: NintendoEnvironment[];
113
+ /** If an error should be returned if the addon already exists. */
114
+ ErrorIfExists?: boolean;
115
+ }
116
+ interface CreateOrUpdateNintendoResponse extends IPlayFabResultCommon {
117
+ }
118
+ interface CreateOrUpdatePSNRequest extends IPlayFabRequestCommon {
119
+ /** Client ID obtained after setting up your game with Sony. This one is associated with the existing PS4 marketplace. */
120
+ ClientID?: string;
121
+ /** Client secret obtained after setting up your game with Sony. This one is associated with the existing PS4 marketplace. */
122
+ ClientSecret?: string;
123
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
124
+ CustomTags?: Record<string, string | null>;
125
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
126
+ Entity?: EntityKey;
127
+ /** If an error should be returned if the addon already exists. */
128
+ ErrorIfExists?: boolean;
129
+ /**
130
+ * Client ID obtained after setting up your game with Sony. This one is associated with the modern marketplace, which
131
+ * includes PS5, cross-generation for PS4, and unified entitlements.
132
+ */
133
+ NextGenClientID?: string;
134
+ /**
135
+ * Client secret obtained after setting up your game with Sony. This one is associated with the modern marketplace, which
136
+ * includes PS5, cross-generation for PS4, and unified entitlements.
137
+ */
138
+ NextGenClientSecret?: string;
139
+ }
140
+ interface CreateOrUpdatePSNResponse extends IPlayFabResultCommon {
141
+ }
142
+ interface CreateOrUpdateSteamRequest extends IPlayFabRequestCommon {
143
+ /** Application ID obtained after setting up your app in Valve's developer portal. */
144
+ ApplicationId: string;
145
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
146
+ CustomTags?: Record<string, string | null>;
147
+ /** Enforce usage of AzurePlayFab identity in user authentication tickets. */
148
+ EnforceServiceSpecificTickets?: boolean;
149
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
150
+ Entity?: EntityKey;
151
+ /** If an error should be returned if the addon already exists. */
152
+ ErrorIfExists?: boolean;
153
+ /** Sercet Key obtained after setting up your app in Valve's developer portal. */
154
+ SecretKey: string;
155
+ /** Use Steam Payments sandbox endpoint for test transactions. */
156
+ UseSandbox?: boolean;
157
+ }
158
+ interface CreateOrUpdateSteamResponse extends IPlayFabResultCommon {
159
+ }
160
+ interface CreateOrUpdateToxModRequest extends IPlayFabRequestCommon {
161
+ /** Account ID obtained after creating your ToxMod developer account. */
162
+ AccountId: string;
163
+ /** Account Key obtained after creating your ToxMod developer account. */
164
+ AccountKey: string;
165
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
166
+ CustomTags?: Record<string, string | null>;
167
+ /** Whether ToxMod Addon is Enabled by Title. */
168
+ Enabled: boolean;
169
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
170
+ Entity?: EntityKey;
171
+ /** If an error should be returned if the addon already exists. */
172
+ ErrorIfExists?: boolean;
173
+ }
174
+ interface CreateOrUpdateToxModResponse extends IPlayFabResultCommon {
175
+ }
176
+ interface CreateOrUpdateTwitchRequest extends IPlayFabRequestCommon {
177
+ /** Client ID obtained after creating your Twitch developer account. */
178
+ ClientID?: string;
179
+ /** Client Secret obtained after creating your Twitch developer account. */
180
+ ClientSecret?: string;
181
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
182
+ CustomTags?: Record<string, string | null>;
183
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
184
+ Entity?: EntityKey;
185
+ /** If an error should be returned if the addon already exists. */
186
+ ErrorIfExists?: boolean;
187
+ }
188
+ interface CreateOrUpdateTwitchResponse extends IPlayFabResultCommon {
189
+ }
190
+ interface DeleteAppleRequest extends IPlayFabRequestCommon {
191
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
192
+ CustomTags?: Record<string, string | null>;
193
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
194
+ Entity?: EntityKey;
195
+ }
196
+ interface DeleteAppleResponse extends IPlayFabResultCommon {
197
+ }
198
+ interface DeleteFacebookInstantGamesRequest extends IPlayFabRequestCommon {
199
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
200
+ CustomTags?: Record<string, string | null>;
201
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
202
+ Entity?: EntityKey;
203
+ }
204
+ interface DeleteFacebookInstantGamesResponse extends IPlayFabResultCommon {
205
+ }
206
+ interface DeleteFacebookRequest extends IPlayFabRequestCommon {
207
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
208
+ CustomTags?: Record<string, string | null>;
209
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
210
+ Entity?: EntityKey;
211
+ }
212
+ interface DeleteFacebookResponse extends IPlayFabResultCommon {
213
+ }
214
+ interface DeleteGoogleRequest extends IPlayFabRequestCommon {
215
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
216
+ CustomTags?: Record<string, string | null>;
217
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
218
+ Entity?: EntityKey;
219
+ }
220
+ interface DeleteGoogleResponse extends IPlayFabResultCommon {
221
+ }
222
+ interface DeleteKongregateRequest extends IPlayFabRequestCommon {
223
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
224
+ CustomTags?: Record<string, string | null>;
225
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
226
+ Entity?: EntityKey;
227
+ }
228
+ interface DeleteKongregateResponse extends IPlayFabResultCommon {
229
+ }
230
+ interface DeleteNintendoRequest extends IPlayFabRequestCommon {
231
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
232
+ CustomTags?: Record<string, string | null>;
233
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
234
+ Entity?: EntityKey;
235
+ }
236
+ interface DeleteNintendoResponse extends IPlayFabResultCommon {
237
+ }
238
+ interface DeletePSNRequest extends IPlayFabRequestCommon {
239
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
240
+ CustomTags?: Record<string, string | null>;
241
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
242
+ Entity?: EntityKey;
243
+ }
244
+ interface DeletePSNResponse extends IPlayFabResultCommon {
245
+ }
246
+ interface DeleteSteamRequest extends IPlayFabRequestCommon {
247
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
248
+ CustomTags?: Record<string, string | null>;
249
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
250
+ Entity?: EntityKey;
251
+ }
252
+ interface DeleteSteamResponse extends IPlayFabResultCommon {
253
+ }
254
+ interface DeleteToxModRequest extends IPlayFabRequestCommon {
255
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
256
+ CustomTags?: Record<string, string | null>;
257
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
258
+ Entity?: EntityKey;
259
+ }
260
+ interface DeleteToxModResponse extends IPlayFabResultCommon {
261
+ }
262
+ interface DeleteTwitchRequest extends IPlayFabRequestCommon {
263
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
264
+ CustomTags?: Record<string, string | null>;
265
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
266
+ Entity?: EntityKey;
267
+ }
268
+ interface DeleteTwitchResponse extends IPlayFabResultCommon {
269
+ }
270
+ interface EntityKey {
271
+ /** Unique ID of the entity. */
272
+ Id: string;
273
+ /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
274
+ Type?: string;
275
+ }
276
+ interface GetAppleRequest extends IPlayFabRequestCommon {
277
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
278
+ CustomTags?: Record<string, string | null>;
279
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
280
+ Entity?: EntityKey;
281
+ }
282
+ interface GetAppleResponse extends IPlayFabResultCommon {
283
+ /** iOS App Bundle ID obtained after setting up your app in the App Store. */
284
+ AppBundleId?: string;
285
+ /** Addon status. */
286
+ Created: boolean;
287
+ /** Ignore expiration date for identity tokens. */
288
+ IgnoreExpirationDate?: boolean;
289
+ /** Require secure authentication only for this app. */
290
+ RequireSecureAuthentication?: boolean;
291
+ }
292
+ interface GetFacebookInstantGamesRequest extends IPlayFabRequestCommon {
293
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
294
+ CustomTags?: Record<string, string | null>;
295
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
296
+ Entity?: EntityKey;
297
+ }
298
+ interface GetFacebookInstantGamesResponse extends IPlayFabResultCommon {
299
+ /** Facebook App ID obtained after setting up your app in Facebook Instant Games. */
300
+ AppID?: string;
301
+ /** Addon status. */
302
+ Created: boolean;
303
+ }
304
+ interface GetFacebookRequest extends IPlayFabRequestCommon {
305
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
306
+ CustomTags?: Record<string, string | null>;
307
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
308
+ Entity?: EntityKey;
309
+ }
310
+ interface GetFacebookResponse extends IPlayFabResultCommon {
311
+ /** Facebook App ID obtained after setting up your app in Facebook. */
312
+ AppID?: string;
313
+ /** Addon status. */
314
+ Created: boolean;
315
+ /** Email address for purchase dispute notifications. */
316
+ NotificationEmail?: string;
317
+ }
318
+ interface GetGoogleRequest extends IPlayFabRequestCommon {
319
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
320
+ CustomTags?: Record<string, string | null>;
321
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
322
+ Entity?: EntityKey;
323
+ }
324
+ interface GetGoogleResponse extends IPlayFabResultCommon {
325
+ /**
326
+ * Google App Package ID obtained after setting up your app in the Google Play developer portal. Required if using Google
327
+ * receipt validation.
328
+ */
329
+ AppPackageID?: string;
330
+ /** Addon status. */
331
+ Created: boolean;
332
+ /**
333
+ * Google OAuth Client ID obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
334
+ * Required if using Google Authentication.
335
+ */
336
+ OAuthClientID?: string;
337
+ /**
338
+ * Authorized Redirect Uri obtained through the Google Developer Console. This currently defaults to
339
+ * https://oauth.playfab.com/oauth2/google. If you are authenticating players via browser, please update this to your own
340
+ * domain.
341
+ */
342
+ OauthCustomRedirectUri?: string;
343
+ }
344
+ interface GetKongregateRequest extends IPlayFabRequestCommon {
345
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
346
+ CustomTags?: Record<string, string | null>;
347
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
348
+ Entity?: EntityKey;
349
+ }
350
+ interface GetKongregateResponse extends IPlayFabResultCommon {
351
+ /** Addon status. */
352
+ Created: boolean;
353
+ }
354
+ interface GetNintendoRequest extends IPlayFabRequestCommon {
355
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
356
+ CustomTags?: Record<string, string | null>;
357
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
358
+ Entity?: EntityKey;
359
+ }
360
+ interface GetNintendoResponse extends IPlayFabResultCommon {
361
+ /** Nintendo Switch Application ID, without the "0x" prefix. */
362
+ ApplicationID?: string;
363
+ /** Addon status. */
364
+ Created: boolean;
365
+ /** List of Nintendo Environments, currently supporting up to 4. */
366
+ Environments?: NintendoEnvironment[];
367
+ }
368
+ interface GetPSNRequest extends IPlayFabRequestCommon {
369
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
370
+ CustomTags?: Record<string, string | null>;
371
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
372
+ Entity?: EntityKey;
373
+ }
374
+ interface GetPSNResponse extends IPlayFabResultCommon {
375
+ /** Client ID obtained after setting up your game with Sony. This one is associated with the existing PS4 marketplace. */
376
+ ClientID?: string;
377
+ /** Addon status. */
378
+ Created: boolean;
379
+ /**
380
+ * Client ID obtained after setting up your game with Sony. This one is associated with the modern marketplace, which
381
+ * includes PS5, cross-generation for PS4, and unified entitlements.
382
+ */
383
+ NextGenClientID?: string;
384
+ }
385
+ interface GetSteamRequest extends IPlayFabRequestCommon {
386
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
387
+ CustomTags?: Record<string, string | null>;
388
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
389
+ Entity?: EntityKey;
390
+ }
391
+ interface GetSteamResponse extends IPlayFabResultCommon {
392
+ /** Application ID obtained after setting up your game in Valve's developer portal. */
393
+ ApplicationId?: string;
394
+ /** Addon status. */
395
+ Created: boolean;
396
+ /** Enforce usage of AzurePlayFab identity in user authentication tickets. */
397
+ EnforceServiceSpecificTickets?: boolean;
398
+ /** Use Steam Payments sandbox endpoint for test transactions. */
399
+ UseSandbox?: boolean;
400
+ }
401
+ interface GetToxModRequest extends IPlayFabRequestCommon {
402
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
403
+ CustomTags?: Record<string, string | null>;
404
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
405
+ Entity?: EntityKey;
406
+ }
407
+ interface GetToxModResponse extends IPlayFabResultCommon {
408
+ /** Account ID obtained after creating your Twitch developer account. */
409
+ AccountId?: string;
410
+ /** Account Key obtained after creating your Twitch developer account. */
411
+ AccountKey?: string;
412
+ /** Addon status. */
413
+ Created: boolean;
414
+ /** Whether the ToxMod Addon is enabled by the title. */
415
+ Enabled: boolean;
416
+ }
417
+ interface GetTwitchRequest extends IPlayFabRequestCommon {
418
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
419
+ CustomTags?: Record<string, string | null>;
420
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
421
+ Entity?: EntityKey;
422
+ }
423
+ interface GetTwitchResponse extends IPlayFabResultCommon {
424
+ /** Client ID obtained after creating your Twitch developer account. */
425
+ ClientID?: string;
426
+ /** Addon status. */
427
+ Created: boolean;
428
+ }
429
+ interface NintendoEnvironment {
430
+ /** Client ID for the Nintendo Environment. */
431
+ ClientID?: string;
432
+ /** Client Secret for the Nintendo Environment. */
433
+ ClientSecret?: string;
434
+ /** ID for the Nintendo Environment. */
435
+ ID?: string;
436
+ }
437
+
438
+ declare class PlayFabAddonApi extends PlayFabCommon {
439
+ /**
440
+ * Creates the Apple addon on a title, or updates it if it already exists.
441
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdateapple
442
+ */
443
+ CreateOrUpdateApple(request: CreateOrUpdateAppleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateAppleResponse>;
444
+ /**
445
+ * Creates the Facebook addon on a title, or updates it if it already exists.
446
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatefacebook
447
+ */
448
+ CreateOrUpdateFacebook(request: CreateOrUpdateFacebookRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateFacebookResponse>;
449
+ /**
450
+ * Creates the Facebook Instant Games addon on a title, or updates it if it already exists.
451
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatefacebookinstantgames
452
+ */
453
+ CreateOrUpdateFacebookInstantGames(request: CreateOrUpdateFacebookInstantGamesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateFacebookInstantGamesResponse>;
454
+ /**
455
+ * Creates the Google addon on a title, or updates it if it already exists.
456
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdategoogle
457
+ */
458
+ CreateOrUpdateGoogle(request: CreateOrUpdateGoogleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateGoogleResponse>;
459
+ /**
460
+ * Creates the Kongregate addon on a title, or updates it if it already exists.
461
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatekongregate
462
+ */
463
+ CreateOrUpdateKongregate(request: CreateOrUpdateKongregateRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateKongregateResponse>;
464
+ /**
465
+ * Creates the Nintendo addon on a title, or updates it if it already exists.
466
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatenintendo
467
+ */
468
+ CreateOrUpdateNintendo(request: CreateOrUpdateNintendoRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateNintendoResponse>;
469
+ /**
470
+ * Creates the PSN addon on a title, or updates it if it already exists.
471
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatepsn
472
+ */
473
+ CreateOrUpdatePSN(request: CreateOrUpdatePSNRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateOrUpdatePSNResponse>;
474
+ /**
475
+ * Creates the Steam addon on a title, or updates it if it already exists.
476
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatesteam
477
+ */
478
+ CreateOrUpdateSteam(request: CreateOrUpdateSteamRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateSteamResponse>;
479
+ /**
480
+ * Creates the ToxMod addon on a title, or updates it if it already exists.
481
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatetoxmod
482
+ */
483
+ CreateOrUpdateToxMod(request: CreateOrUpdateToxModRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateToxModResponse>;
484
+ /**
485
+ * Creates the Twitch addon on a title, or updates it if it already exists.
486
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatetwitch
487
+ */
488
+ CreateOrUpdateTwitch(request: CreateOrUpdateTwitchRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateTwitchResponse>;
489
+ /**
490
+ * Deletes the Apple addon on a title.
491
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/deleteapple
492
+ */
493
+ DeleteApple(request: DeleteAppleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteAppleResponse>;
494
+ /**
495
+ * Deletes the Facebook addon on a title.
496
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebook
497
+ */
498
+ DeleteFacebook(request: DeleteFacebookRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteFacebookResponse>;
499
+ /**
500
+ * Deletes the Facebook addon on a title.
501
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebookinstantgames
502
+ */
503
+ DeleteFacebookInstantGames(request: DeleteFacebookInstantGamesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteFacebookInstantGamesResponse>;
504
+ /**
505
+ * Deletes the Google addon on a title.
506
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletegoogle
507
+ */
508
+ DeleteGoogle(request: DeleteGoogleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteGoogleResponse>;
509
+ /**
510
+ * Deletes the Kongregate addon on a title.
511
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletekongregate
512
+ */
513
+ DeleteKongregate(request: DeleteKongregateRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteKongregateResponse>;
514
+ /**
515
+ * Deletes the Nintendo addon on a title.
516
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletenintendo
517
+ */
518
+ DeleteNintendo(request: DeleteNintendoRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteNintendoResponse>;
519
+ /**
520
+ * Deletes the PSN addon on a title.
521
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletepsn
522
+ */
523
+ DeletePSN(request: DeletePSNRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeletePSNResponse>;
524
+ /**
525
+ * Deletes the Steam addon on a title.
526
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletesteam
527
+ */
528
+ DeleteSteam(request: DeleteSteamRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteSteamResponse>;
529
+ /**
530
+ * Deletes the ToxMod addon on a title.
531
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetoxmod
532
+ */
533
+ DeleteToxMod(request: DeleteToxModRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteToxModResponse>;
534
+ /**
535
+ * Deletes the Twitch addon on a title.
536
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetwitch
537
+ */
538
+ DeleteTwitch(request: DeleteTwitchRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteTwitchResponse>;
539
+ /**
540
+ * Gets information of the Apple addon on a title, omits secrets.
541
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/getapple
542
+ */
543
+ GetApple(request: GetAppleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetAppleResponse>;
544
+ /**
545
+ * Gets information of the Facebook addon on a title, omits secrets.
546
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebook
547
+ */
548
+ GetFacebook(request: GetFacebookRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetFacebookResponse>;
549
+ /**
550
+ * Gets information of the Facebook Instant Games addon on a title, omits secrets.
551
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebookinstantgames
552
+ */
553
+ GetFacebookInstantGames(request: GetFacebookInstantGamesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetFacebookInstantGamesResponse>;
554
+ /**
555
+ * Gets information of the Google addon on a title, omits secrets.
556
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/getgoogle
557
+ */
558
+ GetGoogle(request: GetGoogleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetGoogleResponse>;
559
+ /**
560
+ * Gets information of the Kongregate addon on a title, omits secrets.
561
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/getkongregate
562
+ */
563
+ GetKongregate(request: GetKongregateRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetKongregateResponse>;
564
+ /**
565
+ * Gets information of the Nintendo addon on a title, omits secrets.
566
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/getnintendo
567
+ */
568
+ GetNintendo(request: GetNintendoRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetNintendoResponse>;
569
+ /**
570
+ * Gets information of the PSN addon on a title, omits secrets.
571
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/getpsn
572
+ */
573
+ GetPSN(request: GetPSNRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPSNResponse>;
574
+ /**
575
+ * Gets information of the Steam addon on a title, omits secrets.
576
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/getsteam
577
+ */
578
+ GetSteam(request: GetSteamRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetSteamResponse>;
579
+ /**
580
+ * Gets information of the ToxMod addon on a title, omits secrets.
581
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/gettoxmod
582
+ */
583
+ GetToxMod(request: GetToxModRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetToxModResponse>;
584
+ /**
585
+ * Gets information of the Twitch addon on a title, omits secrets.
586
+ * https://docs.microsoft.com/rest/api/playfab/addon/addon/gettwitch
587
+ */
588
+ GetTwitch(request: GetTwitchRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTwitchResponse>;
589
+ }
590
+
591
+ export { PlayFabAddonApi as default };