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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. package/dist/Addon.d.ts +178 -38
  2. package/dist/Addon.js +2 -2
  3. package/dist/Admin.d.ts +2385 -194
  4. package/dist/Admin.js +2 -2
  5. package/dist/Authentication.d.ts +31 -4
  6. package/dist/Authentication.js +2 -2
  7. package/dist/Client.d.ts +2234 -320
  8. package/dist/Client.js +2 -2
  9. package/dist/CloudScript.d.ts +198 -30
  10. package/dist/CloudScript.js +2 -2
  11. package/dist/Data.d.ts +136 -17
  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 +199 -12
  16. package/dist/Events.js +2 -2
  17. package/dist/Experimentation.d.ts +163 -16
  18. package/dist/Experimentation.js +2 -2
  19. package/dist/Groups.d.ts +266 -27
  20. package/dist/Groups.js +2 -2
  21. package/dist/Insights.d.ts +32 -6
  22. package/dist/Insights.js +2 -2
  23. package/dist/Localization.d.ts +4 -1
  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 +2696 -168
  29. package/dist/Multiplayer.js +2 -2
  30. package/dist/Profiles.d.ts +162 -18
  31. package/dist/Profiles.js +2 -2
  32. package/dist/Progression.d.ts +286 -34
  33. package/dist/Progression.js +2 -2
  34. package/dist/Server.d.ts +1903 -241
  35. package/dist/Server.js +2 -2
  36. package/dist/chunk-3I6ONUUQ.js +237 -0
  37. package/dist/chunk-3I6ONUUQ.js.map +1 -0
  38. package/dist/chunk-3O5QT4SL.js +2477 -0
  39. package/dist/chunk-3O5QT4SL.js.map +1 -0
  40. package/dist/chunk-3OBHYLBF.js +2673 -0
  41. package/dist/chunk-3OBHYLBF.js.map +1 -0
  42. package/dist/chunk-57KYHGBO.js +421 -0
  43. package/dist/chunk-57KYHGBO.js.map +1 -0
  44. package/dist/{chunk-CLMINF57.js → chunk-5CWZN75H.js} +6 -3
  45. package/dist/chunk-5CWZN75H.js.map +1 -0
  46. package/dist/chunk-73SVDH45.js +197 -0
  47. package/dist/chunk-73SVDH45.js.map +1 -0
  48. package/dist/chunk-ADHTNFTN.js +175 -0
  49. package/dist/chunk-ADHTNFTN.js.map +1 -0
  50. package/dist/chunk-C7U2JQNZ.js +76 -0
  51. package/dist/chunk-C7U2JQNZ.js.map +1 -0
  52. package/dist/{chunk-PXPOK2QU.js → chunk-GAZYZIK2.js} +34 -8
  53. package/dist/chunk-GAZYZIK2.js.map +1 -0
  54. package/dist/chunk-J54WY4UN.js +413 -0
  55. package/dist/chunk-J54WY4UN.js.map +1 -0
  56. package/dist/chunk-NFWQ4MMZ.js +1048 -0
  57. package/dist/chunk-NFWQ4MMZ.js.map +1 -0
  58. package/dist/{chunk-7UQYMDJQ.js → chunk-P7UVG26J.js} +167 -32
  59. package/dist/chunk-P7UVG26J.js.map +1 -0
  60. package/dist/chunk-PFXZB4UN.js +2387 -0
  61. package/dist/chunk-PFXZB4UN.js.map +1 -0
  62. package/dist/{chunk-RJPMKD7P.js → chunk-QNGQW3YB.js} +28 -6
  63. package/dist/chunk-QNGQW3YB.js.map +1 -0
  64. package/dist/chunk-SQWILU5T.js +270 -0
  65. package/dist/chunk-SQWILU5T.js.map +1 -0
  66. package/dist/{chunk-FEEE3PRD.js → chunk-SR2RIRLX.js} +1482 -175
  67. package/dist/chunk-SR2RIRLX.js.map +1 -0
  68. package/dist/{chunk-6TH6EJYH.js → chunk-XVDYM74A.js} +4 -4
  69. package/dist/chunk-XVDYM74A.js.map +1 -0
  70. package/dist/chunk-ZW4TJ3MQ.js +225 -0
  71. package/dist/chunk-ZW4TJ3MQ.js.map +1 -0
  72. package/dist/index.d.ts +6 -5
  73. package/dist/index.js +29 -25
  74. package/package.json +2 -2
  75. package/dist/chunk-2IBLMNAQ.js +0 -882
  76. package/dist/chunk-2IBLMNAQ.js.map +0 -1
  77. package/dist/chunk-3TRLETD6.js +0 -119
  78. package/dist/chunk-3TRLETD6.js.map +0 -1
  79. package/dist/chunk-4LT3OUQD.js +0 -632
  80. package/dist/chunk-4LT3OUQD.js.map +0 -1
  81. package/dist/chunk-6TH6EJYH.js.map +0 -1
  82. package/dist/chunk-7UQYMDJQ.js.map +0 -1
  83. package/dist/chunk-CLMINF57.js.map +0 -1
  84. package/dist/chunk-F5NRBD4O.js +0 -174
  85. package/dist/chunk-F5NRBD4O.js.map +0 -1
  86. package/dist/chunk-FEEE3PRD.js.map +0 -1
  87. package/dist/chunk-HKZJ4H4O.js +0 -97
  88. package/dist/chunk-HKZJ4H4O.js.map +0 -1
  89. package/dist/chunk-NJQCK4TL.js +0 -61
  90. package/dist/chunk-NJQCK4TL.js.map +0 -1
  91. package/dist/chunk-ONCBQLGS.js +0 -1147
  92. package/dist/chunk-ONCBQLGS.js.map +0 -1
  93. package/dist/chunk-PXPOK2QU.js.map +0 -1
  94. package/dist/chunk-Q22JHX4G.js +0 -76
  95. package/dist/chunk-Q22JHX4G.js.map +0 -1
  96. package/dist/chunk-RJPMKD7P.js.map +0 -1
  97. package/dist/chunk-WROXLFDZ.js +0 -103
  98. package/dist/chunk-WROXLFDZ.js.map +0 -1
  99. package/dist/chunk-XAI5IWL4.js +0 -187
  100. package/dist/chunk-XAI5IWL4.js.map +0 -1
  101. package/dist/chunk-XM26BUTO.js +0 -384
  102. package/dist/chunk-XM26BUTO.js.map +0 -1
