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/Addon.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 CreateOrUpdateAppleRequest extends IPlayFabRequestCommon {
4
4
  /** iOS App Bundle ID obtained after setting up your app in the App Store. */
@@ -69,12 +69,12 @@ interface CreateOrUpdateGoogleRequest extends IPlayFabRequestCommon {
69
69
  /** If an error should be returned if the addon already exists. */
70
70
  ErrorIfExists?: boolean;
71
71
  /**
72
- * Google OAuth Client ID obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
72
+ * Google OAuth Client ID obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
73
73
  * Required if using Google Authentication.
74
74
  */
75
75
  OAuthClientID?: string;
76
76
  /**
77
- * Google OAuth Client Secret obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
77
+ * Google OAuth Client Secret obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
78
78
  * Required if using Google Authentication.
79
79
  */
80
80
  OAuthClientSecret?: string;
@@ -102,7 +102,7 @@ interface CreateOrUpdateKongregateRequest extends IPlayFabRequestCommon {
102
102
  interface CreateOrUpdateKongregateResponse extends IPlayFabResultCommon {
103
103
  }
104
104
  interface CreateOrUpdateNintendoRequest extends IPlayFabRequestCommon {
105
- /** Nintendo Switch Application ID, without the "0x" prefix. */
105
+ /** Nintendo Switch Application ID, without the "0x" prefix. */
106
106
  ApplicationID?: string;
107
107
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
108
108
  CustomTags?: Record<string, string | null>;
@@ -140,7 +140,7 @@ interface CreateOrUpdatePSNRequest extends IPlayFabRequestCommon {
140
140
  interface CreateOrUpdatePSNResponse extends IPlayFabResultCommon {
141
141
  }
142
142
  interface CreateOrUpdateSteamRequest extends IPlayFabRequestCommon {
143
- /** Application ID obtained after setting up your app in Valve's developer portal. */
143
+ /** Application ID obtained after setting up your app in Valve&#39;s developer portal. */
144
144
  ApplicationId: string;
145
145
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
146
146
  CustomTags?: Record<string, string | null>;
@@ -150,7 +150,7 @@ interface CreateOrUpdateSteamRequest extends IPlayFabRequestCommon {
150
150
  Entity?: EntityKey;
151
151
  /** If an error should be returned if the addon already exists. */
152
152
  ErrorIfExists?: boolean;
153
- /** Sercet Key obtained after setting up your app in Valve's developer portal. */
153
+ /** Sercet Key obtained after setting up your app in Valve&#39;s developer portal. */
154
154
  SecretKey: string;
155
155
  /** Use Steam Payments sandbox endpoint for test transactions. */
156
156
  UseSandbox?: boolean;
@@ -272,6 +272,11 @@ interface EntityKey {
272
272
  Id: string;
273
273
  /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
274
274
  Type?: string;
275
+ /**
276
+ * Alternate name for Type.
277
+ * @deprecated Please use Type instead.
278
+ */
279
+ TypeString?: string;
275
280
  }
276
281
  interface GetAppleRequest extends IPlayFabRequestCommon {
277
282
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
@@ -330,7 +335,7 @@ interface GetGoogleResponse extends IPlayFabResultCommon {
330
335
  /** Addon status. */
331
336
  Created: boolean;
332
337
  /**
333
- * Google OAuth Client ID obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
338
+ * Google OAuth Client ID obtained through the Google Developer Console by creating a new set of &quot;OAuth Client ID&quot;.
334
339
  * Required if using Google Authentication.
335
340
  */
336
341
  OAuthClientID?: string;
@@ -358,7 +363,7 @@ interface GetNintendoRequest extends IPlayFabRequestCommon {
358
363
  Entity?: EntityKey;
359
364
  }
360
365
  interface GetNintendoResponse extends IPlayFabResultCommon {
361
- /** Nintendo Switch Application ID, without the "0x" prefix. */
366
+ /** Nintendo Switch Application ID, without the &quot;0x&quot; prefix. */
362
367
  ApplicationID?: string;
363
368
  /** Addon status. */
364
369
  Created: boolean;
@@ -389,7 +394,7 @@ interface GetSteamRequest extends IPlayFabRequestCommon {
389
394
  Entity?: EntityKey;
390
395
  }
391
396
  interface GetSteamResponse extends IPlayFabResultCommon {
392
- /** Application ID obtained after setting up your game in Valve's developer portal. */
397
+ /** Application ID obtained after setting up your game in Valve&#39;s developer portal. */
393
398
  ApplicationId?: string;
394
399
  /** Addon status. */
395
400
  Created: boolean;
@@ -438,152 +443,287 @@ interface NintendoEnvironment {
438
443
  declare class PlayFabAddonApi extends PlayFabCommon {
439
444
  /**
440
445
  * 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
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
+ * });
442
454
  */
443
455
  CreateOrUpdateApple(request: CreateOrUpdateAppleRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateAppleResponse>;
444
456
  /**
445
457
  * 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
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
+ * });
447
466
  */
448
467
  CreateOrUpdateFacebook(request: CreateOrUpdateFacebookRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateFacebookResponse>;
449
468
  /**
450
469
  * 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
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
+ * });
452
477
  */
453
478
  CreateOrUpdateFacebookInstantGames(request: CreateOrUpdateFacebookInstantGamesRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateFacebookInstantGamesResponse>;
454
479
  /**
455
480
  * 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
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
+ * });
457
491
  */
458
492
  CreateOrUpdateGoogle(request: CreateOrUpdateGoogleRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateGoogleResponse>;
459
493
  /**
460
494
  * 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
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
+ * });
462
501
  */
463
502
  CreateOrUpdateKongregate(request: CreateOrUpdateKongregateRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateKongregateResponse>;
464
503
  /**
465
504
  * 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
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
+ * });
467
518
  */
468
519
  CreateOrUpdateNintendo(request: CreateOrUpdateNintendoRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateNintendoResponse>;
469
520
  /**
470
521
  * 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
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
+ * });
472
531
  */
473
532
  CreateOrUpdatePSN(request: CreateOrUpdatePSNRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdatePSNResponse>;
474
533
  /**
475
534
  * 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
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
+ * });
477
544
  */
478
545
  CreateOrUpdateSteam(request: CreateOrUpdateSteamRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateSteamResponse>;
479
546
  /**
480
547
  * 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
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
+ * });
482
556
  */
483
557
  CreateOrUpdateToxMod(request: CreateOrUpdateToxModRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateToxModResponse>;
484
558
  /**
485
559
  * 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
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
+ * });
487
567
  */
488
568
  CreateOrUpdateTwitch(request: CreateOrUpdateTwitchRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateTwitchResponse>;
489
569
  /**
490
570
  * Deletes the Apple addon on a title.
491
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/deleteapple
571
+ *
572
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deleteapple Microsoft Documentation}
573
+ * @example
574
+ * await addonClient.DeleteApple({});
492
575
  */
493
576
  DeleteApple(request: DeleteAppleRequest, extraHeaders?: Record<string, string>): Promise<DeleteAppleResponse>;
494
577
  /**
495
578
  * Deletes the Facebook addon on a title.
496
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebook
579
+ *
580
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebook Microsoft Documentation}
581
+ * @example
582
+ * await addonClient.DeleteFacebook({});
497
583
  */
498
584
  DeleteFacebook(request: DeleteFacebookRequest, extraHeaders?: Record<string, string>): Promise<DeleteFacebookResponse>;
499
585
  /**
500
586
  * Deletes the Facebook addon on a title.
501
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebookinstantgames
587
+ *
588
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebookinstantgames Microsoft Documentation}
589
+ * @example
590
+ * await addonClient.DeleteFacebookInstantGames({});
502
591
  */
503
592
  DeleteFacebookInstantGames(request: DeleteFacebookInstantGamesRequest, extraHeaders?: Record<string, string>): Promise<DeleteFacebookInstantGamesResponse>;
504
593
  /**
505
594
  * Deletes the Google addon on a title.
506
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletegoogle
595
+ *
596
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletegoogle Microsoft Documentation}
597
+ * @example
598
+ * await addonClient.DeleteGoogle({});
507
599
  */
508
600
  DeleteGoogle(request: DeleteGoogleRequest, extraHeaders?: Record<string, string>): Promise<DeleteGoogleResponse>;
509
601
  /**
510
602
  * Deletes the Kongregate addon on a title.
511
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletekongregate
603
+ *
604
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletekongregate Microsoft Documentation}
605
+ * @example
606
+ * await addonClient.DeleteKongregate({});
512
607
  */
513
608
  DeleteKongregate(request: DeleteKongregateRequest, extraHeaders?: Record<string, string>): Promise<DeleteKongregateResponse>;
514
609
  /**
515
610
  * Deletes the Nintendo addon on a title.
516
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletenintendo
611
+ *
612
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletenintendo Microsoft Documentation}
613
+ * @example
614
+ * await addonClient.DeleteNintendo({});
517
615
  */
518
616
  DeleteNintendo(request: DeleteNintendoRequest, extraHeaders?: Record<string, string>): Promise<DeleteNintendoResponse>;
519
617
  /**
520
618
  * Deletes the PSN addon on a title.
521
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletepsn
619
+ *
620
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletepsn Microsoft Documentation}
621
+ * @example
622
+ * await addonClient.DeletePSN({});
522
623
  */
523
624
  DeletePSN(request: DeletePSNRequest, extraHeaders?: Record<string, string>): Promise<DeletePSNResponse>;
524
625
  /**
525
626
  * Deletes the Steam addon on a title.
526
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletesteam
627
+ *
628
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletesteam Microsoft Documentation}
629
+ * @example
630
+ * await addonClient.DeleteSteam({});
527
631
  */
528
632
  DeleteSteam(request: DeleteSteamRequest, extraHeaders?: Record<string, string>): Promise<DeleteSteamResponse>;
529
633
  /**
530
634
  * Deletes the ToxMod addon on a title.
531
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetoxmod
635
+ *
636
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetoxmod Microsoft Documentation}
637
+ * @example
638
+ * await addonClient.DeleteToxMod({});
532
639
  */
533
640
  DeleteToxMod(request: DeleteToxModRequest, extraHeaders?: Record<string, string>): Promise<DeleteToxModResponse>;
534
641
  /**
535
642
  * Deletes the Twitch addon on a title.
536
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetwitch
643
+ *
644
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetwitch Microsoft Documentation}
645
+ * @example
646
+ * await addonClient.DeleteTwitch({});
537
647
  */
538
648
  DeleteTwitch(request: DeleteTwitchRequest, extraHeaders?: Record<string, string>): Promise<DeleteTwitchResponse>;
539
649
  /**
540
650
  * Gets information of the Apple addon on a title, omits secrets.
541
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/getapple
651
+ *
652
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getapple Microsoft Documentation}
653
+ * @example
654
+ * await addonClient.GetApple({});
542
655
  */
543
656
  GetApple(request: GetAppleRequest, extraHeaders?: Record<string, string>): Promise<GetAppleResponse>;
544
657
  /**
545
658
  * Gets information of the Facebook addon on a title, omits secrets.
546
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebook
659
+ *
660
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebook Microsoft Documentation}
661
+ * @example
662
+ * await addonClient.GetFacebook({});
547
663
  */
548
664
  GetFacebook(request: GetFacebookRequest, extraHeaders?: Record<string, string>): Promise<GetFacebookResponse>;
549
665
  /**
550
666
  * Gets information of the Facebook Instant Games addon on a title, omits secrets.
551
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebookinstantgames
667
+ *
668
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebookinstantgames Microsoft Documentation}
669
+ * @example
670
+ * await addonClient.GetFacebookInstantGames({});
552
671
  */
553
672
  GetFacebookInstantGames(request: GetFacebookInstantGamesRequest, extraHeaders?: Record<string, string>): Promise<GetFacebookInstantGamesResponse>;
554
673
  /**
555
674
  * Gets information of the Google addon on a title, omits secrets.
556
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/getgoogle
675
+ *
676
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getgoogle Microsoft Documentation}
677
+ * @example
678
+ * await addonClient.GetGoogle({});
557
679
  */
558
680
  GetGoogle(request: GetGoogleRequest, extraHeaders?: Record<string, string>): Promise<GetGoogleResponse>;
559
681
  /**
560
682
  * Gets information of the Kongregate addon on a title, omits secrets.
561
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/getkongregate
683
+ *
684
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getkongregate Microsoft Documentation}
685
+ * @example
686
+ * await addonClient.GetKongregate({});
562
687
  */
563
688
  GetKongregate(request: GetKongregateRequest, extraHeaders?: Record<string, string>): Promise<GetKongregateResponse>;
564
689
  /**
565
690
  * Gets information of the Nintendo addon on a title, omits secrets.
566
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/getnintendo
691
+ *
692
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getnintendo Microsoft Documentation}
693
+ * @example
694
+ * await addonClient.GetNintendo({});
567
695
  */
568
696
  GetNintendo(request: GetNintendoRequest, extraHeaders?: Record<string, string>): Promise<GetNintendoResponse>;
569
697
  /**
570
698
  * Gets information of the PSN addon on a title, omits secrets.
571
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/getpsn
699
+ *
700
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getpsn Microsoft Documentation}
701
+ * @example
702
+ * await addonClient.GetPSN({});
572
703
  */
573
704
  GetPSN(request: GetPSNRequest, extraHeaders?: Record<string, string>): Promise<GetPSNResponse>;
574
705
  /**
575
706
  * Gets information of the Steam addon on a title, omits secrets.
576
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/getsteam
707
+ *
708
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getsteam Microsoft Documentation}
709
+ * @example
710
+ * await addonClient.GetSteam({});
577
711
  */
578
712
  GetSteam(request: GetSteamRequest, extraHeaders?: Record<string, string>): Promise<GetSteamResponse>;
579
713
  /**
580
714
  * Gets information of the ToxMod addon on a title, omits secrets.
581
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/gettoxmod
715
+ *
716
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/gettoxmod Microsoft Documentation}
717
+ * @example
718
+ * await addonClient.GetToxMod({});
582
719
  */
583
720
  GetToxMod(request: GetToxModRequest, extraHeaders?: Record<string, string>): Promise<GetToxModResponse>;
584
721
  /**
585
722
  * Gets information of the Twitch addon on a title, omits secrets.
586
- * https://docs.microsoft.com/rest/api/playfab/addon/addon/gettwitch
723
+ *
724
+ * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/gettwitch Microsoft Documentation}
725
+ * @example
726
+ * await addonClient.GetTwitch({});
587
727
  */
588
728
  GetTwitch(request: GetTwitchRequest, extraHeaders?: Record<string, string>): Promise<GetTwitchResponse>;
589
729
  }
package/dist/Addon.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  PlayFabAddonApi
3
- } from "./chunk-A7VD6ALV.js";
4
- import "./chunk-62SULWOK.js";
3
+ } from "./chunk-P7UVG26J.js";
4
+ import "./chunk-XVDYM74A.js";
5
5
  export {
6
6
  PlayFabAddonApi as default
7
7
  };