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,10 +1,14 @@
1
1
  /**
2
- * @api POST https://apis.roblox.com/cloud/v2/creator-store-products
3
- * @summary Create Creator Store Product
4
- * @param body
5
- * @description Add a Creator Store product. Only use this method if your product has never
2
+ * `BETA`
3
+ *
4
+ * Add a Creator Store product. Only use this method if your product has never
6
5
  been distributed on the Creator Store; otherwise, use the `PATCH` method to
7
6
  update the product.
7
+ *
8
+ * **Scopes:** `creator-store-product:write`
9
+ * **Engine:** Not available in-engine
10
+ *
11
+ * @param body
8
12
  */
9
13
  export declare const postCloudV2CreatorStoreProducts: import("../..").EndpointGeneric<{}, {
10
14
  path: string;
@@ -64,10 +68,14 @@ export declare const postCloudV2CreatorStoreProducts: import("../..").EndpointGe
64
68
  fontFamilyAssetId: string;
65
69
  }>;
66
70
  /**
67
- * @api GET https://apis.roblox.com/cloud/v2/creator-store-products/:creator_store_product_id
68
- * @summary Get Creator Store Product
71
+ * `BETA`
72
+ *
73
+ * Get a Creator Store product.
74
+ *
75
+ * **Scopes:** `creator-store-product:read`
76
+ * **Engine:** Not available in-engine
77
+ *
69
78
  * @param creator_store_product_id The creator-store-product ID.
70
- * @description Get a Creator Store product.
71
79
  */
72
80
  export declare const getCloudV2CreatorStoreProductsCreatorStoreProductId: import("../..").EndpointGeneric<{
73
81
  creator_store_product_id: string;
@@ -101,14 +109,18 @@ export declare const getCloudV2CreatorStoreProductsCreatorStoreProductId: import
101
109
  fontFamilyAssetId: string;
102
110
  }, undefined>;
103
111
  /**
104
- * @api PATCH https://apis.roblox.com/cloud/v2/creator-store-products/:creator_store_product_id
105
- * @summary Update Creator Store Product
112
+ * `BETA`
113
+ *
114
+ * Update a Creator Store product.
115
+ *
116
+ * **Scopes:** `creator-store-product:write`
117
+ * **Engine:** Not available in-engine
118
+ *
106
119
  * @param body
107
120
  * @param creator_store_product_id The creator-store-product ID.
108
121
  * @param updateMask The list of fields to update.
109
122
  * @param allowMissing If set to true, and the creator store product is not found, a creator store
110
123
  product is created. In this situation, `update_mask` is ignored.
111
- * @description Update a Creator Store product.
112
124
  */
113
125
  export declare const patchCloudV2CreatorStoreProductsCreatorStoreProductId: import("../..").EndpointGeneric<{
114
126
  creator_store_product_id: string;
@@ -172,10 +184,13 @@ export declare const patchCloudV2CreatorStoreProductsCreatorStoreProductId: impo
172
184
  fontFamilyAssetId: string;
173
185
  }>;
174
186
  /**
175
- * @api GET https://apis.roblox.com/cloud/v2/groups/:group_id
176
- * @summary Get Group
187
+ * `BETA`
188
+ *
189
+ * Gets the specified group.
190
+ *
191
+ * **Engine:** Usable with HttpService
192
+ *
177
193
  * @param group_id The group ID.
178
- * @description Gets the specified group.
179
194
  */
