rozod 6.2.0 → 6.4.0
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/lib/endpoints/accountsettingsv1.d.ts +27 -33
- package/lib/endpoints/accountsettingsv1.js +11 -22
- package/lib/endpoints/adconfigurationv2.d.ts +104 -119
- package/lib/endpoints/adconfigurationv2.js +32 -48
- package/lib/endpoints/assetdeliveryv1.d.ts +25 -24
- package/lib/endpoints/assetdeliveryv1.js +25 -24
- package/lib/endpoints/assetdeliveryv2.d.ts +25 -24
- package/lib/endpoints/assetdeliveryv2.js +25 -24
- package/lib/endpoints/authv1.d.ts +132 -84
- package/lib/endpoints/authv1.js +118 -64
- package/lib/endpoints/authv2.d.ts +56 -56
- package/lib/endpoints/authv2.js +57 -50
- package/lib/endpoints/authv3.d.ts +11 -11
- package/lib/endpoints/authv3.js +11 -11
- package/lib/endpoints/avatarv1.d.ts +1 -0
- package/lib/endpoints/avatarv1.js +1 -0
- package/lib/endpoints/avatarv2.d.ts +1 -0
- package/lib/endpoints/avatarv2.js +1 -0
- package/lib/endpoints/avatarv3.d.ts +1 -0
- package/lib/endpoints/avatarv3.js +1 -0
- package/lib/endpoints/badgesv1.d.ts +6 -22
- package/lib/endpoints/badgesv1.js +2 -22
- package/lib/endpoints/catalogv1.d.ts +39 -113
- package/lib/endpoints/catalogv1.js +39 -107
- package/lib/endpoints/catalogv2.d.ts +11 -11
- package/lib/endpoints/catalogv2.js +11 -11
- package/lib/endpoints/clientsettingsv2.d.ts +8 -7
- package/lib/endpoints/clientsettingsv2.js +9 -1
- package/lib/endpoints/developv1.d.ts +31 -31
- package/lib/endpoints/developv1.js +26 -26
- package/lib/endpoints/developv2.d.ts +27 -27
- package/lib/endpoints/developv2.js +22 -22
- package/lib/endpoints/economycreatorstatsv1.d.ts +1 -1
- package/lib/endpoints/economycreatorstatsv1.js +1 -1
- package/lib/endpoints/followingsv2.d.ts +2 -2
- package/lib/endpoints/followingsv2.js +2 -2
- package/lib/endpoints/friendsv1.d.ts +24 -98
- package/lib/endpoints/friendsv1.js +25 -91
- package/lib/endpoints/gamesv1.d.ts +31 -615
- package/lib/endpoints/gamesv1.js +32 -608
- package/lib/endpoints/gamesv2.d.ts +187 -260
- package/lib/endpoints/gamesv2.js +130 -190
- package/lib/endpoints/groupsv1.d.ts +34 -28
- package/lib/endpoints/groupsv1.js +31 -18
- package/lib/endpoints/groupsv2.d.ts +92 -92
- package/lib/endpoints/groupsv2.js +93 -87
- package/lib/endpoints/inventoryv1.d.ts +9 -21
- package/lib/endpoints/inventoryv1.js +4 -4
- package/lib/endpoints/inventoryv2.d.ts +91 -91
- package/lib/endpoints/inventoryv2.js +86 -86
- package/lib/endpoints/itemconfigurationv1.d.ts +1 -1
- package/lib/endpoints/itemconfigurationv1.js +1 -1
- package/lib/endpoints/thumbnailsv1.d.ts +1 -0
- package/lib/endpoints/thumbnailsv1.js +1 -0
- package/lib/endpoints/tradesv1.d.ts +10 -16
- package/lib/endpoints/tradesv1.js +10 -10
- package/lib/endpoints/twostepverificationv1.d.ts +59 -59
- package/lib/endpoints/twostepverificationv1.js +59 -59
- package/lib/endpoints/usersv1.d.ts +1 -1
- package/lib/endpoints/usersv1.js +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +29 -3
- package/lib/opencloud/v1/asset-permissions.d.ts +7 -2
- package/lib/opencloud/v1/asset-permissions.js +9 -3
- package/lib/opencloud/v1/assets.d.ts +59 -32
- package/lib/opencloud/v1/assets.js +77 -41
- package/lib/opencloud/v1/datastores-ordered.d.ts +50 -14
- package/lib/opencloud/v1/datastores-ordered.js +62 -20
- package/lib/opencloud/v1/datastores.d.ts +99 -42
- package/lib/opencloud/v1/datastores.js +123 -50
- package/lib/opencloud/v1/developer-products.d.ts +29 -11
- package/lib/opencloud/v1/developer-products.js +37 -15
- package/lib/opencloud/v1/game-passes.d.ts +29 -11
- package/lib/opencloud/v1/game-passes.js +37 -15
- package/lib/opencloud/v1/messaging.d.ts +6 -2
- package/lib/opencloud/v1/messaging.js +8 -3
- package/lib/opencloud/v1/open-eval.d.ts +14 -4
- package/lib/opencloud/v1/open-eval.js +18 -6
- package/lib/opencloud/v1/secrets-store.d.ts +46 -26
- package/lib/opencloud/v1/secrets-store.js +56 -31
- package/lib/opencloud/v1/toolbox.d.ts +14 -6
- package/lib/opencloud/v1/toolbox.js +18 -8
- package/lib/opencloud/v1/universes.d.ts +6 -2
- package/lib/opencloud/v1/universes.js +8 -3
- package/lib/opencloud/v2/cloud.d.ts +854 -395
- package/lib/opencloud/v2/cloud.js +967 -395
- package/package.json +1 -1
|
@@ -24,11 +24,9 @@ const SecretPaginatedList = zod_1.z.object({
|
|
|
24
24
|
previousPageCursor: zod_1.z.string().nullable(),
|
|
25
25
|
});
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* @param universeId The universe ID
|
|
31
|
-
* @description Creates a new secret. A maximum of 500 secrets per universe is allowed.
|
|
27
|
+
* `BETA`
|
|
28
|
+
*
|
|
29
|
+
* Creates a new secret. A maximum of 500 secrets per universe is allowed.
|
|
32
30
|
|
|
33
31
|
Only the owner of the universe can create secrets. For group-owned universes, only the group owner or authorized
|
|
34
32
|
members can create secrets.
|
|
@@ -41,11 +39,18 @@ To encrypt the secret:
|
|
|
41
39
|
Include the key_id from the public key response in the request.
|
|
42
40
|
|
|
43
41
|
For an example, see the [Secrets store guide](https://create.roblox.com/docs/cloud/guides/secrets-store).
|
|
42
|
+
*
|
|
43
|
+
* **Scopes:** `universe.secret:write`
|
|
44
|
+
* **Engine:** Not available in-engine
|
|
45
|
+
*
|
|
46
|
+
* @param body The secret to create with encrypted content
|
|
47
|
+
* @param universeId The universe ID
|
|
44
48
|
*/
|
|
45
49
|
exports.postCloudV2UniversesUniverseIdSecrets = (0, __1.endpoint)({
|
|
46
50
|
method: 'POST',
|
|
47
51
|
path: '/cloud/v2/universes/:universeId/secrets',
|
|
48
|
-
baseUrl: 'https://apis.roblox.com
|
|
52
|
+
baseUrl: 'https://apis.roblox.com',
|
|
53
|
+
scopes: ['universe.secret:write'],
|
|
49
54
|
requestFormat: 'json',
|
|
50
55
|
serializationMethod: {
|
|
51
56
|
body: {},
|
|
@@ -72,21 +77,26 @@ exports.postCloudV2UniversesUniverseIdSecrets = (0, __1.endpoint)({
|
|
|
72
77
|
],
|
|
73
78
|
});
|
|
74
79
|
/**
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
* @param limit Number of secrets to return per page (1-500, default 10)
|
|
79
|
-
* @param cursor Pagination cursor from previous response
|
|
80
|
-
* @description Lists all secrets defined for a universe.
|
|
80
|
+
* `BETA`
|
|
81
|
+
*
|
|
82
|
+
* Lists all secrets defined for a universe.
|
|
81
83
|
Secret content is not returned for security reasons - only metadata such as ID, domain, creation and update timestamps are included.
|
|
82
84
|
|
|
83
85
|
Only the owner of the universe can list secrets. For group-owned universes, only the group owner or authorized
|
|
84
86
|
members can list secrets.
|
|
87
|
+
*
|
|
88
|
+
* **Scopes:** `universe.secret:read`
|
|
89
|
+
* **Engine:** Not available in-engine
|
|
90
|
+
*
|
|
91
|
+
* @param universeId The universe ID
|
|
92
|
+
* @param limit Number of secrets to return per page (1-500, default 10)
|
|
93
|
+
* @param cursor Pagination cursor from previous response
|
|
85
94
|
*/
|
|
86
95
|
exports.getCloudV2UniversesUniverseIdSecrets = (0, __1.endpoint)({
|
|
87
96
|
method: 'GET',
|
|
88
97
|
path: '/cloud/v2/universes/:universeId/secrets',
|
|
89
|
-
baseUrl: 'https://apis.roblox.com
|
|
98
|
+
baseUrl: 'https://apis.roblox.com',
|
|
99
|
+
scopes: ['universe.secret:read'],
|
|
90
100
|
requestFormat: 'json',
|
|
91
101
|
serializationMethod: {
|
|
92
102
|
universeId: {},
|
|
@@ -111,12 +121,9 @@ exports.getCloudV2UniversesUniverseIdSecrets = (0, __1.endpoint)({
|
|
|
111
121
|
],
|
|
112
122
|
});
|
|
113
123
|
/**
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
* @param universeId The universe ID
|
|
118
|
-
* @param secretId The ID of the secret to update
|
|
119
|
-
* @description Updates an existing secret.
|
|
124
|
+
* `BETA`
|
|
125
|
+
*
|
|
126
|
+
* Updates an existing secret.
|
|
120
127
|
|
|
121
128
|
Only the owner of the universe can update secrets. For group-owned universes, only the group owner or authorized
|
|
122
129
|
members can update secrets.
|
|
@@ -131,11 +138,19 @@ To encrypt the updated secret:
|
|
|
131
138
|
Include the key_id from the public key response in the request.
|
|
132
139
|
|
|
133
140
|
For an example, see the [Secrets store guide](https://create.roblox.com/docs/cloud/guides/secrets-store).
|
|
141
|
+
*
|
|
142
|
+
* **Scopes:** `universe.secret:write`
|
|
143
|
+
* **Engine:** Not available in-engine
|
|
144
|
+
*
|
|
145
|
+
* @param body The updated secret data with encrypted content
|
|
146
|
+
* @param universeId The universe ID
|
|
147
|
+
* @param secretId The ID of the secret to update
|
|
134
148
|
*/
|
|
135
149
|
exports.patchCloudV2UniversesUniverseIdSecretsSecretId = (0, __1.endpoint)({
|
|
136
150
|
method: 'PATCH',
|
|
137
151
|
path: '/cloud/v2/universes/:universeId/secrets/:secretId',
|
|
138
|
-
baseUrl: 'https://apis.roblox.com
|
|
152
|
+
baseUrl: 'https://apis.roblox.com',
|
|
153
|
+
scopes: ['universe.secret:write'],
|
|
139
154
|
requestFormat: 'json',
|
|
140
155
|
serializationMethod: {
|
|
141
156
|
body: {},
|
|
@@ -164,21 +179,26 @@ exports.patchCloudV2UniversesUniverseIdSecretsSecretId = (0, __1.endpoint)({
|
|
|
164
179
|
],
|
|
165
180
|
});
|
|
166
181
|
/**
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
* @param secretId The ID of the secret to delete
|
|
171
|
-
* @description Permanently deletes a secret from a universe.
|
|
182
|
+
* `BETA`
|
|
183
|
+
*
|
|
184
|
+
* Permanently deletes a secret from a universe.
|
|
172
185
|
|
|
173
186
|
Only the owner of the universe can delete secrets. For group-owned universes, only the group owner or authorized
|
|
174
187
|
members can delete secrets.
|
|
175
188
|
|
|
176
189
|
This operation is irreversible. Make sure you no longer need the secret before deleting it.
|
|
190
|
+
*
|
|
191
|
+
* **Scopes:** `universe.secret:write`
|
|
192
|
+
* **Engine:** Not available in-engine
|
|
193
|
+
*
|
|
194
|
+
* @param universeId The universe ID
|
|
195
|
+
* @param secretId The ID of the secret to delete
|
|
177
196
|
*/
|
|
178
197
|
exports.deleteCloudV2UniversesUniverseIdSecretsSecretId = (0, __1.endpoint)({
|
|
179
198
|
method: 'DELETE',
|
|
180
199
|
path: '/cloud/v2/universes/:universeId/secrets/:secretId',
|
|
181
|
-
baseUrl: 'https://apis.roblox.com
|
|
200
|
+
baseUrl: 'https://apis.roblox.com',
|
|
201
|
+
scopes: ['universe.secret:write'],
|
|
182
202
|
requestFormat: 'json',
|
|
183
203
|
serializationMethod: {
|
|
184
204
|
universeId: {},
|
|
@@ -205,10 +225,9 @@ exports.deleteCloudV2UniversesUniverseIdSecretsSecretId = (0, __1.endpoint)({
|
|
|
205
225
|
],
|
|
206
226
|
});
|
|
207
227
|
/**
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
* @description Retrieves the public key for a universe. You need this key to encrypt secret content
|
|
228
|
+
* `BETA`
|
|
229
|
+
*
|
|
230
|
+
* Retrieves the public key for a universe. You need this key to encrypt secret content
|
|
212
231
|
before sending it to Roblox.
|
|
213
232
|
|
|
214
233
|
Only the owner of the universe can retrieve the public key. For group-owned universes, only the group owner or
|
|
@@ -221,11 +240,17 @@ Use this key with LibSodium sealed box encryption to encrypt your secret content
|
|
|
221
240
|
creating or updating secrets.
|
|
222
241
|
|
|
223
242
|
Include the key_id from the public key response in the request to create or update a secret.
|
|
243
|
+
*
|
|
244
|
+
* **Scopes:** `universe.secret:read`
|
|
245
|
+
* **Engine:** Not available in-engine
|
|
246
|
+
*
|
|
247
|
+
* @param universeId The universe ID
|
|
224
248
|
*/
|
|
225
249
|
exports.getCloudV2UniversesUniverseIdSecretsPublicKey = (0, __1.endpoint)({
|
|
226
250
|
method: 'GET',
|
|
227
251
|
path: '/cloud/v2/universes/:universeId/secrets/public-key',
|
|
228
|
-
baseUrl: 'https://apis.roblox.com
|
|
252
|
+
baseUrl: 'https://apis.roblox.com',
|
|
253
|
+
scopes: ['universe.secret:read'],
|
|
229
254
|
requestFormat: 'json',
|
|
230
255
|
serializationMethod: {
|
|
231
256
|
universeId: {},
|
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
2
|
+
* `BETA`
|
|
3
|
+
*
|
|
4
|
+
* Search Creator Store for assets.
|
|
5
|
+
*
|
|
6
|
+
* **Scopes:** `creator-store-product:read`
|
|
7
|
+
* **Engine:** Usable with HttpService
|
|
8
|
+
*
|
|
4
9
|
* @param searchCategoryType The asset type to search within.
|
|
5
10
|
* @param query The search terms used to filter the results.
|
|
6
11
|
* @param modelSubTypes When searching for models, the subtypes associated with the search results.
|
|
@@ -27,7 +32,6 @@
|
|
|
27
32
|
* @param categoryPath
|
|
28
33
|
* @param searchView Indicates which fields will be populated in the response.
|
|
29
34
|
* @param musicChartType Indicates which music charts to filter from.
|
|
30
|
-
* @description Search Creator Store for assets.
|
|
31
35
|
*/
|
|
32
36
|
export declare const getToolboxServiceV2AssetsSearch: import("../..").EndpointGeneric<{
|
|
33
37
|
searchCategoryType: "Plugin" | "Audio" | "Model" | "Decal" | "MeshPart" | "Video" | "FontFamily";
|
|
@@ -113,10 +117,14 @@ export declare const getToolboxServiceV2AssetsSearch: import("../..").EndpointGe
|
|
|
113
117
|
filteredKeyword: string | null;
|
|
114
118
|
} | null, undefined>;
|
|
115
119
|
/**
|
|
116
|
-
*
|
|
117
|
-
*
|
|
120
|
+
* `BETA`
|
|
121
|
+
*
|
|
122
|
+
* Get details for a single Creator Store asset.
|
|
123
|
+
*
|
|
124
|
+
* **Scopes:** `creator-store-product:read`
|
|
125
|
+
* **Engine:** Usable with HttpService
|
|
126
|
+
*
|
|
118
127
|
* @param id The asset ID to retrieve details for.
|
|
119
|
-
* @description Get details for a single Creator Store asset.
|
|
120
128
|
*/
|
|
121
129
|
export declare const getToolboxServiceV2AssetsId: import("../..").EndpointGeneric<{
|
|
122
130
|
id: number;
|
|
@@ -92,8 +92,13 @@ const SearchCreatorStoreAssetsResponse = zod_1.z.object({
|
|
|
92
92
|
const ProblemDetails = zod_1.z.unknown().nullable();
|
|
93
93
|
const HttpValidationProblemDetails = ProblemDetails;
|
|
94
94
|
/**
|
|
95
|
-
*
|
|
96
|
-
*
|
|
95
|
+
* `BETA`
|
|
96
|
+
*
|
|
97
|
+
* Search Creator Store for assets.
|
|
98
|
+
*
|
|
99
|
+
* **Scopes:** `creator-store-product:read`
|
|
100
|
+
* **Engine:** Usable with HttpService
|
|
101
|
+
*
|
|
97
102
|
* @param searchCategoryType The asset type to search within.
|
|
98
103
|
* @param query The search terms used to filter the results.
|
|
99
104
|
* @param modelSubTypes When searching for models, the subtypes associated with the search results.
|
|
@@ -120,12 +125,12 @@ const HttpValidationProblemDetails = ProblemDetails;
|
|
|
120
125
|
* @param categoryPath
|
|
121
126
|
* @param searchView Indicates which fields will be populated in the response.
|
|
122
127
|
* @param musicChartType Indicates which music charts to filter from.
|
|
123
|
-
* @description Search Creator Store for assets.
|
|
124
128
|
*/
|
|
125
129
|
exports.getToolboxServiceV2AssetsSearch = (0, __1.endpoint)({
|
|
126
130
|
method: 'GET',
|
|
127
131
|
path: '/toolbox-service/v2/assets:search',
|
|
128
|
-
baseUrl: 'https://apis.roblox.com
|
|
132
|
+
baseUrl: 'https://apis.roblox.com',
|
|
133
|
+
scopes: ['creator-store-product:read'],
|
|
129
134
|
requestFormat: 'json',
|
|
130
135
|
serializationMethod: {
|
|
131
136
|
searchCategoryType: {},
|
|
@@ -203,15 +208,20 @@ exports.getToolboxServiceV2AssetsSearch = (0, __1.endpoint)({
|
|
|
203
208
|
],
|
|
204
209
|
});
|
|
205
210
|
/**
|
|
206
|
-
*
|
|
207
|
-
*
|
|
211
|
+
* `BETA`
|
|
212
|
+
*
|
|
213
|
+
* Get details for a single Creator Store asset.
|
|
214
|
+
*
|
|
215
|
+
* **Scopes:** `creator-store-product:read`
|
|
216
|
+
* **Engine:** Usable with HttpService
|
|
217
|
+
*
|
|
208
218
|
* @param id The asset ID to retrieve details for.
|
|
209
|
-
* @description Get details for a single Creator Store asset.
|
|
210
219
|
*/
|
|
211
220
|
exports.getToolboxServiceV2AssetsId = (0, __1.endpoint)({
|
|
212
221
|
method: 'GET',
|
|
213
222
|
path: '/toolbox-service/v2/assets/:id',
|
|
214
|
-
baseUrl: 'https://apis.roblox.com
|
|
223
|
+
baseUrl: 'https://apis.roblox.com',
|
|
224
|
+
scopes: ['creator-store-product:read'],
|
|
215
225
|
requestFormat: 'json',
|
|
216
226
|
serializationMethod: {
|
|
217
227
|
id: {},
|
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* **Publish a Place** · `BETA`
|
|
3
|
+
*
|
|
4
|
+
* Publish a new place or update an existing place with a new version. Provide a RBXL or RBXLX file in the data-binary.
|
|
5
|
+
*
|
|
6
|
+
* **Scopes:** `universe-places:write`
|
|
7
|
+
*
|
|
3
8
|
* @param universeId The identifier of the experience in which you want to publish your place to. You can [copy your experience's Universe ID](/cloud/guides/usage-place-publishing.md#publishing-a-place) on **Creator Dashboard**.
|
|
4
9
|
* @param placeId The identifier of your place. See [Publishing places with API keys](/cloud/guides/usage-place-publishing.md) on obtaining a Place ID.
|
|
5
10
|
* @param versionType Can only be either:
|
|
6
11
|
- `Saved`: the place file should be saved, but not published.
|
|
7
12
|
- `Published`: the place file should be saved and published.
|
|
8
|
-
* @description Publish a new place or update an existing place with a new version. Provide a RBXL or RBXLX file in the data-binary.
|
|
9
13
|
*/
|
|
10
14
|
export declare const postUniverseIdPlacesPlaceIdVersions: import("../..").EndpointGeneric<{
|
|
11
15
|
universeId: number;
|
|
@@ -4,18 +4,23 @@ exports.postUniverseIdPlacesPlaceIdVersions = void 0;
|
|
|
4
4
|
const zod_1 = require("zod");
|
|
5
5
|
const __1 = require("../..");
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* **Publish a Place** · `BETA`
|
|
8
|
+
*
|
|
9
|
+
* Publish a new place or update an existing place with a new version. Provide a RBXL or RBXLX file in the data-binary.
|
|
10
|
+
*
|
|
11
|
+
* **Scopes:** `universe-places:write`
|
|
12
|
+
*
|
|
8
13
|
* @param universeId The identifier of the experience in which you want to publish your place to. You can [copy your experience's Universe ID](/cloud/guides/usage-place-publishing.md#publishing-a-place) on **Creator Dashboard**.
|
|
9
14
|
* @param placeId The identifier of your place. See [Publishing places with API keys](/cloud/guides/usage-place-publishing.md) on obtaining a Place ID.
|
|
10
15
|
* @param versionType Can only be either:
|
|
11
16
|
- `Saved`: the place file should be saved, but not published.
|
|
12
17
|
- `Published`: the place file should be saved and published.
|
|
13
|
-
* @description Publish a new place or update an existing place with a new version. Provide a RBXL or RBXLX file in the data-binary.
|
|
14
18
|
*/
|
|
15
19
|
exports.postUniverseIdPlacesPlaceIdVersions = (0, __1.endpoint)({
|
|
16
20
|
method: 'POST',
|
|
17
21
|
path: '/v1/:universeId/places/:placeId/versions',
|
|
18
|
-
baseUrl: 'https://apis.roblox.com/
|
|
22
|
+
baseUrl: 'https://apis.roblox.com/universes',
|
|
23
|
+
scopes: ['universe-places:write'],
|
|
19
24
|
requestFormat: 'json',
|
|
20
25
|
serializationMethod: {
|
|
21
26
|
universeId: {},
|