@jacobhumston/roblox-openapi-ts 1.0.60 → 1.0.62
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/types.d.ts +1093 -1505
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -239,7 +239,7 @@ export interface paths {
|
|
|
239
239
|
query?: {
|
|
240
240
|
/** @description Universe ID to check eligibility for */
|
|
241
241
|
universeId?: string;
|
|
242
|
-
/** @description Objective filter (PLAYS or
|
|
242
|
+
/** @description Objective filter (PLAYS or ENGAGEMENT) */
|
|
243
243
|
objective?: "PLAYS" | "ENGAGEMENT";
|
|
244
244
|
};
|
|
245
245
|
header?: never;
|
|
@@ -784,6 +784,505 @@ export interface paths {
|
|
|
784
784
|
patch?: never;
|
|
785
785
|
trace?: never;
|
|
786
786
|
};
|
|
787
|
+
"/analytics-alert-control-plane/v1/resource/{resourceType}/id/{resourceId}/alerts": {
|
|
788
|
+
parameters: {
|
|
789
|
+
query?: never;
|
|
790
|
+
header?: never;
|
|
791
|
+
path?: never;
|
|
792
|
+
cookie?: never;
|
|
793
|
+
};
|
|
794
|
+
/**
|
|
795
|
+
* Returns the alert configurations for a resource. Optionally filter by alert IDs, firing
|
|
796
|
+
* status, severity, or metric name.
|
|
797
|
+
*/
|
|
798
|
+
get: {
|
|
799
|
+
parameters: {
|
|
800
|
+
query?: {
|
|
801
|
+
/**
|
|
802
|
+
* @description Optional list of alert IDs to restrict results to. Repeat the parameter for multiple
|
|
803
|
+
* values: `?ids=1&ids=2`. IDs are string-encoded 64-bit integers.
|
|
804
|
+
*/
|
|
805
|
+
ids?: string[];
|
|
806
|
+
/**
|
|
807
|
+
* @description Optional firing-status filter (`OK` or `Firing`).
|
|
808
|
+
*
|
|
809
|
+
* OK
|
|
810
|
+
*
|
|
811
|
+
* Firing
|
|
812
|
+
*/
|
|
813
|
+
firingStatus?: components["schemas"]["AlertStorage.FiringStatus"];
|
|
814
|
+
/**
|
|
815
|
+
* @description Optional list of severity levels to filter by. Repeat the parameter for multiple
|
|
816
|
+
* values: `?severities=SEV_0&severities=SEV_1`.
|
|
817
|
+
*/
|
|
818
|
+
severities?: components["schemas"]["AlertStorage.Severity"][];
|
|
819
|
+
/**
|
|
820
|
+
* @description Optional list of metric names to filter by (exact match, case-sensitive). Repeat the
|
|
821
|
+
* parameter for multiple values: `?metrics=dau&metrics=mau`.
|
|
822
|
+
*/
|
|
823
|
+
metrics?: string[];
|
|
824
|
+
};
|
|
825
|
+
header?: never;
|
|
826
|
+
path: {
|
|
827
|
+
/**
|
|
828
|
+
* @description The type of resource to query. Currently only `Universe` is supported.
|
|
829
|
+
*
|
|
830
|
+
* Universe
|
|
831
|
+
*/
|
|
832
|
+
resourceType: components["schemas"]["AlertStorage.ResourceType"];
|
|
833
|
+
/** @description The numeric ID of the resource (e.g. the universe ID). */
|
|
834
|
+
resourceId: string;
|
|
835
|
+
};
|
|
836
|
+
cookie?: never;
|
|
837
|
+
};
|
|
838
|
+
requestBody?: never;
|
|
839
|
+
responses: {
|
|
840
|
+
/** @description OK */
|
|
841
|
+
200: {
|
|
842
|
+
headers: {
|
|
843
|
+
[name: string]: unknown;
|
|
844
|
+
};
|
|
845
|
+
content: {
|
|
846
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.AlertDetailResponse"][];
|
|
847
|
+
};
|
|
848
|
+
};
|
|
849
|
+
/** @description Bad Request */
|
|
850
|
+
400: {
|
|
851
|
+
headers: {
|
|
852
|
+
[name: string]: unknown;
|
|
853
|
+
};
|
|
854
|
+
content: {
|
|
855
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
856
|
+
};
|
|
857
|
+
};
|
|
858
|
+
/** @description Unauthorized */
|
|
859
|
+
401: {
|
|
860
|
+
headers: {
|
|
861
|
+
[name: string]: unknown;
|
|
862
|
+
};
|
|
863
|
+
content: {
|
|
864
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
865
|
+
};
|
|
866
|
+
};
|
|
867
|
+
/** @description Forbidden */
|
|
868
|
+
403: {
|
|
869
|
+
headers: {
|
|
870
|
+
[name: string]: unknown;
|
|
871
|
+
};
|
|
872
|
+
content: {
|
|
873
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
874
|
+
};
|
|
875
|
+
};
|
|
876
|
+
/** @description Service Unavailable */
|
|
877
|
+
503: {
|
|
878
|
+
headers: {
|
|
879
|
+
[name: string]: unknown;
|
|
880
|
+
};
|
|
881
|
+
content: {
|
|
882
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
883
|
+
};
|
|
884
|
+
};
|
|
885
|
+
};
|
|
886
|
+
};
|
|
887
|
+
put?: never;
|
|
888
|
+
/**
|
|
889
|
+
* Creates a new alert configuration for a resource.
|
|
890
|
+
* @description See the <a href="https://create.roblox.com/docs/cloud/guides/alerts/metrics">alerts guide</a> for supported metrics and dimensions.
|
|
891
|
+
*/
|
|
892
|
+
post: {
|
|
893
|
+
parameters: {
|
|
894
|
+
query?: never;
|
|
895
|
+
header?: never;
|
|
896
|
+
path: {
|
|
897
|
+
/**
|
|
898
|
+
* @description The type of resource to create the alert on. Currently only `Universe` is supported.
|
|
899
|
+
*
|
|
900
|
+
* Universe
|
|
901
|
+
*/
|
|
902
|
+
resourceType: components["schemas"]["AlertStorage.ResourceType"];
|
|
903
|
+
/** @description The numeric ID of the resource (e.g. the universe ID). */
|
|
904
|
+
resourceId: string;
|
|
905
|
+
};
|
|
906
|
+
cookie?: never;
|
|
907
|
+
};
|
|
908
|
+
/** @description The alert configuration to create. */
|
|
909
|
+
requestBody?: {
|
|
910
|
+
content: {
|
|
911
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.CreateAlertConfigRequest"];
|
|
912
|
+
"text/json": components["schemas"]["AnalyticsAlertControlPlane.Models.CreateAlertConfigRequest"];
|
|
913
|
+
"application/*+json": components["schemas"]["AnalyticsAlertControlPlane.Models.CreateAlertConfigRequest"];
|
|
914
|
+
};
|
|
915
|
+
};
|
|
916
|
+
responses: {
|
|
917
|
+
/** @description Created */
|
|
918
|
+
201: {
|
|
919
|
+
headers: {
|
|
920
|
+
[name: string]: unknown;
|
|
921
|
+
};
|
|
922
|
+
content: {
|
|
923
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.AlertDetailResponse"];
|
|
924
|
+
};
|
|
925
|
+
};
|
|
926
|
+
/** @description Bad Request */
|
|
927
|
+
400: {
|
|
928
|
+
headers: {
|
|
929
|
+
[name: string]: unknown;
|
|
930
|
+
};
|
|
931
|
+
content: {
|
|
932
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
933
|
+
};
|
|
934
|
+
};
|
|
935
|
+
/** @description Unauthorized */
|
|
936
|
+
401: {
|
|
937
|
+
headers: {
|
|
938
|
+
[name: string]: unknown;
|
|
939
|
+
};
|
|
940
|
+
content: {
|
|
941
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
942
|
+
};
|
|
943
|
+
};
|
|
944
|
+
/** @description Forbidden */
|
|
945
|
+
403: {
|
|
946
|
+
headers: {
|
|
947
|
+
[name: string]: unknown;
|
|
948
|
+
};
|
|
949
|
+
content: {
|
|
950
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
951
|
+
};
|
|
952
|
+
};
|
|
953
|
+
/**
|
|
954
|
+
* @description Conflict. Possible error codes:
|
|
955
|
+
*
|
|
956
|
+
* - `ALERT_NAME_EXISTED`: An alert with this name already exists for the resource.
|
|
957
|
+
* Alert names must be unique per resource.
|
|
958
|
+
*
|
|
959
|
+
* - `MAX_ALERT_REACHED`: The resource has reached the maximum number of allowed alerts.
|
|
960
|
+
*/
|
|
961
|
+
409: {
|
|
962
|
+
headers: {
|
|
963
|
+
[name: string]: unknown;
|
|
964
|
+
};
|
|
965
|
+
content: {
|
|
966
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
967
|
+
};
|
|
968
|
+
};
|
|
969
|
+
/** @description Service Unavailable */
|
|
970
|
+
503: {
|
|
971
|
+
headers: {
|
|
972
|
+
[name: string]: unknown;
|
|
973
|
+
};
|
|
974
|
+
content: {
|
|
975
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
976
|
+
};
|
|
977
|
+
};
|
|
978
|
+
};
|
|
979
|
+
};
|
|
980
|
+
delete?: never;
|
|
981
|
+
options?: never;
|
|
982
|
+
head?: never;
|
|
983
|
+
patch?: never;
|
|
984
|
+
trace?: never;
|
|
985
|
+
};
|
|
986
|
+
"/analytics-alert-control-plane/v1/resource/{resourceType}/id/{resourceId}/alerts/incidents": {
|
|
987
|
+
parameters: {
|
|
988
|
+
query?: never;
|
|
989
|
+
header?: never;
|
|
990
|
+
path?: never;
|
|
991
|
+
cookie?: never;
|
|
992
|
+
};
|
|
993
|
+
/**
|
|
994
|
+
* Returns alert incidents for a resource whose active window overlaps the specified time
|
|
995
|
+
* range. An incident is included if it was open at any point between `startTime` and
|
|
996
|
+
* `endTime`.
|
|
997
|
+
*/
|
|
998
|
+
get: {
|
|
999
|
+
parameters: {
|
|
1000
|
+
query: {
|
|
1001
|
+
/**
|
|
1002
|
+
* @description Start of the time range to query (ISO 8601, UTC). Must be within the last 30 days
|
|
1003
|
+
* (see AnalyticsAlertControlPlane.Operations.GetAlertIncidentsOperation.MaxQueryDays).
|
|
1004
|
+
*/
|
|
1005
|
+
startTime: string;
|
|
1006
|
+
/**
|
|
1007
|
+
* @description End of the time range to query (ISO 8601, UTC). Must be greater than or equal to
|
|
1008
|
+
* `startTime`.
|
|
1009
|
+
*/
|
|
1010
|
+
endTime: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* @description Optional metric name to restrict results to incidents from alerts on that metric (exact
|
|
1013
|
+
* match, case-sensitive).
|
|
1014
|
+
*/
|
|
1015
|
+
metric?: string;
|
|
1016
|
+
/**
|
|
1017
|
+
* @description Optional list of alert IDs to restrict results to. Repeat the parameter for multiple
|
|
1018
|
+
* values: `?alertIds=1&alertIds=2`. IDs are string-encoded 64-bit integers.
|
|
1019
|
+
*/
|
|
1020
|
+
alertIds?: string[];
|
|
1021
|
+
/**
|
|
1022
|
+
* @description Optional list of severity levels to restrict results to. Repeat the parameter for
|
|
1023
|
+
* multiple values: `?severities=SEV_0&severities=SEV_1`.
|
|
1024
|
+
*/
|
|
1025
|
+
severities?: components["schemas"]["AlertStorage.Severity"][];
|
|
1026
|
+
};
|
|
1027
|
+
header?: never;
|
|
1028
|
+
path: {
|
|
1029
|
+
/**
|
|
1030
|
+
* @description The type of resource to query. Currently only `Universe` is supported.
|
|
1031
|
+
*
|
|
1032
|
+
* Universe
|
|
1033
|
+
*/
|
|
1034
|
+
resourceType: components["schemas"]["AlertStorage.ResourceType"];
|
|
1035
|
+
/** @description The numeric ID of the resource (e.g. the universe ID). */
|
|
1036
|
+
resourceId: string;
|
|
1037
|
+
};
|
|
1038
|
+
cookie?: never;
|
|
1039
|
+
};
|
|
1040
|
+
requestBody?: never;
|
|
1041
|
+
responses: {
|
|
1042
|
+
/** @description OK */
|
|
1043
|
+
200: {
|
|
1044
|
+
headers: {
|
|
1045
|
+
[name: string]: unknown;
|
|
1046
|
+
};
|
|
1047
|
+
content: {
|
|
1048
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.IncidentDetailResponse"][];
|
|
1049
|
+
};
|
|
1050
|
+
};
|
|
1051
|
+
/** @description Bad Request */
|
|
1052
|
+
400: {
|
|
1053
|
+
headers: {
|
|
1054
|
+
[name: string]: unknown;
|
|
1055
|
+
};
|
|
1056
|
+
content: {
|
|
1057
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1058
|
+
};
|
|
1059
|
+
};
|
|
1060
|
+
/** @description Unauthorized */
|
|
1061
|
+
401: {
|
|
1062
|
+
headers: {
|
|
1063
|
+
[name: string]: unknown;
|
|
1064
|
+
};
|
|
1065
|
+
content: {
|
|
1066
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1067
|
+
};
|
|
1068
|
+
};
|
|
1069
|
+
/** @description Forbidden */
|
|
1070
|
+
403: {
|
|
1071
|
+
headers: {
|
|
1072
|
+
[name: string]: unknown;
|
|
1073
|
+
};
|
|
1074
|
+
content: {
|
|
1075
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1076
|
+
};
|
|
1077
|
+
};
|
|
1078
|
+
/** @description Service Unavailable */
|
|
1079
|
+
503: {
|
|
1080
|
+
headers: {
|
|
1081
|
+
[name: string]: unknown;
|
|
1082
|
+
};
|
|
1083
|
+
content: {
|
|
1084
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1085
|
+
};
|
|
1086
|
+
};
|
|
1087
|
+
};
|
|
1088
|
+
};
|
|
1089
|
+
put?: never;
|
|
1090
|
+
post?: never;
|
|
1091
|
+
delete?: never;
|
|
1092
|
+
options?: never;
|
|
1093
|
+
head?: never;
|
|
1094
|
+
patch?: never;
|
|
1095
|
+
trace?: never;
|
|
1096
|
+
};
|
|
1097
|
+
"/analytics-alert-control-plane/v1/resource/{resourceType}/id/{resourceId}/alerts/{alertId}": {
|
|
1098
|
+
parameters: {
|
|
1099
|
+
query?: never;
|
|
1100
|
+
header?: never;
|
|
1101
|
+
path?: never;
|
|
1102
|
+
cookie?: never;
|
|
1103
|
+
};
|
|
1104
|
+
get?: never;
|
|
1105
|
+
put?: never;
|
|
1106
|
+
post?: never;
|
|
1107
|
+
/** Deletes an alert configuration. This action is irreversible. */
|
|
1108
|
+
delete: {
|
|
1109
|
+
parameters: {
|
|
1110
|
+
query?: never;
|
|
1111
|
+
header?: never;
|
|
1112
|
+
path: {
|
|
1113
|
+
/**
|
|
1114
|
+
* @description The type of resource the alert belongs to. Currently only `Universe` is supported.
|
|
1115
|
+
*
|
|
1116
|
+
* Universe
|
|
1117
|
+
*/
|
|
1118
|
+
resourceType: components["schemas"]["AlertStorage.ResourceType"];
|
|
1119
|
+
/** @description The numeric ID of the resource (e.g. the universe ID). */
|
|
1120
|
+
resourceId: string;
|
|
1121
|
+
/** @description The ID of the alert to delete. */
|
|
1122
|
+
alertId: string;
|
|
1123
|
+
};
|
|
1124
|
+
cookie?: never;
|
|
1125
|
+
};
|
|
1126
|
+
requestBody?: never;
|
|
1127
|
+
responses: {
|
|
1128
|
+
/** @description No Content */
|
|
1129
|
+
204: {
|
|
1130
|
+
headers: {
|
|
1131
|
+
[name: string]: unknown;
|
|
1132
|
+
};
|
|
1133
|
+
content?: never;
|
|
1134
|
+
};
|
|
1135
|
+
/** @description Bad Request */
|
|
1136
|
+
400: {
|
|
1137
|
+
headers: {
|
|
1138
|
+
[name: string]: unknown;
|
|
1139
|
+
};
|
|
1140
|
+
content: {
|
|
1141
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1142
|
+
};
|
|
1143
|
+
};
|
|
1144
|
+
/** @description Unauthorized */
|
|
1145
|
+
401: {
|
|
1146
|
+
headers: {
|
|
1147
|
+
[name: string]: unknown;
|
|
1148
|
+
};
|
|
1149
|
+
content: {
|
|
1150
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1151
|
+
};
|
|
1152
|
+
};
|
|
1153
|
+
/** @description Forbidden */
|
|
1154
|
+
403: {
|
|
1155
|
+
headers: {
|
|
1156
|
+
[name: string]: unknown;
|
|
1157
|
+
};
|
|
1158
|
+
content: {
|
|
1159
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1160
|
+
};
|
|
1161
|
+
};
|
|
1162
|
+
/** @description Not Found */
|
|
1163
|
+
404: {
|
|
1164
|
+
headers: {
|
|
1165
|
+
[name: string]: unknown;
|
|
1166
|
+
};
|
|
1167
|
+
content: {
|
|
1168
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1169
|
+
};
|
|
1170
|
+
};
|
|
1171
|
+
/** @description Service Unavailable */
|
|
1172
|
+
503: {
|
|
1173
|
+
headers: {
|
|
1174
|
+
[name: string]: unknown;
|
|
1175
|
+
};
|
|
1176
|
+
content: {
|
|
1177
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1178
|
+
};
|
|
1179
|
+
};
|
|
1180
|
+
};
|
|
1181
|
+
};
|
|
1182
|
+
options?: never;
|
|
1183
|
+
head?: never;
|
|
1184
|
+
/**
|
|
1185
|
+
* Updates an existing alert configuration. Only the fields included in the request body are
|
|
1186
|
+
* changed; omitted fields retain their current values.
|
|
1187
|
+
* @description See the <a href="https://create.roblox.com/docs/cloud/guides/alerts/metrics">alerts guide</a> for supported metrics and dimensions.
|
|
1188
|
+
*/
|
|
1189
|
+
patch: {
|
|
1190
|
+
parameters: {
|
|
1191
|
+
query?: never;
|
|
1192
|
+
header?: never;
|
|
1193
|
+
path: {
|
|
1194
|
+
/**
|
|
1195
|
+
* @description The type of resource the alert belongs to. Currently only `Universe` is supported.
|
|
1196
|
+
*
|
|
1197
|
+
* Universe
|
|
1198
|
+
*/
|
|
1199
|
+
resourceType: components["schemas"]["AlertStorage.ResourceType"];
|
|
1200
|
+
/** @description The numeric ID of the resource (e.g. the universe ID). */
|
|
1201
|
+
resourceId: string;
|
|
1202
|
+
/** @description The ID of the alert to update. */
|
|
1203
|
+
alertId: string;
|
|
1204
|
+
};
|
|
1205
|
+
cookie?: never;
|
|
1206
|
+
};
|
|
1207
|
+
/** @description The fields to update on the alert configuration. */
|
|
1208
|
+
requestBody?: {
|
|
1209
|
+
content: {
|
|
1210
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.UpdateAlertConfigRequest"];
|
|
1211
|
+
"text/json": components["schemas"]["AnalyticsAlertControlPlane.Models.UpdateAlertConfigRequest"];
|
|
1212
|
+
"application/*+json": components["schemas"]["AnalyticsAlertControlPlane.Models.UpdateAlertConfigRequest"];
|
|
1213
|
+
};
|
|
1214
|
+
};
|
|
1215
|
+
responses: {
|
|
1216
|
+
/** @description OK */
|
|
1217
|
+
200: {
|
|
1218
|
+
headers: {
|
|
1219
|
+
[name: string]: unknown;
|
|
1220
|
+
};
|
|
1221
|
+
content: {
|
|
1222
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.AlertDetailResponse"];
|
|
1223
|
+
};
|
|
1224
|
+
};
|
|
1225
|
+
/** @description Bad Request */
|
|
1226
|
+
400: {
|
|
1227
|
+
headers: {
|
|
1228
|
+
[name: string]: unknown;
|
|
1229
|
+
};
|
|
1230
|
+
content: {
|
|
1231
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1232
|
+
};
|
|
1233
|
+
};
|
|
1234
|
+
/** @description Unauthorized */
|
|
1235
|
+
401: {
|
|
1236
|
+
headers: {
|
|
1237
|
+
[name: string]: unknown;
|
|
1238
|
+
};
|
|
1239
|
+
content: {
|
|
1240
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1241
|
+
};
|
|
1242
|
+
};
|
|
1243
|
+
/** @description Forbidden */
|
|
1244
|
+
403: {
|
|
1245
|
+
headers: {
|
|
1246
|
+
[name: string]: unknown;
|
|
1247
|
+
};
|
|
1248
|
+
content: {
|
|
1249
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1250
|
+
};
|
|
1251
|
+
};
|
|
1252
|
+
/** @description Not Found */
|
|
1253
|
+
404: {
|
|
1254
|
+
headers: {
|
|
1255
|
+
[name: string]: unknown;
|
|
1256
|
+
};
|
|
1257
|
+
content: {
|
|
1258
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1259
|
+
};
|
|
1260
|
+
};
|
|
1261
|
+
/**
|
|
1262
|
+
* @description Conflict (`ALERT_NAME_EXISTED`): the new name collides with an existing alert on the
|
|
1263
|
+
* same resource. Alert names must be unique per resource.
|
|
1264
|
+
*/
|
|
1265
|
+
409: {
|
|
1266
|
+
headers: {
|
|
1267
|
+
[name: string]: unknown;
|
|
1268
|
+
};
|
|
1269
|
+
content: {
|
|
1270
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1271
|
+
};
|
|
1272
|
+
};
|
|
1273
|
+
/** @description Service Unavailable */
|
|
1274
|
+
503: {
|
|
1275
|
+
headers: {
|
|
1276
|
+
[name: string]: unknown;
|
|
1277
|
+
};
|
|
1278
|
+
content: {
|
|
1279
|
+
"application/json": components["schemas"]["AnalyticsAlertControlPlane.Models.ErrorResponse"];
|
|
1280
|
+
};
|
|
1281
|
+
};
|
|
1282
|
+
};
|
|
1283
|
+
};
|
|
1284
|
+
trace?: never;
|
|
1285
|
+
};
|
|
787
1286
|
"/analytics-query-api/v1/universes/{universeId}/dimension-values": {
|
|
788
1287
|
parameters: {
|
|
789
1288
|
query?: never;
|
|
@@ -5027,272 +5526,6 @@ export interface paths {
|
|
|
5027
5526
|
patch?: never;
|
|
5028
5527
|
trace?: never;
|
|
5029
5528
|
};
|
|
5030
|
-
"/legacy-followings/v1/users/{userId}/universes": {
|
|
5031
|
-
parameters: {
|
|
5032
|
-
query?: never;
|
|
5033
|
-
header?: never;
|
|
5034
|
-
path?: never;
|
|
5035
|
-
cookie?: never;
|
|
5036
|
-
};
|
|
5037
|
-
/** Gets all the followings between a user with userId and universes */
|
|
5038
|
-
get: {
|
|
5039
|
-
parameters: {
|
|
5040
|
-
query?: never;
|
|
5041
|
-
header?: never;
|
|
5042
|
-
path: {
|
|
5043
|
-
userId: number;
|
|
5044
|
-
};
|
|
5045
|
-
cookie?: never;
|
|
5046
|
-
};
|
|
5047
|
-
requestBody?: never;
|
|
5048
|
-
responses: {
|
|
5049
|
-
/** @description OK */
|
|
5050
|
-
200: {
|
|
5051
|
-
headers: {
|
|
5052
|
-
[name: string]: unknown;
|
|
5053
|
-
};
|
|
5054
|
-
content: {
|
|
5055
|
-
"application/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseResponse"][];
|
|
5056
|
-
"text/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseResponse"][];
|
|
5057
|
-
};
|
|
5058
|
-
};
|
|
5059
|
-
/** @description 0: Authorization has been denied for this request. */
|
|
5060
|
-
401: {
|
|
5061
|
-
headers: {
|
|
5062
|
-
[name: string]: unknown;
|
|
5063
|
-
};
|
|
5064
|
-
content?: never;
|
|
5065
|
-
};
|
|
5066
|
-
/** @description User is not authorized for this action. */
|
|
5067
|
-
403: {
|
|
5068
|
-
headers: {
|
|
5069
|
-
[name: string]: unknown;
|
|
5070
|
-
};
|
|
5071
|
-
content?: never;
|
|
5072
|
-
};
|
|
5073
|
-
};
|
|
5074
|
-
};
|
|
5075
|
-
put?: never;
|
|
5076
|
-
post?: never;
|
|
5077
|
-
delete?: never;
|
|
5078
|
-
options?: never;
|
|
5079
|
-
head?: never;
|
|
5080
|
-
patch?: never;
|
|
5081
|
-
trace?: never;
|
|
5082
|
-
};
|
|
5083
|
-
"/legacy-followings/v1/users/{userId}/universes/{universeId}": {
|
|
5084
|
-
parameters: {
|
|
5085
|
-
query?: never;
|
|
5086
|
-
header?: never;
|
|
5087
|
-
path?: never;
|
|
5088
|
-
cookie?: never;
|
|
5089
|
-
};
|
|
5090
|
-
get?: never;
|
|
5091
|
-
put?: never;
|
|
5092
|
-
/** Creates the following between a user with userId and universe with universeId */
|
|
5093
|
-
post: {
|
|
5094
|
-
parameters: {
|
|
5095
|
-
query?: never;
|
|
5096
|
-
header?: never;
|
|
5097
|
-
path: {
|
|
5098
|
-
userId: number;
|
|
5099
|
-
universeId: number;
|
|
5100
|
-
};
|
|
5101
|
-
cookie?: never;
|
|
5102
|
-
};
|
|
5103
|
-
requestBody?: never;
|
|
5104
|
-
responses: {
|
|
5105
|
-
/** @description OK */
|
|
5106
|
-
200: {
|
|
5107
|
-
headers: {
|
|
5108
|
-
[name: string]: unknown;
|
|
5109
|
-
};
|
|
5110
|
-
content: {
|
|
5111
|
-
"application/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseResponse"];
|
|
5112
|
-
"text/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseResponse"];
|
|
5113
|
-
};
|
|
5114
|
-
};
|
|
5115
|
-
/** @description The user has reached the limit of number of followed universes. */
|
|
5116
|
-
400: {
|
|
5117
|
-
headers: {
|
|
5118
|
-
[name: string]: unknown;
|
|
5119
|
-
};
|
|
5120
|
-
content?: never;
|
|
5121
|
-
};
|
|
5122
|
-
/** @description 0: Authorization has been denied for this request. */
|
|
5123
|
-
401: {
|
|
5124
|
-
headers: {
|
|
5125
|
-
[name: string]: unknown;
|
|
5126
|
-
};
|
|
5127
|
-
content?: never;
|
|
5128
|
-
};
|
|
5129
|
-
/**
|
|
5130
|
-
* @description User is not authorized for this action.
|
|
5131
|
-
* 0: Token Validation Failed
|
|
5132
|
-
*/
|
|
5133
|
-
403: {
|
|
5134
|
-
headers: {
|
|
5135
|
-
[name: string]: unknown;
|
|
5136
|
-
};
|
|
5137
|
-
content?: never;
|
|
5138
|
-
};
|
|
5139
|
-
};
|
|
5140
|
-
};
|
|
5141
|
-
/** Deletes the following between a user with userId and universe with universeId */
|
|
5142
|
-
delete: {
|
|
5143
|
-
parameters: {
|
|
5144
|
-
query?: never;
|
|
5145
|
-
header?: never;
|
|
5146
|
-
path: {
|
|
5147
|
-
userId: number;
|
|
5148
|
-
universeId: number;
|
|
5149
|
-
};
|
|
5150
|
-
cookie?: never;
|
|
5151
|
-
};
|
|
5152
|
-
requestBody?: never;
|
|
5153
|
-
responses: {
|
|
5154
|
-
/** @description OK */
|
|
5155
|
-
200: {
|
|
5156
|
-
headers: {
|
|
5157
|
-
[name: string]: unknown;
|
|
5158
|
-
};
|
|
5159
|
-
content: {
|
|
5160
|
-
"application/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseResponse"];
|
|
5161
|
-
"text/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseResponse"];
|
|
5162
|
-
};
|
|
5163
|
-
};
|
|
5164
|
-
/** @description 0: Authorization has been denied for this request. */
|
|
5165
|
-
401: {
|
|
5166
|
-
headers: {
|
|
5167
|
-
[name: string]: unknown;
|
|
5168
|
-
};
|
|
5169
|
-
content?: never;
|
|
5170
|
-
};
|
|
5171
|
-
/**
|
|
5172
|
-
* @description User is not authorized for this action.
|
|
5173
|
-
* 0: Token Validation Failed
|
|
5174
|
-
*/
|
|
5175
|
-
403: {
|
|
5176
|
-
headers: {
|
|
5177
|
-
[name: string]: unknown;
|
|
5178
|
-
};
|
|
5179
|
-
content?: never;
|
|
5180
|
-
};
|
|
5181
|
-
};
|
|
5182
|
-
};
|
|
5183
|
-
options?: never;
|
|
5184
|
-
head?: never;
|
|
5185
|
-
patch?: never;
|
|
5186
|
-
trace?: never;
|
|
5187
|
-
};
|
|
5188
|
-
"/legacy-followings/v1/users/{userId}/universes/{universeId}/status": {
|
|
5189
|
-
parameters: {
|
|
5190
|
-
query?: never;
|
|
5191
|
-
header?: never;
|
|
5192
|
-
path?: never;
|
|
5193
|
-
cookie?: never;
|
|
5194
|
-
};
|
|
5195
|
-
/** Gets the status of a following relationship between a user and a universe. */
|
|
5196
|
-
get: {
|
|
5197
|
-
parameters: {
|
|
5198
|
-
query?: never;
|
|
5199
|
-
header?: never;
|
|
5200
|
-
path: {
|
|
5201
|
-
userId: number;
|
|
5202
|
-
universeId: number;
|
|
5203
|
-
};
|
|
5204
|
-
cookie?: never;
|
|
5205
|
-
};
|
|
5206
|
-
requestBody?: never;
|
|
5207
|
-
responses: {
|
|
5208
|
-
/** @description OK */
|
|
5209
|
-
200: {
|
|
5210
|
-
headers: {
|
|
5211
|
-
[name: string]: unknown;
|
|
5212
|
-
};
|
|
5213
|
-
content: {
|
|
5214
|
-
"application/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseStatusResponse"];
|
|
5215
|
-
"text/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseStatusResponse"];
|
|
5216
|
-
};
|
|
5217
|
-
};
|
|
5218
|
-
/** @description 0: Authorization has been denied for this request. */
|
|
5219
|
-
401: {
|
|
5220
|
-
headers: {
|
|
5221
|
-
[name: string]: unknown;
|
|
5222
|
-
};
|
|
5223
|
-
content?: never;
|
|
5224
|
-
};
|
|
5225
|
-
/** @description User is not authorized for this action. */
|
|
5226
|
-
403: {
|
|
5227
|
-
headers: {
|
|
5228
|
-
[name: string]: unknown;
|
|
5229
|
-
};
|
|
5230
|
-
content?: never;
|
|
5231
|
-
};
|
|
5232
|
-
};
|
|
5233
|
-
};
|
|
5234
|
-
put?: never;
|
|
5235
|
-
post?: never;
|
|
5236
|
-
delete?: never;
|
|
5237
|
-
options?: never;
|
|
5238
|
-
head?: never;
|
|
5239
|
-
patch?: never;
|
|
5240
|
-
trace?: never;
|
|
5241
|
-
};
|
|
5242
|
-
"/legacy-followings/v2/users/{userId}/universes": {
|
|
5243
|
-
parameters: {
|
|
5244
|
-
query?: never;
|
|
5245
|
-
header?: never;
|
|
5246
|
-
path?: never;
|
|
5247
|
-
cookie?: never;
|
|
5248
|
-
};
|
|
5249
|
-
/** Gets all universes followed by a user. */
|
|
5250
|
-
get: {
|
|
5251
|
-
parameters: {
|
|
5252
|
-
query?: never;
|
|
5253
|
-
header?: never;
|
|
5254
|
-
path: {
|
|
5255
|
-
/** @description The user ID. */
|
|
5256
|
-
userId: number;
|
|
5257
|
-
};
|
|
5258
|
-
cookie?: never;
|
|
5259
|
-
};
|
|
5260
|
-
requestBody?: never;
|
|
5261
|
-
responses: {
|
|
5262
|
-
/** @description OK */
|
|
5263
|
-
200: {
|
|
5264
|
-
headers: {
|
|
5265
|
-
[name: string]: unknown;
|
|
5266
|
-
};
|
|
5267
|
-
content: {
|
|
5268
|
-
"application/json": components["schemas"]["Roblox.Followings.Api.Models.FollowsByTypeResponse"];
|
|
5269
|
-
"text/json": components["schemas"]["Roblox.Followings.Api.Models.FollowsByTypeResponse"];
|
|
5270
|
-
};
|
|
5271
|
-
};
|
|
5272
|
-
/** @description 0: Authorization has been denied for this request. */
|
|
5273
|
-
401: {
|
|
5274
|
-
headers: {
|
|
5275
|
-
[name: string]: unknown;
|
|
5276
|
-
};
|
|
5277
|
-
content?: never;
|
|
5278
|
-
};
|
|
5279
|
-
/** @description User is not authorized for this action. */
|
|
5280
|
-
403: {
|
|
5281
|
-
headers: {
|
|
5282
|
-
[name: string]: unknown;
|
|
5283
|
-
};
|
|
5284
|
-
content?: never;
|
|
5285
|
-
};
|
|
5286
|
-
};
|
|
5287
|
-
};
|
|
5288
|
-
put?: never;
|
|
5289
|
-
post?: never;
|
|
5290
|
-
delete?: never;
|
|
5291
|
-
options?: never;
|
|
5292
|
-
head?: never;
|
|
5293
|
-
patch?: never;
|
|
5294
|
-
trace?: never;
|
|
5295
|
-
};
|
|
5296
5529
|
"/legacy-game-internationalization/v1/badges/{badgeId}/description/language-codes/{languageCode}": {
|
|
5297
5530
|
parameters: {
|
|
5298
5531
|
query?: never;
|
|
@@ -9266,289 +9499,6 @@ export interface paths {
|
|
|
9266
9499
|
patch?: never;
|
|
9267
9500
|
trace?: never;
|
|
9268
9501
|
};
|
|
9269
|
-
"/matchmaking-api/v1/client-status": {
|
|
9270
|
-
parameters: {
|
|
9271
|
-
query?: never;
|
|
9272
|
-
header?: never;
|
|
9273
|
-
path?: never;
|
|
9274
|
-
cookie?: never;
|
|
9275
|
-
};
|
|
9276
|
-
/** Get the client-status */
|
|
9277
|
-
get: {
|
|
9278
|
-
parameters: {
|
|
9279
|
-
query?: never;
|
|
9280
|
-
header?: never;
|
|
9281
|
-
path?: never;
|
|
9282
|
-
cookie?: never;
|
|
9283
|
-
};
|
|
9284
|
-
/** @description ClientStatusGetRequest */
|
|
9285
|
-
requestBody?: {
|
|
9286
|
-
content: {
|
|
9287
|
-
"application/json-patch+json": components["schemas"]["ClientStatusGetRequest"];
|
|
9288
|
-
"application/json": components["schemas"]["ClientStatusGetRequest"];
|
|
9289
|
-
"text/json": components["schemas"]["ClientStatusGetRequest"];
|
|
9290
|
-
"application/*+json": components["schemas"]["ClientStatusGetRequest"];
|
|
9291
|
-
};
|
|
9292
|
-
};
|
|
9293
|
-
responses: {
|
|
9294
|
-
/** @description Success */
|
|
9295
|
-
200: {
|
|
9296
|
-
headers: {
|
|
9297
|
-
[name: string]: unknown;
|
|
9298
|
-
};
|
|
9299
|
-
content?: never;
|
|
9300
|
-
};
|
|
9301
|
-
};
|
|
9302
|
-
};
|
|
9303
|
-
put?: never;
|
|
9304
|
-
/** Set the client-status */
|
|
9305
|
-
post: {
|
|
9306
|
-
parameters: {
|
|
9307
|
-
query?: never;
|
|
9308
|
-
header?: never;
|
|
9309
|
-
path?: never;
|
|
9310
|
-
cookie?: never;
|
|
9311
|
-
};
|
|
9312
|
-
/** @description ClientStatusSetRequest */
|
|
9313
|
-
requestBody?: {
|
|
9314
|
-
content: {
|
|
9315
|
-
"application/json-patch+json": components["schemas"]["ClientStatusSetRequest"];
|
|
9316
|
-
"application/json": components["schemas"]["ClientStatusSetRequest"];
|
|
9317
|
-
"text/json": components["schemas"]["ClientStatusSetRequest"];
|
|
9318
|
-
"application/*+json": components["schemas"]["ClientStatusSetRequest"];
|
|
9319
|
-
};
|
|
9320
|
-
};
|
|
9321
|
-
responses: {
|
|
9322
|
-
/** @description Success */
|
|
9323
|
-
200: {
|
|
9324
|
-
headers: {
|
|
9325
|
-
[name: string]: unknown;
|
|
9326
|
-
};
|
|
9327
|
-
content?: never;
|
|
9328
|
-
};
|
|
9329
|
-
};
|
|
9330
|
-
};
|
|
9331
|
-
delete?: never;
|
|
9332
|
-
options?: never;
|
|
9333
|
-
head?: never;
|
|
9334
|
-
patch?: never;
|
|
9335
|
-
trace?: never;
|
|
9336
|
-
};
|
|
9337
|
-
"/matchmaking-api/v1/game-instances/forecast-update": {
|
|
9338
|
-
parameters: {
|
|
9339
|
-
query?: never;
|
|
9340
|
-
header?: never;
|
|
9341
|
-
path?: never;
|
|
9342
|
-
cookie?: never;
|
|
9343
|
-
};
|
|
9344
|
-
get?: never;
|
|
9345
|
-
put?: never;
|
|
9346
|
-
/** Forecast the outcome of launching an update */
|
|
9347
|
-
post: {
|
|
9348
|
-
parameters: {
|
|
9349
|
-
query?: never;
|
|
9350
|
-
header?: never;
|
|
9351
|
-
path?: never;
|
|
9352
|
-
cookie?: never;
|
|
9353
|
-
};
|
|
9354
|
-
requestBody?: {
|
|
9355
|
-
content: {
|
|
9356
|
-
"application/json-patch+json": components["schemas"]["ForecastUpdateRequest"];
|
|
9357
|
-
"application/json": components["schemas"]["ForecastUpdateRequest"];
|
|
9358
|
-
"text/json": components["schemas"]["ForecastUpdateRequest"];
|
|
9359
|
-
"application/*+json": components["schemas"]["ForecastUpdateRequest"];
|
|
9360
|
-
};
|
|
9361
|
-
};
|
|
9362
|
-
responses: {
|
|
9363
|
-
/** @description Success */
|
|
9364
|
-
200: {
|
|
9365
|
-
headers: {
|
|
9366
|
-
[name: string]: unknown;
|
|
9367
|
-
};
|
|
9368
|
-
content: {
|
|
9369
|
-
"application/json": components["schemas"]["ForecastUpdateResponse"];
|
|
9370
|
-
};
|
|
9371
|
-
};
|
|
9372
|
-
};
|
|
9373
|
-
};
|
|
9374
|
-
delete?: never;
|
|
9375
|
-
options?: never;
|
|
9376
|
-
head?: never;
|
|
9377
|
-
patch?: never;
|
|
9378
|
-
trace?: never;
|
|
9379
|
-
};
|
|
9380
|
-
"/matchmaking-api/v1/game-instances/get-update-status": {
|
|
9381
|
-
parameters: {
|
|
9382
|
-
query?: never;
|
|
9383
|
-
header?: never;
|
|
9384
|
-
path?: never;
|
|
9385
|
-
cookie?: never;
|
|
9386
|
-
};
|
|
9387
|
-
/** Get the rollout status of an update */
|
|
9388
|
-
get: {
|
|
9389
|
-
parameters: {
|
|
9390
|
-
query?: {
|
|
9391
|
-
universeId?: number;
|
|
9392
|
-
};
|
|
9393
|
-
header?: never;
|
|
9394
|
-
path?: never;
|
|
9395
|
-
cookie?: never;
|
|
9396
|
-
};
|
|
9397
|
-
requestBody?: never;
|
|
9398
|
-
responses: {
|
|
9399
|
-
/** @description Success */
|
|
9400
|
-
200: {
|
|
9401
|
-
headers: {
|
|
9402
|
-
[name: string]: unknown;
|
|
9403
|
-
};
|
|
9404
|
-
content: {
|
|
9405
|
-
"application/json": components["schemas"]["GetUpdateStatusResponse"];
|
|
9406
|
-
};
|
|
9407
|
-
};
|
|
9408
|
-
};
|
|
9409
|
-
};
|
|
9410
|
-
put?: never;
|
|
9411
|
-
post?: never;
|
|
9412
|
-
delete?: never;
|
|
9413
|
-
options?: never;
|
|
9414
|
-
head?: never;
|
|
9415
|
-
patch?: never;
|
|
9416
|
-
trace?: never;
|
|
9417
|
-
};
|
|
9418
|
-
"/matchmaking-api/v1/game-instances/launch-update": {
|
|
9419
|
-
parameters: {
|
|
9420
|
-
query?: never;
|
|
9421
|
-
header?: never;
|
|
9422
|
-
path?: never;
|
|
9423
|
-
cookie?: never;
|
|
9424
|
-
};
|
|
9425
|
-
get?: never;
|
|
9426
|
-
put?: never;
|
|
9427
|
-
/** Launch a game update */
|
|
9428
|
-
post: {
|
|
9429
|
-
parameters: {
|
|
9430
|
-
query?: never;
|
|
9431
|
-
header?: never;
|
|
9432
|
-
path?: never;
|
|
9433
|
-
cookie?: never;
|
|
9434
|
-
};
|
|
9435
|
-
requestBody?: {
|
|
9436
|
-
content: {
|
|
9437
|
-
"application/json-patch+json": components["schemas"]["LaunchUpdateRequest"];
|
|
9438
|
-
"application/json": components["schemas"]["LaunchUpdateRequest"];
|
|
9439
|
-
"text/json": components["schemas"]["LaunchUpdateRequest"];
|
|
9440
|
-
"application/*+json": components["schemas"]["LaunchUpdateRequest"];
|
|
9441
|
-
};
|
|
9442
|
-
};
|
|
9443
|
-
responses: {
|
|
9444
|
-
/** @description Success */
|
|
9445
|
-
200: {
|
|
9446
|
-
headers: {
|
|
9447
|
-
[name: string]: unknown;
|
|
9448
|
-
};
|
|
9449
|
-
content: {
|
|
9450
|
-
"application/json": components["schemas"]["LaunchUpdateResponse"];
|
|
9451
|
-
};
|
|
9452
|
-
};
|
|
9453
|
-
};
|
|
9454
|
-
};
|
|
9455
|
-
delete?: never;
|
|
9456
|
-
options?: never;
|
|
9457
|
-
head?: never;
|
|
9458
|
-
patch?: never;
|
|
9459
|
-
trace?: never;
|
|
9460
|
-
};
|
|
9461
|
-
"/matchmaking-api/v1/game-instances/shutdown": {
|
|
9462
|
-
parameters: {
|
|
9463
|
-
query?: never;
|
|
9464
|
-
header?: never;
|
|
9465
|
-
path?: never;
|
|
9466
|
-
cookie?: never;
|
|
9467
|
-
};
|
|
9468
|
-
get?: never;
|
|
9469
|
-
put?: never;
|
|
9470
|
-
/** Shutdown game instances. */
|
|
9471
|
-
post: {
|
|
9472
|
-
parameters: {
|
|
9473
|
-
query?: never;
|
|
9474
|
-
header?: never;
|
|
9475
|
-
path?: never;
|
|
9476
|
-
cookie?: never;
|
|
9477
|
-
};
|
|
9478
|
-
requestBody?: {
|
|
9479
|
-
content: {
|
|
9480
|
-
"application/json-patch+json": components["schemas"]["ShutdownGameInstancesRequest"];
|
|
9481
|
-
"application/json": components["schemas"]["ShutdownGameInstancesRequest"];
|
|
9482
|
-
"text/json": components["schemas"]["ShutdownGameInstancesRequest"];
|
|
9483
|
-
"application/*+json": components["schemas"]["ShutdownGameInstancesRequest"];
|
|
9484
|
-
};
|
|
9485
|
-
};
|
|
9486
|
-
responses: {
|
|
9487
|
-
/** @description Success */
|
|
9488
|
-
200: {
|
|
9489
|
-
headers: {
|
|
9490
|
-
[name: string]: unknown;
|
|
9491
|
-
};
|
|
9492
|
-
content: {
|
|
9493
|
-
"application/json": components["schemas"]["ShutdownGameInstancesResponse"];
|
|
9494
|
-
};
|
|
9495
|
-
};
|
|
9496
|
-
};
|
|
9497
|
-
};
|
|
9498
|
-
delete?: never;
|
|
9499
|
-
options?: never;
|
|
9500
|
-
head?: never;
|
|
9501
|
-
patch?: never;
|
|
9502
|
-
trace?: never;
|
|
9503
|
-
};
|
|
9504
|
-
"/matchmaking-api/v1/game-instances/shutdown-all": {
|
|
9505
|
-
parameters: {
|
|
9506
|
-
query?: never;
|
|
9507
|
-
header?: never;
|
|
9508
|
-
path?: never;
|
|
9509
|
-
cookie?: never;
|
|
9510
|
-
};
|
|
9511
|
-
get?: never;
|
|
9512
|
-
put?: never;
|
|
9513
|
-
/** Shutdown all game instances. */
|
|
9514
|
-
post: {
|
|
9515
|
-
parameters: {
|
|
9516
|
-
query?: never;
|
|
9517
|
-
header?: never;
|
|
9518
|
-
path?: never;
|
|
9519
|
-
cookie?: never;
|
|
9520
|
-
};
|
|
9521
|
-
requestBody?: {
|
|
9522
|
-
content: {
|
|
9523
|
-
"multipart/form-data": {
|
|
9524
|
-
/**
|
|
9525
|
-
* Format: int64
|
|
9526
|
-
* @description The place ID to shut down.
|
|
9527
|
-
*/
|
|
9528
|
-
PlaceId?: number;
|
|
9529
|
-
/** @description Whether to replace instances or not. */
|
|
9530
|
-
ReplaceInstances?: boolean;
|
|
9531
|
-
};
|
|
9532
|
-
};
|
|
9533
|
-
};
|
|
9534
|
-
responses: {
|
|
9535
|
-
/** @description Success */
|
|
9536
|
-
200: {
|
|
9537
|
-
headers: {
|
|
9538
|
-
[name: string]: unknown;
|
|
9539
|
-
};
|
|
9540
|
-
content: {
|
|
9541
|
-
"application/json": components["schemas"]["ShutdownAllGameInstancesResponse"];
|
|
9542
|
-
};
|
|
9543
|
-
};
|
|
9544
|
-
};
|
|
9545
|
-
};
|
|
9546
|
-
delete?: never;
|
|
9547
|
-
options?: never;
|
|
9548
|
-
head?: never;
|
|
9549
|
-
patch?: never;
|
|
9550
|
-
trace?: never;
|
|
9551
|
-
};
|
|
9552
9502
|
"/matchmaking-api/v1/matchmaking/player-attribute": {
|
|
9553
9503
|
parameters: {
|
|
9554
9504
|
query?: never;
|
|
@@ -9740,82 +9690,6 @@ export interface paths {
|
|
|
9740
9690
|
patch?: never;
|
|
9741
9691
|
trace?: never;
|
|
9742
9692
|
};
|
|
9743
|
-
"/matchmaking-api/v1/matchmaking/scoring-configuration/default-weights": {
|
|
9744
|
-
parameters: {
|
|
9745
|
-
query?: never;
|
|
9746
|
-
header?: never;
|
|
9747
|
-
path?: never;
|
|
9748
|
-
cookie?: never;
|
|
9749
|
-
};
|
|
9750
|
-
get: {
|
|
9751
|
-
parameters: {
|
|
9752
|
-
query?: never;
|
|
9753
|
-
header?: never;
|
|
9754
|
-
path?: never;
|
|
9755
|
-
cookie?: never;
|
|
9756
|
-
};
|
|
9757
|
-
requestBody?: never;
|
|
9758
|
-
responses: {
|
|
9759
|
-
/** @description Success */
|
|
9760
|
-
200: {
|
|
9761
|
-
headers: {
|
|
9762
|
-
[name: string]: unknown;
|
|
9763
|
-
};
|
|
9764
|
-
content: {
|
|
9765
|
-
"application/json": components["schemas"]["GetMatchmakingScoringDefaultWeightsResponse"];
|
|
9766
|
-
};
|
|
9767
|
-
};
|
|
9768
|
-
};
|
|
9769
|
-
};
|
|
9770
|
-
put?: never;
|
|
9771
|
-
post?: never;
|
|
9772
|
-
delete?: never;
|
|
9773
|
-
options?: never;
|
|
9774
|
-
head?: never;
|
|
9775
|
-
patch?: never;
|
|
9776
|
-
trace?: never;
|
|
9777
|
-
};
|
|
9778
|
-
"/matchmaking-api/v1/matchmaking/scoring-configuration/generate-mock-servers": {
|
|
9779
|
-
parameters: {
|
|
9780
|
-
query?: never;
|
|
9781
|
-
header?: never;
|
|
9782
|
-
path?: never;
|
|
9783
|
-
cookie?: never;
|
|
9784
|
-
};
|
|
9785
|
-
get: {
|
|
9786
|
-
parameters: {
|
|
9787
|
-
query?: {
|
|
9788
|
-
count?: number;
|
|
9789
|
-
capacity?: number;
|
|
9790
|
-
playerAge?: number;
|
|
9791
|
-
playerPlayHistory?: number;
|
|
9792
|
-
isPlayerVoiceChatEnabled?: boolean;
|
|
9793
|
-
};
|
|
9794
|
-
header?: never;
|
|
9795
|
-
path?: never;
|
|
9796
|
-
cookie?: never;
|
|
9797
|
-
};
|
|
9798
|
-
requestBody?: never;
|
|
9799
|
-
responses: {
|
|
9800
|
-
/** @description Success */
|
|
9801
|
-
200: {
|
|
9802
|
-
headers: {
|
|
9803
|
-
[name: string]: unknown;
|
|
9804
|
-
};
|
|
9805
|
-
content: {
|
|
9806
|
-
"application/json": components["schemas"]["GenerateMockServerSignalValuesResponse"];
|
|
9807
|
-
};
|
|
9808
|
-
};
|
|
9809
|
-
};
|
|
9810
|
-
};
|
|
9811
|
-
put?: never;
|
|
9812
|
-
post?: never;
|
|
9813
|
-
delete?: never;
|
|
9814
|
-
options?: never;
|
|
9815
|
-
head?: never;
|
|
9816
|
-
patch?: never;
|
|
9817
|
-
trace?: never;
|
|
9818
|
-
};
|
|
9819
9693
|
"/matchmaking-api/v1/matchmaking/scoring-configuration/place": {
|
|
9820
9694
|
parameters: {
|
|
9821
9695
|
query?: never;
|
|
@@ -10362,95 +10236,6 @@ export interface paths {
|
|
|
10362
10236
|
patch?: never;
|
|
10363
10237
|
trace?: never;
|
|
10364
10238
|
};
|
|
10365
|
-
"/matchmaking-api/v1/matchmaking/universe/{universeId}/start-place": {
|
|
10366
|
-
parameters: {
|
|
10367
|
-
query?: never;
|
|
10368
|
-
header?: never;
|
|
10369
|
-
path?: never;
|
|
10370
|
-
cookie?: never;
|
|
10371
|
-
};
|
|
10372
|
-
/** Gets the start place override for a universe. */
|
|
10373
|
-
get: {
|
|
10374
|
-
parameters: {
|
|
10375
|
-
query?: never;
|
|
10376
|
-
header?: never;
|
|
10377
|
-
path: {
|
|
10378
|
-
universeId: number;
|
|
10379
|
-
};
|
|
10380
|
-
cookie?: never;
|
|
10381
|
-
};
|
|
10382
|
-
requestBody?: never;
|
|
10383
|
-
responses: {
|
|
10384
|
-
/** @description Success */
|
|
10385
|
-
200: {
|
|
10386
|
-
headers: {
|
|
10387
|
-
[name: string]: unknown;
|
|
10388
|
-
};
|
|
10389
|
-
content: {
|
|
10390
|
-
"application/json": components["schemas"]["GetStartPlaceOverrideResponse"];
|
|
10391
|
-
};
|
|
10392
|
-
};
|
|
10393
|
-
};
|
|
10394
|
-
};
|
|
10395
|
-
put?: never;
|
|
10396
|
-
/** Sets (creates or updates) the start place override for a universe. */
|
|
10397
|
-
post: {
|
|
10398
|
-
parameters: {
|
|
10399
|
-
query?: never;
|
|
10400
|
-
header?: never;
|
|
10401
|
-
path: {
|
|
10402
|
-
universeId: number;
|
|
10403
|
-
};
|
|
10404
|
-
cookie?: never;
|
|
10405
|
-
};
|
|
10406
|
-
requestBody?: {
|
|
10407
|
-
content: {
|
|
10408
|
-
"application/json-patch+json": components["schemas"]["SetStartPlaceOverrideRequestBody"];
|
|
10409
|
-
"application/json": components["schemas"]["SetStartPlaceOverrideRequestBody"];
|
|
10410
|
-
"text/json": components["schemas"]["SetStartPlaceOverrideRequestBody"];
|
|
10411
|
-
"application/*+json": components["schemas"]["SetStartPlaceOverrideRequestBody"];
|
|
10412
|
-
};
|
|
10413
|
-
};
|
|
10414
|
-
responses: {
|
|
10415
|
-
/** @description Success */
|
|
10416
|
-
200: {
|
|
10417
|
-
headers: {
|
|
10418
|
-
[name: string]: unknown;
|
|
10419
|
-
};
|
|
10420
|
-
content: {
|
|
10421
|
-
"application/json": components["schemas"]["SetStartPlaceOverrideResponse"];
|
|
10422
|
-
};
|
|
10423
|
-
};
|
|
10424
|
-
};
|
|
10425
|
-
};
|
|
10426
|
-
/** Deletes the start place override for a universe. */
|
|
10427
|
-
delete: {
|
|
10428
|
-
parameters: {
|
|
10429
|
-
query?: never;
|
|
10430
|
-
header?: never;
|
|
10431
|
-
path: {
|
|
10432
|
-
universeId: number;
|
|
10433
|
-
};
|
|
10434
|
-
cookie?: never;
|
|
10435
|
-
};
|
|
10436
|
-
requestBody?: never;
|
|
10437
|
-
responses: {
|
|
10438
|
-
/** @description Success */
|
|
10439
|
-
200: {
|
|
10440
|
-
headers: {
|
|
10441
|
-
[name: string]: unknown;
|
|
10442
|
-
};
|
|
10443
|
-
content: {
|
|
10444
|
-
"application/json": components["schemas"]["DeleteStartPlaceOverrideResponse"];
|
|
10445
|
-
};
|
|
10446
|
-
};
|
|
10447
|
-
};
|
|
10448
|
-
};
|
|
10449
|
-
options?: never;
|
|
10450
|
-
head?: never;
|
|
10451
|
-
patch?: never;
|
|
10452
|
-
trace?: never;
|
|
10453
|
-
};
|
|
10454
10239
|
"/messaging-service/v1/universes/{universeId}/topics/{topic}": {
|
|
10455
10240
|
parameters: {
|
|
10456
10241
|
query?: never;
|
|
@@ -11241,6 +11026,8 @@ export interface paths {
|
|
|
11241
11026
|
* 13: Invalid password.
|
|
11242
11027
|
* 14: Invalid email address.
|
|
11243
11028
|
* 15: Too many accounts use this email address.
|
|
11029
|
+
* 17: Password is not complex enough.
|
|
11030
|
+
* 18: Password is too similar to username.
|
|
11244
11031
|
*/
|
|
11245
11032
|
400: {
|
|
11246
11033
|
headers: {
|
|
@@ -12638,7 +12425,11 @@ export interface paths {
|
|
|
12638
12425
|
};
|
|
12639
12426
|
get?: never;
|
|
12640
12427
|
put?: never;
|
|
12641
|
-
/**
|
|
12428
|
+
/**
|
|
12429
|
+
* Sets the authenticated user's body colors.
|
|
12430
|
+
* @deprecated
|
|
12431
|
+
* @description Please use PATCH v4/avatar
|
|
12432
|
+
*/
|
|
12642
12433
|
post: {
|
|
12643
12434
|
parameters: {
|
|
12644
12435
|
query?: never;
|
|
@@ -12698,7 +12489,10 @@ export interface paths {
|
|
|
12698
12489
|
put?: never;
|
|
12699
12490
|
/**
|
|
12700
12491
|
* Sets the authenticated user's player avatar type (e.g. R6 or R15).
|
|
12492
|
+
* @deprecated
|
|
12701
12493
|
* @description This is the avatar type chosen on the Avatar page. Some games can override this and force your character to be R6 or R15.
|
|
12494
|
+
*
|
|
12495
|
+
* Please use PATCH v4/avatar
|
|
12702
12496
|
*/
|
|
12703
12497
|
post: {
|
|
12704
12498
|
parameters: {
|
|
@@ -12768,7 +12562,11 @@ export interface paths {
|
|
|
12768
12562
|
};
|
|
12769
12563
|
get?: never;
|
|
12770
12564
|
put?: never;
|
|
12771
|
-
/**
|
|
12565
|
+
/**
|
|
12566
|
+
* Sets the authenticated user's scales.
|
|
12567
|
+
* @deprecated
|
|
12568
|
+
* @description Please use PATCH v4/avatar
|
|
12569
|
+
*/
|
|
12772
12570
|
post: {
|
|
12773
12571
|
parameters: {
|
|
12774
12572
|
query?: never;
|
|
@@ -14201,13 +13999,7 @@ export interface paths {
|
|
|
14201
13999
|
path?: never;
|
|
14202
14000
|
cookie?: never;
|
|
14203
14001
|
};
|
|
14204
|
-
|
|
14205
|
-
requestBody: {
|
|
14206
|
-
content: {
|
|
14207
|
-
"application/json": components["schemas"]["Roblox.Catalog.Api.MultigetItemDetailsRequestModel"];
|
|
14208
|
-
"text/json": components["schemas"]["Roblox.Catalog.Api.MultigetItemDetailsRequestModel"];
|
|
14209
|
-
};
|
|
14210
|
-
};
|
|
14002
|
+
requestBody: components["requestBodies"]["Roblox.Catalog.Api.MultigetItemDetailsRequestModel"];
|
|
14211
14003
|
responses: {
|
|
14212
14004
|
/** @description OK */
|
|
14213
14005
|
200: {
|
|
@@ -15778,7 +15570,11 @@ export interface paths {
|
|
|
15778
15570
|
};
|
|
15779
15571
|
content?: never;
|
|
15780
15572
|
};
|
|
15781
|
-
/**
|
|
15573
|
+
/**
|
|
15574
|
+
* @description 0: Token Validation Failed
|
|
15575
|
+
* 36: Password is not complex enough.
|
|
15576
|
+
* 37: Password is too similar to username.
|
|
15577
|
+
*/
|
|
15782
15578
|
403: {
|
|
15783
15579
|
headers: {
|
|
15784
15580
|
[name: string]: unknown;
|
|
@@ -19998,6 +19794,52 @@ export interface paths {
|
|
|
19998
19794
|
patch?: never;
|
|
19999
19795
|
trace?: never;
|
|
20000
19796
|
};
|
|
19797
|
+
"/v1/locales/supported-locales-for-feature": {
|
|
19798
|
+
parameters: {
|
|
19799
|
+
query?: never;
|
|
19800
|
+
header?: never;
|
|
19801
|
+
path?: never;
|
|
19802
|
+
cookie?: never;
|
|
19803
|
+
};
|
|
19804
|
+
/** Get list of Supported locales for a specific feature. */
|
|
19805
|
+
get: {
|
|
19806
|
+
parameters: {
|
|
19807
|
+
query: {
|
|
19808
|
+
featureName: string;
|
|
19809
|
+
};
|
|
19810
|
+
header?: never;
|
|
19811
|
+
path?: never;
|
|
19812
|
+
cookie?: never;
|
|
19813
|
+
};
|
|
19814
|
+
requestBody?: never;
|
|
19815
|
+
responses: {
|
|
19816
|
+
/** @description OK */
|
|
19817
|
+
200: {
|
|
19818
|
+
headers: {
|
|
19819
|
+
[name: string]: unknown;
|
|
19820
|
+
};
|
|
19821
|
+
content: {
|
|
19822
|
+
"application/json": components["schemas"]["Roblox.Locale.Api.SupportedLocalesResponse"];
|
|
19823
|
+
"text/json": components["schemas"]["Roblox.Locale.Api.SupportedLocalesResponse"];
|
|
19824
|
+
};
|
|
19825
|
+
};
|
|
19826
|
+
/** @description Internal server error */
|
|
19827
|
+
500: {
|
|
19828
|
+
headers: {
|
|
19829
|
+
[name: string]: unknown;
|
|
19830
|
+
};
|
|
19831
|
+
content?: never;
|
|
19832
|
+
};
|
|
19833
|
+
};
|
|
19834
|
+
};
|
|
19835
|
+
put?: never;
|
|
19836
|
+
post?: never;
|
|
19837
|
+
delete?: never;
|
|
19838
|
+
options?: never;
|
|
19839
|
+
head?: never;
|
|
19840
|
+
patch?: never;
|
|
19841
|
+
trace?: never;
|
|
19842
|
+
};
|
|
20001
19843
|
"/v1/locales/user-locale": {
|
|
20002
19844
|
parameters: {
|
|
20003
19845
|
query?: never;
|
|
@@ -24509,6 +24351,8 @@ export interface paths {
|
|
|
24509
24351
|
* 4: Passwords do not match
|
|
24510
24352
|
* 5: Password cannot be used
|
|
24511
24353
|
* 8: The account security ticket is expired.
|
|
24354
|
+
* 14: Password is not complex enough
|
|
24355
|
+
* 15: Password is too similar to username
|
|
24512
24356
|
*/
|
|
24513
24357
|
400: {
|
|
24514
24358
|
headers: {
|
|
@@ -24757,6 +24601,8 @@ export interface paths {
|
|
|
24757
24601
|
* 12: Too many attempts. Please wait a bit.
|
|
24758
24602
|
* 17: One time Passcode session was not valid
|
|
24759
24603
|
* 22: Maximum logged in accounts limit reached.
|
|
24604
|
+
* 36: Password is not complex enough.
|
|
24605
|
+
* 37: Password is too similar to username.
|
|
24760
24606
|
* 44: Login is unavailable in your country.
|
|
24761
24607
|
*/
|
|
24762
24608
|
403: {
|
|
@@ -24854,6 +24700,8 @@ export interface paths {
|
|
|
24854
24700
|
* 22: Maximum logged in accounts limit reached.
|
|
24855
24701
|
* 29: Account Linking already exists on this account
|
|
24856
24702
|
* 30: Account Linking required but failed
|
|
24703
|
+
* 36: Password is not complex enough.
|
|
24704
|
+
* 37: Password is too similar to username.
|
|
24857
24705
|
* 44: Login is unavailable in your country.
|
|
24858
24706
|
*/
|
|
24859
24707
|
403: {
|
|
@@ -27958,6 +27806,7 @@ export interface paths {
|
|
|
27958
27806
|
get: {
|
|
27959
27807
|
parameters: {
|
|
27960
27808
|
query: {
|
|
27809
|
+
/** @description The type of a statistics dataset. ['PremiumUpsells' = 0, 'PremiumVisits' = 1] */
|
|
27961
27810
|
Type: "PremiumUpsells" | "PremiumVisits";
|
|
27962
27811
|
StartTime: string;
|
|
27963
27812
|
EndTime: string;
|
|
@@ -28740,6 +28589,10 @@ export interface paths {
|
|
|
28740
28589
|
* @description Roblox.Web.Authentication.Passwords.PasswordResponseCodes.InvalidCurrentPassword
|
|
28741
28590
|
* OR
|
|
28742
28591
|
* Roblox.Web.Authentication.Passwords.PasswordResponseCodes.InvalidPassword
|
|
28592
|
+
* OR
|
|
28593
|
+
* Roblox.Web.Authentication.Passwords.PasswordResponseCodes.PasswordLowComplexity
|
|
28594
|
+
* OR
|
|
28595
|
+
* Roblox.Web.Authentication.Passwords.PasswordResponseCodes.PasswordTooSimilarToUsername
|
|
28743
28596
|
*/
|
|
28744
28597
|
400: {
|
|
28745
28598
|
headers: {
|
|
@@ -30151,7 +30004,10 @@ export interface paths {
|
|
|
30151
30004
|
};
|
|
30152
30005
|
/**
|
|
30153
30006
|
* Returns details about a specified user's avatar.
|
|
30007
|
+
* @deprecated
|
|
30154
30008
|
* @description Includes assets, bodycolors, and playerAvatarType.
|
|
30009
|
+
*
|
|
30010
|
+
* Please use GET v4/avatar/users/{userId}
|
|
30155
30011
|
*/
|
|
30156
30012
|
get: {
|
|
30157
30013
|
parameters: {
|
|
@@ -32735,6 +32591,8 @@ export interface paths {
|
|
|
32735
32591
|
/**
|
|
32736
32592
|
* Deprecated, user v2.
|
|
32737
32593
|
* Gets a list of outfits for the specified user.
|
|
32594
|
+
* @deprecated
|
|
32595
|
+
* @description Please use GET v2/avatar/users/{userId}/outfits
|
|
32738
32596
|
*/
|
|
32739
32597
|
get: {
|
|
32740
32598
|
parameters: {
|
|
@@ -33180,218 +33038,6 @@ export interface paths {
|
|
|
33180
33038
|
patch?: never;
|
|
33181
33039
|
trace?: never;
|
|
33182
33040
|
};
|
|
33183
|
-
"/v1/users/{userId}/universes": {
|
|
33184
|
-
parameters: {
|
|
33185
|
-
query?: never;
|
|
33186
|
-
header?: never;
|
|
33187
|
-
path?: never;
|
|
33188
|
-
cookie?: never;
|
|
33189
|
-
};
|
|
33190
|
-
/** Gets all the followings between a user with userId and universes */
|
|
33191
|
-
get: {
|
|
33192
|
-
parameters: {
|
|
33193
|
-
query?: never;
|
|
33194
|
-
header?: never;
|
|
33195
|
-
path: {
|
|
33196
|
-
userId: number;
|
|
33197
|
-
};
|
|
33198
|
-
cookie?: never;
|
|
33199
|
-
};
|
|
33200
|
-
requestBody?: never;
|
|
33201
|
-
responses: {
|
|
33202
|
-
/** @description OK */
|
|
33203
|
-
200: {
|
|
33204
|
-
headers: {
|
|
33205
|
-
[name: string]: unknown;
|
|
33206
|
-
};
|
|
33207
|
-
content: {
|
|
33208
|
-
"application/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseResponse"][];
|
|
33209
|
-
"text/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseResponse"][];
|
|
33210
|
-
};
|
|
33211
|
-
};
|
|
33212
|
-
/** @description 0: Authorization has been denied for this request. */
|
|
33213
|
-
401: {
|
|
33214
|
-
headers: {
|
|
33215
|
-
[name: string]: unknown;
|
|
33216
|
-
};
|
|
33217
|
-
content?: never;
|
|
33218
|
-
};
|
|
33219
|
-
/** @description User is not authorized for this action. */
|
|
33220
|
-
403: {
|
|
33221
|
-
headers: {
|
|
33222
|
-
[name: string]: unknown;
|
|
33223
|
-
};
|
|
33224
|
-
content?: never;
|
|
33225
|
-
};
|
|
33226
|
-
};
|
|
33227
|
-
};
|
|
33228
|
-
put?: never;
|
|
33229
|
-
post?: never;
|
|
33230
|
-
delete?: never;
|
|
33231
|
-
options?: never;
|
|
33232
|
-
head?: never;
|
|
33233
|
-
patch?: never;
|
|
33234
|
-
trace?: never;
|
|
33235
|
-
};
|
|
33236
|
-
"/v1/users/{userId}/universes/{universeId}": {
|
|
33237
|
-
parameters: {
|
|
33238
|
-
query?: never;
|
|
33239
|
-
header?: never;
|
|
33240
|
-
path?: never;
|
|
33241
|
-
cookie?: never;
|
|
33242
|
-
};
|
|
33243
|
-
get?: never;
|
|
33244
|
-
put?: never;
|
|
33245
|
-
/** Creates the following between a user with userId and universe with universeId */
|
|
33246
|
-
post: {
|
|
33247
|
-
parameters: {
|
|
33248
|
-
query?: never;
|
|
33249
|
-
header?: never;
|
|
33250
|
-
path: {
|
|
33251
|
-
userId: number;
|
|
33252
|
-
universeId: number;
|
|
33253
|
-
};
|
|
33254
|
-
cookie?: never;
|
|
33255
|
-
};
|
|
33256
|
-
requestBody?: never;
|
|
33257
|
-
responses: {
|
|
33258
|
-
/** @description OK */
|
|
33259
|
-
200: {
|
|
33260
|
-
headers: {
|
|
33261
|
-
[name: string]: unknown;
|
|
33262
|
-
};
|
|
33263
|
-
content: {
|
|
33264
|
-
"application/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseResponse"];
|
|
33265
|
-
"text/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseResponse"];
|
|
33266
|
-
};
|
|
33267
|
-
};
|
|
33268
|
-
/** @description The user has reached the limit of number of followed universes. */
|
|
33269
|
-
400: {
|
|
33270
|
-
headers: {
|
|
33271
|
-
[name: string]: unknown;
|
|
33272
|
-
};
|
|
33273
|
-
content?: never;
|
|
33274
|
-
};
|
|
33275
|
-
/** @description 0: Authorization has been denied for this request. */
|
|
33276
|
-
401: {
|
|
33277
|
-
headers: {
|
|
33278
|
-
[name: string]: unknown;
|
|
33279
|
-
};
|
|
33280
|
-
content?: never;
|
|
33281
|
-
};
|
|
33282
|
-
/**
|
|
33283
|
-
* @description User is not authorized for this action.
|
|
33284
|
-
* 0: Token Validation Failed
|
|
33285
|
-
*/
|
|
33286
|
-
403: {
|
|
33287
|
-
headers: {
|
|
33288
|
-
[name: string]: unknown;
|
|
33289
|
-
};
|
|
33290
|
-
content?: never;
|
|
33291
|
-
};
|
|
33292
|
-
};
|
|
33293
|
-
};
|
|
33294
|
-
/** Deletes the following between a user with userId and universe with universeId */
|
|
33295
|
-
delete: {
|
|
33296
|
-
parameters: {
|
|
33297
|
-
query?: never;
|
|
33298
|
-
header?: never;
|
|
33299
|
-
path: {
|
|
33300
|
-
userId: number;
|
|
33301
|
-
universeId: number;
|
|
33302
|
-
};
|
|
33303
|
-
cookie?: never;
|
|
33304
|
-
};
|
|
33305
|
-
requestBody?: never;
|
|
33306
|
-
responses: {
|
|
33307
|
-
/** @description OK */
|
|
33308
|
-
200: {
|
|
33309
|
-
headers: {
|
|
33310
|
-
[name: string]: unknown;
|
|
33311
|
-
};
|
|
33312
|
-
content: {
|
|
33313
|
-
"application/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseResponse"];
|
|
33314
|
-
"text/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseResponse"];
|
|
33315
|
-
};
|
|
33316
|
-
};
|
|
33317
|
-
/** @description 0: Authorization has been denied for this request. */
|
|
33318
|
-
401: {
|
|
33319
|
-
headers: {
|
|
33320
|
-
[name: string]: unknown;
|
|
33321
|
-
};
|
|
33322
|
-
content?: never;
|
|
33323
|
-
};
|
|
33324
|
-
/**
|
|
33325
|
-
* @description User is not authorized for this action.
|
|
33326
|
-
* 0: Token Validation Failed
|
|
33327
|
-
*/
|
|
33328
|
-
403: {
|
|
33329
|
-
headers: {
|
|
33330
|
-
[name: string]: unknown;
|
|
33331
|
-
};
|
|
33332
|
-
content?: never;
|
|
33333
|
-
};
|
|
33334
|
-
};
|
|
33335
|
-
};
|
|
33336
|
-
options?: never;
|
|
33337
|
-
head?: never;
|
|
33338
|
-
patch?: never;
|
|
33339
|
-
trace?: never;
|
|
33340
|
-
};
|
|
33341
|
-
"/v1/users/{userId}/universes/{universeId}/status": {
|
|
33342
|
-
parameters: {
|
|
33343
|
-
query?: never;
|
|
33344
|
-
header?: never;
|
|
33345
|
-
path?: never;
|
|
33346
|
-
cookie?: never;
|
|
33347
|
-
};
|
|
33348
|
-
/** Gets the status of a following relationship between a user and a universe. */
|
|
33349
|
-
get: {
|
|
33350
|
-
parameters: {
|
|
33351
|
-
query?: never;
|
|
33352
|
-
header?: never;
|
|
33353
|
-
path: {
|
|
33354
|
-
userId: number;
|
|
33355
|
-
universeId: number;
|
|
33356
|
-
};
|
|
33357
|
-
cookie?: never;
|
|
33358
|
-
};
|
|
33359
|
-
requestBody?: never;
|
|
33360
|
-
responses: {
|
|
33361
|
-
/** @description OK */
|
|
33362
|
-
200: {
|
|
33363
|
-
headers: {
|
|
33364
|
-
[name: string]: unknown;
|
|
33365
|
-
};
|
|
33366
|
-
content: {
|
|
33367
|
-
"application/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseStatusResponse"];
|
|
33368
|
-
"text/json": components["schemas"]["Roblox.Followings.Api.Models.UserFollowingUniverseStatusResponse"];
|
|
33369
|
-
};
|
|
33370
|
-
};
|
|
33371
|
-
/** @description 0: Authorization has been denied for this request. */
|
|
33372
|
-
401: {
|
|
33373
|
-
headers: {
|
|
33374
|
-
[name: string]: unknown;
|
|
33375
|
-
};
|
|
33376
|
-
content?: never;
|
|
33377
|
-
};
|
|
33378
|
-
/** @description User is not authorized for this action. */
|
|
33379
|
-
403: {
|
|
33380
|
-
headers: {
|
|
33381
|
-
[name: string]: unknown;
|
|
33382
|
-
};
|
|
33383
|
-
content?: never;
|
|
33384
|
-
};
|
|
33385
|
-
};
|
|
33386
|
-
};
|
|
33387
|
-
put?: never;
|
|
33388
|
-
post?: never;
|
|
33389
|
-
delete?: never;
|
|
33390
|
-
options?: never;
|
|
33391
|
-
head?: never;
|
|
33392
|
-
patch?: never;
|
|
33393
|
-
trace?: never;
|
|
33394
|
-
};
|
|
33395
33041
|
"/v1/users/{userId}/username-history": {
|
|
33396
33042
|
parameters: {
|
|
33397
33043
|
query?: never;
|
|
@@ -34294,7 +33940,11 @@ export interface paths {
|
|
|
34294
33940
|
path?: never;
|
|
34295
33941
|
cookie?: never;
|
|
34296
33942
|
};
|
|
34297
|
-
/**
|
|
33943
|
+
/**
|
|
33944
|
+
* Returns details about the authenticated user's avatar.
|
|
33945
|
+
* @deprecated
|
|
33946
|
+
* @description Please use GET v4/avatar
|
|
33947
|
+
*/
|
|
34298
33948
|
get: {
|
|
34299
33949
|
parameters: {
|
|
34300
33950
|
query?: {
|
|
@@ -34491,7 +34141,10 @@ export interface paths {
|
|
|
34491
34141
|
};
|
|
34492
34142
|
/**
|
|
34493
34143
|
* Returns details about a specified user's avatar.
|
|
34144
|
+
* @deprecated
|
|
34494
34145
|
* @description Includes assets, bodycolors, and playerAvatarType.
|
|
34146
|
+
*
|
|
34147
|
+
* Please use GET v4/avatar/users/{userId}
|
|
34495
34148
|
*/
|
|
34496
34149
|
get: {
|
|
34497
34150
|
parameters: {
|
|
@@ -36372,6 +36025,8 @@ export interface paths {
|
|
|
36372
36025
|
* 12: The user is invalid.
|
|
36373
36026
|
* 20: The password is invalid.
|
|
36374
36027
|
* 21: Passwords do not match.
|
|
36028
|
+
* 27: The password is not complex enough.
|
|
36029
|
+
* 28: The password is too similar to the username.
|
|
36375
36030
|
*/
|
|
36376
36031
|
400: {
|
|
36377
36032
|
headers: {
|
|
@@ -37418,6 +37073,8 @@ export interface paths {
|
|
|
37418
37073
|
* 4: Passwords do not match
|
|
37419
37074
|
* 5: Password cannot be used
|
|
37420
37075
|
* 8: The account security ticket is expired.
|
|
37076
|
+
* 14: Password is not complex enough
|
|
37077
|
+
* 15: Password is too similar to username
|
|
37421
37078
|
*/
|
|
37422
37079
|
400: {
|
|
37423
37080
|
headers: {
|
|
@@ -37727,6 +37384,8 @@ export interface paths {
|
|
|
37727
37384
|
* 12: Too many attempts. Please wait a bit.
|
|
37728
37385
|
* 17: One time Passcode session was not valid
|
|
37729
37386
|
* 22: Maximum logged in accounts limit reached.
|
|
37387
|
+
* 36: Password is not complex enough.
|
|
37388
|
+
* 37: Password is too similar to username.
|
|
37730
37389
|
* 44: Login is unavailable in your country.
|
|
37731
37390
|
*/
|
|
37732
37391
|
403: {
|
|
@@ -37824,6 +37483,8 @@ export interface paths {
|
|
|
37824
37483
|
* 22: Maximum logged in accounts limit reached.
|
|
37825
37484
|
* 29: Account Linking already exists on this account
|
|
37826
37485
|
* 30: Account Linking required but failed
|
|
37486
|
+
* 36: Password is not complex enough.
|
|
37487
|
+
* 37: Password is too similar to username.
|
|
37827
37488
|
* 44: Login is unavailable in your country.
|
|
37828
37489
|
*/
|
|
37829
37490
|
403: {
|
|
@@ -39247,6 +38908,7 @@ export interface paths {
|
|
|
39247
38908
|
* 22: Invalid asset type.
|
|
39248
38909
|
* 23: Invalid value, the min must be less than or equal to the max
|
|
39249
38910
|
* 24: Invalid scale value
|
|
38911
|
+
* 26: Invalid private server price
|
|
39250
38912
|
* 28: OptIn/Out Regions Not Supported.
|
|
39251
38913
|
* 41: You cannot change the private server price again so soon after the previous change. Please try again later.
|
|
39252
38914
|
* 44: The provided audience configuration is invalid. Ensure the audience list contains only supported audience values.
|
|
@@ -39269,6 +38931,7 @@ export interface paths {
|
|
|
39269
38931
|
* @description 0: Token Validation Failed
|
|
39270
38932
|
* 2: You are not authorized to configure this universe.
|
|
39271
38933
|
* 14: You are not authorized to sell games.
|
|
38934
|
+
* 25: Not authorized to update private server settings
|
|
39272
38935
|
* 29: Luobu app terms of service user agreement is missing.
|
|
39273
38936
|
* 30: Unknown error while updating Opt in out region.
|
|
39274
38937
|
* 45: The creator of this experience is not eligible to set this audience.
|
|
@@ -39286,7 +38949,10 @@ export interface paths {
|
|
|
39286
38949
|
};
|
|
39287
38950
|
content?: never;
|
|
39288
38951
|
};
|
|
39289
|
-
/**
|
|
38952
|
+
/**
|
|
38953
|
+
* @description 27: Unknown error while updating private server settings
|
|
38954
|
+
* 43: Failed to update the audience configuration. The change was not applied. Please try again.
|
|
38955
|
+
*/
|
|
39290
38956
|
500: {
|
|
39291
38957
|
headers: {
|
|
39292
38958
|
[name: string]: unknown;
|
|
@@ -39385,6 +39051,10 @@ export interface paths {
|
|
|
39385
39051
|
* @description Roblox.Web.Authentication.Passwords.PasswordResponseCodes.InvalidCurrentPassword
|
|
39386
39052
|
* OR
|
|
39387
39053
|
* Roblox.Web.Authentication.Passwords.PasswordResponseCodes.InvalidPassword
|
|
39054
|
+
* OR
|
|
39055
|
+
* Roblox.Web.Authentication.Passwords.PasswordResponseCodes.PasswordLowComplexity
|
|
39056
|
+
* OR
|
|
39057
|
+
* Roblox.Web.Authentication.Passwords.PasswordResponseCodes.PasswordTooSimilarToUsername
|
|
39388
39058
|
*/
|
|
39389
39059
|
400: {
|
|
39390
39060
|
headers: {
|
|
@@ -40044,103 +39714,30 @@ export interface paths {
|
|
|
40044
39714
|
patch?: never;
|
|
40045
39715
|
trace?: never;
|
|
40046
39716
|
};
|
|
40047
|
-
"/v2/users/{userId}/inventory/{assetTypeId}": {
|
|
40048
|
-
parameters: {
|
|
40049
|
-
query?: never;
|
|
40050
|
-
header?: never;
|
|
40051
|
-
path?: never;
|
|
40052
|
-
cookie?: never;
|
|
40053
|
-
};
|
|
40054
|
-
/** Gets user's inventory based on specific asset type */
|
|
40055
|
-
get: {
|
|
40056
|
-
parameters: {
|
|
40057
|
-
query?: {
|
|
40058
|
-
/** @description The number of results per request. */
|
|
40059
|
-
limit?: 10 | 25 | 50 | 100;
|
|
40060
|
-
/** @description The paging cursor for the previous or next page. */
|
|
40061
|
-
cursor?: string;
|
|
40062
|
-
/** @description The order the results are sorted in. */
|
|
40063
|
-
sortOrder?: "Asc" | "Desc";
|
|
40064
|
-
};
|
|
40065
|
-
header?: never;
|
|
40066
|
-
path: {
|
|
40067
|
-
/** @description The user Id of the inventory owner */
|
|
40068
|
-
userId: number;
|
|
40069
|
-
/** @description The asset type Id of the items to get */
|
|
40070
|
-
assetTypeId: number;
|
|
40071
|
-
};
|
|
40072
|
-
cookie?: never;
|
|
40073
|
-
};
|
|
40074
|
-
requestBody?: never;
|
|
40075
|
-
responses: {
|
|
40076
|
-
/** @description OK */
|
|
40077
|
-
200: {
|
|
40078
|
-
headers: {
|
|
40079
|
-
[name: string]: unknown;
|
|
40080
|
-
};
|
|
40081
|
-
content: {
|
|
40082
|
-
"application/json": components["schemas"]["Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Inventory.Api.Models.InventoryItemModel_"];
|
|
40083
|
-
"text/json": components["schemas"]["Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Inventory.Api.Models.InventoryItemModel_"];
|
|
40084
|
-
};
|
|
40085
|
-
};
|
|
40086
|
-
/**
|
|
40087
|
-
* @description 1: Invalid user Id.
|
|
40088
|
-
* 2: Invalid asset type Id.
|
|
40089
|
-
*/
|
|
40090
|
-
400: {
|
|
40091
|
-
headers: {
|
|
40092
|
-
[name: string]: unknown;
|
|
40093
|
-
};
|
|
40094
|
-
content?: never;
|
|
40095
|
-
};
|
|
40096
|
-
/**
|
|
40097
|
-
* @description 3: Insufficient permission.
|
|
40098
|
-
* 4: You are not authorized to view this user's inventory.
|
|
40099
|
-
*/
|
|
40100
|
-
403: {
|
|
40101
|
-
headers: {
|
|
40102
|
-
[name: string]: unknown;
|
|
40103
|
-
};
|
|
40104
|
-
content?: never;
|
|
40105
|
-
};
|
|
40106
|
-
};
|
|
40107
|
-
};
|
|
40108
|
-
put?: never;
|
|
40109
|
-
post?: never;
|
|
40110
|
-
delete?: never;
|
|
40111
|
-
options?: never;
|
|
40112
|
-
head?: never;
|
|
40113
|
-
patch?: never;
|
|
40114
|
-
trace?: never;
|
|
40115
|
-
};
|
|
40116
|
-
"/v2/users/{userId}/tradableItems": {
|
|
39717
|
+
"/v2/users/{userId}/inventory/{assetTypeId}": {
|
|
40117
39718
|
parameters: {
|
|
40118
39719
|
query?: never;
|
|
40119
39720
|
header?: never;
|
|
40120
39721
|
path?: never;
|
|
40121
39722
|
cookie?: never;
|
|
40122
39723
|
};
|
|
40123
|
-
/** Gets
|
|
39724
|
+
/** Gets user's inventory based on specific asset type */
|
|
40124
39725
|
get: {
|
|
40125
39726
|
parameters: {
|
|
40126
39727
|
query?: {
|
|
40127
|
-
/** @description
|
|
40128
|
-
|
|
40129
|
-
/** @description
|
|
40130
|
-
itemTargetTypes?: ("Unknown" | "HatAccessory" | "HairAccessory" | "FaceAccessory" | "NeckAccessory" | "ShoulderAccessory" | "FrontAccessory" | "BackAccessory" | "WaistAccessory" | "Gear" | "Face" | "JacketAccessory" | "SweaterAccessory" | "DressSkirtAccessory" | "Character" | "DynamicHead" | "Shoes" | "Animation")[];
|
|
40131
|
-
/** @description The key to sort tradable items by. */
|
|
40132
|
-
sortBy?: "Unknown" | "CreationTime" | "AcquisitionTime";
|
|
40133
|
-
/** @description The sort order for the tradable items. */
|
|
40134
|
-
sortOrder?: 0 | 1 | 2;
|
|
40135
|
-
/** @description The maximum number of items to return. */
|
|
40136
|
-
limit?: number;
|
|
40137
|
-
/** @description The pagination cursor. */
|
|
39728
|
+
/** @description The number of results per request. */
|
|
39729
|
+
limit?: 10 | 25 | 50 | 100;
|
|
39730
|
+
/** @description The paging cursor for the previous or next page. */
|
|
40138
39731
|
cursor?: string;
|
|
39732
|
+
/** @description The order the results are sorted in. */
|
|
39733
|
+
sortOrder?: "Asc" | "Desc";
|
|
40139
39734
|
};
|
|
40140
39735
|
header?: never;
|
|
40141
39736
|
path: {
|
|
40142
|
-
/** @description The
|
|
39737
|
+
/** @description The user Id of the inventory owner */
|
|
40143
39738
|
userId: number;
|
|
39739
|
+
/** @description The asset type Id of the items to get */
|
|
39740
|
+
assetTypeId: number;
|
|
40144
39741
|
};
|
|
40145
39742
|
cookie?: never;
|
|
40146
39743
|
};
|
|
@@ -40152,11 +39749,14 @@ export interface paths {
|
|
|
40152
39749
|
[name: string]: unknown;
|
|
40153
39750
|
};
|
|
40154
39751
|
content: {
|
|
40155
|
-
"application/json": components["schemas"]["Roblox.
|
|
40156
|
-
"text/json": components["schemas"]["Roblox.
|
|
39752
|
+
"application/json": components["schemas"]["Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Inventory.Api.Models.InventoryItemModel_"];
|
|
39753
|
+
"text/json": components["schemas"]["Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Inventory.Api.Models.InventoryItemModel_"];
|
|
40157
39754
|
};
|
|
40158
39755
|
};
|
|
40159
|
-
/**
|
|
39756
|
+
/**
|
|
39757
|
+
* @description 1: Invalid user Id.
|
|
39758
|
+
* 2: Invalid asset type Id.
|
|
39759
|
+
*/
|
|
40160
39760
|
400: {
|
|
40161
39761
|
headers: {
|
|
40162
39762
|
[name: string]: unknown;
|
|
@@ -40164,29 +39764,15 @@ export interface paths {
|
|
|
40164
39764
|
content?: never;
|
|
40165
39765
|
};
|
|
40166
39766
|
/**
|
|
40167
|
-
* @description
|
|
40168
|
-
* 4: You are not authorized to
|
|
39767
|
+
* @description 3: Insufficient permission.
|
|
39768
|
+
* 4: You are not authorized to view this user's inventory.
|
|
40169
39769
|
*/
|
|
40170
|
-
401: {
|
|
40171
|
-
headers: {
|
|
40172
|
-
[name: string]: unknown;
|
|
40173
|
-
};
|
|
40174
|
-
content?: never;
|
|
40175
|
-
};
|
|
40176
|
-
/** @description 4: You are not authorized to modify this trade. */
|
|
40177
39770
|
403: {
|
|
40178
39771
|
headers: {
|
|
40179
39772
|
[name: string]: unknown;
|
|
40180
39773
|
};
|
|
40181
39774
|
content?: never;
|
|
40182
39775
|
};
|
|
40183
|
-
/** @description 0: An unknown error occured. */
|
|
40184
|
-
404: {
|
|
40185
|
-
headers: {
|
|
40186
|
-
[name: string]: unknown;
|
|
40187
|
-
};
|
|
40188
|
-
content?: never;
|
|
40189
|
-
};
|
|
40190
39776
|
};
|
|
40191
39777
|
};
|
|
40192
39778
|
put?: never;
|
|
@@ -40197,20 +39783,33 @@ export interface paths {
|
|
|
40197
39783
|
patch?: never;
|
|
40198
39784
|
trace?: never;
|
|
40199
39785
|
};
|
|
40200
|
-
"/v2/users/{userId}/
|
|
39786
|
+
"/v2/users/{userId}/tradableItems": {
|
|
40201
39787
|
parameters: {
|
|
40202
39788
|
query?: never;
|
|
40203
39789
|
header?: never;
|
|
40204
39790
|
path?: never;
|
|
40205
39791
|
cookie?: never;
|
|
40206
39792
|
};
|
|
40207
|
-
/** Gets
|
|
39793
|
+
/** Gets tradable items for a user. */
|
|
40208
39794
|
get: {
|
|
40209
39795
|
parameters: {
|
|
40210
|
-
query?:
|
|
39796
|
+
query?: {
|
|
39797
|
+
/** @description Optional search query to filter items by. */
|
|
39798
|
+
search?: string;
|
|
39799
|
+
/** @description Optional list of item target types to filter by. */
|
|
39800
|
+
itemTargetTypes?: ("Unknown" | "HatAccessory" | "HairAccessory" | "FaceAccessory" | "NeckAccessory" | "ShoulderAccessory" | "FrontAccessory" | "BackAccessory" | "WaistAccessory" | "Gear" | "Face" | "JacketAccessory" | "SweaterAccessory" | "DressSkirtAccessory" | "Character" | "DynamicHead" | "Shoes" | "Animation")[];
|
|
39801
|
+
/** @description The key to sort tradable items by. */
|
|
39802
|
+
sortBy?: "Unknown" | "CreationTime" | "AcquisitionTime";
|
|
39803
|
+
/** @description The sort order for the tradable items. */
|
|
39804
|
+
sortOrder?: 0 | 1 | 2;
|
|
39805
|
+
/** @description The maximum number of items to return. */
|
|
39806
|
+
limit?: number;
|
|
39807
|
+
/** @description The pagination cursor. */
|
|
39808
|
+
cursor?: string;
|
|
39809
|
+
};
|
|
40211
39810
|
header?: never;
|
|
40212
39811
|
path: {
|
|
40213
|
-
/** @description The user
|
|
39812
|
+
/** @description The id of the user. */
|
|
40214
39813
|
userId: number;
|
|
40215
39814
|
};
|
|
40216
39815
|
cookie?: never;
|
|
@@ -40223,24 +39822,41 @@ export interface paths {
|
|
|
40223
39822
|
[name: string]: unknown;
|
|
40224
39823
|
};
|
|
40225
39824
|
content: {
|
|
40226
|
-
"application/json": components["schemas"]["Roblox.
|
|
40227
|
-
"text/json": components["schemas"]["Roblox.
|
|
39825
|
+
"application/json": components["schemas"]["Roblox.Trades.Api.Models.V2.GetUserTradableItemsResponse"];
|
|
39826
|
+
"text/json": components["schemas"]["Roblox.Trades.Api.Models.V2.GetUserTradableItemsResponse"];
|
|
40228
39827
|
};
|
|
40229
39828
|
};
|
|
40230
|
-
/** @description
|
|
39829
|
+
/** @description 25: The cursor provided is invalid. */
|
|
39830
|
+
400: {
|
|
39831
|
+
headers: {
|
|
39832
|
+
[name: string]: unknown;
|
|
39833
|
+
};
|
|
39834
|
+
content?: never;
|
|
39835
|
+
};
|
|
39836
|
+
/**
|
|
39837
|
+
* @description 0: Authorization has been denied for this request.
|
|
39838
|
+
* 4: You are not authorized to modify this trade.
|
|
39839
|
+
*/
|
|
40231
39840
|
401: {
|
|
40232
39841
|
headers: {
|
|
40233
39842
|
[name: string]: unknown;
|
|
40234
39843
|
};
|
|
40235
39844
|
content?: never;
|
|
40236
39845
|
};
|
|
40237
|
-
/** @description
|
|
39846
|
+
/** @description 4: You are not authorized to modify this trade. */
|
|
40238
39847
|
403: {
|
|
40239
39848
|
headers: {
|
|
40240
39849
|
[name: string]: unknown;
|
|
40241
39850
|
};
|
|
40242
39851
|
content?: never;
|
|
40243
39852
|
};
|
|
39853
|
+
/** @description 0: An unknown error occured. */
|
|
39854
|
+
404: {
|
|
39855
|
+
headers: {
|
|
39856
|
+
[name: string]: unknown;
|
|
39857
|
+
};
|
|
39858
|
+
content?: never;
|
|
39859
|
+
};
|
|
40244
39860
|
};
|
|
40245
39861
|
};
|
|
40246
39862
|
put?: never;
|
|
@@ -40503,7 +40119,11 @@ export interface paths {
|
|
|
40503
40119
|
path?: never;
|
|
40504
40120
|
cookie?: never;
|
|
40505
40121
|
};
|
|
40506
|
-
/**
|
|
40122
|
+
/**
|
|
40123
|
+
* Gets details about the contents of an outfit.
|
|
40124
|
+
* @deprecated
|
|
40125
|
+
* @description Please use GET v4/outfits/{outfitId}/details
|
|
40126
|
+
*/
|
|
40507
40127
|
get: {
|
|
40508
40128
|
parameters: {
|
|
40509
40129
|
query?: {
|
|
@@ -41125,6 +40745,395 @@ export interface components {
|
|
|
41125
40745
|
/** @description A join request ID. */
|
|
41126
40746
|
AcceptGroupJoinRequestRequest: Record<string, never>;
|
|
41127
40747
|
ActionResult: Record<string, never>;
|
|
40748
|
+
/** @description The threshold condition that determines when an alert fires. */
|
|
40749
|
+
"AlertStorage.AlertCondition": {
|
|
40750
|
+
operator: components["schemas"]["AlertStorage.ConditionOperator"];
|
|
40751
|
+
/**
|
|
40752
|
+
* Format: double
|
|
40753
|
+
* @description Numeric threshold the metric value is compared against.
|
|
40754
|
+
*/
|
|
40755
|
+
threshold: number;
|
|
40756
|
+
evaluationMode: components["schemas"]["AlertStorage.EvaluationMode"];
|
|
40757
|
+
/**
|
|
40758
|
+
* Format: int32
|
|
40759
|
+
* @description How many intervals back the comparison period is placed for `PeriodOverPeriod`
|
|
40760
|
+
* evaluation. A value of `1` compares against the immediately preceding interval;
|
|
40761
|
+
* a value of `7` with a `OneDay` interval compares against the same day last
|
|
40762
|
+
* week. `null` for `Absolute` conditions.
|
|
40763
|
+
*/
|
|
40764
|
+
periodOffsetMultiplier?: number | null;
|
|
40765
|
+
};
|
|
40766
|
+
/**
|
|
40767
|
+
* @description The current lifecycle state of an alert configuration.
|
|
40768
|
+
*
|
|
40769
|
+
* Enabled
|
|
40770
|
+
*
|
|
40771
|
+
* Disabled
|
|
40772
|
+
*
|
|
40773
|
+
* PausedByRoblox
|
|
40774
|
+
*
|
|
40775
|
+
* Syncing
|
|
40776
|
+
*
|
|
40777
|
+
* Error
|
|
40778
|
+
* @enum {string}
|
|
40779
|
+
*/
|
|
40780
|
+
"AlertStorage.AlertConfigState": "Enabled" | "Disabled" | "PausedByRoblox" | "Syncing" | "Error";
|
|
40781
|
+
/**
|
|
40782
|
+
* @description How frequently an alert condition is evaluated.
|
|
40783
|
+
*
|
|
40784
|
+
* OneMinute
|
|
40785
|
+
*
|
|
40786
|
+
* HalfHour
|
|
40787
|
+
*
|
|
40788
|
+
* OneHour
|
|
40789
|
+
*
|
|
40790
|
+
* OneDay
|
|
40791
|
+
* @enum {string}
|
|
40792
|
+
*/
|
|
40793
|
+
"AlertStorage.AlertInterval": "OneMinute" | "HalfHour" | "OneHour" | "OneDay";
|
|
40794
|
+
/**
|
|
40795
|
+
* @description Comparison operator used to evaluate whether a metric value breaches a threshold.
|
|
40796
|
+
*
|
|
40797
|
+
* Gt
|
|
40798
|
+
*
|
|
40799
|
+
* Gte
|
|
40800
|
+
*
|
|
40801
|
+
* Lt
|
|
40802
|
+
*
|
|
40803
|
+
* Lte
|
|
40804
|
+
* @enum {string}
|
|
40805
|
+
*/
|
|
40806
|
+
"AlertStorage.ConditionOperator": "Gt" | "Gte" | "Lt" | "Lte";
|
|
40807
|
+
/**
|
|
40808
|
+
* @description Determines how the metric value is derived before being compared against the threshold.
|
|
40809
|
+
*
|
|
40810
|
+
* Absolute
|
|
40811
|
+
*
|
|
40812
|
+
* PeriodOverPeriod
|
|
40813
|
+
* @enum {string}
|
|
40814
|
+
*/
|
|
40815
|
+
"AlertStorage.EvaluationMode": "Absolute" | "PeriodOverPeriod";
|
|
40816
|
+
/**
|
|
40817
|
+
* @description Whether an alert is currently in a firing or resolved state.
|
|
40818
|
+
*
|
|
40819
|
+
* OK
|
|
40820
|
+
*
|
|
40821
|
+
* Firing
|
|
40822
|
+
* @enum {string}
|
|
40823
|
+
*/
|
|
40824
|
+
"AlertStorage.FiringStatus": "OK" | "Firing";
|
|
40825
|
+
/**
|
|
40826
|
+
* @description The type of resource an alert is attached to.
|
|
40827
|
+
*
|
|
40828
|
+
* Universe
|
|
40829
|
+
* @enum {string}
|
|
40830
|
+
*/
|
|
40831
|
+
"AlertStorage.ResourceType": "Universe";
|
|
40832
|
+
/**
|
|
40833
|
+
* @description Severity level assigned to an alert configuration.
|
|
40834
|
+
*
|
|
40835
|
+
* SEV_0
|
|
40836
|
+
*
|
|
40837
|
+
* SEV_1
|
|
40838
|
+
*
|
|
40839
|
+
* SEV_2
|
|
40840
|
+
* @enum {string}
|
|
40841
|
+
*/
|
|
40842
|
+
"AlertStorage.Severity": "SEV_0" | "SEV_1" | "SEV_2";
|
|
40843
|
+
/** @description A single webhook notification destination linked to an alert configuration. */
|
|
40844
|
+
"AlertStorage.WebhookReceiver": {
|
|
40845
|
+
/**
|
|
40846
|
+
* @description The ID of the webhook configuration in the Webhook Delivery System. Must be a valid
|
|
40847
|
+
* UUID and unique within the list on this alert configuration.
|
|
40848
|
+
*/
|
|
40849
|
+
webhookConfigurationId: string;
|
|
40850
|
+
};
|
|
40851
|
+
/**
|
|
40852
|
+
* @description Webhook notification settings for an alert. When set, each webhook in the
|
|
40853
|
+
* `receivers` list will be called whenever the alert fires or resolves.
|
|
40854
|
+
* Set to `null` to disable webhook notifications for the alert.
|
|
40855
|
+
*/
|
|
40856
|
+
"AlertStorage.WebhookReceiverConfig": {
|
|
40857
|
+
/**
|
|
40858
|
+
* @description List of webhook destinations to notify when the alert fires or resolves. Each entry
|
|
40859
|
+
* references a webhook configuration you have created in the Webhook Delivery System.
|
|
40860
|
+
* The list must contain unique entries with no duplicates.
|
|
40861
|
+
*/
|
|
40862
|
+
receivers?: components["schemas"]["AlertStorage.WebhookReceiver"][] | null;
|
|
40863
|
+
};
|
|
40864
|
+
/**
|
|
40865
|
+
* @description The threshold condition for an alert. Specifies the comparison operator, threshold value,
|
|
40866
|
+
* and how the metric value is derived before comparison.
|
|
40867
|
+
*
|
|
40868
|
+
* On create, `operator`, `threshold`, and `evaluationMode` are all required.
|
|
40869
|
+
* On update (PATCH), the entire `condition` object is optional; when included, any
|
|
40870
|
+
* sub-field can be omitted to keep its current value.
|
|
40871
|
+
*
|
|
40872
|
+
* `periodOffsetMultiplier` only applies when `evaluationMode` is
|
|
40873
|
+
* `PeriodOverPeriod`. It is ignored for `Absolute` conditions.
|
|
40874
|
+
*/
|
|
40875
|
+
"AnalyticsAlertControlPlane.Models.AlertConditionInput": {
|
|
40876
|
+
operator?: components["schemas"]["AlertStorage.ConditionOperator"];
|
|
40877
|
+
/**
|
|
40878
|
+
* Format: double
|
|
40879
|
+
* @description Numeric threshold the metric value is compared against.
|
|
40880
|
+
* Required on create; optional on update.
|
|
40881
|
+
*/
|
|
40882
|
+
threshold?: number | null;
|
|
40883
|
+
evaluationMode?: components["schemas"]["AlertStorage.EvaluationMode"];
|
|
40884
|
+
/**
|
|
40885
|
+
* Format: int32
|
|
40886
|
+
* @description How many intervals back the comparison period is placed for
|
|
40887
|
+
* `PeriodOverPeriod` evaluation. For example, a value of `1` (the default)
|
|
40888
|
+
* compares the current interval against the immediately preceding interval.
|
|
40889
|
+
* A value of `7` with a `OneDay` interval compares today against the same
|
|
40890
|
+
* day last week. Only valid when `evaluationMode` is `PeriodOverPeriod`;
|
|
40891
|
+
* omit or leave `null` for `Absolute` conditions.
|
|
40892
|
+
*/
|
|
40893
|
+
periodOffsetMultiplier?: number | null;
|
|
40894
|
+
};
|
|
40895
|
+
/** @description Key fields of the alert configuration that triggered an incident. */
|
|
40896
|
+
"AnalyticsAlertControlPlane.Models.AlertConfigSummary": {
|
|
40897
|
+
/** @description Unique identifier of the alert configuration (string-encoded 64-bit integer). */
|
|
40898
|
+
id: string;
|
|
40899
|
+
/** @description Display name of the alert configuration. */
|
|
40900
|
+
name: string;
|
|
40901
|
+
/** @description Name of the metric this alert evaluates. */
|
|
40902
|
+
metric: string;
|
|
40903
|
+
severity: components["schemas"]["AlertStorage.Severity"];
|
|
40904
|
+
/** @description Optional free-text description of the alert's purpose. */
|
|
40905
|
+
description?: string | null;
|
|
40906
|
+
interval: components["schemas"]["AlertStorage.AlertInterval"];
|
|
40907
|
+
/** @description Dimension filters applied to the metric query, if any. */
|
|
40908
|
+
filter?: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertQueryFilter"][] | null;
|
|
40909
|
+
/** @description Grouping dimensions for the metric query, if any. */
|
|
40910
|
+
breakdown?: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertQueryBreakdown"][] | null;
|
|
40911
|
+
condition: components["schemas"]["AlertStorage.AlertCondition"];
|
|
40912
|
+
};
|
|
40913
|
+
/** @description Full details of a saved alert configuration. */
|
|
40914
|
+
"AnalyticsAlertControlPlane.Models.AlertDetailResponse": {
|
|
40915
|
+
/** @description Unique identifier of the alert configuration (string-encoded 64-bit integer). */
|
|
40916
|
+
alertId: string;
|
|
40917
|
+
resourceType: components["schemas"]["AlertStorage.ResourceType"];
|
|
40918
|
+
/** @description Numeric ID of the resource this alert monitors (e.g. the universe ID). */
|
|
40919
|
+
resourceId: string;
|
|
40920
|
+
/** @description Display name of the alert. Must be unique within the resource. */
|
|
40921
|
+
name: string;
|
|
40922
|
+
/** @description Name of the metric this alert evaluates. */
|
|
40923
|
+
metric: string;
|
|
40924
|
+
/** @description Optional free-text description of the alert's purpose. */
|
|
40925
|
+
description?: string | null;
|
|
40926
|
+
severity: components["schemas"]["AlertStorage.Severity"];
|
|
40927
|
+
interval: components["schemas"]["AlertStorage.AlertInterval"];
|
|
40928
|
+
/**
|
|
40929
|
+
* Format: int32
|
|
40930
|
+
* @description Number of consecutive evaluation periods the condition must be met before the alert fires.
|
|
40931
|
+
* Must be at least 1. For example, a value of 3 with a 1-minute interval means the condition
|
|
40932
|
+
* must hold for 3 consecutive minutes before an incident is opened.
|
|
40933
|
+
*/
|
|
40934
|
+
consecutiveOccurrences: number;
|
|
40935
|
+
/**
|
|
40936
|
+
* @description Optional dimension filters applied to the metric query. Each entry restricts the metric
|
|
40937
|
+
* to rows where the specified dimension matches one of the given values.
|
|
40938
|
+
*/
|
|
40939
|
+
filter?: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertQueryFilter"][] | null;
|
|
40940
|
+
/**
|
|
40941
|
+
* @description Optional grouping dimensions for the metric query. When set, the alert evaluates
|
|
40942
|
+
* the metric independently for each combination of dimension values and fires if any
|
|
40943
|
+
* group breaches the condition.
|
|
40944
|
+
*/
|
|
40945
|
+
breakdown?: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertQueryBreakdown"][] | null;
|
|
40946
|
+
condition: components["schemas"]["AlertStorage.AlertCondition"];
|
|
40947
|
+
configState: components["schemas"]["AlertStorage.AlertConfigState"];
|
|
40948
|
+
webhookReceiverConfig?: components["schemas"]["AlertStorage.WebhookReceiverConfig"];
|
|
40949
|
+
firingStatus: components["schemas"]["AlertStorage.FiringStatus"];
|
|
40950
|
+
/**
|
|
40951
|
+
* Format: date-time
|
|
40952
|
+
* @description Timestamp of the most recent firing event. `null` if the alert has never fired.
|
|
40953
|
+
*/
|
|
40954
|
+
lastFiredAt?: string | null;
|
|
40955
|
+
/**
|
|
40956
|
+
* Format: date-time
|
|
40957
|
+
* @description Timestamp when this alert configuration was created (UTC).
|
|
40958
|
+
*/
|
|
40959
|
+
createdAt: string;
|
|
40960
|
+
/**
|
|
40961
|
+
* Format: date-time
|
|
40962
|
+
* @description Timestamp of the most recent modification to this alert configuration (UTC).
|
|
40963
|
+
*/
|
|
40964
|
+
lastModifiedAt: string;
|
|
40965
|
+
/**
|
|
40966
|
+
* @description ID of the user who last modified this alert configuration.
|
|
40967
|
+
* `null` if the last modification was made by the system.
|
|
40968
|
+
*/
|
|
40969
|
+
lastModifiedBy?: string | null;
|
|
40970
|
+
};
|
|
40971
|
+
/**
|
|
40972
|
+
* @description A set of dimensions used to group the metric query. When a breakdown is specified, the
|
|
40973
|
+
* alert evaluates each unique combination of dimension values independently and fires if any
|
|
40974
|
+
* group breaches the condition.
|
|
40975
|
+
*/
|
|
40976
|
+
"AnalyticsAlertControlPlane.Models.AlertQueryBreakdown": {
|
|
40977
|
+
/** @description Names of the dimensions to group by (e.g. `["platform", "age_bracket"]`). */
|
|
40978
|
+
dimensions: string[];
|
|
40979
|
+
};
|
|
40980
|
+
/**
|
|
40981
|
+
* @description A dimension filter applied to the metric query. Restricts the metric to rows where the
|
|
40982
|
+
* specified dimension matches one of the given values.
|
|
40983
|
+
*/
|
|
40984
|
+
"AnalyticsAlertControlPlane.Models.AlertQueryFilter": {
|
|
40985
|
+
/** @description Name of the dimension to filter on (e.g. `platform`). */
|
|
40986
|
+
dimension: string;
|
|
40987
|
+
/**
|
|
40988
|
+
* @description The allowed values for this dimension. A metric data point is included only if its
|
|
40989
|
+
* dimension value is in this list.
|
|
40990
|
+
*/
|
|
40991
|
+
values: string[];
|
|
40992
|
+
};
|
|
40993
|
+
/** @description Request body for creating a new alert configuration. */
|
|
40994
|
+
"AnalyticsAlertControlPlane.Models.CreateAlertConfigRequest": {
|
|
40995
|
+
/**
|
|
40996
|
+
* @description Display name of the alert. Must be unique within the resource. Maximum length is 128
|
|
40997
|
+
* characters and the value is subject to Roblox text-moderation policies.
|
|
40998
|
+
*/
|
|
40999
|
+
name: string;
|
|
41000
|
+
/** @description Name of the metric this alert should evaluate. */
|
|
41001
|
+
metric: string;
|
|
41002
|
+
/** @description Optional free-text description of the alert's purpose. */
|
|
41003
|
+
description?: string | null;
|
|
41004
|
+
severity: components["schemas"]["AlertStorage.Severity"];
|
|
41005
|
+
interval: components["schemas"]["AlertStorage.AlertInterval"];
|
|
41006
|
+
/**
|
|
41007
|
+
* Format: int32
|
|
41008
|
+
* @description Number of consecutive evaluation periods the condition must be met before the alert
|
|
41009
|
+
* fires. Must be at least 1. For example, a value of 3 with a 1-minute interval means
|
|
41010
|
+
* the condition must hold for 3 consecutive minutes before an incident is opened.
|
|
41011
|
+
*/
|
|
41012
|
+
consecutiveOccurrences: number;
|
|
41013
|
+
/**
|
|
41014
|
+
* @description Optional grouping dimensions for the metric query. When set, the alert evaluates
|
|
41015
|
+
* the metric independently for each combination of dimension values and fires if any
|
|
41016
|
+
* group breaches the condition.
|
|
41017
|
+
*/
|
|
41018
|
+
breakdown?: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertQueryBreakdown"][] | null;
|
|
41019
|
+
/**
|
|
41020
|
+
* @description Optional dimension filters applied to the metric query. Each entry restricts the metric
|
|
41021
|
+
* to rows where the specified dimension matches one of the given values.
|
|
41022
|
+
*/
|
|
41023
|
+
filter?: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertQueryFilter"][] | null;
|
|
41024
|
+
condition: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertConditionInput"];
|
|
41025
|
+
webhookReceiverConfig?: components["schemas"]["AlertStorage.WebhookReceiverConfig"];
|
|
41026
|
+
};
|
|
41027
|
+
/** @description Standard error response body for the Alerts API. */
|
|
41028
|
+
"AnalyticsAlertControlPlane.Models.ErrorResponse": {
|
|
41029
|
+
/** @description Machine-readable error code (e.g. PERMISSION_DENIED). */
|
|
41030
|
+
errorCode?: string | null;
|
|
41031
|
+
/** @description Human-readable error description. */
|
|
41032
|
+
message?: string | null;
|
|
41033
|
+
};
|
|
41034
|
+
/**
|
|
41035
|
+
* @description A single metric value that breached the alert threshold, optionally scoped to a specific
|
|
41036
|
+
* dimension value when the alert uses a breakdown.
|
|
41037
|
+
*/
|
|
41038
|
+
"AnalyticsAlertControlPlane.Models.FiringConditionResponse": {
|
|
41039
|
+
/**
|
|
41040
|
+
* Format: double
|
|
41041
|
+
* @description The metric value that exceeded the threshold at the time of evaluation.
|
|
41042
|
+
*/
|
|
41043
|
+
firingValue: number;
|
|
41044
|
+
firingDimension?: components["schemas"]["AnalyticsAlertControlPlane.Models.FiringDimensionResponse"];
|
|
41045
|
+
};
|
|
41046
|
+
/** @description A dimension name/value pair that identifies which slice of the metric was firing. */
|
|
41047
|
+
"AnalyticsAlertControlPlane.Models.FiringDimensionResponse": {
|
|
41048
|
+
/** @description Name of the dimension (e.g. `platform`). */
|
|
41049
|
+
dimension: string;
|
|
41050
|
+
/** @description Value of the dimension for the slice that was firing (e.g. `Mobile`). */
|
|
41051
|
+
value: string;
|
|
41052
|
+
};
|
|
41053
|
+
/**
|
|
41054
|
+
* @description A snapshot of the alert condition at a specific evaluation, capturing the metric values
|
|
41055
|
+
* that were firing and any dimension breakdowns involved.
|
|
41056
|
+
*/
|
|
41057
|
+
"AnalyticsAlertControlPlane.Models.FiringMetadataResponse": {
|
|
41058
|
+
/** @description Dimension filters that were active at this evaluation, if any. */
|
|
41059
|
+
filter?: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertQueryFilter"][] | null;
|
|
41060
|
+
/** @description Grouping dimensions that were active at this evaluation, if any. */
|
|
41061
|
+
breakdown?: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertQueryBreakdown"][] | null;
|
|
41062
|
+
condition: components["schemas"]["AlertStorage.AlertCondition"];
|
|
41063
|
+
/** @description The specific metric values and dimension combinations that caused the condition to fire. */
|
|
41064
|
+
firingCondition: components["schemas"]["AnalyticsAlertControlPlane.Models.FiringConditionResponse"][];
|
|
41065
|
+
};
|
|
41066
|
+
/** @description Details of a single alert incident. */
|
|
41067
|
+
"AnalyticsAlertControlPlane.Models.IncidentDetailResponse": {
|
|
41068
|
+
/** @description Unique identifier of this incident. */
|
|
41069
|
+
id: string;
|
|
41070
|
+
resourceType: components["schemas"]["AlertStorage.ResourceType"];
|
|
41071
|
+
/** @description Numeric ID of the resource this incident belongs to (e.g. the universe ID). */
|
|
41072
|
+
resourceId: string;
|
|
41073
|
+
status: components["schemas"]["AlertStorage.FiringStatus"];
|
|
41074
|
+
/**
|
|
41075
|
+
* Format: date-time
|
|
41076
|
+
* @description Timestamp when this incident was first opened (UTC).
|
|
41077
|
+
*/
|
|
41078
|
+
openedAt: string;
|
|
41079
|
+
/**
|
|
41080
|
+
* Format: date-time
|
|
41081
|
+
* @description Start of the evaluation window that first satisfied the alert condition and opened this
|
|
41082
|
+
* incident (UTC).
|
|
41083
|
+
*/
|
|
41084
|
+
openedWindowStartAt: string;
|
|
41085
|
+
/**
|
|
41086
|
+
* Format: date-time
|
|
41087
|
+
* @description Timestamp when this incident was resolved (UTC). `null` if the incident is still
|
|
41088
|
+
* active.
|
|
41089
|
+
*/
|
|
41090
|
+
resolvedAt?: string | null;
|
|
41091
|
+
/**
|
|
41092
|
+
* Format: date-time
|
|
41093
|
+
* @description Start of the evaluation window in which the alert condition was no longer satisfied,
|
|
41094
|
+
* causing the incident to be resolved (UTC). `null` if the incident is still active.
|
|
41095
|
+
*/
|
|
41096
|
+
resolvedWindowStartAt?: string | null;
|
|
41097
|
+
firstFiringMetadata: components["schemas"]["AnalyticsAlertControlPlane.Models.FiringMetadataResponse"];
|
|
41098
|
+
latestFiringMetadata: components["schemas"]["AnalyticsAlertControlPlane.Models.FiringMetadataResponse"];
|
|
41099
|
+
alertConfig: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertConfigSummary"];
|
|
41100
|
+
};
|
|
41101
|
+
/**
|
|
41102
|
+
* @description Request body for partially updating an alert configuration (PATCH semantics). All fields
|
|
41103
|
+
* are optional; only the fields present in the request body are updated.
|
|
41104
|
+
*/
|
|
41105
|
+
"AnalyticsAlertControlPlane.Models.UpdateAlertConfigRequest": {
|
|
41106
|
+
/**
|
|
41107
|
+
* @description New display name for the alert. Must be unique within the resource. Subject to
|
|
41108
|
+
* Roblox text-moderation policies.
|
|
41109
|
+
*/
|
|
41110
|
+
name?: string | null;
|
|
41111
|
+
/** @description New metric name this alert should evaluate. */
|
|
41112
|
+
metric?: string | null;
|
|
41113
|
+
/** @description New free-text description of the alert's purpose. */
|
|
41114
|
+
description?: string | null;
|
|
41115
|
+
severity?: components["schemas"]["AlertStorage.Severity"];
|
|
41116
|
+
interval?: components["schemas"]["AlertStorage.AlertInterval"];
|
|
41117
|
+
/**
|
|
41118
|
+
* Format: int32
|
|
41119
|
+
* @description New consecutive-occurrences count. When set, the alert will require the condition to
|
|
41120
|
+
* hold for this many consecutive evaluation periods before firing. Must be at least 1.
|
|
41121
|
+
*/
|
|
41122
|
+
consecutiveOccurrences?: number | null;
|
|
41123
|
+
/**
|
|
41124
|
+
* @description New grouping dimensions for the metric query. Replaces the existing breakdown entirely
|
|
41125
|
+
* when provided.
|
|
41126
|
+
*/
|
|
41127
|
+
breakdown?: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertQueryBreakdown"][] | null;
|
|
41128
|
+
/**
|
|
41129
|
+
* @description New dimension filters for the metric query. Replaces the existing filter list entirely
|
|
41130
|
+
* when provided.
|
|
41131
|
+
*/
|
|
41132
|
+
filter?: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertQueryFilter"][] | null;
|
|
41133
|
+
condition?: components["schemas"]["AnalyticsAlertControlPlane.Models.AlertConditionInput"];
|
|
41134
|
+
webhookReceiverConfig?: components["schemas"]["AlertStorage.WebhookReceiverConfig"];
|
|
41135
|
+
configState?: components["schemas"]["AlertStorage.AlertConfigState"];
|
|
41136
|
+
};
|
|
41128
41137
|
/** @description A breakdown dimension value in a query result. */
|
|
41129
41138
|
"AnalyticsQueryPublicApi.BreakdownValue": {
|
|
41130
41139
|
/** @description The dimension name. */
|
|
@@ -41681,24 +41690,6 @@ export interface components {
|
|
|
41681
41690
|
/** Format: int32 */
|
|
41682
41691
|
rank?: number;
|
|
41683
41692
|
};
|
|
41684
|
-
/** @description Get Client Status request. */
|
|
41685
|
-
ClientStatusGetRequest: {
|
|
41686
|
-
/**
|
|
41687
|
-
* Format: int64
|
|
41688
|
-
* @description The client's browser tracker id.
|
|
41689
|
-
*/
|
|
41690
|
-
browserTrackerId?: number | null;
|
|
41691
|
-
};
|
|
41692
|
-
/** @description Set Client Status request. */
|
|
41693
|
-
ClientStatusSetRequest: {
|
|
41694
|
-
/** @description The client's status to send. */
|
|
41695
|
-
status?: string | null;
|
|
41696
|
-
/**
|
|
41697
|
-
* Format: int64
|
|
41698
|
-
* @description The client's browser tracker id.
|
|
41699
|
-
*/
|
|
41700
|
-
browserTrackerId?: number | null;
|
|
41701
|
-
};
|
|
41702
41693
|
/**
|
|
41703
41694
|
* @description Request body for
|
|
41704
41695
|
* `POST /v1/experimentation/universes/{universeId}/experiments/{experimentId}:complete`.
|
|
@@ -42523,8 +42514,6 @@ export interface components {
|
|
|
42523
42514
|
*/
|
|
42524
42515
|
collectionName?: string | null;
|
|
42525
42516
|
} | null;
|
|
42526
|
-
/** @description Response for deleting the start place override for a universe. */
|
|
42527
|
-
DeleteStartPlaceOverrideResponse: Record<string, never>;
|
|
42528
42517
|
/**
|
|
42529
42518
|
* @description Deployment strategy for publishing configurations.
|
|
42530
42519
|
*
|
|
@@ -43103,18 +43092,6 @@ export interface components {
|
|
|
43103
43092
|
[key: string]: components["schemas"]["PlaceSummaryForGameRestart"];
|
|
43104
43093
|
} | null;
|
|
43105
43094
|
};
|
|
43106
|
-
/** @description ForecastUpdateRequest is used to request an update to the forecast of a Place in a Universe. */
|
|
43107
|
-
ForecastUpdateRequest: {
|
|
43108
|
-
/**
|
|
43109
|
-
* Format: int64
|
|
43110
|
-
* @description The Universe ID to update.
|
|
43111
|
-
*/
|
|
43112
|
-
universeId?: number;
|
|
43113
|
-
};
|
|
43114
|
-
/** @description ForecastUpdateResponse is used to return information about the forecasted update of a place. */
|
|
43115
|
-
ForecastUpdateResponse: {
|
|
43116
|
-
placeSummaries?: components["schemas"]["PlaceSummaryForGameUpdate"][] | null;
|
|
43117
|
-
};
|
|
43118
43095
|
/** @description v3 game event response. All fields except VirtualEventsApi.Models.V3.Response.GameEventResponse.Id are gated by the `?fields=` mask. */
|
|
43119
43096
|
GameEventResponse: {
|
|
43120
43097
|
/**
|
|
@@ -43265,21 +43242,6 @@ export interface components {
|
|
|
43265
43242
|
*/
|
|
43266
43243
|
structuredStackTrace?: components["schemas"]["StructuredStackFrame"][] | null;
|
|
43267
43244
|
};
|
|
43268
|
-
GameUpdateStatus: {
|
|
43269
|
-
/** Format: uuid */
|
|
43270
|
-
id?: string;
|
|
43271
|
-
/** Format: int64 */
|
|
43272
|
-
universeId?: number;
|
|
43273
|
-
/** Format: date-time */
|
|
43274
|
-
startTime?: string;
|
|
43275
|
-
closeOldVersionsOnly?: boolean;
|
|
43276
|
-
/** Format: date-time */
|
|
43277
|
-
bleedOffEndTime?: string;
|
|
43278
|
-
placeUpdateStatuses?: {
|
|
43279
|
-
[key: string]: components["schemas"]["PlaceUpdateStatus"];
|
|
43280
|
-
} | null;
|
|
43281
|
-
bleedOffServers?: boolean;
|
|
43282
|
-
};
|
|
43283
43245
|
GameVoteResponse: {
|
|
43284
43246
|
/** Format: int64 */
|
|
43285
43247
|
id?: number;
|
|
@@ -43291,11 +43253,6 @@ export interface components {
|
|
|
43291
43253
|
GameVoteResponseApiArrayResponse: {
|
|
43292
43254
|
data?: components["schemas"]["GameVoteResponse"][] | null;
|
|
43293
43255
|
};
|
|
43294
|
-
/** @description Response for generating mock server signal values. */
|
|
43295
|
-
GenerateMockServerSignalValuesResponse: {
|
|
43296
|
-
/** @description The mock server signal values. */
|
|
43297
|
-
exampleGameSignalValues?: components["schemas"]["MockServerSignalValues"][] | null;
|
|
43298
|
-
};
|
|
43299
43256
|
/**
|
|
43300
43257
|
* @description Represents metadata about the long-running operation corresponding to a
|
|
43301
43258
|
* GenerateSpeechAsset request.
|
|
@@ -43402,32 +43359,6 @@ export interface components {
|
|
|
43402
43359
|
GetMatchmakingScoringConfigurationResponse: {
|
|
43403
43360
|
scoringConfiguration?: components["schemas"]["MatchmakingScoringConfiguration"];
|
|
43404
43361
|
};
|
|
43405
|
-
/** @description Response containing the weights of the current default matchmaking scoring weights */
|
|
43406
|
-
GetMatchmakingScoringDefaultWeightsResponse: {
|
|
43407
|
-
/** @description The weights of the current default matchmaking scoring weights. */
|
|
43408
|
-
weights?: {
|
|
43409
|
-
/** Format: double */
|
|
43410
|
-
Invalid?: number;
|
|
43411
|
-
/** Format: double */
|
|
43412
|
-
Occupancy?: number;
|
|
43413
|
-
/** Format: double */
|
|
43414
|
-
Age?: number;
|
|
43415
|
-
/** Format: double */
|
|
43416
|
-
Language?: number;
|
|
43417
|
-
/** Format: double */
|
|
43418
|
-
Latency?: number;
|
|
43419
|
-
/** Format: double */
|
|
43420
|
-
PreferredPlayers?: number;
|
|
43421
|
-
/** Format: double */
|
|
43422
|
-
VoiceChat?: number;
|
|
43423
|
-
/** Format: double */
|
|
43424
|
-
DeviceType?: number;
|
|
43425
|
-
/** Format: double */
|
|
43426
|
-
PlayHistory?: number;
|
|
43427
|
-
/** Format: double */
|
|
43428
|
-
TextChat?: number;
|
|
43429
|
-
} | null;
|
|
43430
|
-
};
|
|
43431
43362
|
GetPlaceContributorsResponse: {
|
|
43432
43363
|
nextCursor?: string | null;
|
|
43433
43364
|
hasMore?: boolean;
|
|
@@ -43454,15 +43385,6 @@ export interface components {
|
|
|
43454
43385
|
/** @description Gets or sets the saves. */
|
|
43455
43386
|
saves: components["schemas"]["HydratedSave"][] | null;
|
|
43456
43387
|
} | null;
|
|
43457
|
-
/** @description Response for getting the start place override for a universe. */
|
|
43458
|
-
GetStartPlaceOverrideResponse: {
|
|
43459
|
-
dataStoreLocation?: components["schemas"]["DataStoreLocation"];
|
|
43460
|
-
};
|
|
43461
|
-
/** @description Get Update Status response. */
|
|
43462
|
-
GetUpdateStatusResponse: {
|
|
43463
|
-
/** @description The status of the game update. */
|
|
43464
|
-
updateStatusList?: components["schemas"]["GameUpdateStatus"][] | null;
|
|
43465
|
-
};
|
|
43466
43388
|
/** @description Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. */
|
|
43467
43389
|
GoogleProtobufAny: {
|
|
43468
43390
|
/** @description The type of the serialized message. */
|
|
@@ -44300,61 +44222,6 @@ export interface components {
|
|
|
44300
44222
|
*/
|
|
44301
44223
|
instancesImpacted?: number;
|
|
44302
44224
|
};
|
|
44303
|
-
/** @description Launch Update Request. Contains specification for how update should roll out */
|
|
44304
|
-
LaunchUpdateRequest: {
|
|
44305
|
-
/**
|
|
44306
|
-
* Format: int64
|
|
44307
|
-
* @description The Universe ID to update.
|
|
44308
|
-
*/
|
|
44309
|
-
universeId?: number;
|
|
44310
|
-
/** @description The place IDs to update. If none are specified, we will update all active Places in the Universe */
|
|
44311
|
-
placeIds?: number[] | null;
|
|
44312
|
-
/**
|
|
44313
|
-
* @description If true (default in UI), we will only migrate players from servers running old PlaceVersions.
|
|
44314
|
-
* If false, we will migrate all players
|
|
44315
|
-
*/
|
|
44316
|
-
closeOldVersionsOnly?: boolean;
|
|
44317
|
-
/**
|
|
44318
|
-
* @description If true (default in UI), we will stop matchmaking to servers but keep them up before shutting them down, allowing
|
|
44319
|
-
* players to naturally migrate to the newer version.
|
|
44320
|
-
* If false, we will immediately start shutting down servers
|
|
44321
|
-
*/
|
|
44322
|
-
bleedOffServers?: boolean;
|
|
44323
|
-
/**
|
|
44324
|
-
* Format: int32
|
|
44325
|
-
* @description If BleedOffServers=true, how long will we allow old servers to stay up before shutting them down.
|
|
44326
|
-
* Valid values: 1 - 60 minutes
|
|
44327
|
-
*/
|
|
44328
|
-
bleedOffDurationMinutes?: number;
|
|
44329
|
-
/**
|
|
44330
|
-
* @description Optional. A mapping of PlaceId to the specific versions to restart/bleed off for that place.
|
|
44331
|
-
* When set for a place, only servers running those exact versions will be affected.
|
|
44332
|
-
* If a place is not in this dictionary or has an empty set, behavior falls back to CloseOldVersionsOnly logic.
|
|
44333
|
-
*/
|
|
44334
|
-
placeIdToVersions?: {
|
|
44335
|
-
[key: string]: number[] | null;
|
|
44336
|
-
} | null;
|
|
44337
|
-
/** @description Optional. Attributes string to include in the ServerLifecycleChanged CSM payload published to game servers. */
|
|
44338
|
-
attributes?: string | null;
|
|
44339
|
-
};
|
|
44340
|
-
/** @description Launch Update response. */
|
|
44341
|
-
LaunchUpdateResponse: {
|
|
44342
|
-
/**
|
|
44343
|
-
* Format: uuid
|
|
44344
|
-
* @description An ID for UI to query status of this update
|
|
44345
|
-
*/
|
|
44346
|
-
updateId?: string;
|
|
44347
|
-
/**
|
|
44348
|
-
* Format: int32
|
|
44349
|
-
* @description How many players are playing in servers that will be shut down according to the update configuration
|
|
44350
|
-
*/
|
|
44351
|
-
numPlayersToBeKicked?: number;
|
|
44352
|
-
/**
|
|
44353
|
-
* Format: int32
|
|
44354
|
-
* @description How many game instances will be closed according to the update configuration
|
|
44355
|
-
*/
|
|
44356
|
-
instancesToBeClosed?: number;
|
|
44357
|
-
};
|
|
44358
44225
|
/**
|
|
44359
44226
|
* Format: int32
|
|
44360
44227
|
* @enum {integer}
|
|
@@ -45257,66 +45124,6 @@ export interface components {
|
|
|
45257
45124
|
*/
|
|
45258
45125
|
readonly count?: number;
|
|
45259
45126
|
};
|
|
45260
|
-
/** @description Mock server signal values. */
|
|
45261
|
-
MockServerSignalValues: {
|
|
45262
|
-
/**
|
|
45263
|
-
* Format: int32
|
|
45264
|
-
* @description The capacity of the mock server.
|
|
45265
|
-
*/
|
|
45266
|
-
capacity?: number;
|
|
45267
|
-
/**
|
|
45268
|
-
* Format: int32
|
|
45269
|
-
* @description The occupancy of the mock server.
|
|
45270
|
-
*/
|
|
45271
|
-
occupancy?: number;
|
|
45272
|
-
/** @description If the game has preferred players. */
|
|
45273
|
-
hasPreferredPlayers?: boolean;
|
|
45274
|
-
/**
|
|
45275
|
-
* Format: int32
|
|
45276
|
-
* @description The joining player's age.
|
|
45277
|
-
*/
|
|
45278
|
-
playerAge?: number;
|
|
45279
|
-
/**
|
|
45280
|
-
* Format: int32
|
|
45281
|
-
* @description The server's age for the mock server.
|
|
45282
|
-
*/
|
|
45283
|
-
serverAveragePlayerAge?: number;
|
|
45284
|
-
/**
|
|
45285
|
-
* Format: int32
|
|
45286
|
-
* @description The number of player's in the mock server that have a common language.
|
|
45287
|
-
*/
|
|
45288
|
-
commonLanguagePlayers?: number;
|
|
45289
|
-
/**
|
|
45290
|
-
* Format: int32
|
|
45291
|
-
* @description The latency of the mock server.
|
|
45292
|
-
*/
|
|
45293
|
-
latency?: number;
|
|
45294
|
-
/**
|
|
45295
|
-
* Format: int32
|
|
45296
|
-
* @description The number of player's in the mock server that have a common device.
|
|
45297
|
-
*/
|
|
45298
|
-
commonDevicePlayers?: number;
|
|
45299
|
-
/**
|
|
45300
|
-
* Format: double
|
|
45301
|
-
* @description The joining player's play history. The value is a log10 transformation of the player's playtime in minutes during last 28 days.
|
|
45302
|
-
*/
|
|
45303
|
-
playerPlayHistory?: number;
|
|
45304
|
-
/**
|
|
45305
|
-
* Format: double
|
|
45306
|
-
* @description The server's play history for the mock server.
|
|
45307
|
-
*/
|
|
45308
|
-
serverAveragePlayHistory?: number;
|
|
45309
|
-
/**
|
|
45310
|
-
* Format: int32
|
|
45311
|
-
* @description The number of player's in the mock server that have voice chat enabled.
|
|
45312
|
-
*/
|
|
45313
|
-
commonVoicePlayers?: number | null;
|
|
45314
|
-
/**
|
|
45315
|
-
* Format: int32
|
|
45316
|
-
* @description The number of player's in the mock server that can commonly text chat with the joining player.
|
|
45317
|
-
*/
|
|
45318
|
-
commonTextChatPlayers?: number;
|
|
45319
|
-
};
|
|
45320
45127
|
/** @description Representation of a model asset. */
|
|
45321
45128
|
Model: ({
|
|
45322
45129
|
/** @description The subtypes that the model belongs to. */
|
|
@@ -45914,110 +45721,6 @@ export interface components {
|
|
|
45914
45721
|
[key: string]: number;
|
|
45915
45722
|
} | null;
|
|
45916
45723
|
};
|
|
45917
|
-
/** @description Summary of a place for a game update. */
|
|
45918
|
-
PlaceSummaryForGameUpdate: {
|
|
45919
|
-
/**
|
|
45920
|
-
* Format: int64
|
|
45921
|
-
* @description Place ID of the place to be updated.
|
|
45922
|
-
*/
|
|
45923
|
-
placeId?: number;
|
|
45924
|
-
/**
|
|
45925
|
-
* Format: int32
|
|
45926
|
-
* @description Number of players to be kicked from the place during the game update.
|
|
45927
|
-
*/
|
|
45928
|
-
playersToBeKicked?: number;
|
|
45929
|
-
/**
|
|
45930
|
-
* Format: int32
|
|
45931
|
-
* @description Total number of players in the place.
|
|
45932
|
-
*/
|
|
45933
|
-
totalPlayers?: number;
|
|
45934
|
-
/**
|
|
45935
|
-
* Format: int32
|
|
45936
|
-
* @description Number of instances to be closed for the place during the game update.
|
|
45937
|
-
*/
|
|
45938
|
-
instancesToBeClosed?: number;
|
|
45939
|
-
/**
|
|
45940
|
-
* Format: int32
|
|
45941
|
-
* @description Total number of instances for the place.
|
|
45942
|
-
*/
|
|
45943
|
-
totalInstances?: number;
|
|
45944
|
-
/**
|
|
45945
|
-
* Format: int32
|
|
45946
|
-
* @description Lastest version of the place to be updated.
|
|
45947
|
-
*/
|
|
45948
|
-
placeVersion?: number;
|
|
45949
|
-
/**
|
|
45950
|
-
* Format: date-time
|
|
45951
|
-
* @description The timestamp of the last update to the place summary.
|
|
45952
|
-
*/
|
|
45953
|
-
lastUpdated?: string;
|
|
45954
|
-
/**
|
|
45955
|
-
* @description Indicates whether the place is still part of the universe.
|
|
45956
|
-
* A place may have active games but is no longer in the universe if it has been removed from the universe.
|
|
45957
|
-
*/
|
|
45958
|
-
isInUniverse?: boolean;
|
|
45959
|
-
/**
|
|
45960
|
-
* @description Player counts broken down by place version.
|
|
45961
|
-
* Key is the place version, value is the number of players on that version.
|
|
45962
|
-
*/
|
|
45963
|
-
versionToPlayerCounts?: {
|
|
45964
|
-
[key: string]: number;
|
|
45965
|
-
} | null;
|
|
45966
|
-
/**
|
|
45967
|
-
* @description Instance counts broken down by place version.
|
|
45968
|
-
* Key is the place version, value is the number of instances on that version.
|
|
45969
|
-
*/
|
|
45970
|
-
versionToInstanceCounts?: {
|
|
45971
|
-
[key: string]: number;
|
|
45972
|
-
} | null;
|
|
45973
|
-
};
|
|
45974
|
-
/** @description Container for the status of a game update. */
|
|
45975
|
-
PlaceUpdateStatus: {
|
|
45976
|
-
/**
|
|
45977
|
-
* Format: int64
|
|
45978
|
-
* @description The placeId of the game update
|
|
45979
|
-
*/
|
|
45980
|
-
placeId?: number;
|
|
45981
|
-
/** @description Which phase is the update in: BleedOff, Migrate, or Done */
|
|
45982
|
-
phase?: string | null;
|
|
45983
|
-
/**
|
|
45984
|
-
* Format: date-time
|
|
45985
|
-
* @description When the update started
|
|
45986
|
-
*/
|
|
45987
|
-
startTime?: string;
|
|
45988
|
-
/**
|
|
45989
|
-
* Format: date-time
|
|
45990
|
-
* @description When the update is expected to end, or null if it has not ended yet
|
|
45991
|
-
*/
|
|
45992
|
-
endTime?: string | null;
|
|
45993
|
-
/**
|
|
45994
|
-
* Format: int32
|
|
45995
|
-
* @description Number of players in the game update initially, before any players are kicked
|
|
45996
|
-
*/
|
|
45997
|
-
startPlayersToBeKicked?: number;
|
|
45998
|
-
/**
|
|
45999
|
-
* Format: int32
|
|
46000
|
-
* @description Number of instances that will be closed during the game update
|
|
46001
|
-
*/
|
|
46002
|
-
startInstancesToBeClosed?: number;
|
|
46003
|
-
/**
|
|
46004
|
-
* Format: int32
|
|
46005
|
-
* @description How many players are remaining in instances that will be shut down according to the update configuration
|
|
46006
|
-
*/
|
|
46007
|
-
numPlayersToBeKicked?: number;
|
|
46008
|
-
/**
|
|
46009
|
-
* Format: int32
|
|
46010
|
-
* @description Number of places that will be updated
|
|
46011
|
-
*/
|
|
46012
|
-
instancesToBeClosed?: number;
|
|
46013
|
-
/**
|
|
46014
|
-
* Format: int32
|
|
46015
|
-
* @description The version of the place that is being updated
|
|
46016
|
-
*/
|
|
46017
|
-
placeVersion?: number;
|
|
46018
|
-
/** @description The versions of the place that will be closed during the update */
|
|
46019
|
-
placeVersionsToBeClosed?: number[] | null;
|
|
46020
|
-
};
|
|
46021
45724
|
PlaceVersion: {
|
|
46022
45725
|
version?: string | null;
|
|
46023
45726
|
title?: string | null;
|
|
@@ -47755,7 +47458,7 @@ export interface components {
|
|
|
47755
47458
|
* @description The type of outfit
|
|
47756
47459
|
* @enum {integer}
|
|
47757
47460
|
*/
|
|
47758
|
-
outfitType?: 0 | 1 | 2 | 4 | 5;
|
|
47461
|
+
outfitType?: 0 | 1 | 2 | 4 | 5 | 6;
|
|
47759
47462
|
};
|
|
47760
47463
|
/** @description A model containing details needed to update or create an outfit. */
|
|
47761
47464
|
"Roblox.Api.Avatar.Models.OutfitUpdateModelV3": {
|
|
@@ -47772,7 +47475,7 @@ export interface components {
|
|
|
47772
47475
|
* @description The type of outfit.
|
|
47773
47476
|
* @enum {integer}
|
|
47774
47477
|
*/
|
|
47775
|
-
outfitType?: 0 | 1 | 2 | 4 | 5;
|
|
47478
|
+
outfitType?: 0 | 1 | 2 | 4 | 5 | 6;
|
|
47776
47479
|
};
|
|
47777
47480
|
/** @description A model that contains a playerAvatarType */
|
|
47778
47481
|
"Roblox.Api.Avatar.Models.PlayerAvatarTypeModel": {
|
|
@@ -47934,7 +47637,7 @@ export interface components {
|
|
|
47934
47637
|
* @description The type of the outfit.
|
|
47935
47638
|
* @enum {integer}
|
|
47936
47639
|
*/
|
|
47937
|
-
outfitType?: 0 | 1 | 2 | 4 | 5;
|
|
47640
|
+
outfitType?: 0 | 1 | 2 | 4 | 5 | 6;
|
|
47938
47641
|
/** @description The assets on the outfit. */
|
|
47939
47642
|
assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"][];
|
|
47940
47643
|
bodyColors?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColorsModelV4"];
|
|
@@ -48067,7 +47770,7 @@ export interface components {
|
|
|
48067
47770
|
* @description The type of outfit (for example Avatar or Makeup). Defaults to Avatar when omitted.
|
|
48068
47771
|
* @enum {integer}
|
|
48069
47772
|
*/
|
|
48070
|
-
outfitType?: 0 | 1 | 2 | 4 | 5;
|
|
47773
|
+
outfitType?: 0 | 1 | 2 | 4 | 5 | 6;
|
|
48071
47774
|
};
|
|
48072
47775
|
/** @description A model that contains a list of AssetWear models */
|
|
48073
47776
|
"Roblox.Api.Avatar.Models.WearRequestModel": {
|
|
@@ -49147,10 +48850,10 @@ export interface components {
|
|
|
49147
48850
|
"Roblox.Authentication.Api.Models.AccountUpgradeRequest": {
|
|
49148
48851
|
/**
|
|
49149
48852
|
* Format: int32
|
|
49150
|
-
* @description ['Unknown' = 0, 'Pioneer' = 1, 'OAuth' = 2, 'Guest' = 3]
|
|
48853
|
+
* @description ['Unknown' = 0, 'Pioneer' = 1, 'OAuth' = 2, 'Guest' = 3, 'PioneerU13' = 4]
|
|
49151
48854
|
* @enum {integer}
|
|
49152
48855
|
*/
|
|
49153
|
-
upgradeType?: 0 | 1 | 2 | 3;
|
|
48856
|
+
upgradeType?: 0 | 1 | 2 | 3 | 4;
|
|
49154
48857
|
username?: string;
|
|
49155
48858
|
password?: string;
|
|
49156
48859
|
/** Format: date-time */
|
|
@@ -49290,10 +48993,10 @@ export interface components {
|
|
|
49290
48993
|
"Roblox.Authentication.Api.Models.PasswordValidationResponse": {
|
|
49291
48994
|
/**
|
|
49292
48995
|
* Format: int32
|
|
49293
|
-
* @description ['ValidPassword' = 0, 'WeakPasswordError' = 1, 'PasswordLengthError' = 2, 'PasswordSameAsUsernameError' = 3, 'ForbiddenPasswordError' = 4, 'DumbStringsError' = 5]
|
|
48996
|
+
* @description ['ValidPassword' = 0, 'WeakPasswordError' = 1, 'PasswordLengthError' = 2, 'PasswordSameAsUsernameError' = 3, 'ForbiddenPasswordError' = 4, 'DumbStringsError' = 5, 'PasswordLowComplexityError' = 6, 'PasswordTooSimilarToUsernameError' = 7]
|
|
49294
48997
|
* @enum {integer}
|
|
49295
48998
|
*/
|
|
49296
|
-
code?: 0 | 1 | 2 | 3 | 4 | 5;
|
|
48999
|
+
code?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
|
|
49297
49000
|
message?: string;
|
|
49298
49001
|
};
|
|
49299
49002
|
"Roblox.Authentication.Api.Models.ProviderInfoModel": {
|
|
@@ -50469,70 +50172,6 @@ export interface components {
|
|
|
50469
50172
|
[key: string]: number[][];
|
|
50470
50173
|
};
|
|
50471
50174
|
};
|
|
50472
|
-
/** @description Data model containing collection of all followed sources of a specific type. */
|
|
50473
|
-
"Roblox.Followings.Api.Models.FollowsByTypeResponse": {
|
|
50474
|
-
/**
|
|
50475
|
-
* Format: int32
|
|
50476
|
-
* @description Type of the follower entity. ['Invalid' = 0, 'User' = 1]
|
|
50477
|
-
* @enum {integer}
|
|
50478
|
-
*/
|
|
50479
|
-
followerType?: 0 | 1;
|
|
50480
|
-
/**
|
|
50481
|
-
* Format: int64
|
|
50482
|
-
* @description ID of the follower entity.
|
|
50483
|
-
*/
|
|
50484
|
-
followerId?: number;
|
|
50485
|
-
/**
|
|
50486
|
-
* Format: int32
|
|
50487
|
-
* @description Type of the source entity. ['Invalid' = 0, 'Universe' = 1]
|
|
50488
|
-
* @enum {integer}
|
|
50489
|
-
*/
|
|
50490
|
-
sourceType?: 0 | 1;
|
|
50491
|
-
/** @description Followed sources: map of (source ID => follow date) */
|
|
50492
|
-
followedSources?: {
|
|
50493
|
-
[key: string]: string;
|
|
50494
|
-
};
|
|
50495
|
-
};
|
|
50496
|
-
/** @description Model for a user following a universe controller responses */
|
|
50497
|
-
"Roblox.Followings.Api.Models.UserFollowingUniverseResponse": {
|
|
50498
|
-
/**
|
|
50499
|
-
* Format: int64
|
|
50500
|
-
* @description The id of the universe being followed
|
|
50501
|
-
*/
|
|
50502
|
-
universeId?: number;
|
|
50503
|
-
/**
|
|
50504
|
-
* Format: int64
|
|
50505
|
-
* @description The id of the user that is following
|
|
50506
|
-
*/
|
|
50507
|
-
userId?: number;
|
|
50508
|
-
};
|
|
50509
|
-
/** @description Model for a user following a universe state controller responses */
|
|
50510
|
-
"Roblox.Followings.Api.Models.UserFollowingUniverseStatusResponse": {
|
|
50511
|
-
/**
|
|
50512
|
-
* Format: int64
|
|
50513
|
-
* @description The id of the universe.
|
|
50514
|
-
*/
|
|
50515
|
-
UniverseId?: number;
|
|
50516
|
-
/**
|
|
50517
|
-
* Format: int64
|
|
50518
|
-
* @description The id of the user.
|
|
50519
|
-
*/
|
|
50520
|
-
UserId?: number;
|
|
50521
|
-
/** @description If the user can follow the universe. */
|
|
50522
|
-
CanFollow?: boolean;
|
|
50523
|
-
/** @description If the user is currently following the universe. */
|
|
50524
|
-
IsFollowing?: boolean;
|
|
50525
|
-
/**
|
|
50526
|
-
* Format: int32
|
|
50527
|
-
* @description The number of followings between this user and a universe.
|
|
50528
|
-
*/
|
|
50529
|
-
FollowingCountByType?: number;
|
|
50530
|
-
/**
|
|
50531
|
-
* Format: int32
|
|
50532
|
-
* @description The limit to the number of followings between a user and a universe for a specific user.
|
|
50533
|
-
*/
|
|
50534
|
-
FollowingLimitByType?: number;
|
|
50535
|
-
};
|
|
50536
50175
|
/** @description A response model representing a friend request. */
|
|
50537
50176
|
"Roblox.Friends.Api.FriendRequest": {
|
|
50538
50177
|
/**
|
|
@@ -50552,10 +50191,10 @@ export interface components {
|
|
|
50552
50191
|
sourceUniverseId?: number;
|
|
50553
50192
|
/**
|
|
50554
50193
|
* Format: int32
|
|
50555
|
-
* @description The origin source type associated with the friend request. ['Unknown' = 0, 'PlayerSearch' = 1, 'QrCode' = 2, 'InGame' = 3, 'UserProfile' = 4, 'QqContactImporter' = 5, 'WeChatContactImporter' = 6, 'ProfileShare' = 7, 'PhoneContactImporter' = 8, 'FriendRecommendations' = 9, 'UserCommunities' = 10, 'TrustedFriend' = 11, 'SchoolMemberList' = 12]
|
|
50194
|
+
* @description The origin source type associated with the friend request. ['Unknown' = 0, 'PlayerSearch' = 1, 'QrCode' = 2, 'InGame' = 3, 'UserProfile' = 4, 'QqContactImporter' = 5, 'WeChatContactImporter' = 6, 'ProfileShare' = 7, 'PhoneContactImporter' = 8, 'FriendRecommendations' = 9, 'UserCommunities' = 10, 'TrustedFriend' = 11, 'SchoolMemberList' = 12, 'SocialTabsPage' = 13]
|
|
50556
50195
|
* @enum {integer}
|
|
50557
50196
|
*/
|
|
50558
|
-
originSourceType?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
|
|
50197
|
+
originSourceType?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13;
|
|
50559
50198
|
/** @description The contact name associated with the friend request. */
|
|
50560
50199
|
contactName?: string;
|
|
50561
50200
|
/** @description The nickname associated with the friend request. */
|
|
@@ -54267,61 +53906,6 @@ export interface components {
|
|
|
54267
53906
|
/** @description The ID of the scoring configuration. */
|
|
54268
53907
|
scoringConfigurationId?: string | null;
|
|
54269
53908
|
};
|
|
54270
|
-
/**
|
|
54271
|
-
* @description Request body for setting the start place override for a universe. The universe is
|
|
54272
|
-
* identified by the route, so it is not part of the body.
|
|
54273
|
-
*/
|
|
54274
|
-
SetStartPlaceOverrideRequestBody: {
|
|
54275
|
-
dataStoreLocation?: components["schemas"]["DataStoreLocation"];
|
|
54276
|
-
};
|
|
54277
|
-
/** @description Response for setting the start place override for a universe. */
|
|
54278
|
-
SetStartPlaceOverrideResponse: Record<string, never>;
|
|
54279
|
-
/** @description Shutdown All Game Instances response. */
|
|
54280
|
-
ShutdownAllGameInstancesResponse: {
|
|
54281
|
-
/**
|
|
54282
|
-
* Format: int64
|
|
54283
|
-
* @description The place ID to shut down.
|
|
54284
|
-
*/
|
|
54285
|
-
placeId?: number;
|
|
54286
|
-
/** @description Whether to replace instances or not. */
|
|
54287
|
-
replaceInstances?: boolean;
|
|
54288
|
-
};
|
|
54289
|
-
/** @description Shutdown Game Instance request. */
|
|
54290
|
-
ShutdownGameInstancesRequest: {
|
|
54291
|
-
/**
|
|
54292
|
-
* Format: int64
|
|
54293
|
-
* @description The place ID to shut down.
|
|
54294
|
-
*/
|
|
54295
|
-
placeId?: number;
|
|
54296
|
-
/**
|
|
54297
|
-
* Format: int64
|
|
54298
|
-
* @description The private server ID.
|
|
54299
|
-
*/
|
|
54300
|
-
privateServerId?: number | null;
|
|
54301
|
-
/**
|
|
54302
|
-
* Format: uuid
|
|
54303
|
-
* @description The game ID.
|
|
54304
|
-
*/
|
|
54305
|
-
gameId?: string | null;
|
|
54306
|
-
};
|
|
54307
|
-
/** @description Shutdown Game Instance response. */
|
|
54308
|
-
ShutdownGameInstancesResponse: {
|
|
54309
|
-
/**
|
|
54310
|
-
* Format: int64
|
|
54311
|
-
* @description The place ID to shut down.
|
|
54312
|
-
*/
|
|
54313
|
-
placeId?: number;
|
|
54314
|
-
/**
|
|
54315
|
-
* Format: int64
|
|
54316
|
-
* @description The private server ID.
|
|
54317
|
-
*/
|
|
54318
|
-
privateServerId?: number | null;
|
|
54319
|
-
/**
|
|
54320
|
-
* Format: uuid
|
|
54321
|
-
* @description The game ID.
|
|
54322
|
-
*/
|
|
54323
|
-
gameId?: string | null;
|
|
54324
|
-
};
|
|
54325
53909
|
/** @description Variant definition for an in-game-config experiment (CreatorConfigsPublicApi.Models.Experimentation.InGameConfigExperimentConfiguration). */
|
|
54326
53910
|
SingleConfigExperimentVariant: {
|
|
54327
53911
|
/** @description Metadata common to all variants. */
|
|
@@ -55707,10 +55291,10 @@ export interface components {
|
|
|
55707
55291
|
/** @description The display name of the campaign. */
|
|
55708
55292
|
name?: string;
|
|
55709
55293
|
/**
|
|
55710
|
-
* @description The advertising goal of the campaign. `PLAYS` for campaigns created via this API; campaigns from other surfaces may report `AWARENESS`, `REACH`, `
|
|
55294
|
+
* @description The advertising goal of the campaign. `PLAYS` or `ENGAGEMENT` for campaigns created via this API; campaigns from other surfaces may report `AWARENESS`, `REACH`, `VIDEO_VIEWS`, or `ROBUX_SPEND`.
|
|
55711
55295
|
* @enum {string}
|
|
55712
55296
|
*/
|
|
55713
|
-
objective?: "PLAYS" | "
|
|
55297
|
+
objective?: "PLAYS" | "ENGAGEMENT" | "AWARENESS" | "REACH" | "VIDEO_VIEWS" | "ROBUX_SPEND";
|
|
55714
55298
|
/**
|
|
55715
55299
|
* @description How the campaign is paid for. Fixed when the campaign is created. Can be
|
|
55716
55300
|
* `CREDIT_CARD`, `ADS_CREDIT`, or `INVOICE`.
|
|
@@ -55747,11 +55331,8 @@ export interface components {
|
|
|
55747
55331
|
* @description The eligibility result for the requested experience. Present only when
|
|
55748
55332
|
* universeId was supplied in the request.
|
|
55749
55333
|
*/
|
|
55750
|
-
eligibility?: components["schemas"]["internal_public_v1.
|
|
55751
|
-
/**
|
|
55752
|
-
* @description The campaign objectives you can create. Values can be `PLAYS` or the
|
|
55753
|
-
* deprecated `ENGAGEMENT` (both create the same campaign).
|
|
55754
|
-
*/
|
|
55334
|
+
eligibility?: components["schemas"]["internal_public_v1.PublicUniverseEligibility"];
|
|
55335
|
+
/** @description The campaign objectives you can create. Values can be `PLAYS` or `ENGAGEMENT`. */
|
|
55755
55336
|
objectives?: ("PLAYS" | "ENGAGEMENT")[];
|
|
55756
55337
|
/**
|
|
55757
55338
|
* @description The payment types available for the caller's account. Values can be
|
|
@@ -55788,8 +55369,8 @@ export interface components {
|
|
|
55788
55369
|
/** @description The display name of the campaign. Required. */
|
|
55789
55370
|
name: string;
|
|
55790
55371
|
/**
|
|
55791
|
-
* @description The advertising goal. Required. Can be `PLAYS`
|
|
55792
|
-
*
|
|
55372
|
+
* @description The advertising goal. Required. Can be `PLAYS` or `ENGAGEMENT`. `ENGAGEMENT`
|
|
55373
|
+
* does not support targeting and is not available for every experience.
|
|
55793
55374
|
* @enum {string}
|
|
55794
55375
|
*/
|
|
55795
55376
|
objective: "PLAYS" | "ENGAGEMENT";
|
|
@@ -55896,6 +55477,17 @@ export interface components {
|
|
|
55896
55477
|
/** @description A human-readable description of the error. */
|
|
55897
55478
|
message?: string;
|
|
55898
55479
|
};
|
|
55480
|
+
"internal_public_v1.PublicUniverseEligibility": {
|
|
55481
|
+
/** @description Whether the experience can currently be advertised. */
|
|
55482
|
+
eligible?: boolean;
|
|
55483
|
+
/**
|
|
55484
|
+
* @description The reasons the experience is not eligible. Omitted when eligible. Values can be
|
|
55485
|
+
* `NO_PERMISSION` or `BLOCKED`.
|
|
55486
|
+
*/
|
|
55487
|
+
reasons?: ("NO_PERMISSION" | "BLOCKED")[];
|
|
55488
|
+
/** @description The identifier of the experience that was checked. */
|
|
55489
|
+
universeId?: string;
|
|
55490
|
+
};
|
|
55899
55491
|
"internal_public_v1.Schedule": {
|
|
55900
55492
|
/**
|
|
55901
55493
|
* @description How long the campaign runs from startTime, in days. Must not exceed 3650 (about
|
|
@@ -55938,17 +55530,6 @@ export interface components {
|
|
|
55938
55530
|
/** @description The selectable device types. Values can be `PHONE`, `TABLET`, `DESKTOP`, or `CONSOLE`. */
|
|
55939
55531
|
devices?: ("PHONE" | "TABLET" | "DESKTOP" | "CONSOLE")[];
|
|
55940
55532
|
};
|
|
55941
|
-
"internal_public_v1.UniverseEligibility": {
|
|
55942
|
-
/** @description Whether the experience can currently be advertised. */
|
|
55943
|
-
eligible?: boolean;
|
|
55944
|
-
/**
|
|
55945
|
-
* @description The reasons the experience is not eligible. Omitted when eligible. Values can be
|
|
55946
|
-
* `NO_PERMISSION` or `BLOCKED`.
|
|
55947
|
-
*/
|
|
55948
|
-
reasons?: ("NO_PERMISSION" | "BLOCKED")[];
|
|
55949
|
-
/** @description The identifier of the experience that was checked. */
|
|
55950
|
-
universeId?: string;
|
|
55951
|
-
};
|
|
55952
55533
|
"internal_public_v1.UpdateBudget": {
|
|
55953
55534
|
/**
|
|
55954
55535
|
* @description The new budget amount in micro-USD, as a decimal string (for example,
|
|
@@ -56107,6 +55688,13 @@ export interface components {
|
|
|
56107
55688
|
"text/json": components["schemas"]["Roblox.Authentication.Api.Models.SignupRequest"];
|
|
56108
55689
|
};
|
|
56109
55690
|
};
|
|
55691
|
+
/** @description Roblox.Catalog.Api.MultigetItemDetailsRequestModel. */
|
|
55692
|
+
"Roblox.Catalog.Api.MultigetItemDetailsRequestModel": {
|
|
55693
|
+
content: {
|
|
55694
|
+
"application/json": components["schemas"]["Roblox.Catalog.Api.MultigetItemDetailsRequestModel"];
|
|
55695
|
+
"text/json": components["schemas"]["Roblox.Catalog.Api.MultigetItemDetailsRequestModel"];
|
|
55696
|
+
};
|
|
55697
|
+
};
|
|
56110
55698
|
"Roblox.PrivateMessages.Api.Models.BatchMessagesRequest": {
|
|
56111
55699
|
content: {
|
|
56112
55700
|
"application/json": components["schemas"]["Roblox.PrivateMessages.Api.Models.BatchMessagesRequest"];
|