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.
Files changed (87) hide show
  1. package/lib/endpoints/accountsettingsv1.d.ts +27 -33
  2. package/lib/endpoints/accountsettingsv1.js +11 -22
  3. package/lib/endpoints/adconfigurationv2.d.ts +104 -119
  4. package/lib/endpoints/adconfigurationv2.js +32 -48
  5. package/lib/endpoints/assetdeliveryv1.d.ts +25 -24
  6. package/lib/endpoints/assetdeliveryv1.js +25 -24
  7. package/lib/endpoints/assetdeliveryv2.d.ts +25 -24
  8. package/lib/endpoints/assetdeliveryv2.js +25 -24
  9. package/lib/endpoints/authv1.d.ts +132 -84
  10. package/lib/endpoints/authv1.js +118 -64
  11. package/lib/endpoints/authv2.d.ts +56 -56
  12. package/lib/endpoints/authv2.js +57 -50
  13. package/lib/endpoints/authv3.d.ts +11 -11
  14. package/lib/endpoints/authv3.js +11 -11
  15. package/lib/endpoints/avatarv1.d.ts +1 -0
  16. package/lib/endpoints/avatarv1.js +1 -0
  17. package/lib/endpoints/avatarv2.d.ts +1 -0
  18. package/lib/endpoints/avatarv2.js +1 -0
  19. package/lib/endpoints/avatarv3.d.ts +1 -0
  20. package/lib/endpoints/avatarv3.js +1 -0
  21. package/lib/endpoints/badgesv1.d.ts +6 -22
  22. package/lib/endpoints/badgesv1.js +2 -22
  23. package/lib/endpoints/catalogv1.d.ts +39 -113
  24. package/lib/endpoints/catalogv1.js +39 -107
  25. package/lib/endpoints/catalogv2.d.ts +11 -11
  26. package/lib/endpoints/catalogv2.js +11 -11
  27. package/lib/endpoints/clientsettingsv2.d.ts +8 -7
  28. package/lib/endpoints/clientsettingsv2.js +9 -1
  29. package/lib/endpoints/developv1.d.ts +31 -31
  30. package/lib/endpoints/developv1.js +26 -26
  31. package/lib/endpoints/developv2.d.ts +27 -27
  32. package/lib/endpoints/developv2.js +22 -22
  33. package/lib/endpoints/economycreatorstatsv1.d.ts +1 -1
  34. package/lib/endpoints/economycreatorstatsv1.js +1 -1
  35. package/lib/endpoints/followingsv2.d.ts +2 -2
  36. package/lib/endpoints/followingsv2.js +2 -2
  37. package/lib/endpoints/friendsv1.d.ts +24 -98
  38. package/lib/endpoints/friendsv1.js +25 -91
  39. package/lib/endpoints/gamesv1.d.ts +31 -615
  40. package/lib/endpoints/gamesv1.js +32 -608
  41. package/lib/endpoints/gamesv2.d.ts +187 -260
  42. package/lib/endpoints/gamesv2.js +130 -190
  43. package/lib/endpoints/groupsv1.d.ts +34 -28
  44. package/lib/endpoints/groupsv1.js +31 -18
  45. package/lib/endpoints/groupsv2.d.ts +92 -92
  46. package/lib/endpoints/groupsv2.js +93 -87
  47. package/lib/endpoints/inventoryv1.d.ts +9 -21
  48. package/lib/endpoints/inventoryv1.js +4 -4
  49. package/lib/endpoints/inventoryv2.d.ts +91 -91
  50. package/lib/endpoints/inventoryv2.js +86 -86
  51. package/lib/endpoints/itemconfigurationv1.d.ts +1 -1
  52. package/lib/endpoints/itemconfigurationv1.js +1 -1
  53. package/lib/endpoints/thumbnailsv1.d.ts +1 -0
  54. package/lib/endpoints/thumbnailsv1.js +1 -0
  55. package/lib/endpoints/tradesv1.d.ts +10 -16
  56. package/lib/endpoints/tradesv1.js +10 -10
  57. package/lib/endpoints/twostepverificationv1.d.ts +59 -59
  58. package/lib/endpoints/twostepverificationv1.js +59 -59
  59. package/lib/endpoints/usersv1.d.ts +1 -1
  60. package/lib/endpoints/usersv1.js +1 -1
  61. package/lib/index.d.ts +1 -0
  62. package/lib/index.js +29 -3
  63. package/lib/opencloud/v1/asset-permissions.d.ts +7 -2
  64. package/lib/opencloud/v1/asset-permissions.js +9 -3
  65. package/lib/opencloud/v1/assets.d.ts +59 -32
  66. package/lib/opencloud/v1/assets.js +77 -41
  67. package/lib/opencloud/v1/datastores-ordered.d.ts +50 -14
  68. package/lib/opencloud/v1/datastores-ordered.js +62 -20
  69. package/lib/opencloud/v1/datastores.d.ts +99 -42
  70. package/lib/opencloud/v1/datastores.js +123 -50
  71. package/lib/opencloud/v1/developer-products.d.ts +29 -11
  72. package/lib/opencloud/v1/developer-products.js +37 -15
  73. package/lib/opencloud/v1/game-passes.d.ts +29 -11
  74. package/lib/opencloud/v1/game-passes.js +37 -15
  75. package/lib/opencloud/v1/messaging.d.ts +6 -2
  76. package/lib/opencloud/v1/messaging.js +8 -3
  77. package/lib/opencloud/v1/open-eval.d.ts +14 -4
  78. package/lib/opencloud/v1/open-eval.js +18 -6
  79. package/lib/opencloud/v1/secrets-store.d.ts +46 -26
  80. package/lib/opencloud/v1/secrets-store.js +56 -31
  81. package/lib/opencloud/v1/toolbox.d.ts +14 -6
  82. package/lib/opencloud/v1/toolbox.js +18 -8
  83. package/lib/opencloud/v1/universes.d.ts +6 -2
  84. package/lib/opencloud/v1/universes.js +8 -3
  85. package/lib/opencloud/v2/cloud.d.ts +854 -395
  86. package/lib/opencloud/v2/cloud.js +967 -395
  87. package/package.json +1 -1
