@jacobhumston/roblox-openapi-ts 1.0.61 → 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 +995 -154
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -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;
|
|
@@ -27307,6 +27806,7 @@ export interface paths {
|
|
|
27307
27806
|
get: {
|
|
27308
27807
|
parameters: {
|
|
27309
27808
|
query: {
|
|
27809
|
+
/** @description The type of a statistics dataset. ['PremiumUpsells' = 0, 'PremiumVisits' = 1] */
|
|
27310
27810
|
Type: "PremiumUpsells" | "PremiumVisits";
|
|
27311
27811
|
StartTime: string;
|
|
27312
27812
|
EndTime: string;
|
|
@@ -33440,7 +33940,11 @@ export interface paths {
|
|
|
33440
33940
|
path?: never;
|
|
33441
33941
|
cookie?: never;
|
|
33442
33942
|
};
|
|
33443
|
-
/**
|
|
33943
|
+
/**
|
|
33944
|
+
* Returns details about the authenticated user's avatar.
|
|
33945
|
+
* @deprecated
|
|
33946
|
+
* @description Please use GET v4/avatar
|
|
33947
|
+
*/
|
|
33444
33948
|
get: {
|
|
33445
33949
|
parameters: {
|
|
33446
33950
|
query?: {
|
|
@@ -33637,7 +34141,10 @@ export interface paths {
|
|
|
33637
34141
|
};
|
|
33638
34142
|
/**
|
|
33639
34143
|
* Returns details about a specified user's avatar.
|
|
34144
|
+
* @deprecated
|
|
33640
34145
|
* @description Includes assets, bodycolors, and playerAvatarType.
|
|
34146
|
+
*
|
|
34147
|
+
* Please use GET v4/avatar/users/{userId}
|
|
33641
34148
|
*/
|
|
33642
34149
|
get: {
|
|
33643
34150
|
parameters: {
|
|
@@ -38401,6 +38908,7 @@ export interface paths {
|
|
|
38401
38908
|
* 22: Invalid asset type.
|
|
38402
38909
|
* 23: Invalid value, the min must be less than or equal to the max
|
|
38403
38910
|
* 24: Invalid scale value
|
|
38911
|
+
* 26: Invalid private server price
|
|
38404
38912
|
* 28: OptIn/Out Regions Not Supported.
|
|
38405
38913
|
* 41: You cannot change the private server price again so soon after the previous change. Please try again later.
|
|
38406
38914
|
* 44: The provided audience configuration is invalid. Ensure the audience list contains only supported audience values.
|
|
@@ -38423,6 +38931,7 @@ export interface paths {
|
|
|
38423
38931
|
* @description 0: Token Validation Failed
|
|
38424
38932
|
* 2: You are not authorized to configure this universe.
|
|
38425
38933
|
* 14: You are not authorized to sell games.
|
|
38934
|
+
* 25: Not authorized to update private server settings
|
|
38426
38935
|
* 29: Luobu app terms of service user agreement is missing.
|
|
38427
38936
|
* 30: Unknown error while updating Opt in out region.
|
|
38428
38937
|
* 45: The creator of this experience is not eligible to set this audience.
|
|
@@ -38440,7 +38949,10 @@ export interface paths {
|
|
|
38440
38949
|
};
|
|
38441
38950
|
content?: never;
|
|
38442
38951
|
};
|
|
38443
|
-
/**
|
|
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
|
+
*/
|
|
38444
38956
|
500: {
|
|
38445
38957
|
headers: {
|
|
38446
38958
|
[name: string]: unknown;
|
|
@@ -39607,7 +40119,11 @@ export interface paths {
|
|
|
39607
40119
|
path?: never;
|
|
39608
40120
|
cookie?: never;
|
|
39609
40121
|
};
|
|
39610
|
-
/**
|
|
40122
|
+
/**
|
|
40123
|
+
* Gets details about the contents of an outfit.
|
|
40124
|
+
* @deprecated
|
|
40125
|
+
* @description Please use GET v4/outfits/{outfitId}/details
|
|
40126
|
+
*/
|
|
39611
40127
|
get: {
|
|
39612
40128
|
parameters: {
|
|
39613
40129
|
query?: {
|
|
@@ -39631,8 +40147,8 @@ export interface paths {
|
|
|
39631
40147
|
[name: string]: unknown;
|
|
39632
40148
|
};
|
|
39633
40149
|
content: {
|
|
39634
|
-
"application/json": components["schemas"]["
|
|
39635
|
-
"text/json": components["schemas"]["
|
|
40150
|
+
"application/json": components["schemas"]["Roblox.Api.Avatar.Models.OutfitDetailsModelV2"];
|
|
40151
|
+
"text/json": components["schemas"]["Roblox.Api.Avatar.Models.OutfitDetailsModelV2"];
|
|
39636
40152
|
};
|
|
39637
40153
|
};
|
|
39638
40154
|
/** @description 2: The outfit for the specified userOutfit is invalid. */
|
|
@@ -40229,6 +40745,395 @@ export interface components {
|
|
|
40229
40745
|
/** @description A join request ID. */
|
|
40230
40746
|
AcceptGroupJoinRequestRequest: Record<string, never>;
|
|
40231
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
|
+
};
|
|
40232
41137
|
/** @description A breakdown dimension value in a query result. */
|
|
40233
41138
|
"AnalyticsQueryPublicApi.BreakdownValue": {
|
|
40234
41139
|
/** @description The dimension name. */
|
|
@@ -40686,132 +41591,6 @@ export interface components {
|
|
|
40686
41591
|
/** @description Indicates which music charts to filter from. */
|
|
40687
41592
|
musicChartType?: components["schemas"]["MusicChartType"];
|
|
40688
41593
|
} | null;
|
|
40689
|
-
/** @description Exhaustive model denoting all possible metadata fields of an asset */
|
|
40690
|
-
"AvatarPublicApi.Roblox.Api.Avatar.Models.AssetMetaModelV1": {
|
|
40691
|
-
/**
|
|
40692
|
-
* Format: int32
|
|
40693
|
-
* @description Layered-clothing order
|
|
40694
|
-
*/
|
|
40695
|
-
order?: number;
|
|
40696
|
-
/**
|
|
40697
|
-
* Format: float
|
|
40698
|
-
* @description Layered-clothing puffiness
|
|
40699
|
-
*/
|
|
40700
|
-
puffiness?: number;
|
|
40701
|
-
position?: components["schemas"]["Roblox.Api.Avatar.Models.AssetPosition"];
|
|
40702
|
-
rotation?: components["schemas"]["Roblox.Api.Avatar.Models.AssetRotation"];
|
|
40703
|
-
scale?: components["schemas"]["Roblox.Api.Avatar.Models.AssetScale"];
|
|
40704
|
-
/**
|
|
40705
|
-
* Format: int32
|
|
40706
|
-
* @description Head Shape selected for the asset id.
|
|
40707
|
-
* Applicable for dynamic head assets.
|
|
40708
|
-
* @enum {integer}
|
|
40709
|
-
*/
|
|
40710
|
-
headShape?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29;
|
|
40711
|
-
/**
|
|
40712
|
-
* @description Indicates user choice for facial animation.
|
|
40713
|
-
* staticFacialAnimation=false, implies the toggle as on and face will animate.
|
|
40714
|
-
* Applicable for dynamic head assets.
|
|
40715
|
-
*/
|
|
40716
|
-
staticFacialAnimation?: boolean;
|
|
40717
|
-
/**
|
|
40718
|
-
* Format: int32
|
|
40719
|
-
* @description Client-authoritative meta model format version
|
|
40720
|
-
* - default is always 1
|
|
40721
|
-
*/
|
|
40722
|
-
version?: number;
|
|
40723
|
-
};
|
|
40724
|
-
/**
|
|
40725
|
-
* @description A model containing details about an asset
|
|
40726
|
-
* - V2: adds CurrentVersionId, AssetMetaModel
|
|
40727
|
-
*/
|
|
40728
|
-
"AvatarPublicApi.Roblox.Api.Avatar.Models.AssetModelV2": {
|
|
40729
|
-
/**
|
|
40730
|
-
* Format: int64
|
|
40731
|
-
* @description The id
|
|
40732
|
-
*/
|
|
40733
|
-
id?: number;
|
|
40734
|
-
/** @description The name */
|
|
40735
|
-
name?: string;
|
|
40736
|
-
assetType?: components["schemas"]["Roblox.Api.Avatar.Models.AssetTypeModel"];
|
|
40737
|
-
/**
|
|
40738
|
-
* Format: int64
|
|
40739
|
-
* @description Id of the current version of asset
|
|
40740
|
-
*/
|
|
40741
|
-
currentVersionId?: number;
|
|
40742
|
-
meta?: components["schemas"]["AvatarPublicApi.Roblox.Api.Avatar.Models.AssetMetaModelV1"];
|
|
40743
|
-
/** @description Asset availability status. */
|
|
40744
|
-
availabilityStatus?: string;
|
|
40745
|
-
/**
|
|
40746
|
-
* Format: date-time
|
|
40747
|
-
* @description For rental assets only. (Future) ownership expiration time of the asset.
|
|
40748
|
-
*/
|
|
40749
|
-
expirationTime?: string;
|
|
40750
|
-
/** @description If the "Id" is swappable, applicable for DH assets. */
|
|
40751
|
-
supportsHeadShapes?: boolean;
|
|
40752
|
-
};
|
|
40753
|
-
/**
|
|
40754
|
-
* @description A model which contains
|
|
40755
|
-
* - an asset id
|
|
40756
|
-
* - AssetMetaModel
|
|
40757
|
-
*/
|
|
40758
|
-
"AvatarPublicApi.Roblox.Api.Avatar.Models.AssetWearModel": {
|
|
40759
|
-
/**
|
|
40760
|
-
* Format: int64
|
|
40761
|
-
* @description An asset id
|
|
40762
|
-
*/
|
|
40763
|
-
id?: number;
|
|
40764
|
-
meta?: components["schemas"]["AvatarPublicApi.Roblox.Api.Avatar.Models.AssetMetaModelV1"];
|
|
40765
|
-
};
|
|
40766
|
-
/** @description A model containing details about a user outfit */
|
|
40767
|
-
"AvatarPublicApi.Roblox.Api.Avatar.Models.OutfitDetailsModelV2": {
|
|
40768
|
-
/**
|
|
40769
|
-
* Format: int64
|
|
40770
|
-
* @description The id
|
|
40771
|
-
*/
|
|
40772
|
-
id?: number;
|
|
40773
|
-
/** @description The name */
|
|
40774
|
-
name?: string;
|
|
40775
|
-
/** @description A list of assetIds */
|
|
40776
|
-
assets?: components["schemas"]["AvatarPublicApi.Roblox.Api.Avatar.Models.AssetModelV2"][];
|
|
40777
|
-
bodyColor3s?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColors3Model"];
|
|
40778
|
-
scale?: components["schemas"]["Roblox.Web.Responses.Avatar.ScaleModel"];
|
|
40779
|
-
/** @description The player avatar type - this can be R6 or R15. */
|
|
40780
|
-
playerAvatarType?: string;
|
|
40781
|
-
/** @description The outfit type of the outfit */
|
|
40782
|
-
outfitType?: string;
|
|
40783
|
-
/** @description Whether the outfit can be edited by the user */
|
|
40784
|
-
isEditable?: boolean;
|
|
40785
|
-
/**
|
|
40786
|
-
* Format: int64
|
|
40787
|
-
* @description The universe id of the outfit, null when outfit is not created in-experience
|
|
40788
|
-
*/
|
|
40789
|
-
universeId?: number;
|
|
40790
|
-
/** @description The moderation status of the outfit, not applicable when outfit is created outside experience */
|
|
40791
|
-
moderationStatus?: string;
|
|
40792
|
-
/**
|
|
40793
|
-
* Format: int64
|
|
40794
|
-
* @description The bundle ID, currently only returned for in-experience created outfits.
|
|
40795
|
-
*/
|
|
40796
|
-
bundleId?: number;
|
|
40797
|
-
/** @description The inventory type of the outfit. */
|
|
40798
|
-
inventoryType?: string;
|
|
40799
|
-
};
|
|
40800
|
-
/** @description A model containing avatar background data. */
|
|
40801
|
-
"AvatarPublicApi.Roblox.Api.Avatar.Models.V4.AvatarBackgroundModel": {
|
|
40802
|
-
backgroundAsset?: components["schemas"]["AvatarPublicApi.Roblox.Api.Avatar.Models.AssetModelV2"];
|
|
40803
|
-
};
|
|
40804
|
-
/**
|
|
40805
|
-
* @description A model which contains the asset id of the background. This can be
|
|
40806
|
-
* extended to have more attributes in the future.
|
|
40807
|
-
*/
|
|
40808
|
-
"AvatarPublicApi.Roblox.Api.Avatar.Models.V4.AvatarBackgroundRequestModel": {
|
|
40809
|
-
/**
|
|
40810
|
-
* Format: int64
|
|
40811
|
-
* @description An asset id.
|
|
40812
|
-
*/
|
|
40813
|
-
id?: number;
|
|
40814
|
-
};
|
|
40815
41594
|
/** @description Request object to grant one permission to multiple assets. */
|
|
40816
41595
|
BatchGrantPermissionsRequest: {
|
|
40817
41596
|
subjectType?: components["schemas"]["SubjectType"];
|
|
@@ -46223,6 +47002,19 @@ export interface components {
|
|
|
46223
47002
|
/** @description The name */
|
|
46224
47003
|
name?: string;
|
|
46225
47004
|
};
|
|
47005
|
+
/**
|
|
47006
|
+
* @description A model which contains
|
|
47007
|
+
* - an asset id
|
|
47008
|
+
* - AssetMetaModel
|
|
47009
|
+
*/
|
|
47010
|
+
"Roblox.Api.Avatar.Models.AssetWearModel": {
|
|
47011
|
+
/**
|
|
47012
|
+
* Format: int64
|
|
47013
|
+
* @description An asset id
|
|
47014
|
+
*/
|
|
47015
|
+
id?: number;
|
|
47016
|
+
meta?: components["schemas"]["Roblox.Api.Avatar.Models.AssetMetaModelV1"];
|
|
47017
|
+
};
|
|
46226
47018
|
/** @description Success response class */
|
|
46227
47019
|
"Roblox.Api.Avatar.Models.AvatarApiSuccessResponse": {
|
|
46228
47020
|
/** @description Gets or sets a value indicating whether the request was a success. */
|
|
@@ -46325,7 +47117,7 @@ export interface components {
|
|
|
46325
47117
|
playerAvatarType?: 1 | 3;
|
|
46326
47118
|
bodyColor3s?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColors3Model"];
|
|
46327
47119
|
/** @description The assets worn on the character */
|
|
46328
|
-
assets?: components["schemas"]["
|
|
47120
|
+
assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"][];
|
|
46329
47121
|
/** @description Whether default clothing has been applied to this avatar. */
|
|
46330
47122
|
defaultShirtApplied?: boolean;
|
|
46331
47123
|
/** @description Whether default clothing has been applied to this avatar. */
|
|
@@ -46603,6 +47395,40 @@ export interface components {
|
|
|
46603
47395
|
/** @description The moderation status of the outfit, not applicable when outfit is created outside experience */
|
|
46604
47396
|
moderationStatus?: string;
|
|
46605
47397
|
};
|
|
47398
|
+
/** @description A model containing details about a user outfit */
|
|
47399
|
+
"Roblox.Api.Avatar.Models.OutfitDetailsModelV2": {
|
|
47400
|
+
/**
|
|
47401
|
+
* Format: int64
|
|
47402
|
+
* @description The id
|
|
47403
|
+
*/
|
|
47404
|
+
id?: number;
|
|
47405
|
+
/** @description The name */
|
|
47406
|
+
name?: string;
|
|
47407
|
+
/** @description A list of assetIds */
|
|
47408
|
+
assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"][];
|
|
47409
|
+
bodyColor3s?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColors3Model"];
|
|
47410
|
+
scale?: components["schemas"]["Roblox.Web.Responses.Avatar.ScaleModel"];
|
|
47411
|
+
/** @description The player avatar type - this can be R6 or R15. */
|
|
47412
|
+
playerAvatarType?: string;
|
|
47413
|
+
/** @description The outfit type of the outfit */
|
|
47414
|
+
outfitType?: string;
|
|
47415
|
+
/** @description Whether the outfit can be edited by the user */
|
|
47416
|
+
isEditable?: boolean;
|
|
47417
|
+
/**
|
|
47418
|
+
* Format: int64
|
|
47419
|
+
* @description The universe id of the outfit, null when outfit is not created in-experience
|
|
47420
|
+
*/
|
|
47421
|
+
universeId?: number;
|
|
47422
|
+
/** @description The moderation status of the outfit, not applicable when outfit is created outside experience */
|
|
47423
|
+
moderationStatus?: string;
|
|
47424
|
+
/**
|
|
47425
|
+
* Format: int64
|
|
47426
|
+
* @description The bundle ID, currently only returned for in-experience created outfits.
|
|
47427
|
+
*/
|
|
47428
|
+
bundleId?: number;
|
|
47429
|
+
/** @description The inventory type of the outfit. */
|
|
47430
|
+
inventoryType?: string;
|
|
47431
|
+
};
|
|
46606
47432
|
/** @description A slim model for user outfits. */
|
|
46607
47433
|
"Roblox.Api.Avatar.Models.OutfitModel": {
|
|
46608
47434
|
/**
|
|
@@ -46623,7 +47449,7 @@ export interface components {
|
|
|
46623
47449
|
name?: string;
|
|
46624
47450
|
bodyColors?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColorsModel"];
|
|
46625
47451
|
/** @description Array of assets */
|
|
46626
|
-
assets?: components["schemas"]["
|
|
47452
|
+
assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetWearModel"][];
|
|
46627
47453
|
scale?: components["schemas"]["Roblox.Web.Responses.Avatar.ScaleModel"];
|
|
46628
47454
|
/** @description The avatar scale */
|
|
46629
47455
|
playerAvatarType?: string;
|
|
@@ -46632,7 +47458,7 @@ export interface components {
|
|
|
46632
47458
|
* @description The type of outfit
|
|
46633
47459
|
* @enum {integer}
|
|
46634
47460
|
*/
|
|
46635
|
-
outfitType?: 0 | 1 | 2 | 4 | 5;
|
|
47461
|
+
outfitType?: 0 | 1 | 2 | 4 | 5 | 6;
|
|
46636
47462
|
};
|
|
46637
47463
|
/** @description A model containing details needed to update or create an outfit. */
|
|
46638
47464
|
"Roblox.Api.Avatar.Models.OutfitUpdateModelV3": {
|
|
@@ -46640,7 +47466,7 @@ export interface components {
|
|
|
46640
47466
|
name?: string;
|
|
46641
47467
|
bodyColor3s?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColors3Model"];
|
|
46642
47468
|
/** @description Array of assets. */
|
|
46643
|
-
assets?: components["schemas"]["
|
|
47469
|
+
assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetWearModel"][];
|
|
46644
47470
|
scale?: components["schemas"]["Roblox.Web.Responses.Avatar.ScaleModel"];
|
|
46645
47471
|
/** @description The avatar scale. */
|
|
46646
47472
|
playerAvatarType?: string;
|
|
@@ -46649,7 +47475,7 @@ export interface components {
|
|
|
46649
47475
|
* @description The type of outfit.
|
|
46650
47476
|
* @enum {integer}
|
|
46651
47477
|
*/
|
|
46652
|
-
outfitType?: 0 | 1 | 2 | 4 | 5;
|
|
47478
|
+
outfitType?: 0 | 1 | 2 | 4 | 5 | 6;
|
|
46653
47479
|
};
|
|
46654
47480
|
/** @description A model that contains a playerAvatarType */
|
|
46655
47481
|
"Roblox.Api.Avatar.Models.PlayerAvatarTypeModel": {
|
|
@@ -46696,7 +47522,7 @@ export interface components {
|
|
|
46696
47522
|
playerAvatarType?: 1 | 3;
|
|
46697
47523
|
bodyColors?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColors3Model"];
|
|
46698
47524
|
/** @description The assets worn on the character. */
|
|
46699
|
-
assets?: components["schemas"]["
|
|
47525
|
+
assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetWearModel"][];
|
|
46700
47526
|
};
|
|
46701
47527
|
/** @description A model containing details about an avatar update request. */
|
|
46702
47528
|
"Roblox.Api.Avatar.Models.UpdateAvatarRequestModel": {
|
|
@@ -46717,15 +47543,30 @@ export interface components {
|
|
|
46717
47543
|
* @description The assets that could not be worn
|
|
46718
47544
|
* Unlike invalidAssetIds, only contains assets that are wearable types.
|
|
46719
47545
|
*/
|
|
46720
|
-
invalidAssets?: components["schemas"]["
|
|
47546
|
+
invalidAssets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"][];
|
|
46721
47547
|
/** @description Whether or not all the outfit contents were successfully worn. */
|
|
46722
47548
|
success?: boolean;
|
|
46723
47549
|
};
|
|
47550
|
+
/** @description A model containing avatar background data. */
|
|
47551
|
+
"Roblox.Api.Avatar.Models.V4.AvatarBackgroundModel": {
|
|
47552
|
+
backgroundAsset?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"];
|
|
47553
|
+
};
|
|
47554
|
+
/**
|
|
47555
|
+
* @description A model which contains the asset id of the background. This can be
|
|
47556
|
+
* extended to have more attributes in the future.
|
|
47557
|
+
*/
|
|
47558
|
+
"Roblox.Api.Avatar.Models.V4.AvatarBackgroundRequestModel": {
|
|
47559
|
+
/**
|
|
47560
|
+
* Format: int64
|
|
47561
|
+
* @description An asset id.
|
|
47562
|
+
*/
|
|
47563
|
+
id?: number;
|
|
47564
|
+
};
|
|
46724
47565
|
/** @description Avatar config details. */
|
|
46725
47566
|
"Roblox.Api.Avatar.Models.V4.AvatarConfigurations": {
|
|
46726
47567
|
/** @description The emotes on the character. */
|
|
46727
47568
|
emotes?: components["schemas"]["Roblox.Api.Avatar.Models.EmoteResponseModel"][];
|
|
46728
|
-
background?: components["schemas"]["
|
|
47569
|
+
background?: components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarBackgroundModel"];
|
|
46729
47570
|
/** @description List of customizations set for this avatar. At most one per thumbnail type (Closeup, FullBody). */
|
|
46730
47571
|
thumbnailCustomizations?: components["schemas"]["Roblox.Api.Avatar.Models.AvatarThumbnailCustomizationModel"][];
|
|
46731
47572
|
profileFrame?: components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarProfileFrameModel"];
|
|
@@ -46746,11 +47587,11 @@ export interface components {
|
|
|
46746
47587
|
playerAvatarType?: 1 | 3;
|
|
46747
47588
|
bodyColors?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColorsModelV4"];
|
|
46748
47589
|
/** @description The assets worn on the character. */
|
|
46749
|
-
assets?: components["schemas"]["
|
|
47590
|
+
assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"][];
|
|
46750
47591
|
};
|
|
46751
47592
|
/** @description A model containing avatar profile frame data. */
|
|
46752
47593
|
"Roblox.Api.Avatar.Models.V4.AvatarProfileFrameModel": {
|
|
46753
|
-
frameAsset?: components["schemas"]["
|
|
47594
|
+
frameAsset?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"];
|
|
46754
47595
|
};
|
|
46755
47596
|
/** @description A model which contains the asset id of the profile frame. */
|
|
46756
47597
|
"Roblox.Api.Avatar.Models.V4.AvatarProfileFrameRequestModel": {
|
|
@@ -46762,7 +47603,7 @@ export interface components {
|
|
|
46762
47603
|
};
|
|
46763
47604
|
/** @description Background configuration for an outfit. */
|
|
46764
47605
|
"Roblox.Api.Avatar.Models.V4.OutfitConfigurations": {
|
|
46765
|
-
background?: components["schemas"]["
|
|
47606
|
+
background?: components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarBackgroundModel"];
|
|
46766
47607
|
};
|
|
46767
47608
|
/** @description Details about an outfit. */
|
|
46768
47609
|
"Roblox.Api.Avatar.Models.V4.OutfitDefinition": {
|
|
@@ -46796,9 +47637,9 @@ export interface components {
|
|
|
46796
47637
|
* @description The type of the outfit.
|
|
46797
47638
|
* @enum {integer}
|
|
46798
47639
|
*/
|
|
46799
|
-
outfitType?: 0 | 1 | 2 | 4 | 5;
|
|
47640
|
+
outfitType?: 0 | 1 | 2 | 4 | 5 | 6;
|
|
46800
47641
|
/** @description The assets on the outfit. */
|
|
46801
|
-
assets?: components["schemas"]["
|
|
47642
|
+
assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"][];
|
|
46802
47643
|
bodyColors?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColorsModelV4"];
|
|
46803
47644
|
scale?: components["schemas"]["Roblox.Web.Responses.Avatar.ScaleModel"];
|
|
46804
47645
|
/**
|
|
@@ -46827,7 +47668,7 @@ export interface components {
|
|
|
46827
47668
|
/** @description Validation details for avatar mutation responses when one or more inputs could not be applied. */
|
|
46828
47669
|
"Roblox.Api.Avatar.Models.V4.Response.AvatarValidationResultV4": {
|
|
46829
47670
|
/** @description Assets that could not be worn. */
|
|
46830
|
-
invalidAssets?: components["schemas"]["
|
|
47671
|
+
invalidAssets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"][];
|
|
46831
47672
|
/** @description Background assets that could not be applied. */
|
|
46832
47673
|
invalidBackground?: components["schemas"]["Roblox.Api.Avatar.Models.InvalidBackgroundResponse"][];
|
|
46833
47674
|
/** @description Profile frame assets that could not be applied. */
|
|
@@ -46851,7 +47692,7 @@ export interface components {
|
|
|
46851
47692
|
/** @description Validation details for outfit mutation responses when one or more inputs could not be applied. */
|
|
46852
47693
|
"Roblox.Api.Avatar.Models.V4.Response.OutfitValidationResultV4": {
|
|
46853
47694
|
/** @description Assets that could not be worn. */
|
|
46854
|
-
unwornAssets?: components["schemas"]["
|
|
47695
|
+
unwornAssets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"][];
|
|
46855
47696
|
/** @description Background assets that could not be applied. */
|
|
46856
47697
|
invalidBackground?: components["schemas"]["Roblox.Api.Avatar.Models.InvalidBackgroundResponse"][];
|
|
46857
47698
|
};
|
|
@@ -46865,7 +47706,7 @@ export interface components {
|
|
|
46865
47706
|
* Prefer Roblox.Api.Avatar.Models.V4.Response.UpdateAvatarDefinitionResponseV4.Validation.Roblox.Api.Avatar.Models.V4.Response.AvatarValidationResultV4.InvalidAssets.
|
|
46866
47707
|
* Will be reverted once the engine fix is fully deployed.
|
|
46867
47708
|
*/
|
|
46868
|
-
invalidAssets?: components["schemas"]["
|
|
47709
|
+
invalidAssets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"][];
|
|
46869
47710
|
validation?: components["schemas"]["Roblox.Api.Avatar.Models.V4.Response.AvatarValidationResultV4"];
|
|
46870
47711
|
};
|
|
46871
47712
|
/** @description Response model for update outfit (V4). */
|
|
@@ -46880,7 +47721,7 @@ export interface components {
|
|
|
46880
47721
|
emoteRequestModels?: components["schemas"]["Roblox.Api.Avatar.Models.EmoteRequestModel"][];
|
|
46881
47722
|
/** @description The avatar's thumbnail customizations. */
|
|
46882
47723
|
thumbnailCustomizationModels?: components["schemas"]["Roblox.Api.Avatar.Models.AvatarThumbnailCustomizationModel"][];
|
|
46883
|
-
backgroundRequestModel?: components["schemas"]["
|
|
47724
|
+
backgroundRequestModel?: components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarBackgroundRequestModel"];
|
|
46884
47725
|
profileFrameRequestModel?: components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarProfileFrameRequestModel"];
|
|
46885
47726
|
};
|
|
46886
47727
|
/** @description A model containing details about an avatar update. */
|
|
@@ -46899,11 +47740,11 @@ export interface components {
|
|
|
46899
47740
|
playerAvatarType?: 1 | 3;
|
|
46900
47741
|
bodyColors?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColorsModelV4"];
|
|
46901
47742
|
/** @description The assets worn on the character. */
|
|
46902
|
-
assets?: components["schemas"]["
|
|
47743
|
+
assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetWearModel"][];
|
|
46903
47744
|
};
|
|
46904
47745
|
/** @description A model containing outfit config fields to update. */
|
|
46905
47746
|
"Roblox.Api.Avatar.Models.V4.UpdateOutfitConfig": {
|
|
46906
|
-
backgroundRequestModel?: components["schemas"]["
|
|
47747
|
+
backgroundRequestModel?: components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarBackgroundRequestModel"];
|
|
46907
47748
|
};
|
|
46908
47749
|
/** @description A model containing outfit fields to create or update. */
|
|
46909
47750
|
"Roblox.Api.Avatar.Models.V4.UpdateOutfitDefinition": {
|
|
@@ -46916,7 +47757,7 @@ export interface components {
|
|
|
46916
47757
|
name?: string;
|
|
46917
47758
|
bodyColors?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColorsModelV4"];
|
|
46918
47759
|
/** @description The assets on the outfit. */
|
|
46919
|
-
assets?: components["schemas"]["
|
|
47760
|
+
assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetWearModel"][];
|
|
46920
47761
|
scale?: components["schemas"]["Roblox.Web.Responses.Avatar.ScaleModel"];
|
|
46921
47762
|
/**
|
|
46922
47763
|
* Format: int32
|
|
@@ -46929,12 +47770,12 @@ export interface components {
|
|
|
46929
47770
|
* @description The type of outfit (for example Avatar or Makeup). Defaults to Avatar when omitted.
|
|
46930
47771
|
* @enum {integer}
|
|
46931
47772
|
*/
|
|
46932
|
-
outfitType?: 0 | 1 | 2 | 4 | 5;
|
|
47773
|
+
outfitType?: 0 | 1 | 2 | 4 | 5 | 6;
|
|
46933
47774
|
};
|
|
46934
47775
|
/** @description A model that contains a list of AssetWear models */
|
|
46935
47776
|
"Roblox.Api.Avatar.Models.WearRequestModel": {
|
|
46936
47777
|
/** @description The asset ids */
|
|
46937
|
-
assets?: components["schemas"]["
|
|
47778
|
+
assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetWearModel"][];
|
|
46938
47779
|
};
|
|
46939
47780
|
/** @description A model for wear outfit responses */
|
|
46940
47781
|
"Roblox.Api.Avatar.Models.WearResponseModel": {
|
|
@@ -46942,7 +47783,7 @@ export interface components {
|
|
|
46942
47783
|
* @description The assets that could not be worn
|
|
46943
47784
|
* Unlike invalidAssetIds, only contains assets that are wearable types
|
|
46944
47785
|
*/
|
|
46945
|
-
invalidAssets?: components["schemas"]["
|
|
47786
|
+
invalidAssets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"][];
|
|
46946
47787
|
/** @description The asset ids that could not be worn */
|
|
46947
47788
|
invalidAssetIds?: number[];
|
|
46948
47789
|
/** @description Whether or not all the outfit contents were successfully worn */
|