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
@@ -1,23 +1,60 @@
1
1
  import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
2
2
 
3
3
  interface AssetReference {
4
- /** The asset's file name. This is a filename with the .zip, .tar, or .tar.gz extension. */
4
+ /** The asset's file name. This is a filename with the .zip, .tar, or .tar.gz extension. */
5
5
  FileName?: string;
6
- /** The asset's mount path. */
6
+ /** The asset's mount path. */
7
7
  MountPath?: string;
8
8
  }
9
9
  interface AssetReferenceParams {
10
- /** The asset's file name. */
10
+ /** The asset's file name. */
11
11
  FileName: string;
12
- /** The asset's mount path. */
12
+ /** The asset's mount path. */
13
13
  MountPath?: string;
14
14
  }
15
15
  interface AssetSummary {
16
- /** The asset's file name. This is a filename with the .zip, .tar, or .tar.gz extension. */
16
+ /** The asset's file name. This is a filename with the .zip, .tar, or .tar.gz extension. */
17
17
  FileName?: string;
18
18
  /** The metadata associated with the asset. */
19
19
  Metadata?: Record<string, string | null>;
20
20
  }
21
+ interface BatchParameters {
22
+ /**
23
+ * The initial threshold value for determining if a match result is considered anomalous enough to be ignored. If this is
24
+ * not specified and the parent model ID is specified, then the parent model&#39;s value will be used. Otherwise, a default
25
+ * value of -20 is used. Note: This was the one that was used when creating the batch model, which might differ from
26
+ * &lt;c&gt;CurrentAnomalousMatchResultIgnoreThreshold&lt;/c&gt; value.
27
+ */
28
+ AnomalousMatchResultIgnoreThreshold?: number;
29
+ /** DateTime in UTC of the end of the range of match result end times for a batch run. The specified DateTime is exclusive. */
30
+ MatchResultEndDateTime: string;
31
+ /**
32
+ * DateTime in UTC of the start of the range of match result end times for a batch run. The specified DateTime is
33
+ * inclusive.
34
+ */
35
+ MatchResultStartDateTime: string;
36
+ /** Maximum number of batch learning iterations to run. */
37
+ MaxIterations: number;
38
+ /** ID of the Model that was used as a parent of the batch run for creating this model. */
39
+ ParentModelId?: string;
40
+ }
41
+ interface BatchResults {
42
+ /**
43
+ * A dictionary containing the activity value for certain batch learning iterations. The key is the iteration number and
44
+ * the value is the activity value. The activity value is a measure of how much the model is changing. The batch learning
45
+ * algorithm will stop if the activity drops below a convergence threshold.
46
+ */
47
+ LearningActivity?: Record<string, number>;
48
+ /**
49
+ * The number of match results that were within the date range for the batch run but were ignored because they didn&#39;t have
50
+ * the required conditions or events.
51
+ */
52
+ MatchResultsIgnoredCount: number;
53
+ /** The number of match results that were processed in the batch run. */
54
+ MatchResultsUsedCount: number;
55
+ /** The total duration in seconds of the batch run. */
56
+ RunTimeInSeconds: number;
57
+ }
21
58
  interface BuildAliasDetailsResponse extends IPlayFabResultCommon {
22
59
  /** The guid string alias Id of the alias to be created or updated. */
23
60
  AliasId?: string;
@@ -25,6 +62,16 @@ interface BuildAliasDetailsResponse extends IPlayFabResultCommon {
25
62
  AliasName?: string;
26
63
  /** Array of build selection criteria. */
27
64
  BuildSelectionCriteria?: BuildSelectionCriterion[];
65
+ /**
66
+ * Deprecated - Do not use
67
+ * @deprecated Do not use
68
+ */
69
+ PageSize?: number;
70
+ /**
71
+ * Deprecated - Do not use
72
+ * @deprecated Do not use
73
+ */
74
+ SkipToken?: string;
28
75
  }
29
76
  interface BuildAliasParams {
30
77
  /** The guid string alias ID to use for the request. */
@@ -92,7 +139,7 @@ interface CancelAllMatchmakingTicketsForPlayerRequest extends IPlayFabRequestCom
92
139
  CustomTags?: Record<string, string | null>;
93
140
  /** The entity key of the player whose tickets should be canceled. */
94
141
  Entity?: EntityKey;
95
- /** The name of the queue from which a player's tickets should be canceled. */
142
+ /** The name of the queue from which a player&#39;s tickets should be canceled. */
96
143
  QueueName: string;
97
144
  }
98
145
  interface CancelAllMatchmakingTicketsForPlayerResult extends IPlayFabResultCommon {
@@ -102,7 +149,7 @@ interface CancelAllServerBackfillTicketsForPlayerRequest extends IPlayFabRequest
102
149
  CustomTags?: Record<string, string | null>;
103
150
  /** The entity key of the player whose backfill tickets should be canceled. */
104
151
  Entity: EntityKey;
105
- /** The name of the queue from which a player's backfill tickets should be canceled. */
152
+ /** The name of the queue from which a player&#39;s backfill tickets should be canceled. */
106
153
  QueueName: string;
107
154
  }
108
155
  interface CancelAllServerBackfillTicketsForPlayerResult extends IPlayFabResultCommon {
@@ -117,6 +164,16 @@ interface CancelMatchmakingTicketRequest extends IPlayFabRequestCommon {
117
164
  }
118
165
  interface CancelMatchmakingTicketResult extends IPlayFabResultCommon {
119
166
  }
167
+ interface CancelModelRequest extends IPlayFabRequestCommon {
168
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
169
+ CustomTags?: Record<string, string | null>;
170
+ /** The ID of the Model we want to cancel a batch run for. */
171
+ ModelId: string;
172
+ /** The ID of the Scenario that the requested model belongs to. */
173
+ ScenarioId: string;
174
+ }
175
+ interface CancelModelResponse extends IPlayFabResultCommon {
176
+ }
120
177
  interface CancelServerBackfillTicketRequest extends IPlayFabRequestCommon {
121
178
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
122
179
  CustomTags?: Record<string, string | null>;
@@ -144,6 +201,20 @@ interface CertificateSummary {
144
201
  /** The thumbprint for the certificate. */
145
202
  Thumbprint?: string;
146
203
  }
204
+ interface CognitiveServicesLocale {
205
+ /** Gender of the locale if available */
206
+ Gender?: string;
207
+ /** The code for supported locale */
208
+ Locale?: string;
209
+ /** Name of the locale if available */
210
+ Name?: string;
211
+ /** Short name of the locale if available */
212
+ ShortName?: string;
213
+ }
214
+ interface ConditionsSet {
215
+ /** A map from condition names to condition values in which to get the skills of the players. */
216
+ Conditions?: Record<string, string | null>;
217
+ }
147
218
  interface ConnectedPlayer {
148
219
  /** The player ID of the player connected to the multiplayer server. */
149
220
  PlayerId?: string;
@@ -172,6 +243,54 @@ interface CoreCapacityChange {
172
243
  /** Virtual machine family to change. */
173
244
  VmFamily: string;
174
245
  }
246
+ interface CreateBaseModelRequest extends IPlayFabRequestCommon {
247
+ /** A list of condition keys and their associated affinity weights for this model. */
248
+ Conditions?: ModelCondition[];
249
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
250
+ CustomTags?: Record<string, string | null>;
251
+ /** The name of the model that will be created. */
252
+ ModelName: string;
253
+ /** The ID of the scenario to create the base model. */
254
+ ScenarioId: string;
255
+ }
256
+ interface CreateBaseModelResponse extends IPlayFabResultCommon {
257
+ /** The id of the model that was created. */
258
+ ModelId?: string;
259
+ }
260
+ interface CreateBatchModelRequest extends IPlayFabRequestCommon {
261
+ /**
262
+ * The threshold value for determining if a match result is considered anomalous enough to be ignored. It must be negative.
263
+ * If this is not specified and the parent model ID is specified, then the parent model&#39;s value will be used. Otherwise, a
264
+ * default value of -20 is used. Typically, increasing it by 1 to -19 will roughly detect 3x more anomalous matches.
265
+ * Typically, decreasing it by 1 to -21 will roughly detect 3x less anomalous matches.
266
+ */
267
+ AnomalousMatchResultIgnoreThreshold?: number;
268
+ /** A list of condition keys and their associated affinity weights for this model. */
269
+ Conditions?: ModelCondition[];
270
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
271
+ CustomTags?: Record<string, string | null>;
272
+ /** A list of events used in this model. */
273
+ Events?: string[];
274
+ /**
275
+ * A model ID which is the batch run uses as a starting point for learning. If not supplied a base model is used as the
276
+ * starting point.
277
+ */
278
+ InitialSettingsModelId?: string;
279
+ /** The exclusive end time of match results used for this mode. */
280
+ MatchResultEndTimeUtc: string;
281
+ /** The inclusive start time of match results used for this mode. */
282
+ MatchResultStartTimeUtc: string;
283
+ /** The maximum number of batch learning iterations to run. */
284
+ MaxIterations: number;
285
+ /** The name of the model that will be created. */
286
+ ModelName: string;
287
+ /** The ID of the scenario for this batch model. */
288
+ ScenarioId: string;
289
+ }
290
+ interface CreateBatchModelResponse extends IPlayFabResultCommon {
291
+ /** The id of the model that was created. Null if the request failed. */
292
+ ModelId?: string;
293
+ }
175
294
  interface CreateBuildAliasRequest extends IPlayFabRequestCommon {
176
295
  /** The alias name. */
177
296
  AliasName: string;
@@ -192,8 +311,18 @@ interface CreateBuildWithCustomContainerRequest extends IPlayFabRequestCommon {
192
311
  ContainerFlavor?: string;
193
312
  /** The container reference, consisting of the image name and tag. */
194
313
  ContainerImageReference?: ContainerImageReference;
314
+ /**
315
+ * The name of the container repository.
316
+ * @deprecated Please use ContainerImageReference instead.
317
+ */
318
+ ContainerRepositoryName?: string;
195
319
  /** The container command to run when the multiplayer server has been allocated, including any arguments. */
196
320
  ContainerRunCommand?: string;
321
+ /**
322
+ * The tag for the container.
323
+ * @deprecated Please use ContainerImageReference instead.
324
+ */
325
+ ContainerTag?: string;
197
326
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
198
327
  CustomTags?: Record<string, string | null>;
199
328
  /** The list of game assets related to the build. */
@@ -219,6 +348,12 @@ interface CreateBuildWithCustomContainerRequest extends IPlayFabRequestCommon {
219
348
  RegionConfigurations: BuildRegionParams[];
220
349
  /** The resource constraints to apply to each server on the VM (EXPERIMENTAL API) */
221
350
  ServerResourceConstraints?: ServerResourceConstraintParams;
351
+ /**
352
+ * DEPRECATED - this is always true. Assets are downloaded and uncompressed in memory, without the compressedversion being
353
+ * written first to disc.
354
+ * @deprecated Please use instead.
355
+ */
356
+ UseStreamingForAssetDownloads?: boolean;
222
357
  /** The VM size to create the build on. */
223
358
  VmSize?: string;
224
359
  /** The configuration for the VmStartupScript for the build */
@@ -318,6 +453,12 @@ interface CreateBuildWithManagedContainerRequest extends IPlayFabRequestCommon {
318
453
  ServerResourceConstraints?: ServerResourceConstraintParams;
319
454
  /** The command to run when the multiplayer server is started, including any arguments. */
320
455
  StartMultiplayerServerCommand: string;
456
+ /**
457
+ * DEPRECATED - this is always true. Assets are downloaded and uncompressed in memory, without the compressedversion being
458
+ * written first to disc.
459
+ * @deprecated Please use instead.
460
+ */
461
+ UseStreamingForAssetDownloads?: boolean;
321
462
  /** The VM size to create the build on. */
322
463
  VmSize?: string;
323
464
  /** The configuration for the VmStartupScript for the build */
@@ -430,6 +571,12 @@ interface CreateBuildWithProcessBasedServerRequest extends IPlayFabRequestCommon
430
571
  * relative to the root asset folder when unzipped.
431
572
  */
432
573
  StartMultiplayerServerCommand: string;
574
+ /**
575
+ * DEPRECATED - this is always true. Assets are downloaded and uncompressed in memory, without the compressedversion being
576
+ * written first to disc.
577
+ * @deprecated Please use instead.
578
+ */
579
+ UseStreamingForAssetDownloads?: boolean;
433
580
  /** The VM size to create the build on. */
434
581
  VmSize?: string;
435
582
  /** The configuration for the VmStartupScript for the build */
@@ -500,11 +647,11 @@ interface CreateBuildWithProcessBasedServerResponse extends IPlayFabResultCommon
500
647
  }
501
648
  interface CreateLobbyRequest extends IPlayFabRequestCommon {
502
649
  /**
503
- * The policy indicating who is allowed to join the lobby, and the visibility to queries. May be 'Public', 'Friends' or
504
- * 'Private'. Public means the lobby is both visible in queries and any player may join, including invited players. Friends
650
+ * The policy indicating who is allowed to join the lobby, and the visibility to queries. May be &#39;Public&#39;, &#39;Friends&#39; or
651
+ * &#39;Private&#39;. Public means the lobby is both visible in queries and any player may join, including invited players. Friends
505
652
  * means that users who are bidirectional friends of members in the lobby may search to find friend lobbies, to retrieve
506
653
  * its connection string. Private means the lobby is not visible in queries, and a player must receive an invitation to
507
- * join. Defaults to 'Public' on creation. Can only be changed by the lobby owner.
654
+ * join. Defaults to &#39;Public&#39; on creation. Can only be changed by the lobby owner.
508
655
  */
509
656
  AccessPolicy?: string;
510
657
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
@@ -518,18 +665,18 @@ interface CreateLobbyRequest extends IPlayFabRequestCommon {
518
665
  /** The maximum number of players allowed in the lobby. The value must be between 2 and 128. */
519
666
  MaxPlayers: number;
520
667
  /**
521
- * The member initially added to the lobby. Client must specify exactly one member, which is the creator's entity and
668
+ * The member initially added to the lobby. Client must specify exactly one member, which is the creator&#39;s entity and
522
669
  * member data. Member PubSubConnectionHandle must be null or empty. Game servers must not specify any members.
523
670
  */
524
671
  Members?: Member[];
525
672
  /** The lobby owner. Must be the calling entity. */
526
673
  Owner: EntityKey;
527
674
  /**
528
- * The policy for how a new owner is chosen. May be 'Automatic', 'Manual' or 'None'. Can only be specified by clients. If
529
- * client-owned and 'Automatic' - The Lobby service will automatically assign another connected owner when the current
530
- * owner leaves or disconnects. The useConnections property must be true. If client - owned and 'Manual' - Ownership is
675
+ * The policy for how a new owner is chosen. May be &#39;Automatic&#39;, &#39;Manual&#39; or &#39;None&#39;. Can only be specified by clients. If
676
+ * client-owned and &#39;Automatic&#39; - The Lobby service will automatically assign another connected owner when the current
677
+ * owner leaves or disconnects. The useConnections property must be true. If client - owned and &#39;Manual&#39; - Ownership is
531
678
  * protected as long as the current owner is connected. If the current owner leaves or disconnects any member may set
532
- * themselves as the current owner. The useConnections property must be true. If client-owned and 'None' - Any member can
679
+ * themselves as the current owner. The useConnections property must be true. If client-owned and &#39;None&#39; - Any member can
533
680
  * set ownership. The useConnections property can be either true or false.
534
681
  */
535
682
  OwnerMigrationPolicy?: string;
@@ -600,6 +747,20 @@ interface CreateRemoteUserResponse extends IPlayFabResultCommon {
600
747
  /** The username for the remote user that was created. */
601
748
  Username?: string;
602
749
  }
750
+ interface CreateScenarioRequest extends IPlayFabRequestCommon {
751
+ /** A dictionary of allowed condition keys and the allowed condition values for each. */
752
+ Conditions?: ScenarioConfigCondition[];
753
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
754
+ CustomTags?: Record<string, string | null>;
755
+ /** List of strings that represents all the events that are allowed to be present in a MatchResult. */
756
+ Events?: string[];
757
+ /** The name of the scenario to create. */
758
+ Name: string;
759
+ }
760
+ interface CreateScenarioResponse extends IPlayFabResultCommon {
761
+ /** The id of the scenario that was created. */
762
+ ScenarioId?: string;
763
+ }
603
764
  interface CreateServerBackfillTicketRequest extends IPlayFabRequestCommon {
604
765
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
605
766
  CustomTags?: Record<string, string | null>;
@@ -686,6 +847,16 @@ interface CustomTeamSizeBalanceRuleExpansion {
686
847
  /** How many seconds before this rule is expanded. */
687
848
  SecondsBetweenExpansions: number;
688
849
  }
850
+ interface DeactivateModelRequest extends IPlayFabRequestCommon {
851
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
852
+ CustomTags?: Record<string, string | null>;
853
+ /** The ID of model that will be deactivated. */
854
+ ModelId: string;
855
+ /** The ID of the scenario for the model to deactivate. */
856
+ ScenarioId: string;
857
+ }
858
+ interface DeactivateModelResponse extends IPlayFabResultCommon {
859
+ }
689
860
  interface DeleteAssetRequest extends IPlayFabRequestCommon {
690
861
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
691
862
  CustomTags?: Record<string, string | null>;
@@ -730,6 +901,16 @@ interface DeleteLobbyRequest extends IPlayFabRequestCommon {
730
901
  /** The id of the lobby. */
731
902
  LobbyId?: string;
732
903
  }
904
+ interface DeleteModelRequest extends IPlayFabRequestCommon {
905
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
906
+ CustomTags?: Record<string, string | null>;
907
+ /** The ID of the model to be deleted. */
908
+ ModelId: string;
909
+ /** The ID of the scenario for the model to delete. */
910
+ ScenarioId: string;
911
+ }
912
+ interface DeleteModelResponse extends IPlayFabResultCommon {
913
+ }
733
914
  interface DeleteRemoteUserRequest extends IPlayFabRequestCommon {
734
915
  /** The guid string build ID of the multiplayer server where the remote user is to delete. */
735
916
  BuildId: string;
@@ -742,6 +923,19 @@ interface DeleteRemoteUserRequest extends IPlayFabRequestCommon {
742
923
  /** The virtual machine ID the multiplayer server is located on. */
743
924
  VmId: string;
744
925
  }
926
+ interface DeleteScenarioRequest extends IPlayFabRequestCommon {
927
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
928
+ CustomTags?: Record<string, string | null>;
929
+ /**
930
+ * If this flag is specified, the scenario will be deleted even if it contains models, as long as they are in either a
931
+ * failed, cancelled, or deactivated state.
932
+ */
933
+ ForceDelete: boolean;
934
+ /** The Scenario ID of the scenario to be deleted. */
935
+ ScenarioId: string;
936
+ }
937
+ interface DeleteScenarioResponse extends IPlayFabResultCommon {
938
+ }
745
939
  interface DeleteSecretRequest extends IPlayFabRequestCommon {
746
940
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
747
941
  CustomTags?: Record<string, string | null>;
@@ -752,7 +946,7 @@ interface DifferenceRule {
752
946
  /** Description of the attribute used by this rule to match tickets. */
753
947
  Attribute: QueueRuleAttribute;
754
948
  /**
755
- * Describes the behavior when an attribute is not specified in the ticket creation request or in the user's entity
949
+ * Describes the behavior when an attribute is not specified in the ticket creation request or in the user&#39;s entity
756
950
  * profile.
757
951
  */
758
952
  AttributeNotSpecifiedBehavior: string;
@@ -776,7 +970,7 @@ interface DifferenceRule {
776
970
  Name: string;
777
971
  /**
778
972
  * How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
779
- * prioritized over those that don't). Leave blank if this rule is always enforced.
973
+ * prioritized over those that don&#39;t). Leave blank if this rule is always enforced.
780
974
  */
781
975
  SecondsUntilOptional?: number;
782
976
  /** The relative weight of this rule compared to others. */
@@ -807,31 +1001,50 @@ interface EnableMultiplayerServersForTitleResponse extends IPlayFabResultCommon
807
1001
  /** The enabled status for the multiplayer server features for the title. */
808
1002
  Status?: string;
809
1003
  }
1004
+ interface EnablePartiesForTitleRequest extends IPlayFabRequestCommon {
1005
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1006
+ CustomTags?: Record<string, string | null>;
1007
+ }
810
1008
  interface EntityKey {
811
1009
  /** Unique ID of the entity. */
812
1010
  Id: string;
813
1011
  /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
814
1012
  Type?: string;
1013
+ /**
1014
+ * Alternate name for Type.
1015
+ * @deprecated Please use Type instead.
1016
+ */
1017
+ TypeString?: string;
815
1018
  }
816
1019
  interface FindFriendLobbiesRequest extends IPlayFabRequestCommon {
817
1020
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
818
1021
  CustomTags?: Record<string, string | null>;
819
- /** Indicates which other platforms' friends this query should link to. */
1022
+ /**
1023
+ * Controls whether this query should link to friends made on the Facebook network. Defaults to false
1024
+ * @deprecated Please use ExternalPlatformFriends instead.
1025
+ */
1026
+ ExcludeFacebookFriends?: boolean;
1027
+ /**
1028
+ * Controls whether this query should link to friends made on the Steam network. Defaults to false
1029
+ * @deprecated Please use ExternalPlatformFriends instead.
1030
+ */
1031
+ ExcludeSteamFriends?: boolean;
1032
+ /** Indicates which other platforms&#39; friends this query should link to. */
820
1033
  ExternalPlatformFriends?: string;
821
1034
  /**
822
- * OData style string that contains one or more filters. Only the following operators are supported: "and" (logical and),
823
- * "eq" (equal), "ne" (not equals), "ge" (greater than or equal), "gt" (greater than), "le" (less than or equal), and "lt"
1035
+ * OData style string that contains one or more filters. Only the following operators are supported: &quot;and&quot; (logical and),
1036
+ * &quot;eq&quot; (equal), &quot;ne&quot; (not equals), &quot;ge&quot; (greater than or equal), &quot;gt&quot; (greater than), &quot;le&quot; (less than or equal), and &quot;lt&quot;
824
1037
  * (less than). The left-hand side of each OData logical expression should be either a search property key (e.g.
825
- * string_key1, number_key3, etc) or one of the pre-defined search keys all of which must be prefixed by "lobby/":
1038
+ * string_key1, number_key3, etc) or one of the pre-defined search keys all of which must be prefixed by &quot;lobby/&quot;:
826
1039
  * lobby/memberCount (number of players in a lobby), lobby/maxMemberCount (maximum number of players allowed in a lobby),
827
1040
  * lobby/memberCountRemaining (remaining number of players who can be allowed in a lobby), lobby/membershipLock (must equal
828
- * 'Unlocked' or 'Locked'), lobby/amOwner (required to equal "true"), lobby/amMember (required to equal "true").
1041
+ * &#39;Unlocked&#39; or &#39;Locked&#39;), lobby/amOwner (required to equal &quot;true&quot;), lobby/amMember (required to equal &quot;true&quot;).
829
1042
  */
830
1043
  Filter?: string;
831
1044
  /**
832
- * OData style string that contains sorting for this query in either ascending ("asc") or descending ("desc") order.
833
- * OrderBy clauses are of the form "number_key1 asc" or the pre-defined search key "lobby/memberCount asc",
834
- * "lobby/memberCountRemaining desc" and "lobby/maxMemberCount desc". To sort by closest, a moniker `distance{number_key1 =
1045
+ * OData style string that contains sorting for this query in either ascending (&quot;asc&quot;) or descending (&quot;desc&quot;) order.
1046
+ * OrderBy clauses are of the form &quot;number_key1 asc&quot; or the pre-defined search key &quot;lobby/memberCount asc&quot;,
1047
+ * &quot;lobby/memberCountRemaining desc&quot; and &quot;lobby/maxMemberCount desc&quot;. To sort by closest, a moniker `distance{number_key1 =
835
1048
  * 5}` can be used to sort by distance from the given number. This field only supports either one sort clause or one
836
1049
  * distance clause.
837
1050
  */
@@ -851,19 +1064,19 @@ interface FindLobbiesRequest extends IPlayFabRequestCommon {
851
1064
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
852
1065
  CustomTags?: Record<string, string | null>;
853
1066
  /**
854
- * OData style string that contains one or more filters. Only the following operators are supported: "and" (logical and),
855
- * "eq" (equal), "ne" (not equals), "ge" (greater than or equal), "gt" (greater than), "le" (less than or equal), and "lt"
1067
+ * OData style string that contains one or more filters. Only the following operators are supported: &quot;and&quot; (logical and),
1068
+ * &quot;eq&quot; (equal), &quot;ne&quot; (not equals), &quot;ge&quot; (greater than or equal), &quot;gt&quot; (greater than), &quot;le&quot; (less than or equal), and &quot;lt&quot;
856
1069
  * (less than). The left-hand side of each OData logical expression should be either a search property key (e.g.
857
- * string_key1, number_key3, etc) or one of the pre-defined search keys all of which must be prefixed by "lobby/":
1070
+ * string_key1, number_key3, etc) or one of the pre-defined search keys all of which must be prefixed by &quot;lobby/&quot;:
858
1071
  * lobby/memberCount (number of players in a lobby), lobby/maxMemberCount (maximum number of players allowed in a lobby),
859
1072
  * lobby/memberCountRemaining (remaining number of players who can be allowed in a lobby), lobby/membershipLock (must equal
860
- * 'Unlocked' or 'Locked'), lobby/amOwner (required to equal "true"), lobby/amMember (required to equal "true").
1073
+ * &#39;Unlocked&#39; or &#39;Locked&#39;), lobby/amOwner (required to equal &quot;true&quot;), lobby/amMember (required to equal &quot;true&quot;).
861
1074
  */
862
1075
  Filter?: string;
863
1076
  /**
864
- * OData style string that contains sorting for this query in either ascending ("asc") or descending ("desc") order.
865
- * OrderBy clauses are of the form "number_key1 asc" or the pre-defined search key "lobby/memberCount asc",
866
- * "lobby/memberCountRemaining desc" and "lobby/maxMemberCount desc". To sort by closest, a moniker `distance{number_key1 =
1077
+ * OData style string that contains sorting for this query in either ascending (&quot;asc&quot;) or descending (&quot;desc&quot;) order.
1078
+ * OrderBy clauses are of the form &quot;number_key1 asc&quot; or the pre-defined search key &quot;lobby/memberCount asc&quot;,
1079
+ * &quot;lobby/memberCountRemaining desc&quot; and &quot;lobby/maxMemberCount desc&quot;. To sort by closest, a moniker `distance{number_key1 =
867
1080
  * 5}` can be used to sort by distance from the given number. This field only supports either one sort clause or one
868
1081
  * distance clause.
869
1082
  */
@@ -935,25 +1148,25 @@ interface GameSecretReferenceParams {
935
1148
  interface GetAssetDownloadUrlRequest extends IPlayFabRequestCommon {
936
1149
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
937
1150
  CustomTags?: Record<string, string | null>;
938
- /** The asset's file name to get the download URL for. */
1151
+ /** The asset&#39;s file name to get the download URL for. */
939
1152
  FileName: string;
940
1153
  }
941
1154
  interface GetAssetDownloadUrlResponse extends IPlayFabResultCommon {
942
- /** The asset's download URL. */
1155
+ /** The asset&#39;s download URL. */
943
1156
  AssetDownloadUrl?: string;
944
- /** The asset's file name to get the download URL for. */
1157
+ /** The asset&#39;s file name to get the download URL for. */
945
1158
  FileName?: string;
946
1159
  }
947
1160
  interface GetAssetUploadUrlRequest extends IPlayFabRequestCommon {
948
1161
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
949
1162
  CustomTags?: Record<string, string | null>;
950
- /** The asset's file name to get the upload URL for. */
1163
+ /** The asset&#39;s file name to get the upload URL for. */
951
1164
  FileName: string;
952
1165
  }
953
1166
  interface GetAssetUploadUrlResponse extends IPlayFabResultCommon {
954
- /** The asset's upload URL. */
1167
+ /** The asset&#39;s upload URL. */
955
1168
  AssetUploadUrl?: string;
956
- /** The asset's file name to get the upload URL for. */
1169
+ /** The asset&#39;s file name to get the upload URL for. */
957
1170
  FileName?: string;
958
1171
  }
959
1172
  interface GetBuildAliasRequest extends IPlayFabRequestCommon {
@@ -1019,11 +1232,45 @@ interface GetBuildResponse extends IPlayFabResultCommon {
1019
1232
  * builds. If the build is a custom build, this field will be null.
1020
1233
  */
1021
1234
  StartMultiplayerServerCommand?: string;
1235
+ /**
1236
+ * When true, assets will be downloaded and uncompressed in memory, without the compressedversion being written first to
1237
+ * disc.
1238
+ * @deprecated Do not use
1239
+ */
1240
+ UseStreamingForAssetDownloads?: boolean;
1022
1241
  /** The VM size the build was created on. */
1023
1242
  VmSize?: string;
1024
1243
  /** The configuration for the VmStartupScript feature for the build */
1025
1244
  VmStartupScriptConfiguration?: VmStartupScriptConfiguration;
1026
1245
  }
1246
+ interface GetCognitiveServicesLocalesRequest extends IPlayFabRequestCommon {
1247
+ /** The type of the cognitive service for which locales are being requested. */
1248
+ CognitiveServicesType: string;
1249
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1250
+ CustomTags?: Record<string, string | null>;
1251
+ /** The region the client is closest to (A service endpoint will be provided for this region or one nearest one available). */
1252
+ Region: string;
1253
+ }
1254
+ interface GetCognitiveServicesLocalesResponse extends IPlayFabResultCommon {
1255
+ /** The locales for the cognitive service. */
1256
+ Locales?: CognitiveServicesLocale[];
1257
+ }
1258
+ interface GetCognitiveServicesTokenRequest extends IPlayFabRequestCommon {
1259
+ /** The type of the cognitive service for which a token is being requested. */
1260
+ CognitiveServicesType: string;
1261
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1262
+ CustomTags?: Record<string, string | null>;
1263
+ /** The region the client is closest to (A service endpoint will be provided for this region or one nearest one available). */
1264
+ Region: string;
1265
+ }
1266
+ interface GetCognitiveServicesTokenResponse extends IPlayFabResultCommon {
1267
+ /** Token expiration time. */
1268
+ ExpirationTimeUtc?: string;
1269
+ /** The url for the service where further requests can be made with the given token. */
1270
+ ServiceEndpoint?: string;
1271
+ /** The token for the cognitive service. */
1272
+ Token?: string;
1273
+ }
1027
1274
  interface GetContainerRegistryCredentialsRequest extends IPlayFabRequestCommon {
1028
1275
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1029
1276
  CustomTags?: Record<string, string | null>;
@@ -1070,6 +1317,11 @@ interface GetMatchmakingTicketRequest extends IPlayFabRequestCommon {
1070
1317
  TicketId: string;
1071
1318
  }
1072
1319
  interface GetMatchmakingTicketResult extends IPlayFabResultCommon {
1320
+ /**
1321
+ * The reason why the current ticket was canceled. This field is only set if the ticket is in canceled state.
1322
+ * @deprecated Please use CancellationReasonString instead.
1323
+ */
1324
+ CancellationReason?: string;
1073
1325
  /**
1074
1326
  * The reason why the current ticket was canceled. This field is only set if the ticket is in canceled state. Please retry
1075
1327
  * if CancellationReason is RetryRequired.
@@ -1079,7 +1331,7 @@ interface GetMatchmakingTicketResult extends IPlayFabResultCommon {
1079
1331
  ChangeNumber?: number;
1080
1332
  /** The server date and time at which ticket was created. */
1081
1333
  Created: string;
1082
- /** The Creator's entity key. */
1334
+ /** The Creator&#39;s entity key. */
1083
1335
  Creator: EntityKey;
1084
1336
  /** How long to attempt matching this ticket in seconds. */
1085
1337
  GiveUpAfterSeconds: number;
@@ -1129,6 +1381,67 @@ interface GetMatchResult extends IPlayFabResultCommon {
1129
1381
  /** The details of the server that the match has been allocated to. */
1130
1382
  ServerDetails?: ServerDetails;
1131
1383
  }
1384
+ interface GetModelDetailsRequest extends IPlayFabRequestCommon {
1385
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1386
+ CustomTags?: Record<string, string | null>;
1387
+ /** The ID of the Model we want to retrieve details for. */
1388
+ ModelId: string;
1389
+ /** The ID of the Scenario that the requested model belongs to. */
1390
+ ScenarioId: string;
1391
+ }
1392
+ interface GetModelDetailsResponse extends IPlayFabResultCommon {
1393
+ /** The details of the Model that was requested. */
1394
+ ModelDetails?: ModelDetails;
1395
+ }
1396
+ interface GetModelsByScenarioRequest extends IPlayFabRequestCommon {
1397
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1398
+ CustomTags?: Record<string, string | null>;
1399
+ /** The ID of the scenario to get the model. */
1400
+ ScenarioId: string;
1401
+ }
1402
+ interface GetModelsByScenarioResponse extends IPlayFabResultCommon {
1403
+ /** The model result based on the given scenario. */
1404
+ Models?: ModelSummary[];
1405
+ }
1406
+ interface GetMultiplayerServerAndTokenRequest extends IPlayFabRequestCommon {
1407
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1408
+ CustomTags?: Record<string, string | null>;
1409
+ /**
1410
+ * The title generated guid string session ID of the multiplayer server to get details for. This is to keep track of
1411
+ * multiplayer server sessions.
1412
+ */
1413
+ SessionId: string;
1414
+ /** List of players for which to get tokens. */
1415
+ TokenPlayerIds: string[];
1416
+ }
1417
+ interface GetMultiplayerServerAndTokenResponse extends IPlayFabResultCommon {
1418
+ /** The identity of the build in which the server was allocated. */
1419
+ BuildId?: string;
1420
+ /** The connected players in the multiplayer server. */
1421
+ ConnectedPlayers?: ConnectedPlayer[];
1422
+ /** The fully qualified domain name of the virtual machine that is hosting this multiplayer server. */
1423
+ FQDN?: string;
1424
+ /** The public IPv4 address of the virtual machine that is hosting this multiplayer server. */
1425
+ IPV4Address?: string;
1426
+ /** The time (UTC) at which a change in the multiplayer server state was observed. */
1427
+ LastStateTransitionTime?: string;
1428
+ /** A set of tokens that can be used to connect to the server. Tokens match the requested user ids */
1429
+ PlayerTokens?: PlayerToken[];
1430
+ /** The ports the multiplayer server uses. */
1431
+ Ports?: Port[];
1432
+ /** The list of public Ipv4 addresses associated with the server. */
1433
+ PublicIPV4Addresses?: PublicIpAddress[];
1434
+ /** The region the multiplayer server is located in. */
1435
+ Region?: string;
1436
+ /** The string server ID of the multiplayer server generated by PlayFab. */
1437
+ ServerId?: string;
1438
+ /** The guid string session ID of the multiplayer server. */
1439
+ SessionId?: string;
1440
+ /** The state of the multiplayer server. */
1441
+ State?: string;
1442
+ /** The virtual machine ID that the multiplayer server is located on. */
1443
+ VmId?: string;
1444
+ }
1132
1445
  interface GetMultiplayerServerDetailsRequest extends IPlayFabRequestCommon {
1133
1446
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1134
1447
  CustomTags?: Record<string, string | null>;
@@ -1167,6 +1480,11 @@ interface GetMultiplayerServerDetailsResponse extends IPlayFabResultCommon {
1167
1480
  interface GetMultiplayerServerLogsRequest extends IPlayFabRequestCommon {
1168
1481
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1169
1482
  CustomTags?: Record<string, string | null>;
1483
+ /**
1484
+ * The region of the multiplayer server to get logs for.
1485
+ * @deprecated Do not use
1486
+ */
1487
+ Region?: string;
1170
1488
  /** The server ID of multiplayer server to get logs for. */
1171
1489
  ServerId: string;
1172
1490
  }
@@ -1180,6 +1498,82 @@ interface GetMultiplayerSessionLogsBySessionIdRequest extends IPlayFabRequestCom
1180
1498
  /** The server ID of multiplayer server to get logs for. */
1181
1499
  SessionId: string;
1182
1500
  }
1501
+ interface GetPlayerSkillForConditionsFromModelRequest extends IPlayFabRequestCommon {
1502
+ /** A map from condition names to condition values in which to get the skills of the players. */
1503
+ Conditions: ConditionsSet[];
1504
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1505
+ CustomTags?: Record<string, string | null>;
1506
+ /** If set to true, TrueSkill will return the player&#39;s SkillBreakdown as part of the response. */
1507
+ IncludeSkillBreakdown: boolean;
1508
+ /** ID of the model to get the players&#39; skill from. */
1509
+ ModelId: string;
1510
+ /** List of players to retrieve skill values for. */
1511
+ Players: TrueSkillPlayer[];
1512
+ /** ID of the scenario to get the players&#39; skill from. */
1513
+ ScenarioId: string;
1514
+ }
1515
+ interface GetPlayerSkillForConditionsFromModelResponse extends IPlayFabResultCommon {
1516
+ /** If the specified model is marked as primary for the given scenario. */
1517
+ IsModelPrimary: boolean;
1518
+ /** The skill values for the specified players in a given model. */
1519
+ Skills?: PlayerSkills[];
1520
+ }
1521
+ interface GetPlayerSkillForConditionsRequest extends IPlayFabRequestCommon {
1522
+ /** A map from condition names to condition values in which to get the skills of the players. */
1523
+ Conditions: ConditionsSet[];
1524
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1525
+ CustomTags?: Record<string, string | null>;
1526
+ /** If set to true, TrueSkill will return the player&#39;s SkillBreakdown as part of the response. */
1527
+ IncludeSkillBreakdown: boolean;
1528
+ /** List of players to retrieve skill values for. */
1529
+ Players: TrueSkillPlayer[];
1530
+ /** ID of the scenario to get the players&#39; skill from. */
1531
+ ScenarioId: string;
1532
+ }
1533
+ interface GetPlayerSkillForConditionsResponse extends IPlayFabResultCommon {
1534
+ /** ID of the Model where the skill values were retrieved from. */
1535
+ ModelId?: string;
1536
+ /** The skill values for the specified players in the primary model of a given scenario. */
1537
+ Skills?: PlayerSkills[];
1538
+ }
1539
+ interface GetPlayerSkillFromModelRequest extends IPlayFabRequestCommon {
1540
+ /** A map from condition names to condition values in which to get the skills of the players. */
1541
+ Conditions?: Record<string, string | null>;
1542
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1543
+ CustomTags?: Record<string, string | null>;
1544
+ /** If set to true, TrueSkill will return the player&#39;s SkillBreakdown as part of the response. */
1545
+ IncludeSkillBreakdown: boolean;
1546
+ /** ID of the model to get the players&#39; skill from. */
1547
+ ModelId: string;
1548
+ /** List of players to retrieve skill values for. */
1549
+ Players: TrueSkillPlayer[];
1550
+ /** ID of the scenario to get the players&#39; skill from. */
1551
+ ScenarioId: string;
1552
+ }
1553
+ interface GetPlayerSkillFromModelResponse extends IPlayFabResultCommon {
1554
+ /** If the specified model is marked as primary for the given scenario. */
1555
+ IsModelPrimary: boolean;
1556
+ /** The skill values for the specified players in a given model. */
1557
+ Skills?: PlayerSkill[];
1558
+ }
1559
+ interface GetPlayerSkillRequest extends IPlayFabRequestCommon {
1560
+ /** A map from condition names to condition values in which to get the skills of the players. */
1561
+ Conditions?: Record<string, string | null>;
1562
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1563
+ CustomTags?: Record<string, string | null>;
1564
+ /** If set to true, TrueSkill will return the player&#39;s SkillBreakdown as part of the response. */
1565
+ IncludeSkillBreakdown: boolean;
1566
+ /** List of players to retrieve skill values for. */
1567
+ Players: TrueSkillPlayer[];
1568
+ /** ID of the scenario to get the players&#39; skill from. */
1569
+ ScenarioId: string;
1570
+ }
1571
+ interface GetPlayerSkillResponse extends IPlayFabResultCommon {
1572
+ /** ID of the Model where the skill values were retrieved from. */
1573
+ ModelId?: string;
1574
+ /** The skill values for the specified players in the primary model of a given scenario. */
1575
+ Skills?: PlayerSkill[];
1576
+ }
1183
1577
  interface GetQueueStatisticsRequest extends IPlayFabRequestCommon {
1184
1578
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1185
1579
  CustomTags?: Record<string, string | null>;
@@ -1208,6 +1602,24 @@ interface GetRemoteLoginEndpointResponse extends IPlayFabResultCommon {
1208
1602
  /** The remote login port of multiplayer server. */
1209
1603
  Port: number;
1210
1604
  }
1605
+ interface GetScenarioConfigurationRequest extends IPlayFabRequestCommon {
1606
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1607
+ CustomTags?: Record<string, string | null>;
1608
+ /** The Scenario ID of the given scenario. */
1609
+ ScenarioId: string;
1610
+ }
1611
+ interface GetScenarioConfigurationResponse extends IPlayFabResultCommon {
1612
+ /** The requested Scenario Configuration. */
1613
+ ScenarioConfiguration?: ScenarioConfiguration;
1614
+ }
1615
+ interface GetScenarioConfigurationsRequest extends IPlayFabRequestCommon {
1616
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1617
+ CustomTags?: Record<string, string | null>;
1618
+ }
1619
+ interface GetScenarioConfigurationsResponse extends IPlayFabResultCommon {
1620
+ /** The Scenario Configurations of the title. */
1621
+ ScenarioConfigurations?: ScenarioConfiguration[];
1622
+ }
1211
1623
  interface GetServerBackfillTicketRequest extends IPlayFabRequestCommon {
1212
1624
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1213
1625
  CustomTags?: Record<string, string | null>;
@@ -1222,6 +1634,11 @@ interface GetServerBackfillTicketRequest extends IPlayFabRequestCommon {
1222
1634
  TicketId: string;
1223
1635
  }
1224
1636
  interface GetServerBackfillTicketResult extends IPlayFabResultCommon {
1637
+ /**
1638
+ * The reason why the current ticket was canceled. This field is only set if the ticket is in canceled state.
1639
+ * @deprecated Please use CancellationReasonString instead.
1640
+ */
1641
+ CancellationReason?: string;
1225
1642
  /** The reason why the current ticket was canceled. This field is only set if the ticket is in canceled state. */
1226
1643
  CancellationReasonString?: string;
1227
1644
  /** The server date and time at which ticket was created. */
@@ -1289,11 +1706,11 @@ interface InviteToLobbyRequest extends IPlayFabRequestCommon {
1289
1706
  }
1290
1707
  interface JoinArrangedLobbyRequest extends IPlayFabRequestCommon {
1291
1708
  /**
1292
- * The policy indicating who is allowed to join the lobby, and the visibility to queries. May be 'Public', 'Friends' or
1293
- * 'Private'. Public means the lobby is both visible in queries and any player may join, including invited players. Friends
1709
+ * The policy indicating who is allowed to join the lobby, and the visibility to queries. May be &#39;Public&#39;, &#39;Friends&#39; or
1710
+ * &#39;Private&#39;. Public means the lobby is both visible in queries and any player may join, including invited players. Friends
1294
1711
  * means that users who are bidirectional friends of members in the lobby may search to find friend lobbies, to retrieve
1295
1712
  * its connection string. Private means the lobby is not visible in queries, and a player must receive an invitation to
1296
- * join. Defaults to 'Public' on creation. Can only be changed by the lobby owner.
1713
+ * join. Defaults to &#39;Public&#39; on creation. Can only be changed by the lobby owner.
1297
1714
  */
1298
1715
  AccessPolicy?: string;
1299
1716
  /**
@@ -1315,11 +1732,11 @@ interface JoinArrangedLobbyRequest extends IPlayFabRequestCommon {
1315
1732
  /** The member entity who is joining the lobby. The first member to join will be the lobby owner. */
1316
1733
  MemberEntity: EntityKey;
1317
1734
  /**
1318
- * The policy for how a new owner is chosen. May be 'Automatic', 'Manual' or 'None'. Can only be specified by clients. If
1319
- * client-owned and 'Automatic' - The Lobby service will automatically assign another connected owner when the current
1320
- * owner leaves or disconnects. The useConnections property must be true. If client - owned and 'Manual' - Ownership is
1735
+ * The policy for how a new owner is chosen. May be &#39;Automatic&#39;, &#39;Manual&#39; or &#39;None&#39;. Can only be specified by clients. If
1736
+ * client-owned and &#39;Automatic&#39; - The Lobby service will automatically assign another connected owner when the current
1737
+ * owner leaves or disconnects. The useConnections property must be true. If client - owned and &#39;Manual&#39; - Ownership is
1321
1738
  * protected as long as the current owner is connected. If the current owner leaves or disconnects any member may set
1322
- * themselves as the current owner. The useConnections property must be true. If client-owned and 'None' - Any member can
1739
+ * themselves as the current owner. The useConnections property must be true. If client-owned and &#39;None&#39; - Any member can
1323
1740
  * set ownership. The useConnections property can be either true or false.
1324
1741
  */
1325
1742
  OwnerMigrationPolicy?: string;
@@ -1360,7 +1777,7 @@ interface JoinLobbyAsServerRequest extends IPlayFabRequestCommon {
1360
1777
  ServerEntity: EntityKey;
1361
1778
  }
1362
1779
  interface JoinLobbyAsServerResult extends IPlayFabResultCommon {
1363
- /** Successfully joined lobby's id. */
1780
+ /** Successfully joined lobby&#39;s id. */
1364
1781
  LobbyId: string;
1365
1782
  }
1366
1783
  interface JoinLobbyRequest extends IPlayFabRequestCommon {
@@ -1378,7 +1795,7 @@ interface JoinLobbyRequest extends IPlayFabRequestCommon {
1378
1795
  MemberEntity?: EntityKey;
1379
1796
  }
1380
1797
  interface JoinLobbyResult extends IPlayFabResultCommon {
1381
- /** Successfully joined lobby's id. */
1798
+ /** Successfully joined lobby&#39;s id. */
1382
1799
  LobbyId: string;
1383
1800
  }
1384
1801
  interface JoinMatchmakingTicketRequest extends IPlayFabRequestCommon {
@@ -1595,6 +2012,11 @@ interface ListMultiplayerServersResponse extends IPlayFabResultCommon {
1595
2012
  interface ListPartyQosServersRequest extends IPlayFabRequestCommon {
1596
2013
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1597
2014
  CustomTags?: Record<string, string | null>;
2015
+ /**
2016
+ * Qos servers version
2017
+ * @deprecated Do not use
2018
+ */
2019
+ Version?: string;
1598
2020
  }
1599
2021
  interface ListPartyQosServersResponse extends IPlayFabResultCommon {
1600
2022
  /** The page size on the response. */
@@ -1623,6 +2045,20 @@ interface ListQosServersForTitleResponse extends IPlayFabResultCommon {
1623
2045
  /** The skip token for the paged response. */
1624
2046
  SkipToken?: string;
1625
2047
  }
2048
+ /** @deprecated Do not use */
2049
+ interface ListQosServersRequest extends IPlayFabRequestCommon {
2050
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2051
+ CustomTags?: Record<string, string | null>;
2052
+ }
2053
+ /** @deprecated Do not use */
2054
+ interface ListQosServersResponse extends IPlayFabResultCommon {
2055
+ /** The page size on the response. */
2056
+ PageSize: number;
2057
+ /** The list of QoS servers. */
2058
+ QosServers?: QosServer[];
2059
+ /** The skip token for the paged response. */
2060
+ SkipToken?: string;
2061
+ }
1626
2062
  interface ListSecretSummariesRequest extends IPlayFabRequestCommon {
1627
2063
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1628
2064
  CustomTags?: Record<string, string | null>;
@@ -1750,20 +2186,20 @@ interface LobbySummary {
1750
2186
  SearchData?: Record<string, string | null>;
1751
2187
  }
1752
2188
  interface MatchmakingPlayer {
1753
- /** The user's attributes custom to the title. */
2189
+ /** The user&#39;s attributes custom to the title. */
1754
2190
  Attributes?: MatchmakingPlayerAttributes;
1755
2191
  /** The entity key of the matchmaking user. */
1756
2192
  Entity: EntityKey;
1757
2193
  }
1758
2194
  interface MatchmakingPlayerAttributes {
1759
- /** A data object representing a user's attributes. */
2195
+ /** A data object representing a user&#39;s attributes. */
1760
2196
  DataObject?: any;
1761
- /** An escaped data object representing a user's attributes. */
2197
+ /** An escaped data object representing a user&#39;s attributes. */
1762
2198
  EscapedDataObject?: string;
1763
2199
  }
1764
2200
  interface MatchmakingPlayerWithTeamAssignment {
1765
2201
  /**
1766
- * The user's attributes custom to the title. These attributes will be null unless the request has ReturnMemberAttributes
2202
+ * The user&#39;s attributes custom to the title. These attributes will be null unless the request has ReturnMemberAttributes
1767
2203
  * flag set to true.
1768
2204
  */
1769
2205
  Attributes?: MatchmakingPlayerAttributes;
@@ -1816,20 +2252,55 @@ interface MatchmakingQueueTeam {
1816
2252
  /** A name to identify the team. This is case insensitive. */
1817
2253
  Name: string;
1818
2254
  }
2255
+ interface MatchResult {
2256
+ /** Time when the match ended. */
2257
+ EndDateTimeUtc: string;
2258
+ /** ID of the scenario that this match result belongs to. */
2259
+ ScenarioId: string;
2260
+ /** Time when the match started. */
2261
+ StartDateTimeUtc: string;
2262
+ /** List of teams that participated in the given match. */
2263
+ Teams: MatchResultTeam[];
2264
+ }
2265
+ interface MatchResultPlayer {
2266
+ /** ID of the Bot. This field should be empty if player isn&#39;t a bot. */
2267
+ BotId?: number;
2268
+ /** How the player&#39;s participation ended in the match. CompletionStatus can only be Completed, Quit, Disconnected or Kicked. */
2269
+ CompletionStatus: string;
2270
+ /** A map from condition name to condition value of this player in the given match. */
2271
+ Conditions?: Record<string, string | null>;
2272
+ /** Entity of the given player. This field should be empty if player is a bot. */
2273
+ Entity?: EntityKey;
2274
+ /** A map from event name to the count of events of this player in the given match. */
2275
+ EventCounts?: Record<string, number>;
2276
+ /** GUID shared by players on this team that formed a group to play together prior to matchmaking. */
2277
+ PreMatchPartyId?: string;
2278
+ /** Duration that the given player stayed in the match. */
2279
+ SecondsPlayed: number;
2280
+ }
2281
+ interface MatchResultTeam {
2282
+ /** List of players that participated in the given match in this team. */
2283
+ Players: MatchResultPlayer[];
2284
+ /**
2285
+ * Rank of the given team in the match. Rank starts from 0 and increment based on the team placing, the winning team being
2286
+ * 0. Teams can have the same rank to denote draws.
2287
+ */
2288
+ Rank: number;
2289
+ }
1819
2290
  interface MatchTotalRule {
1820
2291
  /** Description of the attribute used by this rule to match tickets. */
1821
2292
  Attribute: QueueRuleAttribute;
1822
2293
  /** Collection of fields relating to expanding this rule at set intervals. */
1823
2294
  Expansion?: MatchTotalRuleExpansion;
1824
- /** The maximum total value for a group. Must be >= Min. */
2295
+ /** The maximum total value for a group. Must be &gt;= Min. */
1825
2296
  Max: number;
1826
- /** The minimum total value for a group. Must be >=2. */
2297
+ /** The minimum total value for a group. Must be &gt;=2. */
1827
2298
  Min: number;
1828
2299
  /** Friendly name chosen by developer. */
1829
2300
  Name: string;
1830
2301
  /**
1831
2302
  * How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
1832
- * prioritized over those that don't). Leave blank if this rule is always enforced.
2303
+ * prioritized over those that don&#39;t). Leave blank if this rule is always enforced.
1833
2304
  */
1834
2305
  SecondsUntilOptional?: number;
1835
2306
  /** The relative weight of this rule compared to others. */
@@ -1851,6 +2322,90 @@ interface Member {
1851
2322
  /** Opaque string, stored on a Subscribe call, which indicates the connection an owner or member has with PubSub. */
1852
2323
  PubSubConnectionHandle?: string;
1853
2324
  }
2325
+ interface ModelCondition {
2326
+ /** The key for this condition. */
2327
+ Key: string;
2328
+ /**
2329
+ * A number representing the rank of this condition in terms of how important the condition is in comparison to the other
2330
+ * ones in the model. This number should be between 1 and the total number of condition in the model, and it should be
2331
+ * unique across all the conditions. The lower the specified rank the more important the condition, 1 being the most
2332
+ * important. This will be used for identifying similar conditions when the model has no data about some conditions.
2333
+ */
2334
+ Rank: number;
2335
+ }
2336
+ interface ModelDetails {
2337
+ /**
2338
+ * The number of batch learning iterations that have been run for this model. When null, it means that this is a base
2339
+ * model.
2340
+ */
2341
+ BatchIterations?: number;
2342
+ /**
2343
+ * List of parameters that were used for creating this model via batch run. The value for the parameters is null when the
2344
+ * model is a base model.
2345
+ */
2346
+ BatchParameters?: BatchParameters;
2347
+ /**
2348
+ * The summary of the batch results for this model. This will be null when the model is a base model or when the batch run
2349
+ * hasn&#39;t finished..
2350
+ */
2351
+ BatchResults?: BatchResults;
2352
+ /** List of condition keys and their associated affinity weights that this model supports. */
2353
+ Conditions?: ModelCondition[];
2354
+ /** Time when the Model was created. */
2355
+ CreationDateTime: string;
2356
+ /**
2357
+ * The current threshold value for determining if a match result is considered anomalous enough to be ignored. This will be
2358
+ * null when creating a batch model and the settings have not been loaded yet. Note:
2359
+ * &lt;c&gt;BatchParameters.AnomalousMatchResultIgnoreThreshold&lt;/c&gt; value was the one that was used when creating the batch
2360
+ * model, which might differ from this value.
2361
+ */
2362
+ CurrentAnomalousMatchResultIgnoreThreshold?: number;
2363
+ /**
2364
+ * An integer between 0 and MaxStateProgress (inclusive) indicating progress within the model&#39;s current state, or null if
2365
+ * the current state is not a state with measurable progress.
2366
+ */
2367
+ CurrentStateProgress?: number;
2368
+ /**
2369
+ * Time remaining in seconds to finish the current model state. If it is a base model, the model isn&#39;t in a state with
2370
+ * measurable progress, or if the time remaining is unknown, this field will be null.
2371
+ */
2372
+ EstimatedTimeRemainingInSeconds?: number;
2373
+ /** List of events that the Model supports. */
2374
+ Events?: string[];
2375
+ /** The primary flag of the model. */
2376
+ IsPrimary: boolean;
2377
+ /**
2378
+ * The maximum progress value for the model&#39;s current state, or null if the current state is not a state with measurable
2379
+ * progress.
2380
+ */
2381
+ MaxStateProgress?: number;
2382
+ /** String that represents the method that was used for creating this model. The value can only be either Base or Batch. */
2383
+ ModelCreationMethod?: string;
2384
+ /** The ID of the model. */
2385
+ ModelId?: string;
2386
+ /** The name of the model. */
2387
+ ModelName?: string;
2388
+ /**
2389
+ * The state of the model. ModelState can be Pending, LoadingMatches, BuildingModel, SavingModel, ReadyForCatchUp,
2390
+ * CatchingUp, CatchUpFailed, Active, Cancelled, BatchFailed, or Deactivated.
2391
+ */
2392
+ ModelState?: string;
2393
+ }
2394
+ interface ModelSummary {
2395
+ /** Time when the Model was created. */
2396
+ CreationDateTime: string;
2397
+ /** The primary flag of the model. */
2398
+ IsPrimary: boolean;
2399
+ /** The ID of the model. */
2400
+ ModelId?: string;
2401
+ /** The name of the model. */
2402
+ ModelName?: string;
2403
+ /**
2404
+ * The state of the model. ModelState can be Pending, LoadingMatches, BuildingModel, SavingModel, ReadyForCatchUp,
2405
+ * CatchingUp, CatchUpFailed, Active, Cancelled, BatchFailed, or Deactivated.
2406
+ */
2407
+ ModelState?: string;
2408
+ }
1854
2409
  interface MonitoringApplicationConfiguration {
1855
2410
  /** Asset which contains the monitoring application files and scripts. */
1856
2411
  AssetReference: AssetReference;
@@ -1907,10 +2462,14 @@ interface PaginationResponse {
1907
2462
  /** The number of lobbies that matched the search request. */
1908
2463
  TotalMatchedLobbyCount?: number;
1909
2464
  }
2465
+ interface PartyBuildAliasParams {
2466
+ /** The guid string alias ID to use for the request. */
2467
+ AliasId: string;
2468
+ }
1910
2469
  interface PartyInvitationConfiguration {
1911
2470
  /**
1912
2471
  * The list of PlayFab EntityKeys that the invitation allows to authenticate into the network. If this list is empty, all
1913
- * users are allowed to authenticate using the invitation's identifier. This list may contain no more than 1024 items.
2472
+ * users are allowed to authenticate using the invitation&#39;s identifier. This list may contain no more than 1024 items.
1914
2473
  */
1915
2474
  EntityKeys?: EntityKey[];
1916
2475
  /** The invite identifier for this party. If this value is specified, it must be no longer than 127 characters. */
@@ -1938,6 +2497,54 @@ interface PartyNetworkConfiguration {
1938
2497
  */
1939
2498
  PartyInvitationConfiguration?: PartyInvitationConfiguration;
1940
2499
  }
2500
+ interface PlayerSkill {
2501
+ /** Entity of the given player. */
2502
+ Entity?: EntityKey;
2503
+ /** Time when the last match to update the player&#39;s skill was uploaded. */
2504
+ LastProcessedMatchUploadTimeUtc: string;
2505
+ /**
2506
+ * The given player&#39;s skill value to be used for Matchmaking computed by TrueSkill. This takes into account the player&#39;s
2507
+ * squad size, as well as other modifiers related to the skills in this condition as a whole
2508
+ */
2509
+ MatchmakingSkillValue: number;
2510
+ /**
2511
+ * A detailed breakdown of the player&#39;s skill. This will only be returned if IncludeSkillBreakdown was specified and true
2512
+ * in the request.
2513
+ */
2514
+ SkillBreakdown?: SkillBreakdown;
2515
+ /** The given player&#39;s individual skill computed by TrueSkill. */
2516
+ SkillValue: number;
2517
+ }
2518
+ interface PlayerSkillForCondition {
2519
+ /** Set of Conditions of the respective player skills data. */
2520
+ Conditions?: Record<string, string | null>;
2521
+ /**
2522
+ * The given player&#39;s skill value to be used for Matchmaking computed by TrueSkill. This takes into account the player&#39;s
2523
+ * squad size, as well as other modifiers related to the skills in this condition as a whole
2524
+ */
2525
+ MatchmakingSkillValue: number;
2526
+ /**
2527
+ * A detailed breakdown of the player&#39;s skill. This will only be returned if IncludeSkillBreakdown was specified and true
2528
+ * in the request.
2529
+ */
2530
+ SkillBreakdown?: SkillBreakdown;
2531
+ /** The given player&#39;s individual skill computed by TrueSkill. */
2532
+ SkillValue: number;
2533
+ }
2534
+ interface PlayerSkills {
2535
+ /** Entity of the given player. */
2536
+ Entity?: EntityKey;
2537
+ /** Time when the last match to update the player&#39;s skill was uploaded. */
2538
+ LastProcessedMatchUploadTimeUtc: string;
2539
+ /** List of skill values for all the conditions sets that were requested. */
2540
+ SkillsForConditions?: PlayerSkillForCondition[];
2541
+ }
2542
+ interface PlayerToken {
2543
+ /** The player id of the player for which the token applies. */
2544
+ PlayerId?: string;
2545
+ /** The (base64 encoded) token. */
2546
+ Token?: string;
2547
+ }
1941
2548
  interface Port {
1942
2549
  /** The name for the port. */
1943
2550
  Name: string;
@@ -1998,7 +2605,7 @@ interface RegionSelectionRule {
1998
2605
  Path: string;
1999
2606
  /**
2000
2607
  * How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
2001
- * prioritized over those that don't). Leave blank if this rule is always enforced.
2608
+ * prioritized over those that don&#39;t). Leave blank if this rule is always enforced.
2002
2609
  */
2003
2610
  SecondsUntilOptional?: number;
2004
2611
  /** The relative weight of this rule compared to others. */
@@ -2022,6 +2629,61 @@ interface RemoveMemberFromLobbyRequest extends IPlayFabRequestCommon {
2022
2629
  /** If true, removed member can never rejoin this lobby. */
2023
2630
  PreventRejoin: boolean;
2024
2631
  }
2632
+ interface RequestMultiplayerServerAndTokenRequest extends IPlayFabRequestCommon {
2633
+ /** The identifiers of the build alias to use for the request. */
2634
+ BuildAliasParams?: BuildAliasParams;
2635
+ /** The guid string build ID of the multiplayer server to request. */
2636
+ BuildId?: string;
2637
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2638
+ CustomTags?: Record<string, string | null>;
2639
+ /**
2640
+ * Initial list of players (potentially matchmade) allowed to connect to the game. This list is passed to the game server
2641
+ * when requested (via GSDK) and can be used to validate players connecting to it.
2642
+ */
2643
+ InitialPlayers?: string[];
2644
+ /**
2645
+ * The preferred regions to request a multiplayer server from. The Multiplayer Service will iterate through the regions in
2646
+ * the specified order and allocate a server from the first one that has servers available.
2647
+ */
2648
+ PreferredRegions: string[];
2649
+ /**
2650
+ * Data encoded as a string that is passed to the game server when requested. This can be used to to communicate
2651
+ * information such as game mode or map through the request flow.
2652
+ */
2653
+ SessionCookie?: string;
2654
+ /** A guid string session ID created track the multiplayer server session over its life. */
2655
+ SessionId: string;
2656
+ /** List of players for which to get tokens. */
2657
+ TokenPlayerIds: string[];
2658
+ }
2659
+ interface RequestMultiplayerServerAndTokenResponse extends IPlayFabResultCommon {
2660
+ /** The identity of the build in which the server was allocated. */
2661
+ BuildId?: string;
2662
+ /** The connected players in the multiplayer server. */
2663
+ ConnectedPlayers?: ConnectedPlayer[];
2664
+ /** The fully qualified domain name of the virtual machine that is hosting this multiplayer server. */
2665
+ FQDN?: string;
2666
+ /** The public IPv4 address of the virtual machine that is hosting this multiplayer server. */
2667
+ IPV4Address?: string;
2668
+ /** The time (UTC) at which a change in the multiplayer server state was observed. */
2669
+ LastStateTransitionTime?: string;
2670
+ /** A set of tokens that can be used to connect to the server. Tokens match the requested user ids */
2671
+ PlayerTokens?: PlayerToken[];
2672
+ /** The ports the multiplayer server uses. */
2673
+ Ports?: Port[];
2674
+ /** The list of public Ipv4 addresses associated with the server. */
2675
+ PublicIPV4Addresses?: PublicIpAddress[];
2676
+ /** The region the multiplayer server is located in. */
2677
+ Region?: string;
2678
+ /** The string server ID of the multiplayer server generated by PlayFab. */
2679
+ ServerId?: string;
2680
+ /** The guid string session ID of the multiplayer server. */
2681
+ SessionId?: string;
2682
+ /** The state of the multiplayer server. */
2683
+ State?: string;
2684
+ /** The virtual machine ID that the multiplayer server is located on. */
2685
+ VmId?: string;
2686
+ }
2025
2687
  interface RequestMultiplayerServerRequest extends IPlayFabRequestCommon {
2026
2688
  /** The identifiers of the build alias to use for the request. */
2027
2689
  BuildAliasParams?: BuildAliasParams;
@@ -2073,6 +2735,52 @@ interface RequestMultiplayerServerResponse extends IPlayFabResultCommon {
2073
2735
  /** The virtual machine ID that the multiplayer server is located on. */
2074
2736
  VmId?: string;
2075
2737
  }
2738
+ interface RequestPartyRequest extends IPlayFabRequestCommon {
2739
+ /** The identifiers of the build alias to use for the request. */
2740
+ BuildAliasParams?: PartyBuildAliasParams;
2741
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2742
+ CustomTags?: Record<string, string | null>;
2743
+ /** A guid string party ID created track the party session over its life. */
2744
+ PartyId: string;
2745
+ /**
2746
+ * The preferred regions to request a party session from. The party service will iterate through the regions in the
2747
+ * specified order and allocate a party session from the first one that is available.
2748
+ */
2749
+ PreferredRegions: string[];
2750
+ /**
2751
+ * Data encoded as a string that is passed to the party when requested. This can be used to to communicate information such
2752
+ * as party type through the request flow.
2753
+ */
2754
+ SessionCookie?: string;
2755
+ /** The client version for the party being requested. */
2756
+ Version?: string;
2757
+ }
2758
+ interface RequestPartyResponse extends IPlayFabResultCommon {
2759
+ /** The build id that the party was allocated on. */
2760
+ BuildId?: string;
2761
+ /** The connected players in the party. */
2762
+ ConnectedPlayers?: ConnectedPlayer[];
2763
+ /** The thumbprint of the DTLS certificate presented by the party session */
2764
+ DTLSCertificateSHA2Thumbprint?: string;
2765
+ /** The fully qualified domain name of the virtual machine that is hosting this party session. */
2766
+ FQDN?: string;
2767
+ /** The IPv4 address of the virtual machine that is hosting this party session. */
2768
+ IPV4Address?: string;
2769
+ /** The time (UTC) at which a change in the party state was observed. */
2770
+ LastStateTransitionTime?: string;
2771
+ /** The guid string party ID of the party session. */
2772
+ PartyId?: string;
2773
+ /** The ports the party session uses. */
2774
+ Ports?: Port[];
2775
+ /** The region the party session is located in. */
2776
+ Region?: string;
2777
+ /** The string server ID of the party session generated by PlayFab. */
2778
+ ServerId?: string;
2779
+ /** The state of the party session. */
2780
+ State?: string;
2781
+ /** The virtual machine ID that the party session is located on. */
2782
+ VmId?: string;
2783
+ }
2076
2784
  interface RequestPartyServiceRequest extends IPlayFabRequestCommon {
2077
2785
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2078
2786
  CustomTags?: Record<string, string | null>;
@@ -2109,8 +2817,40 @@ interface RolloverContainerRegistryCredentialsResponse extends IPlayFabResultCom
2109
2817
  /** The username for accessing the container registry. */
2110
2818
  Username?: string;
2111
2819
  }
2820
+ interface ScenarioConfigCondition {
2821
+ /** The key for a scenario condition. */
2822
+ Key: string;
2823
+ /** List of strings that represents all the values for a condition. */
2824
+ Values: string[];
2825
+ }
2826
+ interface ScenarioConfigEvent {
2827
+ /** The name for a scenario event. */
2828
+ Name?: string;
2829
+ /** The state of a scenario event. State can be Allowed or Required. */
2830
+ State?: string;
2831
+ }
2832
+ interface ScenarioConfigResponseCondition {
2833
+ /** The key for a scenario condition. */
2834
+ Key: string;
2835
+ /** The state of a scenario condition. State can be Allowed or Required. */
2836
+ State?: string;
2837
+ /** List of strings that represents all the values for a condition. */
2838
+ Values: string[];
2839
+ }
2840
+ interface ScenarioConfiguration {
2841
+ /** A list of condition keys, allowed condition values, and state for each that are allowed to be present in a MatchResult. */
2842
+ Conditions?: ScenarioConfigResponseCondition[];
2843
+ /** List of all the Events that are allowed to be present in a MatchResult for this scenario. */
2844
+ Events?: ScenarioConfigEvent[];
2845
+ /** The id of the returned scenario. */
2846
+ Id?: string;
2847
+ /** The friendly name of the returned scenario. */
2848
+ Name?: string;
2849
+ /** The ID of the primary model of the scenario. */
2850
+ PrimaryModelId?: string;
2851
+ }
2112
2852
  interface Schedule {
2113
- /** A short description about this schedule. For example, "Game launch on July 15th". */
2853
+ /** A short description about this schedule. For example, &quot;Game launch on July 15th&quot;. */
2114
2854
  Description?: string;
2115
2855
  /**
2116
2856
  * The date and time in UTC at which the schedule ends. If IsRecurringWeekly is true, this schedule will keep renewing for
@@ -2155,7 +2895,7 @@ interface ServerDetails {
2155
2895
  IPV4Address?: string;
2156
2896
  /** The ports the multiplayer server uses. */
2157
2897
  Ports?: Port[];
2158
- /** The server's region. */
2898
+ /** The server&#39;s region. */
2159
2899
  Region?: string;
2160
2900
  /** The string server ID of the multiplayer server generated by PlayFab. */
2161
2901
  ServerId?: string;
@@ -2173,7 +2913,7 @@ interface SetIntersectionRule {
2173
2913
  /** Description of the attribute used by this rule to match tickets. */
2174
2914
  Attribute: QueueRuleAttribute;
2175
2915
  /**
2176
- * Describes the behavior when an attribute is not specified in the ticket creation request or in the user's entity
2916
+ * Describes the behavior when an attribute is not specified in the ticket creation request or in the user&#39;s entity
2177
2917
  * profile.
2178
2918
  */
2179
2919
  AttributeNotSpecifiedBehavior: string;
@@ -2195,7 +2935,7 @@ interface SetIntersectionRule {
2195
2935
  Name: string;
2196
2936
  /**
2197
2937
  * How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
2198
- * prioritized over those that don't). Leave blank if this rule is always enforced.
2938
+ * prioritized over those that don&#39;t). Leave blank if this rule is always enforced.
2199
2939
  */
2200
2940
  SecondsUntilOptional?: number;
2201
2941
  /** The relative weight of this rule compared to others. */
@@ -2210,11 +2950,35 @@ interface SetMatchmakingQueueRequest extends IPlayFabRequestCommon {
2210
2950
  interface SetMatchmakingQueueResult extends IPlayFabResultCommon {
2211
2951
  }
2212
2952
  interface ShutdownMultiplayerServerRequest extends IPlayFabRequestCommon {
2953
+ /**
2954
+ * The guid string build ID of the multiplayer server to delete.
2955
+ * @deprecated Do not use
2956
+ */
2957
+ BuildId?: string;
2213
2958
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2214
2959
  CustomTags?: Record<string, string | null>;
2960
+ /**
2961
+ * The region of the multiplayer server to shut down.
2962
+ * @deprecated Do not use
2963
+ */
2964
+ Region?: string;
2215
2965
  /** A guid string session ID of the multiplayer server to shut down. */
2216
2966
  SessionId: string;
2217
2967
  }
2968
+ interface SkillBreakdown {
2969
+ /** A number denoting the number of matches that the player has played in the specific conditions. */
2970
+ Experience: number;
2971
+ /** The average skill of the given player&#39;s skill distribution. */
2972
+ Mean: number;
2973
+ /**
2974
+ * A double between 0 and 1 denoting the approximate percentage of players that have lower skill than the given player.
2975
+ * QuantileRank is only supported for batch models. Note: The percentage is based on quantiles of player skill obtained
2976
+ * when the model was created, and those quantiles could become less accurate over time.
2977
+ */
2978
+ QuantileRank?: number;
2979
+ /** The variance of the given player&#39;s skill based on their skill distribution. */
2980
+ Variance: number;
2981
+ }
2218
2982
  interface Statistics {
2219
2983
  /** The average. */
2220
2984
  Average: number;
@@ -2235,7 +2999,7 @@ interface StringEqualityRule {
2235
2999
  /** Description of the attribute used by this rule to match tickets. */
2236
3000
  Attribute: QueueRuleAttribute;
2237
3001
  /**
2238
- * Describes the behavior when an attribute is not specified in the ticket creation request or in the user's entity
3002
+ * Describes the behavior when an attribute is not specified in the ticket creation request or in the user&#39;s entity
2239
3003
  * profile.
2240
3004
  */
2241
3005
  AttributeNotSpecifiedBehavior: string;
@@ -2253,7 +3017,7 @@ interface StringEqualityRule {
2253
3017
  Name: string;
2254
3018
  /**
2255
3019
  * How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
2256
- * prioritized over those that don't). Leave blank if this rule is always enforced.
3020
+ * prioritized over those that don&#39;t). Leave blank if this rule is always enforced.
2257
3021
  */
2258
3022
  SecondsUntilOptional?: number;
2259
3023
  /** The relative weight of this rule compared to others. */
@@ -2274,14 +3038,14 @@ interface SubscribeToLobbyResourceRequest extends IPlayFabRequestCommon {
2274
3038
  PubSubConnectionHandle: string;
2275
3039
  /**
2276
3040
  * The name of the resource to subscribe to. For LobbyChange subscriptions this is the lobbyId. For LobbyInvite
2277
- * subscriptions this should always be "@me".
3041
+ * subscriptions this should always be &quot;@me&quot;.
2278
3042
  */
2279
3043
  ResourceId: string;
2280
3044
  /** Version number for the subscription of this resource. */
2281
3045
  SubscriptionVersion: number;
2282
3046
  /**
2283
- * Subscription type. "LobbyChange" subscriptions allow a member or owner to receive notifications of lobby data, member or
2284
- * owner changes. "LobbyInvite" subscriptions allow a player to receive invites to lobbies. A player does not need to be a
3047
+ * Subscription type. &quot;LobbyChange&quot; subscriptions allow a member or owner to receive notifications of lobby data, member or
3048
+ * owner changes. &quot;LobbyInvite&quot; subscriptions allow a player to receive invites to lobbies. A player does not need to be a
2285
3049
  * member of a lobby to receive lobby invites.
2286
3050
  */
2287
3051
  Type: string;
@@ -2338,7 +3102,7 @@ interface TeamDifferenceRule {
2338
3102
  Name: string;
2339
3103
  /**
2340
3104
  * How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
2341
- * prioritized over those that don't). Leave blank if this rule is always enforced.
3105
+ * prioritized over those that don&#39;t). Leave blank if this rule is always enforced.
2342
3106
  */
2343
3107
  SecondsUntilOptional?: number;
2344
3108
  }
@@ -2356,7 +3120,7 @@ interface TeamSizeBalanceRule {
2356
3120
  Name: string;
2357
3121
  /**
2358
3122
  * How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
2359
- * prioritized over those that don't). Leave blank if this rule is always enforced.
3123
+ * prioritized over those that don&#39;t). Leave blank if this rule is always enforced.
2360
3124
  */
2361
3125
  SecondsUntilOptional?: number;
2362
3126
  }
@@ -2365,7 +3129,7 @@ interface TeamTicketSizeSimilarityRule {
2365
3129
  Name: string;
2366
3130
  /**
2367
3131
  * How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be
2368
- * prioritized over those that don't). Leave blank if this rule is always enforced.
3132
+ * prioritized over those that don&#39;t). Leave blank if this rule is always enforced.
2369
3133
  */
2370
3134
  SecondsUntilOptional?: number;
2371
3135
  }
@@ -2373,6 +3137,15 @@ interface TitleMultiplayerServersQuotas {
2373
3137
  /** The core capacity for the various regions and VM Family */
2374
3138
  CoreCapacities?: CoreCapacity[];
2375
3139
  }
3140
+ interface TrueSkillPlayer {
3141
+ /** Entity of the player to retrieve skill values for. */
3142
+ Entity: EntityKey;
3143
+ /**
3144
+ * Size of the squad that the player is currently on. If this value is not specified, we consider the player to not be in a
3145
+ * squad.
3146
+ */
3147
+ SquadSize?: number;
3148
+ }
2376
3149
  interface UnsubscribeFromLobbyResourceRequest extends IPlayFabRequestCommon {
2377
3150
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2378
3151
  CustomTags?: Record<string, string | null>;
@@ -2475,11 +3248,11 @@ interface UpdateLobbyAsServerRequest extends IPlayFabRequestCommon {
2475
3248
  }
2476
3249
  interface UpdateLobbyRequest extends IPlayFabRequestCommon {
2477
3250
  /**
2478
- * The policy indicating who is allowed to join the lobby, and the visibility to queries. May be 'Public', 'Friends' or
2479
- * 'Private'. Public means the lobby is both visible in queries and any player may join, including invited players. Friends
3251
+ * The policy indicating who is allowed to join the lobby, and the visibility to queries. May be &#39;Public&#39;, &#39;Friends&#39; or
3252
+ * &#39;Private&#39;. Public means the lobby is both visible in queries and any player may join, including invited players. Friends
2480
3253
  * means that users who are bidirectional friends of members in the lobby may search to find friend lobbies, to retrieve
2481
3254
  * its connection string. Private means the lobby is not visible in queries, and a player must receive an invitation to
2482
- * join. Defaults to 'Public' on creation. Can only be changed by the lobby owner.
3255
+ * join. Defaults to &#39;Public&#39; on creation. Can only be changed by the lobby owner.
2483
3256
  */
2484
3257
  AccessPolicy?: string;
2485
3258
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
@@ -2503,35 +3276,35 @@ interface UpdateLobbyRequest extends IPlayFabRequestCommon {
2503
3276
  MaxPlayers?: number;
2504
3277
  /**
2505
3278
  * The private key-value pairs used by the member to communicate information to other members and the owner. Optional. Sets
2506
- * or updates new key-value pairs on the caller's member data. New keys will be added with their values and existing keys
3279
+ * or updates new key-value pairs on the caller&#39;s member data. New keys will be added with their values and existing keys
2507
3280
  * will be updated with the new values. Visible to all entities in the lobby. At most 30 key-value pairs may be stored
2508
3281
  * here, keys are limited to 30 characters and values to 1000. The total size of all memberData values may not exceed 4096
2509
3282
  * bytes. Keys are case sensitive. Servers cannot specifiy this.
2510
3283
  */
2511
3284
  MemberData?: Record<string, string | null>;
2512
3285
  /**
2513
- * The keys to delete from the lobby MemberData. Optional. Deletes key-value pairs on the caller's member data. All the
2514
- * specified keys will be removed from the caller's member data. Keys that do not exist are a no-op. If the key to delete
3286
+ * The keys to delete from the lobby MemberData. Optional. Deletes key-value pairs on the caller&#39;s member data. All the
3287
+ * specified keys will be removed from the caller&#39;s member data. Keys that do not exist are a no-op. If the key to delete
2515
3288
  * exists in the memberData (same request) it will result in a bad request. Servers cannot specifiy this.
2516
3289
  */
2517
3290
  MemberDataToDelete?: string[];
2518
3291
  /** The member entity whose data is being modified. Servers cannot specify this. */
2519
3292
  MemberEntity?: EntityKey;
2520
3293
  /**
2521
- * A setting indicating whether the lobby is locked. May be 'Unlocked' or 'Locked'. When Locked new members are not allowed
2522
- * to join. Defaults to 'Unlocked' on creation. Can only be changed by the lobby owner.
3294
+ * A setting indicating whether the lobby is locked. May be &#39;Unlocked&#39; or &#39;Locked&#39;. When Locked new members are not allowed
3295
+ * to join. Defaults to &#39;Unlocked&#39; on creation. Can only be changed by the lobby owner.
2523
3296
  */
2524
3297
  MembershipLock?: string;
2525
3298
  /**
2526
- * The lobby owner. Optional. Set to transfer ownership of the lobby. If client - owned and 'Automatic' - The Lobby service
3299
+ * The lobby owner. Optional. Set to transfer ownership of the lobby. If client - owned and &#39;Automatic&#39; - The Lobby service
2527
3300
  * will automatically assign another connected owner when the current owner leaves or disconnects. useConnections must be
2528
- * true. If client - owned and 'Manual' - Ownership is protected as long as the current owner is connected. If the current
3301
+ * true. If client - owned and &#39;Manual&#39; - Ownership is protected as long as the current owner is connected. If the current
2529
3302
  * owner leaves or disconnects any member may set themselves as the current owner. The useConnections property must be
2530
- * true. If client-owned and 'None' - Any member can set ownership. The useConnections property can be either true or
3303
+ * true. If client-owned and &#39;None&#39; - Any member can set ownership. The useConnections property can be either true or
2531
3304
  * false. For all client-owned lobbies when the owner leaves and a new owner can not be automatically selected - The owner
2532
3305
  * field is set to null. For all client-owned lobbies when the owner disconnects and a new owner can not be automatically
2533
3306
  * selected - The owner field remains unchanged and the current owner retains all owner abilities for the lobby. If
2534
- * server-owned (must be 'Server') - Any server can set ownership. The useConnections property must be true.
3307
+ * server-owned (must be &#39;Server&#39;) - Any server can set ownership. The useConnections property must be true.
2535
3308
  */
2536
3309
  Owner?: EntityKey;
2537
3310
  /**
@@ -2550,6 +3323,48 @@ interface UpdateLobbyRequest extends IPlayFabRequestCommon {
2550
3323
  */
2551
3324
  SearchDataToDelete?: string[];
2552
3325
  }
3326
+ interface UpdateModelRequest extends IPlayFabRequestCommon {
3327
+ /** Optional new threshold value for anomalous match results in the model. */
3328
+ AnomalousMatchResultIgnoreThreshold?: number;
3329
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3330
+ CustomTags?: Record<string, string | null>;
3331
+ /** The ID of the Model we want to update. */
3332
+ ModelId: string;
3333
+ /** Optional new friendly name for the model. */
3334
+ ModelName?: string;
3335
+ /** The ID of the Scenario that the requested model belongs to. */
3336
+ ScenarioId: string;
3337
+ }
3338
+ interface UpdateModelResponse extends IPlayFabResultCommon {
3339
+ }
3340
+ interface UpdatePrimaryModelRequest extends IPlayFabRequestCommon {
3341
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3342
+ CustomTags?: Record<string, string | null>;
3343
+ /** The ID of model that will be marked as primary. */
3344
+ ModelId: string;
3345
+ /** The ID of the scenario to update. */
3346
+ ScenarioId: string;
3347
+ }
3348
+ interface UpdatePrimaryModelResponse extends IPlayFabResultCommon {
3349
+ }
3350
+ interface UpdateScenarioConfigurationRequest extends IPlayFabRequestCommon {
3351
+ /** List of strings that represents all the conditions that are to be removed. */
3352
+ ConditionsToRemove?: string[];
3353
+ /** A dictionary of conditions that are to be added or updated. */
3354
+ ConditionsToUpdateOrAdd?: ScenarioConfigCondition[];
3355
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3356
+ CustomTags?: Record<string, string | null>;
3357
+ /** List of strings that represents all the events that are to be added. */
3358
+ EventsToAdd?: string[];
3359
+ /** List of strings that represents all the events that are to be removed. */
3360
+ EventsToRemove?: string[];
3361
+ /** The friendly name of the given scenario to be updated. */
3362
+ Name?: string;
3363
+ /** The Scenario ID of the given scenario. */
3364
+ ScenarioId: string;
3365
+ }
3366
+ interface UpdateScenarioConfigurationResponse extends IPlayFabResultCommon {
3367
+ }
2553
3368
  interface UploadCertificateRequest extends IPlayFabRequestCommon {
2554
3369
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2555
3370
  CustomTags?: Record<string, string | null>;
@@ -2558,6 +3373,18 @@ interface UploadCertificateRequest extends IPlayFabRequestCommon {
2558
3373
  /** The game certificate to upload. */
2559
3374
  GameCertificate: Certificate;
2560
3375
  }
3376
+ interface UploadMatchResultRequest extends IPlayFabRequestCommon {
3377
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3378
+ CustomTags?: Record<string, string | null>;
3379
+ /** The match result to be uploaded for computing player skills. */
3380
+ MatchResult: MatchResult;
3381
+ }
3382
+ interface UploadMatchResultResponse extends IPlayFabResultCommon {
3383
+ /** Identifier of the MatchResult, unique within the title. */
3384
+ MatchResultId?: string;
3385
+ /** Time that the MatchResult was uploaded. Null if the upload of the given MatchResult failed. */
3386
+ UploadTimeUtc: string;
3387
+ }
2561
3388
  interface UploadSecretRequest extends IPlayFabRequestCommon {
2562
3389
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2563
3390
  CustomTags?: Record<string, string | null>;
@@ -2610,448 +3437,2149 @@ interface WindowsCrashDumpConfiguration {
2610
3437
  declare class PlayFabMultiplayerApi extends PlayFabCommon {
2611
3438
  /**
2612
3439
  * Cancel all active tickets the player is a member of in a given queue.
2613
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/cancelallmatchmakingticketsforplayer
3440
+ *
3441
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/cancelallmatchmakingticketsforplayer Microsoft Documentation}
3442
+ * @example
3443
+ * await matchClient.CancelAllMatchmakingTicketsForPlayer({
3444
+ * "Entity": {
3445
+ * "Id": "123123123",
3446
+ * "Type": "title_player_account",
3447
+ * "TypeString": "title_player_account"
3448
+ * },
3449
+ * "QueueName": "custom123"
3450
+ * });
2614
3451
  */
2615
3452
  CancelAllMatchmakingTicketsForPlayer(request: CancelAllMatchmakingTicketsForPlayerRequest, extraHeaders?: Record<string, string>): Promise<CancelAllMatchmakingTicketsForPlayerResult>;
2616
3453
  /**
2617
3454
  * Cancel all active backfill tickets the player is a member of in a given queue.
2618
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/cancelallserverbackfillticketsforplayer
3455
+ *
3456
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/cancelallserverbackfillticketsforplayer Microsoft Documentation}
3457
+ * @example
3458
+ * await matchClient.CancelAllServerBackfillTicketsForPlayer({
3459
+ * "Entity": {
3460
+ * "Id": "123123123",
3461
+ * "Type": "title_player_account",
3462
+ * "TypeString": "title_player_account"
3463
+ * },
3464
+ * "QueueName": "custom123"
3465
+ * });
2619
3466
  */
2620
3467
  CancelAllServerBackfillTicketsForPlayer(request: CancelAllServerBackfillTicketsForPlayerRequest, extraHeaders?: Record<string, string>): Promise<CancelAllServerBackfillTicketsForPlayerResult>;
2621
3468
  /**
2622
3469
  * Cancel a matchmaking ticket.
2623
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/cancelmatchmakingticket
3470
+ *
3471
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/cancelmatchmakingticket Microsoft Documentation}
3472
+ * @example
3473
+ * await matchClient.CancelMatchmakingTicket({
3474
+ * "TicketId": "1c4b0daa-150e-47ae-9923-d770c0f9b07c",
3475
+ * "QueueName": "custom123"
3476
+ * });
2624
3477
  */
2625
3478
  CancelMatchmakingTicket(request: CancelMatchmakingTicketRequest, extraHeaders?: Record<string, string>): Promise<CancelMatchmakingTicketResult>;
3479
+ /**
3480
+ * Cancel a batch model creation.
3481
+ *
3482
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/cancelmodel Microsoft Documentation}
3483
+ * @example
3484
+ * await trueskillClient.CancelModel({
3485
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
3486
+ * "ModelId": "73a2506e-9fd3-4d84-8dd7-570c8e9e02cf"
3487
+ * });
3488
+ */
3489
+ CancelModel(request: CancelModelRequest, extraHeaders?: Record<string, string>): Promise<CancelModelResponse>;
2626
3490
  /**
2627
3491
  * Cancel a server backfill ticket.
2628
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/cancelserverbackfillticket
3492
+ *
3493
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/cancelserverbackfillticket Microsoft Documentation}
3494
+ * @example
3495
+ * await matchClient.CancelServerBackfillTicket({
3496
+ * "TicketId": "1c4b0daa-150e-47ae-9923-d770c0f9b07c",
3497
+ * "QueueName": "custom123"
3498
+ * });
2629
3499
  */
2630
3500
  CancelServerBackfillTicket(request: CancelServerBackfillTicketRequest, extraHeaders?: Record<string, string>): Promise<CancelServerBackfillTicketResult>;
3501
+ /**
3502
+ * Create a base model with default settings.
3503
+ *
3504
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/createbasemodel Microsoft Documentation}
3505
+ * @example
3506
+ * await trueskillClient.CreateBaseModel({
3507
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
3508
+ * "ModelName": "Test Batch Model",
3509
+ * "Conditions": [
3510
+ * {
3511
+ * "Key": "Platform",
3512
+ * "Rank": 2
3513
+ * },
3514
+ * {
3515
+ * "Key": "GameMode",
3516
+ * "Rank": 1
3517
+ * }
3518
+ * ]
3519
+ * });
3520
+ */
3521
+ CreateBaseModel(request: CreateBaseModelRequest, extraHeaders?: Record<string, string>): Promise<CreateBaseModelResponse>;
3522
+ /**
3523
+ * Creates a batch model that is learned from a title's match results in a scenario.
3524
+ *
3525
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/createbatchmodel Microsoft Documentation}
3526
+ * @example
3527
+ * await trueskillClient.CreateBatchModel({
3528
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
3529
+ * "ModelName": "Test Batch Model",
3530
+ * "Conditions": [
3531
+ * {
3532
+ * "Key": "Platform",
3533
+ * "Rank": 2
3534
+ * },
3535
+ * {
3536
+ * "Key": "GameMode",
3537
+ * "Rank": 1
3538
+ * }
3539
+ * ],
3540
+ * "Events": [
3541
+ * "Kills",
3542
+ * "Deaths"
3543
+ * ],
3544
+ * "InitialSettingsModelId": "73a2506e-9fd3-4d84-8dd7-570c8e9e02cf",
3545
+ * "MatchResultStartTimeUtc": "2025-05-26T17:12:07.326Z",
3546
+ * "MatchResultEndTimeUtc": "2025-05-26T17:42:07.326Z",
3547
+ * "MaxIterations": 100,
3548
+ * "AnomalousMatchResultIgnoreThreshold": -20.0
3549
+ * });
3550
+ */
3551
+ CreateBatchModel(request: CreateBatchModelRequest, extraHeaders?: Record<string, string>): Promise<CreateBatchModelResponse>;
2631
3552
  /**
2632
3553
  * Creates a multiplayer server build alias.
2633
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createbuildalias
3554
+ *
3555
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/createbuildalias Microsoft Documentation}
3556
+ * @example
3557
+ * await multiplayerserverClient.CreateBuildAlias({
3558
+ * "AliasName": "AliasName",
3559
+ * "BuildSelectionCriteria": [
3560
+ * {
3561
+ * "BuildWeightDistribution": {
3562
+ * "53781fa8-006d-4e9c-b733-57433d579285": 1
3563
+ * }
3564
+ * }
3565
+ * ]
3566
+ * });
2634
3567
  */
2635
3568
  CreateBuildAlias(request: CreateBuildAliasRequest, extraHeaders?: Record<string, string>): Promise<BuildAliasDetailsResponse>;
2636
3569
  /**
2637
3570
  * Creates a multiplayer server build with a custom container.
2638
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createbuildwithcustomcontainer
3571
+ *
3572
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/createbuildwithcustomcontainer Microsoft Documentation}
3573
+ * @example
3574
+ * await multiplayerserverClient.CreateBuildWithCustomContainer({
3575
+ * "ContainerRunCommand": "/data/Assets -startserver",
3576
+ * "GameAssetReferences": [
3577
+ * {
3578
+ * "FileName": "gameserver.zip",
3579
+ * "MountPath": "/data/Assets"
3580
+ * }
3581
+ * ],
3582
+ * "ContainerImageReference": {
3583
+ * "ImageName": "ContainerImageName",
3584
+ * "Tag": "ContainerTag"
3585
+ * },
3586
+ * "LinuxInstrumentationConfiguration": {
3587
+ * "IsEnabled": false
3588
+ * },
3589
+ * "ContainerFlavor": "CustomLinux",
3590
+ * "ServerResourceConstraints": {
3591
+ * "CpuLimit": 0.5,
3592
+ * "MemoryLimitGB": 0.5
3593
+ * },
3594
+ * "BuildName": "GameBuildName",
3595
+ * "Metadata": {
3596
+ * "MetadataKey": "MetadataValue"
3597
+ * },
3598
+ * "VmSize": "Standard_D2_v2",
3599
+ * "MultiplayerServerCountPerVm": 10,
3600
+ * "Ports": [
3601
+ * {
3602
+ * "Name": "PortName",
3603
+ * "Num": 1243,
3604
+ * "Protocol": "TCP"
3605
+ * }
3606
+ * ],
3607
+ * "RegionConfigurations": [
3608
+ * {
3609
+ * "Region": "EastUs",
3610
+ * "MaxServers": 10,
3611
+ * "StandbyServers": 5,
3612
+ * "ScheduledStandbySettings": {
3613
+ * "IsEnabled": true,
3614
+ * "ScheduleList": [
3615
+ * {
3616
+ * "StartTime": "2020-08-21T17:00:00Z",
3617
+ * "EndTime": "2020-08-24T09:00:00Z",
3618
+ * "IsRecurringWeekly": true,
3619
+ * "IsDisabled": false,
3620
+ * "Description": "Weekend Schedule",
3621
+ * "TargetStandby": 8
3622
+ * },
3623
+ * {
3624
+ * "StartTime": "2020-08-24T09:00:00Z",
3625
+ * "EndTime": "2020-08-28T17:00:00Z",
3626
+ * "IsRecurringWeekly": true,
3627
+ * "IsDisabled": false,
3628
+ * "Description": "Weekday Schedule",
3629
+ * "TargetStandby": 3
3630
+ * }
3631
+ * ]
3632
+ * },
3633
+ * "RoutingSettings": {
3634
+ * "NumberOfMicrosoftRoutingIPs": 1,
3635
+ * "NumberOfInternetRoutingIPs": 1,
3636
+ * "DefaultRoutingType": 1
3637
+ * }
3638
+ * },
3639
+ * {
3640
+ * "Region": "WestUs",
3641
+ * "MaxServers": 50,
3642
+ * "StandbyServers": 8,
3643
+ * "ScheduledStandbySettings": {
3644
+ * "IsEnabled": true,
3645
+ * "ScheduleList": [
3646
+ * {
3647
+ * "StartTime": "2020-08-21T09:00:00Z",
3648
+ * "EndTime": "2020-08-21T23:00:00Z",
3649
+ * "IsRecurringWeekly": false,
3650
+ * "IsDisabled": false,
3651
+ * "Description": "Game Launch",
3652
+ * "TargetStandby": 30
3653
+ * }
3654
+ * ]
3655
+ * }
3656
+ * },
3657
+ * {
3658
+ * "Region": "NorthEurope",
3659
+ * "MaxServers": 7,
3660
+ * "StandbyServers": 3
3661
+ * }
3662
+ * ],
3663
+ * "GameCertificateReferences": [
3664
+ * {
3665
+ * "Name": "CertName",
3666
+ * "GsdkAlias": "CertGsdkAlias"
3667
+ * }
3668
+ * ],
3669
+ * "GameSecretReferences": [
3670
+ * {
3671
+ * "Name": "SecretName"
3672
+ * }
3673
+ * ],
3674
+ * "RoutingSettings": {
3675
+ * "NumberOfMicrosoftRoutingIPs": 1,
3676
+ * "NumberOfInternetRoutingIPs": 0,
3677
+ * "DefaultRoutingType": 0
3678
+ * }
3679
+ * });
2639
3680
  */
2640
3681
  CreateBuildWithCustomContainer(request: CreateBuildWithCustomContainerRequest, extraHeaders?: Record<string, string>): Promise<CreateBuildWithCustomContainerResponse>;
2641
3682
  /**
2642
3683
  * Creates a multiplayer server build with a managed container.
2643
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createbuildwithmanagedcontainer
3684
+ *
3685
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/createbuildwithmanagedcontainer Microsoft Documentation}
3686
+ * @example
3687
+ * await multiplayerserverClient.CreateBuildWithManagedContainer({
3688
+ * "StartMultiplayerServerCommand": "gameserver.exe -startserver",
3689
+ * "GameAssetReferences": [
3690
+ * {
3691
+ * "FileName": "gameserver.zip",
3692
+ * "MountPath": "C:\\Asset\\"
3693
+ * }
3694
+ * ],
3695
+ * "InstrumentationConfiguration": {
3696
+ * "ProcessesToMonitor": [
3697
+ * "GameServerProcessName"
3698
+ * ],
3699
+ * "IsEnabled": true
3700
+ * },
3701
+ * "GameWorkingDirectory": "C:\\Assets",
3702
+ * "ContainerFlavor": "ManagedWindowsServerCore",
3703
+ * "ServerResourceConstraints": {
3704
+ * "CpuLimit": 0.5,
3705
+ * "MemoryLimitGB": 0.5
3706
+ * },
3707
+ * "BuildName": "GameBuildName",
3708
+ * "Metadata": {
3709
+ * "MetadataKey": "MetadataValue"
3710
+ * },
3711
+ * "VmSize": "Standard_D2_v2",
3712
+ * "MultiplayerServerCountPerVm": 10,
3713
+ * "Ports": [
3714
+ * {
3715
+ * "Name": "PortName",
3716
+ * "Num": 1243,
3717
+ * "Protocol": "TCP"
3718
+ * }
3719
+ * ],
3720
+ * "RegionConfigurations": [
3721
+ * {
3722
+ * "Region": "EastUs",
3723
+ * "MaxServers": 10,
3724
+ * "StandbyServers": 5,
3725
+ * "ScheduledStandbySettings": {
3726
+ * "IsEnabled": true,
3727
+ * "ScheduleList": [
3728
+ * {
3729
+ * "StartTime": "2020-08-21T17:00:00Z",
3730
+ * "EndTime": "2020-08-24T09:00:00Z",
3731
+ * "IsRecurringWeekly": true,
3732
+ * "IsDisabled": false,
3733
+ * "Description": "Weekend Schedule",
3734
+ * "TargetStandby": 8
3735
+ * },
3736
+ * {
3737
+ * "StartTime": "2020-08-24T09:00:00Z",
3738
+ * "EndTime": "2020-08-28T17:00:00Z",
3739
+ * "IsRecurringWeekly": true,
3740
+ * "IsDisabled": false,
3741
+ * "Description": "Weekday Schedule",
3742
+ * "TargetStandby": 3
3743
+ * }
3744
+ * ]
3745
+ * }
3746
+ * },
3747
+ * {
3748
+ * "Region": "WestUs",
3749
+ * "MaxServers": 50,
3750
+ * "StandbyServers": 8,
3751
+ * "ScheduledStandbySettings": {
3752
+ * "IsEnabled": true,
3753
+ * "ScheduleList": [
3754
+ * {
3755
+ * "StartTime": "2020-08-21T09:00:00Z",
3756
+ * "EndTime": "2020-08-21T23:00:00Z",
3757
+ * "IsRecurringWeekly": false,
3758
+ * "IsDisabled": false,
3759
+ * "Description": "Game Launch",
3760
+ * "TargetStandby": 30
3761
+ * }
3762
+ * ]
3763
+ * }
3764
+ * },
3765
+ * {
3766
+ * "Region": "NorthEurope",
3767
+ * "MaxServers": 7,
3768
+ * "StandbyServers": 3
3769
+ * }
3770
+ * ],
3771
+ * "GameCertificateReferences": [
3772
+ * {
3773
+ * "Name": "CertName",
3774
+ * "GsdkAlias": "CertGsdkAlias"
3775
+ * }
3776
+ * ],
3777
+ * "GameSecretReferences": [
3778
+ * {
3779
+ * "Name": "SecretName"
3780
+ * }
3781
+ * ]
3782
+ * });
2644
3783
  */
2645
3784
  CreateBuildWithManagedContainer(request: CreateBuildWithManagedContainerRequest, extraHeaders?: Record<string, string>): Promise<CreateBuildWithManagedContainerResponse>;
2646
3785
  /**
2647
3786
  * Creates a multiplayer server build with the server running as a process.
2648
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createbuildwithprocessbasedserver
3787
+ *
3788
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/createbuildwithprocessbasedserver Microsoft Documentation}
3789
+ * @example
3790
+ * await multiplayerserverClient.CreateBuildWithProcessBasedServer({
3791
+ * "OsPlatform": "Windows",
3792
+ * "GameAssetReferences": [
3793
+ * {
3794
+ * "FileName": "game.zip"
3795
+ * }
3796
+ * ],
3797
+ * "StartMultiplayerServerCommand": "gameserver.exe -startserver",
3798
+ * "InstrumentationConfiguration": {
3799
+ * "ProcessesToMonitor": [
3800
+ * "GameServerProcessName"
3801
+ * ],
3802
+ * "IsEnabled": true
3803
+ * },
3804
+ * "GameWorkingDirectory": "C:\\Assets",
3805
+ * "IsOSPreview": false,
3806
+ * "VmSize": "Standard_D2_v2",
3807
+ * "MultiplayerServerCountPerVm": 10,
3808
+ * "Ports": [
3809
+ * {
3810
+ * "Name": "PortName",
3811
+ * "Num": 1243,
3812
+ * "Protocol": "TCP"
3813
+ * }
3814
+ * ],
3815
+ * "RegionConfigurations": [
3816
+ * {
3817
+ * "Region": "EastUs",
3818
+ * "MaxServers": 10,
3819
+ * "StandbyServers": 5
3820
+ * },
3821
+ * {
3822
+ * "Region": "WestUs",
3823
+ * "MaxServers": 12,
3824
+ * "StandbyServers": 8
3825
+ * },
3826
+ * {
3827
+ * "Region": "NorthEurope",
3828
+ * "MaxServers": 7,
3829
+ * "StandbyServers": 3
3830
+ * }
3831
+ * ],
3832
+ * "GameCertificateReferences": [
3833
+ * {
3834
+ * "Name": "CertName",
3835
+ * "GsdkAlias": "CertGsdkAlias"
3836
+ * }
3837
+ * ],
3838
+ * "GameSecretReferences": [
3839
+ * {
3840
+ * "Name": "SecretName"
3841
+ * }
3842
+ * ]
3843
+ * });
2649
3844
  */
2650
3845
  CreateBuildWithProcessBasedServer(request: CreateBuildWithProcessBasedServerRequest, extraHeaders?: Record<string, string>): Promise<CreateBuildWithProcessBasedServerResponse>;
2651
3846
  /**
2652
3847
  * Create a lobby.
2653
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/createlobby
3848
+ *
3849
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/createlobby Microsoft Documentation}
3850
+ * @example
3851
+ * await lobbyClient.CreateLobby({
3852
+ * "MaxPlayers": 50,
3853
+ * "Owner": {
3854
+ * "Id": "1234",
3855
+ * "Type": "title_player_account",
3856
+ * "TypeString": "title_player_account"
3857
+ * },
3858
+ * "OwnerMigrationPolicy": "Automatic",
3859
+ * "UseConnections": true,
3860
+ * "AccessPolicy": "Public",
3861
+ * "SearchData": {
3862
+ * "string_key1": "searchable value"
3863
+ * },
3864
+ * "LobbyData": {
3865
+ * "MyGameKey": "MyGameKey value"
3866
+ * },
3867
+ * "Members": [
3868
+ * {
3869
+ * "MemberEntity": {
3870
+ * "Id": "1234",
3871
+ * "Type": "title_player_account",
3872
+ * "TypeString": "title_player_account"
3873
+ * }
3874
+ * }
3875
+ * ],
3876
+ * "RestrictInvitesToLobbyOwner": false
3877
+ * });
2654
3878
  */
2655
3879
  CreateLobby(request: CreateLobbyRequest, extraHeaders?: Record<string, string>): Promise<CreateLobbyResult>;
2656
3880
  /**
2657
3881
  * Create a matchmaking ticket as a client.
2658
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/creatematchmakingticket
3882
+ *
3883
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/creatematchmakingticket Microsoft Documentation}
3884
+ * @example
3885
+ * await matchClient.CreateMatchmakingTicket({
3886
+ * "Creator": {},
3887
+ * "MembersToMatchWith": [],
3888
+ * "GiveUpAfterSeconds": 100,
3889
+ * "QueueName": "custom123"
3890
+ * });
2659
3891
  */
2660
3892
  CreateMatchmakingTicket(request: CreateMatchmakingTicketRequest, extraHeaders?: Record<string, string>): Promise<CreateMatchmakingTicketResult>;
2661
3893
  /**
2662
3894
  * Creates a remote user to log on to a VM for a multiplayer server build.
2663
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createremoteuser
3895
+ *
3896
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/createremoteuser Microsoft Documentation}
3897
+ * @example
3898
+ * await multiplayerserverClient.CreateRemoteUser({
3899
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
3900
+ * "Region": "SouthCentralUs",
3901
+ * "VmId": "VmID1",
3902
+ * "Username": "AUsername",
3903
+ * "ExpirationTime": "2014-04-07T09:04:28Z"
3904
+ * });
2664
3905
  */
2665
3906
  CreateRemoteUser(request: CreateRemoteUserRequest, extraHeaders?: Record<string, string>): Promise<CreateRemoteUserResponse>;
3907
+ /**
3908
+ * Create a scenario to specify which conditions, conditions values and events will be allowed when submitting match
3909
+ * results.
3910
+ *
3911
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/createscenario Microsoft Documentation}
3912
+ * @example
3913
+ * await trueskillClient.CreateScenario({
3914
+ * "Name": "Test Scenario",
3915
+ * "Conditions": [
3916
+ * {
3917
+ * "Key": "Platform",
3918
+ * "Values": [
3919
+ * "PC",
3920
+ * "Xbox"
3921
+ * ]
3922
+ * },
3923
+ * {
3924
+ * "Key": "GameMode",
3925
+ * "Values": [
3926
+ * "TeamDeathMatch",
3927
+ * "CaptureTheFlag"
3928
+ * ]
3929
+ * }
3930
+ * ],
3931
+ * "Events": [
3932
+ * "Kills",
3933
+ * "Deaths"
3934
+ * ]
3935
+ * });
3936
+ */
3937
+ CreateScenario(request: CreateScenarioRequest, extraHeaders?: Record<string, string>): Promise<CreateScenarioResponse>;
2666
3938
  /**
2667
3939
  * Create a backfill matchmaking ticket as a server. A backfill ticket represents an ongoing game. The matchmaking service
2668
3940
  * automatically starts matching the backfill ticket against other matchmaking tickets. Backfill tickets cannot match with
2669
3941
  * other backfill tickets.
2670
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/createserverbackfillticket
3942
+ *
3943
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/createserverbackfillticket Microsoft Documentation}
3944
+ * @example
3945
+ * await matchClient.CreateServerBackfillTicket({
3946
+ * "Members": [],
3947
+ * "GiveUpAfterSeconds": 100,
3948
+ * "ServerDetails": {
3949
+ * "IPV4Address": "10.250.24.54",
3950
+ * "Ports": [
3951
+ * {
3952
+ * "Name": "PortName",
3953
+ * "Num": 1243,
3954
+ * "Protocol": "TCP"
3955
+ * }
3956
+ * ],
3957
+ * "Region": "WestUS",
3958
+ * "Fqdn": "vm.azure.cloudapp.net",
3959
+ * "ServerId": "359e4634-7c8f-4d44-87a5-f3a876aac6c0"
3960
+ * },
3961
+ * "QueueName": "custom123"
3962
+ * });
2671
3963
  */
2672
3964
  CreateServerBackfillTicket(request: CreateServerBackfillTicketRequest, extraHeaders?: Record<string, string>): Promise<CreateServerBackfillTicketResult>;
2673
3965
  /**
2674
3966
  * Create a matchmaking ticket as a server. The matchmaking service automatically starts matching the ticket against other
2675
3967
  * matchmaking tickets.
2676
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/createservermatchmakingticket
3968
+ *
3969
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/createservermatchmakingticket Microsoft Documentation}
3970
+ * @example
3971
+ * await matchClient.CreateServerMatchmakingTicket({
3972
+ * "Members": [
3973
+ * null
3974
+ * ],
3975
+ * "GiveUpAfterSeconds": 100,
3976
+ * "QueueName": "custom123"
3977
+ * });
2677
3978
  */
2678
3979
  CreateServerMatchmakingTicket(request: CreateServerMatchmakingTicketRequest, extraHeaders?: Record<string, string>): Promise<CreateMatchmakingTicketResult>;
2679
3980
  /**
2680
3981
  * Creates a request to change a title's multiplayer server quotas.
2681
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createtitlemultiplayerserversquotachange
3982
+ *
3983
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/createtitlemultiplayerserversquotachange Microsoft Documentation}
3984
+ * @example
3985
+ * await multiplayerserverClient.CreateTitleMultiplayerServersQuotaChange({
3986
+ * "ContactEmail": "john@mygamestudio.com",
3987
+ * "StartDate": "2020-01-23T00:00:00Z",
3988
+ * "ChangeDescription": "Season 3 Launch",
3989
+ * "Notes": "Based on the last launch, we expect 1 trillion active users.",
3990
+ * "Changes": [
3991
+ * {
3992
+ * "VmFamily": "Dasv4",
3993
+ * "Region": "EastUs",
3994
+ * "NewCoreLimit": 55000
3995
+ * },
3996
+ * {
3997
+ * "VmFamily": "Dasv4",
3998
+ * "Region": "NorthCentralUs",
3999
+ * "NewCoreLimit": 65000
4000
+ * }
4001
+ * ]
4002
+ * });
2682
4003
  */
2683
4004
  CreateTitleMultiplayerServersQuotaChange(request: CreateTitleMultiplayerServersQuotaChangeRequest, extraHeaders?: Record<string, string>): Promise<CreateTitleMultiplayerServersQuotaChangeResponse>;
4005
+ /**
4006
+ * Switch a model's state from Active to Deactivated.
4007
+ *
4008
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/deactivatemodel Microsoft Documentation}
4009
+ * @example
4010
+ * await trueskillClient.DeactivateModel({
4011
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
4012
+ * "ModelId": "73a2506e-9fd3-4d84-8dd7-570c8e9e02cf"
4013
+ * });
4014
+ */
4015
+ DeactivateModel(request: DeactivateModelRequest, extraHeaders?: Record<string, string>): Promise<DeactivateModelResponse>;
2684
4016
  /**
2685
4017
  * Deletes a multiplayer server game asset for a title.
2686
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deleteasset
4018
+ *
4019
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/deleteasset Microsoft Documentation}
4020
+ * @example
4021
+ * await multiplayerserverClient.DeleteAsset({
4022
+ * "FileName": "gameserver.zip"
4023
+ * });
2687
4024
  */
2688
4025
  DeleteAsset(request: DeleteAssetRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2689
4026
  /**
2690
4027
  * Deletes a multiplayer server build.
2691
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletebuild
4028
+ *
4029
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/deletebuild Microsoft Documentation}
4030
+ * @example
4031
+ * await multiplayerserverClient.DeleteBuild({
4032
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285"
4033
+ * });
2692
4034
  */
2693
4035
  DeleteBuild(request: DeleteBuildRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2694
4036
  /**
2695
4037
  * Deletes a multiplayer server build alias.
2696
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletebuildalias
4038
+ *
4039
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/deletebuildalias Microsoft Documentation}
4040
+ * @example
4041
+ * await multiplayerserverClient.DeleteBuildAlias({
4042
+ * "AliasId": "21781fa8-096d-4d9c-b699-75433d579285"
4043
+ * });
2697
4044
  */
2698
4045
  DeleteBuildAlias(request: DeleteBuildAliasRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2699
4046
  /**
2700
4047
  * Removes a multiplayer server build's region.
2701
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletebuildregion
4048
+ *
4049
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/deletebuildregion Microsoft Documentation}
4050
+ * @example
4051
+ * await multiplayerserverClient.DeleteBuildRegion({
4052
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
4053
+ * "Region": "JapanEast"
4054
+ * });
2702
4055
  */
2703
4056
  DeleteBuildRegion(request: DeleteBuildRegionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2704
4057
  /**
2705
4058
  * Deletes a multiplayer server game certificate.
2706
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletecertificate
4059
+ *
4060
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/deletecertificate Microsoft Documentation}
4061
+ * @example
4062
+ * await multiplayerserverClient.DeleteCertificate({
4063
+ * "Name": "GameCertificate1"
4064
+ * });
2707
4065
  */
2708
4066
  DeleteCertificate(request: DeleteCertificateRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2709
4067
  /**
2710
4068
  * Deletes a container image repository.
2711
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletecontainerimagerepository
4069
+ *
4070
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/deletecontainerimagerepository Microsoft Documentation}
4071
+ * @example
4072
+ * await multiplayerserverClient.DeleteContainerImageRepository({
4073
+ * "ImageName": "imageName1"
4074
+ * });
2712
4075
  */
2713
4076
  DeleteContainerImageRepository(request: DeleteContainerImageRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2714
4077
  /**
2715
4078
  * Delete a lobby.
2716
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/deletelobby
4079
+ *
4080
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/deletelobby Microsoft Documentation}
4081
+ * @example
4082
+ * await lobbyClient.DeleteLobby({
4083
+ * "LobbyId": "12345678-1234-1234-1234-123456789ABC"
4084
+ * });
2717
4085
  */
2718
4086
  DeleteLobby(request: DeleteLobbyRequest, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
4087
+ /**
4088
+ * Delete a model.
4089
+ *
4090
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/deletemodel Microsoft Documentation}
4091
+ * @example
4092
+ * await trueskillClient.DeleteModel({
4093
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
4094
+ * "ModelId": "73a2506e-9fd3-4d84-8dd7-570c8e9e02cf"
4095
+ * });
4096
+ */
4097
+ DeleteModel(request: DeleteModelRequest, extraHeaders?: Record<string, string>): Promise<DeleteModelResponse>;
2719
4098
  /**
2720
4099
  * Deletes a remote user to log on to a VM for a multiplayer server build.
2721
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deleteremoteuser
4100
+ *
4101
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/deleteremoteuser Microsoft Documentation}
4102
+ * @example
4103
+ * await multiplayerserverClient.DeleteRemoteUser({
4104
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
4105
+ * "Region": "SouthCentralUs",
4106
+ * "VmId": "VmID1",
4107
+ * "Username": "AUsername"
4108
+ * });
2722
4109
  */
2723
4110
  DeleteRemoteUser(request: DeleteRemoteUserRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4111
+ /**
4112
+ * Delete a scenario.
4113
+ *
4114
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/deletescenario Microsoft Documentation}
4115
+ * @example
4116
+ * await trueskillClient.DeleteScenario({
4117
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
4118
+ * "ForceDelete": true
4119
+ * });
4120
+ */
4121
+ DeleteScenario(request: DeleteScenarioRequest, extraHeaders?: Record<string, string>): Promise<DeleteScenarioResponse>;
2724
4122
  /**
2725
4123
  * Deletes a multiplayer server game secret.
2726
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletesecret
4124
+ *
4125
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/deletesecret Microsoft Documentation}
4126
+ * @example
4127
+ * await multiplayerserverClient.DeleteSecret({
4128
+ * "Name": "GameSecret1"
4129
+ * });
2727
4130
  */
2728
4131
  DeleteSecret(request: DeleteSecretRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2729
4132
  /**
2730
4133
  * Enables the multiplayer server feature for a title.
2731
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/enablemultiplayerserversfortitle
4134
+ *
4135
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/enablemultiplayerserversfortitle Microsoft Documentation}
4136
+ * @example
4137
+ * await multiplayerserverClient.EnableMultiplayerServersForTitle({});
2732
4138
  */
2733
4139
  EnableMultiplayerServersForTitle(request: EnableMultiplayerServersForTitleRequest, extraHeaders?: Record<string, string>): Promise<EnableMultiplayerServersForTitleResponse>;
4140
+ /**
4141
+ * Enables the parties feature for a title.
4142
+ *
4143
+ * {@link https://docs.microsoft.com/rest/api/playfab/party/multiplayerserver/enablepartiesfortitle Microsoft Documentation}
4144
+ * @example
4145
+ * await partyClient.EnablePartiesForTitle({});
4146
+ */
4147
+ EnablePartiesForTitle(request: EnablePartiesForTitleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2734
4148
  /**
2735
4149
  * Find lobbies which match certain criteria, and which friends are in.
2736
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/findfriendlobbies
4150
+ *
4151
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/findfriendlobbies Microsoft Documentation}
4152
+ * @example
4153
+ * await lobbyClient.FindFriendLobbies({
4154
+ * "Filter": "string_key1 eq 'Wizard' and number_key5 gt 5",
4155
+ * "OrderBy": "number_key5 desc",
4156
+ * "ExternalPlatformFriends": "Xbox",
4157
+ * "XboxToken": "XBOXTOKEN",
4158
+ * "Pagination": {
4159
+ * "ContinuationToken": "",
4160
+ * "PageSizeRequested": 20
4161
+ * }
4162
+ * });
2737
4163
  */
2738
4164
  FindFriendLobbies(request: FindFriendLobbiesRequest, extraHeaders?: Record<string, string>): Promise<FindFriendLobbiesResult>;
2739
4165
  /**
2740
4166
  * Find all the lobbies that match certain criteria.
2741
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/findlobbies
4167
+ *
4168
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/findlobbies Microsoft Documentation}
4169
+ * @example
4170
+ * await lobbyClient.FindLobbies({
4171
+ * "Filter": "string_key1 eq 'Wizard' and number_key5 gt 5",
4172
+ * "OrderBy": "number_key5 desc",
4173
+ * "Pagination": {
4174
+ * "ContinuationToken": "",
4175
+ * "PageSizeRequested": 20
4176
+ * }
4177
+ * });
2742
4178
  */
2743
4179
  FindLobbies(request: FindLobbiesRequest, extraHeaders?: Record<string, string>): Promise<FindLobbiesResult>;
2744
4180
  /**
2745
4181
  * Gets a URL that can be used to download the specified asset. A sample pre-authenticated url -
2746
4182
  * https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05&ss=b&srt=sco&sp=rw&st=startDate&se=endDate&spr=https&sig=sampleSig&api-version=2017-07-29
2747
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getassetdownloadurl
4183
+ *
4184
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/getassetdownloadurl Microsoft Documentation}
4185
+ * @example
4186
+ * await multiplayerserverClient.GetAssetDownloadUrl({
4187
+ * "FileName": "gameserver.zip"
4188
+ * });
2748
4189
  */
2749
4190
  GetAssetDownloadUrl(request: GetAssetDownloadUrlRequest, extraHeaders?: Record<string, string>): Promise<GetAssetDownloadUrlResponse>;
2750
4191
  /**
2751
4192
  * Gets the URL to upload assets to. A sample pre-authenticated url -
2752
4193
  * https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05&ss=b&srt=sco&sp=rw&st=startDate&se=endDate&spr=https&sig=sampleSig&api-version=2017-07-29
2753
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getassetuploadurl
4194
+ *
4195
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/getassetuploadurl Microsoft Documentation}
4196
+ * @example
4197
+ * await multiplayerserverClient.GetAssetUploadUrl({
4198
+ * "FileName": "gameserver.zip"
4199
+ * });
2754
4200
  */
2755
4201
  GetAssetUploadUrl(request: GetAssetUploadUrlRequest, extraHeaders?: Record<string, string>): Promise<GetAssetUploadUrlResponse>;
2756
4202
  /**
2757
4203
  * Gets a multiplayer server build.
2758
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getbuild
4204
+ *
4205
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/getbuild Microsoft Documentation}
4206
+ * @example
4207
+ * await multiplayerserverClient.GetBuild({
4208
+ * "BuildId": "53781fa8-006d-4e9c-b733-57433d579285"
4209
+ * });
2759
4210
  */
2760
4211
  GetBuild(request: GetBuildRequest, extraHeaders?: Record<string, string>): Promise<GetBuildResponse>;
2761
4212
  /**
2762
4213
  * Gets a multiplayer server build alias.
2763
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getbuildalias
4214
+ *
4215
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/getbuildalias Microsoft Documentation}
4216
+ * @example
4217
+ * await multiplayerserverClient.GetBuildAlias({
4218
+ * "AliasId": "21781fa8-096d-4d9c-b699-75433d579285"
4219
+ * });
2764
4220
  */
2765
4221
  GetBuildAlias(request: GetBuildAliasRequest, extraHeaders?: Record<string, string>): Promise<BuildAliasDetailsResponse>;
4222
+ /**
4223
+ * Gets supported locales for the cognitive services based on the specified service type.
4224
+ *
4225
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/getcognitiveserviceslocales Microsoft Documentation}
4226
+ * @example
4227
+ * await multiplayerserverClient.GetCognitiveServicesLocales({
4228
+ * "CognitiveServicesType": "SpeechToText",
4229
+ * "Region": "WestUs"
4230
+ * });
4231
+ */
4232
+ GetCognitiveServicesLocales(request: GetCognitiveServicesLocalesRequest, extraHeaders?: Record<string, string>): Promise<GetCognitiveServicesLocalesResponse>;
4233
+ /**
4234
+ * Gets a token for the cognitive services based on the specified service type.
4235
+ *
4236
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/getcognitiveservicestoken Microsoft Documentation}
4237
+ * @example
4238
+ * await multiplayerserverClient.GetCognitiveServicesToken({
4239
+ * "CognitiveServicesType": "SpeechToText",
4240
+ * "Region": "AustraliaEast"
4241
+ * });
4242
+ */
4243
+ GetCognitiveServicesToken(request: GetCognitiveServicesTokenRequest, extraHeaders?: Record<string, string>): Promise<GetCognitiveServicesTokenResponse>;
2766
4244
  /**
2767
4245
  * Gets the credentials to the container registry.
2768
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getcontainerregistrycredentials
4246
+ *
4247
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/getcontainerregistrycredentials Microsoft Documentation}
4248
+ * @example
4249
+ * await multiplayerserverClient.GetContainerRegistryCredentials({});
2769
4250
  */
2770
4251
  GetContainerRegistryCredentials(request: GetContainerRegistryCredentialsRequest, extraHeaders?: Record<string, string>): Promise<GetContainerRegistryCredentialsResponse>;
2771
4252
  /**
2772
4253
  * Get a lobby.
2773
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/getlobby
4254
+ *
4255
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/getlobby Microsoft Documentation}
4256
+ * @example
4257
+ * await lobbyClient.GetLobby({
4258
+ * "LobbyId": "12345678-1234-1234-1234-123456789ABC"
4259
+ * });
2774
4260
  */
2775
4261
  GetLobby(request: GetLobbyRequest, extraHeaders?: Record<string, string>): Promise<GetLobbyResult>;
2776
4262
  /**
2777
4263
  * Get a match.
2778
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/getmatch
4264
+ *
4265
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/getmatch Microsoft Documentation}
4266
+ * @example
4267
+ * await matchClient.GetMatch({
4268
+ * "MatchId": "4e0c5fd7-80e9-4744-b0ce-061a7f067ff5",
4269
+ * "QueueName": "custom123",
4270
+ * "EscapeObject": false,
4271
+ * "ReturnMemberAttributes": false
4272
+ * });
2779
4273
  */
2780
4274
  GetMatch(request: GetMatchRequest, extraHeaders?: Record<string, string>): Promise<GetMatchResult>;
2781
4275
  /**
2782
4276
  * SDK support is limited to C# and Java for this API. Get a matchmaking queue configuration.
2783
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking-admin/getmatchmakingqueue
4277
+ *
4278
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking-admin/getmatchmakingqueue Microsoft Documentation}
4279
+ * @example
4280
+ * await matchClient.GetMatchmakingQueue({
4281
+ * "QueueName": "custom123"
4282
+ * });
2784
4283
  */
2785
4284
  GetMatchmakingQueue(request: GetMatchmakingQueueRequest, extraHeaders?: Record<string, string>): Promise<GetMatchmakingQueueResult>;
2786
4285
  /**
2787
4286
  * Get a matchmaking ticket by ticket Id.
2788
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/getmatchmakingticket
4287
+ *
4288
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/getmatchmakingticket Microsoft Documentation}
4289
+ * @example
4290
+ * await matchClient.GetMatchmakingTicket({
4291
+ * "TicketId": "1c4b0daa-150e-47ae-9923-d770c0f9b07c",
4292
+ * "QueueName": "custom123",
4293
+ * "EscapeObject": false
4294
+ * });
2789
4295
  */
2790
4296
  GetMatchmakingTicket(request: GetMatchmakingTicketRequest, extraHeaders?: Record<string, string>): Promise<GetMatchmakingTicketResult>;
4297
+ /**
4298
+ * Gets the details of a Model.
4299
+ *
4300
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/getmodeldetails Microsoft Documentation}
4301
+ * @example
4302
+ * await trueskillClient.GetModelDetails({
4303
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
4304
+ * "ModelId": "73a2506e-9fd3-4d84-8dd7-570c8e9e02cf"
4305
+ * });
4306
+ */
4307
+ GetModelDetails(request: GetModelDetailsRequest, extraHeaders?: Record<string, string>): Promise<GetModelDetailsResponse>;
4308
+ /**
4309
+ * Get all of the models assigned to a specific scenario.
4310
+ *
4311
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/getmodelsbyscenario Microsoft Documentation}
4312
+ * @example
4313
+ * await trueskillClient.GetModelsByScenario({
4314
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d"
4315
+ * });
4316
+ */
4317
+ GetModelsByScenario(request: GetModelsByScenarioRequest, extraHeaders?: Record<string, string>): Promise<GetModelsByScenarioResponse>;
4318
+ /**
4319
+ * Gets multiplayer server session details and associated user connection tokens for a build.
4320
+ *
4321
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/getmultiplayerserverandtoken Microsoft Documentation}
4322
+ * @example
4323
+ * await multiplayerserverClient.GetMultiplayerServerAndToken({
4324
+ * "TokenPlayerIds": [
4325
+ * "User1",
4326
+ * "User2"
4327
+ * ],
4328
+ * "SessionId": "02bdef0e-e01e-4b29-8efe-ff9f47a06d8c"
4329
+ * });
4330
+ */
4331
+ GetMultiplayerServerAndToken(request: GetMultiplayerServerAndTokenRequest, extraHeaders?: Record<string, string>): Promise<GetMultiplayerServerAndTokenResponse>;
2791
4332
  /**
2792
4333
  * Gets multiplayer server session details for a build.
2793
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getmultiplayerserverdetails
4334
+ *
4335
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/getmultiplayerserverdetails Microsoft Documentation}
4336
+ * @example
4337
+ * await multiplayerserverClient.GetMultiplayerServerDetails({
4338
+ * "SessionId": "02bdef0e-e01e-4b29-8efe-ff9f47a06d8c"
4339
+ * });
2794
4340
  */
2795
4341
  GetMultiplayerServerDetails(request: GetMultiplayerServerDetailsRequest, extraHeaders?: Record<string, string>): Promise<GetMultiplayerServerDetailsResponse>;
2796
4342
  /**
2797
4343
  * Gets multiplayer server logs after a server has terminated.
2798
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getmultiplayerserverlogs
4344
+ *
4345
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/getmultiplayerserverlogs Microsoft Documentation}
4346
+ * @example
4347
+ * await multiplayerserverClient.GetMultiplayerServerLogs({
4348
+ * "Region": "AustraliaEast",
4349
+ * "ServerId": "SomeServerId"
4350
+ * });
2799
4351
  */
2800
4352
  GetMultiplayerServerLogs(request: GetMultiplayerServerLogsRequest, extraHeaders?: Record<string, string>): Promise<GetMultiplayerServerLogsResponse>;
2801
4353
  /**
2802
4354
  * Gets multiplayer server logs after a server has terminated.
2803
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getmultiplayersessionlogsbysessionid
4355
+ *
4356
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/getmultiplayersessionlogsbysessionid Microsoft Documentation}
4357
+ * @example
4358
+ * await multiplayerserverClient.GetMultiplayerSessionLogsBySessionId({
4359
+ * "SessionId": "92e29db9-4004-4349-9a1f-b70ac01bdc08"
4360
+ * });
2804
4361
  */
2805
4362
  GetMultiplayerSessionLogsBySessionId(request: GetMultiplayerSessionLogsBySessionIdRequest, extraHeaders?: Record<string, string>): Promise<GetMultiplayerServerLogsResponse>;
4363
+ /**
4364
+ * Gets skill values of a set of players from the primary model of a given scenario.
4365
+ *
4366
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill/getplayerskill Microsoft Documentation}
4367
+ * @example
4368
+ * await trueskillClient.GetPlayerSkill({
4369
+ * "Conditions": {
4370
+ * "Platform": "Xbox",
4371
+ * "Mode": "Deathmatch"
4372
+ * },
4373
+ * "Players": [
4374
+ * {
4375
+ * "Entity": {
4376
+ * "Id": "1234",
4377
+ * "Type": "title_player_account",
4378
+ * "TypeString": "title_player_account"
4379
+ * }
4380
+ * },
4381
+ * {
4382
+ * "Entity": {
4383
+ * "Id": "5678",
4384
+ * "Type": "title_player_account",
4385
+ * "TypeString": "title_player_account"
4386
+ * },
4387
+ * "SquadSize": 2
4388
+ * }
4389
+ * ],
4390
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
4391
+ * "IncludeSkillBreakdown": true
4392
+ * });
4393
+ */
4394
+ GetPlayerSkill(request: GetPlayerSkillRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSkillResponse>;
4395
+ /**
4396
+ * Gets skill values of a set of players for multiple sets of conditions from the primary model of a given scenario.
4397
+ *
4398
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill/getplayerskillforconditions Microsoft Documentation}
4399
+ * @example
4400
+ * await trueskillClient.GetPlayerSkillForConditions({
4401
+ * "Conditions": [
4402
+ * {
4403
+ * "Conditions": {
4404
+ * "Platform": "Xbox",
4405
+ * "Mode": "Deathmatch"
4406
+ * }
4407
+ * },
4408
+ * {
4409
+ * "Conditions": {
4410
+ * "Platform": "Xbox",
4411
+ * "Mode": "Guardian"
4412
+ * }
4413
+ * }
4414
+ * ],
4415
+ * "Players": [
4416
+ * {
4417
+ * "Entity": {
4418
+ * "Id": "1234",
4419
+ * "Type": "title_player_account",
4420
+ * "TypeString": "title_player_account"
4421
+ * }
4422
+ * },
4423
+ * {
4424
+ * "Entity": {
4425
+ * "Id": "5678",
4426
+ * "Type": "title_player_account",
4427
+ * "TypeString": "title_player_account"
4428
+ * },
4429
+ * "SquadSize": 2
4430
+ * }
4431
+ * ],
4432
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
4433
+ * "IncludeSkillBreakdown": true
4434
+ * });
4435
+ */
4436
+ GetPlayerSkillForConditions(request: GetPlayerSkillForConditionsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSkillForConditionsResponse>;
4437
+ /**
4438
+ * Gets skill values of a set of players for multiple sets of conditions from a specific model.
4439
+ *
4440
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill/getplayerskillforconditionsfrommodel Microsoft Documentation}
4441
+ * @example
4442
+ * await trueskillClient.GetPlayerSkillForConditionsFromModel({
4443
+ * "ModelId": "73a2506e-9fd3-4d84-8dd7-570c8e9e02cf",
4444
+ * "Conditions": [
4445
+ * {
4446
+ * "Conditions": {
4447
+ * "Platform": "Xbox",
4448
+ * "Mode": "Deathmatch"
4449
+ * }
4450
+ * },
4451
+ * {
4452
+ * "Conditions": {
4453
+ * "Platform": "Xbox",
4454
+ * "Mode": "Guardian"
4455
+ * }
4456
+ * }
4457
+ * ],
4458
+ * "Players": [
4459
+ * {
4460
+ * "Entity": {
4461
+ * "Id": "1234",
4462
+ * "Type": "title_player_account",
4463
+ * "TypeString": "title_player_account"
4464
+ * }
4465
+ * },
4466
+ * {
4467
+ * "Entity": {
4468
+ * "Id": "5678",
4469
+ * "Type": "title_player_account",
4470
+ * "TypeString": "title_player_account"
4471
+ * },
4472
+ * "SquadSize": 2
4473
+ * }
4474
+ * ],
4475
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
4476
+ * "IncludeSkillBreakdown": true
4477
+ * });
4478
+ */
4479
+ GetPlayerSkillForConditionsFromModel(request: GetPlayerSkillForConditionsFromModelRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSkillForConditionsFromModelResponse>;
4480
+ /**
4481
+ * Gets skill values of a set of players from a specific model.
4482
+ *
4483
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill/getplayerskillfrommodel Microsoft Documentation}
4484
+ * @example
4485
+ * await trueskillClient.GetPlayerSkillFromModel({
4486
+ * "ModelId": "73a2506e-9fd3-4d84-8dd7-570c8e9e02cf",
4487
+ * "Conditions": {
4488
+ * "Platform": "Xbox",
4489
+ * "Mode": "Deathmatch"
4490
+ * },
4491
+ * "Players": [
4492
+ * {
4493
+ * "Entity": {
4494
+ * "Id": "1234",
4495
+ * "Type": "title_player_account",
4496
+ * "TypeString": "title_player_account"
4497
+ * }
4498
+ * },
4499
+ * {
4500
+ * "Entity": {
4501
+ * "Id": "5678",
4502
+ * "Type": "title_player_account",
4503
+ * "TypeString": "title_player_account"
4504
+ * },
4505
+ * "SquadSize": 2
4506
+ * }
4507
+ * ],
4508
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
4509
+ * "IncludeSkillBreakdown": true
4510
+ * });
4511
+ */
4512
+ GetPlayerSkillFromModel(request: GetPlayerSkillFromModelRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSkillFromModelResponse>;
2806
4513
  /**
2807
4514
  * Get the statistics for a queue.
2808
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/getqueuestatistics
4515
+ *
4516
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/getqueuestatistics Microsoft Documentation}
4517
+ * @example
4518
+ * await matchClient.GetQueueStatistics({
4519
+ * "QueueName": "custom123"
4520
+ * });
2809
4521
  */
2810
4522
  GetQueueStatistics(request: GetQueueStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetQueueStatisticsResult>;
2811
4523
  /**
2812
4524
  * Gets a remote login endpoint to a VM that is hosting a multiplayer server build.
2813
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getremoteloginendpoint
4525
+ *
4526
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/getremoteloginendpoint Microsoft Documentation}
4527
+ * @example
4528
+ * await multiplayerserverClient.GetRemoteLoginEndpoint({
4529
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
4530
+ * "Region": "SouthCentralUs",
4531
+ * "VmId": "VmID1"
4532
+ * });
2814
4533
  */
2815
4534
  GetRemoteLoginEndpoint(request: GetRemoteLoginEndpointRequest, extraHeaders?: Record<string, string>): Promise<GetRemoteLoginEndpointResponse>;
4535
+ /**
4536
+ * Get a scenario configuration.
4537
+ *
4538
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/getscenarioconfiguration Microsoft Documentation}
4539
+ * @example
4540
+ * await trueskillClient.GetScenarioConfiguration({
4541
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d"
4542
+ * });
4543
+ */
4544
+ GetScenarioConfiguration(request: GetScenarioConfigurationRequest, extraHeaders?: Record<string, string>): Promise<GetScenarioConfigurationResponse>;
4545
+ /**
4546
+ * Gets all scenario configurations that belong to the title.
4547
+ *
4548
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/getscenarioconfigurations Microsoft Documentation}
4549
+ */
4550
+ GetScenarioConfigurations(request: GetScenarioConfigurationsRequest, extraHeaders?: Record<string, string>): Promise<GetScenarioConfigurationsResponse>;
2816
4551
  /**
2817
4552
  * Get a matchmaking backfill ticket by ticket Id.
2818
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/getserverbackfillticket
4553
+ *
4554
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/getserverbackfillticket Microsoft Documentation}
4555
+ * @example
4556
+ * await matchClient.GetServerBackfillTicket({
4557
+ * "TicketId": "1c4b0daa-150e-47ae-9923-d770c0f9b07c",
4558
+ * "QueueName": "custom123",
4559
+ * "EscapeObject": false
4560
+ * });
2819
4561
  */
2820
4562
  GetServerBackfillTicket(request: GetServerBackfillTicketRequest, extraHeaders?: Record<string, string>): Promise<GetServerBackfillTicketResult>;
2821
4563
  /**
2822
4564
  * Gets the status of whether a title is enabled for the multiplayer server feature.
2823
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/gettitleenabledformultiplayerserversstatus
4565
+ *
4566
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/gettitleenabledformultiplayerserversstatus Microsoft Documentation}
4567
+ * @example
4568
+ * await multiplayerserverClient.GetTitleEnabledForMultiplayerServersStatus({});
2824
4569
  */
2825
4570
  GetTitleEnabledForMultiplayerServersStatus(request: GetTitleEnabledForMultiplayerServersStatusRequest, extraHeaders?: Record<string, string>): Promise<GetTitleEnabledForMultiplayerServersStatusResponse>;
2826
4571
  /**
2827
4572
  * Gets a title's server quota change request.
2828
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/gettitlemultiplayerserversquotachange
4573
+ *
4574
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/gettitlemultiplayerserversquotachange Microsoft Documentation}
4575
+ * @example
4576
+ * await multiplayerserverClient.GetTitleMultiplayerServersQuotaChange({
4577
+ * "RequestId": "1234"
4578
+ * });
2829
4579
  */
2830
4580
  GetTitleMultiplayerServersQuotaChange(request: GetTitleMultiplayerServersQuotaChangeRequest, extraHeaders?: Record<string, string>): Promise<GetTitleMultiplayerServersQuotaChangeResponse>;
2831
4581
  /**
2832
4582
  * Gets the quotas for a title in relation to multiplayer servers.
2833
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/gettitlemultiplayerserversquotas
4583
+ *
4584
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/gettitlemultiplayerserversquotas Microsoft Documentation}
4585
+ * @example
4586
+ * await multiplayerserverClient.GetTitleMultiplayerServersQuotas({});
2834
4587
  */
2835
4588
  GetTitleMultiplayerServersQuotas(request: GetTitleMultiplayerServersQuotasRequest, extraHeaders?: Record<string, string>): Promise<GetTitleMultiplayerServersQuotasResponse>;
2836
4589
  /**
2837
4590
  * Send a notification to invite a player to a lobby.
2838
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/invitetolobby
4591
+ *
4592
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/invitetolobby Microsoft Documentation}
4593
+ * @example
4594
+ * await lobbyClient.InviteToLobby({
4595
+ * "LobbyId": "12345678-1234-1234-1234-123456789ABC",
4596
+ * "MemberEntity": {
4597
+ * "Id": "1234",
4598
+ * "Type": "title_player_account",
4599
+ * "TypeString": "title_player_account"
4600
+ * },
4601
+ * "InviteeEntity": {
4602
+ * "Id": "4321",
4603
+ * "Type": "title_player_account",
4604
+ * "TypeString": "title_player_account"
4605
+ * }
4606
+ * });
2839
4607
  */
2840
4608
  InviteToLobby(request: InviteToLobbyRequest, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
2841
4609
  /**
2842
4610
  * Join an Arranged lobby.
2843
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/joinarrangedlobby
4611
+ *
4612
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/joinarrangedlobby Microsoft Documentation}
4613
+ * @example
4614
+ * await lobbyClient.JoinArrangedLobby({
4615
+ * "MaxPlayers": 50,
4616
+ * "OwnerMigrationPolicy": "Automatic",
4617
+ * "UseConnections": true,
4618
+ * "AccessPolicy": "Public",
4619
+ * "MemberEntity": {
4620
+ * "Id": "1234",
4621
+ * "Type": "title_player_account",
4622
+ * "TypeString": "title_player_account"
4623
+ * },
4624
+ * "ArrangementString": "arrangementString",
4625
+ * "MemberData": {
4626
+ * "MyMemberKey": "MyMemberKey value"
4627
+ * },
4628
+ * "RestrictInvitesToLobbyOwner": false
4629
+ * });
2844
4630
  */
2845
4631
  JoinArrangedLobby(request: JoinArrangedLobbyRequest, extraHeaders?: Record<string, string>): Promise<JoinLobbyResult>;
2846
4632
  /**
2847
4633
  * Join a lobby.
2848
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/joinlobby
4634
+ *
4635
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/joinlobby Microsoft Documentation}
4636
+ * @example
4637
+ * await lobbyClient.JoinLobby({
4638
+ * "MemberEntity": {
4639
+ * "Id": "1234",
4640
+ * "Type": "title_player_account",
4641
+ * "TypeString": "title_player_account"
4642
+ * },
4643
+ * "ConnectionString": "connString",
4644
+ * "MemberData": {
4645
+ * "MyDataKey": "MyDataKey value"
4646
+ * }
4647
+ * });
2849
4648
  */
2850
4649
  JoinLobby(request: JoinLobbyRequest, extraHeaders?: Record<string, string>): Promise<JoinLobbyResult>;
2851
4650
  /**
2852
4651
  * Preview: Join a lobby as a server entity. This is restricted to client lobbies which are using connections.
2853
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/joinlobbyasserver
4652
+ *
4653
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/joinlobbyasserver Microsoft Documentation}
4654
+ * @example
4655
+ * await lobbyClient.JoinLobbyAsServer({
4656
+ * "ServerEntity": {
4657
+ * "Id": "1234",
4658
+ * "Type": "game_server",
4659
+ * "TypeString": "game_server"
4660
+ * },
4661
+ * "ConnectionString": "connString",
4662
+ * "ServerData": {
4663
+ * "MyDataKey": "MyDataKey value"
4664
+ * }
4665
+ * });
2854
4666
  */
2855
4667
  JoinLobbyAsServer(request: JoinLobbyAsServerRequest, extraHeaders?: Record<string, string>): Promise<JoinLobbyAsServerResult>;
2856
4668
  /**
2857
4669
  * Join a matchmaking ticket.
2858
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/joinmatchmakingticket
4670
+ *
4671
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/joinmatchmakingticket Microsoft Documentation}
4672
+ * @example
4673
+ * await matchClient.JoinMatchmakingTicket({
4674
+ * "TicketId": "1c4b0daa-150e-47ae-9923-d770c0f9b07c",
4675
+ * "QueueName": "custom123",
4676
+ * "Member": {}
4677
+ * });
2859
4678
  */
2860
4679
  JoinMatchmakingTicket(request: JoinMatchmakingTicketRequest, extraHeaders?: Record<string, string>): Promise<JoinMatchmakingTicketResult>;
2861
4680
  /**
2862
4681
  * Leave a lobby.
2863
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/leavelobby
4682
+ *
4683
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/leavelobby Microsoft Documentation}
4684
+ * @example
4685
+ * await lobbyClient.LeaveLobby({
4686
+ * "LobbyId": "12345678-1234-1234-1234-123456789ABC",
4687
+ * "MemberEntity": {
4688
+ * "Id": "1234",
4689
+ * "Type": "title_player_account",
4690
+ * "TypeString": "title_player_account"
4691
+ * }
4692
+ * });
2864
4693
  */
2865
4694
  LeaveLobby(request: LeaveLobbyRequest, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
2866
4695
  /**
2867
4696
  * Preview: Request for server to leave a lobby. This is restricted to client owned lobbies which are using connections.
2868
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/leavelobbyasserver
4697
+ *
4698
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/leavelobbyasserver Microsoft Documentation}
4699
+ * @example
4700
+ * await lobbyClient.LeaveLobbyAsServer({
4701
+ * "ServerEntity": {
4702
+ * "Id": "1234",
4703
+ * "Type": "game_server",
4704
+ * "TypeString": "game_server"
4705
+ * },
4706
+ * "LobbyId": "12345678-1234-1234-1234-123456789ABC"
4707
+ * });
2869
4708
  */
2870
4709
  LeaveLobbyAsServer(request: LeaveLobbyAsServerRequest, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
2871
4710
  /**
2872
4711
  * Lists archived multiplayer server sessions for a build.
2873
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listarchivedmultiplayerservers
4712
+ *
4713
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listarchivedmultiplayerservers Microsoft Documentation}
4714
+ * @example
4715
+ * await multiplayerserverClient.ListArchivedMultiplayerServers({
4716
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
4717
+ * "Region": "SouthCentralUs"
4718
+ * });
2874
4719
  */
2875
4720
  ListArchivedMultiplayerServers(request: ListMultiplayerServersRequest, extraHeaders?: Record<string, string>): Promise<ListMultiplayerServersResponse>;
2876
4721
  /**
2877
4722
  * Lists multiplayer server game assets for a title.
2878
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listassetsummaries
4723
+ *
4724
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listassetsummaries Microsoft Documentation}
4725
+ * @example
4726
+ * await multiplayerserverClient.ListAssetSummaries({
4727
+ * "PageSize": 10
4728
+ * });
2879
4729
  */
2880
4730
  ListAssetSummaries(request: ListAssetSummariesRequest, extraHeaders?: Record<string, string>): Promise<ListAssetSummariesResponse>;
2881
4731
  /**
2882
4732
  * Lists details of all build aliases for a title. Accepts tokens for title and if game client access is enabled, allows
2883
4733
  * game client to request list of builds with player entity token.
2884
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listbuildaliases
4734
+ *
4735
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listbuildaliases Microsoft Documentation}
4736
+ * @example
4737
+ * await multiplayerserverClient.ListBuildAliases({
4738
+ * "PageSize": 10
4739
+ * });
2885
4740
  */
2886
4741
  ListBuildAliases(request: ListBuildAliasesRequest, extraHeaders?: Record<string, string>): Promise<ListBuildAliasesResponse>;
2887
4742
  /**
2888
4743
  * Lists summarized details of all multiplayer server builds for a title. Accepts tokens for title and if game client
2889
4744
  * access is enabled, allows game client to request list of builds with player entity token.
2890
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listbuildsummariesv2
4745
+ *
4746
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listbuildsummaries Microsoft Documentation}
4747
+ * @deprecated Please use ListBuildSummariesV2 instead.
4748
+ */
4749
+ ListBuildSummaries(request: ListBuildSummariesRequest, extraHeaders?: Record<string, string>): Promise<ListBuildSummariesResponse>;
4750
+ /**
4751
+ * Lists summarized details of all multiplayer server builds for a title. Accepts tokens for title and if game client
4752
+ * access is enabled, allows game client to request list of builds with player entity token.
4753
+ *
4754
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listbuildsummariesv2 Microsoft Documentation}
4755
+ * @example
4756
+ * await multiplayerserverClient.ListBuildSummariesV2({
4757
+ * "PageSize": 10
4758
+ * });
2891
4759
  */
2892
4760
  ListBuildSummariesV2(request: ListBuildSummariesRequest, extraHeaders?: Record<string, string>): Promise<ListBuildSummariesResponse>;
2893
4761
  /**
2894
4762
  * Lists multiplayer server game certificates for a title.
2895
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listcertificatesummaries
4763
+ *
4764
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listcertificatesummaries Microsoft Documentation}
4765
+ * @example
4766
+ * await multiplayerserverClient.ListCertificateSummaries({
4767
+ * "PageSize": 10
4768
+ * });
2896
4769
  */
2897
4770
  ListCertificateSummaries(request: ListCertificateSummariesRequest, extraHeaders?: Record<string, string>): Promise<ListCertificateSummariesResponse>;
2898
4771
  /**
2899
4772
  * Lists custom container images for a title.
2900
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listcontainerimages
4773
+ *
4774
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listcontainerimages Microsoft Documentation}
4775
+ * @example
4776
+ * await multiplayerserverClient.ListContainerImages({
4777
+ * "PageSize": 10
4778
+ * });
2901
4779
  */
2902
4780
  ListContainerImages(request: ListContainerImagesRequest, extraHeaders?: Record<string, string>): Promise<ListContainerImagesResponse>;
2903
4781
  /**
2904
4782
  * Lists the tags for a custom container image.
2905
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listcontainerimagetags
4783
+ *
4784
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listcontainerimagetags Microsoft Documentation}
4785
+ * @example
4786
+ * await multiplayerserverClient.ListContainerImageTags({
4787
+ * "ImageName": "imageName1",
4788
+ * "PageSize": 10
4789
+ * });
2906
4790
  */
2907
4791
  ListContainerImageTags(request: ListContainerImageTagsRequest, extraHeaders?: Record<string, string>): Promise<ListContainerImageTagsResponse>;
2908
4792
  /**
2909
4793
  * SDK support is limited to C# and Java for this API. List all matchmaking queue configs.
2910
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking-admin/listmatchmakingqueues
4794
+ *
4795
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking-admin/listmatchmakingqueues Microsoft Documentation}
4796
+ * @example
4797
+ * await matchClient.ListMatchmakingQueues({});
2911
4798
  */
2912
4799
  ListMatchmakingQueues(request: ListMatchmakingQueuesRequest, extraHeaders?: Record<string, string>): Promise<ListMatchmakingQueuesResult>;
2913
4800
  /**
2914
4801
  * List all matchmaking ticket Ids the user is a member of.
2915
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/listmatchmakingticketsforplayer
4802
+ *
4803
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/listmatchmakingticketsforplayer Microsoft Documentation}
4804
+ * @example
4805
+ * await matchClient.ListMatchmakingTicketsForPlayer({
4806
+ * "Entity": {
4807
+ * "Id": "123123123",
4808
+ * "Type": "title_player_account",
4809
+ * "TypeString": "title_player_account"
4810
+ * },
4811
+ * "QueueName": "custom123"
4812
+ * });
2916
4813
  */
2917
4814
  ListMatchmakingTicketsForPlayer(request: ListMatchmakingTicketsForPlayerRequest, extraHeaders?: Record<string, string>): Promise<ListMatchmakingTicketsForPlayerResult>;
2918
4815
  /**
2919
4816
  * Lists multiplayer server sessions for a build.
2920
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listmultiplayerservers
4817
+ *
4818
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listmultiplayerservers Microsoft Documentation}
4819
+ * @example
4820
+ * await multiplayerserverClient.ListMultiplayerServers({
4821
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
4822
+ * "Region": "SouthCentralUs"
4823
+ * });
2921
4824
  */
2922
4825
  ListMultiplayerServers(request: ListMultiplayerServersRequest, extraHeaders?: Record<string, string>): Promise<ListMultiplayerServersResponse>;
2923
4826
  /**
2924
4827
  * Lists quality of service servers for party.
2925
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listpartyqosservers
4828
+ *
4829
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listpartyqosservers Microsoft Documentation}
4830
+ * @example
4831
+ * await multiplayerserverClient.ListPartyQosServers({
4832
+ * "Version": "1.0.0"
4833
+ * });
2926
4834
  */
2927
4835
  ListPartyQosServers(request: ListPartyQosServersRequest, extraHeaders?: Record<string, string>): Promise<ListPartyQosServersResponse>;
4836
+ /**
4837
+ * Lists quality of service servers.
4838
+ *
4839
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listqosservers Microsoft Documentation}
4840
+ * @deprecated Please use ListQosServersForTitle instead.
4841
+ */
4842
+ ListQosServers(request: ListQosServersRequest, extraHeaders?: Record<string, string>): Promise<ListQosServersResponse>;
2928
4843
  /**
2929
4844
  * Lists quality of service servers for the title. By default, servers are only returned for regions where a Multiplayer
2930
4845
  * Servers build has been deployed.
2931
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listqosserversfortitle
4846
+ *
4847
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listqosserversfortitle Microsoft Documentation}
4848
+ * @example
4849
+ * await multiplayerserverClient.ListQosServersForTitle({
4850
+ * "IncludeAllRegions": true,
4851
+ * "RoutingPreference": "Microsoft"
4852
+ * });
2932
4853
  */
2933
4854
  ListQosServersForTitle(request: ListQosServersForTitleRequest, extraHeaders?: Record<string, string>): Promise<ListQosServersForTitleResponse>;
2934
4855
  /**
2935
4856
  * Lists multiplayer server game secrets for a title.
2936
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listsecretsummaries
4857
+ *
4858
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listsecretsummaries Microsoft Documentation}
4859
+ * @example
4860
+ * await multiplayerserverClient.ListSecretSummaries({
4861
+ * "PageSize": 10
4862
+ * });
2937
4863
  */
2938
4864
  ListSecretSummaries(request: ListSecretSummariesRequest, extraHeaders?: Record<string, string>): Promise<ListSecretSummariesResponse>;
2939
4865
  /**
2940
4866
  * List all server backfill ticket Ids the user is a member of.
2941
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/listserverbackfillticketsforplayer
4867
+ *
4868
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/listserverbackfillticketsforplayer Microsoft Documentation}
4869
+ * @example
4870
+ * await matchClient.ListServerBackfillTicketsForPlayer({
4871
+ * "Entity": {
4872
+ * "Id": "123123123",
4873
+ * "Type": "title_player_account",
4874
+ * "TypeString": "title_player_account"
4875
+ * },
4876
+ * "QueueName": "custom123"
4877
+ * });
2942
4878
  */
2943
4879
  ListServerBackfillTicketsForPlayer(request: ListServerBackfillTicketsForPlayerRequest, extraHeaders?: Record<string, string>): Promise<ListServerBackfillTicketsForPlayerResult>;
2944
4880
  /**
2945
4881
  * List all server quota change requests for a title.
2946
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listtitlemultiplayerserversquotachanges
4882
+ *
4883
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listtitlemultiplayerserversquotachanges Microsoft Documentation}
4884
+ * @example
4885
+ * await multiplayerserverClient.ListTitleMultiplayerServersQuotaChanges({});
2947
4886
  */
2948
4887
  ListTitleMultiplayerServersQuotaChanges(request: ListTitleMultiplayerServersQuotaChangesRequest, extraHeaders?: Record<string, string>): Promise<ListTitleMultiplayerServersQuotaChangesResponse>;
2949
4888
  /**
2950
4889
  * Lists virtual machines for a title.
2951
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listvirtualmachinesummaries
4890
+ *
4891
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/listvirtualmachinesummaries Microsoft Documentation}
4892
+ * @example
4893
+ * await multiplayerserverClient.ListVirtualMachineSummaries({
4894
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
4895
+ * "Region": "SouthCentralUs",
4896
+ * "PageSize": 10
4897
+ * });
2952
4898
  */
2953
4899
  ListVirtualMachineSummaries(request: ListVirtualMachineSummariesRequest, extraHeaders?: Record<string, string>): Promise<ListVirtualMachineSummariesResponse>;
2954
4900
  /**
2955
4901
  * SDK support is limited to C# and Java for this API. Remove a matchmaking queue config.
2956
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking-admin/removematchmakingqueue
4902
+ *
4903
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking-admin/removematchmakingqueue Microsoft Documentation}
4904
+ * @example
4905
+ * await matchClient.RemoveMatchmakingQueue({
4906
+ * "QueueName": "custom123"
4907
+ * });
2957
4908
  */
2958
4909
  RemoveMatchmakingQueue(request: RemoveMatchmakingQueueRequest, extraHeaders?: Record<string, string>): Promise<RemoveMatchmakingQueueResult>;
2959
4910
  /**
2960
4911
  * Remove a member from a lobby.
2961
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/removemember
4912
+ *
4913
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/removemember Microsoft Documentation}
4914
+ * @example
4915
+ * await lobbyClient.RemoveMember({
4916
+ * "LobbyId": "12345678-1234-1234-1234-123456789ABC",
4917
+ * "MemberEntity": {
4918
+ * "Id": "1234",
4919
+ * "Type": "title_player_account",
4920
+ * "TypeString": "title_player_account"
4921
+ * },
4922
+ * "PreventRejoin": false
4923
+ * });
2962
4924
  */
2963
4925
  RemoveMember(request: RemoveMemberFromLobbyRequest, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
2964
4926
  /**
2965
4927
  * Request a multiplayer server session. Accepts tokens for title and if game client access is enabled, allows game client
2966
4928
  * to request a server with player entity token.
2967
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/requestmultiplayerserver
4929
+ *
4930
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/requestmultiplayerserver Microsoft Documentation}
4931
+ * @example
4932
+ * await multiplayerserverClient.RequestMultiplayerServer({
4933
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
4934
+ * "SessionId": "02bdef0e-e01e-4b29-8efe-ff9f47a06d8c",
4935
+ * "SessionCookie": "U2Vzc2lvbkNvb2tpZQ==",
4936
+ * "InitialPlayers": [
4937
+ * "gamer1",
4938
+ * "gamer2"
4939
+ * ],
4940
+ * "PreferredRegions": [
4941
+ * "SouthCentralUs",
4942
+ * "WestUs"
4943
+ * ]
4944
+ * });
2968
4945
  */
2969
4946
  RequestMultiplayerServer(request: RequestMultiplayerServerRequest, extraHeaders?: Record<string, string>): Promise<RequestMultiplayerServerResponse>;
4947
+ /**
4948
+ * Request a multiplayer server session and associated user connection tokens. Accepts tokens for title and if game client
4949
+ * access is enabled, allows game client to request a server with player entity token.
4950
+ *
4951
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/requestmultiplayerserverandtoken Microsoft Documentation}
4952
+ * @example
4953
+ * await multiplayerserverClient.RequestMultiplayerServerAndToken({
4954
+ * "TokenPlayerIds": [
4955
+ * "gamer1",
4956
+ * "gamer2"
4957
+ * ],
4958
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
4959
+ * "SessionId": "02bdef0e-e01e-4b29-8efe-ff9f47a06d8c",
4960
+ * "SessionCookie": "U2Vzc2lvbkNvb2tpZQ==",
4961
+ * "InitialPlayers": [
4962
+ * "gamer1",
4963
+ * "gamer2"
4964
+ * ],
4965
+ * "PreferredRegions": [
4966
+ * "SouthCentralUs",
4967
+ * "WestUs"
4968
+ * ]
4969
+ * });
4970
+ */
4971
+ RequestMultiplayerServerAndToken(request: RequestMultiplayerServerAndTokenRequest, extraHeaders?: Record<string, string>): Promise<RequestMultiplayerServerAndTokenResponse>;
4972
+ /**
4973
+ * Request a party session.
4974
+ *
4975
+ * {@link https://docs.microsoft.com/rest/api/playfab/party/multiplayerserver/requestparty Microsoft Documentation}
4976
+ * @example
4977
+ * await partyClient.RequestParty({
4978
+ * "PartyId": "23781fa9-e01e-4b29-4f0b-dd9f37a06a1e",
4979
+ * "PreferredRegions": [
4980
+ * "EastUs",
4981
+ * "WestUs"
4982
+ * ],
4983
+ * "SessionCookie": "FooBarCookie",
4984
+ * "Version": "0.1"
4985
+ * });
4986
+ */
4987
+ RequestParty(request: RequestPartyRequest, extraHeaders?: Record<string, string>): Promise<RequestPartyResponse>;
2970
4988
  /**
2971
4989
  * Request a party session.
2972
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/requestpartyservice
4990
+ *
4991
+ * {@link https://docs.microsoft.com/rest/api/playfab/party/multiplayerserver/requestpartyservice Microsoft Documentation}
4992
+ * @example
4993
+ * await partyClient.RequestPartyService({
4994
+ * "TitleId": "12345",
4995
+ * "PartyId": "23781fa9-e01e-4b29-4f0b-dd9f37a06a1e",
4996
+ * "PreferredRegions": [
4997
+ * "EastUs",
4998
+ * "WestUs"
4999
+ * ],
5000
+ * "NetworkConfiguration": {
5001
+ * "MaxUsers": 1024,
5002
+ * "MaxDevices": 128,
5003
+ * "MaxUsersPerDevice": 8,
5004
+ * "MaxDevicesPerUser": 128,
5005
+ * "MaxEndpointsPerDevice": 32,
5006
+ * "DirectPeerConnectivityOptions": "None",
5007
+ * "PartyInvitationConfiguration": {
5008
+ * "Identifier": "f8b73a15-6ec2-48f8-b5fb-6c5946dc10be",
5009
+ * "Revocability": "Anyone",
5010
+ * "EntityKeys": []
5011
+ * }
5012
+ * }
5013
+ * });
2973
5014
  */
2974
5015
  RequestPartyService(request: RequestPartyServiceRequest, extraHeaders?: Record<string, string>): Promise<RequestPartyServiceResponse>;
2975
5016
  /**
2976
5017
  * Rolls over the credentials to the container registry.
2977
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/rollovercontainerregistrycredentials
5018
+ *
5019
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/rollovercontainerregistrycredentials Microsoft Documentation}
5020
+ * @example
5021
+ * await multiplayerserverClient.RolloverContainerRegistryCredentials({});
2978
5022
  */
2979
5023
  RolloverContainerRegistryCredentials(request: RolloverContainerRegistryCredentialsRequest, extraHeaders?: Record<string, string>): Promise<RolloverContainerRegistryCredentialsResponse>;
2980
5024
  /**
2981
5025
  * SDK support is limited to C# and Java for this API. Create or update a matchmaking queue configuration.
2982
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking-admin/setmatchmakingqueue
5026
+ *
5027
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking-admin/setmatchmakingqueue Microsoft Documentation}
5028
+ * @example
5029
+ * await matchClient.SetMatchmakingQueue({
5030
+ * "MatchmakingQueue": {
5031
+ * "Name": "ExampleQueueName",
5032
+ * "MinMatchSize": 7,
5033
+ * "MaxMatchSize": 8,
5034
+ * "MaxTicketSize": 2,
5035
+ * "ServerAllocationEnabled": true,
5036
+ * "BuildId": "065a3208-39af-4691-8794-5f774c367ac2",
5037
+ * "DifferenceRules": [
5038
+ * {
5039
+ * "Difference": 10.0,
5040
+ * "MergeFunction": "Average",
5041
+ * "DefaultAttributeValue": 0.0,
5042
+ * "LinearExpansion": {
5043
+ * "Delta": 0.5,
5044
+ * "Limit": 20.0,
5045
+ * "SecondsBetweenExpansions": 5
5046
+ * },
5047
+ * "Attribute": {
5048
+ * "Path": "ExampleAttributeDifference",
5049
+ * "Source": "User"
5050
+ * },
5051
+ * "AttributeNotSpecifiedBehavior": "UseDefault",
5052
+ * "Weight": 1.0,
5053
+ * "Name": "ExampleNameDifference",
5054
+ * "SecondsUntilOptional": 50
5055
+ * }
5056
+ * ],
5057
+ * "StringEqualityRules": [
5058
+ * {
5059
+ * "DefaultAttributeValue": "ExampleDefault",
5060
+ * "Expansion": {
5061
+ * "EnabledOverrides": [
5062
+ * false,
5063
+ * true,
5064
+ * true,
5065
+ * false
5066
+ * ],
5067
+ * "SecondsBetweenExpansions": 5
5068
+ * },
5069
+ * "Attribute": {
5070
+ * "Path": "ExampleAttributeStringEquality",
5071
+ * "Source": "User"
5072
+ * },
5073
+ * "AttributeNotSpecifiedBehavior": "UseDefault",
5074
+ * "Weight": 1.0,
5075
+ * "Name": "ExampleNameStringEquality",
5076
+ * "SecondsUntilOptional": 50
5077
+ * }
5078
+ * ],
5079
+ * "MatchTotalRules": [
5080
+ * {
5081
+ * "Attribute": {
5082
+ * "Path": "ExampleAttribute",
5083
+ * "Source": "User"
5084
+ * },
5085
+ * "Min": 2.0,
5086
+ * "Max": 0.0,
5087
+ * "Weight": 1.0,
5088
+ * "Expansion": {
5089
+ * "MaxOverrides": [
5090
+ * {
5091
+ * "Value": 4.0
5092
+ * },
5093
+ * {
5094
+ * "Value": 4.0
5095
+ * },
5096
+ * null
5097
+ * ],
5098
+ * "SecondsBetweenExpansions": 5
5099
+ * },
5100
+ * "Name": "MatchTotalRule",
5101
+ * "SecondsUntilOptional": 50
5102
+ * }
5103
+ * ],
5104
+ * "SetIntersectionRules": [
5105
+ * {
5106
+ * "DefaultAttributeValue": [
5107
+ * "a",
5108
+ * "b",
5109
+ * "c"
5110
+ * ],
5111
+ * "MinIntersectionSize": 2,
5112
+ * "LinearExpansion": {
5113
+ * "Delta": 2,
5114
+ * "SecondsBetweenExpansions": 5
5115
+ * },
5116
+ * "Attribute": {
5117
+ * "Path": "ExampleAttributeSetIntersectionRule",
5118
+ * "Source": "User"
5119
+ * },
5120
+ * "AttributeNotSpecifiedBehavior": "UseDefault",
5121
+ * "Weight": 1.0,
5122
+ * "Name": "ExampleNameSetIntersectionRule",
5123
+ * "SecondsUntilOptional": 50
5124
+ * }
5125
+ * ],
5126
+ * "RegionSelectionRule": {
5127
+ * "MaxLatency": 250,
5128
+ * "Path": "Latencies",
5129
+ * "LinearExpansion": {
5130
+ * "Delta": 10,
5131
+ * "Limit": 300,
5132
+ * "SecondsBetweenExpansions": 5
5133
+ * },
5134
+ * "Weight": 1.0,
5135
+ * "Name": "RegionSelectionRule",
5136
+ * "SecondsUntilOptional": 50
5137
+ * },
5138
+ * "TeamSizeBalanceRule": {
5139
+ * "Difference": 1,
5140
+ * "LinearExpansion": {
5141
+ * "Delta": 1,
5142
+ * "Limit": 5,
5143
+ * "SecondsBetweenExpansions": 5
5144
+ * },
5145
+ * "Name": "TeamSizeBalanceRule",
5146
+ * "SecondsUntilOptional": 50
5147
+ * },
5148
+ * "TeamDifferenceRules": [
5149
+ * {
5150
+ * "Attribute": {
5151
+ * "Path": "ExampleAttribute",
5152
+ * "Source": "User"
5153
+ * },
5154
+ * "Difference": 2.0,
5155
+ * "DefaultAttributeValue": 0.0,
5156
+ * "LinearExpansion": {
5157
+ * "Delta": 1.0,
5158
+ * "Limit": 5.0,
5159
+ * "SecondsBetweenExpansions": 5
5160
+ * },
5161
+ * "Name": "TeamDifferenceRule",
5162
+ * "SecondsUntilOptional": 50
5163
+ * }
5164
+ * ],
5165
+ * "TeamTicketSizeSimilarityRule": {
5166
+ * "Name": "TeamTicketSizeSimilarityRule",
5167
+ * "SecondsUntilOptional": 180
5168
+ * },
5169
+ * "Teams": [
5170
+ * {
5171
+ * "Name": "monster",
5172
+ * "MinTeamSize": 1,
5173
+ * "MaxTeamSize": 1
5174
+ * },
5175
+ * {
5176
+ * "Name": "hunters",
5177
+ * "MinTeamSize": 4,
5178
+ * "MaxTeamSize": 8
5179
+ * }
5180
+ * ],
5181
+ * "StatisticsVisibilityToPlayers": {
5182
+ * "ShowNumberOfPlayersMatching": true,
5183
+ * "ShowTimeToMatch": true
5184
+ * }
5185
+ * }
5186
+ * });
2983
5187
  */
2984
5188
  SetMatchmakingQueue(request: SetMatchmakingQueueRequest, extraHeaders?: Record<string, string>): Promise<SetMatchmakingQueueResult>;
2985
5189
  /**
2986
5190
  * Shuts down a multiplayer server session.
2987
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/shutdownmultiplayerserver
5191
+ *
5192
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/shutdownmultiplayerserver Microsoft Documentation}
5193
+ * @example
5194
+ * await multiplayerserverClient.ShutdownMultiplayerServer({
5195
+ * "Region": "AustraliaEast",
5196
+ * "SessionId": "02bdef0e-e01e-4b29-8efe-ff9f47a06d8c"
5197
+ * });
2988
5198
  */
2989
5199
  ShutdownMultiplayerServer(request: ShutdownMultiplayerServerRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
2990
5200
  /**
2991
5201
  * Subscribe to lobby resource notifications.
2992
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/subscribetolobbyresource
5202
+ *
5203
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/subscribetolobbyresource Microsoft Documentation}
5204
+ * @example
5205
+ * await lobbyClient.SubscribeToLobbyResource({
5206
+ * "Type": "LobbyChange",
5207
+ * "ResourceId": "5c905725-0184-4112-a563-2f4187710d06",
5208
+ * "SubscriptionVersion": 1,
5209
+ * "PubSubConnectionHandle": "PubSubConnection",
5210
+ * "EntityKey": {
5211
+ * "Id": "1234",
5212
+ * "Type": "title_player_account",
5213
+ * "TypeString": "title_player_account"
5214
+ * }
5215
+ * });
2993
5216
  */
2994
5217
  SubscribeToLobbyResource(request: SubscribeToLobbyResourceRequest, extraHeaders?: Record<string, string>): Promise<SubscribeToLobbyResourceResult>;
2995
5218
  /**
2996
5219
  * Subscribe to match resource notifications.
2997
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/subscribetomatchmakingresource
5220
+ *
5221
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/subscribetomatchmakingresource Microsoft Documentation}
5222
+ * @example
5223
+ * await matchClient.SubscribeToMatchmakingResource({
5224
+ * "Type": "MatchTicketStatusChange",
5225
+ * "ResourceId": "5a58afee-a9d7-4a47-875b-48bae4dc0590",
5226
+ * "SubscriptionVersion": 1,
5227
+ * "PubSubConnectionHandle": "PubSubConnection",
5228
+ * "EntityKey": {}
5229
+ * });
2998
5230
  */
2999
5231
  SubscribeToMatchmakingResource(request: SubscribeToMatchResourceRequest, extraHeaders?: Record<string, string>): Promise<SubscribeToMatchResourceResult>;
3000
5232
  /**
3001
5233
  * Unsubscribe from lobby notifications.
3002
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/unsubscribefromlobbyresource
5234
+ *
5235
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/unsubscribefromlobbyresource Microsoft Documentation}
5236
+ * @example
5237
+ * await lobbyClient.UnsubscribeFromLobbyResource({
5238
+ * "Type": "LobbyChange",
5239
+ * "ResourceId": "5c905725-0184-4112-a563-2f4187710d06",
5240
+ * "SubscriptionVersion": 1,
5241
+ * "PubSubConnectionHandle": "PubSubConnection",
5242
+ * "EntityKey": {
5243
+ * "Id": "1234",
5244
+ * "Type": "title_player_account",
5245
+ * "TypeString": "title_player_account"
5246
+ * }
5247
+ * });
3003
5248
  */
3004
5249
  UnsubscribeFromLobbyResource(request: UnsubscribeFromLobbyResourceRequest, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
3005
5250
  /**
3006
5251
  * Unsubscribe from match resource notifications.
3007
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/unsubscribefrommatchmakingresource
5252
+ *
5253
+ * {@link https://docs.microsoft.com/rest/api/playfab/match/matchmaking/unsubscribefrommatchmakingresource Microsoft Documentation}
5254
+ * @example
5255
+ * await matchClient.UnsubscribeFromMatchmakingResource({
5256
+ * "Type": "MatchTicketStatusChange",
5257
+ * "ResourceId": "5a58afee-a9d7-4a47-875b-48bae4dc0590",
5258
+ * "SubscriptionVersion": 1,
5259
+ * "PubSubConnectionHandle": "PubSubConnection",
5260
+ * "EntityKey": {}
5261
+ * });
3008
5262
  */
3009
5263
  UnsubscribeFromMatchmakingResource(request: UnsubscribeFromMatchResourceRequest, extraHeaders?: Record<string, string>): Promise<UnsubscribeFromMatchResourceResult>;
3010
5264
  /**
3011
5265
  * Untags a container image.
3012
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/untagcontainerimage
5266
+ *
5267
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/untagcontainerimage Microsoft Documentation}
5268
+ * @example
5269
+ * await multiplayerserverClient.UntagContainerImage({
5270
+ * "ImageName": "imageName1",
5271
+ * "Tag": "tag1"
5272
+ * });
3013
5273
  */
3014
5274
  UntagContainerImage(request: UntagContainerImageRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3015
5275
  /**
3016
5276
  * Creates a multiplayer server build alias.
3017
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/updatebuildalias
5277
+ *
5278
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/updatebuildalias Microsoft Documentation}
5279
+ * @example
5280
+ * await multiplayerserverClient.UpdateBuildAlias({
5281
+ * "AliasName": "AliasName",
5282
+ * "BuildSelectionCriteria": [
5283
+ * {
5284
+ * "BuildWeightDistribution": {
5285
+ * "53781fa8-006d-4e9c-b733-57433d579285": 1
5286
+ * }
5287
+ * }
5288
+ * ],
5289
+ * "AliasId": "21781fa8-096d-4d9c-b699-75433d579285"
5290
+ * });
3018
5291
  */
3019
5292
  UpdateBuildAlias(request: UpdateBuildAliasRequest, extraHeaders?: Record<string, string>): Promise<BuildAliasDetailsResponse>;
3020
5293
  /**
3021
5294
  * Updates a multiplayer server build's name.
3022
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/updatebuildname
5295
+ *
5296
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/updatebuildname Microsoft Documentation}
5297
+ * @example
5298
+ * await multiplayerserverClient.UpdateBuildName({
5299
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
5300
+ * "BuildName": "GameBuildName"
5301
+ * });
3023
5302
  */
3024
5303
  UpdateBuildName(request: UpdateBuildNameRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3025
5304
  /**
3026
5305
  * Updates a multiplayer server build's region. If the region is not yet created, it will be created
3027
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/updatebuildregion
5306
+ *
5307
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/updatebuildregion Microsoft Documentation}
5308
+ * @example
5309
+ * await multiplayerserverClient.UpdateBuildRegion({
5310
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
5311
+ * "BuildRegion": {
5312
+ * "Region": "NorthEurope",
5313
+ * "MaxServers": 7,
5314
+ * "StandbyServers": 3
5315
+ * }
5316
+ * });
3028
5317
  */
3029
5318
  UpdateBuildRegion(request: UpdateBuildRegionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3030
5319
  /**
3031
5320
  * Updates a multiplayer server build's regions.
3032
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/updatebuildregions
5321
+ *
5322
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/updatebuildregions Microsoft Documentation}
5323
+ * @example
5324
+ * await multiplayerserverClient.UpdateBuildRegions({
5325
+ * "BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
5326
+ * "BuildRegions": [
5327
+ * {
5328
+ * "Region": "EastUs",
5329
+ * "MaxServers": 10,
5330
+ * "StandbyServers": 5
5331
+ * },
5332
+ * {
5333
+ * "Region": "WestUs",
5334
+ * "MaxServers": 12,
5335
+ * "StandbyServers": 8
5336
+ * },
5337
+ * {
5338
+ * "Region": "NorthEurope",
5339
+ * "MaxServers": 7,
5340
+ * "StandbyServers": 3
5341
+ * }
5342
+ * ]
5343
+ * });
3033
5344
  */
3034
5345
  UpdateBuildRegions(request: UpdateBuildRegionsRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3035
5346
  /**
3036
5347
  * Update a lobby.
3037
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/updatelobby
5348
+ *
5349
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/updatelobby Microsoft Documentation}
5350
+ * @example
5351
+ * await lobbyClient.UpdateLobby({
5352
+ * "LobbyId": "12345678-1234-1234-1234-123456789ABC",
5353
+ * "MaxPlayers": 50,
5354
+ * "AccessPolicy": "Friends",
5355
+ * "MembershipLock": "Locked",
5356
+ * "SearchData": {
5357
+ * "string_key1": "searchable value"
5358
+ * },
5359
+ * "LobbyData": {
5360
+ * "MyGameKey": "MyGameKey value"
5361
+ * },
5362
+ * "MemberEntity": {
5363
+ * "Id": "1234",
5364
+ * "Type": "title_player_account",
5365
+ * "TypeString": "title_player_account"
5366
+ * },
5367
+ * "MemberData": {
5368
+ * "MyDataKey": "MyDataKey updated value"
5369
+ * },
5370
+ * "SearchDataToDelete": [
5371
+ * "number_key1"
5372
+ * ],
5373
+ * "LobbyDataToDelete": [
5374
+ * "MyOldGameKey"
5375
+ * ],
5376
+ * "MemberDataToDelete": []
5377
+ * });
3038
5378
  */
3039
5379
  UpdateLobby(request: UpdateLobbyRequest, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
3040
5380
  /**
3041
5381
  * Preview: Update fields related to a joined server in the lobby the server is in. Servers can keep a lobby from expiring
3042
5382
  * by being the one to "update" the lobby in some way. Servers have no impact on last member leave/last member disconnect
3043
5383
  * behavior.
3044
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/updatelobbyasserver
5384
+ *
5385
+ * {@link https://docs.microsoft.com/rest/api/playfab/lobby/lobby/updatelobbyasserver Microsoft Documentation}
5386
+ * @example
5387
+ * await lobbyClient.UpdateLobbyAsServer({
5388
+ * "LobbyId": "12345678-1234-1234-1234-123456789ABC",
5389
+ * "ServerEntity": {
5390
+ * "Id": "1234",
5391
+ * "Type": "game_server",
5392
+ * "TypeString": "game_server"
5393
+ * },
5394
+ * "ServerData": {
5395
+ * "MyDataKey": "MyDataKey value"
5396
+ * },
5397
+ * "ServerDataToDelete": [
5398
+ * "MyOldGameKey"
5399
+ * ]
5400
+ * });
3045
5401
  */
3046
5402
  UpdateLobbyAsServer(request: UpdateLobbyAsServerRequest, extraHeaders?: Record<string, string>): Promise<LobbyEmptyResult>;
5403
+ /**
5404
+ * Update a model.
5405
+ *
5406
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/updatemodel Microsoft Documentation}
5407
+ * @example
5408
+ * await trueskillClient.UpdateModel({
5409
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
5410
+ * "ModelId": "73a2506e-9fd3-4d84-8dd7-570c8e9e02cf",
5411
+ * "ModelName": "New Model Name",
5412
+ * "AnomalousMatchResultIgnoreThreshold": -21.0
5413
+ * });
5414
+ */
5415
+ UpdateModel(request: UpdateModelRequest, extraHeaders?: Record<string, string>): Promise<UpdateModelResponse>;
5416
+ /**
5417
+ * Mark a model as primary for a scenario.
5418
+ *
5419
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/updateprimarymodel Microsoft Documentation}
5420
+ * @example
5421
+ * await trueskillClient.UpdatePrimaryModel({
5422
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
5423
+ * "ModelId": "73a2506e-9fd3-4d84-8dd7-570c8e9e02cf"
5424
+ * });
5425
+ */
5426
+ UpdatePrimaryModel(request: UpdatePrimaryModelRequest, extraHeaders?: Record<string, string>): Promise<UpdatePrimaryModelResponse>;
5427
+ /**
5428
+ * Update a scenario configuration.
5429
+ *
5430
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill-admin/updatescenarioconfiguration Microsoft Documentation}
5431
+ * @example
5432
+ * await trueskillClient.UpdateScenarioConfiguration({
5433
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
5434
+ * "ConditionsToUpdateOrAdd": [
5435
+ * {
5436
+ * "Key": "InputDevice",
5437
+ * "Values": [
5438
+ * "MouseAndKeyboard",
5439
+ * "Controller"
5440
+ * ]
5441
+ * }
5442
+ * ]
5443
+ * });
5444
+ */
5445
+ UpdateScenarioConfiguration(request: UpdateScenarioConfigurationRequest, extraHeaders?: Record<string, string>): Promise<UpdateScenarioConfigurationResponse>;
3047
5446
  /**
3048
5447
  * Uploads a multiplayer server game certificate.
3049
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/uploadcertificate
5448
+ *
5449
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/uploadcertificate Microsoft Documentation}
5450
+ * @example
5451
+ * await multiplayerserverClient.UploadCertificate({
5452
+ * "GameCertificate": {
5453
+ * "Name": "GameCertificate1",
5454
+ * "Base64EncodedValue": "UGxheUZhYlJvY2tzISEhTGV0J3NtYWtlYWxvdG9mZ2FtZXMh",
5455
+ * "Password": "PasswordForPFXCertificate"
5456
+ * },
5457
+ * "ForceUpdate": false
5458
+ * });
3050
5459
  */
3051
5460
  UploadCertificate(request: UploadCertificateRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
5461
+ /**
5462
+ * Uploads a match result.
5463
+ *
5464
+ * {@link https://docs.microsoft.com/rest/api/playfab/trueskill/trueskill/uploadmatchresult Microsoft Documentation}
5465
+ * @example
5466
+ * await trueskillClient.UploadMatchResult({
5467
+ * "MatchResult": {
5468
+ * "ScenarioId": "f9f0331e-0149-42ba-a994-29b18cac4e4d",
5469
+ * "Teams": [
5470
+ * {
5471
+ * "Players": [
5472
+ * {
5473
+ * "Entity": {
5474
+ * "Id": "5678",
5475
+ * "Type": "title_player_account",
5476
+ * "TypeString": "title_player_account"
5477
+ * },
5478
+ * "PreMatchPartyId": "630a6523-8853-4cf6-9fda-c7da84f3d87a",
5479
+ * "SecondsPlayed": 1800,
5480
+ * "CompletionStatus": "Completed",
5481
+ * "Conditions": {
5482
+ * "Platform": "PC",
5483
+ * "Mode": "Deathmatch"
5484
+ * },
5485
+ * "EventCounts": {
5486
+ * "Kills": 35,
5487
+ * "Deaths": 5
5488
+ * }
5489
+ * },
5490
+ * {
5491
+ * "Entity": {
5492
+ * "Id": "8765",
5493
+ * "Type": "title_player_account",
5494
+ * "TypeString": "title_player_account"
5495
+ * },
5496
+ * "PreMatchPartyId": "630a6523-8853-4cf6-9fda-c7da84f3d87a",
5497
+ * "SecondsPlayed": 1800,
5498
+ * "CompletionStatus": "Completed",
5499
+ * "Conditions": {
5500
+ * "Platform": "Xbox",
5501
+ * "Mode": "Deathmatch"
5502
+ * },
5503
+ * "EventCounts": {
5504
+ * "Kills": 15,
5505
+ * "Deaths": 10
5506
+ * }
5507
+ * }
5508
+ * ],
5509
+ * "Rank": 0
5510
+ * },
5511
+ * {
5512
+ * "Players": [
5513
+ * {
5514
+ * "SecondsPlayed": 1800,
5515
+ * "BotId": 77,
5516
+ * "CompletionStatus": "Completed",
5517
+ * "Conditions": {
5518
+ * "Platform": "Xbox",
5519
+ * "Mode": "Deathmatch"
5520
+ * },
5521
+ * "EventCounts": {
5522
+ * "Kills": 10,
5523
+ * "Deaths": 15
5524
+ * }
5525
+ * },
5526
+ * {
5527
+ * "Entity": {
5528
+ * "Id": "0371",
5529
+ * "Type": "title_player_account",
5530
+ * "TypeString": "title_player_account"
5531
+ * },
5532
+ * "SecondsPlayed": 900,
5533
+ * "CompletionStatus": "Disconnected",
5534
+ * "Conditions": {
5535
+ * "Platform": "PlayStation",
5536
+ * "Mode": "Deathmatch"
5537
+ * },
5538
+ * "EventCounts": {
5539
+ * "Kills": 2,
5540
+ * "Deaths": 20
5541
+ * }
5542
+ * },
5543
+ * {
5544
+ * "Entity": {
5545
+ * "Id": "9731",
5546
+ * "Type": "title_player_account",
5547
+ * "TypeString": "title_player_account"
5548
+ * },
5549
+ * "SecondsPlayed": 900,
5550
+ * "CompletionStatus": "Completed",
5551
+ * "Conditions": {
5552
+ * "Platform": "PlayStation",
5553
+ * "Mode": "Deathmatch"
5554
+ * },
5555
+ * "EventCounts": {
5556
+ * "Kills": 3,
5557
+ * "Deaths": 15
5558
+ * }
5559
+ * }
5560
+ * ],
5561
+ * "Rank": 1
5562
+ * }
5563
+ * ],
5564
+ * "StartDateTimeUtc": "2025-05-26T17:12:07.313Z",
5565
+ * "EndDateTimeUtc": "2025-05-26T17:42:07.313Z"
5566
+ * }
5567
+ * });
5568
+ */
5569
+ UploadMatchResult(request: UploadMatchResultRequest, extraHeaders?: Record<string, string>): Promise<UploadMatchResultResponse>;
3052
5570
  /**
3053
5571
  * Uploads a multiplayer server game secret.
3054
- * https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/uploadsecret
5572
+ *
5573
+ * {@link https://docs.microsoft.com/rest/api/playfab/multiplayerserver/multiplayerserver/uploadsecret Microsoft Documentation}
5574
+ * @example
5575
+ * await multiplayerserverClient.UploadSecret({
5576
+ * "GameSecret": {
5577
+ * "Name": "GameSecret1",
5578
+ * "Value": "Value123",
5579
+ * "ExpirationDate": "2025-09-01T00:00:00Z"
5580
+ * },
5581
+ * "ForceUpdate": false
5582
+ * });
3055
5583
  */
3056
5584
  UploadSecret(request: UploadSecretRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3057
5585
  }