180
195
  export declare const getCloudV2GroupsGroupId: import("../..").EndpointGeneric<{
181
196
  group_id: string;
@@ -193,8 +208,181 @@ export declare const getCloudV2GroupsGroupId: import("../..").EndpointGeneric<{
193
208
  verified: boolean;
194
209
  }, undefined>;
195
210
  /**
196
- * @api GET https://apis.roblox.com/cloud/v2/groups/:group_id/join-requests
197
- * @summary List Group Join Requests
211
+ * `BETA`
212
+ *
213
+ * Lists forum categories in the group.
214
+ *
215
+ * **Scopes:** `group-forum:read`
216
+ * **Engine:** Usable with HttpService
217
+ *
218
+ * @param group_id The group ID.
219
+ * @param maxPageSize The maximum number of group forum categories to return. The service might
220
+ return fewer than this value. If unspecified, at most 10 group forum
221
+ categories are returned. The maximum value is 10 and higher values are set
222
+ to 10.
223
+ * @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
224
+
225
+ When paginating, all other parameters provided to the subsequent call must
226
+ match the call that provided the page token.
227
+ * @param filter This field may be set in order to filter the resources returned.
228
+
229
+ Filtering conforms to Common Expression Language (CEL). Only the boolean
230
+ field `archived` and `==` operator are supported. If `archived=false`,
231
+ archived categories are not returned. The default value is `false`.
232
+ Example: `"filter=archived==true"`
233
+ */
234
+ export declare const getCloudV2GroupsGroupIdForumCategories: import("../..").EndpointGeneric<{
235
+ group_id: string;
236
+ filter?: string | undefined;
237
+ maxPageSize?: number | undefined;
238
+ pageToken?: string | undefined;
239
+ }, {
240
+ groupForumCategories: {
241
+ path: string;
242
+ createTime: string;
243
+ updateTime: string;
244
+ groupForumCategoryId: string;
245
+ displayName: string;
246
+ creator: string;
247
+ archiveTime: string;
248
+ archiver: string;
249
+ }[];
250
+ nextPageToken: string;
251
+ }, undefined>;
252
+ /**
253
+ * `BETA`
254
+ *
255
+ * Lists forum posts in the group's forum category.
256
+ *
257
+ * **Scopes:** `group-forum:read`
258
+ * **Engine:** Usable with HttpService
259
+ *
260
+ * @param group_id The group ID.
261
+ * @param forum_category_id The forum-category ID.
262
+ * @param maxPageSize The maximum number of group forum posts to return. The service might return
263
+ fewer than this value. If unspecified, at most 10 group forum posts are
264
+ returned. The maximum value is 100 and higher values are set to 100.
265
+ * @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
266
+
267
+ When paginating, all other parameters provided to the subsequent call must
268
+ match the call that provided the page token.
269
+ * @param filter This field may be set in order to filter the resources returned.
270
+
271
+ Filtering conforms to Common Expression Language (CEL). Only the query
272
+ `filter=pinned==true` is supported, where only pinned posts are returned.
273
+ `filter=pinned==false`is not supported.
274
+ * @param view The view in which to retrieve the group forum post.
275
+
276
+ Supports FULL and FULL_WITH_FIRST_COMMENT.
277
+
278
+ Defaults to FULL.
279
+
280
+ Possible values:
281
+
282
+ | Value | Description |
283
+ | --- | --- |
284
+ | VIEW_UNSPECIFIED | The group forum post view is not specified; the default will be used. |
285
+ | FULL | Includes all fields but does not dereference `first_comment`. Only the `path` field is populated. |
286
+ | FULL_WITH_FIRST_COMMENT | Includes all fields and also fully populates `first_comment`. The default view. |
287
+ */
288
+ export declare const getCloudV2GroupsGroupIdForumCategoriesForumCategoryIdPosts: import("../..").EndpointGeneric<{
289
+ group_id: string;
290
+ forum_category_id: string;
291
+ filter?: string | undefined;
292
+ view?: "VIEW_UNSPECIFIED" | "FULL" | "FULL_WITH_FIRST_COMMENT" | undefined;
293
+ maxPageSize?: number | undefined;
294
+ pageToken?: string | undefined;
295
+ }, {
296
+ groupForumPosts: {
297
+ path: string;
298
+ createTime: string;
299
+ updateTime: string;
300
+ pinned: boolean;
301
+ locked: boolean;
302
+ groupForumPostId: string;
303
+ title: string;
304
+ firstComment: {
305
+ path: string;
306
+ groupForumCommentId: string;
307
+ message: {
308
+ createTime: string;
309
+ updateTime: string;
310
+ plainText: string;
311
+ author: string;
312
+ messageReaction: {
313
+ emoteId: string;
314
+ count: number;
315
+ }[];
316
+ };
317
+ };
318
+ author: string;
319
+ archiveTime: string;
320
+ archiver: string;
321
+ commentCount: number;
322
+ }[];
323
+ nextPageToken: string;
324
+ }, undefined>;
325
+ /**
326
+ * `BETA`
327
+ *
328
+ * Lists forum comments on a group's forum post.
329
+ *
330
+ * **Scopes:** `group-forum:read`
331
+ * **Engine:** Usable with HttpService
332
+ *
333
+ * @param group_id The group ID.
334
+ * @param forum_category_id The forum-category ID.
335
+ * @param post_id The post ID.
336
+ * @param maxPageSize The maximum number of group forum comments to return. The service might
337
+ return fewer than this value. If unspecified, at most 10 group forum
338
+ comments are returned. The maximum value is 100 and higher values are set
339
+ to 100.
340
+ * @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
341
+
342
+ When paginating, all other parameters provided to the subsequent call must
343
+ match the call that provided the page token.
344
+ * @param filter This field may be set in order to filter the resources returned.
345
+
346
+ Filtering conforms to Common Expression Language (CEL). Only the string
347
+ field `repliesToCommentId` and the `==` operator are supported.
348
+ If `repliesToCommentId` is specified, only comments that respond to the
349
+ comment are returned. The default value is `''`. If
350
+ `repliesToCommentId=''`, only comments responding directly to the post are
351
+ returned. Example:
352
+ `"filter=repliesToCommentId==01234567-89ab-cdef-0123-456789abcdef"`
353
+ */
354
+ export declare const getCloudV2GroupsGroupIdForumCategoriesForumCategoryIdPostsPostIdComments: import("../..").EndpointGeneric<{
355
+ group_id: string;
356
+ forum_category_id: string;
357
+ post_id: string;
358
+ filter?: string | undefined;
359
+ maxPageSize?: number | undefined;
360
+ pageToken?: string | undefined;
361
+ }, {
362
+ groupForumComments: {
363
+ path: string;
364
+ groupForumCommentId: string;
365
+ message: {
366
+ createTime: string;
367
+ updateTime: string;
368
+ plainText: string;
369
+ author: string;
370
+ messageReaction: {
371
+ emoteId: string;
372
+ count: number;
373
+ }[];
374
+ };
375
+ }[];
376
+ nextPageToken: string;
377
+ }, undefined>;
378
+ /**
379
+ * `BETA`
380
+ *
381
+ * List join requests under a group.
382
+ *
383
+ * **Scopes:** `group:read`
384
+ * **Engine:** Usable with HttpService
385
+ *
198
386
  * @param group_id The group ID.
199
387
  * @param maxPageSize The maximum number of group join requests to return. The service might
200
388
  return fewer than this value. If unspecified, at most 10 group join
@@ -211,7 +399,6 @@ field and `==` operator are supported.
211
399
 
212
400
 
213
401
  Example: `"user == 'users/156'"`
214
- * @description List join requests under a group.
215
402
  */
216
403
  export declare const getCloudV2GroupsGroupIdJoinRequests: import("../..").EndpointGeneric<{
217
404
  group_id: string;
@@ -227,32 +414,44 @@ export declare const getCloudV2GroupsGroupIdJoinRequests: import("../..").Endpoi
227
414
  nextPageToken: string;
228
415
  }, undefined>;
229
416
  /**
230
- * @api POST https://apis.roblox.com/cloud/v2/groups/:group_id/join-requests/:join_request_id:accept
231
- * @summary Accept Group Join Request
417
+ * `BETA`
418
+ *
419
+ * Accepts a join request.
420
+ *
421
+ * **Scopes:** `group:write`
422
+ * **Engine:** Usable with HttpService
423
+ *
232
424
  * @param body
233
425
  * @param group_id The group ID.
234
426
  * @param join_request_id The join-request ID.
235
- * @description Accepts a join request.
236
427
  */
237
428
  export declare const postCloudV2GroupsGroupIdJoinRequestsJoinRequestIdAccept: import("../..").EndpointGeneric<{
238
429
  group_id: string;
239
430
  join_request_id: string;
240
431
  }, void, Record<string, never>>;
241
432
  /**
242
- * @api POST https://apis.roblox.com/cloud/v2/groups/:group_id/join-requests/:join_request_id:decline
243
- * @summary Decline Group Join Request
433
+ * `BETA`
434
+ *
435
+ * Declines a join request.
436
+ *
437
+ * **Scopes:** `group:write`
438
+ * **Engine:** Usable with HttpService
439
+ *
244
440
  * @param body
245
441
  * @param group_id The group ID.
246
442
  * @param join_request_id The join-request ID.
247
- * @description Declines a join request.
248
443
  */
249
444
  export declare const postCloudV2GroupsGroupIdJoinRequestsJoinRequestIdDecline: import("../..").EndpointGeneric<{
250
445
  group_id: string;
251
446
  join_request_id: string;
252
447
  }, void, Record<string, never>>;
253
448
  /**
254
- * @api GET https://apis.roblox.com/cloud/v2/groups/:group_id/memberships
255
- * @summary List Group Memberships
449
+ * `BETA`
450
+ *
451
+ * List group members in a group.
452
+ *
453
+ * **Engine:** Usable with HttpService
454
+ *
256
455
  * @param group_id The group ID.
257
456
  * @param maxPageSize The maximum number of group memberships to return. The service might return
258
457
  fewer than this value. If unspecified, at most 10 group memberships are
@@ -266,7 +465,6 @@ match the call that provided the page token.
266
465
  See the
267
466
  [filtering](/cloud/reference/patterns#list-group-memberships)
268
467
  documentation for more information.
269
- * @description List group members in a group.
270
468
  */
271
469
  export declare const getCloudV2GroupsGroupIdMemberships: import("../..").EndpointGeneric<{
272
470
  group_id: string;
@@ -284,15 +482,19 @@ export declare const getCloudV2GroupsGroupIdMemberships: import("../..").Endpoin
284
482
  nextPageToken: string;
285
483
  }, undefined>;
286
484
  /**
287
- * @api PATCH https://apis.roblox.com/cloud/v2/groups/:group_id/memberships/:membership_id
288
- * @summary Update Group Membership
289
- * @param body
290
- * @param group_id The group ID.
291
- * @param membership_id The membership ID.
292
- * @description Updates the group membership for a particular group member. This action
485
+ * `BETA`
486
+ *
487
+ * Updates the group membership for a particular group member. This action
293
488
  requires the requester to be able to manage lower ranked members. Guest or
294
489
  Owner ranks cannot be assigned, and a requester cannot change their own
295
490
  rank.
491
+ *
492
+ * **Scopes:** `group:write`
493
+ * **Engine:** Usable with HttpService
494
+ *
495
+ * @param body
496
+ * @param group_id The group ID.
497
+ * @param membership_id The membership ID.
296
498
  */
297
499
  export declare const patchCloudV2GroupsGroupIdMembershipsMembershipId: import("../..").EndpointGeneric<{
298
500
  group_id: string;
@@ -311,17 +513,9 @@ export declare const patchCloudV2GroupsGroupIdMembershipsMembershipId: import(".
311
513
  role: string;
312
514
  }>;
313
515
  /**
314
- * @api GET https://apis.roblox.com/cloud/v2/groups/:group_id/roles
315
- * @summary List Group Roles
316
- * @param group_id The group ID.
317
- * @param maxPageSize The maximum number of group roles to return. The service might return fewer
318
- than this value. If unspecified, at most 10 group roles are returned. The
319
- maximum value is 20 and higher values are set to 20.
320
- * @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
321
-
322
- When paginating, all other parameters provided to the subsequent call must
323
- match the call that provided the page token.
324
- * @description List roles in a group.
516
+ * `BETA`
517
+ *
518
+ * List roles in a group.
325
519
 
326
520
  The permissions field for roles is viewable based on the requester's access
327
521
  and scopes.
@@ -333,6 +527,18 @@ permissions in their role are visible.
333
527
 
334
528
  If the requester is the owner of the group and has the `group:read` scope,
335
529
  permissions in all roles are visible.
530
+ *
531
+ * **Scopes:** `group:read`
532
+ * **Engine:** Usable with HttpService
533
+ *
534
+ * @param group_id The group ID.
535
+ * @param maxPageSize The maximum number of group roles to return. The service might return fewer
536
+ than this value. If unspecified, at most 10 group roles are returned. The
537
+ maximum value is 20 and higher values are set to 20.
538
+ * @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
539
+
540
+ When paginating, all other parameters provided to the subsequent call must
541
+ match the call that provided the page token.
336
542
  */
337
543
  export declare const getCloudV2GroupsGroupIdRoles: import("../..").EndpointGeneric<{
338
544
  group_id: string;
@@ -384,11 +590,15 @@ export declare const getCloudV2GroupsGroupIdRoles: import("../..").EndpointGener
384
590
  nextPageToken: string;
385
591
  }, undefined>;
386
592
  /**
387
- * @api GET https://apis.roblox.com/cloud/v2/groups/:group_id/roles/:role_id
388
- * @summary Get Group Role
593
+ * `BETA`
594
+ *
595
+ * Get the group role
596
+ *
597
+ * **Scopes:** `group:read`
598
+ * **Engine:** Usable with HttpService
599
+ *
389
600
  * @param group_id The group ID.
390
601
  * @param role_id The role ID.
391
- * @description Get the group role
392
602
  */
393
603
  export declare const getCloudV2GroupsGroupIdRolesRoleId: import("../..").EndpointGeneric<{
394
604
  group_id: string;
@@ -436,16 +646,20 @@ export declare const getCloudV2GroupsGroupIdRolesRoleId: import("../..").Endpoin
436
646
  };
437
647
  }, undefined>;
438
648
  /**
439
- * @api GET https://apis.roblox.com/cloud/v2/groups/:group_id/shout
440
- * @summary Get Group Shout
441
- * @param group_id The group ID.
442
- * @description Gets the group shout.
649
+ * `BETA`
650
+ *
651
+ * Gets the group shout.
443
652
 
444
653
  If a guest can view the group shout, this is always retrievable.
445
654
 
446
655
  If a guest cannot, a member who has the permissions to view the group
447
656
  shout, along with the `group:read` scope, will be able to read the group
448
657
  shout.
658
+ *
659
+ * **Scopes:** `group:read`
660
+ * **Engine:** Usable with HttpService
661
+ *
662
+ * @param group_id The group ID.
449
663
  */
450
664
  export declare const getCloudV2GroupsGroupIdShout: import("../..").EndpointGeneric<{
451
665
  group_id: string;
@@ -457,10 +671,13 @@ export declare const getCloudV2GroupsGroupIdShout: import("../..").EndpointGener
457
671
  poster: string;
458
672
  }, undefined>;
459
673
  /**
460
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id
461
- * @summary Get Universe
674
+ * `STABLE`
675
+ *
676
+ * Gets the specified universe.
677
+ *
678
+ * **Engine:** Not available in-engine
679
+ *
462
680
  * @param universe_id The universe ID.
463
- * @description Gets the specified universe.
464
681
  */
465
682
  export declare const getCloudV2UniversesUniverseId: import("../..").EndpointGeneric<{
466
683
  universe_id: string;
@@ -513,15 +730,19 @@ export declare const getCloudV2UniversesUniverseId: import("../..").EndpointGene
513
730
  rootPlace?: string | undefined;
514
731
  }, undefined>;
515
732
  /**
516
- * @api PATCH https://apis.roblox.com/cloud/v2/universes/:universe_id
517
- * @summary Update Universe
518
- * @param body
519
- * @param universe_id The universe ID.
520
- * @param updateMask The list of fields to update.
521
- * @description Updates the specified universe.
733
+ * `STABLE`
734
+ *
735
+ * Updates the specified universe.
522
736
 
523
737
  This method is guaranteed to return all updated fields.
524
738
  This method may additionally return the full resource.
739
+ *
740
+ * **Scopes:** `universe:write`
741
+ * **Engine:** Not available in-engine
742
+ *
743
+ * @param body
744
+ * @param universe_id The universe ID.
745
+ * @param updateMask The list of fields to update.
525
746
  */
526
747
  export declare const patchCloudV2UniversesUniverseId: import("../..").EndpointGeneric<{
527
748
  universe_id: string;
@@ -622,11 +843,9 @@ export declare const patchCloudV2UniversesUniverseId: import("../..").EndpointGe
622
843
  rootPlace?: string | undefined;
623
844
  }>;
624
845
  /**
625
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id:generateSpeechAsset
626
- * @summary Generate Speech Asset
627
- * @param body
628
- * @param universe_id The universe ID.
629
- * @description Generates an English speech audio asset from the specified text.
846
+ * `BETA`
847
+ *
848
+ * Generates an English speech audio asset from the specified text.
630
849
 
631
850
  This endpoint requires the `asset:read` and `asset:write` scopes in
632
851
  addition to the `universe:write` scope.
@@ -635,6 +854,12 @@ The response returns an `Operation` object that must be prefixed with
635
854
  `/assets/v1`. For example, the URL to discover the result of the operation
636
855
  could be
637
856
  `https://apis.roblox.com/assets/v1/operations/8b42ef30-9c17-4526-b8cf-2ff0136ca94d`.
857
+ *
858
+ * **Scopes:** `universe:write`, `asset:read`, `asset:write`
859
+ * **Engine:** Not available in-engine
860
+ *
861
+ * @param body
862
+ * @param universe_id The universe ID.
638
863
  */
639
864
  export declare const postCloudV2UniversesUniverseIdGenerateSpeechAsset: import("../..").EndpointGeneric<{
640
865
  universe_id: string;
@@ -663,14 +888,18 @@ export declare const postCloudV2UniversesUniverseIdGenerateSpeechAsset: import("
663
888
  } | undefined;
664
889
  }>;
665
890
  /**
666
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id:publishMessage
667
- * @summary Publish Universe Message
668
- * @param body
669
- * @param universe_id The universe ID.
670
- * @description Publishes a message to the universe's live servers.
891
+ * `STABLE`
892
+ *
893
+ * Publishes a message to the universe's live servers.
671
894
 
672
895
  Servers can consume messages via
673
896
  [MessagingService](https://create.roblox.com/docs/reference/engine/classes/MessagingService).
897
+ *
898
+ * **Scopes:** `universe-messaging-service:publish`
899
+ * **Engine:** Not available in-engine
900
+ *
901
+ * @param body
902
+ * @param universe_id The universe ID.
674
903
  */
675
904
  export declare const postCloudV2UniversesUniverseIdPublishMessage: import("../..").EndpointGeneric<{
676
905
  universe_id: string;
@@ -679,13 +908,17 @@ export declare const postCloudV2UniversesUniverseIdPublishMessage: import("../..
679
908
  message: string;
680
909
  }>;
681
910
  /**
682
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id:restartServers
683
- * @summary Restart Universe Servers
684
- * @param body
685
- * @param universe_id The universe ID.
686
- * @description Restarts active servers for a specific universe. Defaults to only
911
+ * `STABLE`
912
+ *
913
+ * Restarts active servers for a specific universe. Defaults to only
687
914
  restarting servers running older versions, but can be configured to restart
688
915
  all servers regardless of version. Used for releasing experience updates.
916
+ *
917
+ * **Scopes:** `universe:write`
918
+ * **Engine:** Not available in-engine
919
+ *
920
+ * @param body
921
+ * @param universe_id The universe ID.
689
922
  */
690
923
  export declare const postCloudV2UniversesUniverseIdRestartServers: import("../..").EndpointGeneric<{
691
924
  universe_id: string;
@@ -696,11 +929,15 @@ export declare const postCloudV2UniversesUniverseIdRestartServers: import("../..
696
929
  bleedOffDurationMinutes: number;
697
930
  }>;
698
931
  /**
699
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id:translateText
700
- * @summary Translate Text
932
+ * `BETA`
933
+ *
934
+ * Translates the provided text from one language to another.
935
+ *
936
+ * **Scopes:** `universe:write`
937
+ * **Engine:** Not available in-engine
938
+ *
701
939
  * @param body
702
940
  * @param universe_id The universe ID.
703
- * @description Translates the provided text from one language to another.
704
941
  */
705
942
  export declare const postCloudV2UniversesUniverseIdTranslateText: import("../..").EndpointGeneric<{
706
943
  universe_id: string;
@@ -713,8 +950,19 @@ export declare const postCloudV2UniversesUniverseIdTranslateText: import("../.."
713
950
  targetLanguageCodes?: string[] | undefined;
714
951
  }>;
715
952
  /**
716
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores
717
- * @summary List Data Stores
953
+ * `STABLE`
954
+ *
955
+ * Returns a list of data stores.
956
+
957
+ Data stores scheduled for permanent deletion are omitted from the results
958
+ by default (or when `showDeleted` is set to `false`). When this is the
959
+ case, the operation will check up to 512 data stores. If all checked data
960
+ stores are deleted, it will return an empty list with a page token to
961
+ continue iteration.
962
+ *
963
+ * **Scopes:** `universe-datastores.control:list`
964
+ * **Engine:** Not available in-engine
965
+ *
718
966
  * @param universe_id The universe ID.
719
967
  * @param maxPageSize The maximum number of data stores to return. The service might return fewer
720
968
  than this value. If unspecified, at most 10 data stores are returned. The
@@ -734,13 +982,6 @@ The `filter` field supports a very small subset of CEL:
734
982
  Example filter: `id.startsWith("foo")`
735
983
  * @param showDeleted If true, resources marked for pending deletion will be included in the
736
984
  results.
737
- * @description Returns a list of data stores.
738
-
739
- Data stores scheduled for permanent deletion are omitted from the results
740
- by default (or when `showDeleted` is set to `false`). When this is the
741
- case, the operation will check up to 512 data stores. If all checked data
742
- stores are deleted, it will return an empty list with a page token to
743
- continue iteration.
744
985
  */
745
986
  export declare const getCloudV2UniversesUniverseIdDataStores: import("../..").EndpointGeneric<{
746
987
  universe_id: string;
@@ -759,11 +1000,9 @@ export declare const getCloudV2UniversesUniverseIdDataStores: import("../..").En
759
1000
  nextPageToken: string;
760
1001
  }, undefined>;
761
1002
  /**
762
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores:snapshot
763
- * @summary Snapshot Data Stores
764
- * @param body
765
- * @param universe_id The universe ID.
766
- * @description Takes a new snapshot of the data stores in an experience.
1003
+ * `STABLE`
1004
+ *
1005
+ * Takes a new snapshot of the data stores in an experience.
767
1006
 
768
1007
  After a snapshot, the next write to every key in the experience will
769
1008
  create a versioned backup of the previous data, regardless of the time of
@@ -779,6 +1018,12 @@ the time of the latest snapshot will be returned.
779
1018
  For more information on using snapshots, see the [Data
780
1019
  stores](https://create.roblox.com/docs/cloud-services/data-stores#snapshots)
781
1020
  Engine guide.
1021
+ *
1022
+ * **Scopes:** `universe-datastores.control:snapshot`
1023
+ * **Engine:** Not available in-engine
1024
+ *
1025
+ * @param body
1026
+ * @param universe_id The universe ID.
782
1027
  */
783
1028
  export declare const postCloudV2UniversesUniverseIdDataStoresSnapshot: import("../..").EndpointGeneric<{
784
1029
  universe_id: string;
@@ -787,11 +1032,9 @@ export declare const postCloudV2UniversesUniverseIdDataStoresSnapshot: import(".
787
1032
  latestSnapshotTime: string;
788
1033
  }, Record<string, never>>;
789
1034
  /**
790
- * @api DELETE https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id
791
- * @summary Delete Data Store
792
- * @param universe_id The universe ID.
793
- * @param data_store_id The data-store ID.
794
- * @description Schedules the specified data store for permanent deletion.
1035
+ * `BETA`
1036
+ *
1037
+ * Schedules the specified data store for permanent deletion.
795
1038
 
796
1039
  This operation assigns the data store an expiry time 30 days in the future,
797
1040
  at which point permanent deletion begins. To cancel, use the
@@ -822,6 +1065,12 @@ after the deletion:
822
1065
 
823
1066
  If the data store is already in a `DELETED` state, this operation is a
824
1067
  no-op, and the data store is returned as-is.
1068
+ *
1069
+ * **Scopes:** `universe-datastores.control:delete`
1070
+ * **Engine:** Not available in-engine
1071
+ *
1072
+ * @param universe_id The universe ID.
1073
+ * @param data_store_id The data-store ID.
825
1074
  */
826
1075
  export declare const deleteCloudV2UniversesUniverseIdDataStoresDataStoreId: import("../..").EndpointGeneric<{
827
1076
  universe_id: string;
@@ -834,12 +1083,16 @@ export declare const deleteCloudV2UniversesUniverseIdDataStoresDataStoreId: impo
834
1083
  id: string;
835
1084
  }, undefined>;
836
1085
  /**
837
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id:undelete
838
- * @summary Undelete Data Store
1086
+ * `BETA`
1087
+ *
1088
+ * Restore the data store
1089
+ *
1090
+ * **Scopes:** `universe-datastores.control:delete`
1091
+ * **Engine:** Not available in-engine
1092
+ *
839
1093
  * @param body
840
1094
  * @param universe_id The universe ID.
841
1095
  * @param data_store_id The data-store ID.
842
- * @description Restore the data store
843
1096
  */
844
1097
  export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdUndelete: import("../..").EndpointGeneric<{
845
1098
  universe_id: string;
@@ -852,8 +1105,18 @@ export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdUndelete
852
1105
  id: string;
853
1106
  }, Record<string, never>>;
854
1107
  /**
855
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries
856
- * @summary List Data Store Entries
1108
+ * `STABLE`
1109
+ *
1110
+ * Returns a list of entries from a data store.
1111
+
1112
+ Only the `path` and `id` fields are populated; use `GetDataStoreEntry`
1113
+ to retrieve other fields.
1114
+
1115
+ Specify the wildcard scope (`-`) to list entries from all scopes.
1116
+ *
1117
+ * **Scopes:** `universe-datastores.objects:list`
1118
+ * **Engine:** Not available in-engine
1119
+ *
857
1120
  * @param universe_id The universe ID.
858
1121
  * @param data_store_id The data-store ID.
859
1122
  * @param maxPageSize The maximum number of data store entries to return. The service might
@@ -874,12 +1137,6 @@ The `filter` field supports a very small subset of CEL:
874
1137
  Example filter: `id.startsWith("foo")`
875
1138
  * @param showDeleted If true, resources marked for pending deletion will be included in the
876
1139
  results.
877
- * @description Returns a list of entries from a data store.
878
-
879
- Only the `path` and `id` fields are populated; use `GetDataStoreEntry`
880
- to retrieve other fields.
881
-
882
- Specify the wildcard scope (`-`) to list entries from all scopes.
883
1140
  */
884
1141
  export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries: import("../..").EndpointGeneric<{
885
1142
  universe_id: string;
@@ -905,8 +1162,15 @@ export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries:
905
1162
  nextPageToken: string;
906
1163
  }, undefined>;
907
1164
  /**
908
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries
909
- * @summary Create Data Store Entry
1165
+ * `STABLE`
1166
+ *
1167
+ * Creates an entry with the provided ID and value.
1168
+
1169
+ Returns a 400 Bad Request if the entry exists.
1170
+ *
1171
+ * **Scopes:** `universe-datastores.objects:create`
1172
+ * **Engine:** Not available in-engine
1173
+ *
910
1174
  * @param body
911
1175
  * @param universe_id The universe ID.
912
1176
  * @param data_store_id The data-store ID.
@@ -915,9 +1179,6 @@ component of the data store entry's resource path.
915
1179
 
916
1180
  This value should be a 1-50 character string. We strongly recommend using
917
1181
  only lowercase letters, numeric digits, and hyphens.
918
- * @description Creates an entry with the provided ID and value.
919
-
920
- Returns a 400 Bad Request if the entry exists.
921
1182
  */
922
1183
  export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries: import("../..").EndpointGeneric<{
923
1184
  universe_id: string;
@@ -949,12 +1210,9 @@ export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries:
949
1210
  attributes: Record<string, never>;
950
1211
  }>;
951
1212
  /**
952
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries/:entry_id
953
- * @summary Get Data Store Entry
954
- * @param universe_id The universe ID.
955
- * @param data_store_id The data-store ID.
956
- * @param entry_id The entry ID.
957
- * @description Gets the specified entry.
1213
+ * `STABLE`
1214
+ *
1215
+ * Gets the specified entry.
958
1216
 
959
1217
  To get the entry at a specific revision, add `@<revisionId>` to the end of
960
1218
  the path.
@@ -979,6 +1237,13 @@ the Unix epoch (1/1/1970) and not more than ten minutes in the future.
979
1237
  For example, to get the revision of `my-entry` that was current on
980
1238
  12/2/2024 at 06:00 UTC, use the path
981
1239
  `/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z`.
1240
+ *
1241
+ * **Scopes:** `universe-datastores.objects:read`
1242
+ * **Engine:** Not available in-engine
1243
+ *
1244
+ * @param universe_id The universe ID.
1245
+ * @param data_store_id The data-store ID.
1246
+ * @param entry_id The entry ID.
982
1247
  */
983
1248
  export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId: import("../..").EndpointGeneric<{
984
1249
  universe_id: string;
@@ -998,18 +1263,22 @@ export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEn
998
1263
  attributes: Record<string, never>;
999
1264
  }, undefined>;
1000
1265
  /**
1001
- * @api DELETE https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries/:entry_id
1002
- * @summary Delete Data Store Entry
1003
- * @param universe_id The universe ID.
1004
- * @param data_store_id The data-store ID.
1005
- * @param entry_id The entry ID.
1006
- * @description Marks the specified entry for deletion.
1266
+ * `STABLE`
1267
+ *
1268
+ * Marks the specified entry for deletion.
1007
1269
 
1008
1270
  Entries are not be deleted immediately; instead, the `state` field will
1009
1271
  be set to `DELETED`. Permanent deletion occurs after 30 days.
1010
1272
 
1011
1273
  On success, returns 200 OK. If the entry doesn't exist, returns
1012
1274
  404 Not Found.
1275
+ *
1276
+ * **Scopes:** `universe-datastores.objects:delete`
1277
+ * **Engine:** Not available in-engine
1278
+ *
1279
+ * @param universe_id The universe ID.
1280
+ * @param data_store_id The data-store ID.
1281
+ * @param entry_id The entry ID.
1013
1282
  */
1014
1283
  export declare const deleteCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId: import("../..").EndpointGeneric<{
1015
1284
  universe_id: string;
@@ -1017,15 +1286,9 @@ export declare const deleteCloudV2UniversesUniverseIdDataStoresDataStoreIdEntrie
1017
1286
  entry_id: string;
1018
1287
  }, void, undefined>;
1019
1288
  /**
1020
- * @api PATCH https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries/:entry_id
1021
- * @summary Update Data Store Entry
1022
- * @param body
1023
- * @param universe_id The universe ID.
1024
- * @param data_store_id The data-store ID.
1025
- * @param entry_id The entry ID.
1026
- * @param allowMissing If set to true, and the data store entry is not found, a data store entry
1027
- is created.
1028
- * @description Updates the value, attributes, and users of an entry.
1289
+ * `STABLE`
1290
+ *
1291
+ * Updates the value, attributes, and users of an entry.
1029
1292
 
1030
1293
  Updating specific revisions of the entry is **unsupported**. If you specify
1031
1294
  a revision ID in the path and `allow_missing` is `true`, the update request
@@ -1035,6 +1298,16 @@ the key.
1035
1298
  Partial update is **unsupported**. If attributes or users are not
1036
1299
  provided when updating the value, they will be cleared. Value must always
1037
1300
  be provided when updating an entry.
1301
+ *
1302
+ * **Scopes:** `universe-datastores.objects:update`
1303
+ * **Engine:** Not available in-engine
1304
+ *
1305
+ * @param body
1306
+ * @param universe_id The universe ID.
1307
+ * @param data_store_id The data-store ID.
1308
+ * @param entry_id The entry ID.
1309
+ * @param allowMissing If set to true, and the data store entry is not found, a data store entry
1310
+ is created.
1038
1311
  */
1039
1312
  export declare const patchCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId: import("../..").EndpointGeneric<{
1040
1313
  universe_id: string;
@@ -1067,13 +1340,9 @@ export declare const patchCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries
1067
1340
  attributes: Record<string, never>;
1068
1341
  }>;
1069
1342
  /**
1070
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries/:entry_id:increment
1071
- * @summary Increment Data Store Entry
1072
- * @param body
1073
- * @param universe_id The universe ID.
1074
- * @param data_store_id The data-store ID.
1075
- * @param entry_id The entry ID.
1076
- * @description Increments the value of the specified entry. Both the existing value and
1343
+ * `STABLE`
1344
+ *
1345
+ * Increments the value of the specified entry. Both the existing value and
1077
1346
  the increment amount must be integers.
1078
1347
 
1079
1348
  If the entry doesn't exist, creates an entry with the specified value.
@@ -1087,6 +1356,14 @@ When this happens, the returned value will be clamped to the valid range,
1087
1356
  but the backend may persist the original value. This behavior is maintained
1088
1357
  for backwards compatibility reasons, but may change in a future version of
1089
1358
  this API.
1359
+ *
1360
+ * **Scopes:** `universe-datastores.objects:create`, `universe-datastores.objects:update`
1361
+ * **Engine:** Not available in-engine
1362
+ *
1363
+ * @param body
1364
+ * @param universe_id The universe ID.
1365
+ * @param data_store_id The data-store ID.
1366
+ * @param entry_id The entry ID.
1090
1367
  */
1091
1368
  export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryIdIncrement: import("../..").EndpointGeneric<{
1092
1369
  universe_id: string;
@@ -1111,8 +1388,23 @@ export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesE
1111
1388
  attributes: Record<string, never>;
1112
1389
  }>;
1113
1390
  /**
1114
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries/:entry_id:listRevisions
1115
- * @summary List Data Store Entry Revisions
1391
+ * `STABLE`
1392
+ *
1393
+ * List revisions of the data store entry.
1394
+
1395
+ This method returns partial data store entries.
1396
+
1397
+ In particular, only the `path`, `id`, `createTime`, `revisionCreateTime`,
1398
+ `revisionId`, `etag`, and `state` fields are populated. Both the `path` and
1399
+ `id` fields will have an `@<version>` suffix.
1400
+
1401
+ In order to get the full entry at a revision, you can use the provided
1402
+ `path` field with the `GetDataStoreEntry` method, i.e. `GET
1403
+ /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>`.
1404
+ *
1405
+ * **Scopes:** `universe-datastores.versions:list`
1406
+ * **Engine:** Not available in-engine
1407
+ *
1116
1408
  * @param universe_id The universe ID.
1117
1409
  * @param data_store_id The data-store ID.
1118
1410
  * @param entry_id The entry ID.
@@ -1134,17 +1426,6 @@ For example:
1134
1426
 
1135
1427
  `"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <=
1136
1428
  2001-01-01T00:00:00Z"`
1137
- * @description List revisions of the data store entry.
1138
-
1139
- This method returns partial data store entries.
1140
-
1141
- In particular, only the `path`, `id`, `createTime`, `revisionCreateTime`,
1142
- `revisionId`, `etag`, and `state` fields are populated. Both the `path` and
1143
- `id` fields will have an `@<version>` suffix.
1144
-
1145
- In order to get the full entry at a revision, you can use the provided
1146
- `path` field with the `GetDataStoreEntry` method, i.e. `GET
1147
- /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>`.
1148
1429
  */
1149
1430
  export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryIdListRevisions: import("../..").EndpointGeneric<{
1150
1431
  universe_id: string;
@@ -1170,8 +1451,18 @@ export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEn
1170
1451
  nextPageToken: string;
1171
1452
  }, undefined>;
1172
1453
  /**
1173
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries
1174
- * @summary List Data Store Entries
1454
+ * `STABLE`
1455
+ *
1456
+ * Returns a list of entries from a data store.
1457
+
1458
+ Only the `path` and `id` fields are populated; use `GetDataStoreEntry`
1459
+ to retrieve other fields.
1460
+
1461
+ Specify the wildcard scope (`-`) to list entries from all scopes.
1462
+ *
1463
+ * **Scopes:** `universe-datastores.objects:list`
1464
+ * **Engine:** Not available in-engine
1465
+ *
1175
1466
  * @param universe_id The universe ID.
1176
1467
  * @param data_store_id The data-store ID.
1177
1468
  * @param scope_id The scope ID.
@@ -1193,12 +1484,6 @@ The `filter` field supports a very small subset of CEL:
1193
1484
  Example filter: `id.startsWith("foo")`
1194
1485
  * @param showDeleted If true, resources marked for pending deletion will be included in the
1195
1486
  results.
1196
- * @description Returns a list of entries from a data store.
1197
-
1198
- Only the `path` and `id` fields are populated; use `GetDataStoreEntry`
1199
- to retrieve other fields.
1200
-
1201
- Specify the wildcard scope (`-`) to list entries from all scopes.
1202
1487
  */
1203
1488
  export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntries: import("../..").EndpointGeneric<{
1204
1489
  universe_id: string;
@@ -1225,8 +1510,15 @@ export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesSco
1225
1510
  nextPageToken: string;
1226
1511
  }, undefined>;
1227
1512
  /**
1228
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries
1229
- * @summary Create Data Store Entry
1513
+ * `STABLE`
1514
+ *
1515
+ * Creates an entry with the provided ID and value.
1516
+
1517
+ Returns a 400 Bad Request if the entry exists.
1518
+ *
1519
+ * **Scopes:** `universe-datastores.objects:create`
1520
+ * **Engine:** Not available in-engine
1521
+ *
1230
1522
  * @param body
1231
1523
  * @param universe_id The universe ID.
1232
1524
  * @param data_store_id The data-store ID.
@@ -1236,9 +1528,6 @@ component of the data store entry's resource path.
1236
1528
 
1237
1529
  This value should be a 1-50 character string. We strongly recommend using
1238
1530
  only lowercase letters, numeric digits, and hyphens.
1239
- * @description Creates an entry with the provided ID and value.
1240
-
1241
- Returns a 400 Bad Request if the entry exists.
1242
1531
  */
1243
1532
  export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntries: import("../..").EndpointGeneric<{
1244
1533
  universe_id: string;
@@ -1271,13 +1560,9 @@ export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesSc
1271
1560
  attributes: Record<string, never>;
1272
1561
  }>;
1273
1562
  /**
1274
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries/:entry_id
1275
- * @summary Get Data Store Entry
1276
- * @param universe_id The universe ID.
1277
- * @param data_store_id The data-store ID.
1278
- * @param scope_id The scope ID.
1279
- * @param entry_id The entry ID.
1280
- * @description Gets the specified entry.
1563
+ * `STABLE`
1564
+ *
1565
+ * Gets the specified entry.
1281
1566
 
1282
1567
  To get the entry at a specific revision, add `@<revisionId>` to the end of
1283
1568
  the path.
@@ -1302,6 +1587,14 @@ the Unix epoch (1/1/1970) and not more than ten minutes in the future.
1302
1587
  For example, to get the revision of `my-entry` that was current on
1303
1588
  12/2/2024 at 06:00 UTC, use the path
1304
1589
  `/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z`.
1590
+ *
1591
+ * **Scopes:** `universe-datastores.objects:read`
1592
+ * **Engine:** Not available in-engine
1593
+ *
1594
+ * @param universe_id The universe ID.
1595
+ * @param data_store_id The data-store ID.
1596
+ * @param scope_id The scope ID.
1597
+ * @param entry_id The entry ID.
1305
1598
  */
1306
1599
  export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryId: import("../..").EndpointGeneric<{
1307
1600
  universe_id: string;
@@ -1322,19 +1615,23 @@ export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesSco
1322
1615
  attributes: Record<string, never>;
1323
1616
  }, undefined>;
1324
1617
  /**
1325
- * @api DELETE https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries/:entry_id
1326
- * @summary Delete Data Store Entry
1327
- * @param universe_id The universe ID.
1328
- * @param data_store_id The data-store ID.
1329
- * @param scope_id The scope ID.
1330
- * @param entry_id The entry ID.
1331
- * @description Marks the specified entry for deletion.
1618
+ * `STABLE`
1619
+ *
1620
+ * Marks the specified entry for deletion.
1332
1621
 
1333
1622
  Entries are not be deleted immediately; instead, the `state` field will
1334
1623
  be set to `DELETED`. Permanent deletion occurs after 30 days.
1335
1624
 
1336
1625
  On success, returns 200 OK. If the entry doesn't exist, returns
1337
1626
  404 Not Found.
1627
+ *
1628
+ * **Scopes:** `universe-datastores.objects:delete`
1629
+ * **Engine:** Not available in-engine
1630
+ *
1631
+ * @param universe_id The universe ID.
1632
+ * @param data_store_id The data-store ID.
1633
+ * @param scope_id The scope ID.
1634
+ * @param entry_id The entry ID.
1338
1635
  */
1339
1636
  export declare const deleteCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryId: import("../..").EndpointGeneric<{
1340
1637
  universe_id: string;
@@ -1343,16 +1640,9 @@ export declare const deleteCloudV2UniversesUniverseIdDataStoresDataStoreIdScopes
1343
1640
  scope_id: string;
1344
1641
  }, void, undefined>;
1345
1642
  /**
1346
- * @api PATCH https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries/:entry_id
1347
- * @summary Update Data Store Entry
1348
- * @param body
1349
- * @param universe_id The universe ID.
1350
- * @param data_store_id The data-store ID.
1351
- * @param scope_id The scope ID.
1352
- * @param entry_id The entry ID.
1353
- * @param allowMissing If set to true, and the data store entry is not found, a data store entry
1354
- is created.
1355
- * @description Updates the value, attributes, and users of an entry.
1643
+ * `STABLE`
1644
+ *
1645
+ * Updates the value, attributes, and users of an entry.
1356
1646
 
1357
1647
  Updating specific revisions of the entry is **unsupported**. If you specify
1358
1648
  a revision ID in the path and `allow_missing` is `true`, the update request
@@ -1362,6 +1652,17 @@ the key.
1362
1652
  Partial update is **unsupported**. If attributes or users are not
1363
1653
  provided when updating the value, they will be cleared. Value must always
1364
1654
  be provided when updating an entry.
1655
+ *
1656
+ * **Scopes:** `universe-datastores.objects:update`
1657
+ * **Engine:** Not available in-engine
1658
+ *
1659
+ * @param body
1660
+ * @param universe_id The universe ID.
1661
+ * @param data_store_id The data-store ID.
1662
+ * @param scope_id The scope ID.
1663
+ * @param entry_id The entry ID.
1664
+ * @param allowMissing If set to true, and the data store entry is not found, a data store entry
1665
+ is created.
1365
1666
  */
1366
1667
  export declare const patchCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryId: import("../..").EndpointGeneric<{
1367
1668
  universe_id: string;
@@ -1395,14 +1696,9 @@ export declare const patchCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesS
1395
1696
  attributes: Record<string, never>;
1396
1697
  }>;
1397
1698
  /**
1398
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries/:entry_id:increment
1399
- * @summary Increment Data Store Entry
1400
- * @param body
1401
- * @param universe_id The universe ID.
1402
- * @param data_store_id The data-store ID.
1403
- * @param scope_id The scope ID.
1404
- * @param entry_id The entry ID.
1405
- * @description Increments the value of the specified entry. Both the existing value and
1699
+ * `STABLE`
1700
+ *
1701
+ * Increments the value of the specified entry. Both the existing value and
1406
1702
  the increment amount must be integers.
1407
1703
 
1408
1704
  If the entry doesn't exist, creates an entry with the specified value.
@@ -1416,6 +1712,15 @@ When this happens, the returned value will be clamped to the valid range,
1416
1712
  but the backend may persist the original value. This behavior is maintained
1417
1713
  for backwards compatibility reasons, but may change in a future version of
1418
1714
  this API.
1715
+ *
1716
+ * **Scopes:** `universe-datastores.objects:create`, `universe-datastores.objects:update`
1717
+ * **Engine:** Not available in-engine
1718
+ *
1719
+ * @param body
1720
+ * @param universe_id The universe ID.
1721
+ * @param data_store_id The data-store ID.
1722
+ * @param scope_id The scope ID.
1723
+ * @param entry_id The entry ID.
1419
1724
  */
1420
1725
  export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryIdIncrement: import("../..").EndpointGeneric<{
1421
1726
  universe_id: string;
@@ -1441,8 +1746,23 @@ export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesSc
1441
1746
  attributes: Record<string, never>;
1442
1747
  }>;
1443
1748
  /**
1444
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries/:entry_id:listRevisions
1445
- * @summary List Data Store Entry Revisions
1749
+ * `STABLE`
1750
+ *
1751
+ * List revisions of the data store entry.
1752
+
1753
+ This method returns partial data store entries.
1754
+
1755
+ In particular, only the `path`, `id`, `createTime`, `revisionCreateTime`,
1756
+ `revisionId`, `etag`, and `state` fields are populated. Both the `path` and
1757
+ `id` fields will have an `@<version>` suffix.
1758
+
1759
+ In order to get the full entry at a revision, you can use the provided
1760
+ `path` field with the `GetDataStoreEntry` method, i.e. `GET
1761
+ /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>`.
1762
+ *
1763
+ * **Scopes:** `universe-datastores.versions:list`
1764
+ * **Engine:** Not available in-engine
1765
+ *
1446
1766
  * @param universe_id The universe ID.
1447
1767
  * @param data_store_id The data-store ID.
1448
1768
  * @param scope_id The scope ID.
@@ -1465,17 +1785,6 @@ For example:
1465
1785
 
1466
1786
  `"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <=
1467
1787
  2001-01-01T00:00:00Z"`
1468
- * @description List revisions of the data store entry.
1469
-
1470
- This method returns partial data store entries.
1471
-
1472
- In particular, only the `path`, `id`, `createTime`, `revisionCreateTime`,
1473
- `revisionId`, `etag`, and `state` fields are populated. Both the `path` and
1474
- `id` fields will have an `@<version>` suffix.
1475
-
1476
- In order to get the full entry at a revision, you can use the provided
1477
- `path` field with the `GetDataStoreEntry` method, i.e. `GET
1478
- /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>`.
1479
1788
  */
1480
1789
  export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryIdListRevisions: import("../..").EndpointGeneric<{
1481
1790
  universe_id: string;
@@ -1502,11 +1811,15 @@ export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesSco
1502
1811
  nextPageToken: string;
1503
1812
  }, undefined>;
1504
1813
  /**
1505
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/luau-execution-session-task-binary-inputs
1506
- * @summary Create Luau Execution Session Task Binary Input
1814
+ * `BETA`
1815
+ *
1816
+ * Create a new `LuauExecutionSessionTaskBinaryInput`.
1817
+ *
1818
+ * **Scopes:** `universe.place.luau-execution-session:write`
1819
+ * **Engine:** Not available in-engine
1820
+ *
1507
1821
  * @param body
1508
1822
  * @param universe_id The universe ID.
1509
- * @description Create a new `LuauExecutionSessionTaskBinaryInput`.
1510
1823
  */
1511
1824
  export declare const postCloudV2UniversesUniverseIdLuauExecutionSessionTaskBinaryInputs: import("../..").EndpointGeneric<{
1512
1825
  universe_id: string;
@@ -1520,11 +1833,15 @@ export declare const postCloudV2UniversesUniverseIdLuauExecutionSessionTaskBinar
1520
1833
  uploadUri: string;
1521
1834
  }>;
1522
1835
  /**
1523
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/memory-store:flush
1524
- * @summary Flush Memory Store
1836
+ * `STABLE`
1837
+ *
1838
+ * Asynchronously flush all data structures in the universe.
1839
+ *
1840
+ * **Scopes:** `memory-store:flush`
1841
+ * **Engine:** Not available in-engine
1842
+ *
1525
1843
  * @param body
1526
1844
  * @param universe_id The universe ID.
1527
- * @description Asynchronously flush all data structures in the universe.
1528
1845
  */
1529
1846
  export declare const postCloudV2UniversesUniverseIdMemoryStoreFlush: import("../..").EndpointGeneric<{
1530
1847
  universe_id: string;
@@ -1546,12 +1863,9 @@ export declare const postCloudV2UniversesUniverseIdMemoryStoreFlush: import("../
1546
1863
  };
1547
1864
  }, Record<string, never>>;
1548
1865
  /**
1549
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/memory-store/queues/:queue_id/items
1550
- * @summary Create Memory Store Queue Item
1551
- * @param body
1552
- * @param universe_id The universe ID.
1553
- * @param queue_id The queue ID.
1554
- * @description Creates a new queue item.
1866
+ * `STABLE`
1867
+ *
1868
+ * Creates a new queue item.
1555
1869
 
1556
1870
  If `ttl` is set, the item will automatically be removed from the queue
1557
1871
  after the time interval specified.
@@ -1560,6 +1874,13 @@ If a numerical `priority` is set, the item will be inserted into the queue
1560
1874
  based on the priority value. The higher the value, the closer to the front
1561
1875
  of the queue the item will be. If priority values are the same then the
1562
1876
  item will be inserted after existing values with the same priority.
1877
+ *
1878
+ * **Scopes:** `memory-store.queue:add`
1879
+ * **Engine:** Not available in-engine
1880
+ *
1881
+ * @param body
1882
+ * @param universe_id The universe ID.
1883
+ * @param queue_id The queue ID.
1563
1884
  */
1564
1885
  export declare const postCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItems: import("../..").EndpointGeneric<{
1565
1886
  universe_id: string;
@@ -1580,14 +1901,18 @@ export declare const postCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItems
1580
1901
  id: string;
1581
1902
  }>;
1582
1903
  /**
1583
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/memory-store/queues/:queue_id/items:discard
1584
- * @summary Discard Memory Store Queue Items
1904
+ * `STABLE`
1905
+ *
1906
+ * Discards read items from the front of the queue.
1907
+
1908
+ Takes a `readId` from a previous `Read` operation.
1909
+ *
1910
+ * **Scopes:** `memory-store.queue:discard`
1911
+ * **Engine:** Not available in-engine
1912
+ *
1585
1913
  * @param body
1586
1914
  * @param universe_id The universe ID.
1587
1915
  * @param queue_id The queue ID.
1588
- * @description Discards read items from the front of the queue.
1589
-
1590
- Takes a `readId` from a previous `Read` operation.
1591
1916
  */
1592
1917
  export declare const postCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItemsDiscard: import("../..").EndpointGeneric<{
1593
1918
  universe_id: string;
@@ -1596,8 +1921,15 @@ export declare const postCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItems
1596
1921
  readId: string;
1597
1922
  }>;
1598
1923
  /**
1599
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/memory-store/queues/:queue_id/items:read
1600
- * @summary Read Memory Store Queue Items
1924
+ * `STABLE`
1925
+ *
1926
+ * Returns the specified number of items at the front of the queue.
1927
+
1928
+
1929
+ *
1930
+ * **Scopes:** `memory-store.queue:dequeue`
1931
+ * **Engine:** Not available in-engine
1932
+ *
1601
1933
  * @param universe_id The universe ID.
1602
1934
  * @param queue_id The queue ID.
1603
1935
  * @param count The number of items to read from the queue
@@ -1616,9 +1948,6 @@ window duration.
1616
1948
  It must be written in seconds greater than 0 and end with `s`.
1617
1949
 
1618
1950
  Defaults to `30s`.
1619
- * @description Returns the specified number of items at the front of the queue.
1620
-
1621
-
1622
1951
  */
1623
1952
  export declare const getCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItemsRead: import("../..").EndpointGeneric<{
1624
1953
  universe_id: string;
@@ -1638,8 +1967,13 @@ export declare const getCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItemsR
1638
1967
  }[];
1639
1968
  }, undefined>;
1640
1969
  /**
1641
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/memory-store/sorted-maps/:sorted_map_id/items
1642
- * @summary List Memory Store Sorted Map Items
1970
+ * `STABLE`
1971
+ *
1972
+ * Gets and returns items in the map with a given order and filter.
1973
+ *
1974
+ * **Scopes:** `memory-store.sorted-map:read`
1975
+ * **Engine:** Not available in-engine
1976
+ *
1643
1977
  * @param universe_id The universe ID.
1644
1978
  * @param sorted_map_id The sorted-map ID.
1645
1979
  * @param maxPageSize The maximum number of memory store sorted map items to return. The service
@@ -1667,7 +2001,6 @@ and `sortKey` fields are supported. In terms of operators, only `<`, `>`
1667
2001
  and `&&` are allowed'
1668
2002
 
1669
2003
  Example: `id > "key-001" && id < "key-100"`
1670
- * @description Gets and returns items in the map with a given order and filter.
1671
2004
  */
1672
2005
  export declare const getCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItems: import("../..").EndpointGeneric<{
1673
2006
  universe_id: string;
@@ -1690,8 +2023,13 @@ export declare const getCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMap
1690
2023
  nextPageToken: string;
1691
2024
  }, undefined>;
1692
2025
  /**
1693
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/memory-store/sorted-maps/:sorted_map_id/items
1694
- * @summary Create Memory Store Sorted Map Item
2026
+ * `STABLE`
2027
+ *
2028
+ * Creates the specified map item if it doesn't exist.
2029
+ *
2030
+ * **Scopes:** `memory-store.sorted-map:write`
2031
+ * **Engine:** Not available in-engine
2032
+ *
1695
2033
  * @param body
1696
2034
  * @param universe_id The universe ID.
1697
2035
  * @param sorted_map_id The sorted-map ID.
@@ -1701,7 +2039,6 @@ final component of the memory store sorted map item's resource path.
1701
2039
  This value should be a 1-127 character string that supports alphanumeric
1702
2040
  and special characters. This id is case sensitive. The id must be url
1703
2041
  encoded if it contains any url breaking special characters.
1704
- * @description Creates the specified map item if it doesn't exist.
1705
2042
  */
1706
2043
  export declare const postCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItems: import("../..").EndpointGeneric<{
1707
2044
  universe_id: string;
@@ -1727,12 +2064,16 @@ export declare const postCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMa
1727
2064
  numericSortKey: number;
1728
2065
  }>;
1729
2066
  /**
1730
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/memory-store/sorted-maps/:sorted_map_id/items/:item_id
1731
- * @summary Get Memory Store Sorted Map Item
2067
+ * `STABLE`
2068
+ *
2069
+ * Gets and returns the value of the given key in the map.
2070
+ *
2071
+ * **Scopes:** `memory-store.sorted-map:read`
2072
+ * **Engine:** Not available in-engine
2073
+ *
1732
2074
  * @param universe_id The universe ID.
1733
2075
  * @param sorted_map_id The sorted-map ID.
1734
2076
  * @param item_id The item ID.
1735
- * @description Gets and returns the value of the given key in the map.
1736
2077
  */
1737
2078
  export declare const getCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId: import("../..").EndpointGeneric<{
1738
2079
  universe_id: string;
@@ -1749,12 +2090,16 @@ export declare const getCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMap
1749
2090
  numericSortKey: number;
1750
2091
  }, undefined>;
1751
2092
  /**
1752
- * @api DELETE https://apis.roblox.com/cloud/v2/universes/:universe_id/memory-store/sorted-maps/:sorted_map_id/items/:item_id
1753
- * @summary Delete Memory Store Sorted Map Item
2093
+ * `STABLE`
2094
+ *
2095
+ * Deletes the specified item from the map.
2096
+ *
2097
+ * **Scopes:** `memory-store.sorted-map:write`
2098
+ * **Engine:** Not available in-engine
2099
+ *
1754
2100
  * @param universe_id The universe ID.
1755
2101
  * @param sorted_map_id The sorted-map ID.
1756
2102
  * @param item_id The item ID.
1757
- * @description Deletes the specified item from the map.
1758
2103
  */
1759
2104
  export declare const deleteCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId: import("../..").EndpointGeneric<{
1760
2105
  universe_id: string;
@@ -1762,15 +2107,19 @@ export declare const deleteCloudV2UniversesUniverseIdMemoryStoreSortedMapsSorted
1762
2107
  item_id: string;
1763
2108
  }, void, undefined>;
1764
2109
  /**
1765
- * @api PATCH https://apis.roblox.com/cloud/v2/universes/:universe_id/memory-store/sorted-maps/:sorted_map_id/items/:item_id
1766
- * @summary Update Memory Store Sorted Map Item
2110
+ * `STABLE`
2111
+ *
2112
+ * Updates the specified map item.
2113
+ *
2114
+ * **Scopes:** `memory-store.sorted-map:write`
2115
+ * **Engine:** Not available in-engine
2116
+ *
1767
2117
  * @param body
1768
2118
  * @param universe_id The universe ID.
1769
2119
  * @param sorted_map_id The sorted-map ID.
1770
2120
  * @param item_id The item ID.
1771
2121
  * @param allowMissing If set to true, and the memory store sorted map item is not found, a memory
1772
2122
  store sorted map item is created.
1773
- * @description Updates the specified map item.
1774
2123
  */
1775
2124
  export declare const patchCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId: import("../..").EndpointGeneric<{
1776
2125
  universe_id: string;
@@ -1797,8 +2146,13 @@ export declare const patchCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedM
1797
2146
  numericSortKey: number;
1798
2147
  }>;
1799
2148
  /**
1800
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/ordered-data-stores/:ordered_data_store_id/scopes/:scope_id/entries
1801
- * @summary List Ordered Data Store Entries
2149
+ * `STABLE`
2150
+ *
2151
+ * Returns a list of entries from an ordered data store.
2152
+ *
2153
+ * **Scopes:** `universe.ordered-data-store.scope.entry:read`
2154
+ * **Engine:** Not available in-engine
2155
+ *
1802
2156
  * @param universe_id The universe ID.
1803
2157
  * @param ordered_data_store_id The ordered-data-store ID.
1804
2158
  * @param scope_id The scope ID.
@@ -1829,7 +2183,6 @@ maxValue the user can use the logical operator `&&`. All tokens in the
1829
2183
  filter expression must be separated by a single space.
1830
2184
 
1831
2185
  Example filters: `entry <= 10`; `entry >= 10 && entry <= 30`
1832
- * @description Returns a list of entries from an ordered data store.
1833
2186
  */
1834
2187
  export declare const getCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntries: import("../..").EndpointGeneric<{
1835
2188
  universe_id: string;
@@ -1848,8 +2201,15 @@ export declare const getCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataSt
1848
2201
  nextPageToken: string;
1849
2202
  }, undefined>;
1850
2203
  /**
1851
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/ordered-data-stores/:ordered_data_store_id/scopes/:scope_id/entries
1852
- * @summary Create Ordered Data Store Entry
2204
+ * `STABLE`
2205
+ *
2206
+ * Creates an entry with the provided ID and value.
2207
+
2208
+ Returns a 400 Bad Request if the entry exists.
2209
+ *
2210
+ * **Scopes:** `universe.ordered-data-store.scope.entry:write`
2211
+ * **Engine:** Not available in-engine
2212
+ *
1853
2213
  * @param body
1854
2214
  * @param universe_id The universe ID.
1855
2215
  * @param ordered_data_store_id The ordered-data-store ID.
@@ -1859,9 +2219,6 @@ component of the ordered data store entry's resource path.
1859
2219
 
1860
2220
  This value should be A 1-63 character string. We strongly recommend using
1861
2221
  only lowercase letters, numeric digits, and hyphens.
1862
- * @description Creates an entry with the provided ID and value.
1863
-
1864
- Returns a 400 Bad Request if the entry exists.
1865
2222
  */
1866
2223
  export declare const postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntries: import("../..").EndpointGeneric<{
1867
2224
  universe_id: string;
@@ -1878,13 +2235,17 @@ export declare const postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataS
1878
2235
  id: string;
1879
2236
  }>;
1880
2237
  /**
1881
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/ordered-data-stores/:ordered_data_store_id/scopes/:scope_id/entries/:entry_id
1882
- * @summary Get Ordered Data Store Entry
2238
+ * `STABLE`
2239
+ *
2240
+ * Gets the specified entry.
2241
+ *
2242
+ * **Scopes:** `universe.ordered-data-store.scope.entry:read`
2243
+ * **Engine:** Not available in-engine
2244
+ *
1883
2245
  * @param universe_id The universe ID.
1884
2246
  * @param ordered_data_store_id The ordered-data-store ID.
1885
2247
  * @param scope_id The scope ID.
1886
2248
  * @param entry_id The entry ID.
1887
- * @description Gets the specified entry.
1888
2249
  */
1889
2250
  export declare const getCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId: import("../..").EndpointGeneric<{
1890
2251
  universe_id: string;
@@ -1897,16 +2258,20 @@ export declare const getCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataSt
1897
2258
  id: string;
1898
2259
  }, undefined>;
1899
2260
  /**
1900
- * @api DELETE https://apis.roblox.com/cloud/v2/universes/:universe_id/ordered-data-stores/:ordered_data_store_id/scopes/:scope_id/entries/:entry_id
1901
- * @summary Delete Ordered Data Store Entry
2261
+ * `STABLE`
2262
+ *
2263
+ * Deletes the specified entry.
2264
+
2265
+ On success, returns 200 OK. If the entry doesn't exist, returns
2266
+ 404 Not Found.
2267
+ *
2268
+ * **Scopes:** `universe.ordered-data-store.scope.entry:write`
2269
+ * **Engine:** Not available in-engine
2270
+ *
1902
2271
  * @param universe_id The universe ID.
1903
2272
  * @param ordered_data_store_id The ordered-data-store ID.
1904
2273
  * @param scope_id The scope ID.
1905
2274
  * @param entry_id The entry ID.
1906
- * @description Deletes the specified entry.
1907
-
1908
- On success, returns 200 OK. If the entry doesn't exist, returns
1909
- 404 Not Found.
1910
2275
  */
1911
2276
  export declare const deleteCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId: import("../..").EndpointGeneric<{
1912
2277
  universe_id: string;
@@ -1915,8 +2280,13 @@ export declare const deleteCloudV2UniversesUniverseIdOrderedDataStoresOrderedDat
1915
2280
  ordered_data_store_id: string;
1916
2281
  }, void, undefined>;
1917
2282
  /**
1918
- * @api PATCH https://apis.roblox.com/cloud/v2/universes/:universe_id/ordered-data-stores/:ordered_data_store_id/scopes/:scope_id/entries/:entry_id
1919
- * @summary Update Ordered Data Store Entry
2283
+ * `STABLE`
2284
+ *
2285
+ * Updates the value of an entry.
2286
+ *
2287
+ * **Scopes:** `universe.ordered-data-store.scope.entry:write`
2288
+ * **Engine:** Not available in-engine
2289
+ *
1920
2290
  * @param body
1921
2291
  * @param universe_id The universe ID.
1922
2292
  * @param ordered_data_store_id The ordered-data-store ID.
@@ -1924,7 +2294,6 @@ export declare const deleteCloudV2UniversesUniverseIdOrderedDataStoresOrderedDat
1924
2294
  * @param entry_id The entry ID.
1925
2295
  * @param allowMissing If set to true, and the ordered data store entry is not found, a ordered
1926
2296
  data store entry is created.
1927
- * @description Updates the value of an entry.
1928
2297
  */
1929
2298
  export declare const patchCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId: import("../..").EndpointGeneric<{
1930
2299
  universe_id: string;
@@ -1942,14 +2311,9 @@ export declare const patchCloudV2UniversesUniverseIdOrderedDataStoresOrderedData
1942
2311
  id: string;
1943
2312
  }>;
1944
2313
  /**
1945
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/ordered-data-stores/:ordered_data_store_id/scopes/:scope_id/entries/:entry_id:increment
1946
- * @summary Increment Ordered Data Store Entry
1947
- * @param body
1948
- * @param universe_id The universe ID.
1949
- * @param ordered_data_store_id The ordered-data-store ID.
1950
- * @param scope_id The scope ID.
1951
- * @param entry_id The entry ID.
1952
- * @description Increments the value of the specified entry. Both the existing value and
2314
+ * `STABLE`
2315
+ *
2316
+ * Increments the value of the specified entry. Both the existing value and
1953
2317
  the increment amount must be integers.
1954
2318
 
1955
2319
  If the entry doesn't exist, creates an entry with the specified value.
@@ -1959,6 +2323,15 @@ When this happens, the returned value will be clamped to the valid range,
1959
2323
  but the backend may persist the original value. This behavior is maintained
1960
2324
  for backwards compatibility reasons, but may change in a future version of
1961
2325
  this API.
2326
+ *
2327
+ * **Scopes:** `universe.ordered-data-store.scope.entry:write`
2328
+ * **Engine:** Not available in-engine
2329
+ *
2330
+ * @param body
2331
+ * @param universe_id The universe ID.
2332
+ * @param ordered_data_store_id The ordered-data-store ID.
2333
+ * @param scope_id The scope ID.
2334
+ * @param entry_id The entry ID.
1962
2335
  */
1963
2336
  export declare const postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryIdIncrement: import("../..").EndpointGeneric<{
1964
2337
  universe_id: string;
@@ -1973,11 +2346,14 @@ export declare const postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataS
1973
2346
  amount: number;
1974
2347
  }>;
1975
2348
  /**
1976
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/places/:place_id
1977
- * @summary Get Place
2349
+ * `STABLE`
2350
+ *
2351
+ * Gets the specified place.
2352
+ *
2353
+ * **Engine:** Not available in-engine
2354
+ *
1978
2355
  * @param universe_id The universe ID.
1979
2356
  * @param place_id The place ID.
1980
- * @description Gets the specified place.
1981
2357
  */
1982
2358
  export declare const getCloudV2UniversesUniverseIdPlacesPlaceId: import("../..").EndpointGeneric<{
1983
2359
  universe_id: string;
@@ -1994,13 +2370,17 @@ export declare const getCloudV2UniversesUniverseIdPlacesPlaceId: import("../..")
1994
2370
  universeRuntimeCreation?: boolean | undefined;
1995
2371
  }, undefined>;
1996
2372
  /**
1997
- * @api PATCH https://apis.roblox.com/cloud/v2/universes/:universe_id/places/:place_id
1998
- * @summary Update Place
2373
+ * `STABLE`
2374
+ *
2375
+ * Updates the specified place.
2376
+ *
2377
+ * **Scopes:** `universe.place:write`
2378
+ * **Engine:** Not available in-engine
2379
+ *
1999
2380
  * @param body
2000
2381
  * @param universe_id The universe ID.
2001
2382
  * @param place_id The place ID.
2002
2383
  * @param updateMask The list of fields to update.
2003
- * @description Updates the specified place.
2004
2384
  */
2005
2385
  export declare const patchCloudV2UniversesUniverseIdPlacesPlaceId: import("../..").EndpointGeneric<{
2006
2386
  universe_id: string;
@@ -2028,17 +2408,21 @@ export declare const patchCloudV2UniversesUniverseIdPlacesPlaceId: import("../..
2028
2408
  universeRuntimeCreation?: boolean | undefined;
2029
2409
  }>;
2030
2410
  /**
2031
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/places/:place_id/instances/:instance_id
2032
- * @summary Get Instance
2033
- * @param universe_id The universe ID.
2034
- * @param place_id The place ID.
2035
- * @param instance_id The instance ID.
2036
- * @description Gets an instance and its property data.
2411
+ * `BETA`
2412
+ *
2413
+ * Gets an instance and its property data.
2037
2414
 
2038
2415
  The maximum supported response data size is 500,000 bytes. If this limit is
2039
2416
  exceeded, the returned `Operation` will be completed with an error result
2040
2417
  that has an error code of `422`.
2041
2418
 
2419
+ *
2420
+ * **Scopes:** `universe.place.instance:read`
2421
+ * **Engine:** Not available in-engine
2422
+ *
2423
+ * @param universe_id The universe ID.
2424
+ * @param place_id The place ID.
2425
+ * @param instance_id The instance ID.
2042
2426
  */
2043
2427
  export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId: import("../..").EndpointGeneric<{
2044
2428
  universe_id: string;
@@ -2062,17 +2446,21 @@ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstance
2062
2446
  };
2063
2447
  }, undefined>;
2064
2448
  /**
2065
- * @api PATCH https://apis.roblox.com/cloud/v2/universes/:universe_id/places/:place_id/instances/:instance_id
2066
- * @summary Update Instance
2449
+ * `BETA`
2450
+ *
2451
+ * Updates an instance's property data.
2452
+
2453
+ When updating a `Script` instance's source property, the maximum supported
2454
+ property size is 200,000 bytes after UTF-8 encoding.
2455
+ *
2456
+ * **Scopes:** `universe.place.instance:write`
2457
+ * **Engine:** Not available in-engine
2458
+ *
2067
2459
  * @param body
2068
2460
  * @param universe_id The universe ID.
2069
2461
  * @param place_id The place ID.
2070
2462
  * @param instance_id The instance ID.
2071
2463
  * @param updateMask The list of fields to update.
2072
- * @description Updates an instance's property data.
2073
-
2074
- When updating a `Script` instance's source property, the maximum supported
2075
- property size is 200,000 bytes after UTF-8 encoding.
2076
2464
  */
2077
2465
  export declare const patchCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId: import("../..").EndpointGeneric<{
2078
2466
  universe_id: string;
@@ -2121,8 +2509,19 @@ export declare const patchCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstan
2121
2509
  };
2122
2510
  }>;
2123
2511
  /**
2124
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/places/:place_id/instances/:instance_id:listChildren
2125
- * @summary List Instance Children
2512
+ * `BETA`
2513
+ *
2514
+ * Lists an instance's children.
2515
+
2516
+ The maximum supported response data size is 500,000 bytes. If this limit is
2517
+ exceeded, the returned `Operation` will be completed with an error result
2518
+ that has an error code of `422`.
2519
+
2520
+
2521
+ *
2522
+ * **Scopes:** `universe.place.instance:read`
2523
+ * **Engine:** Not available in-engine
2524
+ *
2126
2525
  * @param universe_id The universe ID.
2127
2526
  * @param place_id The place ID.
2128
2527
  * @param instance_id The instance ID.
@@ -2136,13 +2535,6 @@ Provide this to retrieve the subsequent page.
2136
2535
  When paginating, all other parameters provided to
2137
2536
  `ListInstanceChildrenRequest` must match the call that provided the page
2138
2537
  token.
2139
- * @description Lists an instance's children.
2140
-
2141
- The maximum supported response data size is 500,000 bytes. If this limit is
2142
- exceeded, the returned `Operation` will be completed with an error result
2143
- that has an error code of `422`.
2144
-
2145
-
2146
2538
  */
2147
2539
  export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceIdListChildren: import("../..").EndpointGeneric<{
2148
2540
  universe_id: string;
@@ -2168,12 +2560,9 @@ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstance
2168
2560
  };
2169
2561
  }, undefined>;
2170
2562
  /**
2171
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/places/:place_id/luau-execution-session-tasks
2172
- * @summary Create Luau Execution Session Task
2173
- * @param body
2174
- * @param universe_id The universe ID.
2175
- * @param place_id The place ID.
2176
- * @description Creates a task but does not wait for the task to complete.
2563
+ * `BETA`
2564
+ *
2565
+ * Creates a task but does not wait for the task to complete.
2177
2566
 
2178
2567
  To check whether a task has
2179
2568
  completed, call the `GetLuauExecutionSessionTask` method and inspect the
@@ -2182,6 +2571,13 @@ completed, call the `GetLuauExecutionSessionTask` method and inspect the
2182
2571
  Quotas:
2183
2572
  * 5 calls per minute per API key owner
2184
2573
  * 45 calls per minute per IP address
2574
+ *
2575
+ * **Scopes:** `universe.place.luau-execution-session:write`
2576
+ * **Engine:** Not available in-engine
2577
+ *
2578
+ * @param body
2579
+ * @param universe_id The universe ID.
2580
+ * @param place_id The place ID.
2185
2581
  */
2186
2582
  export declare const postCloudV2UniversesUniverseIdPlacesPlaceIdLuauExecutionSessionTasks: import("../..").EndpointGeneric<{
2187
2583
  universe_id: string;
@@ -2224,8 +2620,14 @@ export declare const postCloudV2UniversesUniverseIdPlacesPlaceIdLuauExecutionSes
2224
2620
  binaryOutputUri: string;
2225
2621
  }>;
2226
2622
  /**
2227
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/places/:place_id/user-restrictions
2228
- * @summary List User Restrictions
2623
+ * `BETA`
2624
+ *
2625
+ * List user restrictions for users that have ever been banned in either a
2626
+ universe or a specific place.
2627
+ *
2628
+ * **Scopes:** `universe.user-restriction:read`
2629
+ * **Engine:** Not available in-engine
2630
+ *
2229
2631
  * @param universe_id The universe ID.
2230
2632
  * @param place_id The place ID.
2231
2633
  * @param maxPageSize The maximum number of user restrictions to return. The service might return
@@ -2235,8 +2637,6 @@ returned. The maximum value is 100 and higher values are set to 100.
2235
2637
 
2236
2638
  When paginating, all other parameters provided to the subsequent call must
2237
2639
  match the call that provided the page token.
2238
- * @description List user restrictions for users that have ever been banned in either a
2239
- universe or a specific place.
2240
2640
  */
2241
2641
  export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictions: import("../..").EndpointGeneric<{
2242
2642
  universe_id: string;
@@ -2261,12 +2661,16 @@ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictions:
2261
2661
  nextPageToken: string;
2262
2662
  }, undefined>;
2263
2663
  /**
2264
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/places/:place_id/user-restrictions/:user_restriction_id
2265
- * @summary Get User Restriction
2664
+ * `BETA`
2665
+ *
2666
+ * Get the user restriction.
2667
+ *
2668
+ * **Scopes:** `universe.user-restriction:read`
2669
+ * **Engine:** Not available in-engine
2670
+ *
2266
2671
  * @param universe_id The universe ID.
2267
2672
  * @param place_id The place ID.
2268
2673
  * @param user_restriction_id The user-restriction ID.
2269
- * @description Get the user restriction.
2270
2674
  */
2271
2675
  export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrictionId: import("../..").EndpointGeneric<{
2272
2676
  universe_id: string;
@@ -2287,8 +2691,13 @@ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsU
2287
2691
  };
2288
2692
  }, undefined>;
2289
2693
  /**
2290
- * @api PATCH https://apis.roblox.com/cloud/v2/universes/:universe_id/places/:place_id/user-restrictions/:user_restriction_id
2291
- * @summary Update User Restriction
2694
+ * `BETA`
2695
+ *
2696
+ * Update the user restriction.
2697
+ *
2698
+ * **Scopes:** `universe.user-restriction:write`
2699
+ * **Engine:** Not available in-engine
2700
+ *
2292
2701
  * @param body
2293
2702
  * @param universe_id The universe ID.
2294
2703
  * @param place_id The place ID.
@@ -2304,7 +2713,6 @@ that index into `game_join_restriction` (such as
2304
2713
  If this is further in the past than the lifetime of the idempotency key
2305
2714
  (which *may* exceed the annotated minimum lifetime), the server *must*
2306
2715
  return an error.
2307
- * @description Update the user restriction.
2308
2716
  */
2309
2717
  export declare const patchCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrictionId: import("../..").EndpointGeneric<{
2310
2718
  universe_id: string;
@@ -2341,13 +2749,9 @@ export declare const patchCloudV2UniversesUniverseIdPlacesPlaceIdUserRestriction
2341
2749
  };
2342
2750
  }>;
