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
@@ -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;
@@ -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.