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
@@ -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: {},
@@ -1,11 +1,17 @@
1
1
  /**
2
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores
3
- * @summary List data stores in an experience
2
+ * **List Data Stores** · `BETA`
3
+ *
4
+ * Returns a list of an experience's data stores.
5
+ *
6
+ * **Lua equivalent:** `DataStoreService:ListDataStoresAsync`
7
+ * **Scopes:** `universe-datastores.control:list`
8
+ *
4
9
  * @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.
5
10
  * @param cursor Provide to request the next set of data.
6
11
  * @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.
7
12
  * @param prefix Provide to return only data stores with this prefix.
8
- * @description Returns a list of an experience's data stores.
13
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores
14
+ * @deprecated Prefer the v2 alternative(s) listed above.
9
15
  */
10
16
  export declare const getUniversesUniverseIdDatastores: import("../..").EndpointGeneric<{
11
17
  universeId: number;
@@ -20,8 +26,15 @@ export declare const getUniversesUniverseIdDatastores: import("../..").EndpointG
20
26
  nextPageCursor: string | null;
21
27
  }, undefined>;
22
28
  /**
23
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries
24
- * @summary List entries
29
+ * **List Entries** · `BETA`
30
+ *
31
+ * Returns a list of entry keys within a data store.
32
+
33
+ Entries marked deleted with a tombstone version are still included in the response if they have yet to be permanently deleted.
34
+ *
35
+ * **Lua equivalent:** `DataStore:ListKeysAsync`
36
+ * **Scopes:** `universe-datastores.objects:list`
37
+ *
25
38
  * @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.
26
39
  * @param datastoreName The name of the data store.
27
40
  * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
@@ -29,9 +42,9 @@ export declare const getUniversesUniverseIdDatastores: import("../..").EndpointG
29
42
  * @param prefix Provide to return only keys with this prefix.
30
43
  * @param cursor Provide to request the next set of data.
31
44
  * @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.
32
- * @description Returns a list of entry keys within a data store.
33
-
34
- Entries marked deleted with a tombstone version are still included in the response if they have yet to be permanently deleted.
45
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries
46
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries
47
+ * @deprecated Prefer the v2 alternative(s) listed above.
35
48
  */
