@jacobhumston/roblox-openapi-ts 1.0.52 → 1.0.53
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 +12 -290
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -3502,15 +3502,6 @@ export interface paths {
|
|
|
3502
3502
|
/**
|
|
3503
3503
|
* Get User
|
|
3504
3504
|
* @description Gets a user's basic and advanced information.
|
|
3505
|
-
*
|
|
3506
|
-
* To access a user's public information, no additional scopes are required.
|
|
3507
|
-
*
|
|
3508
|
-
* To access a user's verification status, you need the following scopes:
|
|
3509
|
-
* * user.advanced:read
|
|
3510
|
-
*
|
|
3511
|
-
* To access a user's social account information, you need the following
|
|
3512
|
-
* scopes:
|
|
3513
|
-
* * user.social:read
|
|
3514
3505
|
*/
|
|
3515
3506
|
get: operations["Cloud_GetUser"];
|
|
3516
3507
|
put?: never;
|
|
@@ -3521,26 +3512,6 @@ export interface paths {
|
|
|
3521
3512
|
patch?: never;
|
|
3522
3513
|
trace?: never;
|
|
3523
3514
|
};
|
|
3524
|
-
"/cloud/v2/users/{user_id}#OpenCloudUsers": {
|
|
3525
|
-
parameters: {
|
|
3526
|
-
query?: never;
|
|
3527
|
-
header?: never;
|
|
3528
|
-
path?: never;
|
|
3529
|
-
cookie?: never;
|
|
3530
|
-
};
|
|
3531
|
-
/**
|
|
3532
|
-
* Get User
|
|
3533
|
-
* @description Gets a user's basic and advanced information.
|
|
3534
|
-
*/
|
|
3535
|
-
get: operations["OpenCloudUsers.Cloud_GetUser"];
|
|
3536
|
-
put?: never;
|
|
3537
|
-
post?: never;
|
|
3538
|
-
delete?: never;
|
|
3539
|
-
options?: never;
|
|
3540
|
-
head?: never;
|
|
3541
|
-
patch?: never;
|
|
3542
|
-
trace?: never;
|
|
3543
|
-
};
|
|
3544
3515
|
"/cloud/v2/users/{user_id}/asset-quotas": {
|
|
3545
3516
|
parameters: {
|
|
3546
3517
|
query?: never;
|
|
@@ -3614,26 +3585,6 @@ export interface paths {
|
|
|
3614
3585
|
trace?: never;
|
|
3615
3586
|
};
|
|
3616
3587
|
"/cloud/v2/users/{user_id}/operations/{operation_id}": {
|
|
3617
|
-
parameters: {
|
|
3618
|
-
query?: never;
|
|
3619
|
-
header?: never;
|
|
3620
|
-
path?: never;
|
|
3621
|
-
cookie?: never;
|
|
3622
|
-
};
|
|
3623
|
-
/**
|
|
3624
|
-
* Get User Thumbnail Generation Operation
|
|
3625
|
-
* @description Retrieves the status of the operation to [generate a user thumbnail](https://create.roblox.com/docs/cloud/reference/features/users#Cloud_GenerateUserThumbnail).
|
|
3626
|
-
*/
|
|
3627
|
-
get: operations["Cloud_GetUserThumbnailGenerationOperation"];
|
|
3628
|
-
put?: never;
|
|
3629
|
-
post?: never;
|
|
3630
|
-
delete?: never;
|
|
3631
|
-
options?: never;
|
|
3632
|
-
head?: never;
|
|
3633
|
-
patch?: never;
|
|
3634
|
-
trace?: never;
|
|
3635
|
-
};
|
|
3636
|
-
"/cloud/v2/users/{user_id}/operations/{operation_id}#OpenCloudUsers": {
|
|
3637
3588
|
parameters: {
|
|
3638
3589
|
query?: never;
|
|
3639
3590
|
header?: never;
|
|
@@ -3650,7 +3601,7 @@ export interface paths {
|
|
|
3650
3601
|
* polling until `done` is `true`. Once complete, `response.imageUri` contains
|
|
3651
3602
|
* the generated thumbnail URL.
|
|
3652
3603
|
*/
|
|
3653
|
-
get: operations["
|
|
3604
|
+
get: operations["Cloud_GetUserThumbnailGenerationOperation"];
|
|
3654
3605
|
put?: never;
|
|
3655
3606
|
post?: never;
|
|
3656
3607
|
delete?: never;
|
|
@@ -3660,26 +3611,6 @@ export interface paths {
|
|
|
3660
3611
|
trace?: never;
|
|
3661
3612
|
};
|
|
3662
3613
|
"/cloud/v2/users/{user_id}:generateThumbnail": {
|
|
3663
|
-
parameters: {
|
|
3664
|
-
query?: never;
|
|
3665
|
-
header?: never;
|
|
3666
|
-
path?: never;
|
|
3667
|
-
cookie?: never;
|
|
3668
|
-
};
|
|
3669
|
-
/**
|
|
3670
|
-
* Generate User Thumbnail
|
|
3671
|
-
* @description Generates and returns the URL for the user's avatar thumbnail.
|
|
3672
|
-
*/
|
|
3673
|
-
get: operations["Cloud_GenerateUserThumbnail"];
|
|
3674
|
-
put?: never;
|
|
3675
|
-
post?: never;
|
|
3676
|
-
delete?: never;
|
|
3677
|
-
options?: never;
|
|
3678
|
-
head?: never;
|
|
3679
|
-
patch?: never;
|
|
3680
|
-
trace?: never;
|
|
3681
|
-
};
|
|
3682
|
-
"/cloud/v2/users/{user_id}:generateThumbnail#OpenCloudUsers": {
|
|
3683
3614
|
parameters: {
|
|
3684
3615
|
query?: never;
|
|
3685
3616
|
header?: never;
|
|
@@ -3695,7 +3626,7 @@ export interface paths {
|
|
|
3695
3626
|
* which point `response.imageUri` contains the thumbnail URL. See
|
|
3696
3627
|
* [Get User Thumbnail Generation Operation](https://create.roblox.com/docs/cloud/reference/features/users#Cloud_GetUserThumbnailGenerationOperation).
|
|
3697
3628
|
*/
|
|
3698
|
-
get: operations["
|
|
3629
|
+
get: operations["Cloud_GenerateUserThumbnail"];
|
|
3699
3630
|
put?: never;
|
|
3700
3631
|
post?: never;
|
|
3701
3632
|
delete?: never;
|
|
@@ -51669,8 +51600,15 @@ export interface components {
|
|
|
51669
51600
|
GenerateUserThumbnailMetadata: Record<string, never>;
|
|
51670
51601
|
/** @description Returns the URL for the user's avatar thumbnail. */
|
|
51671
51602
|
GenerateUserThumbnailResponse: {
|
|
51603
|
+
/**
|
|
51604
|
+
* @description The fully-qualified type of the packed operation response. Mirrors the
|
|
51605
|
+
* `@type` field the legacy transcoder emitted via `Any.Pack`, kept so clients
|
|
51606
|
+
* reading `response["@type"]` continue to work. Declared first so it
|
|
51607
|
+
* serializes before the payload fields.
|
|
51608
|
+
*/
|
|
51609
|
+
readonly "@type"?: string | null;
|
|
51672
51610
|
/** @description URI for the generated thumbnail. */
|
|
51673
|
-
imageUri?: string;
|
|
51611
|
+
imageUri?: string | null;
|
|
51674
51612
|
};
|
|
51675
51613
|
GenericCurrencyResponse: {
|
|
51676
51614
|
/** Format: int64 */
|
|
@@ -53927,26 +53865,6 @@ export interface components {
|
|
|
53927
53865
|
*/
|
|
53928
53866
|
vertices?: number;
|
|
53929
53867
|
} | null;
|
|
53930
|
-
/**
|
|
53931
|
-
* @description Represents metadata about the long-running operation corresponding to a
|
|
53932
|
-
* GenerateUserThumbnail request.
|
|
53933
|
-
*
|
|
53934
|
-
* This is the type of the `Operation.metadata` field in the response to
|
|
53935
|
-
* `GetOperation` requests for GenerateUserThumbnail operations.
|
|
53936
|
-
*/
|
|
53937
|
-
"OpenCloudUsers.GenerateUserThumbnailMetadata": Record<string, never>;
|
|
53938
|
-
/** @description Returns the URL for the user's avatar thumbnail. */
|
|
53939
|
-
"OpenCloudUsers.GenerateUserThumbnailResponse": {
|
|
53940
|
-
/**
|
|
53941
|
-
* @description The fully-qualified type of the packed operation response. Mirrors the
|
|
53942
|
-
* `@type` field the legacy transcoder emitted via `Any.Pack`, kept so clients
|
|
53943
|
-
* reading `response["@type"]` continue to work. Declared first so it
|
|
53944
|
-
* serializes before the payload fields.
|
|
53945
|
-
*/
|
|
53946
|
-
readonly "@type"?: string | null;
|
|
53947
|
-
/** @description URI for the generated thumbnail. */
|
|
53948
|
-
imageUri?: string | null;
|
|
53949
|
-
};
|
|
53950
53868
|
/**
|
|
53951
53869
|
* @description This resource represents a long-running operation that is the result of a
|
|
53952
53870
|
* network API call.
|
|
@@ -53964,7 +53882,7 @@ export interface components {
|
|
|
53964
53882
|
* Some services might not provide such metadata. Any method that returns a
|
|
53965
53883
|
* long-running operation should document the metadata type, if any.
|
|
53966
53884
|
*/
|
|
53967
|
-
metadata?: components["schemas"]["
|
|
53885
|
+
metadata?: components["schemas"]["GenerateUserThumbnailMetadata"] | null;
|
|
53968
53886
|
/**
|
|
53969
53887
|
* @description If the value is `false`, it means the operation is still in progress.
|
|
53970
53888
|
* If `true`, the operation is completed, and either `error` or `response` is
|
|
@@ -53983,7 +53901,7 @@ export interface components {
|
|
|
53983
53901
|
* is `TakeSnapshot()`, the inferred response type is
|
|
53984
53902
|
* `TakeSnapshotResponse`.
|
|
53985
53903
|
*/
|
|
53986
|
-
response?: components["schemas"]["
|
|
53904
|
+
response?: components["schemas"]["GenerateUserThumbnailResponse"] | null;
|
|
53987
53905
|
};
|
|
53988
53906
|
/** @description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */
|
|
53989
53907
|
"OpenCloudUsers.Status": {
|
|
@@ -65688,63 +65606,6 @@ export interface components {
|
|
|
65688
65606
|
[key: string]: components["schemas"]["UploadThumbnailStatus"];
|
|
65689
65607
|
};
|
|
65690
65608
|
};
|
|
65691
|
-
/** @description Represents any registered user of Roblox. */
|
|
65692
|
-
User: {
|
|
65693
|
-
/**
|
|
65694
|
-
* @description The resource path of the user.
|
|
65695
|
-
*
|
|
65696
|
-
* Format: `users/{user_id}`
|
|
65697
|
-
* @example users/123
|
|
65698
|
-
*/
|
|
65699
|
-
path?: string;
|
|
65700
|
-
/**
|
|
65701
|
-
* Format: date-time
|
|
65702
|
-
* @description The timestamp at which the user was created.
|
|
65703
|
-
* @example 2023-07-05T12:34:56Z
|
|
65704
|
-
*/
|
|
65705
|
-
readonly createTime?: string;
|
|
65706
|
-
/**
|
|
65707
|
-
* @description Unique ID that identifies a user in Roblox.
|
|
65708
|
-
* @example 123456
|
|
65709
|
-
*/
|
|
65710
|
-
readonly id?: string;
|
|
65711
|
-
/**
|
|
65712
|
-
* @description Unique username for a user in Roblox.
|
|
65713
|
-
* @example exampleUser
|
|
65714
|
-
*/
|
|
65715
|
-
name?: string;
|
|
65716
|
-
/**
|
|
65717
|
-
* @description Display name for the user.
|
|
65718
|
-
* @example userDefinedName
|
|
65719
|
-
*/
|
|
65720
|
-
displayName?: string;
|
|
65721
|
-
/**
|
|
65722
|
-
* @description User-defined information about themselves.
|
|
65723
|
-
* @example Example User's bio
|
|
65724
|
-
*/
|
|
65725
|
-
about?: string;
|
|
65726
|
-
/**
|
|
65727
|
-
* @description Current locale selected by the user. Returns IETF language code.
|
|
65728
|
-
* @example en-US
|
|
65729
|
-
*/
|
|
65730
|
-
locale?: string;
|
|
65731
|
-
/**
|
|
65732
|
-
* @description Whether the user is a premium user.
|
|
65733
|
-
* @example true
|
|
65734
|
-
*/
|
|
65735
|
-
readonly premium?: boolean;
|
|
65736
|
-
/**
|
|
65737
|
-
* @description Specifies if the user is identity-verified. Verification includes, but
|
|
65738
|
-
* isn't limited to, non-VoIP phone numbers or government IDs.
|
|
65739
|
-
*
|
|
65740
|
-
* To access this data, you need an API key / OAuth token with the following
|
|
65741
|
-
* scope: user.advanced:read
|
|
65742
|
-
* @example true
|
|
65743
|
-
*/
|
|
65744
|
-
readonly idVerified?: boolean;
|
|
65745
|
-
/** @description User's social network profiles and visibility. */
|
|
65746
|
-
socialNetworkProfiles?: components["schemas"]["User_SocialNetworkProfiles"];
|
|
65747
|
-
};
|
|
65748
65609
|
UserGameVoteRequest: {
|
|
65749
65610
|
vote?: boolean | null;
|
|
65750
65611
|
};
|
|
@@ -66051,40 +65912,6 @@ export interface components {
|
|
|
66051
65912
|
*/
|
|
66052
65913
|
readonly inherited?: boolean;
|
|
66053
65914
|
};
|
|
66054
|
-
/** @description Social network profiles of a user. */
|
|
66055
|
-
User_SocialNetworkProfiles: {
|
|
66056
|
-
/** @description Facebook profile URI. */
|
|
66057
|
-
facebook?: string;
|
|
66058
|
-
/** @description Twitter profile URI. */
|
|
66059
|
-
twitter?: string;
|
|
66060
|
-
/** @description YouTube profile URI. */
|
|
66061
|
-
youtube?: string;
|
|
66062
|
-
/** @description Twitch profile URI. */
|
|
66063
|
-
twitch?: string;
|
|
66064
|
-
/** @description Guilded profile URI. */
|
|
66065
|
-
guilded?: string;
|
|
66066
|
-
/**
|
|
66067
|
-
* Format: enum
|
|
66068
|
-
* @description Visibility of the social network profiles.
|
|
66069
|
-
*
|
|
66070
|
-
* To access this data, you need an API key / OAuth token with the following
|
|
66071
|
-
* scope: user.social:read
|
|
66072
|
-
*
|
|
66073
|
-
* Possible values:
|
|
66074
|
-
*
|
|
66075
|
-
* | Value | Description |
|
|
66076
|
-
* | --- | --- |
|
|
66077
|
-
* | SOCIAL_NETWORK_VISIBILITY_UNSPECIFIED | Default SocialNetworkVisibility. |
|
|
66078
|
-
* | NO_ONE | No one |
|
|
66079
|
-
* | FRIENDS | Friends only |
|
|
66080
|
-
* | FRIENDS_AND_FOLLOWING | Friends and other users the user follows |
|
|
66081
|
-
* | FRIENDS_FOLLOWING_AND_FOLLOWERS | Friends, other users the user follows, and other users who follow the user |
|
|
66082
|
-
* | EVERYONE | Everyone |
|
|
66083
|
-
* @example SOCIAL_NETWORK_VISIBILITY_UNSPECIFIED
|
|
66084
|
-
* @enum {string}
|
|
66085
|
-
*/
|
|
66086
|
-
visibility?: "SOCIAL_NETWORK_VISIBILITY_UNSPECIFIED" | "NO_ONE" | "FRIENDS" | "FRIENDS_AND_FOLLOWING" | "FRIENDS_FOLLOWING_AND_FOLLOWERS" | "EVERYONE";
|
|
66087
|
-
};
|
|
66088
65915
|
/** @description Metadata shared by every experiment variant. */
|
|
66089
65916
|
VariantMeta: {
|
|
66090
65917
|
/**
|
|
@@ -69948,29 +69775,6 @@ export interface operations {
|
|
|
69948
69775
|
};
|
|
69949
69776
|
};
|
|
69950
69777
|
Cloud_GetUser: {
|
|
69951
|
-
parameters: {
|
|
69952
|
-
query?: never;
|
|
69953
|
-
header?: never;
|
|
69954
|
-
path: {
|
|
69955
|
-
/** @description The user ID. */
|
|
69956
|
-
user_id: string;
|
|
69957
|
-
};
|
|
69958
|
-
cookie?: never;
|
|
69959
|
-
};
|
|
69960
|
-
requestBody?: never;
|
|
69961
|
-
responses: {
|
|
69962
|
-
/** @description OK */
|
|
69963
|
-
200: {
|
|
69964
|
-
headers: {
|
|
69965
|
-
[name: string]: unknown;
|
|
69966
|
-
};
|
|
69967
|
-
content: {
|
|
69968
|
-
"application/json": components["schemas"]["User"];
|
|
69969
|
-
};
|
|
69970
|
-
};
|
|
69971
|
-
};
|
|
69972
|
-
};
|
|
69973
|
-
"OpenCloudUsers.Cloud_GetUser": {
|
|
69974
69778
|
parameters: {
|
|
69975
69779
|
query?: never;
|
|
69976
69780
|
header?: never;
|
|
@@ -70114,31 +69918,6 @@ export interface operations {
|
|
|
70114
69918
|
};
|
|
70115
69919
|
};
|
|
70116
69920
|
Cloud_GetUserThumbnailGenerationOperation: {
|
|
70117
|
-
parameters: {
|
|
70118
|
-
query?: never;
|
|
70119
|
-
header?: never;
|
|
70120
|
-
path: {
|
|
70121
|
-
/** @description The user ID. */
|
|
70122
|
-
user_id: string;
|
|
70123
|
-
/** @description The operation ID. */
|
|
70124
|
-
operation_id: string;
|
|
70125
|
-
};
|
|
70126
|
-
cookie?: never;
|
|
70127
|
-
};
|
|
70128
|
-
requestBody?: never;
|
|
70129
|
-
responses: {
|
|
70130
|
-
/** @description OK */
|
|
70131
|
-
200: {
|
|
70132
|
-
headers: {
|
|
70133
|
-
[name: string]: unknown;
|
|
70134
|
-
};
|
|
70135
|
-
content: {
|
|
70136
|
-
"application/json": components["schemas"]["OCV2.Operations.Operation"];
|
|
70137
|
-
};
|
|
70138
|
-
};
|
|
70139
|
-
};
|
|
70140
|
-
};
|
|
70141
|
-
"OpenCloudUsers.Cloud_GetUserThumbnailGenerationOperation": {
|
|
70142
69921
|
parameters: {
|
|
70143
69922
|
query?: never;
|
|
70144
69923
|
header?: never;
|
|
@@ -70164,63 +69943,6 @@ export interface operations {
|
|
|
70164
69943
|
};
|
|
70165
69944
|
};
|
|
70166
69945
|
Cloud_GenerateUserThumbnail: {
|
|
70167
|
-
parameters: {
|
|
70168
|
-
query?: {
|
|
70169
|
-
/**
|
|
70170
|
-
* @description Size of the generated thumbnail. The generated thumbnail will have `size *
|
|
70171
|
-
* size` dimension.
|
|
70172
|
-
*
|
|
70173
|
-
* Currently supported values:
|
|
70174
|
-
* 48, 50, 60, 75, 100, 110, 150, 180, 352, 420, 720
|
|
70175
|
-
* Default is 420.
|
|
70176
|
-
*/
|
|
70177
|
-
size?: number;
|
|
70178
|
-
/**
|
|
70179
|
-
* @description Specify the format of the generated thumbnail. Default is `PNG`.
|
|
70180
|
-
*
|
|
70181
|
-
* Possible values:
|
|
70182
|
-
*
|
|
70183
|
-
* | Value | Description |
|
|
70184
|
-
* | --- | --- |
|
|
70185
|
-
* | FORMAT_UNSPECIFIED | Default UserThumbnail Format -- set to png |
|
|
70186
|
-
* | PNG | Generate thumbnail in `.png` format |
|
|
70187
|
-
* | JPEG | Generate thumbnail in `.jpg` format |
|
|
70188
|
-
*/
|
|
70189
|
-
format?: "FORMAT_UNSPECIFIED" | "PNG" | "JPEG";
|
|
70190
|
-
/**
|
|
70191
|
-
* @description Specify the shape of the thumbnail. Default is `ROUND` (circular).
|
|
70192
|
-
*
|
|
70193
|
-
* Possible values:
|
|
70194
|
-
*
|
|
70195
|
-
* | Value | Description |
|
|
70196
|
-
* | --- | --- |
|
|
70197
|
-
* | SHAPE_UNSPECIFIED | Default UserThumbnail Shape -- set to round |
|
|
70198
|
-
* | ROUND | Generate thumbnail as a circle. |
|
|
70199
|
-
* | SQUARE | Generate thumbnail as a rectangle. |
|
|
70200
|
-
*/
|
|
70201
|
-
shape?: "SHAPE_UNSPECIFIED" | "ROUND" | "SQUARE";
|
|
70202
|
-
};
|
|
70203
|
-
header?: never;
|
|
70204
|
-
path: {
|
|
70205
|
-
/** @description The user ID. */
|
|
70206
|
-
user_id: string;
|
|
70207
|
-
};
|
|
70208
|
-
cookie?: never;
|
|
70209
|
-
};
|
|
70210
|
-
requestBody?: never;
|
|
70211
|
-
responses: {
|
|
70212
|
-
/** @description OK */
|
|
70213
|
-
200: {
|
|
70214
|
-
headers: {
|
|
70215
|
-
[name: string]: unknown;
|
|
70216
|
-
};
|
|
70217
|
-
content: {
|
|
70218
|
-
"application/json": components["schemas"]["Operation"];
|
|
70219
|
-
};
|
|
70220
|
-
};
|
|
70221
|
-
};
|
|
70222
|
-
};
|
|
70223
|
-
"OpenCloudUsers.Cloud_GenerateUserThumbnail": {
|
|
70224
69946
|
parameters: {
|
|
70225
69947
|
query?: {
|
|
70226
69948
|
/**
|