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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. package/dist/Addon.d.ts +179 -39
  2. package/dist/Addon.js +2 -2
  3. package/dist/Admin.d.ts +2386 -195
  4. package/dist/Admin.js +2 -2
  5. package/dist/Authentication.d.ts +32 -5
  6. package/dist/Authentication.js +2 -2
  7. package/dist/Client.d.ts +2235 -321
  8. package/dist/Client.js +2 -2
  9. package/dist/CloudScript.d.ts +199 -31
  10. package/dist/CloudScript.js +2 -2
  11. package/dist/Data.d.ts +137 -18
  12. package/dist/Data.js +2 -2
  13. package/dist/Economy.d.ts +1145 -106
  14. package/dist/Economy.js +2 -2
  15. package/dist/Events.d.ts +200 -13
  16. package/dist/Events.js +2 -2
  17. package/dist/Experimentation.d.ts +164 -17
  18. package/dist/Experimentation.js +2 -2
  19. package/dist/Groups.d.ts +267 -28
  20. package/dist/Groups.js +2 -2
  21. package/dist/Insights.d.ts +33 -7
  22. package/dist/Insights.js +2 -2
  23. package/dist/Localization.d.ts +5 -2
  24. package/dist/Localization.js +2 -2
  25. package/dist/Matchmaker.d.ts +271 -0
  26. package/dist/Matchmaker.js +8 -0
  27. package/dist/Matchmaker.js.map +1 -0
  28. package/dist/Multiplayer.d.ts +2697 -169
  29. package/dist/Multiplayer.js +2 -2
  30. package/dist/{PlayFabCommon-BX3jSqGx.d.ts → PlayFabCommon-Dnp_xHg5.d.ts} +3 -5
  31. package/dist/Profiles.d.ts +163 -19
  32. package/dist/Profiles.js +2 -2
  33. package/dist/Progression.d.ts +287 -35
  34. package/dist/Progression.js +2 -2
  35. package/dist/Server.d.ts +1904 -242
  36. package/dist/Server.js +2 -2
  37. package/dist/chunk-3I6ONUUQ.js +237 -0
  38. package/dist/chunk-3I6ONUUQ.js.map +1 -0
  39. package/dist/chunk-3O5QT4SL.js +2477 -0
  40. package/dist/chunk-3O5QT4SL.js.map +1 -0
  41. package/dist/chunk-3OBHYLBF.js +2673 -0
  42. package/dist/chunk-3OBHYLBF.js.map +1 -0
  43. package/dist/chunk-57KYHGBO.js +421 -0
  44. package/dist/chunk-57KYHGBO.js.map +1 -0
  45. package/dist/{chunk-J4QS5VX5.js → chunk-5CWZN75H.js} +6 -3
  46. package/dist/chunk-5CWZN75H.js.map +1 -0
  47. package/dist/chunk-73SVDH45.js +197 -0
  48. package/dist/chunk-73SVDH45.js.map +1 -0
  49. package/dist/chunk-ADHTNFTN.js +175 -0
  50. package/dist/chunk-ADHTNFTN.js.map +1 -0
  51. package/dist/chunk-C7U2JQNZ.js +76 -0
  52. package/dist/chunk-C7U2JQNZ.js.map +1 -0
  53. package/dist/{chunk-SGSEOIKS.js → chunk-GAZYZIK2.js} +34 -8
  54. package/dist/chunk-GAZYZIK2.js.map +1 -0
  55. package/dist/chunk-J54WY4UN.js +413 -0
  56. package/dist/chunk-J54WY4UN.js.map +1 -0
  57. package/dist/chunk-NFWQ4MMZ.js +1048 -0
  58. package/dist/chunk-NFWQ4MMZ.js.map +1 -0
  59. package/dist/{chunk-A7VD6ALV.js → chunk-P7UVG26J.js} +167 -32
  60. package/dist/chunk-P7UVG26J.js.map +1 -0
  61. package/dist/chunk-PFXZB4UN.js +2387 -0
  62. package/dist/chunk-PFXZB4UN.js.map +1 -0
  63. package/dist/{chunk-X34XZJB6.js → chunk-QNGQW3YB.js} +28 -6
  64. package/dist/chunk-QNGQW3YB.js.map +1 -0
  65. package/dist/chunk-SQWILU5T.js +270 -0
  66. package/dist/chunk-SQWILU5T.js.map +1 -0
  67. package/dist/{chunk-JGDO2ZE3.js → chunk-SR2RIRLX.js} +1482 -175
  68. package/dist/chunk-SR2RIRLX.js.map +1 -0
  69. package/dist/{chunk-62SULWOK.js → chunk-XVDYM74A.js} +17 -14
  70. package/dist/chunk-XVDYM74A.js.map +1 -0
  71. package/dist/chunk-ZW4TJ3MQ.js +225 -0
  72. package/dist/chunk-ZW4TJ3MQ.js.map +1 -0
  73. package/dist/index.d.ts +7 -6
  74. package/dist/index.js +29 -25
  75. package/package.json +2 -2
  76. package/dist/chunk-3FCAP7OZ.js +0 -187
  77. package/dist/chunk-3FCAP7OZ.js.map +0 -1
  78. package/dist/chunk-62SULWOK.js.map +0 -1
  79. package/dist/chunk-A7VD6ALV.js.map +0 -1
  80. package/dist/chunk-BX65UND2.js +0 -632
  81. package/dist/chunk-BX65UND2.js.map +0 -1
  82. package/dist/chunk-J4QS5VX5.js.map +0 -1
  83. package/dist/chunk-JGDO2ZE3.js.map +0 -1
  84. package/dist/chunk-POMI7LEF.js +0 -76
  85. package/dist/chunk-POMI7LEF.js.map +0 -1
  86. package/dist/chunk-Q3OF3AOJ.js +0 -97
  87. package/dist/chunk-Q3OF3AOJ.js.map +0 -1
  88. package/dist/chunk-QUZHVSVZ.js +0 -174
  89. package/dist/chunk-QUZHVSVZ.js.map +0 -1
  90. package/dist/chunk-QVLIVSO4.js +0 -1147
  91. package/dist/chunk-QVLIVSO4.js.map +0 -1
  92. package/dist/chunk-R7V7DFCF.js +0 -103
  93. package/dist/chunk-R7V7DFCF.js.map +0 -1
  94. package/dist/chunk-SGSEOIKS.js.map +0 -1
  95. package/dist/chunk-UOHHNVCJ.js +0 -119
  96. package/dist/chunk-UOHHNVCJ.js.map +0 -1
  97. package/dist/chunk-USKFWNQK.js +0 -384
  98. package/dist/chunk-USKFWNQK.js.map +0 -1
  99. package/dist/chunk-UX7LFJCX.js +0 -61
  100. package/dist/chunk-UX7LFJCX.js.map +0 -1
  101. package/dist/chunk-X34XZJB6.js.map +0 -1
  102. package/dist/chunk-YNZF3WXS.js +0 -882
  103. package/dist/chunk-YNZF3WXS.js.map +0 -1
