@jacobhumston/roblox-openapi-ts 1.0.40 → 1.0.42

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/types.d.ts +200 -474
  2. package/package.json +1 -1
package/dist/types.d.ts CHANGED
@@ -810,9 +810,9 @@ export interface paths {
810
810
  /** @description The dimension values request. */
811
811
  requestBody: {
812
812
  content: {
813
- "application/json": components["schemas"]["DimensionValuesRequest"];
814
- "text/json": components["schemas"]["DimensionValuesRequest"];
815
- "application/*+json": components["schemas"]["DimensionValuesRequest"];
813
+ "application/json": components["schemas"]["AnalyticsQueryPublicApi.DimensionValuesRequest"];
814
+ "text/json": components["schemas"]["AnalyticsQueryPublicApi.DimensionValuesRequest"];
815
+ "application/*+json": components["schemas"]["AnalyticsQueryPublicApi.DimensionValuesRequest"];
816
816
  };
817
817
  };
818
818
  responses: {
@@ -922,9 +922,9 @@ export interface paths {
922
922
  /** @description The query request. */
923
923
  requestBody: {
924
924
  content: {
925
- "application/json": components["schemas"]["QueryRequest"];
926
- "text/json": components["schemas"]["QueryRequest"];
927
- "application/*+json": components["schemas"]["QueryRequest"];
925
+ "application/json": components["schemas"]["AnalyticsQueryPublicApi.QueryRequest"];
926
+ "text/json": components["schemas"]["AnalyticsQueryPublicApi.QueryRequest"];
927
+ "application/*+json": components["schemas"]["AnalyticsQueryPublicApi.QueryRequest"];
928
928
  };
929
929
  };
930
930
  responses: {
@@ -1409,7 +1409,7 @@ export interface paths {
1409
1409
  };
1410
1410
  };
1411
1411
  responses: {
1412
- /** @description OK */
1412
+ /** @description Success */
1413
1413
  200: {
1414
1414
  headers: {
1415
1415
  [name: string]: unknown;
@@ -1436,7 +1436,7 @@ export interface paths {
1436
1436
  "application/json": components["schemas"]["AssetPermissions.ErrorResponse"];
1437
1437
  };
1438
1438
  };
1439
- /** @description Internal Server Error */
1439
+ /** @description Server Error */
1440
1440
  500: {
1441
1441
  headers: {
1442
1442
  [name: string]: unknown;
@@ -4148,7 +4148,10 @@ export interface paths {
4148
4148
  delete?: never;
4149
4149
  options?: never;
4150
4150
  head?: never;
4151
- /** Updates badge configuration. */
4151
+ /**
4152
+ * Updates badge configuration.
4153
+ * @description Managers may change enabled state, name, and description when authorized for the badge.
4154
+ */
4152
4155
  patch: {
4153
4156
  parameters: {
4154
4157
  query?: never;
@@ -4228,7 +4231,10 @@ export interface paths {
4228
4231
  };
4229
4232
  get?: never;
4230
4233
  put?: never;
4231
- /** Creates a new badge. */
4234
+ /**
4235
+ * Creates a new badge.
4236
+ * @description Charges the selected payment source and creates the badge under the universe's root place.
4237
+ */
4232
4238
  post: {
4233
4239
  parameters: {
4234
4240
  query?: never;
@@ -4248,7 +4254,7 @@ export interface paths {
4248
4254
  description?: string;
4249
4255
  /**
4250
4256
  * Format: int32
4251
- * @description Whether or not to pay for the badge with user funds, or group funds. ['User' = 1, 'Group' = 2]
4257
+ * @description Whether or not to pay for the badge with user funds, or group funds.
4252
4258
  * @enum {integer}
4253
4259
  */
4254
4260
  paymentSourceType?: 1 | 2;
@@ -13643,7 +13649,10 @@ export interface paths {
13643
13649
  path?: never;
13644
13650
  cookie?: never;
13645
13651
  };
13646
- /** Gets metadata about the badges system. */
13652
+ /**
13653
+ * Gets metadata about the badges system.
13654
+ * @description Returns creation price and field length limits. Callers use this before creating or editing badges.
13655
+ */
13647
13656
  get: {
13648
13657
  parameters: {
13649
13658
  query?: never;
@@ -13680,7 +13689,10 @@ export interface paths {
13680
13689
  path?: never;
13681
13690
  cookie?: never;
13682
13691
  };
13683
- /** Gets badge information by the badge Id. */
13692
+ /**
13693
+ * Gets badge information by the badge Id.
13694
+ * @description Returns display fields, award statistics, and owning universe for a single badge.
13695
+ */
13684
13696
  get: {
13685
13697
  parameters: {
13686
13698
  query?: never;
@@ -13720,7 +13732,10 @@ export interface paths {
13720
13732
  delete?: never;
13721
13733
  options?: never;
13722
13734
  head?: never;
13723
- /** Updates badge configuration. */
13735
+ /**
13736
+ * Updates badge configuration.
13737
+ * @description Managers may change enabled state, name, and description when authorized for the badge.
13738
+ */
13724
13739
  patch: {
13725
13740
  parameters: {
13726
13741
  query?: never;
@@ -13885,94 +13900,6 @@ export interface paths {
13885
13900
  };
13886
13901
  trace?: never;
13887
13902
  };
13888
- "/v1/badges/{badgeId}/icon": {
13889
- parameters: {
13890
- query?: never;
13891
- header?: never;
13892
- path?: never;
13893
- cookie?: never;
13894
- };
13895
- get?: never;
13896
- put?: never;
13897
- /** Overwrites a badge icon with a new one. */
13898
- post: {
13899
- parameters: {
13900
- query?: never;
13901
- header?: never;
13902
- path: {
13903
- /** @description The badge Id. */
13904
- badgeId: number;
13905
- };
13906
- cookie?: never;
13907
- };
13908
- requestBody?: {
13909
- content: {
13910
- "multipart/form-data": {
13911
- /** Format: binary */
13912
- Files?: string;
13913
- };
13914
- };
13915
- };
13916
- responses: {
13917
- /** @description OK */
13918
- 200: {
13919
- headers: {
13920
- [name: string]: unknown;
13921
- };
13922
- content: {
13923
- "application/json": components["schemas"]["Roblox.Badges.Api.IconUploadResponse"];
13924
- "text/json": components["schemas"]["Roblox.Badges.Api.IconUploadResponse"];
13925
- };
13926
- };
13927
- /**
13928
- * @description 6: Text moderated.
13929
- * 22: Icon file is not present in the request.
13930
- */
13931
- 400: {
13932
- headers: {
13933
- [name: string]: unknown;
13934
- };
13935
- content?: never;
13936
- };
13937
- /** @description 0: Authorization has been denied for this request. */
13938
- 401: {
13939
- headers: {
13940
- [name: string]: unknown;
13941
- };
13942
- content?: never;
13943
- };
13944
- /**
13945
- * @description 0: Token Validation Failed
13946
- * 2: You do not have permission to manage this badge.
13947
- */
13948
- 403: {
13949
- headers: {
13950
- [name: string]: unknown;
13951
- };
13952
- content?: never;
13953
- };
13954
- /** @description 1: Badge is invalid or does not exist. */
13955
- 404: {
13956
- headers: {
13957
- [name: string]: unknown;
13958
- };
13959
- content?: never;
13960
- };
13961
- /** @description 13: Too many requests, try again later. */
13962
- 429: {
13963
- headers: {
13964
- [name: string]: unknown;
13965
- };
13966
- content?: never;
13967
- };
13968
- };
13969
- };
13970
- delete?: never;
13971
- options?: never;
13972
- head?: never;
13973
- patch?: never;
13974
- trace?: never;
13975
- };
13976
13903
  "/v1/badges/{badgeId}/icon#publish.roblox.com": {
13977
13904
  parameters: {
13978
13905
  query?: never;
@@ -27275,6 +27202,8 @@ export interface paths {
27275
27202
  /** @description Optional session identifier. */
27276
27203
  sessionId?: string;
27277
27204
  friendRequestSort?: 0 | 1 | 2;
27205
+ /** @description Whether to uprank unseen friend requests and return isUnseen per friend request. */
27206
+ uprankUnseen?: boolean;
27278
27207
  };
27279
27208
  header?: never;
27280
27209
  path?: never;
@@ -31615,7 +31544,10 @@ export interface paths {
31615
31544
  path?: never;
31616
31545
  cookie?: never;
31617
31546
  };
31618
- /** Gets badges by their awarding game. */
31547
+ /**
31548
+ * Gets badges by their awarding game.
31549
+ * @description Lists badges created under the universe's root place, with paging and optional sort.
31550
+ */
31619
31551
  get: {
31620
31552
  parameters: {
31621
31553
  query?: {
@@ -31664,7 +31596,10 @@ export interface paths {
31664
31596
  };
31665
31597
  };
31666
31598
  put?: never;
31667
- /** Creates a new badge. */
31599
+ /**
31600
+ * Creates a new badge.
31601
+ * @description Charges the selected payment source and creates the badge under the universe's root place.
31602
+ */
31668
31603
  post: {
31669
31604
  parameters: {
31670
31605
  query?: never;
@@ -31684,7 +31619,7 @@ export interface paths {
31684
31619
  description?: string;
31685
31620
  /**
31686
31621
  * Format: int32
31687
- * @description Whether or not to pay for the badge with user funds, or group funds. ['User' = 1, 'Group' = 2]
31622
+ * @description Whether or not to pay for the badge with user funds, or group funds.
31688
31623
  * @enum {integer}
31689
31624
  */
31690
31625
  paymentSourceType?: 1 | 2;
@@ -32228,7 +32163,10 @@ export interface paths {
32228
32163
  path?: never;
32229
32164
  cookie?: never;
32230
32165
  };
32231
- /** Gets the number of free badges left for the current UTC day by their awarding game. */
32166
+ /**
32167
+ * Gets the number of free badges left for the current UTC day by their awarding game.
32168
+ * @description Reflects daily free-creation allowance for the universe when the feature is enabled.
32169
+ */
32232
32170
  get: {
32233
32171
  parameters: {
32234
32172
  query?: never;
@@ -32815,7 +32753,10 @@ export interface paths {
32815
32753
  get?: never;
32816
32754
  put?: never;
32817
32755
  post?: never;
32818
- /** Removes a badge from the authenticated user. */
32756
+ /**
32757
+ * Removes a badge from the authenticated user.
32758
+ * @description Revokes the caller's own awarded badge instance when the badge exists on their account.
32759
+ */
32819
32760
  delete: {
32820
32761
  parameters: {
32821
32762
  query?: never;
@@ -34855,163 +34796,6 @@ export interface paths {
34855
34796
  patch?: never;
34856
34797
  trace?: never;
34857
34798
  };
34858
- "/v1/users/{userId}/badges": {
34859
- parameters: {
34860
- query?: never;
34861
- header?: never;
34862
- path?: never;
34863
- cookie?: never;
34864
- };
34865
- /** Gets a list of badges a user has been awarded. */
34866
- get: {
34867
- parameters: {
34868
- query?: {
34869
- /** @description The number of results per request. */
34870
- limit?: 10 | 25 | 50 | 100;
34871
- /** @description The paging cursor for the previous or next page. */
34872
- cursor?: string;
34873
- /** @description The order the results are sorted in. */
34874
- sortOrder?: "Asc" | "Desc";
34875
- };
34876
- header?: never;
34877
- path: {
34878
- /** @description The user Id. */
34879
- userId: number;
34880
- };
34881
- cookie?: never;
34882
- };
34883
- requestBody?: never;
34884
- responses: {
34885
- /** @description OK */
34886
- 200: {
34887
- headers: {
34888
- [name: string]: unknown;
34889
- };
34890
- content: {
34891
- "application/json": components["schemas"]["Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Badges.Api.GetBadgesByUserResponse_"];
34892
- "text/json": components["schemas"]["Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Badges.Api.GetBadgesByUserResponse_"];
34893
- };
34894
- };
34895
- /** @description 4: User is invalid or does not exist. */
34896
- 404: {
34897
- headers: {
34898
- [name: string]: unknown;
34899
- };
34900
- content?: never;
34901
- };
34902
- };
34903
- };
34904
- put?: never;
34905
- post?: never;
34906
- delete?: never;
34907
- options?: never;
34908
- head?: never;
34909
- patch?: never;
34910
- trace?: never;
34911
- };
34912
- "/v1/users/{userId}/badges/awarded-dates": {
34913
- parameters: {
34914
- query?: never;
34915
- header?: never;
34916
- path?: never;
34917
- cookie?: never;
34918
- };
34919
- /** Gets timestamps for when badges were awarded to a user. */
34920
- get: {
34921
- parameters: {
34922
- query: {
34923
- /** @description The CSV of badge Ids. */
34924
- badgeIds: number[];
34925
- };
34926
- header?: never;
34927
- path: {
34928
- /** @description The user Id. */
34929
- userId: number;
34930
- };
34931
- cookie?: never;
34932
- };
34933
- requestBody?: never;
34934
- responses: {
34935
- /** @description OK */
34936
- 200: {
34937
- headers: {
34938
- [name: string]: unknown;
34939
- };
34940
- content: {
34941
- "application/json": components["schemas"]["Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Badges.Api.BadgeAwardResponse_"];
34942
- "text/json": components["schemas"]["Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Badges.Api.BadgeAwardResponse_"];
34943
- };
34944
- };
34945
- /** @description 5: Too many badge Ids. */
34946
- 400: {
34947
- headers: {
34948
- [name: string]: unknown;
34949
- };
34950
- content?: never;
34951
- };
34952
- /** @description 4: User is invalid or does not exist. */
34953
- 404: {
34954
- headers: {
34955
- [name: string]: unknown;
34956
- };
34957
- content?: never;
34958
- };
34959
- };
34960
- };
34961
- put?: never;
34962
- post?: never;
34963
- delete?: never;
34964
- options?: never;
34965
- head?: never;
34966
- patch?: never;
34967
- trace?: never;
34968
- };
34969
- "/v1/users/{userId}/badges/{badgeId}/awarded-date": {
34970
- parameters: {
34971
- query?: never;
34972
- header?: never;
34973
- path?: never;
34974
- cookie?: never;
34975
- };
34976
- /** Gets timestamp for when a single badge was awarded to a user. */
34977
- get: {
34978
- parameters: {
34979
- query?: never;
34980
- header?: never;
34981
- path: {
34982
- /** @description User id. */
34983
- userId: number;
34984
- /** @description Badge id. */
34985
- badgeId: number;
34986
- };
34987
- cookie?: never;
34988
- };
34989
- requestBody?: never;
34990
- responses: {
34991
- /** @description OK */
34992
- 200: {
34993
- headers: {
34994
- [name: string]: unknown;
34995
- };
34996
- content?: never;
34997
- };
34998
- /** @description 4: User is invalid or does not exist. */
34999
- 404: {
35000
- headers: {
35001
- [name: string]: unknown;
35002
- };
35003
- content?: never;
35004
- };
35005
- };
35006
- };
35007
- put?: never;
35008
- post?: never;
35009
- delete?: never;
35010
- options?: never;
35011
- head?: never;
35012
- patch?: never;
35013
- trace?: never;
35014
- };
35015
34799
  "/v1/users/{userId}/bundles": {
35016
34800
  parameters: {
35017
34801
  query?: never;
@@ -43795,6 +43579,146 @@ export interface components {
43795
43579
  };
43796
43580
  /** @enum {string} */
43797
43581
  AgentType: "User" | "Group";
43582
+ /** @description A breakdown dimension value in a query result. */
43583
+ "AnalyticsQueryPublicApi.BreakdownValue": {
43584
+ /** @description The dimension name. */
43585
+ dimension: string;
43586
+ /** @description The dimension value. */
43587
+ value: string;
43588
+ /** @description A human-readable display value when the dimension is a unique ID. */
43589
+ displayValue?: string | null;
43590
+ };
43591
+ /** @description A single data point in a metric query result. */
43592
+ "AnalyticsQueryPublicApi.DataPoint": {
43593
+ /**
43594
+ * Format: date-time
43595
+ * @description The timestamp of the data point in UTC.
43596
+ */
43597
+ time: string;
43598
+ /**
43599
+ * Format: double
43600
+ * @description The numeric value of the data point.
43601
+ */
43602
+ value: number;
43603
+ /** @description String values associated with the data point, when applicable. */
43604
+ stringValues?: string[] | null;
43605
+ status?: components["schemas"]["AnalyticsQueryPublicApi.DataStatus"];
43606
+ };
43607
+ /**
43608
+ * @description The status of a data point in a query result.
43609
+ * @enum {string}
43610
+ */
43611
+ "AnalyticsQueryPublicApi.DataStatus": "Valid" | "Projected" | "NotStatisticallySignificant";
43612
+ /** @description The values for a single dimension returned by a dimension values query. */
43613
+ "AnalyticsQueryPublicApi.DimensionValues": {
43614
+ /** @description The dimension name. */
43615
+ dimension: string;
43616
+ /** @description The values for the dimension. */
43617
+ values?: components["schemas"]["DimensionValue"][];
43618
+ };
43619
+ /** @description A request to query dimension values. */
43620
+ "AnalyticsQueryPublicApi.DimensionValuesRequest": {
43621
+ /** @description The metric that provides context for resolving dimension namespaces. */
43622
+ metric: string;
43623
+ /** @description The dimensions to retrieve values for. Each entry is a single dimension name. */
43624
+ dimensions?: string[];
43625
+ /**
43626
+ * Format: date-time
43627
+ * @description The inclusive start of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
43628
+ */
43629
+ startTime: string;
43630
+ /**
43631
+ * Format: date-time
43632
+ * @description The exclusive end of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
43633
+ */
43634
+ endTime: string;
43635
+ /** @description Filters to apply to the query. */
43636
+ filter?: components["schemas"]["AnalyticsQueryPublicApi.QueryFilter"][];
43637
+ granularity?: components["schemas"]["AnalyticsQueryPublicApi.MetricGranularity"];
43638
+ /**
43639
+ * Format: int32
43640
+ * @description The maximum number of values to return per dimension.
43641
+ */
43642
+ limit?: number;
43643
+ };
43644
+ /** @description The response for a dimension values query. */
43645
+ "AnalyticsQueryPublicApi.DimensionValuesResponse": {
43646
+ /** @description The dimension values returned by the query. */
43647
+ values?: components["schemas"]["AnalyticsQueryPublicApi.DimensionValues"][];
43648
+ };
43649
+ /**
43650
+ * @description The operation to apply to a query filter.
43651
+ * @enum {string}
43652
+ */
43653
+ "AnalyticsQueryPublicApi.FilterOperation": "In" | "NotIn" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual" | "Match";
43654
+ /**
43655
+ * @description The time granularity of metric data points in a query.
43656
+ * @enum {string}
43657
+ */
43658
+ "AnalyticsQueryPublicApi.MetricGranularity": "OneMinute" | "HalfHour" | "OneHour" | "OneDay" | "OneWeek" | "OneMonth" | "None";
43659
+ /** @description A metric value for a single breakdown series. */
43660
+ "AnalyticsQueryPublicApi.MetricValue": {
43661
+ /** @description The breakdown values for this series. */
43662
+ breakdowns?: components["schemas"]["AnalyticsQueryPublicApi.BreakdownValue"][];
43663
+ /** @description The data points for this series. */
43664
+ dataPoints?: components["schemas"]["AnalyticsQueryPublicApi.DataPoint"][];
43665
+ };
43666
+ /** @description The metadata associated with a long-running operation. */
43667
+ "AnalyticsQueryPublicApi.OperationMetadata": {
43668
+ /**
43669
+ * Format: date-time
43670
+ * @description The time the operation was created.
43671
+ */
43672
+ createdTime?: string | null;
43673
+ };
43674
+ /** @description The error returned from a query request. */
43675
+ "AnalyticsQueryPublicApi.QueryError": {
43676
+ /**
43677
+ * Format: int32
43678
+ * @description The error code.
43679
+ */
43680
+ code?: number;
43681
+ /** @description The message associated with the query error. */
43682
+ message: string;
43683
+ };
43684
+ /** @description A filter applied to a query dimension. */
43685
+ "AnalyticsQueryPublicApi.QueryFilter": {
43686
+ /** @description The dimension name to filter on. */
43687
+ dimension: string;
43688
+ /** @description The values to filter by. */
43689
+ values?: string[];
43690
+ operation: components["schemas"]["AnalyticsQueryPublicApi.FilterOperation"];
43691
+ };
43692
+ /** @description A request to query time series metric data. */
43693
+ "AnalyticsQueryPublicApi.QueryRequest": {
43694
+ /** @description The metric to query. */
43695
+ metric: string;
43696
+ granularity: components["schemas"]["AnalyticsQueryPublicApi.MetricGranularity"];
43697
+ /**
43698
+ * Format: date-time
43699
+ * @description The inclusive start of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
43700
+ */
43701
+ startTime: string;
43702
+ /**
43703
+ * Format: date-time
43704
+ * @description The exclusive end of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
43705
+ */
43706
+ endTime: string;
43707
+ /** @description The dimensions to group results by. Each entry is a single dimension name. */
43708
+ breakdown?: string[];
43709
+ /** @description Filters to apply to the query. */
43710
+ filter?: components["schemas"]["AnalyticsQueryPublicApi.QueryFilter"][];
43711
+ /**
43712
+ * Format: int32
43713
+ * @description The maximum number of breakdown series to return.
43714
+ */
43715
+ limit?: number;
43716
+ };
43717
+ /** @description The response for a metric query. */
43718
+ "AnalyticsQueryPublicApi.QueryResponse": {
43719
+ /** @description The metric values returned by the query. */
43720
+ values?: components["schemas"]["AnalyticsQueryPublicApi.MetricValue"][];
43721
+ };
43798
43722
  ApiEmptyResponseModel: Record<string, never>;
43799
43723
  /** @description Represents an asset. */
43800
43724
  Asset: {
@@ -43881,7 +43805,7 @@ export interface components {
43881
43805
  * @description Enums for customized error code in error responses.
43882
43806
  * @enum {string}
43883
43807
  */
43884
- "AssetPermissions.ErrorCode": "UnknownError" | "InvalidRequest" | "AssetNotFound" | "CannotManageAsset" | "PublicAssetCannotBeGrantedTo" | "CannotManageSubject" | "SubjectNotFound" | "AssetTypeNotEnabled" | "PermissionLimitReached" | "DependenciesLimitReached";
43808
+ "AssetPermissions.ErrorCode": "UnknownError" | "InvalidRequest" | "AssetNotFound" | "CannotManageAsset" | "PublicAssetCannotBeGrantedTo" | "CannotManageSubject" | "SubjectNotFound" | "AssetTypeNotEnabled" | "PermissionLimitReached" | "DependenciesLimitReached" | "NotRequestable" | "RequesterNotConnected" | "AlreadyPending" | "AlreadyHasAccess" | "RequestNotFound" | "InvalidRequestStatus" | "RateLimited" | "CallerNotOwner" | "BatchSizeLimitExceeded";
43885
43809
  /** @description The error object for responses. */
43886
43810
  "AssetPermissions.ErrorResponse": {
43887
43811
  error?: components["schemas"]["AssetPermissions.Error"];
@@ -44126,15 +44050,6 @@ export interface components {
44126
44050
  /** @description The list of grants that had errors. */
44127
44051
  errors?: components["schemas"]["GrantPermissionError"][] | null;
44128
44052
  };
44129
- /** @description A breakdown dimension value in a query result. */
44130
- BreakdownValue: {
44131
- /** @description The dimension name. */
44132
- dimension: string;
44133
- /** @description The dimension value. */
44134
- value: string;
44135
- /** @description A human-readable display value when the dimension is a unique ID. */
44136
- displayValue?: string | null;
44137
- };
44138
44053
  /** @description Request model for bulk deleting saves */
44139
44054
  BulkDeleteSavesRequest: {
44140
44055
  /** @description A list of saves being deleted */
@@ -44724,27 +44639,6 @@ export interface components {
44724
44639
  * @enum {string}
44725
44640
  */
44726
44641
  CustomSignalType: "Invalid" | "PlayerCategorical" | "ServerCategorical" | "ServerNumerical" | "PlayerNumerical";
44727
- /** @description A single data point in a metric query result. */
44728
- DataPoint: {
44729
- /**
44730
- * Format: date-time
44731
- * @description The timestamp of the data point in UTC.
44732
- */
44733
- time: string;
44734
- /**
44735
- * Format: double
44736
- * @description The numeric value of the data point.
44737
- */
44738
- value: number;
44739
- /** @description String values associated with the data point, when applicable. */
44740
- stringValues?: string[] | null;
44741
- status?: components["schemas"]["DataStatus"];
44742
- };
44743
- /**
44744
- * @description The status of a data point in a query result.
44745
- * @enum {string}
44746
- */
44747
- DataStatus: "Valid" | "Projected" | "NotStatisticallySignificant";
44748
44642
  /** @description Represents a data store. */
44749
44643
  DataStore: {
44750
44644
  /**
@@ -45011,51 +44905,14 @@ export interface components {
45011
44905
  /** @description A human-readable display value when the dimension is a unique ID. */
45012
44906
  displayValue?: string | null;
45013
44907
  };
45014
- /** @description The values for a single dimension returned by a dimension values query. */
45015
- DimensionValues: {
45016
- /** @description The dimension name. */
45017
- dimension: string;
45018
- /** @description The values for the dimension. */
45019
- values?: components["schemas"]["DimensionValue"][];
45020
- };
45021
44908
  /** @description A completed long-running dimension values operation with results. */
45022
44909
  DimensionValuesOperationResult: {
45023
44910
  /** @description The server-assigned resource path. */
45024
44911
  path?: string | null;
45025
44912
  /** @description If false, the operation is still in progress. If true, the operation is completed. */
45026
44913
  done?: boolean;
45027
- response?: components["schemas"]["DimensionValuesResponse"];
45028
- metadata?: components["schemas"]["OperationMetadata"];
45029
- };
45030
- /** @description A request to query dimension values. */
45031
- DimensionValuesRequest: {
45032
- /** @description The metric that provides context for resolving dimension namespaces. */
45033
- metric: string;
45034
- /** @description The dimensions to retrieve values for. Each entry is a single dimension name. */
45035
- dimensions?: string[];
45036
- /**
45037
- * Format: date-time
45038
- * @description The inclusive start of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
45039
- */
45040
- startTime: string;
45041
- /**
45042
- * Format: date-time
45043
- * @description The exclusive end of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
45044
- */
45045
- endTime: string;
45046
- /** @description Filters to apply to the query. */
45047
- filter?: components["schemas"]["QueryFilter"][];
45048
- granularity?: components["schemas"]["MetricGranularity"];
45049
- /**
45050
- * Format: int32
45051
- * @description The maximum number of values to return per dimension.
45052
- */
45053
- limit?: number;
45054
- };
45055
- /** @description The response for a dimension values query. */
45056
- DimensionValuesResponse: {
45057
- /** @description The dimension values returned by the query. */
45058
- values?: components["schemas"]["DimensionValues"][];
44914
+ response?: components["schemas"]["AnalyticsQueryPublicApi.DimensionValuesResponse"];
44915
+ metadata?: components["schemas"]["AnalyticsQueryPublicApi.OperationMetadata"];
45059
44916
  };
45060
44917
  /** @description Discards read items from the front of the queue. */
45061
44918
  DiscardMemoryStoreQueueItemsRequest: {
@@ -45188,11 +45045,6 @@ export interface components {
45188
45045
  /** @description The list of available values for the filter. */
45189
45046
  values?: unknown[] | null;
45190
45047
  };
45191
- /**
45192
- * @description The operation to apply to a query filter.
45193
- * @enum {string}
45194
- */
45195
- FilterOperation: "In" | "NotIn" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual" | "Match";
45196
45048
  /** @description Response model for filter options endpoint. */
45197
45049
  FilterOptionsResponse: {
45198
45050
  /** @description A dictionary of filter field names to their metadata and available values. */
@@ -47379,18 +47231,6 @@ export interface components {
47379
47231
  */
47380
47232
  readonly count?: number;
47381
47233
  };
47382
- /**
47383
- * @description The time granularity of metric data points in a query.
47384
- * @enum {string}
47385
- */
47386
- MetricGranularity: "OneMinute" | "HalfHour" | "OneHour" | "OneDay" | "OneWeek" | "OneMonth" | "None";
47387
- /** @description A metric value for a single breakdown series. */
47388
- MetricValue: {
47389
- /** @description The breakdown values for this series. */
47390
- breakdowns?: components["schemas"]["BreakdownValue"][];
47391
- /** @description The data points for this series. */
47392
- dataPoints?: components["schemas"]["DataPoint"][];
47393
- };
47394
47234
  /** @description Mock server signal values. */
47395
47235
  MockServerSignalValues: {
47396
47236
  /**
@@ -47692,8 +47532,8 @@ export interface components {
47692
47532
  path?: string | null;
47693
47533
  /** @description If false, the operation is still in progress. If true, the operation is completed. */
47694
47534
  done?: boolean;
47695
- error?: components["schemas"]["QueryError"];
47696
- metadata?: components["schemas"]["OperationMetadata"];
47535
+ error?: components["schemas"]["AnalyticsQueryPublicApi.QueryError"];
47536
+ metadata?: components["schemas"]["AnalyticsQueryPublicApi.OperationMetadata"];
47697
47537
  };
47698
47538
  OperationErrorResponse: {
47699
47539
  /** Format: int32 */
@@ -47701,21 +47541,13 @@ export interface components {
47701
47541
  readonly error?: string | null;
47702
47542
  message?: string | null;
47703
47543
  };
47704
- /** @description The metadata associated with a long-running operation. */
47705
- OperationMetadata: {
47706
- /**
47707
- * Format: date-time
47708
- * @description The time the operation was created.
47709
- */
47710
- createdTime?: string | null;
47711
- };
47712
47544
  /** @description A long-running operation that is still in progress. */
47713
47545
  OperationPending: {
47714
47546
  /** @description The server-assigned resource path. */
47715
47547
  path?: string | null;
47716
47548
  /** @description If false, the operation is still in progress. If true, the operation is completed. */
47717
47549
  done?: boolean;
47718
- metadata?: components["schemas"]["OperationMetadata"];
47550
+ metadata?: components["schemas"]["AnalyticsQueryPublicApi.OperationMetadata"];
47719
47551
  };
47720
47552
  /** @description A key-value entry in an ordered data store. */
47721
47553
  OrderedDataStoreEntry: {
@@ -48246,16 +48078,6 @@ export interface components {
48246
48078
  /** @description The suggested spelling correction for the original search query. */
48247
48079
  suggestedQuery?: string | null;
48248
48080
  } | null;
48249
- /** @description The error returned from a query request. */
48250
- QueryError: {
48251
- /**
48252
- * Format: int32
48253
- * @description The error code.
48254
- */
48255
- code?: number;
48256
- /** @description The message associated with the query error. */
48257
- message: string;
48258
- };
48259
48081
  /** @description The facets of a query. */
48260
48082
  QueryFacets: {
48261
48083
  /** @description Facets that are already applied to the search. */
@@ -48263,52 +48085,14 @@ export interface components {
48263
48085
  /** @description The unused and still available facets. */
48264
48086
  availableFacets?: string[] | null;
48265
48087
  } | null;
48266
- /** @description A filter applied to a query dimension. */
48267
- QueryFilter: {
48268
- /** @description The dimension name to filter on. */
48269
- dimension: string;
48270
- /** @description The values to filter by. */
48271
- values?: string[];
48272
- operation: components["schemas"]["FilterOperation"];
48273
- };
48274
48088
  /** @description A completed long-running query operation with results. */
48275
48089
  QueryOperationResult: {
48276
48090
  /** @description The server-assigned resource path. */
48277
48091
  path?: string | null;
48278
48092
  /** @description If false, the operation is still in progress. If true, the operation is completed. */
48279
48093
  done?: boolean;
48280
- response?: components["schemas"]["QueryResponse"];
48281
- metadata?: components["schemas"]["OperationMetadata"];
48282
- };
48283
- /** @description A request to query time series metric data. */
48284
- QueryRequest: {
48285
- /** @description The metric to query. */
48286
- metric: string;
48287
- granularity: components["schemas"]["MetricGranularity"];
48288
- /**
48289
- * Format: date-time
48290
- * @description The inclusive start of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
48291
- */
48292
- startTime: string;
48293
- /**
48294
- * Format: date-time
48295
- * @description The exclusive end of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
48296
- */
48297
- endTime: string;
48298
- /** @description The dimensions to group results by. Each entry is a single dimension name. */
48299
- breakdown?: string[];
48300
- /** @description Filters to apply to the query. */
48301
- filter?: components["schemas"]["QueryFilter"][];
48302
- /**
48303
- * Format: int32
48304
- * @description The maximum number of breakdown series to return.
48305
- */
48306
- limit?: number;
48307
- };
48308
- /** @description The response for a metric query. */
48309
- QueryResponse: {
48310
- /** @description The metric values returned by the query. */
48311
- values?: components["schemas"]["MetricValue"][];
48094
+ response?: components["schemas"]["AnalyticsQueryPublicApi.QueryResponse"];
48095
+ metadata?: components["schemas"]["AnalyticsQueryPublicApi.OperationMetadata"];
48312
48096
  };
48313
48097
  /** @description Returns the specified number of items at the front of the queue. */
48314
48098
  ReadMemoryStoreQueueItemsResponse: {
@@ -51093,31 +50877,6 @@ export interface components {
51093
50877
  */
51094
50878
  platform?: "ChromeOnDesktop" | "AndroidNative" | "FirefoxOnDesktop" | "IOSNative" | "AndroidAmazon" | "IOSTencent" | "AndroidTencentService" | "IOSPushKit";
51095
50879
  };
51096
- /** @description The result of being awarded a badge. */
51097
- "Roblox.Badges.Api.BadgeAwardResponse": {
51098
- /**
51099
- * Format: int64
51100
- * @description The badge Id.
51101
- */
51102
- badgeId?: number;
51103
- /**
51104
- * Format: date-time
51105
- * @description When the badge was awarded.
51106
- */
51107
- awardedDate?: string;
51108
- };
51109
- /** @description Represents information about the badge creator. (Creator of the place that awarded the badge) */
51110
- "Roblox.Badges.Api.BadgeCreatorResponse": {
51111
- /**
51112
- * Format: int64
51113
- * @description The creator ID
51114
- */
51115
- id?: number;
51116
- /** @description The name of the creator */
51117
- name?: string;
51118
- /** @description The type of the creator */
51119
- type?: string;
51120
- };
51121
50880
  /** @description Metadata about badges. */
51122
50881
  "Roblox.Badges.Api.BadgeMetadataResponse": {
51123
50882
  /**
@@ -51182,35 +50941,6 @@ export interface components {
51182
50941
  statistics?: components["schemas"]["Roblox.Web.Responses.Badges.BadgeAwardStatisticsResponse"];
51183
50942
  awardingUniverse?: components["schemas"]["Roblox.Badges.Api.UniverseResponse"];
51184
50943
  };
51185
- /** @description Response for the GetBadgesByUser endpoint. */
51186
- "Roblox.Badges.Api.GetBadgesByUserResponse": {
51187
- creator?: components["schemas"]["Roblox.Badges.Api.BadgeCreatorResponse"];
51188
- /** Format: int64 */
51189
- id?: number;
51190
- name?: string;
51191
- description?: string;
51192
- displayName?: string;
51193
- displayDescription?: string;
51194
- enabled?: boolean;
51195
- /** Format: int64 */
51196
- iconImageId?: number;
51197
- /** Format: int64 */
51198
- displayIconImageId?: number;
51199
- awarder?: components["schemas"]["Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Platform.Badges.BadgeAwarderType_"];
51200
- statistics?: components["schemas"]["Roblox.Web.Responses.Badges.BadgeAwardStatisticsResponse"];
51201
- /** Format: date-time */
51202
- created?: string;
51203
- /** Format: date-time */
51204
- updated?: string;
51205
- };
51206
- /** @description Badge icon upload response. */
51207
- "Roblox.Badges.Api.IconUploadResponse": {
51208
- /**
51209
- * Format: int64
51210
- * @description The asset id of the uploaded icon.
51211
- */
51212
- targetId?: number;
51213
- };
51214
50944
  /** @description A response containing universe information. */
51215
50945
  "Roblox.Badges.Api.UniverseResponse": {
51216
50946
  /**
@@ -52117,6 +51847,8 @@ export interface components {
52117
51847
  mutualFriendsList?: string[];
52118
51848
  /** @description The user's verified badge status. */
52119
51849
  hasVerifiedBadge?: boolean;
51850
+ /** @description The user's verified badge status. */
51851
+ isUnseen?: boolean;
52120
51852
  /** @description The user description. */
52121
51853
  description?: string;
52122
51854
  /**
@@ -56642,9 +56374,6 @@ export interface components {
56642
56374
  "Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Api.Develop.Models.UniverseTeamCreateSettingsModel_": {
56643
56375
  data?: components["schemas"]["Roblox.Api.Develop.Models.UniverseTeamCreateSettingsModel"][];
56644
56376
  };
56645
- "Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Badges.Api.BadgeAwardResponse_": {
56646
- data?: components["schemas"]["Roblox.Badges.Api.BadgeAwardResponse"][];
56647
- };
56648
56377
  "Roblox.Web.WebAPI.Models.ApiArrayResponse_Roblox.Catalog.Api.BundleDetailsModel_": {
56649
56378
  data?: components["schemas"]["Roblox.Catalog.Api.BundleDetailsModel"][];
56650
56379
  };
@@ -56770,11 +56499,6 @@ export interface components {
56770
56499
  nextPageCursor?: string;
56771
56500
  data?: components["schemas"]["Roblox.Badges.Api.BadgeResponse"][];
56772
56501
  };
56773
- "Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Badges.Api.GetBadgesByUserResponse_": {
56774
- previousPageCursor?: string;
56775
- nextPageCursor?: string;
56776
- data?: components["schemas"]["Roblox.Badges.Api.GetBadgesByUserResponse"][];
56777
- };
56778
56502
  "Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Catalog.Api.BundleDetailsModel_": {
56779
56503
  previousPageCursor?: string;
56780
56504
  nextPageCursor?: string;
@@ -64906,6 +64630,8 @@ export interface operations {
64906
64630
  * @description The maximum number of game servers to return. The service might return
64907
64631
  * fewer than this value. If unspecified, at most 25 game servers are
64908
64632
  * returned. The maximum value is 100 and higher values are set to 100.
64633
+ * Zero returns no game servers and only the total count, for callers that
64634
+ * need the count without paging through rows.
64909
64635
  */
64910
64636
  MaxPageSize?: number;
64911
64637
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jacobhumston/roblox-openapi-ts",
3
- "version": "1.0.40",
3
+ "version": "1.0.42",
4
4
  "description": "An automatically updated Roblox API client based on their OpenAPI documentation.",
5
5
  "keywords": [
6
6
  "roblox",