async-playfab-web-sdk 1.192.250526 → 1.193.250606
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.
- package/dist/{Addon.d.mts → Addon.d.ts} +213 -73
- package/dist/Addon.js +8 -0
- package/dist/Addon.js.map +1 -1
- package/dist/{Admin.d.mts → Admin.d.ts} +2547 -356
- package/dist/Admin.js +8 -0
- package/dist/Admin.js.map +1 -1
- package/dist/{Authentication.d.mts → Authentication.d.ts} +36 -9
- package/dist/Authentication.js +8 -0
- package/dist/Authentication.js.map +1 -1
- package/dist/{Client.d.mts → Client.d.ts} +2473 -557
- package/dist/Client.js +8 -0
- package/dist/Client.js.map +1 -1
- package/dist/{CloudScript.d.mts → CloudScript.d.ts} +214 -46
- package/dist/CloudScript.js +8 -0
- package/dist/CloudScript.js.map +1 -1
- package/dist/{Data.d.mts → Data.d.ts} +144 -25
- package/dist/Data.js +8 -0
- package/dist/Data.js.map +1 -1
- package/dist/{Economy.d.mts → Economy.d.ts} +1218 -173
- package/dist/Economy.js +8 -0
- package/dist/Economy.js.map +1 -1
- package/dist/{Events.d.mts → Events.d.ts} +212 -25
- package/dist/Events.js +8 -0
- package/dist/Events.js.map +1 -1
- package/dist/{Experimentation.d.mts → Experimentation.d.ts} +177 -30
- package/dist/Experimentation.js +8 -0
- package/dist/Experimentation.js.map +1 -1
- package/dist/{Groups.d.mts → Groups.d.ts} +306 -67
- package/dist/Groups.js +8 -0
- package/dist/Groups.js.map +1 -1
- package/dist/{Insights.d.mts → Insights.d.ts} +39 -13
- package/dist/Insights.js +8 -0
- package/dist/Insights.js.map +1 -1
- package/dist/{Localization.d.mts → Localization.d.ts} +6 -3
- package/dist/Localization.js +8 -0
- package/dist/Localization.js.map +1 -1
- package/dist/Matchmaker.d.ts +271 -0
- package/dist/Matchmaker.js +8 -0
- package/dist/Matchmaker.js.map +1 -0
- package/dist/{Multiplayer.d.mts → Multiplayer.d.ts} +2829 -301
- package/dist/Multiplayer.js +8 -0
- package/dist/Multiplayer.js.map +1 -1
- package/dist/{PlayFabCommon-BUv4zqXf.d.mts → PlayFabCommon-Dnp_xHg5.d.ts} +6 -10
- package/dist/{Profiles.d.mts → Profiles.d.ts} +172 -28
- package/dist/Profiles.js +8 -0
- package/dist/Profiles.js.map +1 -1
- package/dist/{Progression.d.mts → Progression.d.ts} +337 -73
- package/dist/Progression.js +8 -0
- package/dist/Progression.js.map +1 -1
- package/dist/{Server.d.mts → Server.d.ts} +2120 -458
- package/dist/Server.js +8 -0
- package/dist/Server.js.map +1 -1
- package/dist/chunk-5LPKBU65.js +2970 -0
- package/dist/chunk-5LPKBU65.js.map +1 -0
- package/dist/chunk-ABEEDFKP.js +175 -0
- package/dist/chunk-ABEEDFKP.js.map +1 -0
- package/dist/chunk-AGNOI6QW.js +2477 -0
- package/dist/chunk-AGNOI6QW.js.map +1 -0
- package/dist/chunk-B4NQUOWG.js +1048 -0
- package/dist/chunk-B4NQUOWG.js.map +1 -0
- package/dist/chunk-GERGPHQM.js +76 -0
- package/dist/chunk-GERGPHQM.js.map +1 -0
- package/dist/chunk-GOZV2MOC.js +2673 -0
- package/dist/chunk-GOZV2MOC.js.map +1 -0
- package/dist/chunk-GXP64DCJ.js +82 -0
- package/dist/chunk-GXP64DCJ.js.map +1 -0
- package/dist/chunk-HUS6GF7X.js +270 -0
- package/dist/chunk-HUS6GF7X.js.map +1 -0
- package/dist/chunk-JIEFHAFU.js +197 -0
- package/dist/chunk-JIEFHAFU.js.map +1 -0
- package/dist/chunk-LCCANUCE.js +2387 -0
- package/dist/chunk-LCCANUCE.js.map +1 -0
- package/dist/chunk-MNQCGRC6.js +357 -0
- package/dist/chunk-MNQCGRC6.js.map +1 -0
- package/dist/chunk-N4R6Y2MM.js +225 -0
- package/dist/chunk-N4R6Y2MM.js.map +1 -0
- package/dist/{Localization.mjs → chunk-N7LC7KNB.js} +43 -94
- package/dist/chunk-N7LC7KNB.js.map +1 -0
- package/dist/chunk-NPTN4F4Z.js +22 -0
- package/dist/chunk-NPTN4F4Z.js.map +1 -0
- package/dist/chunk-QHGWL3NW.js +237 -0
- package/dist/chunk-QHGWL3NW.js.map +1 -0
- package/dist/chunk-RKXM4KV5.js +421 -0
- package/dist/chunk-RKXM4KV5.js.map +1 -0
- package/dist/chunk-UDM2ZVXN.js +421 -0
- package/dist/chunk-UDM2ZVXN.js.map +1 -0
- package/dist/chunk-ZEBSOOZG.js +82 -0
- package/dist/chunk-ZEBSOOZG.js.map +1 -0
- package/dist/index.d.ts +18 -0
- package/dist/index.js +72 -0
- package/dist/index.js.map +1 -1
- package/package.json +2 -1
- package/dist/Addon.mjs +0 -452
- package/dist/Addon.mjs.map +0 -1
- package/dist/Admin.mjs +0 -1112
- package/dist/Admin.mjs.map +0 -1
- package/dist/Authentication.mjs +0 -290
- package/dist/Authentication.mjs.map +0 -1
- package/dist/Client.mjs +0 -1893
- package/dist/Client.mjs.map +0 -1
- package/dist/CloudScript.mjs +0 -349
- package/dist/CloudScript.mjs.map +0 -1
- package/dist/Data.mjs +0 -291
- package/dist/Data.mjs.map +0 -1
- package/dist/Economy.mjs +0 -614
- package/dist/Economy.mjs.map +0 -1
- package/dist/Events.mjs +0 -327
- package/dist/Events.mjs.map +0 -1
- package/dist/Experimentation.mjs +0 -333
- package/dist/Experimentation.mjs.map +0 -1
- package/dist/Groups.mjs +0 -417
- package/dist/Groups.mjs.map +0 -1
- package/dist/Insights.mjs +0 -286
- package/dist/Insights.mjs.map +0 -1
- package/dist/Localization.mjs.map +0 -1
- package/dist/Multiplayer.mjs +0 -862
- package/dist/Multiplayer.mjs.map +0 -1
- package/dist/Profiles.mjs +0 -306
- package/dist/Profiles.mjs.map +0 -1
- package/dist/Progression.mjs +0 -404
- package/dist/Progression.mjs.map +0 -1
- package/dist/Server.mjs +0 -1377
- package/dist/Server.mjs.map +0 -1
- package/dist/index.d.mts +0 -17
- package/dist/index.mjs +0 -6007
- package/dist/index.mjs.map +0 -1
@@ -0,0 +1,270 @@
|
|
1
|
+
import {
|
2
|
+
PlayFabCommon
|
3
|
+
} from "./chunk-N7LC7KNB.js";
|
4
|
+
|
5
|
+
// src/apis/PlayFabCloudScriptApi.ts
|
6
|
+
var PlayFabCloudScriptApi = class extends PlayFabCommon {
|
7
|
+
/**
|
8
|
+
* Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of
|
9
|
+
* custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.
|
10
|
+
*
|
11
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executeentitycloudscript Microsoft Documentation}
|
12
|
+
* @example
|
13
|
+
* await cloudscriptClient.ExecuteEntityCloudScript({
|
14
|
+
* "FunctionName": "levelCompleted",
|
15
|
+
* "FunctionParameter": {
|
16
|
+
* "level": 3,
|
17
|
+
* "points": 400
|
18
|
+
* },
|
19
|
+
* "RevisionSelection": "Live",
|
20
|
+
* "GeneratePlayStreamEvent": true,
|
21
|
+
* "Entity": {
|
22
|
+
* "Id": "aaa",
|
23
|
+
* "Type": "title_player_account",
|
24
|
+
* "TypeString": "title_player_account"
|
25
|
+
* }
|
26
|
+
* });
|
27
|
+
*/
|
28
|
+
ExecuteEntityCloudScript(request, extraHeaders) {
|
29
|
+
return this.ExecuteRequestWrapper("/CloudScript/ExecuteEntityCloudScript", request, "X-EntityToken", extraHeaders);
|
30
|
+
}
|
31
|
+
/**
|
32
|
+
* Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of
|
33
|
+
* custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.
|
34
|
+
*
|
35
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executefunction Microsoft Documentation}
|
36
|
+
* @example
|
37
|
+
* await cloudscriptClient.ExecuteFunction({
|
38
|
+
* "FunctionName": "LevelCompleted",
|
39
|
+
* "FunctionParameter": {
|
40
|
+
* "level": 3,
|
41
|
+
* "points": 400
|
42
|
+
* },
|
43
|
+
* "GeneratePlayStreamEvent": true,
|
44
|
+
* "Entity": {
|
45
|
+
* "Id": "aaa",
|
46
|
+
* "Type": "title_player_account",
|
47
|
+
* "TypeString": "title_player_account"
|
48
|
+
* }
|
49
|
+
* });
|
50
|
+
*/
|
51
|
+
ExecuteFunction(request, extraHeaders) {
|
52
|
+
return this.ExecuteRequestWrapper("/CloudScript/ExecuteFunction", request, "X-EntityToken", extraHeaders);
|
53
|
+
}
|
54
|
+
/**
|
55
|
+
* Gets registered Azure Functions for a given title id and function name.
|
56
|
+
*
|
57
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/getfunction Microsoft Documentation}
|
58
|
+
* @example
|
59
|
+
* await cloudscriptClient.GetFunction({
|
60
|
+
* "FunctionName": "LevelCompleted"
|
61
|
+
* });
|
62
|
+
*/
|
63
|
+
GetFunction(request, extraHeaders) {
|
64
|
+
return this.ExecuteRequestWrapper("/CloudScript/GetFunction", request, "X-EntityToken", extraHeaders);
|
65
|
+
}
|
66
|
+
/**
|
67
|
+
* Lists all currently registered Event Hub triggered Azure Functions for a given title.
|
68
|
+
*
|
69
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listeventhubfunctions Microsoft Documentation}
|
70
|
+
* @example
|
71
|
+
* await cloudscriptClient.ListEventHubFunctions({});
|
72
|
+
*/
|
73
|
+
ListEventHubFunctions(request, extraHeaders) {
|
74
|
+
return this.ExecuteRequestWrapper("/CloudScript/ListEventHubFunctions", request, "X-EntityToken", extraHeaders);
|
75
|
+
}
|
76
|
+
/**
|
77
|
+
* Lists all currently registered Azure Functions for a given title.
|
78
|
+
*
|
79
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listfunctions Microsoft Documentation}
|
80
|
+
* @example
|
81
|
+
* await cloudscriptClient.ListFunctions({});
|
82
|
+
*/
|
83
|
+
ListFunctions(request, extraHeaders) {
|
84
|
+
return this.ExecuteRequestWrapper("/CloudScript/ListFunctions", request, "X-EntityToken", extraHeaders);
|
85
|
+
}
|
86
|
+
/**
|
87
|
+
* Lists all currently registered HTTP triggered Azure Functions for a given title.
|
88
|
+
*
|
89
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listhttpfunctions Microsoft Documentation}
|
90
|
+
* @example
|
91
|
+
* await cloudscriptClient.ListHttpFunctions({});
|
92
|
+
*/
|
93
|
+
ListHttpFunctions(request, extraHeaders) {
|
94
|
+
return this.ExecuteRequestWrapper("/CloudScript/ListHttpFunctions", request, "X-EntityToken", extraHeaders);
|
95
|
+
}
|
96
|
+
/**
|
97
|
+
* Lists all currently registered Queue triggered Azure Functions for a given title.
|
98
|
+
*
|
99
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listqueuedfunctions Microsoft Documentation}
|
100
|
+
* @example
|
101
|
+
* await cloudscriptClient.ListQueuedFunctions({});
|
102
|
+
*/
|
103
|
+
ListQueuedFunctions(request, extraHeaders) {
|
104
|
+
return this.ExecuteRequestWrapper("/CloudScript/ListQueuedFunctions", request, "X-EntityToken", extraHeaders);
|
105
|
+
}
|
106
|
+
/**
|
107
|
+
* Generate an entity PlayStream event for the provided function result.
|
108
|
+
*
|
109
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforentitytriggeredaction Microsoft Documentation}
|
110
|
+
* @example
|
111
|
+
* await cloudscriptClient.PostFunctionResultForEntityTriggeredAction({
|
112
|
+
* "FunctionResult": {
|
113
|
+
* "ExecutionTimeMilliseconds": 367,
|
114
|
+
* "FunctionName": "LevelCompleted",
|
115
|
+
* "FunctionResult": {
|
116
|
+
* "newScore": 25,
|
117
|
+
* "isWinner": false
|
118
|
+
* }
|
119
|
+
* },
|
120
|
+
* "Entity": {
|
121
|
+
* "Id": "ID",
|
122
|
+
* "Type": "title_player_account",
|
123
|
+
* "TypeString": "title_player_account"
|
124
|
+
* }
|
125
|
+
* });
|
126
|
+
*/
|
127
|
+
PostFunctionResultForEntityTriggeredAction(request, extraHeaders) {
|
128
|
+
return this.ExecuteRequestWrapper("/CloudScript/PostFunctionResultForEntityTriggeredAction", request, "X-EntityToken", extraHeaders);
|
129
|
+
}
|
130
|
+
/**
|
131
|
+
* Generate an entity PlayStream event for the provided function result.
|
132
|
+
*
|
133
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforfunctionexecution Microsoft Documentation}
|
134
|
+
* @example
|
135
|
+
* await cloudscriptClient.PostFunctionResultForFunctionExecution({
|
136
|
+
* "FunctionResult": {
|
137
|
+
* "ExecutionTimeMilliseconds": 367,
|
138
|
+
* "FunctionName": "LevelCompleted",
|
139
|
+
* "FunctionResult": {
|
140
|
+
* "newScore": 25,
|
141
|
+
* "isWinner": false
|
142
|
+
* }
|
143
|
+
* },
|
144
|
+
* "Entity": {
|
145
|
+
* "Id": "ID",
|
146
|
+
* "Type": "title_player_account",
|
147
|
+
* "TypeString": "title_player_account"
|
148
|
+
* }
|
149
|
+
* });
|
150
|
+
*/
|
151
|
+
PostFunctionResultForFunctionExecution(request, extraHeaders) {
|
152
|
+
return this.ExecuteRequestWrapper("/CloudScript/PostFunctionResultForFunctionExecution", request, "X-EntityToken", extraHeaders);
|
153
|
+
}
|
154
|
+
/**
|
155
|
+
* Generate a player PlayStream event for the provided function result.
|
156
|
+
*
|
157
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforplayertriggeredaction Microsoft Documentation}
|
158
|
+
* @example
|
159
|
+
* await cloudscriptClient.PostFunctionResultForPlayerTriggeredAction({
|
160
|
+
* "PlayStreamEventEnvelope": {
|
161
|
+
* "EntityId": "1234ABCD",
|
162
|
+
* "EntityType": "title_player_account",
|
163
|
+
* "EventName": "player_logged_in",
|
164
|
+
* "EventNamespace": "com.playfab",
|
165
|
+
* "EventData": "someeventdata",
|
166
|
+
* "EventSettings": "someeventsettings",
|
167
|
+
* "EventToBeDropped": false
|
168
|
+
* },
|
169
|
+
* "PlayerProfile": {
|
170
|
+
* "TitleId": "FFFF",
|
171
|
+
* "PlayerId": "1234ABCD",
|
172
|
+
* "Created": "2019-02-11T20:23:05Z",
|
173
|
+
* "LastLogin": "2020-02-11T20:23:05Z",
|
174
|
+
* "DisplayName": "Gudge"
|
175
|
+
* },
|
176
|
+
* "FunctionResult": {
|
177
|
+
* "ExecutionTimeMilliseconds": 367,
|
178
|
+
* "FunctionName": "LevelCompleted",
|
179
|
+
* "FunctionResult": {
|
180
|
+
* "newScore": 25,
|
181
|
+
* "isWinner": false
|
182
|
+
* }
|
183
|
+
* }
|
184
|
+
* });
|
185
|
+
*/
|
186
|
+
PostFunctionResultForPlayerTriggeredAction(request, extraHeaders) {
|
187
|
+
return this.ExecuteRequestWrapper("/CloudScript/PostFunctionResultForPlayerTriggeredAction", request, "X-EntityToken", extraHeaders);
|
188
|
+
}
|
189
|
+
/**
|
190
|
+
* Generate a PlayStream event for the provided function result.
|
191
|
+
*
|
192
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforscheduledtask Microsoft Documentation}
|
193
|
+
* @example
|
194
|
+
* await cloudscriptClient.PostFunctionResultForScheduledTask({
|
195
|
+
* "ScheduledTaskId": {
|
196
|
+
* "Name": "MyTask",
|
197
|
+
* "Id": "d739e188-22f6-4d13-a4d5-df2e93d4d2f7"
|
198
|
+
* },
|
199
|
+
* "FunctionResult": {
|
200
|
+
* "ExecutionTimeMilliseconds": 367,
|
201
|
+
* "FunctionName": "LevelCompleted",
|
202
|
+
* "FunctionResult": {
|
203
|
+
* "newScore": 25,
|
204
|
+
* "isWinner": false
|
205
|
+
* }
|
206
|
+
* }
|
207
|
+
* });
|
208
|
+
*/
|
209
|
+
PostFunctionResultForScheduledTask(request, extraHeaders) {
|
210
|
+
return this.ExecuteRequestWrapper("/CloudScript/PostFunctionResultForScheduledTask", request, "X-EntityToken", extraHeaders);
|
211
|
+
}
|
212
|
+
/**
|
213
|
+
* Registers an event hub triggered Azure Function with a title.
|
214
|
+
*
|
215
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registereventhubfunction Microsoft Documentation}
|
216
|
+
* @example
|
217
|
+
* await cloudscriptClient.RegisterEventHubFunction({
|
218
|
+
* "EventHubName": "fn-eventhub",
|
219
|
+
* "ConnectionString": "SampleConnectionString",
|
220
|
+
* "FunctionName": "functionName"
|
221
|
+
* });
|
222
|
+
*/
|
223
|
+
RegisterEventHubFunction(request, extraHeaders) {
|
224
|
+
return this.ExecuteRequestWrapper("/CloudScript/RegisterEventHubFunction", request, "X-EntityToken", extraHeaders);
|
225
|
+
}
|
226
|
+
/**
|
227
|
+
* Registers an HTTP triggered Azure function with a title.
|
228
|
+
*
|
229
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerhttpfunction Microsoft Documentation}
|
230
|
+
* @example
|
231
|
+
* await cloudscriptClient.RegisterHttpFunction({
|
232
|
+
* "FunctionUrl": "http://function.url",
|
233
|
+
* "FunctionName": "functionName"
|
234
|
+
* });
|
235
|
+
*/
|
236
|
+
RegisterHttpFunction(request, extraHeaders) {
|
237
|
+
return this.ExecuteRequestWrapper("/CloudScript/RegisterHttpFunction", request, "X-EntityToken", extraHeaders);
|
238
|
+
}
|
239
|
+
/**
|
240
|
+
* Registers a queue triggered Azure Function with a title.
|
241
|
+
*
|
242
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerqueuedfunction Microsoft Documentation}
|
243
|
+
* @example
|
244
|
+
* await cloudscriptClient.RegisterQueuedFunction({
|
245
|
+
* "QueueName": "fn-queue",
|
246
|
+
* "ConnectionString": "SampleConnectionString",
|
247
|
+
* "FunctionName": "functionName"
|
248
|
+
* });
|
249
|
+
*/
|
250
|
+
RegisterQueuedFunction(request, extraHeaders) {
|
251
|
+
return this.ExecuteRequestWrapper("/CloudScript/RegisterQueuedFunction", request, "X-EntityToken", extraHeaders);
|
252
|
+
}
|
253
|
+
/**
|
254
|
+
* Unregisters an Azure Function with a title.
|
255
|
+
*
|
256
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/unregisterfunction Microsoft Documentation}
|
257
|
+
* @example
|
258
|
+
* await cloudscriptClient.UnregisterFunction({
|
259
|
+
* "FunctionName": "functionName"
|
260
|
+
* });
|
261
|
+
*/
|
262
|
+
UnregisterFunction(request, extraHeaders) {
|
263
|
+
return this.ExecuteRequestWrapper("/CloudScript/UnregisterFunction", request, "X-EntityToken", extraHeaders);
|
264
|
+
}
|
265
|
+
};
|
266
|
+
|
267
|
+
export {
|
268
|
+
PlayFabCloudScriptApi
|
269
|
+
};
|
270
|
+
//# sourceMappingURL=chunk-HUS6GF7X.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"sources":["../src/apis/PlayFabCloudScriptApi.ts"],"sourcesContent":["import type {\n ExecuteEntityCloudScriptRequest,\n ExecuteFunctionRequest,\n GetFunctionRequest,\n ListFunctionsRequest,\n PostFunctionResultForEntityTriggeredActionRequest,\n PostFunctionResultForFunctionExecutionRequest,\n PostFunctionResultForPlayerTriggeredActionRequest,\n PostFunctionResultForScheduledTaskRequest,\n RegisterEventHubFunctionRequest,\n RegisterHttpFunctionRequest,\n RegisterQueuedFunctionRequest,\n UnregisterFunctionRequest,\n ExecuteCloudScriptResult,\n ExecuteFunctionResult,\n GetFunctionResult,\n ListEventHubFunctionsResult,\n ListFunctionsResult,\n ListHttpFunctionsResult,\n ListQueuedFunctionsResult,\n EmptyResult,\n} from \"../types/PlayFabCloudScriptApi\";\nimport { PlayFabCommon } from \"../PlayFabCommon\";\n\nexport default class PlayFabCloudScriptApi extends PlayFabCommon {\n\n /**\n * Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of\n * custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executeentitycloudscript Microsoft Documentation}\n * @example\n * await cloudscriptClient.ExecuteEntityCloudScript({\n * \"FunctionName\": \"levelCompleted\",\n * \"FunctionParameter\": {\n * \"level\": 3,\n * \"points\": 400\n * },\n * \"RevisionSelection\": \"Live\",\n * \"GeneratePlayStreamEvent\": true,\n * \"Entity\": {\n * \"Id\": \"aaa\",\n * \"Type\": \"title_player_account\",\n * \"TypeString\": \"title_player_account\"\n * }\n * });\n */\n ExecuteEntityCloudScript (request: ExecuteEntityCloudScriptRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ExecuteCloudScriptResult>(\"/CloudScript/ExecuteEntityCloudScript\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of\n * custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executefunction Microsoft Documentation}\n * @example\n * await cloudscriptClient.ExecuteFunction({\n * \"FunctionName\": \"LevelCompleted\",\n * \"FunctionParameter\": {\n * \"level\": 3,\n * \"points\": 400\n * },\n * \"GeneratePlayStreamEvent\": true,\n * \"Entity\": {\n * \"Id\": \"aaa\",\n * \"Type\": \"title_player_account\",\n * \"TypeString\": \"title_player_account\"\n * }\n * });\n */\n ExecuteFunction (request: ExecuteFunctionRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ExecuteFunctionResult>(\"/CloudScript/ExecuteFunction\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Gets registered Azure Functions for a given title id and function name.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/getfunction Microsoft Documentation}\n * @example\n * await cloudscriptClient.GetFunction({\n * \"FunctionName\": \"LevelCompleted\"\n * });\n */\n GetFunction (request: GetFunctionRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<GetFunctionResult>(\"/CloudScript/GetFunction\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Lists all currently registered Event Hub triggered Azure Functions for a given title.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listeventhubfunctions Microsoft Documentation}\n * @example\n * await cloudscriptClient.ListEventHubFunctions({});\n */\n ListEventHubFunctions (request: ListFunctionsRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ListEventHubFunctionsResult>(\"/CloudScript/ListEventHubFunctions\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Lists all currently registered Azure Functions for a given title.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listfunctions Microsoft Documentation}\n * @example\n * await cloudscriptClient.ListFunctions({});\n */\n ListFunctions (request: ListFunctionsRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ListFunctionsResult>(\"/CloudScript/ListFunctions\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Lists all currently registered HTTP triggered Azure Functions for a given title.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listhttpfunctions Microsoft Documentation}\n * @example\n * await cloudscriptClient.ListHttpFunctions({});\n */\n ListHttpFunctions (request: ListFunctionsRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ListHttpFunctionsResult>(\"/CloudScript/ListHttpFunctions\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Lists all currently registered Queue triggered Azure Functions for a given title.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listqueuedfunctions Microsoft Documentation}\n * @example\n * await cloudscriptClient.ListQueuedFunctions({});\n */\n ListQueuedFunctions (request: ListFunctionsRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<ListQueuedFunctionsResult>(\"/CloudScript/ListQueuedFunctions\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Generate an entity PlayStream event for the provided function result.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforentitytriggeredaction Microsoft Documentation}\n * @example\n * await cloudscriptClient.PostFunctionResultForEntityTriggeredAction({\n * \"FunctionResult\": {\n * \"ExecutionTimeMilliseconds\": 367,\n * \"FunctionName\": \"LevelCompleted\",\n * \"FunctionResult\": {\n * \"newScore\": 25,\n * \"isWinner\": false\n * }\n * },\n * \"Entity\": {\n * \"Id\": \"ID\",\n * \"Type\": \"title_player_account\",\n * \"TypeString\": \"title_player_account\"\n * }\n * });\n */\n PostFunctionResultForEntityTriggeredAction (request: PostFunctionResultForEntityTriggeredActionRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResult>(\"/CloudScript/PostFunctionResultForEntityTriggeredAction\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Generate an entity PlayStream event for the provided function result.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforfunctionexecution Microsoft Documentation}\n * @example\n * await cloudscriptClient.PostFunctionResultForFunctionExecution({\n * \"FunctionResult\": {\n * \"ExecutionTimeMilliseconds\": 367,\n * \"FunctionName\": \"LevelCompleted\",\n * \"FunctionResult\": {\n * \"newScore\": 25,\n * \"isWinner\": false\n * }\n * },\n * \"Entity\": {\n * \"Id\": \"ID\",\n * \"Type\": \"title_player_account\",\n * \"TypeString\": \"title_player_account\"\n * }\n * });\n */\n PostFunctionResultForFunctionExecution (request: PostFunctionResultForFunctionExecutionRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResult>(\"/CloudScript/PostFunctionResultForFunctionExecution\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Generate a player PlayStream event for the provided function result.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforplayertriggeredaction Microsoft Documentation}\n * @example\n * await cloudscriptClient.PostFunctionResultForPlayerTriggeredAction({\n * \"PlayStreamEventEnvelope\": {\n * \"EntityId\": \"1234ABCD\",\n * \"EntityType\": \"title_player_account\",\n * \"EventName\": \"player_logged_in\",\n * \"EventNamespace\": \"com.playfab\",\n * \"EventData\": \"someeventdata\",\n * \"EventSettings\": \"someeventsettings\",\n * \"EventToBeDropped\": false\n * },\n * \"PlayerProfile\": {\n * \"TitleId\": \"FFFF\",\n * \"PlayerId\": \"1234ABCD\",\n * \"Created\": \"2019-02-11T20:23:05Z\",\n * \"LastLogin\": \"2020-02-11T20:23:05Z\",\n * \"DisplayName\": \"Gudge\"\n * },\n * \"FunctionResult\": {\n * \"ExecutionTimeMilliseconds\": 367,\n * \"FunctionName\": \"LevelCompleted\",\n * \"FunctionResult\": {\n * \"newScore\": 25,\n * \"isWinner\": false\n * }\n * }\n * });\n */\n PostFunctionResultForPlayerTriggeredAction (request: PostFunctionResultForPlayerTriggeredActionRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResult>(\"/CloudScript/PostFunctionResultForPlayerTriggeredAction\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Generate a PlayStream event for the provided function result.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforscheduledtask Microsoft Documentation}\n * @example\n * await cloudscriptClient.PostFunctionResultForScheduledTask({\n * \"ScheduledTaskId\": {\n * \"Name\": \"MyTask\",\n * \"Id\": \"d739e188-22f6-4d13-a4d5-df2e93d4d2f7\"\n * },\n * \"FunctionResult\": {\n * \"ExecutionTimeMilliseconds\": 367,\n * \"FunctionName\": \"LevelCompleted\",\n * \"FunctionResult\": {\n * \"newScore\": 25,\n * \"isWinner\": false\n * }\n * }\n * });\n */\n PostFunctionResultForScheduledTask (request: PostFunctionResultForScheduledTaskRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResult>(\"/CloudScript/PostFunctionResultForScheduledTask\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Registers an event hub triggered Azure Function with a title.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registereventhubfunction Microsoft Documentation}\n * @example\n * await cloudscriptClient.RegisterEventHubFunction({\n * \"EventHubName\": \"fn-eventhub\",\n * \"ConnectionString\": \"SampleConnectionString\",\n * \"FunctionName\": \"functionName\"\n * });\n */\n RegisterEventHubFunction (request: RegisterEventHubFunctionRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResult>(\"/CloudScript/RegisterEventHubFunction\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Registers an HTTP triggered Azure function with a title.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerhttpfunction Microsoft Documentation}\n * @example\n * await cloudscriptClient.RegisterHttpFunction({\n * \"FunctionUrl\": \"http://function.url\",\n * \"FunctionName\": \"functionName\"\n * });\n */\n RegisterHttpFunction (request: RegisterHttpFunctionRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResult>(\"/CloudScript/RegisterHttpFunction\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Registers a queue triggered Azure Function with a title.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerqueuedfunction Microsoft Documentation}\n * @example\n * await cloudscriptClient.RegisterQueuedFunction({\n * \"QueueName\": \"fn-queue\",\n * \"ConnectionString\": \"SampleConnectionString\",\n * \"FunctionName\": \"functionName\"\n * });\n */\n RegisterQueuedFunction (request: RegisterQueuedFunctionRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResult>(\"/CloudScript/RegisterQueuedFunction\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Unregisters an Azure Function with a title.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/unregisterfunction Microsoft Documentation}\n * @example\n * await cloudscriptClient.UnregisterFunction({\n * \"FunctionName\": \"functionName\"\n * });\n */\n UnregisterFunction (request: UnregisterFunctionRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<EmptyResult>(\"/CloudScript/UnregisterFunction\", request, \"X-EntityToken\", extraHeaders);\n }\n\n};\n"],"mappings":";;;;;AAwBA,IAAqB,wBAArB,cAAmD,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuB/D,yBAA0B,SAA0C,cAAuC;AACzG,WAAO,KAAK,sBAAgD,yCAAyC,SAAS,iBAAiB,YAAY;AAAA,EAC7I;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,gBAAiB,SAAiC,cAAuC;AACvF,WAAO,KAAK,sBAA6C,gCAAgC,SAAS,iBAAiB,YAAY;AAAA,EACjI;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,YAAa,SAA6B,cAAuC;AAC/E,WAAO,KAAK,sBAAyC,4BAA4B,SAAS,iBAAiB,YAAY;AAAA,EACzH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,sBAAuB,SAA+B,cAAuC;AAC3F,WAAO,KAAK,sBAAmD,sCAAsC,SAAS,iBAAiB,YAAY;AAAA,EAC7I;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,cAAe,SAA+B,cAAuC;AACnF,WAAO,KAAK,sBAA2C,8BAA8B,SAAS,iBAAiB,YAAY;AAAA,EAC7H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,kBAAmB,SAA+B,cAAuC;AACvF,WAAO,KAAK,sBAA+C,kCAAkC,SAAS,iBAAiB,YAAY;AAAA,EACrI;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,oBAAqB,SAA+B,cAAuC;AACzF,WAAO,KAAK,sBAAiD,oCAAoC,SAAS,iBAAiB,YAAY;AAAA,EACzI;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBA,2CAA4C,SAA4D,cAAuC;AAC7I,WAAO,KAAK,sBAAmC,2DAA2D,SAAS,iBAAiB,YAAY;AAAA,EAClJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBA,uCAAwC,SAAwD,cAAuC;AACrI,WAAO,KAAK,sBAAmC,uDAAuD,SAAS,iBAAiB,YAAY;AAAA,EAC9I;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkCA,2CAA4C,SAA4D,cAAuC;AAC7I,WAAO,KAAK,sBAAmC,2DAA2D,SAAS,iBAAiB,YAAY;AAAA,EAClJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,mCAAoC,SAAoD,cAAuC;AAC7H,WAAO,KAAK,sBAAmC,mDAAmD,SAAS,iBAAiB,YAAY;AAAA,EAC1I;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,yBAA0B,SAA0C,cAAuC;AACzG,WAAO,KAAK,sBAAmC,yCAAyC,SAAS,iBAAiB,YAAY;AAAA,EAChI;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,qBAAsB,SAAsC,cAAuC;AACjG,WAAO,KAAK,sBAAmC,qCAAqC,SAAS,iBAAiB,YAAY;AAAA,EAC5H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,uBAAwB,SAAwC,cAAuC;AACrG,WAAO,KAAK,sBAAmC,uCAAuC,SAAS,iBAAiB,YAAY;AAAA,EAC9H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,mBAAoB,SAAoC,cAAuC;AAC7F,WAAO,KAAK,sBAAmC,mCAAmC,SAAS,iBAAiB,YAAY;AAAA,EAC1H;AAEF;","names":[]}
|
@@ -0,0 +1,197 @@
|
|
1
|
+
import {
|
2
|
+
PlayFabCommon
|
3
|
+
} from "./chunk-N7LC7KNB.js";
|
4
|
+
|
5
|
+
// src/apis/PlayFabProfilesApi.ts
|
6
|
+
var PlayFabProfilesApi = class extends PlayFabCommon {
|
7
|
+
/**
|
8
|
+
* Gets the global title access policy
|
9
|
+
*
|
10
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/getglobalpolicy Microsoft Documentation}
|
11
|
+
* @example
|
12
|
+
* await profileClient.GetGlobalPolicy({});
|
13
|
+
*/
|
14
|
+
GetGlobalPolicy(request, extraHeaders) {
|
15
|
+
return this.ExecuteRequestWrapper("/Profile/GetGlobalPolicy", request, "X-EntityToken", extraHeaders);
|
16
|
+
}
|
17
|
+
/**
|
18
|
+
* Retrieves the entity's profile.
|
19
|
+
*
|
20
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/getprofile Microsoft Documentation}
|
21
|
+
* @example
|
22
|
+
* await profileClient.GetProfile({
|
23
|
+
* "Entity": {
|
24
|
+
* "Id": "1234567787392",
|
25
|
+
* "Type": "title_player_account",
|
26
|
+
* "TypeString": "title_player_account"
|
27
|
+
* }
|
28
|
+
* });
|
29
|
+
*/
|
30
|
+
GetProfile(request, extraHeaders) {
|
31
|
+
return this.ExecuteRequestWrapper("/Profile/GetProfile", request, "X-EntityToken", extraHeaders);
|
32
|
+
}
|
33
|
+
/**
|
34
|
+
* Retrieves the entity's profile.
|
35
|
+
*
|
36
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/getprofiles Microsoft Documentation}
|
37
|
+
* @example
|
38
|
+
* await profileClient.GetProfiles({
|
39
|
+
* "Entities": [
|
40
|
+
* {
|
41
|
+
* "Id": "1234567787392",
|
42
|
+
* "Type": "title_player_account",
|
43
|
+
* "TypeString": "title_player_account"
|
44
|
+
* },
|
45
|
+
* {
|
46
|
+
* "Id": "42434567785265",
|
47
|
+
* "Type": "title_player_account",
|
48
|
+
* "TypeString": "title_player_account"
|
49
|
+
* }
|
50
|
+
* ]
|
51
|
+
* });
|
52
|
+
*/
|
53
|
+
GetProfiles(request, extraHeaders) {
|
54
|
+
return this.ExecuteRequestWrapper("/Profile/GetProfiles", request, "X-EntityToken", extraHeaders);
|
55
|
+
}
|
56
|
+
/**
|
57
|
+
* Retrieves the title player accounts associated with the given master player account.
|
58
|
+
*
|
59
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/gettitleplayersfrommasterplayeraccountids Microsoft Documentation}
|
60
|
+
* @example
|
61
|
+
* await profileClient.GetTitlePlayersFromMasterPlayerAccountIds({
|
62
|
+
* "MasterPlayerAccountIds": [
|
63
|
+
* "1233455677"
|
64
|
+
* ],
|
65
|
+
* "TitleId": "abc123"
|
66
|
+
* });
|
67
|
+
*/
|
68
|
+
GetTitlePlayersFromMasterPlayerAccountIds(request, extraHeaders) {
|
69
|
+
return this.ExecuteRequestWrapper("/Profile/GetTitlePlayersFromMasterPlayerAccountIds", request, "X-EntityToken", extraHeaders);
|
70
|
+
}
|
71
|
+
/**
|
72
|
+
* Retrieves the title player accounts associated with the given XUIDs.
|
73
|
+
*
|
74
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/gettitleplayersfromxboxliveids Microsoft Documentation}
|
75
|
+
* @example
|
76
|
+
* await profileClient.GetTitlePlayersFromXboxLiveIDs({
|
77
|
+
* "XboxLiveIds": [
|
78
|
+
* "1233455677"
|
79
|
+
* ],
|
80
|
+
* "Sandbox": "RETAIL"
|
81
|
+
* });
|
82
|
+
*/
|
83
|
+
GetTitlePlayersFromXboxLiveIDs(request, extraHeaders) {
|
84
|
+
return this.ExecuteRequestWrapper("/Profile/GetTitlePlayersFromXboxLiveIDs", request, "X-EntityToken", extraHeaders);
|
85
|
+
}
|
86
|
+
/**
|
87
|
+
* Update the avatar url of the entity
|
88
|
+
*
|
89
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setavatarurl Microsoft Documentation}
|
90
|
+
* @example
|
91
|
+
* await profileClient.SetAvatarUrl({
|
92
|
+
* "AvatarUrl": "https://test.com/image.png",
|
93
|
+
* "ProfileVersion": 123,
|
94
|
+
* "Entity": {
|
95
|
+
* "Id": "90901000",
|
96
|
+
* "Type": "title_player_account",
|
97
|
+
* "TypeString": "title_player_account"
|
98
|
+
* }
|
99
|
+
* });
|
100
|
+
*/
|
101
|
+
SetAvatarUrl(request, extraHeaders) {
|
102
|
+
return this.ExecuteRequestWrapper("/Profile/SetAvatarUrl", request, "X-EntityToken", extraHeaders);
|
103
|
+
}
|
104
|
+
/**
|
105
|
+
* Update the display name of the entity
|
106
|
+
*
|
107
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setdisplayname Microsoft Documentation}
|
108
|
+
* @example
|
109
|
+
* await profileClient.SetDisplayName({
|
110
|
+
* "DisplayName": "My new display name",
|
111
|
+
* "ExpectedVersion": 123,
|
112
|
+
* "Entity": {
|
113
|
+
* "Id": "90901000",
|
114
|
+
* "Type": "title_player_account",
|
115
|
+
* "TypeString": "title_player_account"
|
116
|
+
* }
|
117
|
+
* });
|
118
|
+
*/
|
119
|
+
SetDisplayName(request, extraHeaders) {
|
120
|
+
return this.ExecuteRequestWrapper("/Profile/SetDisplayName", request, "X-EntityToken", extraHeaders);
|
121
|
+
}
|
122
|
+
/**
|
123
|
+
* Sets the global title access policy
|
124
|
+
*
|
125
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setglobalpolicy Microsoft Documentation}
|
126
|
+
* @example
|
127
|
+
* await profileClient.SetGlobalPolicy({
|
128
|
+
* "Permissions": [
|
129
|
+
* {
|
130
|
+
* "Resource": "pfrn:data--title_player_account!90901000/Profile/SomethingCool",
|
131
|
+
* "Action": "*",
|
132
|
+
* "Effect": "Allow",
|
133
|
+
* "Principal": {
|
134
|
+
* "ChildOf": {
|
135
|
+
* "EntityType": "[SELF]"
|
136
|
+
* }
|
137
|
+
* },
|
138
|
+
* "Comment": "An example policy"
|
139
|
+
* }
|
140
|
+
* ]
|
141
|
+
* });
|
142
|
+
*/
|
143
|
+
SetGlobalPolicy(request, extraHeaders) {
|
144
|
+
return this.ExecuteRequestWrapper("/Profile/SetGlobalPolicy", request, "X-EntityToken", extraHeaders);
|
145
|
+
}
|
146
|
+
/**
|
147
|
+
* Updates the entity's language. The precedence hierarchy for communication to the player is Title Player Account
|
148
|
+
* language, Master Player Account language, and then title default language if the first two aren't set or supported.
|
149
|
+
*
|
150
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setprofilelanguage Microsoft Documentation}
|
151
|
+
* @example
|
152
|
+
* await profileClient.SetProfileLanguage({
|
153
|
+
* "Language": "en",
|
154
|
+
* "ExpectedVersion": 123,
|
155
|
+
* "Entity": {
|
156
|
+
* "Id": "1234",
|
157
|
+
* "Type": "title_player_account",
|
158
|
+
* "TypeString": "title_player_account"
|
159
|
+
* }
|
160
|
+
* });
|
161
|
+
*/
|
162
|
+
SetProfileLanguage(request, extraHeaders) {
|
163
|
+
return this.ExecuteRequestWrapper("/Profile/SetProfileLanguage", request, "X-EntityToken", extraHeaders);
|
164
|
+
}
|
165
|
+
/**
|
166
|
+
* Sets the profiles access policy
|
167
|
+
*
|
168
|
+
* {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setprofilepolicy Microsoft Documentation}
|
169
|
+
* @example
|
170
|
+
* await profileClient.SetProfilePolicy({
|
171
|
+
* "Statements": [
|
172
|
+
* {
|
173
|
+
* "Resource": "pfrn:data--*!*\/Profile/Files/avatar.png",
|
174
|
+
* "Action": "Read",
|
175
|
+
* "Effect": "Allow",
|
176
|
+
* "Principal": {
|
177
|
+
* "FriendOf": "true"
|
178
|
+
* },
|
179
|
+
* "Comment": "Allow my friends to read my avatar"
|
180
|
+
* }
|
181
|
+
* ],
|
182
|
+
* "Entity": {
|
183
|
+
* "Id": "90901000",
|
184
|
+
* "Type": "title_player_account",
|
185
|
+
* "TypeString": "title_player_account"
|
186
|
+
* }
|
187
|
+
* });
|
188
|
+
*/
|
189
|
+
SetProfilePolicy(request, extraHeaders) {
|
190
|
+
return this.ExecuteRequestWrapper("/Profile/SetProfilePolicy", request, "X-EntityToken", extraHeaders);
|
191
|
+
}
|
192
|
+
};
|
193
|
+
|
194
|
+
export {
|
195
|
+
PlayFabProfilesApi
|
196
|
+
};
|
197
|
+
//# sourceMappingURL=chunk-JIEFHAFU.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"sources":["../src/apis/PlayFabProfilesApi.ts"],"sourcesContent":["import type {\n GetGlobalPolicyRequest,\n GetEntityProfileRequest,\n GetEntityProfilesRequest,\n GetTitlePlayersFromMasterPlayerAccountIdsRequest,\n GetTitlePlayersFromXboxLiveIDsRequest,\n SetAvatarUrlRequest,\n SetDisplayNameRequest,\n SetGlobalPolicyRequest,\n SetProfileLanguageRequest,\n SetEntityProfilePolicyRequest,\n GetGlobalPolicyResponse,\n GetEntityProfileResponse,\n GetEntityProfilesResponse,\n GetTitlePlayersFromMasterPlayerAccountIdsResponse,\n GetTitlePlayersFromProviderIDsResponse,\n SetAvatarUrlResponse,\n SetDisplayNameResponse,\n SetGlobalPolicyResponse,\n SetProfileLanguageResponse,\n SetEntityProfilePolicyResponse,\n} from \"../types/PlayFabProfilesApi\";\nimport { PlayFabCommon } from \"../PlayFabCommon\";\n\nexport default class PlayFabProfilesApi extends PlayFabCommon {\n\n /**\n * Gets the global title access policy\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/getglobalpolicy Microsoft Documentation}\n * @example\n * await profileClient.GetGlobalPolicy({});\n */\n GetGlobalPolicy (request: GetGlobalPolicyRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<GetGlobalPolicyResponse>(\"/Profile/GetGlobalPolicy\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Retrieves the entity's profile.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/getprofile Microsoft Documentation}\n * @example\n * await profileClient.GetProfile({\n * \"Entity\": {\n * \"Id\": \"1234567787392\",\n * \"Type\": \"title_player_account\",\n * \"TypeString\": \"title_player_account\"\n * }\n * });\n */\n GetProfile (request: GetEntityProfileRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<GetEntityProfileResponse>(\"/Profile/GetProfile\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Retrieves the entity's profile.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/getprofiles Microsoft Documentation}\n * @example\n * await profileClient.GetProfiles({\n * \"Entities\": [\n * {\n * \"Id\": \"1234567787392\",\n * \"Type\": \"title_player_account\",\n * \"TypeString\": \"title_player_account\"\n * },\n * {\n * \"Id\": \"42434567785265\",\n * \"Type\": \"title_player_account\",\n * \"TypeString\": \"title_player_account\"\n * }\n * ]\n * });\n */\n GetProfiles (request: GetEntityProfilesRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<GetEntityProfilesResponse>(\"/Profile/GetProfiles\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Retrieves the title player accounts associated with the given master player account.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/gettitleplayersfrommasterplayeraccountids Microsoft Documentation}\n * @example\n * await profileClient.GetTitlePlayersFromMasterPlayerAccountIds({\n * \"MasterPlayerAccountIds\": [\n * \"1233455677\"\n * ],\n * \"TitleId\": \"abc123\"\n * });\n */\n GetTitlePlayersFromMasterPlayerAccountIds (request: GetTitlePlayersFromMasterPlayerAccountIdsRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<GetTitlePlayersFromMasterPlayerAccountIdsResponse>(\"/Profile/GetTitlePlayersFromMasterPlayerAccountIds\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Retrieves the title player accounts associated with the given XUIDs.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/gettitleplayersfromxboxliveids Microsoft Documentation}\n * @example\n * await profileClient.GetTitlePlayersFromXboxLiveIDs({\n * \"XboxLiveIds\": [\n * \"1233455677\"\n * ],\n * \"Sandbox\": \"RETAIL\"\n * });\n */\n GetTitlePlayersFromXboxLiveIDs (request: GetTitlePlayersFromXboxLiveIDsRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<GetTitlePlayersFromProviderIDsResponse>(\"/Profile/GetTitlePlayersFromXboxLiveIDs\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Update the avatar url of the entity\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setavatarurl Microsoft Documentation}\n * @example\n * await profileClient.SetAvatarUrl({\n * \"AvatarUrl\": \"https://test.com/image.png\",\n * \"ProfileVersion\": 123,\n * \"Entity\": {\n * \"Id\": \"90901000\",\n * \"Type\": \"title_player_account\",\n * \"TypeString\": \"title_player_account\"\n * }\n * });\n */\n SetAvatarUrl (request: SetAvatarUrlRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<SetAvatarUrlResponse>(\"/Profile/SetAvatarUrl\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Update the display name of the entity\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setdisplayname Microsoft Documentation}\n * @example\n * await profileClient.SetDisplayName({\n * \"DisplayName\": \"My new display name\",\n * \"ExpectedVersion\": 123,\n * \"Entity\": {\n * \"Id\": \"90901000\",\n * \"Type\": \"title_player_account\",\n * \"TypeString\": \"title_player_account\"\n * }\n * });\n */\n SetDisplayName (request: SetDisplayNameRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<SetDisplayNameResponse>(\"/Profile/SetDisplayName\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Sets the global title access policy\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setglobalpolicy Microsoft Documentation}\n * @example\n * await profileClient.SetGlobalPolicy({\n * \"Permissions\": [\n * {\n * \"Resource\": \"pfrn:data--title_player_account!90901000/Profile/SomethingCool\",\n * \"Action\": \"*\",\n * \"Effect\": \"Allow\",\n * \"Principal\": {\n * \"ChildOf\": {\n * \"EntityType\": \"[SELF]\"\n * }\n * },\n * \"Comment\": \"An example policy\"\n * }\n * ]\n * });\n */\n SetGlobalPolicy (request: SetGlobalPolicyRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<SetGlobalPolicyResponse>(\"/Profile/SetGlobalPolicy\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Updates the entity's language. The precedence hierarchy for communication to the player is Title Player Account\n * language, Master Player Account language, and then title default language if the first two aren't set or supported.\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setprofilelanguage Microsoft Documentation}\n * @example\n * await profileClient.SetProfileLanguage({\n * \"Language\": \"en\",\n * \"ExpectedVersion\": 123,\n * \"Entity\": {\n * \"Id\": \"1234\",\n * \"Type\": \"title_player_account\",\n * \"TypeString\": \"title_player_account\"\n * }\n * });\n */\n SetProfileLanguage (request: SetProfileLanguageRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<SetProfileLanguageResponse>(\"/Profile/SetProfileLanguage\", request, \"X-EntityToken\", extraHeaders);\n }\n\n /**\n * Sets the profiles access policy\n * \n * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setprofilepolicy Microsoft Documentation}\n * @example\n * await profileClient.SetProfilePolicy({\n * \"Statements\": [\n * {\n * \"Resource\": \"pfrn:data--*!*\\/Profile/Files/avatar.png\",\n * \"Action\": \"Read\",\n * \"Effect\": \"Allow\",\n * \"Principal\": {\n * \"FriendOf\": \"true\"\n * },\n * \"Comment\": \"Allow my friends to read my avatar\"\n * }\n * ],\n * \"Entity\": {\n * \"Id\": \"90901000\",\n * \"Type\": \"title_player_account\",\n * \"TypeString\": \"title_player_account\"\n * }\n * });\n */\n SetProfilePolicy (request: SetEntityProfilePolicyRequest, extraHeaders?: Record<string, string>) {\n return this.ExecuteRequestWrapper<SetEntityProfilePolicyResponse>(\"/Profile/SetProfilePolicy\", request, \"X-EntityToken\", extraHeaders);\n }\n\n};\n"],"mappings":";;;;;AAwBA,IAAqB,qBAArB,cAAgD,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAS5D,gBAAiB,SAAiC,cAAuC;AACvF,WAAO,KAAK,sBAA+C,4BAA4B,SAAS,iBAAiB,YAAY;AAAA,EAC/H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,WAAY,SAAkC,cAAuC;AACnF,WAAO,KAAK,sBAAgD,uBAAuB,SAAS,iBAAiB,YAAY;AAAA,EAC3H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,YAAa,SAAmC,cAAuC;AACrF,WAAO,KAAK,sBAAiD,wBAAwB,SAAS,iBAAiB,YAAY;AAAA,EAC7H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,0CAA2C,SAA2D,cAAuC;AAC3I,WAAO,KAAK,sBAAyE,sDAAsD,SAAS,iBAAiB,YAAY;AAAA,EACnL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,+BAAgC,SAAgD,cAAuC;AACrH,WAAO,KAAK,sBAA8D,2CAA2C,SAAS,iBAAiB,YAAY;AAAA,EAC7J;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,aAAc,SAA8B,cAAuC;AACjF,WAAO,KAAK,sBAA4C,yBAAyB,SAAS,iBAAiB,YAAY;AAAA,EACzH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,eAAgB,SAAgC,cAAuC;AACrF,WAAO,KAAK,sBAA8C,2BAA2B,SAAS,iBAAiB,YAAY;AAAA,EAC7H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBA,gBAAiB,SAAiC,cAAuC;AACvF,WAAO,KAAK,sBAA+C,4BAA4B,SAAS,iBAAiB,YAAY;AAAA,EAC/H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,mBAAoB,SAAoC,cAAuC;AAC7F,WAAO,KAAK,sBAAkD,+BAA+B,SAAS,iBAAiB,YAAY;AAAA,EACrI;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA0BA,iBAAkB,SAAwC,cAAuC;AAC/F,WAAO,KAAK,sBAAsD,6BAA6B,SAAS,iBAAiB,YAAY;AAAA,EACvI;AAEF;","names":[]}
|