2343
2751
  /**
2344
- * @api POST https://apis.roblox.com/cloud/v2/universes/:universe_id/places/:place_id/versions/:version_id/luau-execution-session-tasks
2345
- * @summary Create Luau Execution Session Task
2346
- * @param body
2347
- * @param universe_id The universe ID.
2348
- * @param place_id The place ID.
2349
- * @param version_id The version ID.
2350
- * @description Creates a task but does not wait for the task to complete.
2752
+ * `BETA`
2753
+ *
2754
+ * Creates a task but does not wait for the task to complete.
2351
2755
 
2352
2756
  To check whether a task has
2353
2757
  completed, call the `GetLuauExecutionSessionTask` method and inspect the
@@ -2356,6 +2760,14 @@ completed, call the `GetLuauExecutionSessionTask` method and inspect the
2356
2760
  Quotas:
2357
2761
  * 5 calls per minute per API key owner
2358
2762
  * 45 calls per minute per IP address
2763
+ *
2764
+ * **Scopes:** `universe.place.luau-execution-session:write`
2765
+ * **Engine:** Not available in-engine
2766
+ *
2767
+ * @param body
2768
+ * @param universe_id The universe ID.
2769
+ * @param place_id The place ID.
2770
+ * @param version_id The version ID.
2359
2771
  */
