@community-fabs/playfab-web-sdk 1.193.250606-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 (94) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +32 -0
  3. package/dist/Addon.d.ts +731 -0
  4. package/dist/Addon.js +8 -0
  5. package/dist/Addon.js.map +1 -0
  6. package/dist/Admin.d.ts +5675 -0
  7. package/dist/Admin.js +8 -0
  8. package/dist/Admin.js.map +1 -0
  9. package/dist/Authentication.d.ts +136 -0
  10. package/dist/Authentication.js +8 -0
  11. package/dist/Authentication.js.map +1 -0
  12. package/dist/Client.d.ts +6398 -0
  13. package/dist/Client.js +8 -0
  14. package/dist/Client.js.map +1 -0
  15. package/dist/CloudScript.d.ts +679 -0
  16. package/dist/CloudScript.js +8 -0
  17. package/dist/CloudScript.js.map +1 -0
  18. package/dist/Data.d.ts +347 -0
  19. package/dist/Data.js +8 -0
  20. package/dist/Data.js.map +1 -0
  21. package/dist/Economy.d.ts +2910 -0
  22. package/dist/Economy.js +8 -0
  23. package/dist/Economy.js.map +1 -0
  24. package/dist/Events.d.ts +494 -0
  25. package/dist/Events.js +8 -0
  26. package/dist/Events.js.map +1 -0
  27. package/dist/Experimentation.d.ts +504 -0
  28. package/dist/Experimentation.js +8 -0
  29. package/dist/Experimentation.js.map +1 -0
  30. package/dist/Groups.d.ts +785 -0
  31. package/dist/Groups.js +8 -0
  32. package/dist/Groups.js.map +1 -0
  33. package/dist/Insights.d.ts +167 -0
  34. package/dist/Insights.js +8 -0
  35. package/dist/Insights.js.map +1 -0
  36. package/dist/Localization.d.ts +23 -0
  37. package/dist/Localization.js +8 -0
  38. package/dist/Localization.js.map +1 -0
  39. package/dist/Matchmaker.d.ts +271 -0
  40. package/dist/Matchmaker.js +8 -0
  41. package/dist/Matchmaker.js.map +1 -0
  42. package/dist/Multiplayer.d.ts +5587 -0
  43. package/dist/Multiplayer.js +8 -0
  44. package/dist/Multiplayer.js.map +1 -0
  45. package/dist/PlayFabCommon-Dnp_xHg5.d.ts +68 -0
  46. package/dist/Profiles.d.ts +422 -0
  47. package/dist/Profiles.js +8 -0
  48. package/dist/Profiles.js.map +1 -0
  49. package/dist/Progression.d.ts +862 -0
  50. package/dist/Progression.js +8 -0
  51. package/dist/Progression.js.map +1 -0
  52. package/dist/Server.d.ts +5551 -0
  53. package/dist/Server.js +8 -0
  54. package/dist/Server.js.map +1 -0
  55. package/dist/chunk-3DU2LYBT.js +2673 -0
  56. package/dist/chunk-3DU2LYBT.js.map +1 -0
  57. package/dist/chunk-6OZSERVG.js +198 -0
  58. package/dist/chunk-6OZSERVG.js.map +1 -0
  59. package/dist/chunk-BD7SF6AA.js +357 -0
  60. package/dist/chunk-BD7SF6AA.js.map +1 -0
  61. package/dist/chunk-CPJ6FMQ3.js +421 -0
  62. package/dist/chunk-CPJ6FMQ3.js.map +1 -0
  63. package/dist/chunk-IFBBLD7Q.js +2477 -0
  64. package/dist/chunk-IFBBLD7Q.js.map +1 -0
  65. package/dist/chunk-J2KKGAWN.js +2387 -0
  66. package/dist/chunk-J2KKGAWN.js.map +1 -0
  67. package/dist/chunk-K2I6VCQK.js +270 -0
  68. package/dist/chunk-K2I6VCQK.js.map +1 -0
  69. package/dist/chunk-MHSKIHSG.js +22 -0
  70. package/dist/chunk-MHSKIHSG.js.map +1 -0
  71. package/dist/chunk-MQZCB76F.js +82 -0
  72. package/dist/chunk-MQZCB76F.js.map +1 -0
  73. package/dist/chunk-OZLGFCPU.js +421 -0
  74. package/dist/chunk-OZLGFCPU.js.map +1 -0
  75. package/dist/chunk-P4FCADAY.js +175 -0
  76. package/dist/chunk-P4FCADAY.js.map +1 -0
  77. package/dist/chunk-QHQBHTHP.js +76 -0
  78. package/dist/chunk-QHQBHTHP.js.map +1 -0
  79. package/dist/chunk-QJRCYM7I.js +82 -0
  80. package/dist/chunk-QJRCYM7I.js.map +1 -0
  81. package/dist/chunk-RVBFE5D5.js +237 -0
  82. package/dist/chunk-RVBFE5D5.js.map +1 -0
  83. package/dist/chunk-SF5NNTLE.js +225 -0
  84. package/dist/chunk-SF5NNTLE.js.map +1 -0
  85. package/dist/chunk-SZJQBNVS.js +197 -0
  86. package/dist/chunk-SZJQBNVS.js.map +1 -0
  87. package/dist/chunk-WBPWV6H3.js +2970 -0
  88. package/dist/chunk-WBPWV6H3.js.map +1 -0
  89. package/dist/chunk-YI4OQ74L.js +1048 -0
  90. package/dist/chunk-YI4OQ74L.js.map +1 -0
  91. package/dist/index.d.ts +18 -0
  92. package/dist/index.js +72 -0
  93. package/dist/index.js.map +1 -0
  94. package/package.json +29 -0
