rozod 6.2.0 → 6.3.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.
Files changed (50) hide show
  1. package/lib/endpoints/authv1.d.ts +48 -0
  2. package/lib/endpoints/authv1.js +49 -2
  3. package/lib/endpoints/avatarv1.d.ts +1 -0
  4. package/lib/endpoints/avatarv1.js +1 -0
  5. package/lib/endpoints/avatarv2.d.ts +1 -0
  6. package/lib/endpoints/avatarv2.js +1 -0
  7. package/lib/endpoints/avatarv3.d.ts +1 -0
  8. package/lib/endpoints/avatarv3.js +1 -0
  9. package/lib/endpoints/badgesv1.d.ts +0 -20
  10. package/lib/endpoints/badgesv1.js +0 -20
  11. package/lib/endpoints/catalogv1.d.ts +2 -70
  12. package/lib/endpoints/catalogv1.js +2 -70
  13. package/lib/endpoints/clientsettingsv2.d.ts +1 -0
  14. package/lib/endpoints/clientsettingsv2.js +1 -0
  15. package/lib/endpoints/friendsv1.d.ts +0 -75
  16. package/lib/endpoints/friendsv1.js +1 -68
  17. package/lib/endpoints/gamesv1.d.ts +4 -0
  18. package/lib/endpoints/gamesv1.js +4 -0
  19. package/lib/endpoints/groupsv1.d.ts +10 -4
  20. package/lib/endpoints/groupsv1.js +3 -2
  21. package/lib/endpoints/thumbnailsv1.d.ts +1 -0
  22. package/lib/endpoints/thumbnailsv1.js +1 -0
  23. package/lib/endpoints/twostepverificationv1.d.ts +1 -0
  24. package/lib/endpoints/twostepverificationv1.js +1 -0
  25. package/lib/index.d.ts +1 -0
  26. package/lib/opencloud/v1/asset-permissions.d.ts +7 -2
  27. package/lib/opencloud/v1/asset-permissions.js +9 -3
  28. package/lib/opencloud/v1/assets.d.ts +59 -32
  29. package/lib/opencloud/v1/assets.js +77 -41
  30. package/lib/opencloud/v1/datastores-ordered.d.ts +50 -14
  31. package/lib/opencloud/v1/datastores-ordered.js +62 -20
  32. package/lib/opencloud/v1/datastores.d.ts +99 -42
  33. package/lib/opencloud/v1/datastores.js +123 -50
  34. package/lib/opencloud/v1/developer-products.d.ts +29 -11
  35. package/lib/opencloud/v1/developer-products.js +37 -15
  36. package/lib/opencloud/v1/game-passes.d.ts +29 -11
  37. package/lib/opencloud/v1/game-passes.js +37 -15
  38. package/lib/opencloud/v1/messaging.d.ts +6 -2
  39. package/lib/opencloud/v1/messaging.js +8 -3
  40. package/lib/opencloud/v1/open-eval.d.ts +14 -4
  41. package/lib/opencloud/v1/open-eval.js +18 -6
  42. package/lib/opencloud/v1/secrets-store.d.ts +46 -26
  43. package/lib/opencloud/v1/secrets-store.js +56 -31
  44. package/lib/opencloud/v1/toolbox.d.ts +14 -6
  45. package/lib/opencloud/v1/toolbox.js +18 -8
  46. package/lib/opencloud/v1/universes.d.ts +6 -2
  47. package/lib/opencloud/v1/universes.js +8 -3
  48. package/lib/opencloud/v2/cloud.d.ts +854 -395
  49. package/lib/opencloud/v2/cloud.js +967 -395
  50. package/package.json +1 -1
@@ -8,18 +8,25 @@ const DataStore = zod_1.z.object({
8
8
  createdTime: zod_1.z.string().datetime({ offset: true }).nullable(),
9
9
  });
10
10
  /**
11
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores
12
- * @summary List data stores in an experience
11
+ * **List Data Stores** · `BETA`
12
+ *
13
+ * Returns a list of an experience's data stores.
14
+ *
15
+ * **Lua equivalent:** `DataStoreService:ListDataStoresAsync`
16
+ * **Scopes:** `universe-datastores.control:list`
17
+ *
13
18
  * @param universeId The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
14
19
  * @param cursor Provide to request the next set of data.
15
20
  * @param limit The maximum number of items to return. Each call only reads one partition, so it can return fewer than the given value when running out of objectives on one partition.
16
21
  * @param prefix Provide to return only data stores with this prefix.
17
- * @description Returns a list of an experience's data stores.
22
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores
23
+ * @deprecated Prefer the v2 alternative(s) listed above.
18
24
  */