2360
2772
  export declare const postCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionTasks: import("../..").EndpointGeneric<{
2361
2773
  universe_id: string;
@@ -2399,8 +2811,16 @@ export declare const postCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionI
2399
2811
  binaryOutputUri: string;
2400
2812
  }>;
2401
2813
  /**
2402
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/places/:place_id/versions/:version_id/luau-execution-sessions/:luau_execution_session_id/tasks/:task_id
2403
- * @summary Get Luau Execution Session Task
2814
+ * `BETA`
2815
+ *
2816
+ * Gets information about a task.
2817
+
2818
+ Quotas:
2819
+ * 45 calls per minute per API key owner or IP address
2820
+ *
2821
+ * **Scopes:** `universe.place.luau-execution-session:read`, `universe.place.luau-execution-session:write`
2822
+ * **Engine:** Not available in-engine
2823
+ *
2404
2824
  * @param universe_id The universe ID.
2405
2825
  * @param place_id The place ID.
2406
2826
  * @param version_id The version ID.
@@ -2419,10 +2839,6 @@ Possible values:
2419
2839
  | VIEW_UNSPECIFIED | The luau execution session task view is not specified; the default will be used. |
2420
2840
  | BASIC | Excludes the `script` field. |
2421
2841
  | FULL | Includes all fields. |
2422
- * @description Gets information about a task.
2423
-
2424
- Quotas:
2425
- * 45 calls per minute per API key owner or IP address
2426
2842
  */