@@ -0,0 +1,731 @@
1
+ import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.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 &quot;OAuth Client ID&quot;.
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 &quot;OAuth Client ID&quot;.
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 &quot;0x&quot; 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&#39;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&#39;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
+ * Alternate name for Type.
277
+ * @deprecated Please use Type instead.
278
+ */
279
+ TypeString?: string;
280
+ }
281
+ interface GetAppleRequest extends IPlayFabRequestCommon {
282
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
283
+ CustomTags?: Record<string, string | null>;
284
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
285
+ Entity?: EntityKey;
286
+ }
287
+ interface GetAppleResponse extends IPlayFabResultCommon {
288
+ /** iOS App Bundle ID obtained after setting up your app in the App Store. */
289
+ AppBundleId?: string;
290
+ /** Addon status. */
291
+ Created: boolean;
292
+ /** Ignore expiration date for identity tokens. */
293
+ IgnoreExpirationDate?: boolean;
294
+ /** Require secure authentication only for this app. */
295
+ RequireSecureAuthentication?: boolean;
296
+ }
297
+ interface GetFacebookInstantGamesRequest extends IPlayFabRequestCommon {
298
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
299
+ CustomTags?: Record<string, string | null>;
300
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
301
+ Entity?: EntityKey;
302
+ }
303
+ interface GetFacebookInstantGamesResponse extends IPlayFabResultCommon {
304
+ /** Facebook App ID obtained after setting up your app in Facebook Instant Games. */
305
+ AppID?: string;
306
+ /** Addon status. */
307
+ Created: boolean;
308
+ }
309
+ interface GetFacebookRequest extends IPlayFabRequestCommon {
310
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
311
+ CustomTags?: Record<string, string | null>;
312
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
313
+ Entity?: EntityKey;
314
+ }
315
+ interface GetFacebookResponse extends IPlayFabResultCommon {
316
+ /** Facebook App ID obtained after setting up your app in Facebook. */
317
+ AppID?: string;
318
+ /** Addon status. */
319
+ Created: boolean;
320
+ /** Email address for purchase dispute notifications. */
321
+ NotificationEmail?: string;
322
+ }
323
+ interface GetGoogleRequest extends IPlayFabRequestCommon {
324
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
325
+ CustomTags?: Record<string, string | null>;
326
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
327
+ Entity?: EntityKey;
328
+ }
329
+ interface GetGoogleResponse extends IPlayFabResultCommon {
330
+ /**
331
+ * Google App Package ID obtained after setting up your app in the Google Play developer portal. Required if using Google
332
+ * receipt validation.
333
+ */
334
+ AppPackageID?: string;
335
+ /** Addon status. */
336
+ Created: boolean;
337
+ /**
338
+ * Google OAuth Client ID obtained through the Google Developer Console by creating a new set of &quot;OAuth Client ID&quot;.
339
+ * Required if using Google Authentication.
340
+ */
341
+ OAuthClientID?: string;
342
+ /**
343
+ * Authorized Redirect Uri obtained through the Google Developer Console. This currently defaults to
344
+ * https://oauth.playfab.com/oauth2/google. If you are authenticating players via browser, please update this to your own
345
+ * domain.
346
+ */
347
+ OauthCustomRedirectUri?: string;
348
+ }
349
+ interface GetKongregateRequest extends IPlayFabRequestCommon {
350
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
351
+ CustomTags?: Record<string, string | null>;
352
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
353
+ Entity?: EntityKey;
354
+ }
355
+ interface GetKongregateResponse extends IPlayFabResultCommon {
356
+ /** Addon status. */
357
+ Created: boolean;
358
+ }
359
+ interface GetNintendoRequest extends IPlayFabRequestCommon {
360
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
361
+ CustomTags?: Record<string, string | null>;
362
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
363
+ Entity?: EntityKey;
364
+ }
365
+ interface GetNintendoResponse extends IPlayFabResultCommon {
366
+ /** Nintendo Switch Application ID, without the &quot;0x&quot; prefix. */
367
+ ApplicationID?: string;
368
+ /** Addon status. */
369
+ Created: boolean;
370
+ /** List of Nintendo Environments, currently supporting up to 4. */
371
+ Environments?: NintendoEnvironment[];
372
+ }
373
+ interface GetPSNRequest extends IPlayFabRequestCommon {
374
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
375
+ CustomTags?: Record<string, string | null>;
376
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
377
+ Entity?: EntityKey;
378
+ }
379
+ interface GetPSNResponse extends IPlayFabResultCommon {
380
+ /** Client ID obtained after setting up your game with Sony. This one is associated with the existing PS4 marketplace. */
381
+ ClientID?: string;
382
+ /** Addon status. */
383
+ Created: boolean;
384
+ /**
385
+ * Client ID obtained after setting up your game with Sony. This one is associated with the modern marketplace, which
386
+ * includes PS5, cross-generation for PS4, and unified entitlements.
387
+ */
388
+ NextGenClientID?: string;
389
+ }
390
+ interface GetSteamRequest extends IPlayFabRequestCommon {
391
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
392
+ CustomTags?: Record<string, string | null>;
393
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
394
+ Entity?: EntityKey;
395
+ }
396
+ interface GetSteamResponse extends IPlayFabResultCommon {
397
+ /** Application ID obtained after setting up your game in Valve&#39;s developer portal. */
398
+ ApplicationId?: string;
399
+ /** Addon status. */
400
+ Created: boolean;
401
+ /** Enforce usage of AzurePlayFab identity in user authentication tickets. */
402
+ EnforceServiceSpecificTickets?: boolean;
403
+ /** Use Steam Payments sandbox endpoint for test transactions. */
404
+ UseSandbox?: boolean;
405
+ }
406
+ interface GetToxModRequest extends IPlayFabRequestCommon {
407
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
408
+ CustomTags?: Record<string, string | null>;
409
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
410
+ Entity?: EntityKey;
411
+ }
412
+ interface GetToxModResponse extends IPlayFabResultCommon {
413
+ /** Account ID obtained after creating your Twitch developer account. */
414
+ AccountId?: string;
415
+ /** Account Key obtained after creating your Twitch developer account. */
416
+ AccountKey?: string;
417
+ /** Addon status. */
418
+ Created: boolean;
419
+ /** Whether the ToxMod Addon is enabled by the title. */
420
+ Enabled: boolean;
421
+ }
422
+ interface GetTwitchRequest extends IPlayFabRequestCommon {
423
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
424
+ CustomTags?: Record<string, string | null>;
425
+ /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
426
+ Entity?: EntityKey;
427
+ }
428
+ interface GetTwitchResponse extends IPlayFabResultCommon {
429
+ /** Client ID obtained after creating your Twitch developer account. */
430
+ ClientID?: string;
431
+ /** Addon status. */
432
+ Created: boolean;
433
+ }
434
+ interface NintendoEnvironment {
435
+ /** Client ID for the Nintendo Environment. */
436
+ ClientID?: string;
437
+ /** Client Secret for the Nintendo Environment. */
438
+ ClientSecret?: string;
439
+ /** ID for the Nintendo Environment. */
440
+ ID?: string;
441
+ }
442
+
443
+ declare class PlayFabAddonApi extends PlayFabCommon {
444
+ /**
445
+ * Creates the Apple addon on a title, or updates it if it already exists.
446
+ *
447
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdateapple Microsoft Documentation}
448
+ * @example
449
+ * await addonClient.CreateOrUpdateApple({
450
+ * "AppBundleId": "123456",
451
+ * "AppSharedSecret": "654321",
452
+ * "RequireSecureAuthentication": true
453
+ * });
454
+ */
455
+ CreateOrUpdateApple(request: CreateOrUpdateAppleRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateAppleResponse>;
456
+ /**
457
+ * Creates the Facebook addon on a title, or updates it if it already exists.
458
+ *
459
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatefacebook Microsoft Documentation}
460
+ * @example
461
+ * await addonClient.CreateOrUpdateFacebook({
462
+ * "AppID": "123456",
463
+ * "AppSecret": "654321",
464
+ * "NotificationEmail": "user@example.com"
465
+ * });
466
+ */
467
+ CreateOrUpdateFacebook(request: CreateOrUpdateFacebookRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateFacebookResponse>;
468
+ /**
469
+ * Creates the Facebook Instant Games addon on a title, or updates it if it already exists.
470
+ *
471
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatefacebookinstantgames Microsoft Documentation}
472
+ * @example
473
+ * await addonClient.CreateOrUpdateFacebookInstantGames({
474
+ * "AppID": "123456",
475
+ * "AppSecret": "654321"
476
+ * });
477
+ */
478
+ CreateOrUpdateFacebookInstantGames(request: CreateOrUpdateFacebookInstantGamesRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateFacebookInstantGamesResponse>;
479
+ /**
480
+ * Creates the Google addon on a title, or updates it if it already exists.
481
+ *
482
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdategoogle Microsoft Documentation}
483
+ * @example
484
+ * await addonClient.CreateOrUpdateGoogle({
485
+ * "AppPackageID": "abcdef",
486
+ * "AppLicenseKey": "fedcba",
487
+ * "OAuthClientID": "123456",
488
+ * "OAuthClientSecret": "654321",
489
+ * "OAuthCustomRedirectUri": "https://yourdomaingoeshere.com"
490
+ * });
491
+ */
492
+ CreateOrUpdateGoogle(request: CreateOrUpdateGoogleRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateGoogleResponse>;
493
+ /**
494
+ * Creates the Kongregate addon on a title, or updates it if it already exists.
495
+ *
496
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatekongregate Microsoft Documentation}
497
+ * @example
498
+ * await addonClient.CreateOrUpdateKongregate({
499
+ * "SecretAPIKey": "123456"
500
+ * });
501
+ */
502
+ CreateOrUpdateKongregate(request: CreateOrUpdateKongregateRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateKongregateResponse>;
503
+ /**
504
+ * Creates the Nintendo addon on a title, or updates it if it already exists.
505
+ *
506
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatenintendo Microsoft Documentation}
507
+ * @example
508
+ * await addonClient.CreateOrUpdateNintendo({
509
+ * "ApplicationID": "123456",
510
+ * "Environments": [
511
+ * {
512
+ * "ID": "1",
513
+ * "ClientID": "123456",
514
+ * "ClientSecret": "654321"
515
+ * }
516
+ * ]
517
+ * });
518
+ */
519
+ CreateOrUpdateNintendo(request: CreateOrUpdateNintendoRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateNintendoResponse>;
520
+ /**
521
+ * Creates the PSN addon on a title, or updates it if it already exists.
522
+ *
523
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatepsn Microsoft Documentation}
524
+ * @example
525
+ * await addonClient.CreateOrUpdatePSN({
526
+ * "ClientID": "123456",
527
+ * "ClientSecret": "abcdef",
528
+ * "NextGenClientID": "654321",
529
+ * "NextGenClientSecret": "fedcba"
530
+ * });
531
+ */
532
+ CreateOrUpdatePSN(request: CreateOrUpdatePSNRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdatePSNResponse>;
533
+ /**
534
+ * Creates the Steam addon on a title, or updates it if it already exists.
535
+ *
536
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatesteam Microsoft Documentation}
537
+ * @example
538
+ * await addonClient.CreateOrUpdateSteam({
539
+ * "ApplicationId": "123456",
540
+ * "SecretKey": "654321",
541
+ * "UseSandbox": true,
542
+ * "EnforceServiceSpecificTickets": true
543
+ * });
544
+ */
545
+ CreateOrUpdateSteam(request: CreateOrUpdateSteamRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateSteamResponse>;
546
+ /**
547
+ * Creates the ToxMod addon on a title, or updates it if it already exists.
548
+ *
549
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatetoxmod Microsoft Documentation}
550
+ * @example
551
+ * await addonClient.CreateOrUpdateToxMod({
552
+ * "Enabled": false,
553
+ * "AccountId": "123456",
554
+ * "AccountKey": "654321"
555
+ * });
556
+ */
557
+ CreateOrUpdateToxMod(request: CreateOrUpdateToxModRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateToxModResponse>;
558
+ /**
559
+ * Creates the Twitch addon on a title, or updates it if it already exists.
560
+ *
561
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatetwitch Microsoft Documentation}
562
+ * @example
563
+ * await addonClient.CreateOrUpdateTwitch({
564
+ * "ClientID": "123456",
565
+ * "ClientSecret": "654321"
566
+ * });
567
+ */
568
+ CreateOrUpdateTwitch(request: CreateOrUpdateTwitchRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateTwitchResponse>;
569
+ /**
570
+ * Deletes the Apple addon on a title.
571
+ *
572
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deleteapple Microsoft Documentation}
573
+ * @example
574
+ * await addonClient.DeleteApple({});
575
+ */
576
+ DeleteApple(request: DeleteAppleRequest, extraHeaders?: Record<string, string>): Promise<DeleteAppleResponse>;
577
+ /**
578
+ * Deletes the Facebook addon on a title.
579
+ *
580
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebook Microsoft Documentation}
581
+ * @example
582
+ * await addonClient.DeleteFacebook({});
583
+ */
584
+ DeleteFacebook(request: DeleteFacebookRequest, extraHeaders?: Record<string, string>): Promise<DeleteFacebookResponse>;
585
+ /**
586
+ * Deletes the Facebook addon on a title.
587
+ *
588
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebookinstantgames Microsoft Documentation}
589
+ * @example
590
+ * await addonClient.DeleteFacebookInstantGames({});
591
+ */
592
+ DeleteFacebookInstantGames(request: DeleteFacebookInstantGamesRequest, extraHeaders?: Record<string, string>): Promise<DeleteFacebookInstantGamesResponse>;
593
+ /**
594
+ * Deletes the Google addon on a title.
595
+ *
596
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletegoogle Microsoft Documentation}
597
+ * @example
598
+ * await addonClient.DeleteGoogle({});
599
+ */
600
+ DeleteGoogle(request: DeleteGoogleRequest, extraHeaders?: Record<string, string>): Promise<DeleteGoogleResponse>;
601
+ /**
602
+ * Deletes the Kongregate addon on a title.
603
+ *
604
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletekongregate Microsoft Documentation}
605
+ * @example
606
+ * await addonClient.DeleteKongregate({});
607
+ */
608
+ DeleteKongregate(request: DeleteKongregateRequest, extraHeaders?: Record<string, string>): Promise<DeleteKongregateResponse>;
609
+ /**
610
+ * Deletes the Nintendo addon on a title.
611
+ *
612
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletenintendo Microsoft Documentation}
613
+ * @example
614
+ * await addonClient.DeleteNintendo({});
615
+ */
616
+ DeleteNintendo(request: DeleteNintendoRequest, extraHeaders?: Record<string, string>): Promise<DeleteNintendoResponse>;
617
+ /**
618
+ * Deletes the PSN addon on a title.
619
+ *
620
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletepsn Microsoft Documentation}
621
+ * @example
622
+ * await addonClient.DeletePSN({});
623
+ */
624
+ DeletePSN(request: DeletePSNRequest, extraHeaders?: Record<string, string>): Promise<DeletePSNResponse>;
625
+ /**
626
+ * Deletes the Steam addon on a title.
627
+ *
628
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletesteam Microsoft Documentation}
629
+ * @example
630
+ * await addonClient.DeleteSteam({});
631
+ */
632
+ DeleteSteam(request: DeleteSteamRequest, extraHeaders?: Record<string, string>): Promise<DeleteSteamResponse>;
633
+ /**
634
+ * Deletes the ToxMod addon on a title.
635
+ *
636
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetoxmod Microsoft Documentation}
637
+ * @example
638
+ * await addonClient.DeleteToxMod({});
639
+ */
640
+ DeleteToxMod(request: DeleteToxModRequest, extraHeaders?: Record<string, string>): Promise<DeleteToxModResponse>;
641
+ /**
642
+ * Deletes the Twitch addon on a title.
643
+ *
644
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetwitch Microsoft Documentation}
645
+ * @example
646
+ * await addonClient.DeleteTwitch({});
647
+ */
648
+ DeleteTwitch(request: DeleteTwitchRequest, extraHeaders?: Record<string, string>): Promise<DeleteTwitchResponse>;
649
+ /**
650
+ * Gets information of the Apple addon on a title, omits secrets.
651
+ *
652
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getapple Microsoft Documentation}
653
+ * @example
654
+ * await addonClient.GetApple({});
655
+ */
656
+ GetApple(request: GetAppleRequest, extraHeaders?: Record<string, string>): Promise<GetAppleResponse>;
657
+ /**
658
+ * Gets information of the Facebook addon on a title, omits secrets.
659
+ *
660
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebook Microsoft Documentation}
661
+ * @example
662
+ * await addonClient.GetFacebook({});
663
+ */
664
+ GetFacebook(request: GetFacebookRequest, extraHeaders?: Record<string, string>): Promise<GetFacebookResponse>;
665
+ /**
666
+ * Gets information of the Facebook Instant Games addon on a title, omits secrets.
667
+ *
668
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebookinstantgames Microsoft Documentation}
669
+ * @example
670
+ * await addonClient.GetFacebookInstantGames({});
671
+ */
672
+ GetFacebookInstantGames(request: GetFacebookInstantGamesRequest, extraHeaders?: Record<string, string>): Promise<GetFacebookInstantGamesResponse>;
673
+ /**
674
+ * Gets information of the Google addon on a title, omits secrets.
675
+ *
676
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getgoogle Microsoft Documentation}
677
+ * @example
678
+ * await addonClient.GetGoogle({});
679
+ */
680
+ GetGoogle(request: GetGoogleRequest, extraHeaders?: Record<string, string>): Promise<GetGoogleResponse>;
681
+ /**
682
+ * Gets information of the Kongregate addon on a title, omits secrets.
683
+ *
684
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getkongregate Microsoft Documentation}
685
+ * @example
686
+ * await addonClient.GetKongregate({});
687
+ */
688
+ GetKongregate(request: GetKongregateRequest, extraHeaders?: Record<string, string>): Promise<GetKongregateResponse>;
689
+ /**
690
+ * Gets information of the Nintendo addon on a title, omits secrets.
691
+ *
692
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getnintendo Microsoft Documentation}
693
+ * @example
694
+ * await addonClient.GetNintendo({});
695
+ */
696
+ GetNintendo(request: GetNintendoRequest, extraHeaders?: Record<string, string>): Promise<GetNintendoResponse>;
697
+ /**
698
+ * Gets information of the PSN addon on a title, omits secrets.
699
+ *
700
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getpsn Microsoft Documentation}
701
+ * @example
702
+ * await addonClient.GetPSN({});
703
+ */
704
+ GetPSN(request: GetPSNRequest, extraHeaders?: Record<string, string>): Promise<GetPSNResponse>;
705
+ /**
706
+ * Gets information of the Steam addon on a title, omits secrets.
707
+ *
708
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getsteam Microsoft Documentation}
709
+ * @example
710
+ * await addonClient.GetSteam({});
711
+ */
712
+ GetSteam(request: GetSteamRequest, extraHeaders?: Record<string, string>): Promise<GetSteamResponse>;
713
+ /**
714
+ * Gets information of the ToxMod addon on a title, omits secrets.
715
+ *
716
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/gettoxmod Microsoft Documentation}
717
+ * @example
718
+ * await addonClient.GetToxMod({});
719
+ */
720
+ GetToxMod(request: GetToxModRequest, extraHeaders?: Record<string, string>): Promise<GetToxModResponse>;
721
+ /**
722
+ * Gets information of the Twitch addon on a title, omits secrets.
723
+ *
724
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/gettwitch Microsoft Documentation}
725
+ * @example
726
+ * await addonClient.GetTwitch({});
727
+ */
728
+ GetTwitch(request: GetTwitchRequest, extraHeaders?: Record<string, string>): Promise<GetTwitchResponse>;
729
+ }
730
+
731
+ export { PlayFabAddonApi as default };