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.
- package/lib/endpoints/accountsettingsv1.d.ts +27 -33
- package/lib/endpoints/accountsettingsv1.js +11 -22
- package/lib/endpoints/adconfigurationv2.d.ts +104 -119
- package/lib/endpoints/adconfigurationv2.js +32 -48
- package/lib/endpoints/assetdeliveryv1.d.ts +25 -24
- package/lib/endpoints/assetdeliveryv1.js +25 -24
- package/lib/endpoints/assetdeliveryv2.d.ts +25 -24
- package/lib/endpoints/assetdeliveryv2.js +25 -24
- package/lib/endpoints/authv1.d.ts +132 -84
- package/lib/endpoints/authv1.js +118 -64
- package/lib/endpoints/authv2.d.ts +56 -56
- package/lib/endpoints/authv2.js +57 -50
- package/lib/endpoints/authv3.d.ts +11 -11
- package/lib/endpoints/authv3.js +11 -11
- package/lib/endpoints/avatarv1.d.ts +1 -0
- package/lib/endpoints/avatarv1.js +1 -0
- package/lib/endpoints/avatarv2.d.ts +1 -0
- package/lib/endpoints/avatarv2.js +1 -0
- package/lib/endpoints/avatarv3.d.ts +1 -0
- package/lib/endpoints/avatarv3.js +1 -0
- package/lib/endpoints/badgesv1.d.ts +6 -22
- package/lib/endpoints/badgesv1.js +2 -22
- package/lib/endpoints/catalogv1.d.ts +39 -113
- package/lib/endpoints/catalogv1.js +39 -107
- package/lib/endpoints/catalogv2.d.ts +11 -11
- package/lib/endpoints/catalogv2.js +11 -11
- package/lib/endpoints/clientsettingsv2.d.ts +8 -7
- package/lib/endpoints/clientsettingsv2.js +9 -1
- package/lib/endpoints/developv1.d.ts +31 -31
- package/lib/endpoints/developv1.js +26 -26
- package/lib/endpoints/developv2.d.ts +27 -27
- package/lib/endpoints/developv2.js +22 -22
- package/lib/endpoints/economycreatorstatsv1.d.ts +1 -1
- package/lib/endpoints/economycreatorstatsv1.js +1 -1
- package/lib/endpoints/followingsv2.d.ts +2 -2
- package/lib/endpoints/followingsv2.js +2 -2
- package/lib/endpoints/friendsv1.d.ts +24 -98
- package/lib/endpoints/friendsv1.js +25 -91
- package/lib/endpoints/gamesv1.d.ts +31 -615
- package/lib/endpoints/gamesv1.js +32 -608
- package/lib/endpoints/gamesv2.d.ts +187 -260
- package/lib/endpoints/gamesv2.js +130 -190
- package/lib/endpoints/groupsv1.d.ts +34 -28
- package/lib/endpoints/groupsv1.js +31 -18
- package/lib/endpoints/groupsv2.d.ts +92 -92
- package/lib/endpoints/groupsv2.js +93 -87
- package/lib/endpoints/inventoryv1.d.ts +9 -21
- package/lib/endpoints/inventoryv1.js +4 -4
- package/lib/endpoints/inventoryv2.d.ts +91 -91
- package/lib/endpoints/inventoryv2.js +86 -86
- package/lib/endpoints/itemconfigurationv1.d.ts +1 -1
- package/lib/endpoints/itemconfigurationv1.js +1 -1
- package/lib/endpoints/thumbnailsv1.d.ts +1 -0
- package/lib/endpoints/thumbnailsv1.js +1 -0
- package/lib/endpoints/tradesv1.d.ts +10 -16
- package/lib/endpoints/tradesv1.js +10 -10
- package/lib/endpoints/twostepverificationv1.d.ts +59 -59
- package/lib/endpoints/twostepverificationv1.js +59 -59
- package/lib/endpoints/usersv1.d.ts +1 -1
- package/lib/endpoints/usersv1.js +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +29 -3
- package/lib/opencloud/v1/asset-permissions.d.ts +7 -2
- package/lib/opencloud/v1/asset-permissions.js +9 -3
- package/lib/opencloud/v1/assets.d.ts +59 -32
- package/lib/opencloud/v1/assets.js +77 -41
- package/lib/opencloud/v1/datastores-ordered.d.ts +50 -14
- package/lib/opencloud/v1/datastores-ordered.js +62 -20
- package/lib/opencloud/v1/datastores.d.ts +99 -42
- package/lib/opencloud/v1/datastores.js +123 -50
- package/lib/opencloud/v1/developer-products.d.ts +29 -11
- package/lib/opencloud/v1/developer-products.js +37 -15
- package/lib/opencloud/v1/game-passes.d.ts +29 -11
- package/lib/opencloud/v1/game-passes.js +37 -15
- package/lib/opencloud/v1/messaging.d.ts +6 -2
- package/lib/opencloud/v1/messaging.js +8 -3
- package/lib/opencloud/v1/open-eval.d.ts +14 -4
- package/lib/opencloud/v1/open-eval.js +18 -6
- package/lib/opencloud/v1/secrets-store.d.ts +46 -26
- package/lib/opencloud/v1/secrets-store.js +56 -31
- package/lib/opencloud/v1/toolbox.d.ts +14 -6
- package/lib/opencloud/v1/toolbox.js +18 -8
- package/lib/opencloud/v1/universes.d.ts +6 -2
- package/lib/opencloud/v1/universes.js +8 -3
- package/lib/opencloud/v2/cloud.d.ts +854 -395
- package/lib/opencloud/v2/cloud.js +967 -395
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
exports.postCloudV2UsersUserIdNotifications = exports.getCloudV2UsersUserIdInventoryItems = exports.getCloudV2UsersUserIdAssetQuotas = exports.getCloudV2UsersUserIdGenerateThumbnail = exports.getCloudV2UsersUserId = exports.patchCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId = exports.getCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId = exports.getCloudV2UniversesUniverseIdUserRestrictionsListLogs = exports.getCloudV2UniversesUniverseIdUserRestrictions = exports.getCloudV2UniversesUniverseIdSubscriptionProductsSubscriptionProductIdSubscriptionsSubscriptionId = exports.getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionsLuauExecutionSessionIdTasksTaskIdLogs = exports.getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionsLuauExecutionSessionIdTasksTaskId = exports.postCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionTasks = exports.patchCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrictionId = exports.getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrictionId = exports.getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictions = exports.postCloudV2UniversesUniverseIdPlacesPlaceIdLuauExecutionSessionTasks = exports.getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceIdListChildren = exports.patchCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId = exports.getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId = exports.patchCloudV2UniversesUniverseIdPlacesPlaceId = exports.getCloudV2UniversesUniverseIdPlacesPlaceId = exports.postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryIdIncrement = exports.patchCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId = void 0;
|
|
3
|
+
exports.getCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntries = exports.patchCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId = exports.deleteCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId = exports.getCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId = exports.postCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItems = exports.getCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItems = exports.getCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItemsRead = exports.postCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItemsDiscard = exports.postCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItems = exports.postCloudV2UniversesUniverseIdMemoryStoreFlush = exports.postCloudV2UniversesUniverseIdLuauExecutionSessionTaskBinaryInputs = exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryIdListRevisions = exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryIdIncrement = exports.patchCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryId = exports.deleteCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryId = exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryId = exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntries = exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntries = exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryIdListRevisions = exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryIdIncrement = exports.patchCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId = exports.deleteCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId = exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId = exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries = exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries = exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdUndelete = exports.deleteCloudV2UniversesUniverseIdDataStoresDataStoreId = exports.postCloudV2UniversesUniverseIdDataStoresSnapshot = exports.getCloudV2UniversesUniverseIdDataStores = exports.postCloudV2UniversesUniverseIdTranslateText = exports.postCloudV2UniversesUniverseIdRestartServers = exports.postCloudV2UniversesUniverseIdPublishMessage = exports.postCloudV2UniversesUniverseIdGenerateSpeechAsset = exports.patchCloudV2UniversesUniverseId = exports.getCloudV2UniversesUniverseId = exports.getCloudV2GroupsGroupIdShout = exports.getCloudV2GroupsGroupIdRolesRoleId = exports.getCloudV2GroupsGroupIdRoles = exports.patchCloudV2GroupsGroupIdMembershipsMembershipId = exports.getCloudV2GroupsGroupIdMemberships = exports.postCloudV2GroupsGroupIdJoinRequestsJoinRequestIdDecline = exports.postCloudV2GroupsGroupIdJoinRequestsJoinRequestIdAccept = exports.getCloudV2GroupsGroupIdJoinRequests = exports.getCloudV2GroupsGroupIdForumCategoriesForumCategoryIdPostsPostIdComments = exports.getCloudV2GroupsGroupIdForumCategoriesForumCategoryIdPosts = exports.getCloudV2GroupsGroupIdForumCategories = exports.getCloudV2GroupsGroupId = exports.patchCloudV2CreatorStoreProductsCreatorStoreProductId = exports.getCloudV2CreatorStoreProductsCreatorStoreProductId = exports.postCloudV2CreatorStoreProducts = void 0;
|
|
4
|
+
exports.postCloudV2UsersUserIdNotifications = exports.getCloudV2UsersUserIdInventoryItems = exports.getCloudV2UsersUserIdAssetQuotas = exports.getCloudV2UsersUserIdGenerateThumbnail = exports.getCloudV2UsersUserId = exports.patchCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId = exports.getCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId = exports.getCloudV2UniversesUniverseIdUserRestrictionsListLogs = exports.getCloudV2UniversesUniverseIdUserRestrictions = exports.getCloudV2UniversesUniverseIdSubscriptionProductsSubscriptionProductIdSubscriptionsSubscriptionId = exports.getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionsLuauExecutionSessionIdTasksTaskIdLogs = exports.getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionsLuauExecutionSessionIdTasksTaskId = exports.postCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionTasks = exports.patchCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrictionId = exports.getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrictionId = exports.getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictions = exports.postCloudV2UniversesUniverseIdPlacesPlaceIdLuauExecutionSessionTasks = exports.getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceIdListChildren = exports.patchCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId = exports.getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId = exports.patchCloudV2UniversesUniverseIdPlacesPlaceId = exports.getCloudV2UniversesUniverseIdPlacesPlaceId = exports.postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryIdIncrement = exports.patchCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId = exports.deleteCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId = exports.getCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId = exports.postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntries = void 0;
|
|
5
5
|
const zod_1 = require("zod");
|
|
6
6
|
const __1 = require("../..");
|
|
7
7
|
const Decimal = zod_1.z.object({
|
|
@@ -45,6 +45,58 @@ const Group = zod_1.z.object({
|
|
|
45
45
|
locked: zod_1.z.boolean(),
|
|
46
46
|
verified: zod_1.z.boolean(),
|
|
47
47
|
});
|
|
48
|
+
const GroupForumCategory = zod_1.z.object({
|
|
49
|
+
path: zod_1.z.string(),
|
|
50
|
+
createTime: zod_1.z.string().datetime({ offset: true }),
|
|
51
|
+
updateTime: zod_1.z.string().datetime({ offset: true }),
|
|
52
|
+
groupForumCategoryId: zod_1.z.string(),
|
|
53
|
+
displayName: zod_1.z.string(),
|
|
54
|
+
creator: zod_1.z.string(),
|
|
55
|
+
archiveTime: zod_1.z.string().datetime({ offset: true }),
|
|
56
|
+
archiver: zod_1.z.string(),
|
|
57
|
+
});
|
|
58
|
+
const ListGroupForumCategoriesResponse = zod_1.z.object({
|
|
59
|
+
groupForumCategories: zod_1.z.array(GroupForumCategory),
|
|
60
|
+
nextPageToken: zod_1.z.string(),
|
|
61
|
+
});
|
|
62
|
+
const MessageReaction = zod_1.z.object({
|
|
63
|
+
emoteId: zod_1.z.string(),
|
|
64
|
+
count: zod_1.z.number().int(),
|
|
65
|
+
});
|
|
66
|
+
const ContentMessage = zod_1.z.object({
|
|
67
|
+
createTime: zod_1.z.string().datetime({ offset: true }),
|
|
68
|
+
updateTime: zod_1.z.string().datetime({ offset: true }),
|
|
69
|
+
plainText: zod_1.z.string(),
|
|
70
|
+
author: zod_1.z.string(),
|
|
71
|
+
messageReaction: zod_1.z.array(MessageReaction),
|
|
72
|
+
});
|
|
73
|
+
const GroupForumComment = zod_1.z.object({
|
|
74
|
+
path: zod_1.z.string(),
|
|
75
|
+
groupForumCommentId: zod_1.z.string(),
|
|
76
|
+
message: ContentMessage,
|
|
77
|
+
});
|
|
78
|
+
const GroupForumPost = zod_1.z.object({
|
|
79
|
+
path: zod_1.z.string(),
|
|
80
|
+
createTime: zod_1.z.string().datetime({ offset: true }),
|
|
81
|
+
updateTime: zod_1.z.string().datetime({ offset: true }),
|
|
82
|
+
pinned: zod_1.z.boolean(),
|
|
83
|
+
locked: zod_1.z.boolean(),
|
|
84
|
+
groupForumPostId: zod_1.z.string(),
|
|
85
|
+
title: zod_1.z.string(),
|
|
86
|
+
firstComment: GroupForumComment,
|
|
87
|
+
author: zod_1.z.string(),
|
|
88
|
+
archiveTime: zod_1.z.string().datetime({ offset: true }),
|
|
89
|
+
archiver: zod_1.z.string(),
|
|
90
|
+
commentCount: zod_1.z.number().int(),
|
|
91
|
+
});
|
|
92
|
+
const ListGroupForumPostsResponse = zod_1.z.object({
|
|
93
|
+
groupForumPosts: zod_1.z.array(GroupForumPost),
|
|
94
|
+
nextPageToken: zod_1.z.string(),
|
|
95
|
+
});
|
|
96
|
+
const ListGroupForumCommentsResponse = zod_1.z.object({
|
|
97
|
+
groupForumComments: zod_1.z.array(GroupForumComment),
|
|
98
|
+
nextPageToken: zod_1.z.string(),
|
|
99
|
+
});
|
|
48
100
|
const GroupJoinRequest = zod_1.z.object({
|
|
49
101
|
path: zod_1.z.string(),
|
|
50
102
|
createTime: zod_1.z.string().datetime({ offset: true }),
|
|
@@ -655,17 +707,22 @@ const UserNotification = zod_1.z.object({
|
|
|
655
707
|
payload: UserNotification_Payload,
|
|
656
708
|
});
|
|
657
709
|
/**
|
|
658
|
-
*
|
|
659
|
-
*
|
|
660
|
-
*
|
|
661
|
-
* @description Add a Creator Store product. Only use this method if your product has never
|
|
710
|
+
* `BETA`
|
|
711
|
+
*
|
|
712
|
+
* Add a Creator Store product. Only use this method if your product has never
|
|
662
713
|
been distributed on the Creator Store; otherwise, use the `PATCH` method to
|
|
663
714
|
update the product.
|
|
715
|
+
*
|
|
716
|
+
* **Scopes:** `creator-store-product:write`
|
|
717
|
+
* **Engine:** Not available in-engine
|
|
718
|
+
*
|
|
719
|
+
* @param body
|
|
664
720
|
*/
|
|
665
721
|
exports.postCloudV2CreatorStoreProducts = (0, __1.endpoint)({
|
|
666
722
|
method: 'POST',
|
|
667
723
|
path: '/cloud/v2/creator-store-products',
|
|
668
724
|
baseUrl: 'https://apis.roblox.com',
|
|
725
|
+
scopes: ['creator-store-product:write'],
|
|
669
726
|
requestFormat: 'json',
|
|
670
727
|
serializationMethod: {
|
|
671
728
|
body: {},
|
|
@@ -676,15 +733,20 @@ exports.postCloudV2CreatorStoreProducts = (0, __1.endpoint)({
|
|
|
676
733
|
errors: [],
|
|
677
734
|
});
|
|
678
735
|
/**
|
|
679
|
-
*
|
|
680
|
-
*
|
|
736
|
+
* `BETA`
|
|
737
|
+
*
|
|
738
|
+
* Get a Creator Store product.
|
|
739
|
+
*
|
|
740
|
+
* **Scopes:** `creator-store-product:read`
|
|
741
|
+
* **Engine:** Not available in-engine
|
|
742
|
+
*
|
|
681
743
|
* @param creator_store_product_id The creator-store-product ID.
|
|
682
|
-
* @description Get a Creator Store product.
|
|
683
744
|
*/
|
|
684
745
|
exports.getCloudV2CreatorStoreProductsCreatorStoreProductId = (0, __1.endpoint)({
|
|
685
746
|
method: 'GET',
|
|
686
747
|
path: '/cloud/v2/creator-store-products/:creator_store_product_id',
|
|
687
748
|
baseUrl: 'https://apis.roblox.com',
|
|
749
|
+
scopes: ['creator-store-product:read'],
|
|
688
750
|
requestFormat: 'json',
|
|
689
751
|
serializationMethod: {
|
|
690
752
|
creator_store_product_id: {},
|
|
@@ -696,19 +758,24 @@ exports.getCloudV2CreatorStoreProductsCreatorStoreProductId = (0, __1.endpoint)(
|
|
|
696
758
|
errors: [],
|
|
697
759
|
});
|
|
698
760
|
/**
|
|
699
|
-
*
|
|
700
|
-
*
|
|
761
|
+
* `BETA`
|
|
762
|
+
*
|
|
763
|
+
* Update a Creator Store product.
|
|
764
|
+
*
|
|
765
|
+
* **Scopes:** `creator-store-product:write`
|
|
766
|
+
* **Engine:** Not available in-engine
|
|
767
|
+
*
|
|
701
768
|
* @param body
|
|
702
769
|
* @param creator_store_product_id The creator-store-product ID.
|
|
703
770
|
* @param updateMask The list of fields to update.
|
|
704
771
|
* @param allowMissing If set to true, and the creator store product is not found, a creator store
|
|
705
772
|
product is created. In this situation, `update_mask` is ignored.
|
|
706
|
-
* @description Update a Creator Store product.
|
|
707
773
|
*/
|
|
708
774
|
exports.patchCloudV2CreatorStoreProductsCreatorStoreProductId = (0, __1.endpoint)({
|
|
709
775
|
method: 'PATCH',
|
|
710
776
|
path: '/cloud/v2/creator-store-products/:creator_store_product_id',
|
|
711
777
|
baseUrl: 'https://apis.roblox.com',
|
|
778
|
+
scopes: ['creator-store-product:write'],
|
|
712
779
|
requestFormat: 'json',
|
|
713
780
|
serializationMethod: {
|
|
714
781
|
body: {},
|
|
@@ -726,10 +793,13 @@ exports.patchCloudV2CreatorStoreProductsCreatorStoreProductId = (0, __1.endpoint
|
|
|
726
793
|
errors: [],
|
|
727
794
|
});
|
|
728
795
|
/**
|
|
729
|
-
*
|
|
730
|
-
*
|
|
796
|
+
* `BETA`
|
|
797
|
+
*
|
|
798
|
+
* Gets the specified group.
|
|
799
|
+
*
|
|
800
|
+
* **Engine:** Usable with HttpService
|
|
801
|
+
*
|
|
731
802
|
* @param group_id The group ID.
|
|
732
|
-
* @description Gets the specified group.
|
|
733
803
|
*/
|
|
734
804
|
exports.getCloudV2GroupsGroupId = (0, __1.endpoint)({
|
|
735
805
|
method: 'GET',
|
|
@@ -746,8 +816,173 @@ exports.getCloudV2GroupsGroupId = (0, __1.endpoint)({
|
|
|
746
816
|
errors: [],
|
|
747
817
|
});
|
|
748
818
|
/**
|
|
749
|
-
*
|
|
750
|
-
*
|
|
819
|
+
* `BETA`
|
|
820
|
+
*
|
|
821
|
+
* Lists forum categories in the group.
|
|
822
|
+
*
|
|
823
|
+
* **Scopes:** `group-forum:read`
|
|
824
|
+
* **Engine:** Usable with HttpService
|
|
825
|
+
*
|
|
826
|
+
* @param group_id The group ID.
|
|
827
|
+
* @param maxPageSize The maximum number of group forum categories to return. The service might
|
|
828
|
+
return fewer than this value. If unspecified, at most 10 group forum
|
|
829
|
+
categories are returned. The maximum value is 10 and higher values are set
|
|
830
|
+
to 10.
|
|
831
|
+
* @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
|
|
832
|
+
|
|
833
|
+
When paginating, all other parameters provided to the subsequent call must
|
|
834
|
+
match the call that provided the page token.
|
|
835
|
+
* @param filter This field may be set in order to filter the resources returned.
|
|
836
|
+
|
|
837
|
+
Filtering conforms to Common Expression Language (CEL). Only the boolean
|
|
838
|
+
field `archived` and `==` operator are supported. If `archived=false`,
|
|
839
|
+
archived categories are not returned. The default value is `false`.
|
|
840
|
+
Example: `"filter=archived==true"`
|
|
841
|
+
*/
|
|
842
|
+
exports.getCloudV2GroupsGroupIdForumCategories = (0, __1.endpoint)({
|
|
843
|
+
method: 'GET',
|
|
844
|
+
path: '/cloud/v2/groups/:group_id/forum-categories',
|
|
845
|
+
baseUrl: 'https://apis.roblox.com',
|
|
846
|
+
scopes: ['group-forum:read'],
|
|
847
|
+
requestFormat: 'json',
|
|
848
|
+
serializationMethod: {
|
|
849
|
+
group_id: {},
|
|
850
|
+
maxPageSize: {},
|
|
851
|
+
pageToken: {},
|
|
852
|
+
filter: {},
|
|
853
|
+
},
|
|
854
|
+
parameters: {
|
|
855
|
+
group_id: zod_1.z.string(),
|
|
856
|
+
maxPageSize: zod_1.z.number().int().optional(),
|
|
857
|
+
pageToken: zod_1.z.string().optional(),
|
|
858
|
+
filter: zod_1.z.string().optional(),
|
|
859
|
+
},
|
|
860
|
+
response: ListGroupForumCategoriesResponse,
|
|
861
|
+
errors: [],
|
|
862
|
+
});
|
|
863
|
+
/**
|
|
864
|
+
* `BETA`
|
|
865
|
+
*
|
|
866
|
+
* Lists forum posts in the group's forum category.
|
|
867
|
+
*
|
|
868
|
+
* **Scopes:** `group-forum:read`
|
|
869
|
+
* **Engine:** Usable with HttpService
|
|
870
|
+
*
|
|
871
|
+
* @param group_id The group ID.
|
|
872
|
+
* @param forum_category_id The forum-category ID.
|
|
873
|
+
* @param maxPageSize The maximum number of group forum posts to return. The service might return
|
|
874
|
+
fewer than this value. If unspecified, at most 10 group forum posts are
|
|
875
|
+
returned. The maximum value is 100 and higher values are set to 100.
|
|
876
|
+
* @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
|
|
877
|
+
|
|
878
|
+
When paginating, all other parameters provided to the subsequent call must
|
|
879
|
+
match the call that provided the page token.
|
|
880
|
+
* @param filter This field may be set in order to filter the resources returned.
|
|
881
|
+
|
|
882
|
+
Filtering conforms to Common Expression Language (CEL). Only the query
|
|
883
|
+
`filter=pinned==true` is supported, where only pinned posts are returned.
|
|
884
|
+
`filter=pinned==false`is not supported.
|
|
885
|
+
* @param view The view in which to retrieve the group forum post.
|
|
886
|
+
|
|
887
|
+
Supports FULL and FULL_WITH_FIRST_COMMENT.
|
|
888
|
+
|
|
889
|
+
Defaults to FULL.
|
|
890
|
+
|
|
891
|
+
Possible values:
|
|
892
|
+
|
|
893
|
+
| Value | Description |
|
|
894
|
+
| --- | --- |
|
|
895
|
+
| VIEW_UNSPECIFIED | The group forum post view is not specified; the default will be used. |
|
|
896
|
+
| FULL | Includes all fields but does not dereference `first_comment`. Only the `path` field is populated. |
|
|
897
|
+
| FULL_WITH_FIRST_COMMENT | Includes all fields and also fully populates `first_comment`. The default view. |
|
|
898
|
+
*/
|
|
899
|
+
exports.getCloudV2GroupsGroupIdForumCategoriesForumCategoryIdPosts = (0, __1.endpoint)({
|
|
900
|
+
method: 'GET',
|
|
901
|
+
path: '/cloud/v2/groups/:group_id/forum-categories/:forum_category_id/posts',
|
|
902
|
+
baseUrl: 'https://apis.roblox.com',
|
|
903
|
+
scopes: ['group-forum:read'],
|
|
904
|
+
requestFormat: 'json',
|
|
905
|
+
serializationMethod: {
|
|
906
|
+
group_id: {},
|
|
907
|
+
forum_category_id: {},
|
|
908
|
+
maxPageSize: {},
|
|
909
|
+
pageToken: {},
|
|
910
|
+
filter: {},
|
|
911
|
+
view: {},
|
|
912
|
+
},
|
|
913
|
+
parameters: {
|
|
914
|
+
group_id: zod_1.z.string(),
|
|
915
|
+
forum_category_id: zod_1.z.string(),
|
|
916
|
+
maxPageSize: zod_1.z.number().int().optional(),
|
|
917
|
+
pageToken: zod_1.z.string().optional(),
|
|
918
|
+
filter: zod_1.z.string().optional(),
|
|
919
|
+
view: zod_1.z.enum(['VIEW_UNSPECIFIED', 'FULL', 'FULL_WITH_FIRST_COMMENT']).optional(),
|
|
920
|
+
},
|
|
921
|
+
response: ListGroupForumPostsResponse,
|
|
922
|
+
errors: [],
|
|
923
|
+
});
|
|
924
|
+
/**
|
|
925
|
+
* `BETA`
|
|
926
|
+
*
|
|
927
|
+
* Lists forum comments on a group's forum post.
|
|
928
|
+
*
|
|
929
|
+
* **Scopes:** `group-forum:read`
|
|
930
|
+
* **Engine:** Usable with HttpService
|
|
931
|
+
*
|
|
932
|
+
* @param group_id The group ID.
|
|
933
|
+
* @param forum_category_id The forum-category ID.
|
|
934
|
+
* @param post_id The post ID.
|
|
935
|
+
* @param maxPageSize The maximum number of group forum comments to return. The service might
|
|
936
|
+
return fewer than this value. If unspecified, at most 10 group forum
|
|
937
|
+
comments are returned. The maximum value is 100 and higher values are set
|
|
938
|
+
to 100.
|
|
939
|
+
* @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
|
|
940
|
+
|
|
941
|
+
When paginating, all other parameters provided to the subsequent call must
|
|
942
|
+
match the call that provided the page token.
|
|
943
|
+
* @param filter This field may be set in order to filter the resources returned.
|
|
944
|
+
|
|
945
|
+
Filtering conforms to Common Expression Language (CEL). Only the string
|
|
946
|
+
field `repliesToCommentId` and the `==` operator are supported.
|
|
947
|
+
If `repliesToCommentId` is specified, only comments that respond to the
|
|
948
|
+
comment are returned. The default value is `''`. If
|
|
949
|
+
`repliesToCommentId=''`, only comments responding directly to the post are
|
|
950
|
+
returned. Example:
|
|
951
|
+
`"filter=repliesToCommentId==01234567-89ab-cdef-0123-456789abcdef"`
|
|
952
|
+
*/
|
|
953
|
+
exports.getCloudV2GroupsGroupIdForumCategoriesForumCategoryIdPostsPostIdComments = (0, __1.endpoint)({
|
|
954
|
+
method: 'GET',
|
|
955
|
+
path: '/cloud/v2/groups/:group_id/forum-categories/:forum_category_id/posts/:post_id/comments',
|
|
956
|
+
baseUrl: 'https://apis.roblox.com',
|
|
957
|
+
scopes: ['group-forum:read'],
|
|
958
|
+
requestFormat: 'json',
|
|
959
|
+
serializationMethod: {
|
|
960
|
+
group_id: {},
|
|
961
|
+
forum_category_id: {},
|
|
962
|
+
post_id: {},
|
|
963
|
+
maxPageSize: {},
|
|
964
|
+
pageToken: {},
|
|
965
|
+
filter: {},
|
|
966
|
+
},
|
|
967
|
+
parameters: {
|
|
968
|
+
group_id: zod_1.z.string(),
|
|
969
|
+
forum_category_id: zod_1.z.string(),
|
|
970
|
+
post_id: zod_1.z.string(),
|
|
971
|
+
maxPageSize: zod_1.z.number().int().optional(),
|
|
972
|
+
pageToken: zod_1.z.string().optional(),
|
|
973
|
+
filter: zod_1.z.string().optional(),
|
|
974
|
+
},
|
|
975
|
+
response: ListGroupForumCommentsResponse,
|
|
976
|
+
errors: [],
|
|
977
|
+
});
|
|
978
|
+
/**
|
|
979
|
+
* `BETA`
|
|
980
|
+
*
|
|
981
|
+
* List join requests under a group.
|
|
982
|
+
*
|
|
983
|
+
* **Scopes:** `group:read`
|
|
984
|
+
* **Engine:** Usable with HttpService
|
|
985
|
+
*
|
|
751
986
|
* @param group_id The group ID.
|
|
752
987
|
* @param maxPageSize The maximum number of group join requests to return. The service might
|
|
753
988
|
return fewer than this value. If unspecified, at most 10 group join
|
|
@@ -764,12 +999,12 @@ field and `==` operator are supported.
|
|
|
764
999
|
|
|
765
1000
|
|
|
766
1001
|
Example: `"user == 'users/156'"`
|
|
767
|
-
* @description List join requests under a group.
|
|
768
1002
|
*/
|
|
769
1003
|
exports.getCloudV2GroupsGroupIdJoinRequests = (0, __1.endpoint)({
|
|
770
1004
|
method: 'GET',
|
|
771
1005
|
path: '/cloud/v2/groups/:group_id/join-requests',
|
|
772
1006
|
baseUrl: 'https://apis.roblox.com',
|
|
1007
|
+
scopes: ['group:read'],
|
|
773
1008
|
requestFormat: 'json',
|
|
774
1009
|
serializationMethod: {
|
|
775
1010
|
group_id: {},
|
|
@@ -787,17 +1022,22 @@ exports.getCloudV2GroupsGroupIdJoinRequests = (0, __1.endpoint)({
|
|
|
787
1022
|
errors: [],
|
|
788
1023
|
});
|
|
789
1024
|
/**
|
|
790
|
-
*
|
|
791
|
-
*
|
|
1025
|
+
* `BETA`
|
|
1026
|
+
*
|
|
1027
|
+
* Accepts a join request.
|
|
1028
|
+
*
|
|
1029
|
+
* **Scopes:** `group:write`
|
|
1030
|
+
* **Engine:** Usable with HttpService
|
|
1031
|
+
*
|
|
792
1032
|
* @param body
|
|
793
1033
|
* @param group_id The group ID.
|
|
794
1034
|
* @param join_request_id The join-request ID.
|
|
795
|
-
* @description Accepts a join request.
|
|
796
1035
|
*/
|
|
797
1036
|
exports.postCloudV2GroupsGroupIdJoinRequestsJoinRequestIdAccept = (0, __1.endpoint)({
|
|
798
1037
|
method: 'POST',
|
|
799
1038
|
path: '/cloud/v2/groups/:group_id/join-requests/:join_request_id:accept',
|
|
800
1039
|
baseUrl: 'https://apis.roblox.com',
|
|
1040
|
+
scopes: ['group:write'],
|
|
801
1041
|
requestFormat: 'json',
|
|
802
1042
|
serializationMethod: {
|
|
803
1043
|
body: {},
|
|
@@ -813,17 +1053,22 @@ exports.postCloudV2GroupsGroupIdJoinRequestsJoinRequestIdAccept = (0, __1.endpoi
|
|
|
813
1053
|
errors: [],
|
|
814
1054
|
});
|
|
815
1055
|
/**
|
|
816
|
-
*
|
|
817
|
-
*
|
|
1056
|
+
* `BETA`
|
|
1057
|
+
*
|
|
1058
|
+
* Declines a join request.
|
|
1059
|
+
*
|
|
1060
|
+
* **Scopes:** `group:write`
|
|
1061
|
+
* **Engine:** Usable with HttpService
|
|
1062
|
+
*
|
|
818
1063
|
* @param body
|
|
819
1064
|
* @param group_id The group ID.
|
|
820
1065
|
* @param join_request_id The join-request ID.
|
|
821
|
-
* @description Declines a join request.
|
|
822
1066
|
*/
|
|
823
1067
|
exports.postCloudV2GroupsGroupIdJoinRequestsJoinRequestIdDecline = (0, __1.endpoint)({
|
|
824
1068
|
method: 'POST',
|
|
825
1069
|
path: '/cloud/v2/groups/:group_id/join-requests/:join_request_id:decline',
|
|
826
1070
|
baseUrl: 'https://apis.roblox.com',
|
|
1071
|
+
scopes: ['group:write'],
|
|
827
1072
|
requestFormat: 'json',
|
|
828
1073
|
serializationMethod: {
|
|
829
1074
|
body: {},
|
|
@@ -839,8 +1084,12 @@ exports.postCloudV2GroupsGroupIdJoinRequestsJoinRequestIdDecline = (0, __1.endpo
|
|
|
839
1084
|
errors: [],
|
|
840
1085
|
});
|
|
841
1086
|
/**
|
|
842
|
-
*
|
|
843
|
-
*
|
|
1087
|
+
* `BETA`
|
|
1088
|
+
*
|
|
1089
|
+
* List group members in a group.
|
|
1090
|
+
*
|
|
1091
|
+
* **Engine:** Usable with HttpService
|
|
1092
|
+
*
|
|
844
1093
|
* @param group_id The group ID.
|
|
845
1094
|
* @param maxPageSize The maximum number of group memberships to return. The service might return
|
|
846
1095
|
fewer than this value. If unspecified, at most 10 group memberships are
|
|
@@ -854,7 +1103,6 @@ match the call that provided the page token.
|
|
|
854
1103
|
See the
|
|
855
1104
|
[filtering](/cloud/reference/patterns#list-group-memberships)
|
|
856
1105
|
documentation for more information.
|
|
857
|
-
* @description List group members in a group.
|
|
858
1106
|
*/
|
|
859
1107
|
exports.getCloudV2GroupsGroupIdMemberships = (0, __1.endpoint)({
|
|
860
1108
|
method: 'GET',
|
|
@@ -877,20 +1125,25 @@ exports.getCloudV2GroupsGroupIdMemberships = (0, __1.endpoint)({
|
|
|
877
1125
|
errors: [],
|
|
878
1126
|
});
|
|
879
1127
|
/**
|
|
880
|
-
*
|
|
881
|
-
*
|
|
882
|
-
*
|
|
883
|
-
* @param group_id The group ID.
|
|
884
|
-
* @param membership_id The membership ID.
|
|
885
|
-
* @description Updates the group membership for a particular group member. This action
|
|
1128
|
+
* `BETA`
|
|
1129
|
+
*
|
|
1130
|
+
* Updates the group membership for a particular group member. This action
|
|
886
1131
|
requires the requester to be able to manage lower ranked members. Guest or
|
|
887
1132
|
Owner ranks cannot be assigned, and a requester cannot change their own
|
|
888
1133
|
rank.
|
|
1134
|
+
*
|
|
1135
|
+
* **Scopes:** `group:write`
|
|
1136
|
+
* **Engine:** Usable with HttpService
|
|
1137
|
+
*
|
|
1138
|
+
* @param body
|
|
1139
|
+
* @param group_id The group ID.
|
|
1140
|
+
* @param membership_id The membership ID.
|
|
889
1141
|
*/
|
|
890
1142
|
exports.patchCloudV2GroupsGroupIdMembershipsMembershipId = (0, __1.endpoint)({
|
|
891
1143
|
method: 'PATCH',
|
|
892
1144
|
path: '/cloud/v2/groups/:group_id/memberships/:membership_id',
|
|
893
1145
|
baseUrl: 'https://apis.roblox.com',
|
|
1146
|
+
scopes: ['group:write'],
|
|
894
1147
|
requestFormat: 'json',
|
|
895
1148
|
serializationMethod: {
|
|
896
1149
|
body: {},
|
|
@@ -906,17 +1159,9 @@ exports.patchCloudV2GroupsGroupIdMembershipsMembershipId = (0, __1.endpoint)({
|
|
|
906
1159
|
errors: [],
|
|
907
1160
|
});
|
|
908
1161
|
/**
|
|
909
|
-
*
|
|
910
|
-
*
|
|
911
|
-
*
|
|
912
|
-
* @param maxPageSize The maximum number of group roles to return. The service might return fewer
|
|
913
|
-
than this value. If unspecified, at most 10 group roles are returned. The
|
|
914
|
-
maximum value is 20 and higher values are set to 20.
|
|
915
|
-
* @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
|
|
916
|
-
|
|
917
|
-
When paginating, all other parameters provided to the subsequent call must
|
|
918
|
-
match the call that provided the page token.
|
|
919
|
-
* @description List roles in a group.
|
|
1162
|
+
* `BETA`
|
|
1163
|
+
*
|
|
1164
|
+
* List roles in a group.
|
|
920
1165
|
|
|
921
1166
|
The permissions field for roles is viewable based on the requester's access
|
|
922
1167
|
and scopes.
|
|
@@ -928,11 +1173,24 @@ permissions in their role are visible.
|
|
|
928
1173
|
|
|
929
1174
|
If the requester is the owner of the group and has the `group:read` scope,
|
|
930
1175
|
permissions in all roles are visible.
|
|
1176
|
+
*
|
|
1177
|
+
* **Scopes:** `group:read`
|
|
1178
|
+
* **Engine:** Usable with HttpService
|
|
1179
|
+
*
|
|
1180
|
+
* @param group_id The group ID.
|
|
1181
|
+
* @param maxPageSize The maximum number of group roles to return. The service might return fewer
|
|
1182
|
+
than this value. If unspecified, at most 10 group roles are returned. The
|
|
1183
|
+
maximum value is 20 and higher values are set to 20.
|
|
1184
|
+
* @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
|
|
1185
|
+
|
|
1186
|
+
When paginating, all other parameters provided to the subsequent call must
|
|
1187
|
+
match the call that provided the page token.
|
|
931
1188
|
*/
|
|
932
1189
|
exports.getCloudV2GroupsGroupIdRoles = (0, __1.endpoint)({
|
|
933
1190
|
method: 'GET',
|
|
934
1191
|
path: '/cloud/v2/groups/:group_id/roles',
|
|
935
1192
|
baseUrl: 'https://apis.roblox.com',
|
|
1193
|
+
scopes: ['group:read'],
|
|
936
1194
|
requestFormat: 'json',
|
|
937
1195
|
serializationMethod: {
|
|
938
1196
|
group_id: {},
|
|
@@ -948,16 +1206,21 @@ exports.getCloudV2GroupsGroupIdRoles = (0, __1.endpoint)({
|
|
|
948
1206
|
errors: [],
|
|
949
1207
|
});
|
|
950
1208
|
/**
|
|
951
|
-
*
|
|
952
|
-
*
|
|
1209
|
+
* `BETA`
|
|
1210
|
+
*
|
|
1211
|
+
* Get the group role
|
|
1212
|
+
*
|
|
1213
|
+
* **Scopes:** `group:read`
|
|
1214
|
+
* **Engine:** Usable with HttpService
|
|
1215
|
+
*
|
|
953
1216
|
* @param group_id The group ID.
|
|
954
1217
|
* @param role_id The role ID.
|
|
955
|
-
* @description Get the group role
|
|
956
1218
|
*/
|
|
957
1219
|
exports.getCloudV2GroupsGroupIdRolesRoleId = (0, __1.endpoint)({
|
|
958
1220
|
method: 'GET',
|
|
959
1221
|
path: '/cloud/v2/groups/:group_id/roles/:role_id',
|
|
960
1222
|
baseUrl: 'https://apis.roblox.com',
|
|
1223
|
+
scopes: ['group:read'],
|
|
961
1224
|
requestFormat: 'json',
|
|
962
1225
|
serializationMethod: {
|
|
963
1226
|
group_id: {},
|
|
@@ -971,21 +1234,26 @@ exports.getCloudV2GroupsGroupIdRolesRoleId = (0, __1.endpoint)({
|
|
|
971
1234
|
errors: [],
|
|
972
1235
|
});
|
|
973
1236
|
/**
|
|
974
|
-
*
|
|
975
|
-
*
|
|
976
|
-
*
|
|
977
|
-
* @description Gets the group shout.
|
|
1237
|
+
* `BETA`
|
|
1238
|
+
*
|
|
1239
|
+
* Gets the group shout.
|
|
978
1240
|
|
|
979
1241
|
If a guest can view the group shout, this is always retrievable.
|
|
980
1242
|
|
|
981
1243
|
If a guest cannot, a member who has the permissions to view the group
|
|
982
1244
|
shout, along with the `group:read` scope, will be able to read the group
|
|
983
1245
|
shout.
|
|
1246
|
+
*
|
|
1247
|
+
* **Scopes:** `group:read`
|
|
1248
|
+
* **Engine:** Usable with HttpService
|
|
1249
|
+
*
|
|
1250
|
+
* @param group_id The group ID.
|
|
984
1251
|
*/
|
|
985
1252
|
exports.getCloudV2GroupsGroupIdShout = (0, __1.endpoint)({
|
|
986
1253
|
method: 'GET',
|
|
987
1254
|
path: '/cloud/v2/groups/:group_id/shout',
|
|
988
1255
|
baseUrl: 'https://apis.roblox.com',
|
|
1256
|
+
scopes: ['group:read'],
|
|
989
1257
|
requestFormat: 'json',
|
|
990
1258
|
serializationMethod: {
|
|
991
1259
|
group_id: {},
|
|
@@ -997,10 +1265,13 @@ exports.getCloudV2GroupsGroupIdShout = (0, __1.endpoint)({
|
|
|
997
1265
|
errors: [],
|
|
998
1266
|
});
|
|
999
1267
|
/**
|
|
1000
|
-
*
|
|
1001
|
-
*
|
|
1268
|
+
* `STABLE`
|
|
1269
|
+
*
|
|
1270
|
+
* Gets the specified universe.
|
|
1271
|
+
*
|
|
1272
|
+
* **Engine:** Not available in-engine
|
|
1273
|
+
*
|
|
1002
1274
|
* @param universe_id The universe ID.
|
|
1003
|
-
* @description Gets the specified universe.
|
|
1004
1275
|
*/
|
|
1005
1276
|
exports.getCloudV2UniversesUniverseId = (0, __1.endpoint)({
|
|
1006
1277
|
method: 'GET',
|
|
@@ -1017,20 +1288,25 @@ exports.getCloudV2UniversesUniverseId = (0, __1.endpoint)({
|
|
|
1017
1288
|
errors: [],
|
|
1018
1289
|
});
|
|
1019
1290
|
/**
|
|
1020
|
-
*
|
|
1021
|
-
*
|
|
1022
|
-
*
|
|
1023
|
-
* @param universe_id The universe ID.
|
|
1024
|
-
* @param updateMask The list of fields to update.
|
|
1025
|
-
* @description Updates the specified universe.
|
|
1291
|
+
* `STABLE`
|
|
1292
|
+
*
|
|
1293
|
+
* Updates the specified universe.
|
|
1026
1294
|
|
|
1027
1295
|
This method is guaranteed to return all updated fields.
|
|
1028
1296
|
This method may additionally return the full resource.
|
|
1297
|
+
*
|
|
1298
|
+
* **Scopes:** `universe:write`
|
|
1299
|
+
* **Engine:** Not available in-engine
|
|
1300
|
+
*
|
|
1301
|
+
* @param body
|
|
1302
|
+
* @param universe_id The universe ID.
|
|
1303
|
+
* @param updateMask The list of fields to update.
|
|
1029
1304
|
*/
|
|
1030
1305
|
exports.patchCloudV2UniversesUniverseId = (0, __1.endpoint)({
|
|
1031
1306
|
method: 'PATCH',
|
|
1032
1307
|
path: '/cloud/v2/universes/:universe_id',
|
|
1033
1308
|
baseUrl: 'https://apis.roblox.com',
|
|
1309
|
+
scopes: ['universe:write'],
|
|
1034
1310
|
requestFormat: 'json',
|
|
1035
1311
|
serializationMethod: {
|
|
1036
1312
|
body: {},
|
|
@@ -1046,11 +1322,9 @@ exports.patchCloudV2UniversesUniverseId = (0, __1.endpoint)({
|
|
|
1046
1322
|
errors: [],
|
|
1047
1323
|
});
|
|
1048
1324
|
/**
|
|
1049
|
-
*
|
|
1050
|
-
*
|
|
1051
|
-
*
|
|
1052
|
-
* @param universe_id The universe ID.
|
|
1053
|
-
* @description Generates an English speech audio asset from the specified text.
|
|
1325
|
+
* `BETA`
|
|
1326
|
+
*
|
|
1327
|
+
* Generates an English speech audio asset from the specified text.
|
|
1054
1328
|
|
|
1055
1329
|
This endpoint requires the `asset:read` and `asset:write` scopes in
|
|
1056
1330
|
addition to the `universe:write` scope.
|
|
@@ -1059,11 +1333,18 @@ The response returns an `Operation` object that must be prefixed with
|
|
|
1059
1333
|
`/assets/v1`. For example, the URL to discover the result of the operation
|
|
1060
1334
|
could be
|
|
1061
1335
|
`https://apis.roblox.com/assets/v1/operations/8b42ef30-9c17-4526-b8cf-2ff0136ca94d`.
|
|
1336
|
+
*
|
|
1337
|
+
* **Scopes:** `universe:write`, `asset:read`, `asset:write`
|
|
1338
|
+
* **Engine:** Not available in-engine
|
|
1339
|
+
*
|
|
1340
|
+
* @param body
|
|
1341
|
+
* @param universe_id The universe ID.
|
|
1062
1342
|
*/
|
|
1063
1343
|
exports.postCloudV2UniversesUniverseIdGenerateSpeechAsset = (0, __1.endpoint)({
|
|
1064
1344
|
method: 'POST',
|
|
1065
1345
|
path: '/cloud/v2/universes/:universe_id:generateSpeechAsset',
|
|
1066
1346
|
baseUrl: 'https://apis.roblox.com',
|
|
1347
|
+
scopes: ['universe:write', 'asset:read', 'asset:write'],
|
|
1067
1348
|
requestFormat: 'json',
|
|
1068
1349
|
serializationMethod: {
|
|
1069
1350
|
body: {},
|
|
@@ -1077,19 +1358,24 @@ exports.postCloudV2UniversesUniverseIdGenerateSpeechAsset = (0, __1.endpoint)({
|
|
|
1077
1358
|
errors: [],
|
|
1078
1359
|
});
|
|
1079
1360
|
/**
|
|
1080
|
-
*
|
|
1081
|
-
*
|
|
1082
|
-
*
|
|
1083
|
-
* @param universe_id The universe ID.
|
|
1084
|
-
* @description Publishes a message to the universe's live servers.
|
|
1361
|
+
* `STABLE`
|
|
1362
|
+
*
|
|
1363
|
+
* Publishes a message to the universe's live servers.
|
|
1085
1364
|
|
|
1086
1365
|
Servers can consume messages via
|
|
1087
1366
|
[MessagingService](https://create.roblox.com/docs/reference/engine/classes/MessagingService).
|
|
1367
|
+
*
|
|
1368
|
+
* **Scopes:** `universe-messaging-service:publish`
|
|
1369
|
+
* **Engine:** Not available in-engine
|
|
1370
|
+
*
|
|
1371
|
+
* @param body
|
|
1372
|
+
* @param universe_id The universe ID.
|
|
1088
1373
|
*/
|
|
1089
1374
|
exports.postCloudV2UniversesUniverseIdPublishMessage = (0, __1.endpoint)({
|
|
1090
1375
|
method: 'POST',
|
|
1091
1376
|
path: '/cloud/v2/universes/:universe_id:publishMessage',
|
|
1092
1377
|
baseUrl: 'https://apis.roblox.com',
|
|
1378
|
+
scopes: ['universe-messaging-service:publish'],
|
|
1093
1379
|
requestFormat: 'json',
|
|
1094
1380
|
serializationMethod: {
|
|
1095
1381
|
body: {},
|
|
@@ -1103,18 +1389,23 @@ exports.postCloudV2UniversesUniverseIdPublishMessage = (0, __1.endpoint)({
|
|
|
1103
1389
|
errors: [],
|
|
1104
1390
|
});
|
|
1105
1391
|
/**
|
|
1106
|
-
*
|
|
1107
|
-
*
|
|
1108
|
-
*
|
|
1109
|
-
* @param universe_id The universe ID.
|
|
1110
|
-
* @description Restarts active servers for a specific universe. Defaults to only
|
|
1392
|
+
* `STABLE`
|
|
1393
|
+
*
|
|
1394
|
+
* Restarts active servers for a specific universe. Defaults to only
|
|
1111
1395
|
restarting servers running older versions, but can be configured to restart
|
|
1112
1396
|
all servers regardless of version. Used for releasing experience updates.
|
|
1397
|
+
*
|
|
1398
|
+
* **Scopes:** `universe:write`
|
|
1399
|
+
* **Engine:** Not available in-engine
|
|
1400
|
+
*
|
|
1401
|
+
* @param body
|
|
1402
|
+
* @param universe_id The universe ID.
|
|
1113
1403
|
*/
|
|
1114
1404
|
exports.postCloudV2UniversesUniverseIdRestartServers = (0, __1.endpoint)({
|
|
1115
1405
|
method: 'POST',
|
|
1116
1406
|
path: '/cloud/v2/universes/:universe_id:restartServers',
|
|
1117
1407
|
baseUrl: 'https://apis.roblox.com',
|
|
1408
|
+
scopes: ['universe:write'],
|
|
1118
1409
|
requestFormat: 'json',
|
|
1119
1410
|
serializationMethod: {
|
|
1120
1411
|
body: {},
|
|
@@ -1128,16 +1419,21 @@ exports.postCloudV2UniversesUniverseIdRestartServers = (0, __1.endpoint)({
|
|
|
1128
1419
|
errors: [],
|
|
1129
1420
|
});
|
|
1130
1421
|
/**
|
|
1131
|
-
*
|
|
1132
|
-
*
|
|
1422
|
+
* `BETA`
|
|
1423
|
+
*
|
|
1424
|
+
* Translates the provided text from one language to another.
|
|
1425
|
+
*
|
|
1426
|
+
* **Scopes:** `universe:write`
|
|
1427
|
+
* **Engine:** Not available in-engine
|
|
1428
|
+
*
|
|
1133
1429
|
* @param body
|
|
1134
1430
|
* @param universe_id The universe ID.
|
|
1135
|
-
* @description Translates the provided text from one language to another.
|
|
1136
1431
|
*/
|
|
1137
1432
|
exports.postCloudV2UniversesUniverseIdTranslateText = (0, __1.endpoint)({
|
|
1138
1433
|
method: 'POST',
|
|
1139
1434
|
path: '/cloud/v2/universes/:universe_id:translateText',
|
|
1140
1435
|
baseUrl: 'https://apis.roblox.com',
|
|
1436
|
+
scopes: ['universe:write'],
|
|
1141
1437
|
requestFormat: 'json',
|
|
1142
1438
|
serializationMethod: {
|
|
1143
1439
|
body: {},
|
|
@@ -1151,8 +1447,19 @@ exports.postCloudV2UniversesUniverseIdTranslateText = (0, __1.endpoint)({
|
|
|
1151
1447
|
errors: [],
|
|
1152
1448
|
});
|
|
1153
1449
|
/**
|
|
1154
|
-
*
|
|
1155
|
-
*
|
|
1450
|
+
* `STABLE`
|
|
1451
|
+
*
|
|
1452
|
+
* Returns a list of data stores.
|
|
1453
|
+
|
|
1454
|
+
Data stores scheduled for permanent deletion are omitted from the results
|
|
1455
|
+
by default (or when `showDeleted` is set to `false`). When this is the
|
|
1456
|
+
case, the operation will check up to 512 data stores. If all checked data
|
|
1457
|
+
stores are deleted, it will return an empty list with a page token to
|
|
1458
|
+
continue iteration.
|
|
1459
|
+
*
|
|
1460
|
+
* **Scopes:** `universe-datastores.control:list`
|
|
1461
|
+
* **Engine:** Not available in-engine
|
|
1462
|
+
*
|
|
1156
1463
|
* @param universe_id The universe ID.
|
|
1157
1464
|
* @param maxPageSize The maximum number of data stores to return. The service might return fewer
|
|
1158
1465
|
than this value. If unspecified, at most 10 data stores are returned. The
|
|
@@ -1172,18 +1479,12 @@ The `filter` field supports a very small subset of CEL:
|
|
|
1172
1479
|
Example filter: `id.startsWith("foo")`
|
|
1173
1480
|
* @param showDeleted If true, resources marked for pending deletion will be included in the
|
|
1174
1481
|
results.
|
|
1175
|
-
* @description Returns a list of data stores.
|
|
1176
|
-
|
|
1177
|
-
Data stores scheduled for permanent deletion are omitted from the results
|
|
1178
|
-
by default (or when `showDeleted` is set to `false`). When this is the
|
|
1179
|
-
case, the operation will check up to 512 data stores. If all checked data
|
|
1180
|
-
stores are deleted, it will return an empty list with a page token to
|
|
1181
|
-
continue iteration.
|
|
1182
1482
|
*/
|
|
1183
1483
|
exports.getCloudV2UniversesUniverseIdDataStores = (0, __1.endpoint)({
|
|
1184
1484
|
method: 'GET',
|
|
1185
1485
|
path: '/cloud/v2/universes/:universe_id/data-stores',
|
|
1186
1486
|
baseUrl: 'https://apis.roblox.com',
|
|
1487
|
+
scopes: ['universe-datastores.control:list'],
|
|
1187
1488
|
requestFormat: 'json',
|
|
1188
1489
|
serializationMethod: {
|
|
1189
1490
|
universe_id: {},
|
|
@@ -1203,11 +1504,9 @@ exports.getCloudV2UniversesUniverseIdDataStores = (0, __1.endpoint)({
|
|
|
1203
1504
|
errors: [],
|
|
1204
1505
|
});
|
|
1205
1506
|
/**
|
|
1206
|
-
*
|
|
1207
|
-
*
|
|
1208
|
-
*
|
|
1209
|
-
* @param universe_id The universe ID.
|
|
1210
|
-
* @description Takes a new snapshot of the data stores in an experience.
|
|
1507
|
+
* `STABLE`
|
|
1508
|
+
*
|
|
1509
|
+
* Takes a new snapshot of the data stores in an experience.
|
|
1211
1510
|
|
|
1212
1511
|
After a snapshot, the next write to every key in the experience will
|
|
1213
1512
|
create a versioned backup of the previous data, regardless of the time of
|
|
@@ -1223,11 +1522,18 @@ the time of the latest snapshot will be returned.
|
|
|
1223
1522
|
For more information on using snapshots, see the [Data
|
|
1224
1523
|
stores](https://create.roblox.com/docs/cloud-services/data-stores#snapshots)
|
|
1225
1524
|
Engine guide.
|
|
1525
|
+
*
|
|
1526
|
+
* **Scopes:** `universe-datastores.control:snapshot`
|
|
1527
|
+
* **Engine:** Not available in-engine
|
|
1528
|
+
*
|
|
1529
|
+
* @param body
|
|
1530
|
+
* @param universe_id The universe ID.
|
|
1226
1531
|
*/
|
|
1227
1532
|
exports.postCloudV2UniversesUniverseIdDataStoresSnapshot = (0, __1.endpoint)({
|
|
1228
1533
|
method: 'POST',
|
|
1229
1534
|
path: '/cloud/v2/universes/:universe_id/data-stores:snapshot',
|
|
1230
1535
|
baseUrl: 'https://apis.roblox.com',
|
|
1536
|
+
scopes: ['universe-datastores.control:snapshot'],
|
|
1231
1537
|
requestFormat: 'json',
|
|
1232
1538
|
serializationMethod: {
|
|
1233
1539
|
body: {},
|
|
@@ -1241,11 +1547,9 @@ exports.postCloudV2UniversesUniverseIdDataStoresSnapshot = (0, __1.endpoint)({
|
|
|
1241
1547
|
errors: [],
|
|
1242
1548
|
});
|
|
1243
1549
|
/**
|
|
1244
|
-
*
|
|
1245
|
-
*
|
|
1246
|
-
*
|
|
1247
|
-
* @param data_store_id The data-store ID.
|
|
1248
|
-
* @description Schedules the specified data store for permanent deletion.
|
|
1550
|
+
* `BETA`
|
|
1551
|
+
*
|
|
1552
|
+
* Schedules the specified data store for permanent deletion.
|
|
1249
1553
|
|
|
1250
1554
|
This operation assigns the data store an expiry time 30 days in the future,
|
|
1251
1555
|
at which point permanent deletion begins. To cancel, use the
|
|
@@ -1276,11 +1580,18 @@ after the deletion:
|
|
|
1276
1580
|
|
|
1277
1581
|
If the data store is already in a `DELETED` state, this operation is a
|
|
1278
1582
|
no-op, and the data store is returned as-is.
|
|
1583
|
+
*
|
|
1584
|
+
* **Scopes:** `universe-datastores.control:delete`
|
|
1585
|
+
* **Engine:** Not available in-engine
|
|
1586
|
+
*
|
|
1587
|
+
* @param universe_id The universe ID.
|
|
1588
|
+
* @param data_store_id The data-store ID.
|
|
1279
1589
|
*/
|
|
1280
1590
|
exports.deleteCloudV2UniversesUniverseIdDataStoresDataStoreId = (0, __1.endpoint)({
|
|
1281
1591
|
method: 'DELETE',
|
|
1282
1592
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id',
|
|
1283
1593
|
baseUrl: 'https://apis.roblox.com',
|
|
1594
|
+
scopes: ['universe-datastores.control:delete'],
|
|
1284
1595
|
requestFormat: 'json',
|
|
1285
1596
|
serializationMethod: {
|
|
1286
1597
|
universe_id: {},
|
|
@@ -1294,17 +1605,22 @@ exports.deleteCloudV2UniversesUniverseIdDataStoresDataStoreId = (0, __1.endpoint
|
|
|
1294
1605
|
errors: [],
|
|
1295
1606
|
});
|
|
1296
1607
|
/**
|
|
1297
|
-
*
|
|
1298
|
-
*
|
|
1608
|
+
* `BETA`
|
|
1609
|
+
*
|
|
1610
|
+
* Restore the data store
|
|
1611
|
+
*
|
|
1612
|
+
* **Scopes:** `universe-datastores.control:delete`
|
|
1613
|
+
* **Engine:** Not available in-engine
|
|
1614
|
+
*
|
|
1299
1615
|
* @param body
|
|
1300
1616
|
* @param universe_id The universe ID.
|
|
1301
1617
|
* @param data_store_id The data-store ID.
|
|
1302
|
-
* @description Restore the data store
|
|
1303
1618
|
*/
|
|
1304
1619
|
exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdUndelete = (0, __1.endpoint)({
|
|
1305
1620
|
method: 'POST',
|
|
1306
1621
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id:undelete',
|
|
1307
1622
|
baseUrl: 'https://apis.roblox.com',
|
|
1623
|
+
scopes: ['universe-datastores.control:delete'],
|
|
1308
1624
|
requestFormat: 'json',
|
|
1309
1625
|
serializationMethod: {
|
|
1310
1626
|
body: {},
|
|
@@ -1320,8 +1636,18 @@ exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdUndelete = (0, __1.en
|
|
|
1320
1636
|
errors: [],
|
|
1321
1637
|
});
|
|
1322
1638
|
/**
|
|
1323
|
-
*
|
|
1324
|
-
*
|
|
1639
|
+
* `STABLE`
|
|
1640
|
+
*
|
|
1641
|
+
* Returns a list of entries from a data store.
|
|
1642
|
+
|
|
1643
|
+
Only the `path` and `id` fields are populated; use `GetDataStoreEntry`
|
|
1644
|
+
to retrieve other fields.
|
|
1645
|
+
|
|
1646
|
+
Specify the wildcard scope (`-`) to list entries from all scopes.
|
|
1647
|
+
*
|
|
1648
|
+
* **Scopes:** `universe-datastores.objects:list`
|
|
1649
|
+
* **Engine:** Not available in-engine
|
|
1650
|
+
*
|
|
1325
1651
|
* @param universe_id The universe ID.
|
|
1326
1652
|
* @param data_store_id The data-store ID.
|
|
1327
1653
|
* @param maxPageSize The maximum number of data store entries to return. The service might
|
|
@@ -1342,17 +1668,12 @@ The `filter` field supports a very small subset of CEL:
|
|
|
1342
1668
|
Example filter: `id.startsWith("foo")`
|
|
1343
1669
|
* @param showDeleted If true, resources marked for pending deletion will be included in the
|
|
1344
1670
|
results.
|
|
1345
|
-
* @description Returns a list of entries from a data store.
|
|
1346
|
-
|
|
1347
|
-
Only the `path` and `id` fields are populated; use `GetDataStoreEntry`
|
|
1348
|
-
to retrieve other fields.
|
|
1349
|
-
|
|
1350
|
-
Specify the wildcard scope (`-`) to list entries from all scopes.
|
|
1351
1671
|
*/
|
|
1352
1672
|
exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries = (0, __1.endpoint)({
|
|
1353
1673
|
method: 'GET',
|
|
1354
1674
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries',
|
|
1355
1675
|
baseUrl: 'https://apis.roblox.com',
|
|
1676
|
+
scopes: ['universe-datastores.objects:list'],
|
|
1356
1677
|
requestFormat: 'json',
|
|
1357
1678
|
serializationMethod: {
|
|
1358
1679
|
universe_id: {},
|
|
@@ -1374,8 +1695,15 @@ exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries = (0, __1.endp
|
|
|
1374
1695
|
errors: [],
|
|
1375
1696
|
});
|
|
1376
1697
|
/**
|
|
1377
|
-
*
|
|
1378
|
-
*
|
|
1698
|
+
* `STABLE`
|
|
1699
|
+
*
|
|
1700
|
+
* Creates an entry with the provided ID and value.
|
|
1701
|
+
|
|
1702
|
+
Returns a 400 Bad Request if the entry exists.
|
|
1703
|
+
*
|
|
1704
|
+
* **Scopes:** `universe-datastores.objects:create`
|
|
1705
|
+
* **Engine:** Not available in-engine
|
|
1706
|
+
*
|
|
1379
1707
|
* @param body
|
|
1380
1708
|
* @param universe_id The universe ID.
|
|
1381
1709
|
* @param data_store_id The data-store ID.
|
|
@@ -1384,14 +1712,12 @@ component of the data store entry's resource path.
|
|
|
1384
1712
|
|
|
1385
1713
|
This value should be a 1-50 character string. We strongly recommend using
|
|
1386
1714
|
only lowercase letters, numeric digits, and hyphens.
|
|
1387
|
-
* @description Creates an entry with the provided ID and value.
|
|
1388
|
-
|
|
1389
|
-
Returns a 400 Bad Request if the entry exists.
|
|
1390
1715
|
*/
|
|
1391
1716
|
exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries = (0, __1.endpoint)({
|
|
1392
1717
|
method: 'POST',
|
|
1393
1718
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries',
|
|
1394
1719
|
baseUrl: 'https://apis.roblox.com',
|
|
1720
|
+
scopes: ['universe-datastores.objects:create'],
|
|
1395
1721
|
requestFormat: 'json',
|
|
1396
1722
|
serializationMethod: {
|
|
1397
1723
|
body: {},
|
|
@@ -1409,12 +1735,9 @@ exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries = (0, __1.end
|
|
|
1409
1735
|
errors: [],
|
|
1410
1736
|
});
|
|
1411
1737
|
/**
|
|
1412
|
-
*
|
|
1413
|
-
*
|
|
1414
|
-
*
|
|
1415
|
-
* @param data_store_id The data-store ID.
|
|
1416
|
-
* @param entry_id The entry ID.
|
|
1417
|
-
* @description Gets the specified entry.
|
|
1738
|
+
* `STABLE`
|
|
1739
|
+
*
|
|
1740
|
+
* Gets the specified entry.
|
|
1418
1741
|
|
|
1419
1742
|
To get the entry at a specific revision, add `@<revisionId>` to the end of
|
|
1420
1743
|
the path.
|
|
@@ -1439,11 +1762,19 @@ the Unix epoch (1/1/1970) and not more than ten minutes in the future.
|
|
|
1439
1762
|
For example, to get the revision of `my-entry` that was current on
|
|
1440
1763
|
12/2/2024 at 06:00 UTC, use the path
|
|
1441
1764
|
`/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z`.
|
|
1765
|
+
*
|
|
1766
|
+
* **Scopes:** `universe-datastores.objects:read`
|
|
1767
|
+
* **Engine:** Not available in-engine
|
|
1768
|
+
*
|
|
1769
|
+
* @param universe_id The universe ID.
|
|
1770
|
+
* @param data_store_id The data-store ID.
|
|
1771
|
+
* @param entry_id The entry ID.
|
|
1442
1772
|
*/
|
|
1443
1773
|
exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId = (0, __1.endpoint)({
|
|
1444
1774
|
method: 'GET',
|
|
1445
1775
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries/:entry_id',
|
|
1446
1776
|
baseUrl: 'https://apis.roblox.com',
|
|
1777
|
+
scopes: ['universe-datastores.objects:read'],
|
|
1447
1778
|
requestFormat: 'json',
|
|
1448
1779
|
serializationMethod: {
|
|
1449
1780
|
universe_id: {},
|
|
@@ -1459,23 +1790,28 @@ exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId = (0, _
|
|
|
1459
1790
|
errors: [],
|
|
1460
1791
|
});
|
|
1461
1792
|
/**
|
|
1462
|
-
*
|
|
1463
|
-
*
|
|
1464
|
-
*
|
|
1465
|
-
* @param data_store_id The data-store ID.
|
|
1466
|
-
* @param entry_id The entry ID.
|
|
1467
|
-
* @description Marks the specified entry for deletion.
|
|
1793
|
+
* `STABLE`
|
|
1794
|
+
*
|
|
1795
|
+
* Marks the specified entry for deletion.
|
|
1468
1796
|
|
|
1469
1797
|
Entries are not be deleted immediately; instead, the `state` field will
|
|
1470
1798
|
be set to `DELETED`. Permanent deletion occurs after 30 days.
|
|
1471
1799
|
|
|
1472
1800
|
On success, returns 200 OK. If the entry doesn't exist, returns
|
|
1473
1801
|
404 Not Found.
|
|
1802
|
+
*
|
|
1803
|
+
* **Scopes:** `universe-datastores.objects:delete`
|
|
1804
|
+
* **Engine:** Not available in-engine
|
|
1805
|
+
*
|
|
1806
|
+
* @param universe_id The universe ID.
|
|
1807
|
+
* @param data_store_id The data-store ID.
|
|
1808
|
+
* @param entry_id The entry ID.
|
|
1474
1809
|
*/
|
|
1475
1810
|
exports.deleteCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId = (0, __1.endpoint)({
|
|
1476
1811
|
method: 'DELETE',
|
|
1477
1812
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries/:entry_id',
|
|
1478
1813
|
baseUrl: 'https://apis.roblox.com',
|
|
1814
|
+
scopes: ['universe-datastores.objects:delete'],
|
|
1479
1815
|
requestFormat: 'json',
|
|
1480
1816
|
serializationMethod: {
|
|
1481
1817
|
universe_id: {},
|
|
@@ -1491,15 +1827,9 @@ exports.deleteCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId = (0
|
|
|
1491
1827
|
errors: [],
|
|
1492
1828
|
});
|
|
1493
1829
|
/**
|
|
1494
|
-
*
|
|
1495
|
-
*
|
|
1496
|
-
*
|
|
1497
|
-
* @param universe_id The universe ID.
|
|
1498
|
-
* @param data_store_id The data-store ID.
|
|
1499
|
-
* @param entry_id The entry ID.
|
|
1500
|
-
* @param allowMissing If set to true, and the data store entry is not found, a data store entry
|
|
1501
|
-
is created.
|
|
1502
|
-
* @description Updates the value, attributes, and users of an entry.
|
|
1830
|
+
* `STABLE`
|
|
1831
|
+
*
|
|
1832
|
+
* Updates the value, attributes, and users of an entry.
|
|
1503
1833
|
|
|
1504
1834
|
Updating specific revisions of the entry is **unsupported**. If you specify
|
|
1505
1835
|
a revision ID in the path and `allow_missing` is `true`, the update request
|
|
@@ -1509,11 +1839,22 @@ the key.
|
|
|
1509
1839
|
Partial update is **unsupported**. If attributes or users are not
|
|
1510
1840
|
provided when updating the value, they will be cleared. Value must always
|
|
1511
1841
|
be provided when updating an entry.
|
|
1842
|
+
*
|
|
1843
|
+
* **Scopes:** `universe-datastores.objects:update`
|
|
1844
|
+
* **Engine:** Not available in-engine
|
|
1845
|
+
*
|
|
1846
|
+
* @param body
|
|
1847
|
+
* @param universe_id The universe ID.
|
|
1848
|
+
* @param data_store_id The data-store ID.
|
|
1849
|
+
* @param entry_id The entry ID.
|
|
1850
|
+
* @param allowMissing If set to true, and the data store entry is not found, a data store entry
|
|
1851
|
+
is created.
|
|
1512
1852
|
*/
|
|
1513
1853
|
exports.patchCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId = (0, __1.endpoint)({
|
|
1514
1854
|
method: 'PATCH',
|
|
1515
1855
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries/:entry_id',
|
|
1516
1856
|
baseUrl: 'https://apis.roblox.com',
|
|
1857
|
+
scopes: ['universe-datastores.objects:update'],
|
|
1517
1858
|
requestFormat: 'json',
|
|
1518
1859
|
serializationMethod: {
|
|
1519
1860
|
body: {},
|
|
@@ -1533,13 +1874,9 @@ exports.patchCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId = (0,
|
|
|
1533
1874
|
errors: [],
|
|
1534
1875
|
});
|
|
1535
1876
|
/**
|
|
1536
|
-
*
|
|
1537
|
-
*
|
|
1538
|
-
*
|
|
1539
|
-
* @param universe_id The universe ID.
|
|
1540
|
-
* @param data_store_id The data-store ID.
|
|
1541
|
-
* @param entry_id The entry ID.
|
|
1542
|
-
* @description Increments the value of the specified entry. Both the existing value and
|
|
1877
|
+
* `STABLE`
|
|
1878
|
+
*
|
|
1879
|
+
* Increments the value of the specified entry. Both the existing value and
|
|
1543
1880
|
the increment amount must be integers.
|
|
1544
1881
|
|
|
1545
1882
|
If the entry doesn't exist, creates an entry with the specified value.
|
|
@@ -1553,11 +1890,20 @@ When this happens, the returned value will be clamped to the valid range,
|
|
|
1553
1890
|
but the backend may persist the original value. This behavior is maintained
|
|
1554
1891
|
for backwards compatibility reasons, but may change in a future version of
|
|
1555
1892
|
this API.
|
|
1893
|
+
*
|
|
1894
|
+
* **Scopes:** `universe-datastores.objects:create`, `universe-datastores.objects:update`
|
|
1895
|
+
* **Engine:** Not available in-engine
|
|
1896
|
+
*
|
|
1897
|
+
* @param body
|
|
1898
|
+
* @param universe_id The universe ID.
|
|
1899
|
+
* @param data_store_id The data-store ID.
|
|
1900
|
+
* @param entry_id The entry ID.
|
|
1556
1901
|
*/
|
|
1557
1902
|
exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryIdIncrement = (0, __1.endpoint)({
|
|
1558
1903
|
method: 'POST',
|
|
1559
1904
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries/:entry_id:increment',
|
|
1560
1905
|
baseUrl: 'https://apis.roblox.com',
|
|
1906
|
+
scopes: ['universe-datastores.objects:create', 'universe-datastores.objects:update'],
|
|
1561
1907
|
requestFormat: 'json',
|
|
1562
1908
|
serializationMethod: {
|
|
1563
1909
|
body: {},
|
|
@@ -1575,8 +1921,23 @@ exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryIdIncreme
|
|
|
1575
1921
|
errors: [],
|
|
1576
1922
|
});
|
|
1577
1923
|
/**
|
|
1578
|
-
*
|
|
1579
|
-
*
|
|
1924
|
+
* `STABLE`
|
|
1925
|
+
*
|
|
1926
|
+
* List revisions of the data store entry.
|
|
1927
|
+
|
|
1928
|
+
This method returns partial data store entries.
|
|
1929
|
+
|
|
1930
|
+
In particular, only the `path`, `id`, `createTime`, `revisionCreateTime`,
|
|
1931
|
+
`revisionId`, `etag`, and `state` fields are populated. Both the `path` and
|
|
1932
|
+
`id` fields will have an `@<version>` suffix.
|
|
1933
|
+
|
|
1934
|
+
In order to get the full entry at a revision, you can use the provided
|
|
1935
|
+
`path` field with the `GetDataStoreEntry` method, i.e. `GET
|
|
1936
|
+
/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>`.
|
|
1937
|
+
*
|
|
1938
|
+
* **Scopes:** `universe-datastores.versions:list`
|
|
1939
|
+
* **Engine:** Not available in-engine
|
|
1940
|
+
*
|
|
1580
1941
|
* @param universe_id The universe ID.
|
|
1581
1942
|
* @param data_store_id The data-store ID.
|
|
1582
1943
|
* @param entry_id The entry ID.
|
|
@@ -1598,22 +1959,12 @@ For example:
|
|
|
1598
1959
|
|
|
1599
1960
|
`"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <=
|
|
1600
1961
|
2001-01-01T00:00:00Z"`
|
|
1601
|
-
* @description List revisions of the data store entry.
|
|
1602
|
-
|
|
1603
|
-
This method returns partial data store entries.
|
|
1604
|
-
|
|
1605
|
-
In particular, only the `path`, `id`, `createTime`, `revisionCreateTime`,
|
|
1606
|
-
`revisionId`, `etag`, and `state` fields are populated. Both the `path` and
|
|
1607
|
-
`id` fields will have an `@<version>` suffix.
|
|
1608
|
-
|
|
1609
|
-
In order to get the full entry at a revision, you can use the provided
|
|
1610
|
-
`path` field with the `GetDataStoreEntry` method, i.e. `GET
|
|
1611
|
-
/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>`.
|
|
1612
1962
|
*/
|
|
1613
1963
|
exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryIdListRevisions = (0, __1.endpoint)({
|
|
1614
1964
|
method: 'GET',
|
|
1615
1965
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/entries/:entry_id:listRevisions',
|
|
1616
1966
|
baseUrl: 'https://apis.roblox.com',
|
|
1967
|
+
scopes: ['universe-datastores.versions:list'],
|
|
1617
1968
|
requestFormat: 'json',
|
|
1618
1969
|
serializationMethod: {
|
|
1619
1970
|
universe_id: {},
|
|
@@ -1635,8 +1986,18 @@ exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryIdListRevi
|
|
|
1635
1986
|
errors: [],
|
|
1636
1987
|
});
|
|
1637
1988
|
/**
|
|
1638
|
-
*
|
|
1639
|
-
*
|
|
1989
|
+
* `STABLE`
|
|
1990
|
+
*
|
|
1991
|
+
* Returns a list of entries from a data store.
|
|
1992
|
+
|
|
1993
|
+
Only the `path` and `id` fields are populated; use `GetDataStoreEntry`
|
|
1994
|
+
to retrieve other fields.
|
|
1995
|
+
|
|
1996
|
+
Specify the wildcard scope (`-`) to list entries from all scopes.
|
|
1997
|
+
*
|
|
1998
|
+
* **Scopes:** `universe-datastores.objects:list`
|
|
1999
|
+
* **Engine:** Not available in-engine
|
|
2000
|
+
*
|
|
1640
2001
|
* @param universe_id The universe ID.
|
|
1641
2002
|
* @param data_store_id The data-store ID.
|
|
1642
2003
|
* @param scope_id The scope ID.
|
|
@@ -1658,17 +2019,12 @@ The `filter` field supports a very small subset of CEL:
|
|
|
1658
2019
|
Example filter: `id.startsWith("foo")`
|
|
1659
2020
|
* @param showDeleted If true, resources marked for pending deletion will be included in the
|
|
1660
2021
|
results.
|
|
1661
|
-
* @description Returns a list of entries from a data store.
|
|
1662
|
-
|
|
1663
|
-
Only the `path` and `id` fields are populated; use `GetDataStoreEntry`
|
|
1664
|
-
to retrieve other fields.
|
|
1665
|
-
|
|
1666
|
-
Specify the wildcard scope (`-`) to list entries from all scopes.
|
|
1667
2022
|
*/
|
|
1668
2023
|
exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntries = (0, __1.endpoint)({
|
|
1669
2024
|
method: 'GET',
|
|
1670
2025
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries',
|
|
1671
2026
|
baseUrl: 'https://apis.roblox.com',
|
|
2027
|
+
scopes: ['universe-datastores.objects:list'],
|
|
1672
2028
|
requestFormat: 'json',
|
|
1673
2029
|
serializationMethod: {
|
|
1674
2030
|
universe_id: {},
|
|
@@ -1692,8 +2048,15 @@ exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntries =
|
|
|
1692
2048
|
errors: [],
|
|
1693
2049
|
});
|
|
1694
2050
|
/**
|
|
1695
|
-
*
|
|
1696
|
-
*
|
|
2051
|
+
* `STABLE`
|
|
2052
|
+
*
|
|
2053
|
+
* Creates an entry with the provided ID and value.
|
|
2054
|
+
|
|
2055
|
+
Returns a 400 Bad Request if the entry exists.
|
|
2056
|
+
*
|
|
2057
|
+
* **Scopes:** `universe-datastores.objects:create`
|
|
2058
|
+
* **Engine:** Not available in-engine
|
|
2059
|
+
*
|
|
1697
2060
|
* @param body
|
|
1698
2061
|
* @param universe_id The universe ID.
|
|
1699
2062
|
* @param data_store_id The data-store ID.
|
|
@@ -1703,14 +2066,12 @@ component of the data store entry's resource path.
|
|
|
1703
2066
|
|
|
1704
2067
|
This value should be a 1-50 character string. We strongly recommend using
|
|
1705
2068
|
only lowercase letters, numeric digits, and hyphens.
|
|
1706
|
-
* @description Creates an entry with the provided ID and value.
|
|
1707
|
-
|
|
1708
|
-
Returns a 400 Bad Request if the entry exists.
|
|
1709
2069
|
*/
|
|
1710
2070
|
exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntries = (0, __1.endpoint)({
|
|
1711
2071
|
method: 'POST',
|
|
1712
2072
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries',
|
|
1713
2073
|
baseUrl: 'https://apis.roblox.com',
|
|
2074
|
+
scopes: ['universe-datastores.objects:create'],
|
|
1714
2075
|
requestFormat: 'json',
|
|
1715
2076
|
serializationMethod: {
|
|
1716
2077
|
body: {},
|
|
@@ -1730,13 +2091,9 @@ exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntries
|
|
|
1730
2091
|
errors: [],
|
|
1731
2092
|
});
|
|
1732
2093
|
/**
|
|
1733
|
-
*
|
|
1734
|
-
*
|
|
1735
|
-
*
|
|
1736
|
-
* @param data_store_id The data-store ID.
|
|
1737
|
-
* @param scope_id The scope ID.
|
|
1738
|
-
* @param entry_id The entry ID.
|
|
1739
|
-
* @description Gets the specified entry.
|
|
2094
|
+
* `STABLE`
|
|
2095
|
+
*
|
|
2096
|
+
* Gets the specified entry.
|
|
1740
2097
|
|
|
1741
2098
|
To get the entry at a specific revision, add `@<revisionId>` to the end of
|
|
1742
2099
|
the path.
|
|
@@ -1761,11 +2118,20 @@ the Unix epoch (1/1/1970) and not more than ten minutes in the future.
|
|
|
1761
2118
|
For example, to get the revision of `my-entry` that was current on
|
|
1762
2119
|
12/2/2024 at 06:00 UTC, use the path
|
|
1763
2120
|
`/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z`.
|
|
2121
|
+
*
|
|
2122
|
+
* **Scopes:** `universe-datastores.objects:read`
|
|
2123
|
+
* **Engine:** Not available in-engine
|
|
2124
|
+
*
|
|
2125
|
+
* @param universe_id The universe ID.
|
|
2126
|
+
* @param data_store_id The data-store ID.
|
|
2127
|
+
* @param scope_id The scope ID.
|
|
2128
|
+
* @param entry_id The entry ID.
|
|
1764
2129
|
*/
|
|
1765
2130
|
exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryId = (0, __1.endpoint)({
|
|
1766
2131
|
method: 'GET',
|
|
1767
2132
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries/:entry_id',
|
|
1768
2133
|
baseUrl: 'https://apis.roblox.com',
|
|
2134
|
+
scopes: ['universe-datastores.objects:read'],
|
|
1769
2135
|
requestFormat: 'json',
|
|
1770
2136
|
serializationMethod: {
|
|
1771
2137
|
universe_id: {},
|
|
@@ -1783,24 +2149,29 @@ exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEn
|
|
|
1783
2149
|
errors: [],
|
|
1784
2150
|
});
|
|
1785
2151
|
/**
|
|
1786
|
-
*
|
|
1787
|
-
*
|
|
1788
|
-
*
|
|
1789
|
-
* @param data_store_id The data-store ID.
|
|
1790
|
-
* @param scope_id The scope ID.
|
|
1791
|
-
* @param entry_id The entry ID.
|
|
1792
|
-
* @description Marks the specified entry for deletion.
|
|
2152
|
+
* `STABLE`
|
|
2153
|
+
*
|
|
2154
|
+
* Marks the specified entry for deletion.
|
|
1793
2155
|
|
|
1794
2156
|
Entries are not be deleted immediately; instead, the `state` field will
|
|
1795
2157
|
be set to `DELETED`. Permanent deletion occurs after 30 days.
|
|
1796
2158
|
|
|
1797
2159
|
On success, returns 200 OK. If the entry doesn't exist, returns
|
|
1798
2160
|
404 Not Found.
|
|
2161
|
+
*
|
|
2162
|
+
* **Scopes:** `universe-datastores.objects:delete`
|
|
2163
|
+
* **Engine:** Not available in-engine
|
|
2164
|
+
*
|
|
2165
|
+
* @param universe_id The universe ID.
|
|
2166
|
+
* @param data_store_id The data-store ID.
|
|
2167
|
+
* @param scope_id The scope ID.
|
|
2168
|
+
* @param entry_id The entry ID.
|
|
1799
2169
|
*/
|
|
1800
2170
|
exports.deleteCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryId = (0, __1.endpoint)({
|
|
1801
2171
|
method: 'DELETE',
|
|
1802
2172
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries/:entry_id',
|
|
1803
2173
|
baseUrl: 'https://apis.roblox.com',
|
|
2174
|
+
scopes: ['universe-datastores.objects:delete'],
|
|
1804
2175
|
requestFormat: 'json',
|
|
1805
2176
|
serializationMethod: {
|
|
1806
2177
|
universe_id: {},
|
|
@@ -1818,16 +2189,9 @@ exports.deleteCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntrie
|
|
|
1818
2189
|
errors: [],
|
|
1819
2190
|
});
|
|
1820
2191
|
/**
|
|
1821
|
-
*
|
|
1822
|
-
*
|
|
1823
|
-
*
|
|
1824
|
-
* @param universe_id The universe ID.
|
|
1825
|
-
* @param data_store_id The data-store ID.
|
|
1826
|
-
* @param scope_id The scope ID.
|
|
1827
|
-
* @param entry_id The entry ID.
|
|
1828
|
-
* @param allowMissing If set to true, and the data store entry is not found, a data store entry
|
|
1829
|
-
is created.
|
|
1830
|
-
* @description Updates the value, attributes, and users of an entry.
|
|
2192
|
+
* `STABLE`
|
|
2193
|
+
*
|
|
2194
|
+
* Updates the value, attributes, and users of an entry.
|
|
1831
2195
|
|
|
1832
2196
|
Updating specific revisions of the entry is **unsupported**. If you specify
|
|
1833
2197
|
a revision ID in the path and `allow_missing` is `true`, the update request
|
|
@@ -1837,11 +2201,23 @@ the key.
|
|
|
1837
2201
|
Partial update is **unsupported**. If attributes or users are not
|
|
1838
2202
|
provided when updating the value, they will be cleared. Value must always
|
|
1839
2203
|
be provided when updating an entry.
|
|
2204
|
+
*
|
|
2205
|
+
* **Scopes:** `universe-datastores.objects:update`
|
|
2206
|
+
* **Engine:** Not available in-engine
|
|
2207
|
+
*
|
|
2208
|
+
* @param body
|
|
2209
|
+
* @param universe_id The universe ID.
|
|
2210
|
+
* @param data_store_id The data-store ID.
|
|
2211
|
+
* @param scope_id The scope ID.
|
|
2212
|
+
* @param entry_id The entry ID.
|
|
2213
|
+
* @param allowMissing If set to true, and the data store entry is not found, a data store entry
|
|
2214
|
+
is created.
|
|
1840
2215
|
*/
|
|
1841
2216
|
exports.patchCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryId = (0, __1.endpoint)({
|
|
1842
2217
|
method: 'PATCH',
|
|
1843
2218
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries/:entry_id',
|
|
1844
2219
|
baseUrl: 'https://apis.roblox.com',
|
|
2220
|
+
scopes: ['universe-datastores.objects:update'],
|
|
1845
2221
|
requestFormat: 'json',
|
|
1846
2222
|
serializationMethod: {
|
|
1847
2223
|
body: {},
|
|
@@ -1863,14 +2239,9 @@ exports.patchCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntries
|
|
|
1863
2239
|
errors: [],
|
|
1864
2240
|
});
|
|
1865
2241
|
/**
|
|
1866
|
-
*
|
|
1867
|
-
*
|
|
1868
|
-
*
|
|
1869
|
-
* @param universe_id The universe ID.
|
|
1870
|
-
* @param data_store_id The data-store ID.
|
|
1871
|
-
* @param scope_id The scope ID.
|
|
1872
|
-
* @param entry_id The entry ID.
|
|
1873
|
-
* @description Increments the value of the specified entry. Both the existing value and
|
|
2242
|
+
* `STABLE`
|
|
2243
|
+
*
|
|
2244
|
+
* Increments the value of the specified entry. Both the existing value and
|
|
1874
2245
|
the increment amount must be integers.
|
|
1875
2246
|
|
|
1876
2247
|
If the entry doesn't exist, creates an entry with the specified value.
|
|
@@ -1884,11 +2255,21 @@ When this happens, the returned value will be clamped to the valid range,
|
|
|
1884
2255
|
but the backend may persist the original value. This behavior is maintained
|
|
1885
2256
|
for backwards compatibility reasons, but may change in a future version of
|
|
1886
2257
|
this API.
|
|
2258
|
+
*
|
|
2259
|
+
* **Scopes:** `universe-datastores.objects:create`, `universe-datastores.objects:update`
|
|
2260
|
+
* **Engine:** Not available in-engine
|
|
2261
|
+
*
|
|
2262
|
+
* @param body
|
|
2263
|
+
* @param universe_id The universe ID.
|
|
2264
|
+
* @param data_store_id The data-store ID.
|
|
2265
|
+
* @param scope_id The scope ID.
|
|
2266
|
+
* @param entry_id The entry ID.
|
|
1887
2267
|
*/
|
|
1888
2268
|
exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryIdIncrement = (0, __1.endpoint)({
|
|
1889
2269
|
method: 'POST',
|
|
1890
2270
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries/:entry_id:increment',
|
|
1891
2271
|
baseUrl: 'https://apis.roblox.com',
|
|
2272
|
+
scopes: ['universe-datastores.objects:create', 'universe-datastores.objects:update'],
|
|
1892
2273
|
requestFormat: 'json',
|
|
1893
2274
|
serializationMethod: {
|
|
1894
2275
|
body: {},
|
|
@@ -1908,8 +2289,23 @@ exports.postCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesE
|
|
|
1908
2289
|
errors: [],
|
|
1909
2290
|
});
|
|
1910
2291
|
/**
|
|
1911
|
-
*
|
|
1912
|
-
*
|
|
2292
|
+
* `STABLE`
|
|
2293
|
+
*
|
|
2294
|
+
* List revisions of the data store entry.
|
|
2295
|
+
|
|
2296
|
+
This method returns partial data store entries.
|
|
2297
|
+
|
|
2298
|
+
In particular, only the `path`, `id`, `createTime`, `revisionCreateTime`,
|
|
2299
|
+
`revisionId`, `etag`, and `state` fields are populated. Both the `path` and
|
|
2300
|
+
`id` fields will have an `@<version>` suffix.
|
|
2301
|
+
|
|
2302
|
+
In order to get the full entry at a revision, you can use the provided
|
|
2303
|
+
`path` field with the `GetDataStoreEntry` method, i.e. `GET
|
|
2304
|
+
/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>`.
|
|
2305
|
+
*
|
|
2306
|
+
* **Scopes:** `universe-datastores.versions:list`
|
|
2307
|
+
* **Engine:** Not available in-engine
|
|
2308
|
+
*
|
|
1913
2309
|
* @param universe_id The universe ID.
|
|
1914
2310
|
* @param data_store_id The data-store ID.
|
|
1915
2311
|
* @param scope_id The scope ID.
|
|
@@ -1932,22 +2328,12 @@ For example:
|
|
|
1932
2328
|
|
|
1933
2329
|
`"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <=
|
|
1934
2330
|
2001-01-01T00:00:00Z"`
|
|
1935
|
-
* @description List revisions of the data store entry.
|
|
1936
|
-
|
|
1937
|
-
This method returns partial data store entries.
|
|
1938
|
-
|
|
1939
|
-
In particular, only the `path`, `id`, `createTime`, `revisionCreateTime`,
|
|
1940
|
-
`revisionId`, `etag`, and `state` fields are populated. Both the `path` and
|
|
1941
|
-
`id` fields will have an `@<version>` suffix.
|
|
1942
|
-
|
|
1943
|
-
In order to get the full entry at a revision, you can use the provided
|
|
1944
|
-
`path` field with the `GetDataStoreEntry` method, i.e. `GET
|
|
1945
|
-
/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@<version>`.
|
|
1946
2331
|
*/
|
|
1947
2332
|
exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryIdListRevisions = (0, __1.endpoint)({
|
|
1948
2333
|
method: 'GET',
|
|
1949
2334
|
path: '/cloud/v2/universes/:universe_id/data-stores/:data_store_id/scopes/:scope_id/entries/:entry_id:listRevisions',
|
|
1950
2335
|
baseUrl: 'https://apis.roblox.com',
|
|
2336
|
+
scopes: ['universe-datastores.versions:list'],
|
|
1951
2337
|
requestFormat: 'json',
|
|
1952
2338
|
serializationMethod: {
|
|
1953
2339
|
universe_id: {},
|
|
@@ -1971,16 +2357,21 @@ exports.getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEn
|
|
|
1971
2357
|
errors: [],
|
|
1972
2358
|
});
|
|
1973
2359
|
/**
|
|
1974
|
-
*
|
|
1975
|
-
*
|
|
2360
|
+
* `BETA`
|
|
2361
|
+
*
|
|
2362
|
+
* Create a new `LuauExecutionSessionTaskBinaryInput`.
|
|
2363
|
+
*
|
|
2364
|
+
* **Scopes:** `universe.place.luau-execution-session:write`
|
|
2365
|
+
* **Engine:** Not available in-engine
|
|
2366
|
+
*
|
|
1976
2367
|
* @param body
|
|
1977
2368
|
* @param universe_id The universe ID.
|
|
1978
|
-
* @description Create a new `LuauExecutionSessionTaskBinaryInput`.
|
|
1979
2369
|
*/
|
|
1980
2370
|
exports.postCloudV2UniversesUniverseIdLuauExecutionSessionTaskBinaryInputs = (0, __1.endpoint)({
|
|
1981
2371
|
method: 'POST',
|
|
1982
2372
|
path: '/cloud/v2/universes/:universe_id/luau-execution-session-task-binary-inputs',
|
|
1983
2373
|
baseUrl: 'https://apis.roblox.com',
|
|
2374
|
+
scopes: ['universe.place.luau-execution-session:write'],
|
|
1984
2375
|
requestFormat: 'json',
|
|
1985
2376
|
serializationMethod: {
|
|
1986
2377
|
body: {},
|
|
@@ -1994,16 +2385,21 @@ exports.postCloudV2UniversesUniverseIdLuauExecutionSessionTaskBinaryInputs = (0,
|
|
|
1994
2385
|
errors: [],
|
|
1995
2386
|
});
|
|
1996
2387
|
/**
|
|
1997
|
-
*
|
|
1998
|
-
*
|
|
2388
|
+
* `STABLE`
|
|
2389
|
+
*
|
|
2390
|
+
* Asynchronously flush all data structures in the universe.
|
|
2391
|
+
*
|
|
2392
|
+
* **Scopes:** `memory-store:flush`
|
|
2393
|
+
* **Engine:** Not available in-engine
|
|
2394
|
+
*
|
|
1999
2395
|
* @param body
|
|
2000
2396
|
* @param universe_id The universe ID.
|
|
2001
|
-
* @description Asynchronously flush all data structures in the universe.
|
|
2002
2397
|
*/
|
|
2003
2398
|
exports.postCloudV2UniversesUniverseIdMemoryStoreFlush = (0, __1.endpoint)({
|
|
2004
2399
|
method: 'POST',
|
|
2005
2400
|
path: '/cloud/v2/universes/:universe_id/memory-store:flush',
|
|
2006
2401
|
baseUrl: 'https://apis.roblox.com',
|
|
2402
|
+
scopes: ['memory-store:flush'],
|
|
2007
2403
|
requestFormat: 'json',
|
|
2008
2404
|
serializationMethod: {
|
|
2009
2405
|
body: {},
|
|
@@ -2017,12 +2413,9 @@ exports.postCloudV2UniversesUniverseIdMemoryStoreFlush = (0, __1.endpoint)({
|
|
|
2017
2413
|
errors: [],
|
|
2018
2414
|
});
|
|
2019
2415
|
/**
|
|
2020
|
-
*
|
|
2021
|
-
*
|
|
2022
|
-
*
|
|
2023
|
-
* @param universe_id The universe ID.
|
|
2024
|
-
* @param queue_id The queue ID.
|
|
2025
|
-
* @description Creates a new queue item.
|
|
2416
|
+
* `STABLE`
|
|
2417
|
+
*
|
|
2418
|
+
* Creates a new queue item.
|
|
2026
2419
|
|
|
2027
2420
|
If `ttl` is set, the item will automatically be removed from the queue
|
|
2028
2421
|
after the time interval specified.
|
|
@@ -2031,11 +2424,19 @@ If a numerical `priority` is set, the item will be inserted into the queue
|
|
|
2031
2424
|
based on the priority value. The higher the value, the closer to the front
|
|
2032
2425
|
of the queue the item will be. If priority values are the same then the
|
|
2033
2426
|
item will be inserted after existing values with the same priority.
|
|
2427
|
+
*
|
|
2428
|
+
* **Scopes:** `memory-store.queue:add`
|
|
2429
|
+
* **Engine:** Not available in-engine
|
|
2430
|
+
*
|
|
2431
|
+
* @param body
|
|
2432
|
+
* @param universe_id The universe ID.
|
|
2433
|
+
* @param queue_id The queue ID.
|
|
2034
2434
|
*/
|
|
2035
2435
|
exports.postCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItems = (0, __1.endpoint)({
|
|
2036
2436
|
method: 'POST',
|
|
2037
2437
|
path: '/cloud/v2/universes/:universe_id/memory-store/queues/:queue_id/items',
|
|
2038
2438
|
baseUrl: 'https://apis.roblox.com',
|
|
2439
|
+
scopes: ['memory-store.queue:add'],
|
|
2039
2440
|
requestFormat: 'json',
|
|
2040
2441
|
serializationMethod: {
|
|
2041
2442
|
body: {},
|
|
@@ -2051,19 +2452,24 @@ exports.postCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItems = (0, __1.en
|
|
|
2051
2452
|
errors: [],
|
|
2052
2453
|
});
|
|
2053
2454
|
/**
|
|
2054
|
-
*
|
|
2055
|
-
*
|
|
2455
|
+
* `STABLE`
|
|
2456
|
+
*
|
|
2457
|
+
* Discards read items from the front of the queue.
|
|
2458
|
+
|
|
2459
|
+
Takes a `readId` from a previous `Read` operation.
|
|
2460
|
+
*
|
|
2461
|
+
* **Scopes:** `memory-store.queue:discard`
|
|
2462
|
+
* **Engine:** Not available in-engine
|
|
2463
|
+
*
|
|
2056
2464
|
* @param body
|
|
2057
2465
|
* @param universe_id The universe ID.
|
|
2058
2466
|
* @param queue_id The queue ID.
|
|
2059
|
-
* @description Discards read items from the front of the queue.
|
|
2060
|
-
|
|
2061
|
-
Takes a `readId` from a previous `Read` operation.
|
|
2062
2467
|
*/
|
|
2063
2468
|
exports.postCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItemsDiscard = (0, __1.endpoint)({
|
|
2064
2469
|
method: 'POST',
|
|
2065
2470
|
path: '/cloud/v2/universes/:universe_id/memory-store/queues/:queue_id/items:discard',
|
|
2066
2471
|
baseUrl: 'https://apis.roblox.com',
|
|
2472
|
+
scopes: ['memory-store.queue:discard'],
|
|
2067
2473
|
requestFormat: 'json',
|
|
2068
2474
|
serializationMethod: {
|
|
2069
2475
|
body: {},
|
|
@@ -2079,8 +2485,15 @@ exports.postCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItemsDiscard = (0,
|
|
|
2079
2485
|
errors: [],
|
|
2080
2486
|
});
|
|
2081
2487
|
/**
|
|
2082
|
-
*
|
|
2083
|
-
*
|
|
2488
|
+
* `STABLE`
|
|
2489
|
+
*
|
|
2490
|
+
* Returns the specified number of items at the front of the queue.
|
|
2491
|
+
|
|
2492
|
+
|
|
2493
|
+
*
|
|
2494
|
+
* **Scopes:** `memory-store.queue:dequeue`
|
|
2495
|
+
* **Engine:** Not available in-engine
|
|
2496
|
+
*
|
|
2084
2497
|
* @param universe_id The universe ID.
|
|
2085
2498
|
* @param queue_id The queue ID.
|
|
2086
2499
|
* @param count The number of items to read from the queue
|
|
@@ -2099,14 +2512,12 @@ window duration.
|
|
|
2099
2512
|
It must be written in seconds greater than 0 and end with `s`.
|
|
2100
2513
|
|
|
2101
2514
|
Defaults to `30s`.
|
|
2102
|
-
* @description Returns the specified number of items at the front of the queue.
|
|
2103
|
-
|
|
2104
|
-
|
|
2105
2515
|
*/
|
|
2106
2516
|
exports.getCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItemsRead = (0, __1.endpoint)({
|
|
2107
2517
|
method: 'GET',
|
|
2108
2518
|
path: '/cloud/v2/universes/:universe_id/memory-store/queues/:queue_id/items:read',
|
|
2109
2519
|
baseUrl: 'https://apis.roblox.com',
|
|
2520
|
+
scopes: ['memory-store.queue:dequeue'],
|
|
2110
2521
|
requestFormat: 'json',
|
|
2111
2522
|
serializationMethod: {
|
|
2112
2523
|
universe_id: {},
|
|
@@ -2126,8 +2537,13 @@ exports.getCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItemsRead = (0, __1
|
|
|
2126
2537
|
errors: [],
|
|
2127
2538
|
});
|
|
2128
2539
|
/**
|
|
2129
|
-
*
|
|
2130
|
-
*
|
|
2540
|
+
* `STABLE`
|
|
2541
|
+
*
|
|
2542
|
+
* Gets and returns items in the map with a given order and filter.
|
|
2543
|
+
*
|
|
2544
|
+
* **Scopes:** `memory-store.sorted-map:read`
|
|
2545
|
+
* **Engine:** Not available in-engine
|
|
2546
|
+
*
|
|
2131
2547
|
* @param universe_id The universe ID.
|
|
2132
2548
|
* @param sorted_map_id The sorted-map ID.
|
|
2133
2549
|
* @param maxPageSize The maximum number of memory store sorted map items to return. The service
|
|
@@ -2155,12 +2571,12 @@ and `sortKey` fields are supported. In terms of operators, only `<`, `>`
|
|
|
2155
2571
|
and `&&` are allowed'
|
|
2156
2572
|
|
|
2157
2573
|
Example: `id > "key-001" && id < "key-100"`
|
|
2158
|
-
* @description Gets and returns items in the map with a given order and filter.
|
|
2159
2574
|
*/
|
|
2160
2575
|
exports.getCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItems = (0, __1.endpoint)({
|
|
2161
2576
|
method: 'GET',
|
|
2162
2577
|
path: '/cloud/v2/universes/:universe_id/memory-store/sorted-maps/:sorted_map_id/items',
|
|
2163
2578
|
baseUrl: 'https://apis.roblox.com',
|
|
2579
|
+
scopes: ['memory-store.sorted-map:read'],
|
|
2164
2580
|
requestFormat: 'json',
|
|
2165
2581
|
serializationMethod: {
|
|
2166
2582
|
universe_id: {},
|
|
@@ -2182,8 +2598,13 @@ exports.getCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItems = (0,
|
|
|
2182
2598
|
errors: [],
|
|
2183
2599
|
});
|
|
2184
2600
|
/**
|
|
2185
|
-
*
|
|
2186
|
-
*
|
|
2601
|
+
* `STABLE`
|
|
2602
|
+
*
|
|
2603
|
+
* Creates the specified map item if it doesn't exist.
|
|
2604
|
+
*
|
|
2605
|
+
* **Scopes:** `memory-store.sorted-map:write`
|
|
2606
|
+
* **Engine:** Not available in-engine
|
|
2607
|
+
*
|
|
2187
2608
|
* @param body
|
|
2188
2609
|
* @param universe_id The universe ID.
|
|
2189
2610
|
* @param sorted_map_id The sorted-map ID.
|
|
@@ -2193,12 +2614,12 @@ final component of the memory store sorted map item's resource path.
|
|
|
2193
2614
|
This value should be a 1-127 character string that supports alphanumeric
|
|
2194
2615
|
and special characters. This id is case sensitive. The id must be url
|
|
2195
2616
|
encoded if it contains any url breaking special characters.
|
|
2196
|
-
* @description Creates the specified map item if it doesn't exist.
|
|
2197
2617
|
*/
|
|
2198
2618
|
exports.postCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItems = (0, __1.endpoint)({
|
|
2199
2619
|
method: 'POST',
|
|
2200
2620
|
path: '/cloud/v2/universes/:universe_id/memory-store/sorted-maps/:sorted_map_id/items',
|
|
2201
2621
|
baseUrl: 'https://apis.roblox.com',
|
|
2622
|
+
scopes: ['memory-store.sorted-map:write'],
|
|
2202
2623
|
requestFormat: 'json',
|
|
2203
2624
|
serializationMethod: {
|
|
2204
2625
|
body: {},
|
|
@@ -2216,17 +2637,22 @@ exports.postCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItems = (0
|
|
|
2216
2637
|
errors: [],
|
|
2217
2638
|
});
|
|
2218
2639
|
/**
|
|
2219
|
-
*
|
|
2220
|
-
*
|
|
2640
|
+
* `STABLE`
|
|
2641
|
+
*
|
|
2642
|
+
* Gets and returns the value of the given key in the map.
|
|
2643
|
+
*
|
|
2644
|
+
* **Scopes:** `memory-store.sorted-map:read`
|
|
2645
|
+
* **Engine:** Not available in-engine
|
|
2646
|
+
*
|
|
2221
2647
|
* @param universe_id The universe ID.
|
|
2222
2648
|
* @param sorted_map_id The sorted-map ID.
|
|
2223
2649
|
* @param item_id The item ID.
|
|
2224
|
-
* @description Gets and returns the value of the given key in the map.
|
|
2225
2650
|
*/
|
|
2226
2651
|
exports.getCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId = (0, __1.endpoint)({
|
|
2227
2652
|
method: 'GET',
|
|
2228
2653
|
path: '/cloud/v2/universes/:universe_id/memory-store/sorted-maps/:sorted_map_id/items/:item_id',
|
|
2229
2654
|
baseUrl: 'https://apis.roblox.com',
|
|
2655
|
+
scopes: ['memory-store.sorted-map:read'],
|
|
2230
2656
|
requestFormat: 'json',
|
|
2231
2657
|
serializationMethod: {
|
|
2232
2658
|
universe_id: {},
|
|
@@ -2242,17 +2668,22 @@ exports.getCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId
|
|
|
2242
2668
|
errors: [],
|
|
2243
2669
|
});
|
|
2244
2670
|
/**
|
|
2245
|
-
*
|
|
2246
|
-
*
|
|
2671
|
+
* `STABLE`
|
|
2672
|
+
*
|
|
2673
|
+
* Deletes the specified item from the map.
|
|
2674
|
+
*
|
|
2675
|
+
* **Scopes:** `memory-store.sorted-map:write`
|
|
2676
|
+
* **Engine:** Not available in-engine
|
|
2677
|
+
*
|
|
2247
2678
|
* @param universe_id The universe ID.
|
|
2248
2679
|
* @param sorted_map_id The sorted-map ID.
|
|
2249
2680
|
* @param item_id The item ID.
|
|
2250
|
-
* @description Deletes the specified item from the map.
|
|
2251
2681
|
*/
|
|
2252
2682
|
exports.deleteCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId = (0, __1.endpoint)({
|
|
2253
2683
|
method: 'DELETE',
|
|
2254
2684
|
path: '/cloud/v2/universes/:universe_id/memory-store/sorted-maps/:sorted_map_id/items/:item_id',
|
|
2255
2685
|
baseUrl: 'https://apis.roblox.com',
|
|
2686
|
+
scopes: ['memory-store.sorted-map:write'],
|
|
2256
2687
|
requestFormat: 'json',
|
|
2257
2688
|
serializationMethod: {
|
|
2258
2689
|
universe_id: {},
|
|
@@ -2268,20 +2699,25 @@ exports.deleteCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsIte
|
|
|
2268
2699
|
errors: [],
|
|
2269
2700
|
});
|
|
2270
2701
|
/**
|
|
2271
|
-
*
|
|
2272
|
-
*
|
|
2702
|
+
* `STABLE`
|
|
2703
|
+
*
|
|
2704
|
+
* Updates the specified map item.
|
|
2705
|
+
*
|
|
2706
|
+
* **Scopes:** `memory-store.sorted-map:write`
|
|
2707
|
+
* **Engine:** Not available in-engine
|
|
2708
|
+
*
|
|
2273
2709
|
* @param body
|
|
2274
2710
|
* @param universe_id The universe ID.
|
|
2275
2711
|
* @param sorted_map_id The sorted-map ID.
|
|
2276
2712
|
* @param item_id The item ID.
|
|
2277
2713
|
* @param allowMissing If set to true, and the memory store sorted map item is not found, a memory
|
|
2278
2714
|
store sorted map item is created.
|
|
2279
|
-
* @description Updates the specified map item.
|
|
2280
2715
|
*/
|
|
2281
2716
|
exports.patchCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId = (0, __1.endpoint)({
|
|
2282
2717
|
method: 'PATCH',
|
|
2283
2718
|
path: '/cloud/v2/universes/:universe_id/memory-store/sorted-maps/:sorted_map_id/items/:item_id',
|
|
2284
2719
|
baseUrl: 'https://apis.roblox.com',
|
|
2720
|
+
scopes: ['memory-store.sorted-map:write'],
|
|
2285
2721
|
requestFormat: 'json',
|
|
2286
2722
|
serializationMethod: {
|
|
2287
2723
|
body: {},
|
|
@@ -2301,8 +2737,13 @@ exports.patchCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItem
|
|
|
2301
2737
|
errors: [],
|
|
2302
2738
|
});
|
|
2303
2739
|
/**
|
|
2304
|
-
*
|
|
2305
|
-
*
|
|
2740
|
+
* `STABLE`
|
|
2741
|
+
*
|
|
2742
|
+
* Returns a list of entries from an ordered data store.
|
|
2743
|
+
*
|
|
2744
|
+
* **Scopes:** `universe.ordered-data-store.scope.entry:read`
|
|
2745
|
+
* **Engine:** Not available in-engine
|
|
2746
|
+
*
|
|
2306
2747
|
* @param universe_id The universe ID.
|
|
2307
2748
|
* @param ordered_data_store_id The ordered-data-store ID.
|
|
2308
2749
|
* @param scope_id The scope ID.
|
|
@@ -2333,12 +2774,12 @@ maxValue the user can use the logical operator `&&`. All tokens in the
|
|
|
2333
2774
|
filter expression must be separated by a single space.
|
|
2334
2775
|
|
|
2335
2776
|
Example filters: `entry <= 10`; `entry >= 10 && entry <= 30`
|
|
2336
|
-
* @description Returns a list of entries from an ordered data store.
|
|
2337
2777
|
*/
|
|
2338
2778
|
exports.getCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntries = (0, __1.endpoint)({
|
|
2339
2779
|
method: 'GET',
|
|
2340
2780
|
path: '/cloud/v2/universes/:universe_id/ordered-data-stores/:ordered_data_store_id/scopes/:scope_id/entries',
|
|
2341
2781
|
baseUrl: 'https://apis.roblox.com',
|
|
2782
|
+
scopes: ['universe.ordered-data-store.scope.entry:read'],
|
|
2342
2783
|
requestFormat: 'json',
|
|
2343
2784
|
serializationMethod: {
|
|
2344
2785
|
universe_id: {},
|
|
@@ -2362,8 +2803,15 @@ exports.getCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesSc
|
|
|
2362
2803
|
errors: [],
|
|
2363
2804
|
});
|
|
2364
2805
|
/**
|
|
2365
|
-
*
|
|
2366
|
-
*
|
|
2806
|
+
* `STABLE`
|
|
2807
|
+
*
|
|
2808
|
+
* Creates an entry with the provided ID and value.
|
|
2809
|
+
|
|
2810
|
+
Returns a 400 Bad Request if the entry exists.
|
|
2811
|
+
*
|
|
2812
|
+
* **Scopes:** `universe.ordered-data-store.scope.entry:write`
|
|
2813
|
+
* **Engine:** Not available in-engine
|
|
2814
|
+
*
|
|
2367
2815
|
* @param body
|
|
2368
2816
|
* @param universe_id The universe ID.
|
|
2369
2817
|
* @param ordered_data_store_id The ordered-data-store ID.
|
|
@@ -2373,14 +2821,12 @@ component of the ordered data store entry's resource path.
|
|
|
2373
2821
|
|
|
2374
2822
|
This value should be A 1-63 character string. We strongly recommend using
|
|
2375
2823
|
only lowercase letters, numeric digits, and hyphens.
|
|
2376
|
-
* @description Creates an entry with the provided ID and value.
|
|
2377
|
-
|
|
2378
|
-
Returns a 400 Bad Request if the entry exists.
|
|
2379
2824
|
*/
|
|
2380
2825
|
exports.postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntries = (0, __1.endpoint)({
|
|
2381
2826
|
method: 'POST',
|
|
2382
2827
|
path: '/cloud/v2/universes/:universe_id/ordered-data-stores/:ordered_data_store_id/scopes/:scope_id/entries',
|
|
2383
2828
|
baseUrl: 'https://apis.roblox.com',
|
|
2829
|
+
scopes: ['universe.ordered-data-store.scope.entry:write'],
|
|
2384
2830
|
requestFormat: 'json',
|
|
2385
2831
|
serializationMethod: {
|
|
2386
2832
|
body: {},
|
|
@@ -2400,18 +2846,23 @@ exports.postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesS
|
|
|
2400
2846
|
errors: [],
|
|
2401
2847
|
});
|
|
2402
2848
|
/**
|
|
2403
|
-
*
|
|
2404
|
-
*
|
|
2849
|
+
* `STABLE`
|
|
2850
|
+
*
|
|
2851
|
+
* Gets the specified entry.
|
|
2852
|
+
*
|
|
2853
|
+
* **Scopes:** `universe.ordered-data-store.scope.entry:read`
|
|
2854
|
+
* **Engine:** Not available in-engine
|
|
2855
|
+
*
|
|
2405
2856
|
* @param universe_id The universe ID.
|
|
2406
2857
|
* @param ordered_data_store_id The ordered-data-store ID.
|
|
2407
2858
|
* @param scope_id The scope ID.
|
|
2408
2859
|
* @param entry_id The entry ID.
|
|
2409
|
-
* @description Gets the specified entry.
|
|
2410
2860
|
*/
|
|
2411
2861
|
exports.getCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId = (0, __1.endpoint)({
|
|
2412
2862
|
method: 'GET',
|
|
2413
2863
|
path: '/cloud/v2/universes/:universe_id/ordered-data-stores/:ordered_data_store_id/scopes/:scope_id/entries/:entry_id',
|
|
2414
2864
|
baseUrl: 'https://apis.roblox.com',
|
|
2865
|
+
scopes: ['universe.ordered-data-store.scope.entry:read'],
|
|
2415
2866
|
requestFormat: 'json',
|
|
2416
2867
|
serializationMethod: {
|
|
2417
2868
|
universe_id: {},
|
|
@@ -2429,21 +2880,26 @@ exports.getCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesSc
|
|
|
2429
2880
|
errors: [],
|
|
2430
2881
|
});
|
|
2431
2882
|
/**
|
|
2432
|
-
*
|
|
2433
|
-
*
|
|
2883
|
+
* `STABLE`
|
|
2884
|
+
*
|
|
2885
|
+
* Deletes the specified entry.
|
|
2886
|
+
|
|
2887
|
+
On success, returns 200 OK. If the entry doesn't exist, returns
|
|
2888
|
+
404 Not Found.
|
|
2889
|
+
*
|
|
2890
|
+
* **Scopes:** `universe.ordered-data-store.scope.entry:write`
|
|
2891
|
+
* **Engine:** Not available in-engine
|
|
2892
|
+
*
|
|
2434
2893
|
* @param universe_id The universe ID.
|
|
2435
2894
|
* @param ordered_data_store_id The ordered-data-store ID.
|
|
2436
2895
|
* @param scope_id The scope ID.
|
|
2437
2896
|
* @param entry_id The entry ID.
|
|
2438
|
-
* @description Deletes the specified entry.
|
|
2439
|
-
|
|
2440
|
-
On success, returns 200 OK. If the entry doesn't exist, returns
|
|
2441
|
-
404 Not Found.
|
|
2442
2897
|
*/
|
|
2443
2898
|
exports.deleteCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId = (0, __1.endpoint)({
|
|
2444
2899
|
method: 'DELETE',
|
|
2445
2900
|
path: '/cloud/v2/universes/:universe_id/ordered-data-stores/:ordered_data_store_id/scopes/:scope_id/entries/:entry_id',
|
|
2446
2901
|
baseUrl: 'https://apis.roblox.com',
|
|
2902
|
+
scopes: ['universe.ordered-data-store.scope.entry:write'],
|
|
2447
2903
|
requestFormat: 'json',
|
|
2448
2904
|
serializationMethod: {
|
|
2449
2905
|
universe_id: {},
|
|
@@ -2461,8 +2917,13 @@ exports.deleteCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScope
|
|
|
2461
2917
|
errors: [],
|
|
2462
2918
|
});
|
|
2463
2919
|
/**
|
|
2464
|
-
*
|
|
2465
|
-
*
|
|
2920
|
+
* `STABLE`
|
|
2921
|
+
*
|
|
2922
|
+
* Updates the value of an entry.
|
|
2923
|
+
*
|
|
2924
|
+
* **Scopes:** `universe.ordered-data-store.scope.entry:write`
|
|
2925
|
+
* **Engine:** Not available in-engine
|
|
2926
|
+
*
|
|
2466
2927
|
* @param body
|
|
2467
2928
|
* @param universe_id The universe ID.
|
|
2468
2929
|
* @param ordered_data_store_id The ordered-data-store ID.
|
|
@@ -2470,12 +2931,12 @@ exports.deleteCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScope
|
|
|
2470
2931
|
* @param entry_id The entry ID.
|
|
2471
2932
|
* @param allowMissing If set to true, and the ordered data store entry is not found, a ordered
|
|
2472
2933
|
data store entry is created.
|
|
2473
|
-
* @description Updates the value of an entry.
|
|
2474
2934
|
*/
|
|
2475
2935
|
exports.patchCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId = (0, __1.endpoint)({
|
|
2476
2936
|
method: 'PATCH',
|
|
2477
2937
|
path: '/cloud/v2/universes/:universe_id/ordered-data-stores/:ordered_data_store_id/scopes/:scope_id/entries/:entry_id',
|
|
2478
2938
|
baseUrl: 'https://apis.roblox.com',
|
|
2939
|
+
scopes: ['universe.ordered-data-store.scope.entry:write'],
|
|
2479
2940
|
requestFormat: 'json',
|
|
2480
2941
|
serializationMethod: {
|
|
2481
2942
|
body: {},
|
|
@@ -2497,14 +2958,9 @@ exports.patchCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopes
|
|
|
2497
2958
|
errors: [],
|
|
2498
2959
|
});
|
|
2499
2960
|
/**
|
|
2500
|
-
*
|
|
2501
|
-
*
|
|
2502
|
-
*
|
|
2503
|
-
* @param universe_id The universe ID.
|
|
2504
|
-
* @param ordered_data_store_id The ordered-data-store ID.
|
|
2505
|
-
* @param scope_id The scope ID.
|
|
2506
|
-
* @param entry_id The entry ID.
|
|
2507
|
-
* @description Increments the value of the specified entry. Both the existing value and
|
|
2961
|
+
* `STABLE`
|
|
2962
|
+
*
|
|
2963
|
+
* Increments the value of the specified entry. Both the existing value and
|
|
2508
2964
|
the increment amount must be integers.
|
|
2509
2965
|
|
|
2510
2966
|
If the entry doesn't exist, creates an entry with the specified value.
|
|
@@ -2514,11 +2970,21 @@ When this happens, the returned value will be clamped to the valid range,
|
|
|
2514
2970
|
but the backend may persist the original value. This behavior is maintained
|
|
2515
2971
|
for backwards compatibility reasons, but may change in a future version of
|
|
2516
2972
|
this API.
|
|
2973
|
+
*
|
|
2974
|
+
* **Scopes:** `universe.ordered-data-store.scope.entry:write`
|
|
2975
|
+
* **Engine:** Not available in-engine
|
|
2976
|
+
*
|
|
2977
|
+
* @param body
|
|
2978
|
+
* @param universe_id The universe ID.
|
|
2979
|
+
* @param ordered_data_store_id The ordered-data-store ID.
|
|
2980
|
+
* @param scope_id The scope ID.
|
|
2981
|
+
* @param entry_id The entry ID.
|
|
2517
2982
|
*/
|
|
2518
2983
|
exports.postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryIdIncrement = (0, __1.endpoint)({
|
|
2519
2984
|
method: 'POST',
|
|
2520
2985
|
path: '/cloud/v2/universes/:universe_id/ordered-data-stores/:ordered_data_store_id/scopes/:scope_id/entries/:entry_id:increment',
|
|
2521
2986
|
baseUrl: 'https://apis.roblox.com',
|
|
2987
|
+
scopes: ['universe.ordered-data-store.scope.entry:write'],
|
|
2522
2988
|
requestFormat: 'json',
|
|
2523
2989
|
serializationMethod: {
|
|
2524
2990
|
body: {},
|
|
@@ -2538,11 +3004,14 @@ exports.postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesS
|
|
|
2538
3004
|
errors: [],
|
|
2539
3005
|
});
|
|
2540
3006
|
/**
|
|
2541
|
-
*
|
|
2542
|
-
*
|
|
3007
|
+
* `STABLE`
|
|
3008
|
+
*
|
|
3009
|
+
* Gets the specified place.
|
|
3010
|
+
*
|
|
3011
|
+
* **Engine:** Not available in-engine
|
|
3012
|
+
*
|
|
2543
3013
|
* @param universe_id The universe ID.
|
|
2544
3014
|
* @param place_id The place ID.
|
|
2545
|
-
* @description Gets the specified place.
|
|
2546
3015
|
*/
|
|
2547
3016
|
exports.getCloudV2UniversesUniverseIdPlacesPlaceId = (0, __1.endpoint)({
|
|
2548
3017
|
method: 'GET',
|
|
@@ -2561,18 +3030,23 @@ exports.getCloudV2UniversesUniverseIdPlacesPlaceId = (0, __1.endpoint)({
|
|
|
2561
3030
|
errors: [],
|
|
2562
3031
|
});
|
|
2563
3032
|
/**
|
|
2564
|
-
*
|
|
2565
|
-
*
|
|
3033
|
+
* `STABLE`
|
|
3034
|
+
*
|
|
3035
|
+
* Updates the specified place.
|
|
3036
|
+
*
|
|
3037
|
+
* **Scopes:** `universe.place:write`
|
|
3038
|
+
* **Engine:** Not available in-engine
|
|
3039
|
+
*
|
|
2566
3040
|
* @param body
|
|
2567
3041
|
* @param universe_id The universe ID.
|
|
2568
3042
|
* @param place_id The place ID.
|
|
2569
3043
|
* @param updateMask The list of fields to update.
|
|
2570
|
-
* @description Updates the specified place.
|
|
2571
3044
|
*/
|
|
2572
3045
|
exports.patchCloudV2UniversesUniverseIdPlacesPlaceId = (0, __1.endpoint)({
|
|
2573
3046
|
method: 'PATCH',
|
|
2574
3047
|
path: '/cloud/v2/universes/:universe_id/places/:place_id',
|
|
2575
3048
|
baseUrl: 'https://apis.roblox.com',
|
|
3049
|
+
scopes: ['universe.place:write'],
|
|
2576
3050
|
requestFormat: 'json',
|
|
2577
3051
|
serializationMethod: {
|
|
2578
3052
|
body: {},
|
|
@@ -2590,22 +3064,27 @@ exports.patchCloudV2UniversesUniverseIdPlacesPlaceId = (0, __1.endpoint)({
|
|
|
2590
3064
|
errors: [],
|
|
2591
3065
|
});
|
|
2592
3066
|
/**
|
|
2593
|
-
*
|
|
2594
|
-
*
|
|
2595
|
-
*
|
|
2596
|
-
* @param place_id The place ID.
|
|
2597
|
-
* @param instance_id The instance ID.
|
|
2598
|
-
* @description Gets an instance and its property data.
|
|
3067
|
+
* `BETA`
|
|
3068
|
+
*
|
|
3069
|
+
* Gets an instance and its property data.
|
|
2599
3070
|
|
|
2600
3071
|
The maximum supported response data size is 500,000 bytes. If this limit is
|
|
2601
3072
|
exceeded, the returned `Operation` will be completed with an error result
|
|
2602
3073
|
that has an error code of `422`.
|
|
2603
3074
|
|
|
3075
|
+
*
|
|
3076
|
+
* **Scopes:** `universe.place.instance:read`
|
|
3077
|
+
* **Engine:** Not available in-engine
|
|
3078
|
+
*
|
|
3079
|
+
* @param universe_id The universe ID.
|
|
3080
|
+
* @param place_id The place ID.
|
|
3081
|
+
* @param instance_id The instance ID.
|
|
2604
3082
|
*/
|
|
2605
3083
|
exports.getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId = (0, __1.endpoint)({
|
|
2606
3084
|
method: 'GET',
|
|
2607
3085
|
path: '/cloud/v2/universes/:universe_id/places/:place_id/instances/:instance_id',
|
|
2608
3086
|
baseUrl: 'https://apis.roblox.com',
|
|
3087
|
+
scopes: ['universe.place.instance:read'],
|
|
2609
3088
|
requestFormat: 'json',
|
|
2610
3089
|
serializationMethod: {
|
|
2611
3090
|
universe_id: {},
|
|
@@ -2621,22 +3100,27 @@ exports.getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId = (0, __1.
|
|
|
2621
3100
|
errors: [],
|
|
2622
3101
|
});
|
|
2623
3102
|
/**
|
|
2624
|
-
*
|
|
2625
|
-
*
|
|
3103
|
+
* `BETA`
|
|
3104
|
+
*
|
|
3105
|
+
* Updates an instance's property data.
|
|
3106
|
+
|
|
3107
|
+
When updating a `Script` instance's source property, the maximum supported
|
|
3108
|
+
property size is 200,000 bytes after UTF-8 encoding.
|
|
3109
|
+
*
|
|
3110
|
+
* **Scopes:** `universe.place.instance:write`
|
|
3111
|
+
* **Engine:** Not available in-engine
|
|
3112
|
+
*
|
|
2626
3113
|
* @param body
|
|
2627
3114
|
* @param universe_id The universe ID.
|
|
2628
3115
|
* @param place_id The place ID.
|
|
2629
3116
|
* @param instance_id The instance ID.
|
|
2630
3117
|
* @param updateMask The list of fields to update.
|
|
2631
|
-
* @description Updates an instance's property data.
|
|
2632
|
-
|
|
2633
|
-
When updating a `Script` instance's source property, the maximum supported
|
|
2634
|
-
property size is 200,000 bytes after UTF-8 encoding.
|
|
2635
3118
|
*/
|
|
2636
3119
|
exports.patchCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId = (0, __1.endpoint)({
|
|
2637
3120
|
method: 'PATCH',
|
|
2638
3121
|
path: '/cloud/v2/universes/:universe_id/places/:place_id/instances/:instance_id',
|
|
2639
3122
|
baseUrl: 'https://apis.roblox.com',
|
|
3123
|
+
scopes: ['universe.place.instance:write'],
|
|
2640
3124
|
requestFormat: 'json',
|
|
2641
3125
|
serializationMethod: {
|
|
2642
3126
|
body: {},
|
|
@@ -2656,8 +3140,19 @@ exports.patchCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId = (0, __
|
|
|
2656
3140
|
errors: [],
|
|
2657
3141
|
});
|
|
2658
3142
|
/**
|
|
2659
|
-
*
|
|
2660
|
-
*
|
|
3143
|
+
* `BETA`
|
|
3144
|
+
*
|
|
3145
|
+
* Lists an instance's children.
|
|
3146
|
+
|
|
3147
|
+
The maximum supported response data size is 500,000 bytes. If this limit is
|
|
3148
|
+
exceeded, the returned `Operation` will be completed with an error result
|
|
3149
|
+
that has an error code of `422`.
|
|
3150
|
+
|
|
3151
|
+
|
|
3152
|
+
*
|
|
3153
|
+
* **Scopes:** `universe.place.instance:read`
|
|
3154
|
+
* **Engine:** Not available in-engine
|
|
3155
|
+
*
|
|
2661
3156
|
* @param universe_id The universe ID.
|
|
2662
3157
|
* @param place_id The place ID.
|
|
2663
3158
|
* @param instance_id The instance ID.
|
|
@@ -2671,18 +3166,12 @@ Provide this to retrieve the subsequent page.
|
|
|
2671
3166
|
When paginating, all other parameters provided to
|
|
2672
3167
|
`ListInstanceChildrenRequest` must match the call that provided the page
|
|
2673
3168
|
token.
|
|
2674
|
-
* @description Lists an instance's children.
|
|
2675
|
-
|
|
2676
|
-
The maximum supported response data size is 500,000 bytes. If this limit is
|
|
2677
|
-
exceeded, the returned `Operation` will be completed with an error result
|
|
2678
|
-
that has an error code of `422`.
|
|
2679
|
-
|
|
2680
|
-
|
|
2681
3169
|
*/
|
|
2682
3170
|
exports.getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceIdListChildren = (0, __1.endpoint)({
|
|
2683
3171
|
method: 'GET',
|
|
2684
3172
|
path: '/cloud/v2/universes/:universe_id/places/:place_id/instances/:instance_id:listChildren',
|
|
2685
3173
|
baseUrl: 'https://apis.roblox.com',
|
|
3174
|
+
scopes: ['universe.place.instance:read'],
|
|
2686
3175
|
requestFormat: 'json',
|
|
2687
3176
|
serializationMethod: {
|
|
2688
3177
|
universe_id: {},
|
|
@@ -2702,12 +3191,9 @@ exports.getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceIdListChildre
|
|
|
2702
3191
|
errors: [],
|
|
2703
3192
|
});
|
|
2704
3193
|
/**
|
|
2705
|
-
*
|
|
2706
|
-
*
|
|
2707
|
-
*
|
|
2708
|
-
* @param universe_id The universe ID.
|
|
2709
|
-
* @param place_id The place ID.
|
|
2710
|
-
* @description Creates a task but does not wait for the task to complete.
|
|
3194
|
+
* `BETA`
|
|
3195
|
+
*
|
|
3196
|
+
* Creates a task but does not wait for the task to complete.
|
|
2711
3197
|
|
|
2712
3198
|
To check whether a task has
|
|
2713
3199
|
completed, call the `GetLuauExecutionSessionTask` method and inspect the
|
|
@@ -2716,11 +3202,19 @@ completed, call the `GetLuauExecutionSessionTask` method and inspect the
|
|
|
2716
3202
|
Quotas:
|
|
2717
3203
|
* 5 calls per minute per API key owner
|
|
2718
3204
|
* 45 calls per minute per IP address
|
|
3205
|
+
*
|
|
3206
|
+
* **Scopes:** `universe.place.luau-execution-session:write`
|
|
3207
|
+
* **Engine:** Not available in-engine
|
|
3208
|
+
*
|
|
3209
|
+
* @param body
|
|
3210
|
+
* @param universe_id The universe ID.
|
|
3211
|
+
* @param place_id The place ID.
|
|
2719
3212
|
*/
|
|
2720
3213
|
exports.postCloudV2UniversesUniverseIdPlacesPlaceIdLuauExecutionSessionTasks = (0, __1.endpoint)({
|
|
2721
3214
|
method: 'POST',
|
|
2722
3215
|
path: '/cloud/v2/universes/:universe_id/places/:place_id/luau-execution-session-tasks',
|
|
2723
3216
|
baseUrl: 'https://apis.roblox.com',
|
|
3217
|
+
scopes: ['universe.place.luau-execution-session:write'],
|
|
2724
3218
|
requestFormat: 'json',
|
|
2725
3219
|
serializationMethod: {
|
|
2726
3220
|
body: {},
|
|
@@ -2736,8 +3230,14 @@ exports.postCloudV2UniversesUniverseIdPlacesPlaceIdLuauExecutionSessionTasks = (
|
|
|
2736
3230
|
errors: [],
|
|
2737
3231
|
});
|
|
2738
3232
|
/**
|
|
2739
|
-
*
|
|
2740
|
-
*
|
|
3233
|
+
* `BETA`
|
|
3234
|
+
*
|
|
3235
|
+
* List user restrictions for users that have ever been banned in either a
|
|
3236
|
+
universe or a specific place.
|
|
3237
|
+
*
|
|
3238
|
+
* **Scopes:** `universe.user-restriction:read`
|
|
3239
|
+
* **Engine:** Not available in-engine
|
|
3240
|
+
*
|
|
2741
3241
|
* @param universe_id The universe ID.
|
|
2742
3242
|
* @param place_id The place ID.
|
|
2743
3243
|
* @param maxPageSize The maximum number of user restrictions to return. The service might return
|
|
@@ -2747,13 +3247,12 @@ returned. The maximum value is 100 and higher values are set to 100.
|
|
|
2747
3247
|
|
|
2748
3248
|
When paginating, all other parameters provided to the subsequent call must
|
|
2749
3249
|
match the call that provided the page token.
|
|
2750
|
-
* @description List user restrictions for users that have ever been banned in either a
|
|
2751
|
-
universe or a specific place.
|
|
2752
3250
|
*/
|
|
2753
3251
|
exports.getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictions = (0, __1.endpoint)({
|
|
2754
3252
|
method: 'GET',
|
|
2755
3253
|
path: '/cloud/v2/universes/:universe_id/places/:place_id/user-restrictions',
|
|
2756
3254
|
baseUrl: 'https://apis.roblox.com',
|
|
3255
|
+
scopes: ['universe.user-restriction:read'],
|
|
2757
3256
|
requestFormat: 'json',
|
|
2758
3257
|
serializationMethod: {
|
|
2759
3258
|
universe_id: {},
|
|
@@ -2771,17 +3270,22 @@ exports.getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictions = (0, __1.end
|
|
|
2771
3270
|
errors: [],
|
|
2772
3271
|
});
|
|
2773
3272
|
/**
|
|
2774
|
-
*
|
|
2775
|
-
*
|
|
3273
|
+
* `BETA`
|
|
3274
|
+
*
|
|
3275
|
+
* Get the user restriction.
|
|
3276
|
+
*
|
|
3277
|
+
* **Scopes:** `universe.user-restriction:read`
|
|
3278
|
+
* **Engine:** Not available in-engine
|
|
3279
|
+
*
|
|
2776
3280
|
* @param universe_id The universe ID.
|
|
2777
3281
|
* @param place_id The place ID.
|
|
2778
3282
|
* @param user_restriction_id The user-restriction ID.
|
|
2779
|
-
* @description Get the user restriction.
|
|
2780
3283
|
*/
|
|
2781
3284
|
exports.getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrictionId = (0, __1.endpoint)({
|
|
2782
3285
|
method: 'GET',
|
|
2783
3286
|
path: '/cloud/v2/universes/:universe_id/places/:place_id/user-restrictions/:user_restriction_id',
|
|
2784
3287
|
baseUrl: 'https://apis.roblox.com',
|
|
3288
|
+
scopes: ['universe.user-restriction:read'],
|
|
2785
3289
|
requestFormat: 'json',
|
|
2786
3290
|
serializationMethod: {
|
|
2787
3291
|
universe_id: {},
|
|
@@ -2797,8 +3301,13 @@ exports.getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrictio
|
|
|
2797
3301
|
errors: [],
|
|
2798
3302
|
});
|
|
2799
3303
|
/**
|
|
2800
|
-
*
|
|
2801
|
-
*
|
|
3304
|
+
* `BETA`
|
|
3305
|
+
*
|
|
3306
|
+
* Update the user restriction.
|
|
3307
|
+
*
|
|
3308
|
+
* **Scopes:** `universe.user-restriction:write`
|
|
3309
|
+
* **Engine:** Not available in-engine
|
|
3310
|
+
*
|
|
2802
3311
|
* @param body
|
|
2803
3312
|
* @param universe_id The universe ID.
|
|
2804
3313
|
* @param place_id The place ID.
|
|
@@ -2814,12 +3323,12 @@ that index into `game_join_restriction` (such as
|
|
|
2814
3323
|
If this is further in the past than the lifetime of the idempotency key
|
|
2815
3324
|
(which *may* exceed the annotated minimum lifetime), the server *must*
|
|
2816
3325
|
return an error.
|
|
2817
|
-
* @description Update the user restriction.
|
|
2818
3326
|
*/
|
|
2819
3327
|
exports.patchCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrictionId = (0, __1.endpoint)({
|
|
2820
3328
|
method: 'PATCH',
|
|
2821
3329
|
path: '/cloud/v2/universes/:universe_id/places/:place_id/user-restrictions/:user_restriction_id',
|
|
2822
3330
|
baseUrl: 'https://apis.roblox.com',
|
|
3331
|
+
scopes: ['universe.user-restriction:write'],
|
|
2823
3332
|
requestFormat: 'json',
|
|
2824
3333
|
serializationMethod: {
|
|
2825
3334
|
body: {},
|
|
@@ -2843,13 +3352,9 @@ exports.patchCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrict
|
|
|
2843
3352
|
errors: [],
|
|
2844
3353
|
});
|
|
2845
3354
|
/**
|
|
2846
|
-
*
|
|
2847
|
-
*
|
|
2848
|
-
*
|
|
2849
|
-
* @param universe_id The universe ID.
|
|
2850
|
-
* @param place_id The place ID.
|
|
2851
|
-
* @param version_id The version ID.
|
|
2852
|
-
* @description Creates a task but does not wait for the task to complete.
|
|
3355
|
+
* `BETA`
|
|
3356
|
+
*
|
|
3357
|
+
* Creates a task but does not wait for the task to complete.
|
|
2853
3358
|
|
|
2854
3359
|
To check whether a task has
|
|
2855
3360
|
completed, call the `GetLuauExecutionSessionTask` method and inspect the
|
|
@@ -2858,11 +3363,20 @@ completed, call the `GetLuauExecutionSessionTask` method and inspect the
|
|
|
2858
3363
|
Quotas:
|
|
2859
3364
|
* 5 calls per minute per API key owner
|
|
2860
3365
|
* 45 calls per minute per IP address
|
|
3366
|
+
*
|
|
3367
|
+
* **Scopes:** `universe.place.luau-execution-session:write`
|
|
3368
|
+
* **Engine:** Not available in-engine
|
|
3369
|
+
*
|
|
3370
|
+
* @param body
|
|
3371
|
+
* @param universe_id The universe ID.
|
|
3372
|
+
* @param place_id The place ID.
|
|
3373
|
+
* @param version_id The version ID.
|
|
2861
3374
|
*/
|
|
2862
3375
|
exports.postCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionTasks = (0, __1.endpoint)({
|
|
2863
3376
|
method: 'POST',
|
|
2864
3377
|
path: '/cloud/v2/universes/:universe_id/places/:place_id/versions/:version_id/luau-execution-session-tasks',
|
|
2865
3378
|
baseUrl: 'https://apis.roblox.com',
|
|
3379
|
+
scopes: ['universe.place.luau-execution-session:write'],
|
|
2866
3380
|
requestFormat: 'json',
|
|
2867
3381
|
serializationMethod: {
|
|
2868
3382
|
body: {},
|
|
@@ -2880,8 +3394,16 @@ exports.postCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutio
|
|
|
2880
3394
|
errors: [],
|
|
2881
3395
|
});
|
|
2882
3396
|
/**
|
|
2883
|
-
*
|
|
2884
|
-
*
|
|
3397
|
+
* `BETA`
|
|
3398
|
+
*
|
|
3399
|
+
* Gets information about a task.
|
|
3400
|
+
|
|
3401
|
+
Quotas:
|
|
3402
|
+
* 45 calls per minute per API key owner or IP address
|
|
3403
|
+
*
|
|
3404
|
+
* **Scopes:** `universe.place.luau-execution-session:read`, `universe.place.luau-execution-session:write`
|
|
3405
|
+
* **Engine:** Not available in-engine
|
|
3406
|
+
*
|
|
2885
3407
|
* @param universe_id The universe ID.
|
|
2886
3408
|
* @param place_id The place ID.
|
|
2887
3409
|
* @param version_id The version ID.
|
|
@@ -2900,15 +3422,12 @@ Possible values:
|
|
|
2900
3422
|
| VIEW_UNSPECIFIED | The luau execution session task view is not specified; the default will be used. |
|
|
2901
3423
|
| BASIC | Excludes the `script` field. |
|
|
2902
3424
|
| FULL | Includes all fields. |
|
|
2903
|
-
* @description Gets information about a task.
|
|
2904
|
-
|
|
2905
|
-
Quotas:
|
|
2906
|
-
* 45 calls per minute per API key owner or IP address
|
|
2907
3425
|
*/
|
|
2908
3426
|
exports.getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionsLuauExecutionSessionIdTasksTaskId = (0, __1.endpoint)({
|
|
2909
3427
|
method: 'GET',
|
|
2910
3428
|
path: '/cloud/v2/universes/:universe_id/places/:place_id/versions/:version_id/luau-execution-sessions/:luau_execution_session_id/tasks/:task_id',
|
|
2911
3429
|
baseUrl: 'https://apis.roblox.com',
|
|
3430
|
+
scopes: ['universe.place.luau-execution-session:read', 'universe.place.luau-execution-session:write'],
|
|
2912
3431
|
requestFormat: 'json',
|
|
2913
3432
|
serializationMethod: {
|
|
2914
3433
|
universe_id: {},
|
|
@@ -2930,8 +3449,16 @@ exports.getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecution
|
|
|
2930
3449
|
errors: [],
|
|
2931
3450
|
});
|
|
2932
3451
|
/**
|
|
2933
|
-
*
|
|
2934
|
-
*
|
|
3452
|
+
* `BETA`
|
|
3453
|
+
*
|
|
3454
|
+
* Lists log chunks generated by a `LuauExecutionSessionTask`.
|
|
3455
|
+
|
|
3456
|
+
Quotas:
|
|
3457
|
+
* 45 calls per minute per API key owner or IP address
|
|
3458
|
+
*
|
|
3459
|
+
* **Scopes:** `universe.place.luau-execution-session:read`, `universe.place.luau-execution-session:write`
|
|
3460
|
+
* **Engine:** Not available in-engine
|
|
3461
|
+
*
|
|
2935
3462
|
* @param universe_id The universe ID.
|
|
2936
3463
|
* @param place_id The place ID.
|
|
2937
3464
|
* @param version_id The version ID.
|
|
@@ -2958,15 +3485,12 @@ Possible values:
|
|
|
2958
3485
|
| VIEW_UNSPECIFIED | The luau execution session task log view is not specified; the default will be used. |
|
|
2959
3486
|
| 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. |
|
|
2960
3487
|
| 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). |
|
|
2961
|
-
* @description Lists log chunks generated by a `LuauExecutionSessionTask`.
|
|
2962
|
-
|
|
2963
|
-
Quotas:
|
|
2964
|
-
* 45 calls per minute per API key owner or IP address
|
|
2965
3488
|
*/
|
|
2966
3489
|
exports.getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionsLuauExecutionSessionIdTasksTaskIdLogs = (0, __1.endpoint)({
|
|
2967
3490
|
method: 'GET',
|
|
2968
3491
|
path: '/cloud/v2/universes/:universe_id/places/:place_id/versions/:version_id/luau-execution-sessions/:luau_execution_session_id/tasks/:task_id/logs',
|
|
2969
3492
|
baseUrl: 'https://apis.roblox.com',
|
|
3493
|
+
scopes: ['universe.place.luau-execution-session:read', 'universe.place.luau-execution-session:write'],
|
|
2970
3494
|
requestFormat: 'json',
|
|
2971
3495
|
serializationMethod: {
|
|
2972
3496
|
universe_id: {},
|
|
@@ -2992,8 +3516,21 @@ exports.getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecution
|
|
|
2992
3516
|
errors: [],
|
|
2993
3517
|
});
|
|
2994
3518
|
/**
|
|
2995
|
-
*
|
|
2996
|
-
*
|
|
3519
|
+
* `BETA`
|
|
3520
|
+
*
|
|
3521
|
+
* Get the subscription.
|
|
3522
|
+
|
|
3523
|
+
The `universe.subscription-product.subscription:read` scope only allows
|
|
3524
|
+
reading subscriptions of the user making the request. Because of this, the
|
|
3525
|
+
subscription ID must match the user ID of the user making the request. Note
|
|
3526
|
+
that this scope might be more relevant for OAuth 2.0 apps.
|
|
3527
|
+
|
|
3528
|
+
To read all subscriptions made by users for a particular universe, use the
|
|
3529
|
+
`universe:write` scope instead.
|
|
3530
|
+
*
|
|
3531
|
+
* **Scopes:** `universe:write`, `universe.subscription-product.subscription:read`
|
|
3532
|
+
* **Engine:** Not available in-engine
|
|
3533
|
+
*
|
|
2997
3534
|
* @param universe_id The universe ID.
|
|
2998
3535
|
* @param subscription_product_id The subscription-product ID.
|
|
2999
3536
|
* @param subscription_id The subscription ID.
|
|
@@ -3010,20 +3547,12 @@ Possible values:
|
|
|
3010
3547
|
| VIEW_UNSPECIFIED | The subscription view is not specified; the default will be used. |
|
|
3011
3548
|
| BASIC | Includes only the `active` and `renewing` fields. |
|
|
3012
3549
|
| FULL | Includes all fields. |
|
|
3013
|
-
* @description Get the subscription.
|
|
3014
|
-
|
|
3015
|
-
The `universe.subscription-product.subscription:read` scope only allows
|
|
3016
|
-
reading subscriptions of the user making the request. Because of this, the
|
|
3017
|
-
subscription ID must match the user ID of the user making the request. Note
|
|
3018
|
-
that this scope might be more relevant for OAuth 2.0 apps.
|
|
3019
|
-
|
|
3020
|
-
To read all subscriptions made by users for a particular universe, use the
|
|
3021
|
-
`universe:write` scope instead.
|
|
3022
3550
|
*/
|
|
3023
3551
|
exports.getCloudV2UniversesUniverseIdSubscriptionProductsSubscriptionProductIdSubscriptionsSubscriptionId = (0, __1.endpoint)({
|
|
3024
3552
|
method: 'GET',
|
|
3025
3553
|
path: '/cloud/v2/universes/:universe_id/subscription-products/:subscription_product_id/subscriptions/:subscription_id',
|
|
3026
3554
|
baseUrl: 'https://apis.roblox.com',
|
|
3555
|
+
scopes: ['universe:write', 'universe.subscription-product.subscription:read'],
|
|
3027
3556
|
requestFormat: 'json',
|
|
3028
3557
|
serializationMethod: {
|
|
3029
3558
|
universe_id: {},
|
|
@@ -3041,8 +3570,14 @@ exports.getCloudV2UniversesUniverseIdSubscriptionProductsSubscriptionProductIdSu
|
|
|
3041
3570
|
errors: [],
|
|
3042
3571
|
});
|
|
3043
3572
|
/**
|
|
3044
|
-
*
|
|
3045
|
-
*
|
|
3573
|
+
* `BETA`
|
|
3574
|
+
*
|
|
3575
|
+
* List user restrictions for users that have ever been banned in either a
|
|
3576
|
+
universe or a specific place.
|
|
3577
|
+
*
|
|
3578
|
+
* **Scopes:** `universe.user-restriction:read`
|
|
3579
|
+
* **Engine:** Not available in-engine
|
|
3580
|
+
*
|
|
3046
3581
|
* @param universe_id The universe ID.
|
|
3047
3582
|
* @param maxPageSize The maximum number of user restrictions to return. The service might return
|
|
3048
3583
|
fewer than this value. If unspecified, at most 10 user restrictions are
|
|
@@ -3051,13 +3586,12 @@ returned. The maximum value is 100 and higher values are set to 100.
|
|
|
3051
3586
|
|
|
3052
3587
|
When paginating, all other parameters provided to the subsequent call must
|
|
3053
3588
|
match the call that provided the page token.
|
|
3054
|
-
* @description List user restrictions for users that have ever been banned in either a
|
|
3055
|
-
universe or a specific place.
|
|
3056
3589
|
*/
|
|
3057
3590
|
exports.getCloudV2UniversesUniverseIdUserRestrictions = (0, __1.endpoint)({
|
|
3058
3591
|
method: 'GET',
|
|
3059
3592
|
path: '/cloud/v2/universes/:universe_id/user-restrictions',
|
|
3060
3593
|
baseUrl: 'https://apis.roblox.com',
|
|
3594
|
+
scopes: ['universe.user-restriction:read'],
|
|
3061
3595
|
requestFormat: 'json',
|
|
3062
3596
|
serializationMethod: {
|
|
3063
3597
|
universe_id: {},
|
|
@@ -3073,8 +3607,16 @@ exports.getCloudV2UniversesUniverseIdUserRestrictions = (0, __1.endpoint)({
|
|
|
3073
3607
|
errors: [],
|
|
3074
3608
|
});
|
|
3075
3609
|
/**
|
|
3076
|
-
*
|
|
3077
|
-
*
|
|
3610
|
+
* `BETA`
|
|
3611
|
+
*
|
|
3612
|
+
* List changes to UserRestriction resources within a given universe.
|
|
3613
|
+
This includes both universe-level and place-level restrictions.
|
|
3614
|
+
|
|
3615
|
+
For universe-level restriction logs, the `place` field will be empty.
|
|
3616
|
+
*
|
|
3617
|
+
* **Scopes:** `universe.user-restriction:read`
|
|
3618
|
+
* **Engine:** Not available in-engine
|
|
3619
|
+
*
|
|
3078
3620
|
* @param universe_id The universe ID.
|
|
3079
3621
|
* @param maxPageSize The maximum number of UserRestrictionLogs to return. The service may return
|
|
3080
3622
|
fewer than this value. If unspecified, at most 10 UserRestrictionLogs are
|
|
@@ -3094,15 +3636,12 @@ The `filter` field supports a very small number of CEL:
|
|
|
3094
3636
|
|
|
3095
3637
|
As an example, filtering for a user and a place takes the form
|
|
3096
3638
|
`filter="user == 'users/123'" && "place == 'places/456'"`
|
|
3097
|
-
* @description List changes to UserRestriction resources within a given universe.
|
|
3098
|
-
This includes both universe-level and place-level restrictions.
|
|
3099
|
-
|
|
3100
|
-
For universe-level restriction logs, the `place` field will be empty.
|
|
3101
3639
|
*/
|
|
3102
3640
|
exports.getCloudV2UniversesUniverseIdUserRestrictionsListLogs = (0, __1.endpoint)({
|
|
3103
3641
|
method: 'GET',
|
|
3104
3642
|
path: '/cloud/v2/universes/:universe_id/user-restrictions:listLogs',
|
|
3105
3643
|
baseUrl: 'https://apis.roblox.com',
|
|
3644
|
+
scopes: ['universe.user-restriction:read'],
|
|
3106
3645
|
requestFormat: 'json',
|
|
3107
3646
|
serializationMethod: {
|
|
3108
3647
|
universe_id: {},
|
|
@@ -3120,16 +3659,21 @@ exports.getCloudV2UniversesUniverseIdUserRestrictionsListLogs = (0, __1.endpoint
|
|
|
3120
3659
|
errors: [],
|
|
3121
3660
|
});
|
|
3122
3661
|
/**
|
|
3123
|
-
*
|
|
3124
|
-
*
|
|
3662
|
+
* `BETA`
|
|
3663
|
+
*
|
|
3664
|
+
* Get the user restriction.
|
|
3665
|
+
*
|
|
3666
|
+
* **Scopes:** `universe.user-restriction:read`
|
|
3667
|
+
* **Engine:** Not available in-engine
|
|
3668
|
+
*
|
|
3125
3669
|
* @param universe_id The universe ID.
|
|
3126
3670
|
* @param user_restriction_id The user-restriction ID.
|
|
3127
|
-
* @description Get the user restriction.
|
|
3128
3671
|
*/
|
|
3129
3672
|
exports.getCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId = (0, __1.endpoint)({
|
|
3130
3673
|
method: 'GET',
|
|
3131
3674
|
path: '/cloud/v2/universes/:universe_id/user-restrictions/:user_restriction_id',
|
|
3132
3675
|
baseUrl: 'https://apis.roblox.com',
|
|
3676
|
+
scopes: ['universe.user-restriction:read'],
|
|
3133
3677
|
requestFormat: 'json',
|
|
3134
3678
|
serializationMethod: {
|
|
3135
3679
|
universe_id: {},
|
|
@@ -3143,8 +3687,13 @@ exports.getCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId = (0, __1
|
|
|
3143
3687
|
errors: [],
|
|
3144
3688
|
});
|
|
3145
3689
|
/**
|
|
3146
|
-
*
|
|
3147
|
-
*
|
|
3690
|
+
* `BETA`
|
|
3691
|
+
*
|
|
3692
|
+
* Update the user restriction.
|
|
3693
|
+
*
|
|
3694
|
+
* **Scopes:** `universe.user-restriction:write`
|
|
3695
|
+
* **Engine:** Not available in-engine
|
|
3696
|
+
*
|
|
3148
3697
|
* @param body
|
|
3149
3698
|
* @param universe_id The universe ID.
|
|
3150
3699
|
* @param user_restriction_id The user-restriction ID.
|
|
@@ -3159,12 +3708,12 @@ that index into `game_join_restriction` (such as
|
|
|
3159
3708
|
If this is further in the past than the lifetime of the idempotency key
|
|
3160
3709
|
(which *may* exceed the annotated minimum lifetime), the server *must*
|
|
3161
3710
|
return an error.
|
|
3162
|
-
* @description Update the user restriction.
|
|
3163
3711
|
*/
|
|
3164
3712
|
exports.patchCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId = (0, __1.endpoint)({
|
|
3165
3713
|
method: 'PATCH',
|
|
3166
3714
|
path: '/cloud/v2/universes/:universe_id/user-restrictions/:user_restriction_id',
|
|
3167
3715
|
baseUrl: 'https://apis.roblox.com',
|
|
3716
|
+
scopes: ['universe.user-restriction:write'],
|
|
3168
3717
|
requestFormat: 'json',
|
|
3169
3718
|
serializationMethod: {
|
|
3170
3719
|
body: {},
|
|
@@ -3186,10 +3735,9 @@ exports.patchCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId = (0, _
|
|
|
3186
3735
|
errors: [],
|
|
3187
3736
|
});
|
|
3188
3737
|
/**
|
|
3189
|
-
*
|
|
3190
|
-
*
|
|
3191
|
-
*
|
|
3192
|
-
* @description Gets a user's basic and advanced information.
|
|
3738
|
+
* `BETA`
|
|
3739
|
+
*
|
|
3740
|
+
* Gets a user's basic and advanced information.
|
|
3193
3741
|
|
|
3194
3742
|
To access a user's public information, no additional scopes are required.
|
|
3195
3743
|
|
|
@@ -3199,11 +3747,17 @@ To access a user's verification status, you need the following scopes:
|
|
|
3199
3747
|
To access a user's social account information, you need the following
|
|
3200
3748
|
scopes:
|
|
3201
3749
|
* user.social:read
|
|
3750
|
+
*
|
|
3751
|
+
* **Scopes:** `user.advanced:read`, `user.social:read`
|
|
3752
|
+
* **Engine:** Not available in-engine
|
|
3753
|
+
*
|
|
3754
|
+
* @param user_id The user ID.
|
|
3202
3755
|
*/
|
|
3203
3756
|
exports.getCloudV2UsersUserId = (0, __1.endpoint)({
|
|
3204
3757
|
method: 'GET',
|
|
3205
3758
|
path: '/cloud/v2/users/:user_id',
|
|
3206
3759
|
baseUrl: 'https://apis.roblox.com',
|
|
3760
|
+
scopes: ['user.advanced:read', 'user.social:read'],
|
|
3207
3761
|
requestFormat: 'json',
|
|
3208
3762
|
serializationMethod: {
|
|
3209
3763
|
user_id: {},
|
|
@@ -3215,8 +3769,12 @@ exports.getCloudV2UsersUserId = (0, __1.endpoint)({
|
|
|
3215
3769
|
errors: [],
|
|
3216
3770
|
});
|
|
3217
3771
|
/**
|
|
3218
|
-
*
|
|
3219
|
-
*
|
|
3772
|
+
* `BETA`
|
|
3773
|
+
*
|
|
3774
|
+
* Generates and returns the URL for the user's avatar thumbnail.
|
|
3775
|
+
*
|
|
3776
|
+
* **Engine:** Not available in-engine
|
|
3777
|
+
*
|
|
3220
3778
|
* @param user_id The user ID.
|
|
3221
3779
|
* @param size Size of the generated thumbnail. The generated thumbnail will have `size *
|
|
3222
3780
|
size` dimension.
|
|
@@ -3242,7 +3800,6 @@ Possible values:
|
|
|
3242
3800
|
| SHAPE_UNSPECIFIED | Default UserThumbnail Shape -- set to round |
|
|
3243
3801
|
| ROUND | Generate thumbnail as a circle. |
|
|
3244
3802
|
| SQUARE | Generate thumbnail as a rectangle. |
|
|
3245
|
-
* @description Generates and returns the URL for the user's avatar thumbnail.
|
|
3246
3803
|
*/
|
|
3247
3804
|
exports.getCloudV2UsersUserIdGenerateThumbnail = (0, __1.endpoint)({
|
|
3248
3805
|
method: 'GET',
|
|
@@ -3265,8 +3822,13 @@ exports.getCloudV2UsersUserIdGenerateThumbnail = (0, __1.endpoint)({
|
|
|
3265
3822
|
errors: [],
|
|
3266
3823
|
});
|
|
3267
3824
|
/**
|
|
3268
|
-
*
|
|
3269
|
-
*
|
|
3825
|
+
* `BETA`
|
|
3826
|
+
*
|
|
3827
|
+
* Returns a list of asset quotas.
|
|
3828
|
+
*
|
|
3829
|
+
* **Scopes:** `asset:read`
|
|
3830
|
+
* **Engine:** Not available in-engine
|
|
3831
|
+
*
|
|
3270
3832
|
* @param user_id The user ID.
|
|
3271
3833
|
* @param maxPageSize The maximum number of asset quotas to return. The service might return
|
|
3272
3834
|
fewer than this value. If unspecified, at most 10 asset quotas are
|
|
@@ -3283,12 +3845,12 @@ Supports the following subset of CEL:
|
|
|
3283
3845
|
|
|
3284
3846
|
For example:
|
|
3285
3847
|
`quotaType == RateLimitUpload && assetType == Audio`
|
|
3286
|
-
* @description Returns a list of asset quotas.
|
|
3287
3848
|
*/
|
|
3288
3849
|
exports.getCloudV2UsersUserIdAssetQuotas = (0, __1.endpoint)({
|
|
3289
3850
|
method: 'GET',
|
|
3290
3851
|
path: '/cloud/v2/users/:user_id/asset-quotas',
|
|
3291
3852
|
baseUrl: 'https://apis.roblox.com',
|
|
3853
|
+
scopes: ['asset:read'],
|
|
3292
3854
|
requestFormat: 'json',
|
|
3293
3855
|
serializationMethod: {
|
|
3294
3856
|
user_id: {},
|
|
@@ -3306,22 +3868,9 @@ exports.getCloudV2UsersUserIdAssetQuotas = (0, __1.endpoint)({
|
|
|
3306
3868
|
errors: [],
|
|
3307
3869
|
});
|
|
3308
3870
|
/**
|
|
3309
|
-
*
|
|
3310
|
-
*
|
|
3311
|
-
*
|
|
3312
|
-
* @param maxPageSize The maximum number of inventory items to return. The service might return
|
|
3313
|
-
fewer than this value. If unspecified, at most 10 inventory items are
|
|
3314
|
-
returned. The maximum value is 100 and higher values are set to 100.
|
|
3315
|
-
* @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
|
|
3316
|
-
|
|
3317
|
-
When paginating, all other parameters provided to the subsequent call must
|
|
3318
|
-
match the call that provided the page token.
|
|
3319
|
-
* @param filter This field may be set in order to filter the resources returned.
|
|
3320
|
-
|
|
3321
|
-
See the
|
|
3322
|
-
[filtering](/cloud/reference/patterns#list-inventory-items)
|
|
3323
|
-
documentation for more information.
|
|
3324
|
-
* @description List the inventory items in a user's inventory.
|
|
3871
|
+
* `BETA`
|
|
3872
|
+
*
|
|
3873
|
+
* List the inventory items in a user's inventory.
|
|
3325
3874
|
|
|
3326
3875
|
The inventory items returned depend on the target user’s choice under
|
|
3327
3876
|
**Settings > Privacy > Who can see my inventory?**:
|
|
@@ -3339,11 +3888,29 @@ Rate Limits:
|
|
|
3339
3888
|
* API Keys - 100 requests/minute per API key owner (can be user or group).
|
|
3340
3889
|
Rate limits are enforced across all of an owner's API keys.
|
|
3341
3890
|
* OAuth2 Tokens - 20 requests/minute per OAuth2 access token
|
|
3891
|
+
*
|
|
3892
|
+
* **Scopes:** `user.inventory-item:read`
|
|
3893
|
+
* **Engine:** Usable with HttpService
|
|
3894
|
+
*
|
|
3895
|
+
* @param user_id The user ID.
|
|
3896
|
+
* @param maxPageSize The maximum number of inventory items to return. The service might return
|
|
3897
|
+
fewer than this value. If unspecified, at most 10 inventory items are
|
|
3898
|
+
returned. The maximum value is 100 and higher values are set to 100.
|
|
3899
|
+
* @param pageToken A page token, received from a previous call, to retrieve a subsequent page.
|
|
3900
|
+
|
|
3901
|
+
When paginating, all other parameters provided to the subsequent call must
|
|
3902
|
+
match the call that provided the page token.
|
|
3903
|
+
* @param filter This field may be set in order to filter the resources returned.
|
|
3904
|
+
|
|
3905
|
+
See the
|
|
3906
|
+
[filtering](/cloud/reference/patterns#list-inventory-items)
|
|
3907
|
+
documentation for more information.
|
|
3342
3908
|
*/
|
|
3343
3909
|
exports.getCloudV2UsersUserIdInventoryItems = (0, __1.endpoint)({
|
|
3344
3910
|
method: 'GET',
|
|
3345
3911
|
path: '/cloud/v2/users/:user_id/inventory-items',
|
|
3346
3912
|
baseUrl: 'https://apis.roblox.com',
|
|
3913
|
+
scopes: ['user.inventory-item:read'],
|
|
3347
3914
|
requestFormat: 'json',
|
|
3348
3915
|
serializationMethod: {
|
|
3349
3916
|
user_id: {},
|
|
@@ -3361,16 +3928,21 @@ exports.getCloudV2UsersUserIdInventoryItems = (0, __1.endpoint)({
|
|
|
3361
3928
|
errors: [],
|
|
3362
3929
|
});
|
|
3363
3930
|
/**
|
|
3364
|
-
*
|
|
3365
|
-
*
|
|
3931
|
+
* `STABLE`
|
|
3932
|
+
*
|
|
3933
|
+
* Sends a notification to a user.
|
|
3934
|
+
*
|
|
3935
|
+
* **Scopes:** `user.user-notification:write`
|
|
3936
|
+
* **Engine:** Not available in-engine
|
|
3937
|
+
*
|
|
3366
3938
|
* @param body
|
|
3367
3939
|
* @param user_id The user ID.
|
|
3368
|
-
* @description Sends a notification to a user.
|
|
3369
3940
|
*/
|
|
3370
3941
|
exports.postCloudV2UsersUserIdNotifications = (0, __1.endpoint)({
|
|
3371
3942
|
method: 'POST',
|
|
3372
3943
|
path: '/cloud/v2/users/:user_id/notifications',
|
|
3373
3944
|
baseUrl: 'https://apis.roblox.com',
|
|
3945
|
+
scopes: ['user.user-notification:write'],
|
|
3374
3946
|
requestFormat: 'json',
|
|
3375
3947
|
serializationMethod: {
|
|
3376
3948
|
body: {},
|