2427
2843
  export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionsLuauExecutionSessionIdTasksTaskId: import("../..").EndpointGeneric<{
2428
2844
  universe_id: string;
@@ -2430,7 +2846,7 @@ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionId
2430
2846
  version_id: string;
2431
2847
  luau_execution_session_id: string;
2432
2848
  task_id: string;
2433
- view?: "VIEW_UNSPECIFIED" | "BASIC" | "FULL" | undefined;
2849
+ view?: "VIEW_UNSPECIFIED" | "FULL" | "BASIC" | undefined;
2434
2850
  }, {
2435
2851
  path: string;
2436
2852
  createTime: string;
@@ -2451,8 +2867,16 @@ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionId
2451
2867
  binaryOutputUri: string;
2452
2868
  }, undefined>;
2453
2869
  /**
2454
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/places/:place_id/versions/:version_id/luau-execution-sessions/:luau_execution_session_id/tasks/:task_id/logs
2455
- * @summary List Luau Execution Session Task Logs
2870
+ * `BETA`
2871
+ *
2872
+ * Lists log chunks generated by a `LuauExecutionSessionTask`.
2873
+
2874
+ Quotas:
2875
+ * 45 calls per minute per API key owner or IP address
2876
+ *
2877
+ * **Scopes:** `universe.place.luau-execution-session:read`, `universe.place.luau-execution-session:write`
2878
+ * **Engine:** Not available in-engine
2879
+ *
2456
2880
  * @param universe_id The universe ID.
2457
2881
  * @param place_id The place ID.
2458
2882
  * @param version_id The version ID.
@@ -2479,10 +2903,6 @@ Possible values:
2479
2903
  | VIEW_UNSPECIFIED | The luau execution session task log view is not specified; the default will be used. |
2480
2904
  | FLAT | If this view is selected, the `messages` field will be populated (and the `structuredMessages` field will not). Each entry of the `messages` array contains only the log message, without additional medata. This is the default. |
2481
2905
  | STRUCTURED | If this view is selected, the `structuredMessages` field will be populated (and the `messages` field will not). Each entry of the `structuredMessages` array contains the log message plus additional metadata (see `LogMessage` for details). |
2482
- * @description Lists log chunks generated by a `LuauExecutionSessionTask`.
2483
-
2484
- Quotas:
2485
- * 45 calls per minute per API key owner or IP address
2486
2906
  */