package/dist/Client.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  PlayFabClientApi
3
- } from "./chunk-JGDO2ZE3.js";
4
- import "./chunk-62SULWOK.js";
3
+ } from "./chunk-SR2RIRLX.js";
4
+ import "./chunk-XVDYM74A.js";
5
5
  export {
6
6
  PlayFabClientApi as default
7
7
  };
@@ -1,4 +1,4 @@
1
- import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-BX3jSqGx.js';
1
+ import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
2
2
 
3
3
  interface AdCampaignAttributionModel {
4
4
  /** UTC time stamp of attribution */
@@ -23,6 +23,11 @@ interface EntityKey {
23
23
  Id: string;
24
24
  /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
25
25
  Type?: string;
26
+ /**
27
+ * Alternate name for Type.
28
+ * @deprecated Please use Type instead.
29
+ */
30
+ TypeString?: string;
26
31
  }
27
32
  interface EventHubFunctionModel {
28
33
  /** The connection string for the event hub. */
@@ -78,17 +83,17 @@ interface ExecuteEntityCloudScriptRequest extends IPlayFabRequestCommon {
78
83
  /** Object that is passed in to the function as the first argument */
79
84
  FunctionParameter?: any;
80
85
  /**
81
- * Generate a 'entity_executed_cloudscript' PlayStream event containing the results of the function execution and other
86
+ * Generate a 'entity_executed_cloudscript' PlayStream event containing the results of the function execution and other
82
87
  * contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
83
88
  */
84
89
  GeneratePlayStreamEvent?: boolean;
85
90
  /**
86
- * Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live'
87
- * executes the current live, published revision, and 'Specific' executes the specified revision. The default value is
88
- * 'Specific', if the SpecificRevision parameter is specified, otherwise it is 'Live'.
91
+ * Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live'
92
+ * executes the current live, published revision, and 'Specific' executes the specified revision. The default value is
93
+ * 'Specific', if the SpecificRevision parameter is specified, otherwise it is 'Live'.
89
94
  */
90
95
  RevisionSelection?: string;
91
- /** The specific revision to execute, when RevisionSelection is set to 'Specific' */
96
+ /** The specific revision to execute, when RevisionSelection is set to 'Specific' */
92
97
  SpecificRevision?: number;
93
98
  }
94
99
  interface ExecuteFunctionRequest extends IPlayFabRequestCommon {
@@ -101,7 +106,7 @@ interface ExecuteFunctionRequest extends IPlayFabRequestCommon {
101
106
  /** Object that is passed in to the function as the FunctionArgument field of the FunctionExecutionContext data structure */
102
107
  FunctionParameter?: any;
103
108
  /**
104
- * Generate a 'entity_executed_cloudscript_function' PlayStream event containing the results of the function execution and
109
+ * Generate a 'entity_executed_cloudscript_function' PlayStream event containing the results of the function execution and
105
110
  * other contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
106
111
  */
107
112
  GeneratePlayStreamEvent?: boolean;
@@ -204,7 +209,7 @@ interface LocationModel {
204
209
  interface LogStatement {
205
210
  /** Optional object accompanying the message as contextual information */
206
211
  Data?: any;
207
- /** 'Debug', 'Info', or 'Error' */
212
+ /** 'Debug', 'Info', or 'Error' */
208
213
  Level?: string;
209
214
  Message?: string;
210
215
  }
@@ -220,6 +225,8 @@ interface MembershipModel {
220
225
  * overridden, this will be the new expiration time.
221
226
  */
222
227
  OverrideExpiration?: string;
228
+ /** Whether the override expiration is set. */
229
+ OverrideIsSet?: boolean;
223
230
  /** The list of subscriptions that this player has for this membership */
224
231
  Subscriptions?: SubscriptionModel[];
225
232
  }
@@ -232,7 +239,7 @@ interface NameIdentifier {
232
239
  interface PlayerProfileModel {
233
240
  /** List of advertising campaigns the player has been attributed to */
234
241
  AdCampaignAttributions?: AdCampaignAttributionModel[];
235
- /** URL of the player's avatar image */
242
+ /** URL of the player's avatar image */
236
243
  AvatarUrl?: string;
237
244
  /** If the player is currently banned, the UTC Date when the ban expires */
238
245
  BannedUntil?: string;
@@ -266,16 +273,16 @@ interface PlayerProfileModel {
266
273
  PushNotificationRegistrations?: PushNotificationRegistrationModel[];
267
274
  /** List of leaderboard statistic values for the player */
268
275
  Statistics?: StatisticModel[];
269
- /** List of player's tags for segmentation */
276
+ /** List of player's tags for segmentation */
270
277
  Tags?: TagModel[];
271
278
  /** Title ID this player profile applies to */
272
279
  TitleId?: string;
273
280
  /**
274
- * Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a
281
+ * Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a
275
282
  * whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.
276
283
  */
277
284
  TotalValueToDateInUSD?: number;
278
- /** List of the player's lifetime purchase totals, summed by real-money currency */
285
+ /** List of the player's lifetime purchase totals, summed by real-money currency */
279
286
  ValuesToDate?: ValueToDateModel[];
280
287
  }
281
288
  interface PlayStreamEventEnvelopeModel {
@@ -311,6 +318,11 @@ interface PostFunctionResultForFunctionExecutionRequest extends IPlayFabRequestC
311
318
  interface PostFunctionResultForPlayerTriggeredActionRequest extends IPlayFabRequestCommon {
312
319
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
313
320
  CustomTags?: Record<string, string | null>;
321
+ /**
322
+ * The optional entity to perform this action on. Defaults to the currently logged in entity.
323
+ * @deprecated Do not use
324
+ */
325
+ Entity?: EntityKey;
314
326
  /** The result of the function execution. */
315
327
  FunctionResult: ExecuteFunctionResult;
316
328
  /** The player profile the function was invoked with. */
@@ -321,6 +333,11 @@ interface PostFunctionResultForPlayerTriggeredActionRequest extends IPlayFabRequ
321
333
  interface PostFunctionResultForScheduledTaskRequest extends IPlayFabRequestCommon {
322
334
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
323
335
  CustomTags?: Record<string, string | null>;
336
+ /**
337
+ * The entity to perform this action on.
338
+ * @deprecated Do not use
339
+ */
340
+ Entity?: EntityKey;
324
341
  /** The result of the function execution */
325
342
  FunctionResult: ExecuteFunctionResult;
326
343
  /** The id of the scheduled task that invoked the function. */
@@ -392,7 +409,7 @@ interface SubscriptionModel {
392
409
  Expiration: string;
393
410
  /** The time the subscription was orignially purchased */
394
411
  InitialSubscriptionTime: string;
395
- /** Whether this subscription is currently active. That is, if Expiration > now. */
412
+ /** Whether this subscription is currently active. That is, if Expiration &gt; now. */
396
413
  IsActive: boolean;
397
414
  /** The status of this subscription, according to the subscription provider. */
398
415
  Status?: string;
@@ -418,12 +435,12 @@ interface ValueToDateModel {
418
435
  Currency?: string;
419
436
  /**
420
437
  * Total value of the purchases in a whole number of 1/100 monetary units. For example, 999 indicates nine dollars and
421
- * ninety-nine cents when Currency is 'USD')
438
+ * ninety-nine cents when Currency is &#39;USD&#39;)
422
439
  */
423
440
  TotalValue: number;
424
441
  /**
425
- * Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine
426
- * dollars and ninety-nine cents when Currency is 'USD'.
442
+ * Total value of the purchases in a string representation of decimal monetary units. For example, &#39;9.99&#39; indicates nine
443
+ * dollars and ninety-nine cents when Currency is &#39;USD&#39;.
427
444
  */
428
445
  TotalValueAsDecimal?: string;
429
446
  }
@@ -432,78 +449,229 @@ declare class PlayFabCloudScriptApi extends PlayFabCommon {
432
449
  /**
433
450
  * Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of
434
451
  * custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.
435
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executeentitycloudscript
452
+ *
453
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executeentitycloudscript Microsoft Documentation}
454
+ * @example
455
+ * await cloudscriptClient.ExecuteEntityCloudScript({
456
+ * "FunctionName": "levelCompleted",
457
+ * "FunctionParameter": {
458
+ * "level": 3,
459
+ * "points": 400
460
+ * },
461
+ * "RevisionSelection": "Live",
462
+ * "GeneratePlayStreamEvent": true,
463
+ * "Entity": {
464
+ * "Id": "aaa",
465
+ * "Type": "title_player_account",
466
+ * "TypeString": "title_player_account"
467
+ * }
468
+ * });
436
469
  */
437
470
  ExecuteEntityCloudScript(request: ExecuteEntityCloudScriptRequest, extraHeaders?: Record<string, string>): Promise<ExecuteCloudScriptResult>;
438
471
  /**
439
472
  * Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of
440
473
  * custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.
441
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executefunction
474
+ *
475
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executefunction Microsoft Documentation}
476
+ * @example
477
+ * await cloudscriptClient.ExecuteFunction({
478
+ * "FunctionName": "LevelCompleted",
479
+ * "FunctionParameter": {
480
+ * "level": 3,
481
+ * "points": 400
482
+ * },
483
+ * "GeneratePlayStreamEvent": true,
484
+ * "Entity": {
485
+ * "Id": "aaa",
486
+ * "Type": "title_player_account",
487
+ * "TypeString": "title_player_account"
488
+ * }
489
+ * });
442
490
  */
443
491
  ExecuteFunction(request: ExecuteFunctionRequest, extraHeaders?: Record<string, string>): Promise<ExecuteFunctionResult>;
444
492
  /**
445
493
  * Gets registered Azure Functions for a given title id and function name.
446
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/getfunction
494
+ *
495
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/getfunction Microsoft Documentation}
496
+ * @example
497
+ * await cloudscriptClient.GetFunction({
498
+ * "FunctionName": "LevelCompleted"
499
+ * });
447
500
  */
448
501
  GetFunction(request: GetFunctionRequest, extraHeaders?: Record<string, string>): Promise<GetFunctionResult>;
449
502
  /**
450
503
  * Lists all currently registered Event Hub triggered Azure Functions for a given title.
451
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listeventhubfunctions
504
+ *
505
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listeventhubfunctions Microsoft Documentation}
506
+ * @example
507
+ * await cloudscriptClient.ListEventHubFunctions({});
452
508
  */
453
509
  ListEventHubFunctions(request: ListFunctionsRequest, extraHeaders?: Record<string, string>): Promise<ListEventHubFunctionsResult>;
454
510
  /**
455
511
  * Lists all currently registered Azure Functions for a given title.
456
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listfunctions
512
+ *
513
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listfunctions Microsoft Documentation}
514
+ * @example
515
+ * await cloudscriptClient.ListFunctions({});
457
516
  */
458
517
  ListFunctions(request: ListFunctionsRequest, extraHeaders?: Record<string, string>): Promise<ListFunctionsResult>;
459
518
  /**
460
519
  * Lists all currently registered HTTP triggered Azure Functions for a given title.
461
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listhttpfunctions
520
+ *
521
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listhttpfunctions Microsoft Documentation}
522
+ * @example
523
+ * await cloudscriptClient.ListHttpFunctions({});
462
524
  */
463
525
  ListHttpFunctions(request: ListFunctionsRequest, extraHeaders?: Record<string, string>): Promise<ListHttpFunctionsResult>;
464
526
  /**
465
527
  * Lists all currently registered Queue triggered Azure Functions for a given title.
466
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listqueuedfunctions
528
+ *
529
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listqueuedfunctions Microsoft Documentation}
530
+ * @example
531
+ * await cloudscriptClient.ListQueuedFunctions({});
467
532
  */
468
533
  ListQueuedFunctions(request: ListFunctionsRequest, extraHeaders?: Record<string, string>): Promise<ListQueuedFunctionsResult>;
469
534
  /**
470
535
  * Generate an entity PlayStream event for the provided function result.
471
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforentitytriggeredaction
536
+ *
537
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforentitytriggeredaction Microsoft Documentation}
538
+ * @example
539
+ * await cloudscriptClient.PostFunctionResultForEntityTriggeredAction({
540
+ * "FunctionResult": {
541
+ * "ExecutionTimeMilliseconds": 367,
542
+ * "FunctionName": "LevelCompleted",
543
+ * "FunctionResult": {
544
+ * "newScore": 25,
545
+ * "isWinner": false
546
+ * }
547
+ * },
548
+ * "Entity": {
549
+ * "Id": "ID",
550
+ * "Type": "title_player_account",
551
+ * "TypeString": "title_player_account"
552
+ * }
553
+ * });
472
554
  */
473
555
  PostFunctionResultForEntityTriggeredAction(request: PostFunctionResultForEntityTriggeredActionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
474
556
  /**
475
557
  * Generate an entity PlayStream event for the provided function result.
476
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforfunctionexecution
558
+ *
559
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforfunctionexecution Microsoft Documentation}
560
+ * @example
561
+ * await cloudscriptClient.PostFunctionResultForFunctionExecution({
562
+ * "FunctionResult": {
563
+ * "ExecutionTimeMilliseconds": 367,
564
+ * "FunctionName": "LevelCompleted",
565
+ * "FunctionResult": {
566
+ * "newScore": 25,
567
+ * "isWinner": false
568
+ * }
569
+ * },
570
+ * "Entity": {
571
+ * "Id": "ID",
572
+ * "Type": "title_player_account",
573
+ * "TypeString": "title_player_account"
574
+ * }
575
+ * });
477
576
  */
478
577
  PostFunctionResultForFunctionExecution(request: PostFunctionResultForFunctionExecutionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
479
578
  /**
480
579
  * Generate a player PlayStream event for the provided function result.
481
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforplayertriggeredaction
580
+ *
581
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforplayertriggeredaction Microsoft Documentation}
582
+ * @example
583
+ * await cloudscriptClient.PostFunctionResultForPlayerTriggeredAction({
584
+ * "PlayStreamEventEnvelope": {
585
+ * "EntityId": "1234ABCD",
586
+ * "EntityType": "title_player_account",
587
+ * "EventName": "player_logged_in",
588
+ * "EventNamespace": "com.playfab",
589
+ * "EventData": "someeventdata",
590
+ * "EventSettings": "someeventsettings",
591
+ * "EventToBeDropped": false
592
+ * },
593
+ * "PlayerProfile": {
594
+ * "TitleId": "FFFF",
595
+ * "PlayerId": "1234ABCD",
596
+ * "Created": "2019-02-11T20:23:05Z",
597
+ * "LastLogin": "2020-02-11T20:23:05Z",
598
+ * "DisplayName": "Gudge"
599
+ * },
600
+ * "FunctionResult": {
601
+ * "ExecutionTimeMilliseconds": 367,
602
+ * "FunctionName": "LevelCompleted",
603
+ * "FunctionResult": {
604
+ * "newScore": 25,
605
+ * "isWinner": false
606
+ * }
607
+ * }
608
+ * });
482
609
  */
483
610
  PostFunctionResultForPlayerTriggeredAction(request: PostFunctionResultForPlayerTriggeredActionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
484
611
  /**
485
612
  * Generate a PlayStream event for the provided function result.
486
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforscheduledtask
613
+ *
614
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforscheduledtask Microsoft Documentation}
615
+ * @example
616
+ * await cloudscriptClient.PostFunctionResultForScheduledTask({
617
+ * "ScheduledTaskId": {
618
+ * "Name": "MyTask",
619
+ * "Id": "d739e188-22f6-4d13-a4d5-df2e93d4d2f7"
620
+ * },
621
+ * "FunctionResult": {
622
+ * "ExecutionTimeMilliseconds": 367,
623
+ * "FunctionName": "LevelCompleted",
624
+ * "FunctionResult": {
625
+ * "newScore": 25,
626
+ * "isWinner": false
627
+ * }
628
+ * }
629
+ * });
487
630
  */
488
631
  PostFunctionResultForScheduledTask(request: PostFunctionResultForScheduledTaskRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
489
632
  /**
490
633
  * Registers an event hub triggered Azure Function with a title.
491
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registereventhubfunction
634
+ *
635
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registereventhubfunction Microsoft Documentation}
636
+ * @example
637
+ * await cloudscriptClient.RegisterEventHubFunction({
638
+ * "EventHubName": "fn-eventhub",
639
+ * "ConnectionString": "SampleConnectionString",
640
+ * "FunctionName": "functionName"
641
+ * });
492
642
  */
493
643
  RegisterEventHubFunction(request: RegisterEventHubFunctionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
494
644
  /**
495
645
  * Registers an HTTP triggered Azure function with a title.
496
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerhttpfunction
646
+ *
647
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerhttpfunction Microsoft Documentation}
648
+ * @example
649
+ * await cloudscriptClient.RegisterHttpFunction({
650
+ * "FunctionUrl": "http://function.url",
651
+ * "FunctionName": "functionName"
652
+ * });
497
653
  */
498
654
  RegisterHttpFunction(request: RegisterHttpFunctionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
499
655
  /**
500
656
  * Registers a queue triggered Azure Function with a title.
501
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerqueuedfunction
657
+ *
658
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerqueuedfunction Microsoft Documentation}
659
+ * @example
660
+ * await cloudscriptClient.RegisterQueuedFunction({
661
+ * "QueueName": "fn-queue",
662
+ * "ConnectionString": "SampleConnectionString",
663
+ * "FunctionName": "functionName"
664
+ * });
502
665
  */
503
666
  RegisterQueuedFunction(request: RegisterQueuedFunctionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
504
667
  /**
505
668
  * Unregisters an Azure Function with a title.
506
- * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/unregisterfunction
669
+ *
670
+ * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/unregisterfunction Microsoft Documentation}
671
+ * @example
672
+ * await cloudscriptClient.UnregisterFunction({
673
+ * "FunctionName": "functionName"
674
+ * });
507
675
  */
508
676
  UnregisterFunction(request: UnregisterFunctionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
509
677
  }
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  PlayFabCloudScriptApi
3
- } from "./chunk-UOHHNVCJ.js";
4
- import "./chunk-62SULWOK.js";
3
+ } from "./chunk-SQWILU5T.js";
4
+ import "./chunk-XVDYM74A.js";
5
5
  export {
6
6
  PlayFabCloudScriptApi as default
7
7
  };