/** * `BETA` * * Add a Creator Store product. Only use this method if your product has never been distributed on the Creator Store; otherwise, use the `PATCH` method to update the product. * * **Scopes:** `creator-store-product:write` * **Engine:** Not available in-engine * * @param body */ export declare const postCloudV2CreatorStoreProducts: import("../..").EndpointGeneric<{}, { path: string; basePrice: { currencyCode: string; quantity: { significand: number; exponent: number; }; }; purchasePrice: { currencyCode: string; quantity: { significand: number; exponent: number; }; }; published: boolean; restrictions: ("RESTRICTION_UNSPECIFIED" | "SOLD_ITEM_RESTRICTED" | "SELLER_TEMPORARILY_RESTRICTED" | "SELLER_PERMANENTLY_RESTRICTED" | "SELLER_NO_LONGER_ACTIVE")[]; purchasable: boolean; userSeller: string; groupSeller: string; modelAssetId: string; pluginAssetId: string; audioAssetId: string; decalAssetId: string; meshPartAssetId: string; videoAssetId: string; fontFamilyAssetId: string; }, { path: string; basePrice: { currencyCode: string; quantity: { significand: number; exponent: number; }; }; purchasePrice: { currencyCode: string; quantity: { significand: number; exponent: number; }; }; published: boolean; restrictions: ("RESTRICTION_UNSPECIFIED" | "SOLD_ITEM_RESTRICTED" | "SELLER_TEMPORARILY_RESTRICTED" | "SELLER_PERMANENTLY_RESTRICTED" | "SELLER_NO_LONGER_ACTIVE")[]; purchasable: boolean; userSeller: string; groupSeller: string; modelAssetId: string; pluginAssetId: string; audioAssetId: string; decalAssetId: string; meshPartAssetId: string; videoAssetId: string; fontFamilyAssetId: string; }>; /** * `BETA` * * Get a Creator Store product. * * **Scopes:** `creator-store-product:read` * **Engine:** Not available in-engine * * @param creator_store_product_id The creator-store-product ID. */ export declare const getCloudV2CreatorStoreProductsCreatorStoreProductId: import("../..").EndpointGeneric<{ creator_store_product_id: string; }, { path: string; basePrice: { currencyCode: string; quantity: { significand: number; exponent: number; }; }; purchasePrice: { currencyCode: string; quantity: { significand: number; exponent: number; }; }; published: boolean; restrictions: ("RESTRICTION_UNSPECIFIED" | "SOLD_ITEM_RESTRICTED" | "SELLER_TEMPORARILY_RESTRICTED" | "SELLER_PERMANENTLY_RESTRICTED" | "SELLER_NO_LONGER_ACTIVE")[]; purchasable: boolean; userSeller: string; groupSeller: string; modelAssetId: string; pluginAssetId: string; audioAssetId: string; decalAssetId: string; meshPartAssetId: string; videoAssetId: string; fontFamilyAssetId: string; }, undefined>; /** * `BETA` * * Update a Creator Store product. * * **Scopes:** `creator-store-product:write` * **Engine:** Not available in-engine * * @param body * @param creator_store_product_id The creator-store-product ID. * @param updateMask The list of fields to update. * @param allowMissing If set to true, and the creator store product is not found, a creator store product is created. In this situation, `update_mask` is ignored. */ export declare const patchCloudV2CreatorStoreProductsCreatorStoreProductId: import("../..").EndpointGeneric<{ creator_store_product_id: string; updateMask?: string | undefined; allowMissing?: boolean | undefined; }, { path: string; basePrice: { currencyCode: string; quantity: { significand: number; exponent: number; }; }; purchasePrice: { currencyCode: string; quantity: { significand: number; exponent: number; }; }; published: boolean; restrictions: ("RESTRICTION_UNSPECIFIED" | "SOLD_ITEM_RESTRICTED" | "SELLER_TEMPORARILY_RESTRICTED" | "SELLER_PERMANENTLY_RESTRICTED" | "SELLER_NO_LONGER_ACTIVE")[]; purchasable: boolean; userSeller: string; groupSeller: string; modelAssetId: string; pluginAssetId: string; audioAssetId: string; decalAssetId: string; meshPartAssetId: string; videoAssetId: string; fontFamilyAssetId: string; }, { path?: string | undefined; basePrice?: { currencyCode: string; quantity: { significand: number; exponent: number; }; } | undefined; purchasePrice?: { currencyCode: string; quantity: { significand: number; exponent: number; }; } | undefined; published?: boolean | undefined; restrictions?: ("RESTRICTION_UNSPECIFIED" | "SOLD_ITEM_RESTRICTED" | "SELLER_TEMPORARILY_RESTRICTED" | "SELLER_PERMANENTLY_RESTRICTED" | "SELLER_NO_LONGER_ACTIVE")[] | undefined; purchasable?: boolean | undefined; userSeller?: string | undefined; groupSeller?: string | undefined; modelAssetId?: string | undefined; pluginAssetId?: string | undefined; audioAssetId?: string | undefined; decalAssetId?: string | undefined; meshPartAssetId?: string | undefined; videoAssetId?: string | undefined; fontFamilyAssetId?: string | undefined; }>; /** * `BETA` * * Gets the specified group. * * **Engine:** Usable with HttpService * * @param group_id The group ID. */ export declare const getCloudV2GroupsGroupId: import("../..").EndpointGeneric<{ group_id: string; }, { path: string; createTime: string; updateTime: string; id: string; displayName: string; description: string; owner: string; memberCount: number; publicEntryAllowed: boolean; locked: boolean; verified: boolean; }, undefined>; /** * `BETA` * * Lists forum categories in the group. * * **Scopes:** `group-forum:read` * **Engine:** Usable with HttpService * * @param group_id The group ID. * @param maxPageSize The maximum number of group forum categories to return. The service might return fewer than this value. If unspecified, at most 10 group forum categories are returned. The maximum value is 10 and higher values are set to 10. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter This field may be set in order to filter the resources returned. Filtering conforms to Common Expression Language (CEL). Only the boolean field `archived` and `==` operator are supported. If `archived=false`, archived categories are not returned. The default value is `false`. Example: `"filter=archived==true"` */ export declare const getCloudV2GroupsGroupIdForumCategories: import("../..").EndpointGeneric<{ group_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { groupForumCategories: { path: string; createTime: string; updateTime: string; groupForumCategoryId: string; displayName: string; creator: string; archiveTime: string; archiver: string; }[]; nextPageToken: string; }, undefined>; /** * `BETA` * * Lists forum posts in the group's forum category. * * **Scopes:** `group-forum:read` * **Engine:** Usable with HttpService * * @param group_id The group ID. * @param forum_category_id The forum-category ID. * @param maxPageSize The maximum number of group forum posts to return. The service might return fewer than this value. If unspecified, at most 10 group forum posts are returned. The maximum value is 100 and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter This field may be set in order to filter the resources returned. Filtering conforms to Common Expression Language (CEL). Only the query `filter=pinned==true` is supported, where only pinned posts are returned. `filter=pinned==false`is not supported. * @param view The view in which to retrieve the group forum post. Supports FULL and FULL_WITH_FIRST_COMMENT. Defaults to FULL. Possible values: | Value | Description | | --- | --- | | VIEW_UNSPECIFIED | The group forum post view is not specified; the default will be used. | | FULL | Includes all fields but does not dereference `first_comment`. Only the `path` field is populated. | | FULL_WITH_FIRST_COMMENT | Includes all fields and also fully populates `first_comment`. The default view. | */ export declare const getCloudV2GroupsGroupIdForumCategoriesForumCategoryIdPosts: import("../..").EndpointGeneric<{ group_id: string; forum_category_id: string; filter?: string | undefined; view?: "VIEW_UNSPECIFIED" | "FULL" | "FULL_WITH_FIRST_COMMENT" | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { groupForumPosts: { path: string; createTime: string; updateTime: string; pinned: boolean; locked: boolean; groupForumPostId: string; title: string; firstComment: { path: string; groupForumCommentId: string; message: { createTime: string; updateTime: string; plainText: string; author: string; messageReaction: { emoteId: string; count: number; }[]; }; }; author: string; archiveTime: string; archiver: string; commentCount: number; }[]; nextPageToken: string; }, undefined>; /** * `BETA` * * Lists forum comments on a group's forum post. * * **Scopes:** `group-forum:read` * **Engine:** Usable with HttpService * * @param group_id The group ID. * @param forum_category_id The forum-category ID. * @param post_id The post ID. * @param maxPageSize The maximum number of group forum comments to return. The service might return fewer than this value. If unspecified, at most 10 group forum comments are returned. The maximum value is 100 and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter This field may be set in order to filter the resources returned. Filtering conforms to Common Expression Language (CEL). Only the string field `repliesToCommentId` and the `==` operator are supported. If `repliesToCommentId` is specified, only comments that respond to the comment are returned. The default value is `''`. If `repliesToCommentId=''`, only comments responding directly to the post are returned. Example: `"filter=repliesToCommentId==01234567-89ab-cdef-0123-456789abcdef"` */ export declare const getCloudV2GroupsGroupIdForumCategoriesForumCategoryIdPostsPostIdComments: import("../..").EndpointGeneric<{ group_id: string; forum_category_id: string; post_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { groupForumComments: { path: string; groupForumCommentId: string; message: { createTime: string; updateTime: string; plainText: string; author: string; messageReaction: { emoteId: string; count: number; }[]; }; }[]; nextPageToken: string; }, undefined>; /** * `BETA` * * List join requests under a group. * * **Scopes:** `group:read` * **Engine:** Usable with HttpService * * @param group_id The group ID. * @param maxPageSize The maximum number of group join requests to return. The service might return fewer than this value. If unspecified, at most 10 group join requests are returned. The maximum value is 20 and higher values are set to 20. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter This field may be set in order to filter the resources returned. Filtering conforms to Common Expression Language (CEL). Only the `user` field and `==` operator are supported. Example: `"user == 'users/156'"` */ export declare const getCloudV2GroupsGroupIdJoinRequests: import("../..").EndpointGeneric<{ group_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { groupJoinRequests: { path: string; createTime: string; user: string; }[]; nextPageToken: string; }, undefined>; /** * `BETA` * * Accepts a join request. * * **Scopes:** `group:write` * **Engine:** Usable with HttpService * * @param body * @param group_id The group ID. * @param join_request_id The join-request ID. */ export declare const postCloudV2GroupsGroupIdJoinRequestsJoinRequestIdAccept: import("../..").EndpointGeneric<{ group_id: string; join_request_id: string; }, void, Record>; /** * `BETA` * * Declines a join request. * * **Scopes:** `group:write` * **Engine:** Usable with HttpService * * @param body * @param group_id The group ID. * @param join_request_id The join-request ID. */ export declare const postCloudV2GroupsGroupIdJoinRequestsJoinRequestIdDecline: import("../..").EndpointGeneric<{ group_id: string; join_request_id: string; }, void, Record>; /** * `BETA` * * List group members in a group. * * **Engine:** Usable with HttpService * * @param group_id The group ID. * @param maxPageSize The maximum number of group memberships to return. The service might return fewer than this value. If unspecified, at most 10 group memberships are returned. The maximum value is 100 and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter This field may be set in order to filter the resources returned. See the [filtering](/cloud/reference/patterns#list-group-memberships) documentation for more information. */ export declare const getCloudV2GroupsGroupIdMemberships: import("../..").EndpointGeneric<{ group_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { groupMemberships: { path: string; createTime: string; updateTime: string; user: string; role: string; roles: string[]; }[]; nextPageToken: string; }, undefined>; /** * `BETA` * * **Deprecated.** Use AssignGroupRole and UnassignGroupRole instead. Updates the group membership for a particular group member. This action requires the requester to be able to manage lower ranked members. Guest or Owner ranks cannot be assigned, and a requester cannot change their own rank. * * **Scopes:** `group:write` * **Engine:** Usable with HttpService * * @param body * @param group_id The group ID. * @param membership_id The membership ID. */ export declare const patchCloudV2GroupsGroupIdMembershipsMembershipId: import("../..").EndpointGeneric<{ group_id: string; membership_id: string; }, { path: string; createTime: string; updateTime: string; user: string; role: string; roles: string[]; }, { path?: string | undefined; createTime?: string | undefined; updateTime?: string | undefined; user?: string | undefined; role?: string | undefined; roles?: string[] | undefined; }>; /** * `BETA` * * Assigns a specific role to a user within a group. If the user already holds the specified role, no action is taken. * * **Scopes:** `group:write` * **Engine:** Usable with HttpService * * @param body * @param group_id The group ID. * @param membership_id The membership ID. */ export declare const postCloudV2GroupsGroupIdMembershipsMembershipIdAssignRole: import("../..").EndpointGeneric<{ group_id: string; membership_id: string; }, { path: string; createTime: string; updateTime: string; user: string; role: string; roles: string[]; }, { role: string; }>; /** * `BETA` * * Unassigns a specific role from a user within a group. If the user does not hold the specified role, no action is taken. * * **Scopes:** `group:write` * **Engine:** Usable with HttpService * * @param body * @param group_id The group ID. * @param membership_id The membership ID. */ export declare const postCloudV2GroupsGroupIdMembershipsMembershipIdUnassignRole: import("../..").EndpointGeneric<{ group_id: string; membership_id: string; }, { path: string; createTime: string; updateTime: string; user: string; role: string; roles: string[]; }, { role: string; }>; /** * `BETA` * * List roles in a group. The permissions field for roles is viewable based on the requester's access and scopes. Permissions for the guest role are always visible - a scope is not needed. If the requester is a member of the group and has the `group:read` scope, permissions in their role are visible. If the requester is the owner of the group and has the `group:read` scope, permissions in all roles are visible. * * **Scopes:** `group:read` * **Engine:** Usable with HttpService * * @param group_id The group ID. * @param maxPageSize The maximum number of group roles to return. The service might return fewer than this value. If unspecified, at most 10 group roles are returned. The maximum value is 20 and higher values are set to 20. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. */ export declare const getCloudV2GroupsGroupIdRoles: import("../..").EndpointGeneric<{ group_id: string; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { groupRoles: { path: string; createTime: string; updateTime: string; id: string; displayName: string; description: string; rank: number; memberCount: number; permissions: { viewWallPosts: boolean; createWallPosts: boolean; deleteWallPosts: boolean; viewGroupShout: boolean; createGroupShout: boolean; changeRank: boolean; acceptRequests: boolean; exileMembers: boolean; manageRelationships: boolean; viewAuditLog: boolean; spendGroupFunds: boolean; advertiseGroup: boolean; createAvatarItems: boolean; manageAvatarItems: boolean; manageGroupUniverses: boolean; viewUniverseAnalytics: boolean; createApiKeys: boolean; manageApiKeys: boolean; banMembers: boolean; viewForums: boolean; manageCategories: boolean; createPosts: boolean; lockPosts: boolean; pinPosts: boolean; removePosts: boolean; createComments: boolean; removeComments: boolean; manageBlockedWords: boolean; viewBlockedWords: boolean; bypassSlowMode: boolean; }; }[]; nextPageToken: string; }, undefined>; /** * `BETA` * * Get the group role * * **Scopes:** `group:read` * **Engine:** Usable with HttpService * * @param group_id The group ID. * @param role_id The role ID. */ export declare const getCloudV2GroupsGroupIdRolesRoleId: import("../..").EndpointGeneric<{ group_id: string; role_id: string; }, { path: string; createTime: string; updateTime: string; id: string; displayName: string; description: string; rank: number; memberCount: number; permissions: { viewWallPosts: boolean; createWallPosts: boolean; deleteWallPosts: boolean; viewGroupShout: boolean; createGroupShout: boolean; changeRank: boolean; acceptRequests: boolean; exileMembers: boolean; manageRelationships: boolean; viewAuditLog: boolean; spendGroupFunds: boolean; advertiseGroup: boolean; createAvatarItems: boolean; manageAvatarItems: boolean; manageGroupUniverses: boolean; viewUniverseAnalytics: boolean; createApiKeys: boolean; manageApiKeys: boolean; banMembers: boolean; viewForums: boolean; manageCategories: boolean; createPosts: boolean; lockPosts: boolean; pinPosts: boolean; removePosts: boolean; createComments: boolean; removeComments: boolean; manageBlockedWords: boolean; viewBlockedWords: boolean; bypassSlowMode: boolean; }; }, undefined>; /** * `STABLE` * * Gets the specified universe. * * **Engine:** Not available in-engine * * @param universe_id The universe ID. */ export declare const getCloudV2UniversesUniverseId: import("../..").EndpointGeneric<{ universe_id: string; }, { templateRootPlace: string; path?: string | undefined; createTime?: string | undefined; updateTime?: string | undefined; displayName?: string | undefined; description?: string | undefined; user?: string | undefined; group?: string | undefined; visibility?: "VISIBILITY_UNSPECIFIED" | "PUBLIC" | "PRIVATE" | undefined; facebookSocialLink?: { title: string; uri: string; } | undefined; twitterSocialLink?: { title: string; uri: string; } | undefined; youtubeSocialLink?: { title: string; uri: string; } | undefined; twitchSocialLink?: { title: string; uri: string; } | undefined; discordSocialLink?: { title: string; uri: string; } | undefined; robloxGroupSocialLink?: { title: string; uri: string; } | undefined; guildedSocialLink?: { title: string; uri: string; } | undefined; voiceChatEnabled?: boolean | undefined; ageRating?: "AGE_RATING_UNSPECIFIED" | "AGE_RATING_ALL" | "AGE_RATING_9_PLUS" | "AGE_RATING_13_PLUS" | "AGE_RATING_17_PLUS" | undefined; privateServerPriceRobux?: number | undefined; desktopEnabled?: boolean | undefined; mobileEnabled?: boolean | undefined; tabletEnabled?: boolean | undefined; consoleEnabled?: boolean | undefined; vrEnabled?: boolean | undefined; rootPlace?: string | undefined; }, undefined>; /** * `STABLE` * * Updates the specified universe. This method is guaranteed to return all updated fields. This method may additionally return the full resource. * * **Scopes:** `universe:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param updateMask The list of fields to update. */ export declare const patchCloudV2UniversesUniverseId: import("../..").EndpointGeneric<{ universe_id: string; updateMask?: string | undefined; }, { templateRootPlace: string; path?: string | undefined; createTime?: string | undefined; updateTime?: string | undefined; displayName?: string | undefined; description?: string | undefined; user?: string | undefined; group?: string | undefined; visibility?: "VISIBILITY_UNSPECIFIED" | "PUBLIC" | "PRIVATE" | undefined; facebookSocialLink?: { title: string; uri: string; } | undefined; twitterSocialLink?: { title: string; uri: string; } | undefined; youtubeSocialLink?: { title: string; uri: string; } | undefined; twitchSocialLink?: { title: string; uri: string; } | undefined; discordSocialLink?: { title: string; uri: string; } | undefined; robloxGroupSocialLink?: { title: string; uri: string; } | undefined; guildedSocialLink?: { title: string; uri: string; } | undefined; voiceChatEnabled?: boolean | undefined; ageRating?: "AGE_RATING_UNSPECIFIED" | "AGE_RATING_ALL" | "AGE_RATING_9_PLUS" | "AGE_RATING_13_PLUS" | "AGE_RATING_17_PLUS" | undefined; privateServerPriceRobux?: number | undefined; desktopEnabled?: boolean | undefined; mobileEnabled?: boolean | undefined; tabletEnabled?: boolean | undefined; consoleEnabled?: boolean | undefined; vrEnabled?: boolean | undefined; rootPlace?: string | undefined; }, { path?: string | undefined; createTime?: string | undefined; updateTime?: string | undefined; displayName?: string | undefined; description?: string | undefined; user?: string | undefined; group?: string | undefined; visibility?: "VISIBILITY_UNSPECIFIED" | "PUBLIC" | "PRIVATE" | undefined; facebookSocialLink?: { title: string; uri: string; } | undefined; twitterSocialLink?: { title: string; uri: string; } | undefined; youtubeSocialLink?: { title: string; uri: string; } | undefined; twitchSocialLink?: { title: string; uri: string; } | undefined; discordSocialLink?: { title: string; uri: string; } | undefined; robloxGroupSocialLink?: { title: string; uri: string; } | undefined; guildedSocialLink?: { title: string; uri: string; } | undefined; voiceChatEnabled?: boolean | undefined; ageRating?: "AGE_RATING_UNSPECIFIED" | "AGE_RATING_ALL" | "AGE_RATING_9_PLUS" | "AGE_RATING_13_PLUS" | "AGE_RATING_17_PLUS" | undefined; privateServerPriceRobux?: number | undefined; desktopEnabled?: boolean | undefined; mobileEnabled?: boolean | undefined; tabletEnabled?: boolean | undefined; consoleEnabled?: boolean | undefined; vrEnabled?: boolean | undefined; rootPlace?: string | undefined; templateRootPlace?: string | undefined; }>; /** * `BETA` * * Generates an English speech audio asset from the specified text. This endpoint requires the `asset:read` and `asset:write` scopes in addition to the `universe:write` scope. The response returns an `Operation` object that must be prefixed with `/assets/v1`. For example, the URL to discover the result of the operation could be `https://apis.roblox.com/assets/v1/operations/8b42ef30-9c17-4526-b8cf-2ff0136ca94d`. * * **Scopes:** `universe:write`, `asset:read`, `asset:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. */ export declare const postCloudV2UniversesUniverseIdGenerateSpeechAsset: import("../..").EndpointGeneric<{ universe_id: string; }, { path: string; metadata: { '@type': string; }; done: boolean; error: { code: number; message: string; details: { '@type': string; }[]; }; response: { '@type': string; }; }, { text: string; speechStyle?: { voiceId: string; pitch: number; speed: number; } | undefined; }>; /** * `STABLE` * * Publishes a message to the universe's live servers. Servers can consume messages via [MessagingService](https://create.roblox.com/docs/reference/engine/classes/MessagingService). * * **Scopes:** `universe-messaging-service:publish` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. */ export declare const postCloudV2UniversesUniverseIdPublishMessage: import("../..").EndpointGeneric<{ universe_id: string; }, void, { topic: string; message: string; }>; /** * `STABLE` * * Restarts active servers for a specific universe. Defaults to only restarting servers running older versions, but can be configured to restart all servers regardless of version. Used for releasing experience updates. * * **Scopes:** `universe:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. */ export declare const postCloudV2UniversesUniverseIdRestartServers: import("../..").EndpointGeneric<{ universe_id: string; }, Record, { placeIds: number[]; closeAllVersions: boolean; bleedOffServers: boolean; bleedOffDurationMinutes: number; }>; /** * `BETA` * * Translates the provided text from one language to another. * * **Scopes:** `universe:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. */ export declare const postCloudV2UniversesUniverseIdTranslateText: import("../..").EndpointGeneric<{ universe_id: string; }, { sourceLanguageCode: string; translations: string; }, { text: string; sourceLanguageCode?: string | undefined; targetLanguageCodes?: string[] | undefined; }>; /** * `STABLE` * * Returns a list of data stores. Data stores scheduled for permanent deletion are omitted from the results by default (or when `showDeleted` is set to `false`). When this is the case, the operation will check up to 512 data stores. If all checked data stores are deleted, it will return an empty list with a page token to continue iteration. * * **Scopes:** `universe-datastores.control:list` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param maxPageSize The maximum number of data stores to return. The service might return fewer than this value. If unspecified, at most 10 data stores are returned. The maximum value is 100 and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter This field may be set in order to filter the resources returned. The `filter` field supports a very small subset of CEL: * Only the `id` field is supported. * Only the `startsWith` function is available; no other operators nor built-ins are supported. Example filter: `id.startsWith("foo")` * @param showDeleted If true, resources marked for pending deletion will be included in the results. */ export declare const getCloudV2UniversesUniverseIdDataStores: import("../..").EndpointGeneric<{ universe_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; showDeleted?: boolean | undefined; }, { dataStores: { path: string; createTime: string; expireTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; id: string; }[]; nextPageToken: string; }, undefined>; /** * `STABLE` * * Takes a new snapshot of the data stores in an experience. After a snapshot, the next write to every key in the experience will create a versioned backup of the previous data, regardless of the time of the last write. In effect, all data current at the time of the snapshot is guaranteed to be available as a versioned backup for at least 30 days. Snapshots can be taken once per UTC day, per experience. If the latest snapshot was taken within the same UTC day, this operation is a no-op and the time of the latest snapshot will be returned. For more information on using snapshots, see the [Data stores](https://create.roblox.com/docs/cloud-services/data-stores#snapshots) Engine guide. * * **Scopes:** `universe-datastores.control:snapshot` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. */ export declare const postCloudV2UniversesUniverseIdDataStoresSnapshot: import("../..").EndpointGeneric<{ universe_id: string; }, { newSnapshotTaken: boolean; latestSnapshotTime: string; }, Record>; /** * `BETA` * * Schedules the specified data store for permanent deletion. This operation assigns the data store an expiry time 30 days in the future, at which point permanent deletion begins. To cancel, use the `UndeleteDataStore` operation before the data store's expiry time. Permanent deletion consists of deleting all of the entries in the data store and then the data store resource itself. The data store is no longer returned by the `ListDataStores` Open Cloud endpoint or `ListDataStoresAsync` Luau API, and you can reuse the data store's name. The duration of the permanent deletion process depends on the number of entries in the data store. However, you can expect a data store with 1 million or fewer entries to be permanently deleted within 3 days. Data stores scheduled for permanent deletion are returned by the `ListDataStores` Open Cloud endpoint when the query parameter `showDeleted` is set to `true`. In the return value, each data store will have a `DELETED` state and an `expireTime` field. Data stores scheduled for permanent deletion are immediately made inaccessible, meaning attempts to read or write to their entries will fail. Note: Due to caching in the backend service, attempts to read from or write to entries in these data stores can continue to succeed for a limited time after the deletion: * `GetDataStoreEntry`: can succeed for up to 24 hours. * All other endpoints: can succeed for several minutes. If the data store is already in a `DELETED` state, this operation is a no-op, and the data store is returned as-is. * * **Scopes:** `universe-datastores.control:delete` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param data_store_id The data-store ID. */ export declare const deleteCloudV2UniversesUniverseIdDataStoresDataStoreId: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; }, { path: string; createTime: string; expireTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; id: string; }, undefined>; /** * `BETA` * * Restore the data store * * **Scopes:** `universe-datastores.control:delete` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param data_store_id The data-store ID. */ export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdUndelete: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; }, { path: string; createTime: string; expireTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; id: string; }, Record>; /** * `STABLE` * * Returns a list of entries from a data store. Only the `path` and `id` fields are populated; use `GetDataStoreEntry` to retrieve other fields. Specify the wildcard scope (`-`) to list entries from all scopes. * * **Scopes:** `universe-datastores.objects:list` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param maxPageSize The maximum number of data store entries to return. The service might return fewer than this value. If unspecified, at most 10 data store entries are returned. The maximum value is 256 and higher values are set to 256. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter This field may be set in order to filter the resources returned. The `filter` field supports a very small subset of CEL: * Only the `id` field is supported. * Only the `startsWith` function is available; no other operators nor built-ins are supported. Example filter: `id.startsWith("foo")` * @param showDeleted If true, resources marked for pending deletion will be included in the results. */ export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; showDeleted?: boolean | undefined; }, { dataStoreEntries: { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }[]; nextPageToken: string; }, undefined>; /** * `STABLE` * * Creates an entry with the provided ID and value. Returns a 400 Bad Request if the entry exists. * * **Scopes:** `universe-datastores.objects:create` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param id The ID to use for the data store entry, which will become the final component of the data store entry's resource path. This value should be a 1-50 character string. We strongly recommend using only lowercase letters, numeric digits, and hyphens. */ export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; id?: string | undefined; }, { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }, { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }>; /** * `STABLE` * * Gets the specified entry. To get the entry at a specific revision, add `@` to the end of the path. For example, to get `my-entry` at the revision ID `08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01`, use the path `/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01`. If your entry ID contains one or more `@` characters, and you want to get the latest version rather than at any specific revision, append the special revision ID `@latest` to the end of the path. Otherwise, the segment of the entry ID after the last `@` will be interpreted as a revision ID. For example, to get the latest revision of `my-entry`, use the path `/cloud/v2/universes/1234/data-stores/5678/entries/my@entry@latest`. To get the entry that was current at a specific time, add `@latest:` to the end of the path, where `` is RFC-3339 formatted. The given timestamp must be after the Unix epoch (1/1/1970) and not more than ten minutes in the future. For example, to get the revision of `my-entry` that was current on 12/2/2024 at 06:00 UTC, use the path `/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z`. * * **Scopes:** `universe-datastores.objects:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param entry_id The entry ID. */ export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; entry_id: string; }, { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }, undefined>; /** * `STABLE` * * Marks the specified entry for deletion. Entries are not be deleted immediately; instead, the `state` field will be set to `DELETED`. Permanent deletion occurs after 30 days. On success, returns 200 OK. If the entry doesn't exist, returns 404 Not Found. * * **Scopes:** `universe-datastores.objects:delete` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param entry_id The entry ID. */ export declare const deleteCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; entry_id: string; }, void, undefined>; /** * `STABLE` * * Updates the value, attributes, and users of an entry. Updating specific revisions of the entry is **unsupported**. If you specify a revision ID in the path and `allow_missing` is `true`, the update request will instead create a new entry with the `@` suffix as part of the key. Partial update is **unsupported**. If attributes or users are not provided when updating the value, they will be cleared. Value must always be provided when updating an entry. * * **Scopes:** `universe-datastores.objects:update` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param entry_id The entry ID. * @param allowMissing If set to true, and the data store entry is not found, a data store entry is created. */ export declare const patchCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; entry_id: string; allowMissing?: boolean | undefined; }, { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }, { [x: string]: unknown; path?: string | undefined; createTime?: string | undefined; revisionId?: string | undefined; revisionCreateTime?: string | undefined; state?: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED" | undefined; etag?: string | undefined; value?: unknown; id?: string | undefined; users?: string[] | undefined; attributes?: Record | undefined; }>; /** * `STABLE` * * Increments the value of the specified entry. Both the existing value and the increment amount must be integers. If the entry doesn't exist, creates an entry with the specified value. Incrementing specific revisions of the entry is **unsupported**. If you specify a revision ID in the path, the increment request will create a new entry with the `@` suffix as part of the key. Known issue: the value may be incremented past the valid range of values. When this happens, the returned value will be clamped to the valid range, but the backend may persist the original value. This behavior is maintained for backwards compatibility reasons, but may change in a future version of this API. * * **Scopes:** `universe-datastores.objects:create`, `universe-datastores.objects:update` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param entry_id The entry ID. */ export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryIdIncrement: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; entry_id: string; }, { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }, { [x: string]: unknown; amount: number; users: string[]; attributes: Record; }>; /** * `STABLE` * * List revisions of the data store entry. This method returns partial data store entries. In particular, only the `path`, `id`, `createTime`, `revisionCreateTime`, `revisionId`, `etag`, and `state` fields are populated. Both the `path` and `id` fields will have an `@` suffix. In order to get the full entry at a revision, you can use the provided `path` field with the `GetDataStoreEntry` method, i.e. `GET /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@`. * * **Scopes:** `universe-datastores.versions:list` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param entry_id The entry ID. * @param maxPageSize The maximum number of revisions to return per page. The service might return fewer than the maximum number of revisions. If unspecified, at most 10 revisions are returned. The maximum value is 100 values and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter Supports the following subset of CEL: * Only the `&&`, `<=`, and `>=` operators are supported. * Only the `revision_create_time` field is supported. For example: `"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <= 2001-01-01T00:00:00Z"` */ export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryIdListRevisions: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; entry_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { dataStoreEntries: { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }[]; nextPageToken: string; }, undefined>; /** * `STABLE` * * Returns a list of entries from a data store. Only the `path` and `id` fields are populated; use `GetDataStoreEntry` to retrieve other fields. Specify the wildcard scope (`-`) to list entries from all scopes. * * **Scopes:** `universe-datastores.objects:list` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param scope_id The scope ID. * @param maxPageSize The maximum number of data store entries to return. The service might return fewer than this value. If unspecified, at most 10 data store entries are returned. The maximum value is 256 and higher values are set to 256. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter This field may be set in order to filter the resources returned. The `filter` field supports a very small subset of CEL: * Only the `id` field is supported. * Only the `startsWith` function is available; no other operators nor built-ins are supported. Example filter: `id.startsWith("foo")` * @param showDeleted If true, resources marked for pending deletion will be included in the results. */ export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntries: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; scope_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; showDeleted?: boolean | undefined; }, { dataStoreEntries: { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }[]; nextPageToken: string; }, undefined>; /** * `STABLE` * * Creates an entry with the provided ID and value. Returns a 400 Bad Request if the entry exists. * * **Scopes:** `universe-datastores.objects:create` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param scope_id The scope ID. * @param id The ID to use for the data store entry, which will become the final component of the data store entry's resource path. This value should be a 1-50 character string. We strongly recommend using only lowercase letters, numeric digits, and hyphens. */ export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntries: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; scope_id: string; id?: string | undefined; }, { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }, { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }>; /** * `STABLE` * * Gets the specified entry. To get the entry at a specific revision, add `@` to the end of the path. For example, to get `my-entry` at the revision ID `08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01`, use the path `/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@08DC3D3F43F9FCC1.0000000001.08DC3D3F43F9FCC1.01`. If your entry ID contains one or more `@` characters, and you want to get the latest version rather than at any specific revision, append the special revision ID `@latest` to the end of the path. Otherwise, the segment of the entry ID after the last `@` will be interpreted as a revision ID. For example, to get the latest revision of `my-entry`, use the path `/cloud/v2/universes/1234/data-stores/5678/entries/my@entry@latest`. To get the entry that was current at a specific time, add `@latest:` to the end of the path, where `` is RFC-3339 formatted. The given timestamp must be after the Unix epoch (1/1/1970) and not more than ten minutes in the future. For example, to get the revision of `my-entry` that was current on 12/2/2024 at 06:00 UTC, use the path `/cloud/v2/universes/1234/data-stores/5678/entries/my-entry@latest:2024-12-02T06:00:00Z`. * * **Scopes:** `universe-datastores.objects:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param scope_id The scope ID. * @param entry_id The entry ID. */ export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryId: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; entry_id: string; scope_id: string; }, { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }, undefined>; /** * `STABLE` * * Marks the specified entry for deletion. Entries are not be deleted immediately; instead, the `state` field will be set to `DELETED`. Permanent deletion occurs after 30 days. On success, returns 200 OK. If the entry doesn't exist, returns 404 Not Found. * * **Scopes:** `universe-datastores.objects:delete` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param scope_id The scope ID. * @param entry_id The entry ID. */ export declare const deleteCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryId: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; entry_id: string; scope_id: string; }, void, undefined>; /** * `STABLE` * * Updates the value, attributes, and users of an entry. Updating specific revisions of the entry is **unsupported**. If you specify a revision ID in the path and `allow_missing` is `true`, the update request will instead create a new entry with the `@` suffix as part of the key. Partial update is **unsupported**. If attributes or users are not provided when updating the value, they will be cleared. Value must always be provided when updating an entry. * * **Scopes:** `universe-datastores.objects:update` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param scope_id The scope ID. * @param entry_id The entry ID. * @param allowMissing If set to true, and the data store entry is not found, a data store entry is created. */ export declare const patchCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryId: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; entry_id: string; scope_id: string; allowMissing?: boolean | undefined; }, { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }, { [x: string]: unknown; path?: string | undefined; createTime?: string | undefined; revisionId?: string | undefined; revisionCreateTime?: string | undefined; state?: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED" | undefined; etag?: string | undefined; value?: unknown; id?: string | undefined; users?: string[] | undefined; attributes?: Record | undefined; }>; /** * `STABLE` * * Increments the value of the specified entry. Both the existing value and the increment amount must be integers. If the entry doesn't exist, creates an entry with the specified value. Incrementing specific revisions of the entry is **unsupported**. If you specify a revision ID in the path, the increment request will create a new entry with the `@` suffix as part of the key. Known issue: the value may be incremented past the valid range of values. When this happens, the returned value will be clamped to the valid range, but the backend may persist the original value. This behavior is maintained for backwards compatibility reasons, but may change in a future version of this API. * * **Scopes:** `universe-datastores.objects:create`, `universe-datastores.objects:update` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param scope_id The scope ID. * @param entry_id The entry ID. */ export declare const postCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryIdIncrement: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; entry_id: string; scope_id: string; }, { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }, { [x: string]: unknown; amount: number; users: string[]; attributes: Record; }>; /** * `STABLE` * * List revisions of the data store entry. This method returns partial data store entries. In particular, only the `path`, `id`, `createTime`, `revisionCreateTime`, `revisionId`, `etag`, and `state` fields are populated. Both the `path` and `id` fields will have an `@` suffix. In order to get the full entry at a revision, you can use the provided `path` field with the `GetDataStoreEntry` method, i.e. `GET /cloud/v2/universes/1234/data-stores/5678/entries/my-entry@`. * * **Scopes:** `universe-datastores.versions:list` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param data_store_id The data-store ID. * @param scope_id The scope ID. * @param entry_id The entry ID. * @param maxPageSize The maximum number of revisions to return per page. The service might return fewer than the maximum number of revisions. If unspecified, at most 10 revisions are returned. The maximum value is 100 values and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter Supports the following subset of CEL: * Only the `&&`, `<=`, and `>=` operators are supported. * Only the `revision_create_time` field is supported. For example: `"revision_create_time >= 2000-01-01T00:00:00Z && revision_create_time <= 2001-01-01T00:00:00Z"` */ export declare const getCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntriesEntryIdListRevisions: import("../..").EndpointGeneric<{ universe_id: string; data_store_id: string; entry_id: string; scope_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { dataStoreEntries: { [x: string]: unknown; path: string; createTime: string; revisionId: string; revisionCreateTime: string; state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED"; etag: string; value: unknown; id: string; users: string[]; attributes: Record; }[]; nextPageToken: string; }, undefined>; /** * `STABLE` * * Create a new `LuauExecutionSessionTaskBinaryInput`. * * **Scopes:** `universe.place.luau-execution-session:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. */ export declare const postCloudV2UniversesUniverseIdLuauExecutionSessionTaskBinaryInputs: import("../..").EndpointGeneric<{ universe_id: string; }, { path: string; size: number; uploadUri: string; }, { path: string; size: number; uploadUri: string; }>; /** * `STABLE` * * Asynchronously flush all data structures in the universe. * * **Scopes:** `memory-store:flush` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. */ export declare const postCloudV2UniversesUniverseIdMemoryStoreFlush: import("../..").EndpointGeneric<{ universe_id: string; }, { path: string; metadata: { '@type': string; }; done: boolean; error: { code: number; message: string; details: { '@type': string; }[]; }; response: { '@type': string; }; }, Record>; /** * `STABLE` * * Creates a new queue item. If `ttl` is set, the item will automatically be removed from the queue after the time interval specified. If a numerical `priority` is set, the item will be inserted into the queue based on the priority value. The higher the value, the closer to the front of the queue the item will be. If priority values are the same then the item will be inserted after existing values with the same priority. * * **Scopes:** `memory-store.queue:add` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param queue_id The queue ID. */ export declare const postCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItems: import("../..").EndpointGeneric<{ universe_id: string; queue_id: string; }, { path: string; data: unknown; priority: number; ttl: string; expireTime: string; id: string; }, { path: string; data: unknown; priority: number; ttl: string; expireTime: string; id: string; }>; /** * `STABLE` * * Discards read items from the front of the queue. Takes a `readId` from a previous `Read` operation. * * **Scopes:** `memory-store.queue:discard` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param queue_id The queue ID. */ export declare const postCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItemsDiscard: import("../..").EndpointGeneric<{ universe_id: string; queue_id: string; }, void, { readId: string; }>; /** * `STABLE` * * Returns the specified number of items at the front of the queue. * * **Scopes:** `memory-store.queue:dequeue` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param queue_id The queue ID. * @param count The number of items to read from the queue If unspecified, 1 item will be returned. The maximum value is 200; values above 200 will be coerced to 200. * @param allOrNothing If `all_or_nothing` is true and the requested number of objects is not available, will return a 404 Error. Otherwise, will return the path and read_id of the read operation and a list of the MemoryStoreQueue items. * @param invisibilityWindow Invisibility window for items read, in seconds. Items read are invisible in subsequent reads during the invisibility window duration. It must be written in seconds greater than 0 and end with `s`. Defaults to `30s`. */ export declare const getCloudV2UniversesUniverseIdMemoryStoreQueuesQueueIdItemsRead: import("../..").EndpointGeneric<{ universe_id: string; queue_id: string; count?: number | undefined; allOrNothing?: boolean | undefined; invisibilityWindow?: string | undefined; }, { readId: string; items: { path: string; data: unknown; priority: number; ttl: string; expireTime: string; id: string; }[]; }, undefined>; /** * `STABLE` * * Gets and returns items in the map with a given order and filter. * * **Scopes:** `memory-store.sorted-map:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param sorted_map_id The sorted-map ID. * @param maxPageSize The maximum number of memory store sorted map items to return. The service might return fewer than this value. If unspecified, at most 1 memory store sorted map items are returned. The maximum value is 100 and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param orderBy If specified, results are ordered according to the specified fields. Values must be a comma-separated list of fields, with an optional, per-field " desc" suffix to sort by descending rather than ascending values. You can access subfields with a `.` operator. Results may be ordered by the following fields: id. Example: "id desc" * @param filter This field may be set in order to filter the resources returned. Filtering conforms to Common Expression Language (CEL). Only the `id` and `sortKey` fields are supported. In terms of operators, only `<`, `>` and `&&` are allowed' Example: `id > "key-001" && id < "key-100"` */ export declare const getCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItems: import("../..").EndpointGeneric<{ universe_id: string; sorted_map_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; orderBy?: string | undefined; }, { memoryStoreSortedMapItems: { path: string; value: unknown; etag: string; ttl: string; expireTime: string; id: string; stringSortKey: string; numericSortKey: number; }[]; nextPageToken: string; }, undefined>; /** * `STABLE` * * Creates the specified map item if it doesn't exist. * * **Scopes:** `memory-store.sorted-map:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param sorted_map_id The sorted-map ID. * @param id The ID to use for the memory store sorted map item, which will become the final component of the memory store sorted map item's resource path. This value should be a 1-127 character string that supports alphanumeric and special characters. This id is case sensitive. The id must be url encoded if it contains any url breaking special characters. */ export declare const postCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItems: import("../..").EndpointGeneric<{ universe_id: string; sorted_map_id: string; id?: string | undefined; }, { path: string; value: unknown; etag: string; ttl: string; expireTime: string; id: string; stringSortKey: string; numericSortKey: number; }, { path: string; value: unknown; etag: string; ttl: string; expireTime: string; id: string; stringSortKey: string; numericSortKey: number; }>; /** * `STABLE` * * Gets and returns the value of the given key in the map. * * **Scopes:** `memory-store.sorted-map:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param sorted_map_id The sorted-map ID. * @param item_id The item ID. */ export declare const getCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId: import("../..").EndpointGeneric<{ universe_id: string; sorted_map_id: string; item_id: string; }, { path: string; value: unknown; etag: string; ttl: string; expireTime: string; id: string; stringSortKey: string; numericSortKey: number; }, undefined>; /** * `STABLE` * * Deletes the specified item from the map. * * **Scopes:** `memory-store.sorted-map:write` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param sorted_map_id The sorted-map ID. * @param item_id The item ID. */ export declare const deleteCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId: import("../..").EndpointGeneric<{ universe_id: string; sorted_map_id: string; item_id: string; }, void, undefined>; /** * `STABLE` * * Updates the specified map item. * * **Scopes:** `memory-store.sorted-map:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param sorted_map_id The sorted-map ID. * @param item_id The item ID. * @param allowMissing If set to true, and the memory store sorted map item is not found, a memory store sorted map item is created. */ export declare const patchCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItemId: import("../..").EndpointGeneric<{ universe_id: string; sorted_map_id: string; item_id: string; allowMissing?: boolean | undefined; }, { path: string; value: unknown; etag: string; ttl: string; expireTime: string; id: string; stringSortKey: string; numericSortKey: number; }, { path?: string | undefined; value?: unknown; etag?: string | undefined; ttl?: string | undefined; expireTime?: string | undefined; id?: string | undefined; stringSortKey?: string | undefined; numericSortKey?: number | undefined; }>; /** * `STABLE` * * Returns a list of entries from an ordered data store. * * **Scopes:** `universe.ordered-data-store.scope.entry:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param ordered_data_store_id The ordered-data-store ID. * @param scope_id The scope ID. * @param maxPageSize The maximum number of ordered data store entries to return. The service might return fewer than this value. If unspecified, at most 10 ordered data store entries are returned. The maximum value is 100 and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param orderBy If specified, results are ordered according to the specified fields. Values must be a comma-separated list of fields, with an optional, per-field " desc" suffix to sort by descending rather than ascending values. You can access subfields with a `.` operator. Results may be ordered by the following fields: value. Example: "value desc" * @param filter This field may be set in order to filter the resources returned. We support two comparison operators for this operation: `<=` and `>=`.These comparison operators act as a minValue and maxValue for the values returned. If filtering is needed for a value between a minValue and maxValue the user can use the logical operator `&&`. All tokens in the filter expression must be separated by a single space. Example filters: `entry <= 10`; `entry >= 10 && entry <= 30` */ export declare const getCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntries: import("../..").EndpointGeneric<{ universe_id: string; scope_id: string; ordered_data_store_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; orderBy?: string | undefined; }, { orderedDataStoreEntries: { path: string; value: number; id: string; }[]; nextPageToken: string; }, undefined>; /** * `STABLE` * * Creates an entry with the provided ID and value. Returns a 400 Bad Request if the entry exists. * * **Scopes:** `universe.ordered-data-store.scope.entry:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param ordered_data_store_id The ordered-data-store ID. * @param scope_id The scope ID. * @param id The ID to use for the ordered data store entry, which will become the final component of the ordered data store entry's resource path. This value should be A 1-63 character string. We strongly recommend using only lowercase letters, numeric digits, and hyphens. */ export declare const postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntries: import("../..").EndpointGeneric<{ universe_id: string; scope_id: string; ordered_data_store_id: string; id?: string | undefined; }, { path: string; value: number; id: string; }, { path: string; value: number; id: string; }>; /** * `STABLE` * * Gets the specified entry. * * **Scopes:** `universe.ordered-data-store.scope.entry:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param ordered_data_store_id The ordered-data-store ID. * @param scope_id The scope ID. * @param entry_id The entry ID. */ export declare const getCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId: import("../..").EndpointGeneric<{ universe_id: string; entry_id: string; scope_id: string; ordered_data_store_id: string; }, { path: string; value: number; id: string; }, undefined>; /** * `STABLE` * * Deletes the specified entry. On success, returns 200 OK. If the entry doesn't exist, returns 404 Not Found. * * **Scopes:** `universe.ordered-data-store.scope.entry:write` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param ordered_data_store_id The ordered-data-store ID. * @param scope_id The scope ID. * @param entry_id The entry ID. */ export declare const deleteCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId: import("../..").EndpointGeneric<{ universe_id: string; entry_id: string; scope_id: string; ordered_data_store_id: string; }, void, undefined>; /** * `STABLE` * * Updates the value of an entry. * * **Scopes:** `universe.ordered-data-store.scope.entry:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param ordered_data_store_id The ordered-data-store ID. * @param scope_id The scope ID. * @param entry_id The entry ID. * @param allowMissing If set to true, and the ordered data store entry is not found, a ordered data store entry is created. */ export declare const patchCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryId: import("../..").EndpointGeneric<{ universe_id: string; entry_id: string; scope_id: string; ordered_data_store_id: string; allowMissing?: boolean | undefined; }, { path: string; value: number; id: string; }, { path?: string | undefined; value?: number | undefined; id?: string | undefined; }>; /** * `STABLE` * * Increments the value of the specified entry. Both the existing value and the increment amount must be integers. If the entry doesn't exist, creates an entry with the specified value. Known issue: the value may be incremented past the valid range of values. When this happens, the returned value will be clamped to the valid range, but the backend may persist the original value. This behavior is maintained for backwards compatibility reasons, but may change in a future version of this API. * * **Scopes:** `universe.ordered-data-store.scope.entry:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param ordered_data_store_id The ordered-data-store ID. * @param scope_id The scope ID. * @param entry_id The entry ID. */ export declare const postCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopesScopeIdEntriesEntryIdIncrement: import("../..").EndpointGeneric<{ universe_id: string; entry_id: string; scope_id: string; ordered_data_store_id: string; }, { path: string; value: number; id: string; }, { amount: number; }>; /** * `STABLE` * * Gets the specified place. * * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param place_id The place ID. */ export declare const getCloudV2UniversesUniverseIdPlacesPlaceId: import("../..").EndpointGeneric<{ universe_id: string; place_id: string; }, { templatePlace: string; path?: string | undefined; createTime?: string | undefined; updateTime?: string | undefined; displayName?: string | undefined; description?: string | undefined; serverSize?: number | undefined; root?: boolean | undefined; universeRuntimeCreation?: boolean | undefined; }, undefined>; /** * `STABLE` * * Updates the specified place. * * **Scopes:** `universe.place:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param place_id The place ID. * @param updateMask The list of fields to update. */ export declare const patchCloudV2UniversesUniverseIdPlacesPlaceId: import("../..").EndpointGeneric<{ universe_id: string; place_id: string; updateMask?: string | undefined; }, { templatePlace: string; path?: string | undefined; createTime?: string | undefined; updateTime?: string | undefined; displayName?: string | undefined; description?: string | undefined; serverSize?: number | undefined; root?: boolean | undefined; universeRuntimeCreation?: boolean | undefined; }, { path?: string | undefined; createTime?: string | undefined; updateTime?: string | undefined; displayName?: string | undefined; description?: string | undefined; serverSize?: number | undefined; root?: boolean | undefined; universeRuntimeCreation?: boolean | undefined; templatePlace?: string | undefined; }>; /** * `BETA` * * Gets an instance and its property data. The maximum supported response data size is 500,000 bytes. If this limit is exceeded, the returned `Operation` will be completed with an error result that has an error code of `422`. * * **Scopes:** `universe.place.instance:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param place_id The place ID. * @param instance_id The instance ID. */ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId: import("../..").EndpointGeneric<{ universe_id: string; place_id: string; instance_id: string; }, { path: string; metadata: { '@type': string; }; done: boolean; error: { code: number; message: string; details: { '@type': string; }[]; }; response: { '@type': string; }; }, undefined>; /** * `BETA` * * Updates an instance's property data. When updating a `Script` instance's source property, the maximum supported property size is 200,000 bytes after UTF-8 encoding. * * **Scopes:** `universe.place.instance:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param place_id The place ID. * @param instance_id The instance ID. * @param updateMask The list of fields to update. */ export declare const patchCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId: import("../..").EndpointGeneric<{ universe_id: string; place_id: string; instance_id: string; updateMask?: string | undefined; }, { path: string; metadata: { '@type': string; }; done: boolean; error: { code: number; message: string; details: { '@type': string; }[]; }; response: { '@type': string; }; }, { path?: string | undefined; hasChildren?: boolean | undefined; engineInstance?: { Id: string; Parent: string; Name: string; Details: { Folder: Record; LocalScript: { Enabled: boolean; RunContext: "Legacy" | "Server" | "Client" | "Plugin"; Source: string; }; ModuleScript: { Source: string; }; Script: { Enabled: boolean; RunContext: "Legacy" | "Server" | "Client" | "Plugin"; Source: string; }; }; } | undefined; }>; /** * `BETA` * * Lists an instance's children. The maximum supported response data size is 500,000 bytes. If this limit is exceeded, the returned `Operation` will be completed with an error result that has an error code of `422`. * * **Scopes:** `universe.place.instance:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param place_id The place ID. * @param instance_id The instance ID. * @param maxPageSize The maximum number of child instance to return. The service may return fewer than this value. If unspecified, at most 200 children will be returned. The maximum value is 200; values above 200 will be coerced to 200. * @param pageToken A page token, received from a previous `ListInstanceChildrenRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInstanceChildrenRequest` must match the call that provided the page token. */ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceIdListChildren: import("../..").EndpointGeneric<{ universe_id: string; place_id: string; instance_id: string; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { path: string; metadata: { '@type': string; }; done: boolean; error: { code: number; message: string; details: { '@type': string; }[]; }; response: { '@type': string; }; }, undefined>; /** * `STABLE` * * Creates a task but does not wait for the task to complete. To check whether a task has completed, call the `GetLuauExecutionSessionTask` method and inspect the `state` field of the returned resource. Quotas: * 5 calls per minute per API key owner * 45 calls per minute per IP address * * **Scopes:** `universe.place.luau-execution-session:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param place_id The place ID. */ export declare const postCloudV2UniversesUniverseIdPlacesPlaceIdLuauExecutionSessionTasks: import("../..").EndpointGeneric<{ universe_id: string; place_id: string; }, { path: string; createTime: string; updateTime: string; user: string; state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED"; script: string; timeout: string; error: { code: "ERROR_CODE_UNSPECIFIED" | "SCRIPT_ERROR" | "DEADLINE_EXCEEDED" | "OUTPUT_SIZE_LIMIT_EXCEEDED" | "INTERNAL_ERROR"; message: string; }; output: { results: unknown[]; }; binaryInput: string; enableBinaryOutput: boolean; binaryOutputUri: string; }, { path: string; createTime: string; updateTime: string; user: string; state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED"; script: string; timeout: string; error: { code: "ERROR_CODE_UNSPECIFIED" | "SCRIPT_ERROR" | "DEADLINE_EXCEEDED" | "OUTPUT_SIZE_LIMIT_EXCEEDED" | "INTERNAL_ERROR"; message: string; }; output: { results: unknown[]; }; binaryInput: string; enableBinaryOutput: boolean; binaryOutputUri: string; }>; /** * `BETA` * * List user restrictions for users that have ever been banned in either a universe or a specific place. * * **Scopes:** `universe.user-restriction:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param place_id The place ID. * @param maxPageSize The maximum number of user restrictions to return. The service might return fewer than this value. If unspecified, at most 10 user restrictions are returned. The maximum value is 100 and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. */ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictions: import("../..").EndpointGeneric<{ universe_id: string; place_id: string; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { userRestrictions: { path: string; updateTime: string; user: string; gameJoinRestriction: { active: boolean; startTime: string; duration: string; privateReason: string; displayReason: string; excludeAltAccounts: boolean; inherited: boolean; }; }[]; nextPageToken: string; }, undefined>; /** * `BETA` * * Get the user restriction. * * **Scopes:** `universe.user-restriction:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param place_id The place ID. * @param user_restriction_id The user-restriction ID. */ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrictionId: import("../..").EndpointGeneric<{ universe_id: string; place_id: string; user_restriction_id: string; }, { path: string; updateTime: string; user: string; gameJoinRestriction: { active: boolean; startTime: string; duration: string; privateReason: string; displayReason: string; excludeAltAccounts: boolean; inherited: boolean; }; }, undefined>; /** * `BETA` * * Update the user restriction. * * **Scopes:** `universe.user-restriction:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param place_id The place ID. * @param user_restriction_id The user-restriction ID. * @param updateMask The list of fields to update. The `game_join_restriction` field must be updated atomically; field masks that index into `game_join_restriction` (such as `"game_join_restriction.active"`) are not supported. * @param idempotencyKey.key The unique key to use for idempotency. * @param idempotencyKey.firstSent The timestamp at which the first request was sent. If this is further in the past than the lifetime of the idempotency key (which *may* exceed the annotated minimum lifetime), the server *must* return an error. */ export declare const patchCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrictionId: import("../..").EndpointGeneric<{ universe_id: string; place_id: string; user_restriction_id: string; updateMask?: string | undefined; "idempotencyKey.key"?: string | undefined; "idempotencyKey.firstSent"?: string | undefined; }, { path: string; updateTime: string; user: string; gameJoinRestriction: { active: boolean; startTime: string; duration: string; privateReason: string; displayReason: string; excludeAltAccounts: boolean; inherited: boolean; }; }, { path?: string | undefined; updateTime?: string | undefined; user?: string | undefined; gameJoinRestriction?: { active: boolean; startTime: string; duration: string; privateReason: string; displayReason: string; excludeAltAccounts: boolean; inherited: boolean; } | undefined; }>; /** * `STABLE` * * Creates a task but does not wait for the task to complete. To check whether a task has completed, call the `GetLuauExecutionSessionTask` method and inspect the `state` field of the returned resource. Quotas: * 5 calls per minute per API key owner * 45 calls per minute per IP address * * **Scopes:** `universe.place.luau-execution-session:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param place_id The place ID. * @param version_id The version ID. */ export declare const postCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionTasks: import("../..").EndpointGeneric<{ universe_id: string; place_id: string; version_id: string; }, { path: string; createTime: string; updateTime: string; user: string; state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED"; script: string; timeout: string; error: { code: "ERROR_CODE_UNSPECIFIED" | "SCRIPT_ERROR" | "DEADLINE_EXCEEDED" | "OUTPUT_SIZE_LIMIT_EXCEEDED" | "INTERNAL_ERROR"; message: string; }; output: { results: unknown[]; }; binaryInput: string; enableBinaryOutput: boolean; binaryOutputUri: string; }, { path: string; createTime: string; updateTime: string; user: string; state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED"; script: string; timeout: string; error: { code: "ERROR_CODE_UNSPECIFIED" | "SCRIPT_ERROR" | "DEADLINE_EXCEEDED" | "OUTPUT_SIZE_LIMIT_EXCEEDED" | "INTERNAL_ERROR"; message: string; }; output: { results: unknown[]; }; binaryInput: string; enableBinaryOutput: boolean; binaryOutputUri: string; }>; /** * `STABLE` * * Gets information about a task. Quotas: * 45 calls per minute per API key owner or IP address * * **Scopes:** `universe.place.luau-execution-session:read`, `universe.place.luau-execution-session:write` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param place_id The place ID. * @param version_id The version ID. * @param luau_execution_session_id The luau-execution-session ID. * @param task_id The task ID. * @param view The view in which to retrieve the luau execution session task. Supports BASIC and FULL. Defaults to BASIC. Possible values: | Value | Description | | --- | --- | | VIEW_UNSPECIFIED | The luau execution session task view is not specified; the default will be used. | | BASIC | Excludes the `script` field. | | FULL | Includes all fields. | */ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionsLuauExecutionSessionIdTasksTaskId: import("../..").EndpointGeneric<{ universe_id: string; place_id: string; version_id: string; luau_execution_session_id: string; task_id: string; view?: "VIEW_UNSPECIFIED" | "FULL" | "BASIC" | undefined; }, { path: string; createTime: string; updateTime: string; user: string; state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED"; script: string; timeout: string; error: { code: "ERROR_CODE_UNSPECIFIED" | "SCRIPT_ERROR" | "DEADLINE_EXCEEDED" | "OUTPUT_SIZE_LIMIT_EXCEEDED" | "INTERNAL_ERROR"; message: string; }; output: { results: unknown[]; }; binaryInput: string; enableBinaryOutput: boolean; binaryOutputUri: string; }, undefined>; /** * `STABLE` * * Lists log chunks generated by a `LuauExecutionSessionTask`. Quotas: * 45 calls per minute per API key owner or IP address * * **Scopes:** `universe.place.luau-execution-session:read`, `universe.place.luau-execution-session:write` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param place_id The place ID. * @param version_id The version ID. * @param luau_execution_session_id The luau-execution-session ID. * @param task_id The task ID. * @param maxPageSize The maximum number of luau execution session task logs to return. The service might return fewer than this value. If unspecified, at most 10000 luau execution session task logs are returned. The maximum value is 10000 and higher values are set to 10000. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param view The view in which to retrieve the luau execution session task log. Supports FLAT and STRUCTURED. Defaults to FLAT. Possible values: | Value | Description | | --- | --- | | VIEW_UNSPECIFIED | The luau execution session task log view is not specified; the default will be used. | | 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. | | 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). | */ export declare const getCloudV2UniversesUniverseIdPlacesPlaceIdVersionsVersionIdLuauExecutionSessionsLuauExecutionSessionIdTasksTaskIdLogs: import("../..").EndpointGeneric<{ universe_id: string; place_id: string; version_id: string; luau_execution_session_id: string; task_id: string; view?: "VIEW_UNSPECIFIED" | "FLAT" | "STRUCTURED" | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { luauExecutionSessionTaskLogs: { path: string; messages: string[]; structuredMessages: { message: string; createTime: string; messageType: "MESSAGE_TYPE_UNSPECIFIED" | "OUTPUT" | "INFO" | "WARNING" | "ERROR"; }[]; }[]; nextPageToken: string; }, undefined>; /** * `BETA` * * Get the subscription. The `universe.subscription-product.subscription:read` scope only allows reading subscriptions of the user making the request. Because of this, the subscription ID must match the user ID of the user making the request. Note that this scope might be more relevant for OAuth 2.0 apps. To read all subscriptions made by users for a particular universe, use the `universe:write` scope instead. * * **Scopes:** `universe:write`, `universe.subscription-product.subscription:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param subscription_product_id The subscription-product ID. * @param subscription_id The subscription ID. * @param view The view in which to retrieve the subscription. Supports BASIC and FULL. Defaults to BASIC. Possible values: | Value | Description | | --- | --- | | VIEW_UNSPECIFIED | The subscription view is not specified; the default will be used. | | BASIC | Includes only the `active` and `renewing` fields. | | FULL | Includes all fields. | */ export declare const getCloudV2UniversesUniverseIdSubscriptionProductsSubscriptionProductIdSubscriptionsSubscriptionId: import("../..").EndpointGeneric<{ universe_id: string; subscription_product_id: string; subscription_id: string; view?: "VIEW_UNSPECIFIED" | "FULL" | "BASIC" | undefined; }, { path: string; createTime: string; updateTime: string; active: boolean; willRenew: boolean; lastBillingTime: string; nextRenewTime: string; expireTime: string; state: "STATE_UNSPECIFIED" | "SUBSCRIBED_WILL_RENEW" | "SUBSCRIBED_WILL_NOT_RENEW" | "SUBSCRIBED_RENEWAL_PAYMENT_PENDING" | "EXPIRED"; expirationDetails: { reason: "EXPIRATION_REASON_UNSPECIFIED" | "PRODUCT_INACTIVE" | "PRODUCT_DELETED" | "SUBSCRIBER_CANCELLED" | "SUBSCRIBER_REFUNDED" | "LAPSED"; }; purchasePlatform: "PURCHASE_PLATFORM_UNSPECIFIED" | "DESKTOP" | "MOBILE"; paymentProvider: "PAYMENT_PROVIDER_UNSPECIFIED" | "STRIPE" | "APPLE" | "GOOGLE" | "ROBLOX_CREDIT" | "ROBUX"; user: string; }, undefined>; /** * `BETA` * * List user restrictions for users that have ever been banned in either a universe or a specific place. * * **Scopes:** `universe.user-restriction:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param maxPageSize The maximum number of user restrictions to return. The service might return fewer than this value. If unspecified, at most 10 user restrictions are returned. The maximum value is 100 and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. */ export declare const getCloudV2UniversesUniverseIdUserRestrictions: import("../..").EndpointGeneric<{ universe_id: string; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { userRestrictions: { path: string; updateTime: string; user: string; gameJoinRestriction: { active: boolean; startTime: string; duration: string; privateReason: string; displayReason: string; excludeAltAccounts: boolean; inherited: boolean; }; }[]; nextPageToken: string; }, undefined>; /** * `BETA` * * List changes to UserRestriction resources within a given universe. This includes both universe-level and place-level restrictions. For universe-level restriction logs, the `place` field will be empty. * * **Scopes:** `universe.user-restriction:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param maxPageSize The maximum number of UserRestrictionLogs to return. The service may return fewer than this value. If unspecified, at most 10 UserRestrictionLogs are returned. The maximum value is 100 and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter This field may be set to filter the logs returned. The `filter` field supports a very small number of CEL: * `user` * `place` * The `==` comparison operator is available. * The `&&` logical operator is also supported. As an example, filtering for a user and a place takes the form `filter="user == 'users/123'" && "place == 'places/456'"` */ export declare const getCloudV2UniversesUniverseIdUserRestrictionsListLogs: import("../..").EndpointGeneric<{ universe_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { logs: { user: string; place: string; moderator: { robloxUser: string; gameServerScript: Record; }; createTime: string; active: boolean; startTime: string; duration: string; privateReason: string; displayReason: string; restrictionType: { gameJoinRestriction: Record; }; excludeAltAccounts: boolean; }[]; nextPageToken: string; }, undefined>; /** * `BETA` * * Get the user restriction. * * **Scopes:** `universe.user-restriction:read` * **Engine:** Not available in-engine * * @param universe_id The universe ID. * @param user_restriction_id The user-restriction ID. */ export declare const getCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId: import("../..").EndpointGeneric<{ universe_id: string; user_restriction_id: string; }, { path: string; updateTime: string; user: string; gameJoinRestriction: { active: boolean; startTime: string; duration: string; privateReason: string; displayReason: string; excludeAltAccounts: boolean; inherited: boolean; }; }, undefined>; /** * `BETA` * * Update the user restriction. * * **Scopes:** `universe.user-restriction:write` * **Engine:** Not available in-engine * * @param body * @param universe_id The universe ID. * @param user_restriction_id The user-restriction ID. * @param updateMask The list of fields to update. The `game_join_restriction` field must be updated atomically; field masks that index into `game_join_restriction` (such as `"game_join_restriction.active"`) are not supported. * @param idempotencyKey.key The unique key to use for idempotency. * @param idempotencyKey.firstSent The timestamp at which the first request was sent. If this is further in the past than the lifetime of the idempotency key (which *may* exceed the annotated minimum lifetime), the server *must* return an error. */ export declare const patchCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId: import("../..").EndpointGeneric<{ universe_id: string; user_restriction_id: string; updateMask?: string | undefined; "idempotencyKey.key"?: string | undefined; "idempotencyKey.firstSent"?: string | undefined; }, { path: string; updateTime: string; user: string; gameJoinRestriction: { active: boolean; startTime: string; duration: string; privateReason: string; displayReason: string; excludeAltAccounts: boolean; inherited: boolean; }; }, { path?: string | undefined; updateTime?: string | undefined; user?: string | undefined; gameJoinRestriction?: { active: boolean; startTime: string; duration: string; privateReason: string; displayReason: string; excludeAltAccounts: boolean; inherited: boolean; } | undefined; }>; /** * `BETA` * * Gets a user's basic and advanced information. To access a user's public information, no additional scopes are required. To access a user's verification status, you need the following scopes: * user.advanced:read To access a user's social account information, you need the following scopes: * user.social:read * * **Scopes:** `user.advanced:read`, `user.social:read` * **Engine:** Not available in-engine * * @param user_id The user ID. */ export declare const getCloudV2UsersUserId: import("../..").EndpointGeneric<{ user_id: string; }, { path: string; createTime: string; id: string; name: string; displayName: string; about: string; locale: string; premium: boolean; idVerified: boolean; socialNetworkProfiles: { facebook: string; twitter: string; youtube: string; twitch: string; guilded: string; visibility: "SOCIAL_NETWORK_VISIBILITY_UNSPECIFIED" | "NO_ONE" | "FRIENDS" | "FRIENDS_AND_FOLLOWING" | "FRIENDS_FOLLOWING_AND_FOLLOWERS" | "EVERYONE"; }; }, undefined>; /** * `BETA` * * Generates and returns the URL for the user's avatar thumbnail. * * **Engine:** Not available in-engine * * @param user_id The user ID. * @param size Size of the generated thumbnail. The generated thumbnail will have `size * size` dimension. Currently supported values: 48, 50, 60, 75, 100, 110, 150, 180, 352, 420, 720 Default is 420. * @param format Specify the format of the generated thumbnail. Default is `PNG`. Possible values: | Value | Description | | --- | --- | | FORMAT_UNSPECIFIED | Default UserThumbnail Format -- set to png | | PNG | Generate thumbnail in `.png` format | | JPEG | Generate thumbnail in `.jpg` format | * @param shape Specify the shape of the thumbnail. Default is `ROUND` (circular). Possible values: | Value | Description | | --- | --- | | SHAPE_UNSPECIFIED | Default UserThumbnail Shape -- set to round | | ROUND | Generate thumbnail as a circle. | | SQUARE | Generate thumbnail as a rectangle. | */ export declare const getCloudV2UsersUserIdGenerateThumbnail: import("../..").EndpointGeneric<{ user_id: string; size?: number | undefined; format?: "FORMAT_UNSPECIFIED" | "PNG" | "JPEG" | undefined; shape?: "SHAPE_UNSPECIFIED" | "ROUND" | "SQUARE" | undefined; }, { path: string; metadata: { '@type': string; }; done: boolean; error: { code: number; message: string; details: { '@type': string; }[]; }; response: { '@type': string; }; }, undefined>; /** * `BETA` * * Returns a list of asset quotas. * * **Scopes:** `asset:read` * **Engine:** Not available in-engine * * @param user_id The user ID. * @param maxPageSize The maximum number of asset quotas to return. The service might return fewer than this value. If unspecified, at most 10 asset quotas are returned. The maximum value is 100 and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter This field may be set in order to filter the resources returned. Supports the following subset of CEL: * Only the `quotaType` and `assetType` fields are supported. * Only the `==` and `&&` operator are supported. For example: `quotaType == RateLimitUpload && assetType == Audio` */ export declare const getCloudV2UsersUserIdAssetQuotas: import("../..").EndpointGeneric<{ user_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { assetQuotas: { path: string; quotaType: "QUOTA_TYPE_UNSPECIFIED" | "RATE_LIMIT_UPLOAD" | "RATE_LIMIT_CREATOR_STORE_DISTRIBUTE"; assetType: "ASSET_TYPE_UNSPECIFIED" | "IMAGE" | "TSHIRT" | "AUDIO" | "MESH" | "LUA" | "HAT" | "PLACE" | "MODEL" | "SHIRT" | "PANTS" | "DECAL" | "HEAD" | "FACE" | "GEAR" | "ANIMATION" | "TORSO" | "RIGHT_ARM" | "LEFT_ARM" | "LEFT_LEG" | "RIGHT_LEG" | "YOUTUBE_VIDEO" | "APP" | "CODE" | "PLUGIN" | "SOLID_MODEL" | "MESH_PART" | "HAIR_ACCESSORY" | "FACE_ACCESSORY" | "NECK_ACCESSORY" | "SHOULDER_ACCESSORY" | "FRONT_ACCESSORY" | "BACK_ACCESSORY" | "WAIST_ACCESSORY" | "CLIMB_ANIMATION" | "DEATH_ANIMATION" | "FALL_ANIMATION" | "IDLE_ANIMATION" | "JUMP_ANIMATION" | "RUN_ANIMATION" | "SWIM_ANIMATION" | "WALK_ANIMATION" | "POSE_ANIMATION" | "LOCALIZATION_TABLE_MANIFEST" | "LOCALIZATION_TABLE_TRANSLATION" | "EMOTE_ANIMATION" | "VIDEO" | "TEXTURE_PACK" | "TSHIRT_ACCESSORY" | "SHIRT_ACCESSORY" | "PANTS_ACCESSORY" | "JACKET_ACCESSORY" | "SWEATER_ACCESSORY" | "SHORTS_ACCESSORY" | "LEFT_SHOE_ACCESSORY" | "RIGHT_SHOE_ACCESSORY" | "DRESS_SKIRT_ACCESSORY" | "FONT_FAMILY" | "FONT_FACE" | "MESH_HIDDEN_SURFACE_REMOVAL" | "EYEBROW_ACCESSORY" | "EYELASH_ACCESSORY" | "MOOD_ANIMATION" | "DYNAMIC_HEAD" | "CODE_SNIPPET" | "ADS_VIDEO"; usage: number; capacity: number; period: "PERIOD_UNSPECIFIED" | "MONTH" | "DAY"; usageResetTime: string; }[]; nextPageToken: string; }, undefined>; /** * `BETA` * * List the inventory items in a user's inventory. The inventory items returned depend on the target user’s choice under **Settings > Privacy > Who can see my inventory?**: * If the user granted inventory visibility to "Everyone," then any API key or OAuth2 token can be used to view the target’s inventory, no matter what scopes it has or who created it. * If the user has not granted inventory visibility to "Everyone": * Their inventory can still be viewed with an API key created by the target user with **Inventory: Read** permission. * Their inventory can still be viewed with an OAuth2 token if the target user authorizes an app requesting permissions for the `user.inventory-item:read` scope. * * **Scopes:** `user.inventory-item:read` * **Engine:** Usable with HttpService * * @param user_id The user ID. * @param maxPageSize The maximum number of inventory items to return. The service might return fewer than this value. If unspecified, at most 10 inventory items are returned. The maximum value is 100 and higher values are set to 100. * @param pageToken A page token, received from a previous call, to retrieve a subsequent page. When paginating, all other parameters provided to the subsequent call must match the call that provided the page token. * @param filter This field may be set in order to filter the resources returned. See the [filtering](/cloud/reference/patterns#list-inventory-items) documentation for more information. */ export declare const getCloudV2UsersUserIdInventoryItems: import("../..").EndpointGeneric<{ user_id: string; filter?: string | undefined; maxPageSize?: number | undefined; pageToken?: string | undefined; }, { inventoryItems: { path: string; assetDetails: { assetId: string; inventoryItemAssetType: "AUDIO" | "HAT" | "MODEL" | "DECAL" | "FACE" | "GEAR" | "ANIMATION" | "TORSO" | "RIGHT_ARM" | "LEFT_ARM" | "LEFT_LEG" | "RIGHT_LEG" | "PLUGIN" | "MESH_PART" | "HAIR_ACCESSORY" | "FACE_ACCESSORY" | "NECK_ACCESSORY" | "SHOULDER_ACCESSORY" | "FRONT_ACCESSORY" | "BACK_ACCESSORY" | "WAIST_ACCESSORY" | "CLIMB_ANIMATION" | "DEATH_ANIMATION" | "FALL_ANIMATION" | "IDLE_ANIMATION" | "JUMP_ANIMATION" | "RUN_ANIMATION" | "SWIM_ANIMATION" | "WALK_ANIMATION" | "POSE_ANIMATION" | "EMOTE_ANIMATION" | "VIDEO" | "TSHIRT_ACCESSORY" | "SHIRT_ACCESSORY" | "PANTS_ACCESSORY" | "JACKET_ACCESSORY" | "SWEATER_ACCESSORY" | "SHORTS_ACCESSORY" | "LEFT_SHOE_ACCESSORY" | "RIGHT_SHOE_ACCESSORY" | "DRESS_SKIRT_ACCESSORY" | "EYEBROW_ACCESSORY" | "EYELASH_ACCESSORY" | "MOOD_ANIMATION" | "DYNAMIC_HEAD" | "INVENTORY_ITEM_ASSET_TYPE_UNSPECIFIED" | "CLASSIC_TSHIRT" | "CLASSIC_SHIRT" | "CLASSIC_PANTS" | "CLASSIC_HEAD" | "PACKAGE" | "CREATED_PLACE" | "PURCHASED_PLACE"; instanceId: string; collectibleDetails: { itemId: string; instanceId: string; instanceState: "COLLECTIBLE_ITEM_INSTANCE_STATE_UNSPECIFIED" | "AVAILABLE" | "HOLD"; serialNumber: number; }; }; badgeDetails: { badgeId: string; }; gamePassDetails: { gamePassId: string; }; privateServerDetails: { privateServerId: string; }; addTime: string; }[]; nextPageToken: string; }, undefined>; /** * `STABLE` * * Sends a notification to a user. * * **Scopes:** `user.user-notification:write` * **Engine:** Not available in-engine * * @param body * @param user_id The user ID. */ export declare const postCloudV2UsersUserIdNotifications: import("../..").EndpointGeneric<{ user_id: string; }, { path: string; id: string; source: { universe: string; }; payload: { type: "TYPE_UNSPECIFIED" | "MOMENT"; messageId: string; parameters: { stringValue: string; int64Value: number; }; joinExperience: { launchData: string; }; analyticsData: { category: string; }; }; }, { path: string; id: string; source: { universe: string; }; payload: { type: "TYPE_UNSPECIFIED" | "MOMENT"; messageId: string; parameters: { stringValue: string; int64Value: number; }; joinExperience: { launchData: string; }; analyticsData: { category: string; }; }; }>; export declare const postApiKeysIntrospect: import("../..").EndpointGeneric<{}, { name: string; authorizedUserId: number; scopes: { name: string; operations: string[]; universeDatastores?: { universeId: string; datastoreName: string; }[] | undefined; groupIds?: string[] | undefined; userIds?: string[] | undefined; }[]; enabled: boolean; expired: boolean; expirationTimeUtc: string; }, { apiKey: string; }>; export declare const deleteLegacyDevelopV2TeamtestByPlaceId: import("../..").EndpointGeneric<{ placeId: number; }, Record, undefined>;