2487
2907
  export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionsLuauExecutionSessionIdTasksTaskIdLogs: import("../..").EndpointGeneric<{
2488
2908
  universe_id: string;
@@ -2506,8 +2926,21 @@ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionId
2506
2926
  nextPageToken: string;
2507
2927
  }, undefined>;
2508
2928
  /**
2509
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/subscription-products/:subscription_product_id/subscriptions/:subscription_id
2510
- * @summary Get Subscription
2929
+ * `BETA`
2930
+ *
2931
+ * Get the subscription.
2932
+
2933
+ The `universe.subscription-product.subscription:read` scope only allows
2934
+ reading subscriptions of the user making the request. Because of this, the
2935
+ subscription ID must match the user ID of the user making the request. Note
2936
+ that this scope might be more relevant for OAuth 2.0 apps.
2937
+
2938
+ To read all subscriptions made by users for a particular universe, use the
2939
+ `universe:write` scope instead.
2940
+ *
2941
+ * **Scopes:** `universe:write`, `universe.subscription-product.subscription:read`
2942
+ * **Engine:** Not available in-engine
2943
+ *
2511
2944
  * @param universe_id The universe ID.
2512
2945
  * @param subscription_product_id The subscription-product ID.
2513
2946
  * @param subscription_id The subscription ID.
@@ -2524,21 +2957,12 @@ Possible values:
2524
2957
  | VIEW_UNSPECIFIED | The subscription view is not specified; the default will be used. |
2525
2958
  | BASIC | Includes only the `active` and `renewing` fields. |
2526
2959
  | FULL | Includes all fields. |
2527
- * @description Get the subscription.
2528
-
2529
- The `universe.subscription-product.subscription:read` scope only allows
2530
- reading subscriptions of the user making the request. Because of this, the
2531
- subscription ID must match the user ID of the user making the request. Note
2532
- that this scope might be more relevant for OAuth 2.0 apps.
2533
-
2534
- To read all subscriptions made by users for a particular universe, use the
2535
- `universe:write` scope instead.
2536
2960
  */