36
49
  export declare const getUniversesUniverseIdDatastoresDatastoreEntries: import("../..").EndpointGeneric<{
37
50
  universeId: number;
@@ -46,13 +59,9 @@ export declare const getUniversesUniverseIdDatastoresDatastoreEntries: import(".
46
59
  nextPageCursor: string | null;
47
60
  }, undefined>;
48
61
  /**
49
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries/entry
50
- * @summary Get entry.
51
- * @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.
52
- * @param datastoreName The name of the data store.
53
- * @param entryKey The key identifying the entry.
54
- * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
55
- * @description Returns the value and metadata associated with an entry.
62
+ * **Get Entry** · `BETA`
63
+ *
64
+ * Returns the value and metadata associated with an entry.
56
65
 
57
66
  Entries marked deleted with a tombstone version will return 404 Not Found.
58
67
 
@@ -75,6 +84,17 @@ roblox-entry-userids: [1, 2, 3]
75
84
  | `roblox-entry-attributes` | Attributes tagged with the entry. Serialized JSON map object. |
76
85
  | `roblox-entry-userids` | Comma-separated list of Roblox user IDs tagged with the entry. |
77
86
 
87
+ *
88
+ * **Lua equivalent:** `GlobalDataStore:GetAsync`
89
+ * **Scopes:** `universe-datastores.objects:read`
90
+ *
91
+ * @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.
92
+ * @param datastoreName The name of the data store.
93
+ * @param entryKey The key identifying the entry.
94
+ * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
95
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
96
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}
97
+ * @deprecated Prefer the v2 alternative(s) listed above.
78
98
  */
79
99
  export declare const getUniversesUniverseIdDatastoresDatastoreEntriesEntry: import("../..").EndpointGeneric<{
80
100
  universeId: number;
@@ -83,8 +103,13 @@ export declare const getUniversesUniverseIdDatastoresDatastoreEntriesEntry: impo
83
103
  entryKey?: string | null | undefined;
84
104
  }, Record<string, never>, undefined>;
85
105
  /**
86
- * @api POST https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries/entry
87
- * @summary Set entry.
106
+ * **Set Entry** · `BETA`
107
+ *
108
+ * Sets the value, metadata and user IDs associated with an entry.
109
+ *
110
+ * **Lua equivalent:** `GlobalDataStore:SetAsync`
111
+ * **Scopes:** `universe-datastores.objects:update`, `universe-datastores.objects:create`, `universe-datastores.control:create`
112
+ *
88
113
  * @param body
89
114
  * @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.
90
115
  * @param datastoreName The name of the data store.
@@ -95,7 +120,11 @@ export declare const getUniversesUniverseIdDatastoresDatastoreEntriesEntry: impo
95
120
  * @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.
96
121
  * @param roblox-entry-userids Comma-separated list of Roblox user IDs tagged with the entry. If not provided, existing user IDs are cleared.
97
122
  * @param content-md5 The base64-encoded MD5 checksum of the content. See [Content-MD5](/cloud/guides/data-stores/request-handling.md#content-md5).
98
- * @description Sets the value, metadata and user IDs associated with an entry.
123
+ * @see PATCH https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
124
+ * @see PATCH https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}
125
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries
126
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries
127
+ * @deprecated Prefer the v2 alternative(s) listed above.
99
128
  */
100
129
  export declare const postUniversesUniverseIdDatastoresDatastoreEntriesEntry: import("../..").EndpointGeneric<{
101
130
  universeId: number;
@@ -109,13 +138,20 @@ export declare const postUniversesUniverseIdDatastoresDatastoreEntriesEntry: imp
109
138
  "content-md5"?: string | null | undefined;
110
139
  }, void, string>;
111
140
  /**
112
- * @api DELETE https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries/entry
113
- * @summary Delete entry.
141
+ * **Delete Entry** · `BETA`
142
+ *
143
+ * Marks the entry as deleted by creating a tombstone version. Entries are deleted permanently after 30 days.
144
+ *
145
+ * **Lua equivalent:** `GlobalDataStore:RemoveAsync`
146
+ * **Scopes:** `universe-datastores.objects:delete`
147
+ *
114
148
  * @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.
115
149
  * @param datastoreName The name of the data store.
116
150
  * @param entryKey The key identifying the entry.
117
151
  * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
118
- * @description Marks the entry as deleted by creating a tombstone version. Entries are deleted permanently after 30 days.
152
+ * @see DELETE https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
153
+ * @see DELETE https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}
154
+ * @deprecated Prefer the v2 alternative(s) listed above.
119
155
  */
120
156
  export declare const deleteUniversesUniverseIdDatastoresDatastoreEntriesEntry: import("../..").EndpointGeneric<{
121
157
  universeId: number;
@@ -124,16 +160,9 @@ export declare const deleteUniversesUniverseIdDatastoresDatastoreEntriesEntry: i
124
160
  entryKey?: string | null | undefined;
125
161
  }, void, undefined>;
126
162
  /**
127
- * @api POST https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries/entry/increment
128
- * @summary Increment entry
129
- * @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.
130
- * @param datastoreName The name of the data store.
131
- * @param entryKey The key identifying the entry.
132
- * @param incrementBy The amount by which the entry should be incremented, or the starting value if it doesn't exist.
133
- * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
134
- * @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.
135
- * @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.
136
- * @description Increments the value for an entry by a given amount, or create a new entry with that amount. Returns the entry and metadata.
163
+ * **Increment Entry** · `BETA`
164
+ *
165
+ * Increments the value for an entry by a given amount, or create a new entry with that amount. Returns the entry and metadata.
137
166
 
138
167
  Metadata can be found in the response headers like the following:
139
168
  ```text
@@ -154,6 +183,20 @@ roblox-entry-userids: [1, 2, 3]
154
183
  | `roblox-entry-attributes` | Attributes tagged with the entry. Serialized JSON map object. |
155
184
  | `roblox-entry-userids` | Comma-separated list of Roblox user IDs tagged with the entry. |
156
185
 
186
+ *
187
+ * **Lua equivalent:** `GlobalDataStore:IncrementAsync`
188
+ * **Scopes:** `universe-datastores.objects:update`, `universe-datastores.objects:create`, `universe-datastores.control:create`
189
+ *
190
+ * @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.
191
+ * @param datastoreName The name of the data store.
192
+ * @param entryKey The key identifying the entry.
193
+ * @param incrementBy The amount by which the entry should be incremented, or the starting value if it doesn't exist.
194
+ * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
195
+ * @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.
196
+ * @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.
197
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment
198
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment
199
+ * @deprecated Prefer the v2 alternative(s) listed above.
157
200
  */
158
201
  export declare const postUniversesUniverseIdDatastoresDatastoreEntriesEntryIncrement: import("../..").EndpointGeneric<{
159
202
  universeId: number;
@@ -165,8 +208,13 @@ export declare const postUniversesUniverseIdDatastoresDatastoreEntriesEntryIncre
165
208
  incrementBy?: number | undefined;
166
209
  }, Record<string, never>, undefined>;
167
210
  /**
168
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries/entry/versions
169
- * @summary List entry versions
211
+ * **List Entry Versions** · `BETA`
212
+ *
213
+ * Returns a list of versions for an entry.
214
+ *
215
+ * **Lua equivalent:** `DataStore:ListVersionsAsync`
216
+ * **Scopes:** `universe-datastores.versions:list`
217
+ *
170
218
  * @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.
171
219
  * @param datastoreName The name of the data store.
172
220
  * @param entryKey The key identifying the entry.
@@ -176,7 +224,9 @@ export declare const postUniversesUniverseIdDatastoresDatastoreEntriesEntryIncre
176
224
  * @param endTime Provide to not include versions later than this timestamp.
177
225
  * @param sortOrder Either `Ascending` (earlier versions first) or `Descending` (later versions first).
178
226
  * @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.
179
- * @description Returns a list of versions for an entry.
227
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions
228
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}:listRevisions
229
+ * @deprecated Prefer the v2 alternative(s) listed above.
180
230
  */
181
231
  export declare const getUniversesUniverseIdDatastoresDatastoreEntriesEntryVersions: import("../..").EndpointGeneric<{
182
232
  universeId: number;
@@ -190,14 +240,9 @@ export declare const getUniversesUniverseIdDatastoresDatastoreEntriesEntryVersio
190
240
  sortOrder?: string | null | undefined;
191
241
  }, void, undefined>;
192
242
  /**
193
- * @api GET https://apis.roblox.com/cloud/v1/universes/:universeId/standard-datastores/datastore/entries/entry/versions/version
194
- * @summary Get entry version.
195
- * @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.
196
- * @param datastoreName The name of the data store.
197
- * @param entryKey The key identifying the entry.
198
- * @param versionId The version to inspect.
199
- * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
200
- * @description Returns the value and metadata of a specific version of an entry.
243
+ * **Get Entry Version** · `BETA`
244
+ *
245
+ * Returns the value and metadata of a specific version of an entry.
201
246
 
202
247
  Metadata can be found in the response headers like the following:
203
248
  ```text
@@ -218,6 +263,18 @@ roblox-entry-userids: [1, 2, 3]
218
263
  | `roblox-entry-attributes` | Attributes tagged with the entry. Serialized JSON map object. |
219
264
  | `roblox-entry-userids` | Comma-separated list of Roblox user IDs tagged with the entry. |
220
265
 
266
+ *
267
+ * **Lua equivalent:** `DataStore:GetVersionAsync`
268
+ * **Scopes:** `universe-datastores.versions:read`
269
+ *
270
+ * @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.
271
+ * @param datastoreName The name of the data store.
272
+ * @param entryKey The key identifying the entry.
273
+ * @param versionId The version to inspect.
274
+ * @param scope The value is `global` by default. See [Scopes](/cloud-services/data-stores/index.md#scopes).
275
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}
276
+ * @see GET https://apis.roblox.com/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}
277
+ * @deprecated Prefer the v2 alternative(s) listed above.
221
278
  */
222
279
  export declare const getUniversesUniverseIdDatastoresDatastoreEntriesEntryVersionsVersion: import("../..").EndpointGeneric<{
223
280
  universeId: number;