package/dist/Groups.d.ts CHANGED
@@ -107,7 +107,7 @@ interface CreateGroupRoleRequest extends IPlayFabRequestCommon {
107
107
  Group: EntityKey;
108
108
  /**
109
109
  * The ID of the role. This must be unique within the group and cannot be changed. Role IDs must be between 1 and 64
110
- * characters long and are restricted to a-Z, A-Z, 0-9, '(', ')', '_', '-' and '.'.
110
+ * characters long and are restricted to a-Z, A-Z, 0-9, '(', ')', '_', '-' and '.'.
111
111
  */
112
112
  RoleId: string;
113
113
  /**
@@ -143,6 +143,11 @@ interface EntityKey {
143
143
  Id: string;
144
144
  /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
145
145
  Type?: string;
146
+ /**
147
+ * Alternate name for Type.
148
+ * @deprecated Please use Type instead.
149
+ */
150
+ TypeString?: string;
146
151
  }
147
152
  interface EntityMemberRole {
148
153
  /** The list of members in the role */
@@ -234,7 +239,7 @@ interface InviteToGroupRequest extends IPlayFabRequestCommon {
234
239
  /** The identifier of the group */
235
240
  Group: EntityKey;
236
241
  /**
237
- * Optional. ID of an existing a role in the group to assign the user to. The group's default member role is used if this
242
+ * Optional. ID of an existing a role in the group to assign the user to. The group's default member role is used if this
238
243
  * is not specified. Role IDs must be between 1 and 64 characters long.
239
244
  */
240
245
  RoleId?: string;
@@ -418,127 +423,361 @@ interface UpdateGroupRoleResponse extends IPlayFabResultCommon {
418
423
  declare class PlayFabGroupsApi extends PlayFabCommon {
419
424
  /**
420
425
  * Accepts an outstanding invitation to to join a group
421
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/acceptgroupapplication
426
+ *
427
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/acceptgroupapplication Microsoft Documentation}
428
+ * @example
429
+ * await groupClient.AcceptGroupApplication({
430
+ * "Group": {
431
+ * "Id": "ABC1234ABC"
432
+ * },
433
+ * "Entity": {
434
+ * "Id": "90901000",
435
+ * "Type": "title_player_account",
436
+ * "TypeString": "title_player_account"
437
+ * }
438
+ * });
422
439
  */
423
440
  AcceptGroupApplication(request: AcceptGroupApplicationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
424
441
  /**
425
442
  * Accepts an invitation to join a group
426
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/acceptgroupinvitation
443
+ *
444
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/acceptgroupinvitation Microsoft Documentation}
445
+ * @example
446
+ * await groupClient.AcceptGroupInvitation({
447
+ * "Group": {
448
+ * "Id": "ABC1234ABC"
449
+ * }
450
+ * });
427
451
  */
428
452
  AcceptGroupInvitation(request: AcceptGroupInvitationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
429
453
  /**
430
454
  * Adds members to a group or role.
431
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/addmembers
455
+ *
456
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/addmembers Microsoft Documentation}
457
+ * @example
458
+ * await groupClient.AddMembers({
459
+ * "Group": {
460
+ * "Id": "ABC1234ABC"
461
+ * },
462
+ * "Members": [
463
+ * {
464
+ * "Id": "90901000",
465
+ * "Type": "title_player_account",
466
+ * "TypeString": "title_player_account"
467
+ * }
468
+ * ]
469
+ * });
432
470
  */
433
471
  AddMembers(request: AddMembersRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
434
472
  /**
435
473
  * Applies to join a group
436
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/applytogroup
474
+ *
475
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/applytogroup Microsoft Documentation}
476
+ * @example
477
+ * await groupClient.ApplyToGroup({
478
+ * "Group": {
479
+ * "Id": "ABC1234ABC"
480
+ * }
481
+ * });
437
482
  */
438
483
  ApplyToGroup(request: ApplyToGroupRequest, extraHeaders?: Record<string, string>): Promise<ApplyToGroupResponse>;
439
484
  /**
440
485
  * Blocks a list of entities from joining a group.
441
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/blockentity
486
+ *
487
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/blockentity Microsoft Documentation}
488
+ * @example
489
+ * await groupClient.BlockEntity({
490
+ * "Group": {
491
+ * "Id": "ABC1234ABC"
492
+ * },
493
+ * "Entity": {
494
+ * "Id": "90901000",
495
+ * "Type": "title_player_account",
496
+ * "TypeString": "title_player_account"
497
+ * }
498
+ * });
442
499
  */
443
500
  BlockEntity(request: BlockEntityRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
444
501
  /**
445
502
  * Changes the role membership of a list of entities from one role to another.
446
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/changememberrole
503
+ *
504
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/changememberrole Microsoft Documentation}
505
+ * @example
506
+ * await groupClient.ChangeMemberRole({
507
+ * "Group": {
508
+ * "Id": "ABC1234ABC"
509
+ * },
510
+ * "OriginRoleId": "awesomepeople",
511
+ * "DestinationRoleId": "members",
512
+ * "Members": [
513
+ * {
514
+ * "Id": "90901000",
515
+ * "Type": "title_player_account",
516
+ * "TypeString": "title_player_account"
517
+ * }
518
+ * ]
519
+ * });
447
520
  */
448
521
  ChangeMemberRole(request: ChangeMemberRoleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
449
522
  /**
450
523
  * Creates a new group.
451
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/creategroup
524
+ *
525
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/creategroup Microsoft Documentation}
526
+ * @example
527
+ * await groupClient.CreateGroup({
528
+ * "GroupName": "Example Group"
529
+ * });
452
530
  */
453
531
  CreateGroup(request: CreateGroupRequest, extraHeaders?: Record<string, string>): Promise<CreateGroupResponse>;
454
532
  /**
455
533
  * Creates a new group role.
456
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/createrole
534
+ *
535
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/createrole Microsoft Documentation}
536
+ * @example
537
+ * await groupClient.CreateRole({
538
+ * "RoleId": "example",
539
+ * "RoleName": "Example Role",
540
+ * "Group": {
541
+ * "Id": "ABC1234ABC"
542
+ * }
543
+ * });
457
544
  */
458
545
  CreateRole(request: CreateGroupRoleRequest, extraHeaders?: Record<string, string>): Promise<CreateGroupRoleResponse>;
459
546
  /**
460
547
  * Deletes a group and all roles, invitations, join requests, and blocks associated with it.
461
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/deletegroup
548
+ *
549
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/deletegroup Microsoft Documentation}
550
+ * @example
551
+ * await groupClient.DeleteGroup({
552
+ * "Group": {
553
+ * "Id": "ABC1234ABC"
554
+ * }
555
+ * });
462
556
  */
463
557
  DeleteGroup(request: DeleteGroupRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
464
558
  /**
465
559
  * Deletes an existing role in a group.
466
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/deleterole
560
+ *
561
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/deleterole Microsoft Documentation}
562
+ * @example
563
+ * await groupClient.DeleteRole({
564
+ * "Group": {
565
+ * "Id": "ABC1234ABC"
566
+ * },
567
+ * "RoleId": "ABC1234DEF"
568
+ * });
467
569
  */
468
570
  DeleteRole(request: DeleteRoleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
469
571
  /**
470
572
  * Gets information about a group and its roles
471
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/getgroup
573
+ *
574
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/getgroup Microsoft Documentation}
575
+ * @example
576
+ * await groupClient.GetGroup({
577
+ * "Group": {
578
+ * "Id": "ABC1234ABC"
579
+ * }
580
+ * });
472
581
  */
473
582
  GetGroup(request: GetGroupRequest, extraHeaders?: Record<string, string>): Promise<GetGroupResponse>;
474
583
  /**
475
584
  * Invites a player to join a group
476
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/invitetogroup
585
+ *
586
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/invitetogroup Microsoft Documentation}
587
+ * @example
588
+ * await groupClient.InviteToGroup({
589
+ * "Group": {
590
+ * "Id": "ABC1234ABC"
591
+ * },
592
+ * "RoleId": "awesomepeople",
593
+ * "Entity": {
594
+ * "Id": "90901000",
595
+ * "Type": "title_player_account",
596
+ * "TypeString": "title_player_account"
597
+ * }
598
+ * });
477
599
  */
478
600
  InviteToGroup(request: InviteToGroupRequest, extraHeaders?: Record<string, string>): Promise<InviteToGroupResponse>;
479
601
  /**
480
602
  * Checks to see if an entity is a member of a group or role within the group
481
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/ismember
603
+ *
604
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/ismember Microsoft Documentation}
605
+ * @example
606
+ * await groupClient.IsMember({
607
+ * "Group": {
608
+ * "Id": "ABC1234ABC"
609
+ * },
610
+ * "RoleId": "ABC1234DEF",
611
+ * "Entity": {
612
+ * "Id": "90901000",
613
+ * "Type": "title_player_account",
614
+ * "TypeString": "title_player_account"
615
+ * }
616
+ * });
482
617
  */
483
618
  IsMember(request: IsMemberRequest, extraHeaders?: Record<string, string>): Promise<IsMemberResponse>;
484
619
  /**
485
620
  * Lists all outstanding requests to join a group
486
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupapplications
621
+ *
622
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupapplications Microsoft Documentation}
623
+ * @example
624
+ * await groupClient.ListGroupApplications({
625
+ * "Group": {
626
+ * "Id": "ABC1234ABC"
627
+ * }
628
+ * });
487
629
  */
488
630
  ListGroupApplications(request: ListGroupApplicationsRequest, extraHeaders?: Record<string, string>): Promise<ListGroupApplicationsResponse>;
489
631
  /**
490
632
  * Lists all entities blocked from joining a group
491
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupblocks
633
+ *
634
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupblocks Microsoft Documentation}
635
+ * @example
636
+ * await groupClient.ListGroupBlocks({
637
+ * "Group": {
638
+ * "Id": "ABC1234ABC"
639
+ * }
640
+ * });
492
641
  */
493
642
  ListGroupBlocks(request: ListGroupBlocksRequest, extraHeaders?: Record<string, string>): Promise<ListGroupBlocksResponse>;
494
643
  /**
495
644
  * Lists all outstanding invitations for a group
496
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupinvitations
645
+ *
646
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupinvitations Microsoft Documentation}
647
+ * @example
648
+ * await groupClient.ListGroupInvitations({
649
+ * "Group": {
650
+ * "Id": "ABC1234ABC"
651
+ * }
652
+ * });
497
653
  */
498
654
  ListGroupInvitations(request: ListGroupInvitationsRequest, extraHeaders?: Record<string, string>): Promise<ListGroupInvitationsResponse>;
499
655
  /**
500
656
  * Lists all members for a group
501
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupmembers
657
+ *
658
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupmembers Microsoft Documentation}
659
+ * @example
660
+ * await groupClient.ListGroupMembers({
661
+ * "Group": {
662
+ * "Id": "ABC1234ABC"
663
+ * }
664
+ * });
502
665
  */
503
666
  ListGroupMembers(request: ListGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<ListGroupMembersResponse>;
504
667
  /**
505
668
  * Lists all groups and roles for an entity
506
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/listmembership
669
+ *
670
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listmembership Microsoft Documentation}
671
+ * @example
672
+ * await groupClient.ListMembership({});
507
673
  */
508
674
  ListMembership(request: ListMembershipRequest, extraHeaders?: Record<string, string>): Promise<ListMembershipResponse>;
509
675
  /**
510
676
  * Lists all outstanding invitations and group applications for an entity
511
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/listmembershipopportunities
677
+ *
678
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listmembershipopportunities Microsoft Documentation}
679
+ * @example
680
+ * await groupClient.ListMembershipOpportunities({});
512
681
  */
513
682
  ListMembershipOpportunities(request: ListMembershipOpportunitiesRequest, extraHeaders?: Record<string, string>): Promise<ListMembershipOpportunitiesResponse>;
514
683
  /**
515
684
  * Removes an application to join a group
516
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/removegroupapplication
685
+ *
686
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/removegroupapplication Microsoft Documentation}
687
+ * @example
688
+ * await groupClient.RemoveGroupApplication({
689
+ * "Group": {
690
+ * "Id": "ABC1234ABC"
691
+ * },
692
+ * "Entity": {
693
+ * "Id": "90901000",
694
+ * "Type": "title_player_account",
695
+ * "TypeString": "title_player_account"
696
+ * }
697
+ * });
517
698
  */
518
699
  RemoveGroupApplication(request: RemoveGroupApplicationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
519
700
  /**
520
701
  * Removes an invitation join a group
521
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/removegroupinvitation
702
+ *
703
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/removegroupinvitation Microsoft Documentation}
704
+ * @example
705
+ * await groupClient.RemoveGroupInvitation({
706
+ * "Group": {
707
+ * "Id": "ABC1234ABC"
708
+ * },
709
+ * "Entity": {
710
+ * "Id": "90901000",
711
+ * "Type": "title_player_account",
712
+ * "TypeString": "title_player_account"
713
+ * }
714
+ * });
522
715
  */
523
716
  RemoveGroupInvitation(request: RemoveGroupInvitationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
524
717
  /**
525
718
  * Removes members from a group.
526
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/removemembers
719
+ *
720
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/removemembers Microsoft Documentation}
721
+ * @example
722
+ * await groupClient.RemoveMembers({
723
+ * "Group": {
724
+ * "Id": "ABC1234ABC"
725
+ * },
726
+ * "RoleId": "ABC1234DEF",
727
+ * "Members": [
728
+ * {
729
+ * "Id": "90901000",
730
+ * "Type": "title_player_account",
731
+ * "TypeString": "title_player_account"
732
+ * }
733
+ * ]
734
+ * });
527
735
  */
528
736
  RemoveMembers(request: RemoveMembersRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
529
737
  /**
530
738
  * Unblocks a list of entities from joining a group
531
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/unblockentity
739
+ *
740
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/unblockentity Microsoft Documentation}
741
+ * @example
742
+ * await groupClient.UnblockEntity({
743
+ * "Group": {
744
+ * "Id": "ABC1234ABC"
745
+ * },
746
+ * "Entity": {
747
+ * "Id": "90901000",
748
+ * "Type": "title_player_account",
749
+ * "TypeString": "title_player_account"
750
+ * }
751
+ * });
532
752
  */
533
753
  UnblockEntity(request: UnblockEntityRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
534
754
  /**
535
755
  * Updates non-membership data about a group.
536
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/updategroup
756
+ *
757
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/updategroup Microsoft Documentation}
758
+ * @example
759
+ * await groupClient.UpdateGroup({
760
+ * "Group": {
761
+ * "Id": "ABC1234ABC"
762
+ * },
763
+ * "GroupName": "My New Group Name",
764
+ * "ExpectedProfileVersion": 17
765
+ * });
537
766
  */
538
767
  UpdateGroup(request: UpdateGroupRequest, extraHeaders?: Record<string, string>): Promise<UpdateGroupResponse>;
539
768
  /**
540
769
  * Updates metadata about a role.
541
- * https://docs.microsoft.com/rest/api/playfab/groups/groups/updaterole
770
+ *
771
+ * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/updaterole Microsoft Documentation}
772
+ * @example
773
+ * await groupClient.UpdateRole({
774
+ * "Group": {
775
+ * "Id": "ABC1234ABC"
776
+ * },
777
+ * "RoleId": "ABC1234DEF",
778
+ * "RoleName": "My New Role Name",
779
+ * "ExpectedProfileVersion": 17
780
+ * });
542
781
  */
543
782
  UpdateRole(request: UpdateGroupRoleRequest, extraHeaders?: Record<string, string>): Promise<UpdateGroupRoleResponse>;
544
783
  }
package/dist/Groups.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  PlayFabGroupsApi
3
- } from "./chunk-XAI5IWL4.js";
4
- import "./chunk-6TH6EJYH.js";
3
+ } from "./chunk-57KYHGBO.js";
4
+ import "./chunk-XVDYM74A.js";
5
5
  export {
6
6
  PlayFabGroupsApi as default
7
7
  };
@@ -107,33 +107,59 @@ declare class PlayFabInsightsApi extends PlayFabCommon {
107
107
  /**
108
108
  * Gets the current values for the Insights performance and data storage retention, list of pending operations, and the
109
109
  * performance and data storage retention limits.
110
- * https://docs.microsoft.com/rest/api/playfab/insights/analytics/getdetails
110
+ *
111
+ * {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/getdetails Microsoft Documentation}
112
+ * @example
113
+ * await insightsClient.GetDetails({});
111
114
  */
112
115
  GetDetails(request: InsightsEmptyRequest, extraHeaders?: Record<string, string>): Promise<InsightsGetDetailsResponse>;
113
116
  /**
114
117
  * Retrieves the range of allowed values for performance and data storage retention values as well as the submeter details
115
118
  * for each performance level.
116
- * https://docs.microsoft.com/rest/api/playfab/insights/analytics/getlimits
119
+ *
120
+ * {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/getlimits Microsoft Documentation}
121
+ * @example
122
+ * await insightsClient.GetLimits({});
117
123
  */
118
124
  GetLimits(request: InsightsEmptyRequest, extraHeaders?: Record<string, string>): Promise<InsightsGetLimitsResponse>;
119
125
  /**
120
126
  * Gets the status of a SetPerformance or SetStorageRetention operation.
121
- * https://docs.microsoft.com/rest/api/playfab/insights/analytics/getoperationstatus
127
+ *
128
+ * {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/getoperationstatus Microsoft Documentation}
129
+ * @example
130
+ * await insightsClient.GetOperationStatus({
131
+ * "OperationId": "3ee468c4-ad09-4bb1-bccf-209ef5abfb96"
132
+ * });
122
133
  */
123
134
  GetOperationStatus(request: InsightsGetOperationStatusRequest, extraHeaders?: Record<string, string>): Promise<InsightsGetOperationStatusResponse>;
124
135
  /**
125
136
  * Gets a list of pending SetPerformance and/or SetStorageRetention operations for the title.
126
- * https://docs.microsoft.com/rest/api/playfab/insights/analytics/getpendingoperations
137
+ *
138
+ * {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/getpendingoperations Microsoft Documentation}
139
+ * @example
140
+ * await insightsClient.GetPendingOperations({
141
+ * "OperationType": "SetPerformance"
142
+ * });
127
143
  */
128
144
  GetPendingOperations(request: InsightsGetPendingOperationsRequest, extraHeaders?: Record<string, string>): Promise<InsightsGetPendingOperationsResponse>;
129
145
  /**
130
146
  * Sets the Insights performance level value for the title.
131
- * https://docs.microsoft.com/rest/api/playfab/insights/analytics/setperformance
147
+ *
148
+ * {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/setperformance Microsoft Documentation}
149
+ * @example
150
+ * await insightsClient.SetPerformance({
151
+ * "PerformanceLevel": 3
152
+ * });
132
153
  */
133
154
  SetPerformance(request: InsightsSetPerformanceRequest, extraHeaders?: Record<string, string>): Promise<InsightsOperationResponse>;
134
155
  /**
135
156
  * Sets the Insights data storage retention days value for the title.
136
- * https://docs.microsoft.com/rest/api/playfab/insights/analytics/setstorageretention
157
+ *
158
+ * {@link https://docs.microsoft.com/rest/api/playfab/insights/analytics/setstorageretention Microsoft Documentation}
159
+ * @example
160
+ * await insightsClient.SetStorageRetention({
161
+ * "RetentionDays": 30
162
+ * });
137
163
  */
138
164
  SetStorageRetention(request: InsightsSetStorageRetentionRequest, extraHeaders?: Record<string, string>): Promise<InsightsOperationResponse>;
139
165
  }
package/dist/Insights.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  PlayFabInsightsApi
3
- } from "./chunk-PXPOK2QU.js";
4
- import "./chunk-6TH6EJYH.js";
3
+ } from "./chunk-GAZYZIK2.js";
4
+ import "./chunk-XVDYM74A.js";
5
5
  export {
6
6
  PlayFabInsightsApi as default
7
7
  };
@@ -12,7 +12,10 @@ interface GetLanguageListResponse extends IPlayFabResultCommon {
12
12
  declare class PlayFabLocalizationApi extends PlayFabCommon {
13
13
  /**
14
14
  * Retrieves the list of allowed languages, only accessible by title entities
15
- * https://docs.microsoft.com/rest/api/playfab/localization/localization/getlanguagelist
15
+ *
16
+ * {@link https://docs.microsoft.com/rest/api/playfab/locale/localization/getlanguagelist Microsoft Documentation}
17
+ * @example
18
+ * await localeClient.GetLanguageList({});
16
19
  */
17
20
  GetLanguageList(request: GetLanguageListRequest, extraHeaders?: Record<string, string>): Promise<GetLanguageListResponse>;
18
21
  }
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  PlayFabLocalizationApi
3
- } from "./chunk-CLMINF57.js";
4
- import "./chunk-6TH6EJYH.js";
3
+ } from "./chunk-5CWZN75H.js";
4
+ import "./chunk-XVDYM74A.js";
5
5
  export {
6
6
  PlayFabLocalizationApi as default
7
7
  };