2537
2961
  export declare const getCloudV2UniversesUniverseIdSubscriptionProductsSubscriptionProductIdSubscriptionsSubscriptionId: import("../..").EndpointGeneric<{
2538
2962
  universe_id: string;
2539
2963
  subscription_product_id: string;
2540
2964
  subscription_id: string;
2541
- view?: "VIEW_UNSPECIFIED" | "BASIC" | "FULL" | undefined;
2965
+ view?: "VIEW_UNSPECIFIED" | "FULL" | "BASIC" | undefined;
2542
2966
  }, {
2543
2967
  path: string;
2544
2968
  createTime: string;
@@ -2557,8 +2981,14 @@ export declare const getCloudV2UniversesUniverseIdSubscriptionProductsSubscripti
2557
2981
  user: string;
2558
2982
  }, undefined>;
2559
2983
  /**
2560
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/user-restrictions
2561
- * @summary List User Restrictions
2984
+ * `BETA`
2985
+ *
2986
+ * List user restrictions for users that have ever been banned in either a
2987
+ universe or a specific place.
2988
+ *
2989
+ * **Scopes:** `universe.user-restriction:read`
2990
+ * **Engine:** Not available in-engine
2991
+ *
2562
2992
  * @param universe_id The universe ID.
2563
2993
  * @param maxPageSize The maximum number of user restrictions to return. The service might return
2564
2994
  fewer than this value. If unspecified, at most 10 user restrictions are
@@ -2567,8 +2997,6 @@ returned. The maximum value is 100 and higher values are set to 100.
2567
2997
 
2568
2998
  When paginating, all other parameters provided to the subsequent call must
2569
2999
  match the call that provided the page token.
2570
- * @description List user restrictions for users that have ever been banned in either a
2571
- universe or a specific place.
2572
3000
  */