19
25
  exports.getUniversesUniverseIdDatastores = (0, __1.endpoint)({
20
26
  method: 'GET',
21
27
  path: '/v1/universes/:universeId/standard-datastores',
22
- baseUrl: 'https://apis.roblox.com/cloud',
28
+ baseUrl: 'https://apis.roblox.com/datastores',
29
+ scopes: ['universe-datastores.control:list'],
23
30
  requestFormat: 'json',
24
31
  serializationMethod: {
25
32
  universeId: {},
@@ -40,8 +47,15 @@ exports.getUniversesUniverseIdDatastores = (0, __1.endpoint)({
40
47
  errors: [],
41
48
  });
42
49
  /**
43
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries
44
- * @summary List entries
50
+ * **List Entries** · `BETA`
51
+ *
52
+ * Returns a list of entry keys within a data store.
53
+
54
+ Entries marked deleted with a tombstone version are still included in the response if they have yet to be permanently deleted.
55
+ *
56
+ * **Lua equivalent:** `DataStore:ListKeysAsync`
57
+ * **Scopes:** `universe-datastores.objects:list`
58
+ *
45
59
  * @param universeId The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
46
60
  * @param datastoreName The name of the data store.
47
61
  * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
@@ -49,14 +63,15 @@ exports.getUniversesUniverseIdDatastores = (0, __1.endpoint)({
49
63
  * @param prefix Provide to return only keys with this prefix.
50
64
  * @param cursor Provide to request the next set of data.
51
65
  * @param limit The maximum number of items to return. Each call only reads one partition, so it can return fewer than the given value when running out of objectives on one partition.
52
- * @description Returns a list of entry keys within a data store.
53
-
54
- Entries marked deleted with a tombstone version are still included in the response if they have yet to be permanently deleted.
66
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries
67
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries
68
+ * @deprecated Prefer the v2 alternative(s) listed above.
55
69
  */
56
70
  exports.getUniversesUniverseIdDatastoresDatastoreEntries = (0, __1.endpoint)({
57
71
  method: 'GET',
58
72
  path: '/v1/universes/:universeId/standard-datastores/datastore/entries',
59
- baseUrl: 'https://apis.roblox.com/cloud',
73
+ baseUrl: 'https://apis.roblox.com/datastores',
74
+ scopes: ['universe-datastores.objects:list'],
60
75
  requestFormat: 'json',
61
76
  serializationMethod: {
62
77
  universeId: {},
@@ -83,13 +98,9 @@ exports.getUniversesUniverseIdDatastoresDatastoreEntries = (0, __1.endpoint)({
83
98
  errors: [],
84
99
  });
85
100
  /**
86
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries/entry
87
- * @summary Get entry.
88
- * @param universeId The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
89
- * @param datastoreName The name of the data store.
90
- * @param entryKey The key identifying the entry.
91
- * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
92
- * @description Returns the value and metadata associated with an entry.
101
+ * **Get Entry** · `BETA`
102
+ *
103
+ * Returns the value and metadata associated with an entry.
93
104
 
94
105
  Entries marked deleted with a tombstone version will return 404 Not Found.
95
106
 
@@ -112,11 +123,23 @@ roblox-entry-userids: [1, 2, 3]
112
123
  | `roblox-entry-attributes` | Attributes tagged with the entry. Serialized JSON map object. |
113
124
  | `roblox-entry-userids` | Comma-separated list of Roblox user IDs tagged with the entry. |
114
125
 
126
+ *
127
+ * **Lua equivalent:** `GlobalDataStore:GetAsync`
128
+ * **Scopes:** `universe-datastores.objects:read`
129
+ *
130
+ * @param universeId The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
131
+ * @param datastoreName The name of the data store.
132
+ * @param entryKey The key identifying the entry.
133
+ * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
134
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
135
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}
136
+ * @deprecated Prefer the v2 alternative(s) listed above.
115
137
  */
116
138
  exports.getUniversesUniverseIdDatastoresDatastoreEntriesEntry = (0, __1.endpoint)({
117
139
  method: 'GET',
118
140
  path: '/v1/universes/:universeId/standard-datastores/datastore/entries/entry',
119
- baseUrl: 'https://apis.roblox.com/cloud',
141
+ baseUrl: 'https://apis.roblox.com/datastores',
142
+ scopes: ['universe-datastores.objects:read'],
120
143
  requestFormat: 'json',
121
144
  serializationMethod: {
122
145
  universeId: {},
@@ -134,8 +157,13 @@ exports.getUniversesUniverseIdDatastoresDatastoreEntriesEntry = (0, __1.endpoint
134
157
  errors: [],
135
158
  });
136
159
  /**
137
- * @api POST https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries/entry
138
- * @summary Set entry.
160
+ * **Set Entry** · `BETA`
161
+ *
162
+ * Sets the value, metadata and user IDs associated with an entry.
163
+ *
164
+ * **Lua equivalent:** `GlobalDataStore:SetAsync`
165
+ * **Scopes:** `universe-datastores.objects:update`, `universe-datastores.objects:create`, `universe-datastores.control:create`
166
+ *
139
167
  * @param body
140
168
  * @param universeId The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
141
169
  * @param datastoreName The name of the data store.
@@ -146,12 +174,21 @@ exports.getUniversesUniverseIdDatastoresDatastoreEntriesEntry = (0, __1.endpoint
146
174
  * @param roblox-entry-attributes Attributes to be associated with new version of the entry. Serialized by JSON map objects. If not provided, existing attributes are cleared.
147
175
  * @param roblox-entry-userids Comma-separated list of Roblox user IDs tagged with the entry. If not provided, existing user IDs are cleared.
148
176
  * @param content-md5 The base64-encoded MD5 checksum of the content. See [Content-MD5](/cloud/guides/data-stores/request-handling.md#content-md5).
149
- * @description Sets the value, metadata and user IDs associated with an entry.
177
+ * @see PATCH https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
178
+ * @see PATCH https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}
179
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries
180
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries
181
+ * @deprecated Prefer the v2 alternative(s) listed above.
150
182
  */
151
183
  exports.postUniversesUniverseIdDatastoresDatastoreEntriesEntry = (0, __1.endpoint)({
152
184
  method: 'POST',
153
185
  path: '/v1/universes/:universeId/standard-datastores/datastore/entries/entry',
154
- baseUrl: 'https://apis.roblox.com/cloud',
186
+ baseUrl: 'https://apis.roblox.com/datastores',
187
+ scopes: [
188
+ 'universe-datastores.objects:update',
189
+ 'universe-datastores.objects:create',
190
+ 'universe-datastores.control:create',
191
+ ],
155
192
  requestFormat: 'json',
156
193
  serializationMethod: {
157
194
  body: {},
@@ -181,18 +218,26 @@ exports.postUniversesUniverseIdDatastoresDatastoreEntriesEntry = (0, __1.endpoin
181
218
  errors: [],
182
219
  });
183
220
  /**
184
- * @api DELETE https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries/entry
185
- * @summary Delete entry.
221
+ * **Delete Entry** · `BETA`
222
+ *
223
+ * Marks the entry as deleted by creating a tombstone version. Entries are deleted permanently after 30 days.
224
+ *
225
+ * **Lua equivalent:** `GlobalDataStore:RemoveAsync`
226
+ * **Scopes:** `universe-datastores.objects:delete`
227
+ *
186
228
  * @param universeId The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
187
229
  * @param datastoreName The name of the data store.
188
230
  * @param entryKey The key identifying the entry.
189
231
  * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
190
- * @description Marks the entry as deleted by creating a tombstone version. Entries are deleted permanently after 30 days.
232
+ * @see DELETE https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
233
+ * @see DELETE https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}
234
+ * @deprecated Prefer the v2 alternative(s) listed above.
191
235
  */
192
236
  exports.deleteUniversesUniverseIdDatastoresDatastoreEntriesEntry = (0, __1.endpoint)({
193
237
  method: 'DELETE',
194
238
  path: '/v1/universes/:universeId/standard-datastores/datastore/entries/entry',
195
- baseUrl: 'https://apis.roblox.com/cloud',
239
+ baseUrl: 'https://apis.roblox.com/datastores',
240
+ scopes: ['universe-datastores.objects:delete'],
196
241
  requestFormat: 'json',
197
242
  serializationMethod: {
198
243
  universeId: {},
@@ -210,16 +255,9 @@ exports.deleteUniversesUniverseIdDatastoresDatastoreEntriesEntry = (0, __1.endpo
210
255
  errors: [],
211
256
  });
212
257
  /**
213
- * @api POST https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries/entry/increment
214
- * @summary Increment entry
215
- * @param universeId The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
216
- * @param datastoreName The name of the data store.
217
- * @param entryKey The key identifying the entry.
218
- * @param incrementBy The amount by which the entry should be incremented, or the starting value if it doesn't exist.
219
- * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
220
- * @param roblox-entry-attributes Attributes to be associated with new version of the entry. Serialized by JSON map objects. If not provided, existing attributes are cleared.
221
- * @param roblox-entry-userids A comma-separated list of Roblox user IDs that the entry is tagged with. If not provided, existing user IDs are cleared.
222
- * @description Increments the value for an entry by a given amount, or create a new entry with that amount. Returns the entry and metadata.
258
+ * **Increment Entry** · `BETA`
259
+ *
260
+ * Increments the value for an entry by a given amount, or create a new entry with that amount. Returns the entry and metadata.
223
261
 
224
262
  Metadata can be found in the response headers like the following:
225
263
  ```text
@@ -240,11 +278,30 @@ roblox-entry-userids: [1, 2, 3]
240
278
  | `roblox-entry-attributes` | Attributes tagged with the entry. Serialized JSON map object. |
241
279
  | `roblox-entry-userids` | Comma-separated list of Roblox user IDs tagged with the entry. |
242
280
 
281
+ *
282
+ * **Lua equivalent:** `GlobalDataStore:IncrementAsync`
283
+ * **Scopes:** `universe-datastores.objects:update`, `universe-datastores.objects:create`, `universe-datastores.control:create`
284
+ *
285
+ * @param universeId The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
286
+ * @param datastoreName The name of the data store.
287
+ * @param entryKey The key identifying the entry.
288
+ * @param incrementBy The amount by which the entry should be incremented, or the starting value if it doesn't exist.
289
+ * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
290
+ * @param roblox-entry-attributes Attributes to be associated with new version of the entry. Serialized by JSON map objects. If not provided, existing attributes are cleared.
291
+ * @param roblox-entry-userids A comma-separated list of Roblox user IDs that the entry is tagged with. If not provided, existing user IDs are cleared.
292
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment
293
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment
294
+ * @deprecated Prefer the v2 alternative(s) listed above.
243
295
  */
244
296
  exports.postUniversesUniverseIdDatastoresDatastoreEntriesEntryIncrement = (0, __1.endpoint)({
245
297
  method: 'POST',
246
298
  path: '/v1/universes/:universeId/standard-datastores/datastore/entries/entry/increment',
247
- baseUrl: 'https://apis.roblox.com/cloud',
299
+ baseUrl: 'https://apis.roblox.com/datastores',
300
+ scopes: [
301
+ 'universe-datastores.objects:update',
302
+ 'universe-datastores.objects:create',
303
+ 'universe-datastores.control:create',
304
+ ],
248
305
  requestFormat: 'json',
249
306
  serializationMethod: {
250
307
  universeId: {},
@@ -268,8 +325,13 @@ exports.postUniversesUniverseIdDatastoresDatastoreEntriesEntryIncrement = (0, __
268
325
  errors: [],
269
326
  });
270
327
  /**
271
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries/entry/versions
272
- * @summary List entry versions
328
+ * **List Entry Versions** · `BETA`
329
+ *
330
+ * Returns a list of versions for an entry.
331
+ *
332
+ * **Lua equivalent:** `DataStore:ListVersionsAsync`
333
+ * **Scopes:** `universe-datastores.versions:list`
334
+ *
273
335
  * @param universeId The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
274
336
  * @param datastoreName The name of the data store.
275
337
  * @param entryKey The key identifying the entry.
@@ -279,12 +341,15 @@ exports.postUniversesUniverseIdDatastoresDatastoreEntriesEntryIncrement = (0, __
279
341
  * @param endTime Provide to not include versions later than this timestamp.
280
342
  * @param sortOrder Either `Ascending` (earlier versions first) or `Descending` (later versions first).
281
343
  * @param limit The maximum number of items to return. Each call only reads one partition, so it can return fewer than the given value when running out of objectives on one partition.
282
- * @description Returns a list of versions for an entry.
344
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions
345
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}:listRevisions
346
+ * @deprecated Prefer the v2 alternative(s) listed above.
283
347
  */
284
348
  exports.getUniversesUniverseIdDatastoresDatastoreEntriesEntryVersions = (0, __1.endpoint)({
285
349
  method: 'GET',
286
350
  path: '/v1/universes/:universeId/standard-datastores/datastore/entries/entry/versions',
287
- baseUrl: 'https://apis.roblox.com/cloud',
351
+ baseUrl: 'https://apis.roblox.com/datastores',
352
+ scopes: ['universe-datastores.versions:list'],
288
353
  requestFormat: 'json',
289
354
  serializationMethod: {
290
355
  universeId: {},
@@ -329,14 +394,9 @@ exports.getUniversesUniverseIdDatastoresDatastoreEntriesEntryVersions = (0, __1.
329
394
  ],
330
395
  });
331
396
  /**
332
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries/entry/versions/version
333
- * @summary Get entry version.
334
- * @param universeId The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
335
- * @param datastoreName The name of the data store.
336
- * @param entryKey The key identifying the entry.
337
- * @param versionId The version to inspect.
338
- * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
339
- * @description Returns the value and metadata of a specific version of an entry.
397
+ * **Get Entry Version** · `BETA`
398
+ *
399
+ * Returns the value and metadata of a specific version of an entry.
340
400
 
341
401
  Metadata can be found in the response headers like the following:
342
402
  ```text
@@ -357,11 +417,24 @@ roblox-entry-userids: [1, 2, 3]
357
417
  | `roblox-entry-attributes` | Attributes tagged with the entry. Serialized JSON map object. |
358
418
  | `roblox-entry-userids` | Comma-separated list of Roblox user IDs tagged with the entry. |
359
419
 
420
+ *
421
+ * **Lua equivalent:** `DataStore:GetVersionAsync`
422
+ * **Scopes:** `universe-datastores.versions:read`
423
+ *
424
+ * @param universeId The identifier of the experience with data stores that you want to access. You can find your experience's universe ID on Creator Hub.
425
+ * @param datastoreName The name of the data store.
426
+ * @param entryKey The key identifying the entry.
427
+ * @param versionId The version to inspect.
428
+ * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
429
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
430
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}
431
+ * @deprecated Prefer the v2 alternative(s) listed above.
360
432
  */
361
433
  exports.getUniversesUniverseIdDatastoresDatastoreEntriesEntryVersionsVersion = (0, __1.endpoint)({
362
434
  method: 'GET',
363
435
  path: '/v1/universes/:universeId/standard-datastores/datastore/entries/entry/versions/version',
364
- baseUrl: 'https://apis.roblox.com/cloud',
436
+ baseUrl: 'https://apis.roblox.com/datastores',
437
+ scopes: ['universe-datastores.versions:read'],
365
438
  requestFormat: 'json',
366
439
  serializationMethod: {
367
440
  universeId: {},
@@ -1,9 +1,13 @@
1
1
  /**
2
- * @api POST https://apis.roblox.com/cloud/developer-products/v2/universes/:universeId/developer-products
3
- * @summary Create developer product
2
+ * `BETA`
3
+ *
4
+ * Creates a new developer product with the provided configuration details.
5
+ *
6
+ * **Scopes:** `developer-product:write`
7
+ * **Engine:** Not available in-engine
8
+ *
4
9
  * @param body
5
10
  * @param universeId The universe ID.
6
- * @description Creates a new developer product with the provided configuration details.
7
11
  */
8
12
  export declare const postDeveloperProductsV2UniversesUniverseIdDeveloperProducts: import("../..").EndpointGeneric<{
9
13
  universeId: number;
@@ -31,13 +35,17 @@ export declare const postDeveloperProductsV2UniversesUniverseIdDeveloperProducts
31
35
  isRegionalPricingEnabled?: boolean | null | undefined;
32
36
  }>;
33
37
  /**
34
- * @api PATCH https://apis.roblox.com/cloud/developer-products/v2/universes/:universeId/developer-products/:productId
35
- * @summary Update developer product
38
+ * `BETA`
39
+ *
40
+ * Updates a developer product with the provided configuration details.
41
+ Note that only fields provided in the request will be updated.
42
+ *
43
+ * **Scopes:** `developer-product:write`
44
+ * **Engine:** Not available in-engine
45
+ *
36
46
  * @param body
37
47
  * @param universeId The universe ID.
38
48
  * @param productId The product ID of the developer product.
39
- * @description Updates a developer product with the provided configuration details.
40
- Note that only fields provided in the request will be updated.
41
49
  */
42
50
  export declare const patchDeveloperProductsV2UniversesUniverseIdDeveloperProductsProductId: import("../..").EndpointGeneric<{
43
51
  universeId: number;
@@ -52,8 +60,13 @@ export declare const patchDeveloperProductsV2UniversesUniverseIdDeveloperProduct
52
60
  storePageEnabled: boolean | null;
53
61
  }>;
54
62
  /**
55
- * @api GET https://apis.roblox.com/cloud/developer-products/v2/universes/:universeId/developer-products/:productId/creator
56
- * @summary Get developer product with configuration details
63
+ * `BETA`
64
+ *
65
+ * Get developer product with configuration details
66
+ *
67
+ * **Scopes:** `developer-product:read`
68
+ * **Engine:** Not available in-engine
69
+ *
57
70
  * @param universeId The universe ID.
58
71
  * @param productId The product ID of the developer product.
59
72
  */
@@ -77,8 +90,13 @@ export declare const getDeveloperProductsV2UniversesUniverseIdDeveloperProductsP
77
90
  updatedTimestamp: string;
78
91
  }, undefined>;
79
92
  /**
80
- * @api GET https://apis.roblox.com/cloud/developer-products/v2/universes/:universeId/developer-products/creator
81
- * @summary List developer products by universe with configuration details
93
+ * `BETA`
94
+ *
95
+ * List developer products by universe with configuration details
96
+ *
97
+ * **Scopes:** `developer-product:read`
98
+ * **Engine:** Not available in-engine
99
+ *
82
100
  * @param universeId The universe ID.
83
101
  * @param pageSize The number of results to return. Defaults to 50.
84
102
  * @param pageToken The cursor token for pagination.
@@ -83,16 +83,21 @@ const ListDeveloperProductConfigsV2Response = zod_1.z.object({
83
83
  nextPageToken: zod_1.z.string().nullable(),
84
84
  });
85
85
  /**
86
- * @api POST https://apis.roblox.com/cloud/developer-products/v2/universes/:universeId/developer-products
87
- * @summary Create developer product
86
+ * `BETA`
87
+ *
88
+ * Creates a new developer product with the provided configuration details.
89
+ *
90
+ * **Scopes:** `developer-product:write`
91
+ * **Engine:** Not available in-engine
92
+ *
88
93
  * @param body
89
94
  * @param universeId The universe ID.
90
- * @description Creates a new developer product with the provided configuration details.
91
95
  */
92
96
  exports.postDeveloperProductsV2UniversesUniverseIdDeveloperProducts = (0, __1.endpoint)({
93
97
  method: 'POST',
94
98
  path: '/developer-products/v2/universes/:universeId/developer-products',
95
- baseUrl: 'https://apis.roblox.com/cloud',
99
+ baseUrl: 'https://apis.roblox.com',
100
+ scopes: ['developer-product:write'],
96
101
  requestFormat: 'form-data',
97
102
  serializationMethod: {
98
103
  body: {},
@@ -123,18 +128,23 @@ exports.postDeveloperProductsV2UniversesUniverseIdDeveloperProducts = (0, __1.en
123
128
  ],
124
129
  });
125
130
  /**
126
- * @api PATCH https://apis.roblox.com/cloud/developer-products/v2/universes/:universeId/developer-products/:productId
127
- * @summary Update developer product
131
+ * `BETA`
132
+ *
133
+ * Updates a developer product with the provided configuration details.
134
+ Note that only fields provided in the request will be updated.
135
+ *
136
+ * **Scopes:** `developer-product:write`
137
+ * **Engine:** Not available in-engine
138
+ *
128
139
  * @param body
129
140
  * @param universeId The universe ID.
130
141
  * @param productId The product ID of the developer product.
131
- * @description Updates a developer product with the provided configuration details.
132
- Note that only fields provided in the request will be updated.
133
142
  */
134
143
  exports.patchDeveloperProductsV2UniversesUniverseIdDeveloperProductsProductId = (0, __1.endpoint)({
135
144
  method: 'PATCH',
136
145
  path: '/developer-products/v2/universes/:universeId/developer-products/:productId',
137
- baseUrl: 'https://apis.roblox.com/cloud',
146
+ baseUrl: 'https://apis.roblox.com',
147
+ scopes: ['developer-product:write'],
138
148
  requestFormat: 'form-data',
139
149
  serializationMethod: {
140
150
  body: {},
@@ -171,15 +181,21 @@ exports.patchDeveloperProductsV2UniversesUniverseIdDeveloperProductsProductId =
171
181
  ],
172
182
  });
173
183
  /**
174
- * @api GET https://apis.roblox.com/cloud/developer-products/v2/universes/:universeId/developer-products/:productId/creator
175
- * @summary Get developer product with configuration details
184
+ * `BETA`
185
+ *
186
+ * Get developer product with configuration details
187
+ *
188
+ * **Scopes:** `developer-product:read`
189
+ * **Engine:** Not available in-engine
190
+ *
176
191
  * @param universeId The universe ID.
177
192
  * @param productId The product ID of the developer product.
178
193
  */
179
194
  exports.getDeveloperProductsV2UniversesUniverseIdDeveloperProductsProductIdCreator = (0, __1.endpoint)({
180
195
  method: 'GET',
181
196
  path: '/developer-products/v2/universes/:universeId/developer-products/:productId/creator',
182
- baseUrl: 'https://apis.roblox.com/cloud',
197
+ baseUrl: 'https://apis.roblox.com',
198
+ scopes: ['developer-product:read'],
183
199
  requestFormat: 'json',
184
200
  serializationMethod: {
185
201
  universeId: {},
@@ -206,8 +222,13 @@ exports.getDeveloperProductsV2UniversesUniverseIdDeveloperProductsProductIdCreat
206
222
  ],
207
223
  });
208
224
  /**
209
- * @api GET https://apis.roblox.com/cloud/developer-products/v2/universes/:universeId/developer-products/creator
210
- * @summary List developer products by universe with configuration details
225
+ * `BETA`
226
+ *
227
+ * List developer products by universe with configuration details
228
+ *
229
+ * **Scopes:** `developer-product:read`
230
+ * **Engine:** Not available in-engine
231
+ *
211
232
  * @param universeId The universe ID.
212
233
  * @param pageSize The number of results to return. Defaults to 50.
213
234
  * @param pageToken The cursor token for pagination.
@@ -215,7 +236,8 @@ exports.getDeveloperProductsV2UniversesUniverseIdDeveloperProductsProductIdCreat
215
236
  exports.getDeveloperProductsV2UniversesUniverseIdDeveloperProductsCreator = (0, __1.endpoint)({
216
237
  method: 'GET',
217
238
  path: '/developer-products/v2/universes/:universeId/developer-products/creator',
218
- baseUrl: 'https://apis.roblox.com/cloud',
239
+ baseUrl: 'https://apis.roblox.com',
240
+ scopes: ['developer-product:read'],
219
241
  requestFormat: 'json',
220
242
  serializationMethod: {
221
243
  universeId: {},
@@ -1,9 +1,13 @@
1
1
  /**
2
- * @api POST https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes
3
- * @summary Create game pass
2
+ * `BETA`
3
+ *
4
+ * Creates a new game pass with the provided configuration details.
5
+ *
6
+ * **Scopes:** `game-pass:write`
7
+ * **Engine:** Not available in-engine
8
+ *
4
9
  * @param body
5
10
  * @param universeId The universe ID.
6
- * @description Creates a new game pass with the provided configuration details.
7
11
  */
8
12
  export declare const postGamePassesV1UniversesUniverseIdGamePasses: import("../..").EndpointGeneric<{
9
13
  universeId: number;
@@ -28,13 +32,17 @@ export declare const postGamePassesV1UniversesUniverseIdGamePasses: import("../.
28
32
  isRegionalPricingEnabled?: boolean | null | undefined;
29
33
  }>;
30
34
  /**
31
- * @api PATCH https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes/:gamePassId
32
- * @summary Update game pass
35
+ * `BETA`
36
+ *
37
+ * Updates a game pass with the provided configuration details.
38
+ Note that only fields provided in the request will be updated.
39
+ *
40
+ * **Scopes:** `game-pass:write`
41
+ * **Engine:** Not available in-engine
42
+ *
33
43
  * @param body
34
44
  * @param universeId The universe ID.
35
45
  * @param gamePassId The game pass ID.
36
- * @description Updates a game pass with the provided configuration details.
37
- Note that only fields provided in the request will be updated.
38
46
  */
39
47
  export declare const patchGamePassesV1UniversesUniverseIdGamePassesGamePassId: import("../..").EndpointGeneric<{
40
48
  universeId: number;
@@ -48,8 +56,13 @@ export declare const patchGamePassesV1UniversesUniverseIdGamePassesGamePassId: i
48
56
  isRegionalPricingEnabled: boolean | null;
49
57
  }>;
50
58
  /**
51
- * @api GET https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes/:gamePassId/creator
52
- * @summary Get game pass with configuration details
59
+ * `BETA`
60
+ *
61
+ * Get game pass with configuration details
62
+ *
63
+ * **Scopes:** `game-pass:read`
64
+ * **Engine:** Not available in-engine
65
+ *
53
66
  * @param universeId The universe ID.
54
67
  * @param gamePassId The game pass ID.
55
68
  */
@@ -70,8 +83,13 @@ export declare const getGamePassesV1UniversesUniverseIdGamePassesGamePassIdCreat
70
83
  } | null;
71
84
  }, undefined>;
72
85
  /**
73
- * @api GET https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes/creator
74
- * @summary List game passes by universe with configuration details
86
+ * `BETA`
87
+ *
88
+ * List game passes by universe with configuration details
89
+ *
90
+ * **Scopes:** `game-pass:read`
91
+ * **Engine:** Not available in-engine
92
+ *
75
93
  * @param universeId The universe ID.
76
94
  * @param pageSize The number of results to return. Defaults to 50 if not provided.
77
95
  * @param pageToken The cursor token for pagination.
@@ -70,16 +70,21 @@ const ListGamePassConfigsByUniverseResponse = zod_1.z.object({
70
70
  nextPageToken: zod_1.z.string().nullable(),
71
71
  });
72
72
  /**
73
- * @api POST https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes
74
- * @summary Create game pass
73
+ * `BETA`
74
+ *
75
+ * Creates a new game pass with the provided configuration details.
76
+ *
77
+ * **Scopes:** `game-pass:write`
78
+ * **Engine:** Not available in-engine
79
+ *
75
80
  * @param body
76
81
  * @param universeId The universe ID.
77
- * @description Creates a new game pass with the provided configuration details.
78
82
  */
79
83
  exports.postGamePassesV1UniversesUniverseIdGamePasses = (0, __1.endpoint)({
80
84
  method: 'POST',
81
85
  path: '/game-passes/v1/universes/:universeId/game-passes',
82
- baseUrl: 'https://apis.roblox.com/cloud',
86
+ baseUrl: 'https://apis.roblox.com',
87
+ scopes: ['game-pass:write'],
83
88
  requestFormat: 'form-data',
84
89
  serializationMethod: {
85
90
  body: {},
@@ -110,18 +115,23 @@ exports.postGamePassesV1UniversesUniverseIdGamePasses = (0, __1.endpoint)({
110
115
  ],
111
116
  });
112
117
  /**
113
- * @api PATCH https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes/:gamePassId
114
- * @summary Update game pass
118
+ * `BETA`
119
+ *
120
+ * Updates a game pass with the provided configuration details.
121
+ Note that only fields provided in the request will be updated.
122
+ *
123
+ * **Scopes:** `game-pass:write`
124
+ * **Engine:** Not available in-engine
125
+ *
115
126
  * @param body
116
127
  * @param universeId The universe ID.
117
128
  * @param gamePassId The game pass ID.
118
- * @description Updates a game pass with the provided configuration details.
119
- Note that only fields provided in the request will be updated.
120
129
  */
121
130
  exports.patchGamePassesV1UniversesUniverseIdGamePassesGamePassId = (0, __1.endpoint)({
122
131
  method: 'PATCH',
123
132
  path: '/game-passes/v1/universes/:universeId/game-passes/:gamePassId',
124
- baseUrl: 'https://apis.roblox.com/cloud',
133
+ baseUrl: 'https://apis.roblox.com',
134
+ scopes: ['game-pass:write'],
125
135
  requestFormat: 'form-data',
126
136
  serializationMethod: {
127
137
  body: {},
@@ -158,15 +168,21 @@ exports.patchGamePassesV1UniversesUniverseIdGamePassesGamePassId = (0, __1.endpo
158
168
  ],
159
169
  });
160
170
  /**
161
- * @api GET https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes/:gamePassId/creator
162
- * @summary Get game pass with configuration details
171
+ * `BETA`
172
+ *
173
+ * Get game pass with configuration details
174
+ *
175
+ * **Scopes:** `game-pass:read`
176
+ * **Engine:** Not available in-engine
177
+ *
163
178
  * @param universeId The universe ID.
164
179
  * @param gamePassId The game pass ID.
165
180
  */
166
181
  exports.getGamePassesV1UniversesUniverseIdGamePassesGamePassIdCreator = (0, __1.endpoint)({
167
182
  method: 'GET',
168
183
  path: '/game-passes/v1/universes/:universeId/game-passes/:gamePassId/creator',
169
- baseUrl: 'https://apis.roblox.com/cloud',
184
+ baseUrl: 'https://apis.roblox.com',
185
+ scopes: ['game-pass:read'],
170
186
  requestFormat: 'json',
171
187
  serializationMethod: {
172
188
  universeId: {},
@@ -193,8 +209,13 @@ exports.getGamePassesV1UniversesUniverseIdGamePassesGamePassIdCreator = (0, __1.
193
209
  ],
194
210
  });
195
211
  /**
196
- * @api GET https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes/creator
197
- * @summary List game passes by universe with configuration details
212
+ * `BETA`
213
+ *
214
+ * List game passes by universe with configuration details
215
+ *
216
+ * **Scopes:** `game-pass:read`
217
+ * **Engine:** Not available in-engine
218
+ *
198
219
  * @param universeId The universe ID.
199
220
  * @param pageSize The number of results to return. Defaults to 50 if not provided.
200
221
  * @param pageToken The cursor token for pagination.
@@ -202,7 +223,8 @@ exports.getGamePassesV1UniversesUniverseIdGamePassesGamePassIdCreator = (0, __1.
202
223
  exports.getGamePassesV1UniversesUniverseIdGamePassesCreator = (0, __1.endpoint)({
203
224
  method: 'GET',
204
225
  path: '/game-passes/v1/universes/:universeId/game-passes/creator',
205
- baseUrl: 'https://apis.roblox.com/cloud',
226
+ baseUrl: 'https://apis.roblox.com',
227
+ scopes: ['game-pass:read'],
206
228
  requestFormat: 'json',
207
229
  serializationMethod: {
208
230
  universeId: {},