@@ -50,19 +50,23 @@ const AssetVersion = zod_1.z.object({
50
50
  published: zod_1.z.boolean(),
51
51
  });
52
52
  /**
53
- * @api POST https://apis.roblox.com/cloud/v1/assets
54
- * @summary Creates an asset with provided content and metadata.
55
- * @param body
56
- * @description Creates an asset with provided content and metadata.
53
+ * **Create Asset** · `BETA`
54
+ *
55
+ * Creates an asset with provided content and metadata.
57
56
 
58
57
  You can't add [SocialLink](#SocialLink) objects when you create an asset. Instead, use [Update Asset](#PATCH-v1-assets-_assetId_).
59
58
 
60
59
  Provide the [Asset](#Asset), binary asset file path, and [content type](/cloud/guides/usage-assets.md#supported-asset-types-and-limits) in the form data.
60
+ *
61
+ * **Scopes:** `asset:read`, `asset:write`
62
+ *
63
+ * @param body
61
64
  */
62
65
  exports.postAssets = (0, __1.endpoint)({
63
66
  method: 'POST',
64
67
  path: '/v1/assets',
65
- baseUrl: 'https://apis.roblox.com/cloud',
68
+ baseUrl: 'https://apis.roblox.com/assets',
69
+ scopes: ['asset:read', 'asset:write'],
66
70
  requestFormat: 'form-data',
67
71
  serializationMethod: {
68
72
  body: {},
@@ -86,16 +90,20 @@ exports.postAssets = (0, __1.endpoint)({
86
90
  ],
87
91
  });
88
92
  /**
89
- * @api GET https://apis.roblox.com/cloud/v1/assets/:assetId
90
- * @summary Retrieve specific asset metadata. Include the `readMask` parameter for additional asset metadata.
93
+ * **Get Asset** · `BETA`
94
+ *
95
+ * Retrieve specific asset metadata.
96
+ *
97
+ * **Scopes:** `asset:read`
98
+ *
91
99
  * @param assetId The unique identifier of the asset.
92
100
  * @param readMask Asset metadata fields to retrieve, including the description, display name, icon, social links, and previews. Examples: `description%2CdisplayName`, `previews%2CtwitchSocialLink`.
93
- * @description Retrieve specific asset metadata.
94
101
  */
95
102
  exports.getAssetsAssetId = (0, __1.endpoint)({
96
103
  method: 'GET',
97
104
  path: '/v1/assets/:assetId',
98
- baseUrl: 'https://apis.roblox.com/cloud',
105
+ baseUrl: 'https://apis.roblox.com/assets',
106
+ scopes: ['asset:read'],
99
107
  requestFormat: 'json',
100
108
  serializationMethod: {
101
109
  assetId: {},
@@ -130,19 +138,23 @@ exports.getAssetsAssetId = (0, __1.endpoint)({
130
138
  ],
131
139
  });
132
140
  /**
133
- * @api PATCH https://apis.roblox.com/cloud/v1/assets/:assetId
134
- * @summary Updates an asset with provided content and metadata.
141
+ * **Update Asset** · `BETA`
142
+ *
143
+ * Updates an asset with provided content and metadata, including the description, display name, icon, social links, and previews. Currently can only update the content body for **Models**. Icons and Previews must be **Image** assets. Icons must have square dimensions.
144
+
145
+ Provide the [Asset](#Asset), binary asset file path, and [content type](/cloud/guides/usage-assets.md#supported-asset-types-and-limits) in the form data.
146
+ *
147
+ * **Scopes:** `asset:read`, `asset:write`
148
+ *
135
149
  * @param body
136
150
  * @param assetId The unique identifier of the asset.
137
151
  * @param updateMask Asset metadata fields to update, including the description, display name, icon, and previews. Examples: `description%2CdisplayName`, `previews%2CtwitchSocialLink`.
138
- * @description Updates an asset with provided content and metadata, including the description, display name, icon, social links, and previews. Currently can only update the content body for **Models**. Icons and Previews must be **Image** assets. Icons must have square dimensions.
139
-
140
- Provide the [Asset](#Asset), binary asset file path, and [content type](/cloud/guides/usage-assets.md#supported-asset-types-and-limits) in the form data.
141
152
  */
142
153
  exports.patchAssetsAssetId = (0, __1.endpoint)({
143
154
  method: 'PATCH',
144
155
  path: '/v1/assets/:assetId',
145
- baseUrl: 'https://apis.roblox.com/cloud',
156
+ baseUrl: 'https://apis.roblox.com/assets',
157
+ scopes: ['asset:read', 'asset:write'],
146
158
  requestFormat: 'form-data',
147
159
  serializationMethod: {
148
160
  body: {},
@@ -171,15 +183,19 @@ exports.patchAssetsAssetId = (0, __1.endpoint)({
171
183
  ],
172
184
  });
173
185
  /**
174
- * @api POST https://apis.roblox.com/cloud/v1/assets/:assetId:archive
175
- * @summary Archives the asset.
186
+ * **Archive Asset** · `BETA`
187
+ *
188
+ * Archives the asset. Archived assets disappear from the website and are no longer usable or visible in Roblox experiences, but you can [restore](#POST-v1-assets-{assetId}:restore) them.
189
+ *
190
+ * **Scopes:** `asset:read`, `asset:write`
191
+ *
176
192
  * @param assetId The unique identifier of the asset.
177
- * @description Archives the asset. Archived assets disappear from the website and are no longer usable or visible in Roblox experiences, but you can [restore](#POST-v1-assets-{assetId}:restore) them.
178
193
  */
179
194
  exports.postAssetsAssetIdArchive = (0, __1.endpoint)({
180
195
  method: 'POST',
181
196
  path: '/v1/assets/:assetId:archive',
182
- baseUrl: 'https://apis.roblox.com/cloud',
197
+ baseUrl: 'https://apis.roblox.com/assets',
198
+ scopes: ['asset:read', 'asset:write'],
183
199
  requestFormat: 'json',
184
200
  serializationMethod: {
185
201
  assetId: {},
@@ -204,15 +220,19 @@ exports.postAssetsAssetIdArchive = (0, __1.endpoint)({
204
220
  ],
205
221
  });
206
222
  /**
207
- * @api POST https://apis.roblox.com/cloud/v1/assets/:assetId:restore
208
- * @summary Restores an archived asset.
223
+ * **Restore Asset** · `BETA`
224
+ *
225
+ * Restores an archived asset.
226
+ *
227
+ * **Scopes:** `asset:read`, `asset:write`
228
+ *
209
229
  * @param assetId The unique identifier of the asset.
210
- * @description Restores an archived asset.
211
230
  */
212
231
  exports.postAssetsAssetIdRestore = (0, __1.endpoint)({
213
232
  method: 'POST',
214
233
  path: '/v1/assets/:assetId:restore',
215
- baseUrl: 'https://apis.roblox.com/cloud',
234
+ baseUrl: 'https://apis.roblox.com/assets',
235
+ scopes: ['asset:read', 'asset:write'],
216
236
  requestFormat: 'json',
217
237
  serializationMethod: {
218
238
  assetId: {},
@@ -237,17 +257,21 @@ exports.postAssetsAssetIdRestore = (0, __1.endpoint)({
237
257
  ],
238
258
  });
239
259
  /**
240
- * @api GET https://apis.roblox.com/cloud/v1/assets/:assetId/versions
241
- * @summary List Asset Versions of an Asset
260
+ * **List Asset Versions** · `BETA`
261
+ *
262
+ * List all versions of a specific asset, with optional pagination.
263
+ *
264
+ * **Scopes:** `asset:read`
265
+ *
242
266
  * @param assetId The unique identifier of the asset.
243
267
  * @param maxPageSize Specifies the number of asset versions to include in the response. Valid values range from 1 to 50 (inclusive). Defaults to 8 when not provided.
244
268
  * @param pageToken A token for pagination. The value is obtained from a previous request and allows for retrieving the next page of asset versions.
245
- * @description List all versions of a specific asset, with optional pagination.
246
269
  */
247
270
  exports.getAssetsAssetIdVersions = (0, __1.endpoint)({
248
271
  method: 'GET',
249
272
  path: '/v1/assets/:assetId/versions',
250
- baseUrl: 'https://apis.roblox.com/cloud',
273
+ baseUrl: 'https://apis.roblox.com/assets',
274
+ scopes: ['asset:read'],
251
275
  requestFormat: 'json',
252
276
  serializationMethod: {
253
277
  assetId: {},
@@ -276,18 +300,22 @@ exports.getAssetsAssetIdVersions = (0, __1.endpoint)({
276
300
  ],
277
301
  });
278
302
  /**
279
- * @api POST https://apis.roblox.com/cloud/v1/assets/:assetId/versions:rollback
280
- * @summary Rollback an asset to a previous version.
281
- * @param body
282
- * @param assetId The unique identifier of the asset.
283
- * @description Rollback an asset to a specific previous version.
303
+ * **Rollback Asset Version** · `BETA`
304
+ *
305
+ * Rollback an asset to a specific previous version.
284
306
 
285
307
  Provide the asset version path in the form data.
308
+ *
309
+ * **Scopes:** `asset:read`, `asset:write`
310
+ *
311
+ * @param body
312
+ * @param assetId The unique identifier of the asset.
286
313
  */
287
314
  exports.postAssetsAssetIdVersionsRollback = (0, __1.endpoint)({
288
315
  method: 'POST',
289
316
  path: '/v1/assets/:assetId/versions:rollback',
290
- baseUrl: 'https://apis.roblox.com/cloud',
317
+ baseUrl: 'https://apis.roblox.com/assets',
318
+ scopes: ['asset:read', 'asset:write'],
291
319
  requestFormat: 'form-data',
292
320
  serializationMethod: {
293
321
  body: {},
@@ -314,16 +342,20 @@ exports.postAssetsAssetIdVersionsRollback = (0, __1.endpoint)({
314
342
  ],
315
343
  });
316
344
  /**
317
- * @api GET https://apis.roblox.com/cloud/v1/assets/:assetId/versions/:versionNumber
318
- * @summary Get Asset Version
345
+ * **Get Asset Version** · `BETA`
346
+ *
347
+ * Retrieve a specific asset version by the asset ID and the version number.
348
+ *
349
+ * **Scopes:** `asset:read`
350
+ *
319
351
  * @param assetId The unique identifier of the asset.
320
352
  * @param versionNumber The version number.
321
- * @description Retrieve a specific asset version by the asset ID and the version number.
322
353
  */
323
354
  exports.getAssetsAssetIdVersionsVersionNumber = (0, __1.endpoint)({
324
355
  method: 'GET',
325
356
  path: '/v1/assets/:assetId/versions/:versionNumber',
326
- baseUrl: 'https://apis.roblox.com/cloud',
357
+ baseUrl: 'https://apis.roblox.com/assets',
358
+ scopes: ['asset:read'],
327
359
  requestFormat: 'json',
328
360
  serializationMethod: {
329
361
  assetId: {},
@@ -346,15 +378,19 @@ exports.getAssetsAssetIdVersionsVersionNumber = (0, __1.endpoint)({
346
378
  ],
347
379
  });
348
380
  /**
349
- * @api GET https://apis.roblox.com/cloud/v1/operations/:operationId
350
- * @summary Get the result of an asset creation or update.
381
+ * **Get Operation** · `BETA`
382
+ *
383
+ * Get the result of an asset creation or update using the returned Operation ID. Requires **Read** for the API key permission and **asset:read** for OAuth 2.0 apps.
384
+ *
385
+ * **Scopes:** `asset:read`
386
+ *
351
387
  * @param operationId The unique identifier of the operation.
352
- * @description Get the result of an asset creation or update using the returned Operation ID. Requires **Read** for the API key permission and **asset:read** for OAuth 2.0 apps.
353
388
  */
354
389
  exports.getOperationsOperationId = (0, __1.endpoint)({
355
390
  method: 'GET',
356
391
  path: '/v1/operations/:operationId',
357
- baseUrl: 'https://apis.roblox.com/cloud',
392
+ baseUrl: 'https://apis.roblox.com/assets',
393
+ scopes: ['asset:read'],
358
394
  requestFormat: 'json',
359
395
  serializationMethod: {
360
396
  operationId: {},
@@ -1,5 +1,10 @@
1
1
  /**
2
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries
2
+ * **List** · `BETA`
3
+ *
4
+ * Returns a list of entries from an ordered data store.
5
+ *
6
+ * **Scopes:** `universe.ordered-data-store.scope.entry:read`
7
+ *
3
8
  * @param universeId The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
4
9
  * @param orderedDataStore The name of the target ordered data store.
5
10
  * @param scope The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).
@@ -7,7 +12,8 @@
7
12
  * @param page_token A page token received from a previous `List` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `List` must match the call providing the page token.
8
13
  * @param order_by The enumeration direction. The order by default is ascending. Input a `desc` suffix for descending.
9
14
  * @param filter The range of qualifying values of entries to return. See [Filters](/cloud/guides/data-stores/request-handling.md#filters).
10
- * @description Returns a list of entries from an ordered data store.
15
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries
16
+ * @deprecated Prefer the v2 alternative(s) listed above.
11
17
  */
12
18
  export declare const getUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntries: import("../..").EndpointGeneric<{
13
19
  universeId: string;
@@ -26,13 +32,19 @@ export declare const getUniversesUniverseIdOrderedDataStoresOrderedDataStoreScop
26
32
  nextPageToken: string;
27
33
  }, undefined>;
28
34
  /**
29
- * @api POST https://apis.roblox.com/cloud/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries
35
+ * **Create** · `BETA`
36
+ *
37
+ * Creates a new entry with the content value provided.
38
+ *
39
+ * **Scopes:** `universe.ordered-data-store.scope.entry:write`
40
+ *
30
41
  * @param body
31
42
  * @param universeId The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
32
43
  * @param orderedDataStore The name of the ordered data store.
33
44
  * @param scope The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).
34
45
  * @param id The name of the entry.
35
- * @description Creates a new entry with the content value provided.
46
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries
47
+ * @deprecated Prefer the v2 alternative(s) listed above.
36
48
  */
37
49
  export declare const postUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntries: import("../..").EndpointGeneric<{
38
50
  id: string;
@@ -47,12 +59,18 @@ export declare const postUniversesUniverseIdOrderedDataStoresOrderedDataStoreSco
47
59
  value: number;
48
60
  }>;
49
61
  /**
50
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries/:entry
62
+ * **Get** · `BETA`
63
+ *
64
+ * Gets and returns the specified entry.
65
+ *
66
+ * **Scopes:** `universe.ordered-data-store.scope.entry:read`
67
+ *
51
68
  * @param universeId The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
52
69
  * @param orderedDataStore The name of the ordered data store.
53
70
  * @param scope The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).
54
71
  * @param entry The entry ID.
55
- * @description Gets and returns the specified entry.
72
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
73
+ * @deprecated Prefer the v2 alternative(s) listed above.
56
74
  */
57
75
  export declare const getUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntriesEntry: import("../..").EndpointGeneric<{
58
76
  universeId: string;
@@ -65,12 +83,18 @@ export declare const getUniversesUniverseIdOrderedDataStoresOrderedDataStoreScop
65
83
  value: number;
66
84
  }, undefined>;
67
85
  /**
68
- * @api DELETE https://apis.roblox.com/cloud/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries/:entry
86
+ * **Delete** · `BETA`
87
+ *
88
+ * Deletes the specified entry. Unlike standard data stores, which mark entries for deletion, ordered data store entries are deleted immediately.
89
+ *
90
+ * **Scopes:** `universe.ordered-data-store.scope.entry:write`
91
+ *
69
92
  * @param universeId The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
70
93
  * @param orderedDataStore The name of the ordered data store.
71
94
  * @param scope The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).
72
95
  * @param entry The entry ID.
73
- * @description Deletes the specified entry. Unlike standard data stores, which mark entries for deletion, ordered data store entries are deleted immediately.
96
+ * @see DELETE https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
97
+ * @deprecated Prefer the v2 alternative(s) listed above.
74
98
  */
75
99
  export declare const deleteUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntriesEntry: import("../..").EndpointGeneric<{
76
100
  universeId: string;
@@ -79,14 +103,20 @@ export declare const deleteUniversesUniverseIdOrderedDataStoresOrderedDataStoreS
79
103
  entry: string;
80
104
  }, void, undefined>;
81
105
  /**
82
- * @api PATCH https://apis.roblox.com/cloud/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries/:entry
106
+ * **Update** · `BETA`
107
+ *
108
+ * Updates an entry value and returns the updated entry.
109
+ *
110
+ * **Scopes:** `universe.ordered-data-store.scope.entry:write`
111
+ *
83
112
  * @param body
84
113
  * @param universeId The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
85
114
  * @param orderedDataStore The name of the ordered data store.
86
115
  * @param scope The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).
87
116
  * @param entry The entry ID.
88
117
  * @param allow_missing The flag to allow the creation of an entry if the entry doesn't exist. See [Allow missing flags](/cloud/guides/data-stores/request-handling.md.md#allow-missing-flags).
89
- * @description Updates an entry value and returns the updated entry.
118
+ * @see PATCH https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
119
+ * @deprecated Prefer the v2 alternative(s) listed above.
90
120
  */
91
121
  export declare const patchUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntriesEntry: import("../..").EndpointGeneric<{
92
122
  universeId: string;
@@ -102,15 +132,21 @@ export declare const patchUniversesUniverseIdOrderedDataStoresOrderedDataStoreSc
102
132
  value: number;
103
133
  }>;
104
134
  /**
105
- * @api POST https://apis.roblox.com/cloud/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries/:entry:increment
135
+ * **Increment** · `BETA`
136
+ *
137
+ * Increments the value of the key by the provided amount and returns the updated entry.
138
+
139
+ Known issue: Entry values can increment past the valid range and this may persist in the backend. Returned values will clamp to the valid range.
140
+ *
141
+ * **Scopes:** `universe.ordered-data-store.scope.entry:write`
142
+ *
106
143
  * @param body
107
144
  * @param universeId The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
108
145
  * @param orderedDataStore The name of the ordered data store.
109
146
  * @param scope The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).
110
147
  * @param entry The entry ID.
111
- * @description Increments the value of the key by the provided amount and returns the updated entry.
112
-
113
- Known issue: Entry values can increment past the valid range and this may persist in the backend. Returned values will clamp to the valid range.
148
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment
149
+ * @deprecated Prefer the v2 alternative(s) listed above.
114
150
  */
115
151
  export declare const postUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntriesEntryIncrement: import("../..").EndpointGeneric<{
116
152
  universeId: string;
@@ -16,7 +16,12 @@ const CreateEntryRequest = zod_1.z.object({ value: zod_1.z.number().int() });
16
16
  const UpdateEntryRequest = zod_1.z.object({ value: zod_1.z.number().int() });
17
17
  const IncrementEntryRequest = zod_1.z.object({ amount: zod_1.z.number().int() });
18
18
  /**
19
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries
19
+ * **List** · `BETA`
20
+ *
21
+ * Returns a list of entries from an ordered data store.
22
+ *
23
+ * **Scopes:** `universe.ordered-data-store.scope.entry:read`
24
+ *
20
25
  * @param universeId The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
21
26
  * @param orderedDataStore The name of the target ordered data store.
22
27
  * @param scope The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).
@@ -24,12 +29,14 @@ const IncrementEntryRequest = zod_1.z.object({ amount: zod_1.z.number().int() })
24
29
  * @param page_token A page token received from a previous `List` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `List` must match the call providing the page token.
25
30
  * @param order_by The enumeration direction. The order by default is ascending. Input a `desc` suffix for descending.
26
31
  * @param filter The range of qualifying values of entries to return. See [Filters](/cloud/guides/data-stores/request-handling.md#filters).
27
- * @description Returns a list of entries from an ordered data store.
32
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries
33
+ * @deprecated Prefer the v2 alternative(s) listed above.
28
34
  */
29
35
  exports.getUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntries = (0, __1.endpoint)({
30
36
  method: 'GET',
31
37
  path: '/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries',
32
- baseUrl: 'https://apis.roblox.com/cloud',
38
+ baseUrl: 'https://apis.roblox.com/ordered-data-stores',
39
+ scopes: ['universe.ordered-data-store.scope.entry:read'],
33
40
  requestFormat: 'json',
34
41
  serializationMethod: {
35
42
  universeId: {},
@@ -66,18 +73,25 @@ exports.getUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntrie
66
73
  ],
67
74
  });
68
75
  /**
69
- * @api POST https://apis.roblox.com/cloud/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries
76
+ * **Create** · `BETA`
77
+ *
78
+ * Creates a new entry with the content value provided.
79
+ *
80
+ * **Scopes:** `universe.ordered-data-store.scope.entry:write`
81
+ *
70
82
  * @param body
71
83
  * @param universeId The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
72
84
  * @param orderedDataStore The name of the ordered data store.
73
85
  * @param scope The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).
74
86
  * @param id The name of the entry.
75
- * @description Creates a new entry with the content value provided.
87
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries
88
+ * @deprecated Prefer the v2 alternative(s) listed above.
76
89
  */
77
90
  exports.postUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntries = (0, __1.endpoint)({
78
91
  method: 'POST',
79
92
  path: '/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries',
80
- baseUrl: 'https://apis.roblox.com/cloud',
93
+ baseUrl: 'https://apis.roblox.com/ordered-data-stores',
94
+ scopes: ['universe.ordered-data-store.scope.entry:write'],
81
95
  requestFormat: 'json',
82
96
  serializationMethod: {
83
97
  body: {},
@@ -114,17 +128,24 @@ exports.postUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntri
114
128
  ],
115
129
  });
116
130
  /**
117
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries/:entry
131
+ * **Get** · `BETA`
132
+ *
133
+ * Gets and returns the specified entry.
134
+ *
135
+ * **Scopes:** `universe.ordered-data-store.scope.entry:read`
136
+ *
118
137
  * @param universeId The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
119
138
  * @param orderedDataStore The name of the ordered data store.
120
139
  * @param scope The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).
121
140
  * @param entry The entry ID.
122
- * @description Gets and returns the specified entry.
141
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
142
+ * @deprecated Prefer the v2 alternative(s) listed above.
123
143
  */
124
144
  exports.getUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntriesEntry = (0, __1.endpoint)({
125
145
  method: 'GET',
126
146
  path: '/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries/:entry',
127
- baseUrl: 'https://apis.roblox.com/cloud',
147
+ baseUrl: 'https://apis.roblox.com/ordered-data-stores',
148
+ scopes: ['universe.ordered-data-store.scope.entry:read'],
128
149
  requestFormat: 'json',
129
150
  serializationMethod: {
130
151
  universeId: {},
@@ -159,17 +180,24 @@ exports.getUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntrie
159
180
  ],
160
181
  });
161
182
  /**
162
- * @api DELETE https://apis.roblox.com/cloud/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries/:entry
183
+ * **Delete** · `BETA`
184
+ *
185
+ * Deletes the specified entry. Unlike standard data stores, which mark entries for deletion, ordered data store entries are deleted immediately.
186
+ *
187
+ * **Scopes:** `universe.ordered-data-store.scope.entry:write`
188
+ *
163
189
  * @param universeId The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
164
190
  * @param orderedDataStore The name of the ordered data store.
165
191
  * @param scope The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).
166
192
  * @param entry The entry ID.
167
- * @description Deletes the specified entry. Unlike standard data stores, which mark entries for deletion, ordered data store entries are deleted immediately.
193
+ * @see DELETE https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
194
+ * @deprecated Prefer the v2 alternative(s) listed above.
168
195
  */
169
196
  exports.deleteUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntriesEntry = (0, __1.endpoint)({
170
197
  method: 'DELETE',
171
198
  path: '/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries/:entry',
172
- baseUrl: 'https://apis.roblox.com/cloud',
199
+ baseUrl: 'https://apis.roblox.com/ordered-data-stores',
200
+ scopes: ['universe.ordered-data-store.scope.entry:write'],
173
201
  requestFormat: 'json',
174
202
  serializationMethod: {
175
203
  universeId: {},
@@ -204,19 +232,26 @@ exports.deleteUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEnt
204
232
  ],
205
233
  });
206
234
  /**
207
- * @api PATCH https://apis.roblox.com/cloud/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries/:entry
235
+ * **Update** · `BETA`
236
+ *
237
+ * Updates an entry value and returns the updated entry.
238
+ *
239
+ * **Scopes:** `universe.ordered-data-store.scope.entry:write`
240
+ *
208
241
  * @param body
209
242
  * @param universeId The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
210
243
  * @param orderedDataStore The name of the ordered data store.
211
244
  * @param scope The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).
212
245
  * @param entry The entry ID.
213
246
  * @param allow_missing The flag to allow the creation of an entry if the entry doesn't exist. See [Allow missing flags](/cloud/guides/data-stores/request-handling.md.md#allow-missing-flags).
214
- * @description Updates an entry value and returns the updated entry.
247
+ * @see PATCH https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
248
+ * @deprecated Prefer the v2 alternative(s) listed above.
215
249
  */
216
250
  exports.patchUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntriesEntry = (0, __1.endpoint)({
217
251
  method: 'PATCH',
218
252
  path: '/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries/:entry',
219
- baseUrl: 'https://apis.roblox.com/cloud',
253
+ baseUrl: 'https://apis.roblox.com/ordered-data-stores',
254
+ scopes: ['universe.ordered-data-store.scope.entry:write'],
220
255
  requestFormat: 'json',
221
256
  serializationMethod: {
222
257
  body: {},
@@ -259,20 +294,27 @@ exports.patchUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntr
259
294
  ],
260
295
  });
261
296
  /**
262
- * @api POST https://apis.roblox.com/cloud/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries/:entry:increment
297
+ * **Increment** · `BETA`
298
+ *
299
+ * Increments the value of the key by the provided amount and returns the updated entry.
300
+
301
+ Known issue: Entry values can increment past the valid range and this may persist in the backend. Returned values will clamp to the valid range.
302
+ *
303
+ * **Scopes:** `universe.ordered-data-store.scope.entry:write`
304
+ *
263
305
  * @param body
264
306
  * @param universeId The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
265
307
  * @param orderedDataStore The name of the ordered data store.
266
308
  * @param scope The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).
267
309
  * @param entry The entry ID.
268
- * @description Increments the value of the key by the provided amount and returns the updated entry.
269
-
270
- Known issue: Entry values can increment past the valid range and this may persist in the backend. Returned values will clamp to the valid range.
310
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment
311
+ * @deprecated Prefer the v2 alternative(s) listed above.
271
312
  */
272
313
  exports.postUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntriesEntryIncrement = (0, __1.endpoint)({
273
314
  method: 'POST',
274
315
  path: '/v1/universes/:universeId/orderedDataStores/:orderedDataStore/scopes/:scope/entries/:entry:increment',
275
- baseUrl: 'https://apis.roblox.com/cloud',
316
+ baseUrl: 'https://apis.roblox.com/ordered-data-stores',
317
+ scopes: ['universe.ordered-data-store.scope.entry:write'],
276
318
  requestFormat: 'json',
277
319
  serializationMethod: {
278
320
  body: {},