2573
3001
  export declare const getCloudV2UniversesUniverseIdUserRestrictions: import("../..").EndpointGeneric<{
2574
3002
  universe_id: string;
@@ -2592,8 +3020,16 @@ export declare const getCloudV2UniversesUniverseIdUserRestrictions: import("../.
2592
3020
  nextPageToken: string;
2593
3021
  }, undefined>;
2594
3022
  /**
2595
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/user-restrictions:listLogs
2596
- * @summary List User Restriction Logs
3023
+ * `BETA`
3024
+ *
3025
+ * List changes to UserRestriction resources within a given universe.
3026
+ This includes both universe-level and place-level restrictions.
3027
+
3028
+ For universe-level restriction logs, the `place` field will be empty.
3029
+ *
3030
+ * **Scopes:** `universe.user-restriction:read`
3031
+ * **Engine:** Not available in-engine
3032
+ *
2597
3033
  * @param universe_id The universe ID.
2598
3034
  * @param maxPageSize The maximum number of UserRestrictionLogs to return. The service may return
2599
3035
  fewer than this value. If unspecified, at most 10 UserRestrictionLogs are
@@ -2613,10 +3049,6 @@ The `filter` field supports a very small number of CEL:
2613
3049
 
2614
3050
  As an example, filtering for a user and a place takes the form
2615
3051
  `filter="user == 'users/123'" && "place == 'places/456'"`
2616
- * @description List changes to UserRestriction resources within a given universe.
2617
- This includes both universe-level and place-level restrictions.
2618
-
2619
- For universe-level restriction logs, the `place` field will be empty.
2620
3052
  */
2621
3053
  export declare const getCloudV2UniversesUniverseIdUserRestrictionsListLogs: import("../..").EndpointGeneric<{
2622
3054
  universe_id: string;
@@ -2645,11 +3077,15 @@ export declare const getCloudV2UniversesUniverseIdUserRestrictionsListLogs: impo
2645
3077
  nextPageToken: string;
2646
3078
  }, undefined>;
2647
3079
  /**
2648
- * @api GET https://apis.roblox.com/cloud/v2/universes/:universe_id/user-restrictions/:user_restriction_id
2649
- * @summary Get User Restriction
3080
+ * `BETA`
3081
+ *
3082
+ * Get the user restriction.
3083
+ *
3084
+ * **Scopes:** `universe.user-restriction:read`
3085
+ * **Engine:** Not available in-engine
3086
+ *
2650
3087
  * @param universe_id The universe ID.
2651
3088
  * @param user_restriction_id The user-restriction ID.
2652
- * @description Get the user restriction.
2653
3089
  */
2654
3090
  export declare const getCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId: import("../..").EndpointGeneric<{
2655
3091
  universe_id: string;
@@ -2669,8 +3105,13 @@ export declare const getCloudV2UniversesUniverseIdUserRestrictionsUserRestrictio
2669
3105
  };
2670
3106
  }, undefined>;
2671
3107
  /**
2672
- * @api PATCH https://apis.roblox.com/cloud/v2/universes/:universe_id/user-restrictions/:user_restriction_id
2673
- * @summary Update User Restriction
3108
+ * `BETA`
3109
+ *
3110
+ * Update the user restriction.
3111
+ *
3112
+ * **Scopes:** `universe.user-restriction:write`
3113
+ * **Engine:** Not available in-engine
3114
+ *
2674
3115
  * @param body
2675
3116
  * @param universe_id The universe ID.
2676
3117
  * @param user_restriction_id The user-restriction ID.
@@ -2685,7 +3126,6 @@ that index into `game_join_restriction` (such as
2685
3126
  If this is further in the past than the lifetime of the idempotency key
2686
3127
  (which *may* exceed the annotated minimum lifetime), the server *must*
2687
3128
  return an error.
2688
- * @description Update the user restriction.
2689
3129
  */
2690
3130
  export declare const patchCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId: import("../..").EndpointGeneric<{
2691
3131
  universe_id: string;
@@ -2721,10 +3161,9 @@ export declare const patchCloudV2UniversesUniverseIdUserRestrictionsUserRestrict
2721
3161
  };
2722
3162
  }>;
2723
3163
  /**
2724
- * @api GET https://apis.roblox.com/cloud/v2/users/:user_id
2725
- * @summary Get User
2726
- * @param user_id The user ID.
2727
- * @description Gets a user's basic and advanced information.
3164
+ * `BETA`
3165
+ *
3166
+ * Gets a user's basic and advanced information.
2728
3167
 
2729
3168
  To access a user's public information, no additional scopes are required.
2730
3169
 
@@ -2734,6 +3173,11 @@ To access a user's verification status, you need the following scopes:
2734
3173
  To access a user's social account information, you need the following
2735
3174
  scopes:
2736
3175
  * user.social:read
3176
+ *
3177
+ * **Scopes:** `user.advanced:read`, `user.social:read`
3178
+ * **Engine:** Not available in-engine
3179
+ *
3180
+ * @param user_id The user ID.
2737
3181
  */
2738
3182
  export declare const getCloudV2UsersUserId: import("../..").EndpointGeneric<{
2739
3183
  user_id: string;
@@ -2757,8 +3201,12 @@ export declare const getCloudV2UsersUserId: import("../..").EndpointGeneric<{
2757
3201
  };
2758
3202
  }, undefined>;
2759
3203
  /**
2760
- * @api GET https://apis.roblox.com/cloud/v2/users/:user_id:generateThumbnail
2761
- * @summary Generate User Thumbnail
3204
+ * `BETA`
3205
+ *
3206
+ * Generates and returns the URL for the user's avatar thumbnail.
3207
+ *
3208
+ * **Engine:** Not available in-engine
3209
+ *
2762
3210
  * @param user_id The user ID.
2763
3211
  * @param size Size of the generated thumbnail. The generated thumbnail will have `size *
2764
3212
  size` dimension.
@@ -2784,7 +3232,6 @@ Possible values:
2784
3232
  | SHAPE_UNSPECIFIED | Default UserThumbnail Shape -- set to round |
2785
3233
  | ROUND | Generate thumbnail as a circle. |
2786
3234
  | SQUARE | Generate thumbnail as a rectangle. |
2787
- * @description Generates and returns the URL for the user's avatar thumbnail.
2788
3235
  */
2789
3236
  export declare const getCloudV2UsersUserIdGenerateThumbnail: import("../..").EndpointGeneric<{
2790
3237
  user_id: string;
@@ -2809,8 +3256,13 @@ export declare const getCloudV2UsersUserIdGenerateThumbnail: import("../..").End
2809
3256
  };
2810
3257
  }, undefined>;
2811
3258
  /**
2812
- * @api GET https://apis.roblox.com/cloud/v2/users/:user_id/asset-quotas
2813
- * @summary List Asset Quotas
3259
+ * `BETA`
3260
+ *
3261
+ * Returns a list of asset quotas.
3262
+ *
3263
+ * **Scopes:** `asset:read`
3264
+ * **Engine:** Not available in-engine
3265
+ *
2814
3266
  * @param user_id The user ID.
2815
3267
  * @param maxPageSize The maximum number of asset quotas to return. The service might return
2816
3268
  fewer than this value. If unspecified, at most 10 asset quotas are
@@ -2827,7 +3279,6 @@ Supports the following subset of CEL:
2827
3279
 
2828
3280
  For example:
2829
3281
  `quotaType == RateLimitUpload && assetType == Audio`
2830
- * @description Returns a list of asset quotas.
2831
3282
  */
2832
3283
  export declare const getCloudV2UsersUserIdAssetQuotas: import("../..").EndpointGeneric<{
2833
3284
  user_id: string;
@@ -2847,22 +3298,9 @@ export declare const getCloudV2UsersUserIdAssetQuotas: import("../..").EndpointG
2847
3298
  nextPageToken: string;
2848
3299
  }, undefined>;
2849
3300
  /**
2850
- * @api GET https://apis.roblox.com/cloud/v2/users/:user_id/inventory-items
2851
- * @summary List Inventory Items
2852
- * @param user_id The user ID.
2853
- * @param maxPageSize The maximum number of inventory items to return. The service might return
2854
- fewer than this value. If unspecified, at most 10 inventory items are
2855
- returned. The maximum value is 100 and higher values are set to 100.
2856
- * @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
2857
-
2858
- When paginating, all other parameters provided to the subsequent call must
2859
- match the call that provided the page token.
2860
- * @param filter This field may be set in order to filter the resources returned.
2861
-
2862
- See the
2863
- [filtering](/cloud/reference/patterns#list-inventory-items)
2864
- documentation for more information.
2865
- * @description List the inventory items in a user's inventory.
3301
+ * `BETA`
3302
+ *
3303
+ * List the inventory items in a user's inventory.
2866
3304
 
2867
3305
  The inventory items returned depend on the target user’s choice under
2868
3306
  **Settings > Privacy > Who can see my inventory?**:
@@ -2880,6 +3318,23 @@ Rate Limits:
2880
3318
  * API Keys - 100 requests/minute per API key owner (can be user or group).
2881
3319
  Rate limits are enforced across all of an owner's API keys.
2882
3320
  * OAuth2 Tokens - 20 requests/minute per OAuth2 access token
3321
+ *
3322
+ * **Scopes:** `user.inventory-item:read`
3323
+ * **Engine:** Usable with HttpService
3324
+ *
3325
+ * @param user_id The user ID.
3326
+ * @param maxPageSize The maximum number of inventory items to return. The service might return
3327
+ fewer than this value. If unspecified, at most 10 inventory items are
3328
+ returned. The maximum value is 100 and higher values are set to 100.
3329
+ * @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
3330
+
3331
+ When paginating, all other parameters provided to the subsequent call must
3332
+ match the call that provided the page token.
3333
+ * @param filter This field may be set in order to filter the resources returned.
3334
+
3335
+ See the
3336
+ [filtering](/cloud/reference/patterns#list-inventory-items)
3337
+ documentation for more information.
2883
3338
  */
2884
3339
  export declare const getCloudV2UsersUserIdInventoryItems: import("../..").EndpointGeneric<{
2885
3340
  user_id: string;
@@ -2914,11 +3369,15 @@ export declare const getCloudV2UsersUserIdInventoryItems: import("../..").Endpoi
2914
3369
  nextPageToken: string;
2915
3370
  }, undefined>;
2916
3371
  /**
2917
- * @api POST https://apis.roblox.com/cloud/v2/users/:user_id/notifications
2918
- * @summary Create User Notification
3372
+ * `STABLE`
3373
+ *
3374
+ * Sends a notification to a user.
3375
+ *
3376
+ * **Scopes:** `user.user-notification:write`
3377
+ * **Engine:** Not available in-engine
3378
+ *
2919
3379
  * @param body
2920
3380
  * @param user_id The user ID.
2921
- * @description Sends a notification to a user.
2922
3381
  */
2923
3382
  export declare const postCloudV2UsersUserIdNotifications: import("../..").EndpointGeneric<{
2924
3383
  user_id: string;