openblox/dist/apis/cloud/experiences/experiences.d.ts

Roblox API Wrapper For Both Classic And OpenCloud APIs.

/// <reference types="node" />
import type { Identifier } from "typeforge";
import type { Universe } from "./experiences.types";
/**
 * Gets information about a universe.
 * @endpoint GET /cloud/v2/universes/{universeId}
 *
 * @param universeId The id of the universe to get information about.
 *
 * @example const { data:universeInfo } = await ExperiencesApi.universeInfo({ universeId: 5795192361 });
 * @exampleData {"path":"universes/5795192361","createTime":"2024-03-25T10:42:46.360Z","updateTime":"2024-03-25T10:42:46.360Z","displayName":"MightyPart's Place Number: 201","description":"","user":"users/45348281","visibility":"PRIVATE","voiceChatEnabled":false,"ageRating":"AGE_RATING_UNSPECIFIED","desktopEnabled":true,"mobileEnabled":true,"tabletEnabled":true,"consoleEnabled":false,"vrEnabled":true}
 * @exampleRawBody {"path":"universes/5795192361","createTime":"2024-03-25T10:42:46.360Z","updateTime":"2024-03-25T10:42:46.360Z","displayName":"MightyPart's Place Number: 201","description":"","user":"users/45348281","visibility":"PRIVATE","voiceChatEnabled":false,"ageRating":"AGE_RATING_UNSPECIFIED","desktopEnabled":true,"mobileEnabled":true,"tabletEnabled":true,"consoleEnabled":false,"vrEnabled":true}
 */
export declare const universeInfo: <UniverseId extends Identifier>(this: any, args: {
    universeId: UniverseId;
}) => Promise<{
    data: {
        path: `universes/${UniverseId}`;
        createTime: Date;
        updateTime: Date;
        user: `users/${number}`;
        group?: false | 0 | null | undefined;
        displayName: string;
        description: string;
        visibility: "PRIVATE" | "PUBLIC" | "VISIBILITY_UNSPECIFIED";
        facebookSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        twitterSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        youtubeSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        twitchSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        discordSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        robloxGroupSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        guildedSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        voiceChatEnabled: boolean;
        ageRating: "AGE_RATING_UNSPECIFIED" | "AGE_RATING_ALL" | "AGE_RATING_9_PLUS" | "AGE_RATING_13_PLUS" | "AGE_RATING_17_PLUS";
        privateServerPriceRobux?: number | undefined;
        desktopEnabled: boolean;
        mobileEnabled: boolean;
        tabletEnabled: boolean;
        consoleEnabled: boolean;
        vrEnabled: boolean;
    } | {
        path: `universes/${UniverseId}`;
        createTime: Date;
        updateTime: Date;
        group: `groups/${number}`;
        user?: false | 0 | null | undefined;
        displayName: string;
        description: string;
        visibility: "PRIVATE" | "PUBLIC" | "VISIBILITY_UNSPECIFIED";
        facebookSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        twitterSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        youtubeSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        twitchSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        discordSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        robloxGroupSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        guildedSocialLink?: {
            title: string;
            uri: `https://${string}`;
        } | undefined;
        voiceChatEnabled: boolean;
        ageRating: "AGE_RATING_UNSPECIFIED" | "AGE_RATING_ALL" | "AGE_RATING_9_PLUS" | "AGE_RATING_13_PLUS" | "AGE_RATING_17_PLUS";
        privateServerPriceRobux?: number | undefined;
        desktopEnabled: boolean;
        mobileEnabled: boolean;
        tabletEnabled: boolean;
        consoleEnabled: boolean;
        vrEnabled: boolean;
    };
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: ({
            path: `universes/${UniverseId}`;
            createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
        } & {
            user: `users/${number}`;
            group?: false | 0 | null | undefined;
        } & Universe<string, string, "PRIVATE" | "PUBLIC" | "VISIBILITY_UNSPECIFIED", boolean, "AGE_RATING_UNSPECIFIED" | "AGE_RATING_ALL" | "AGE_RATING_9_PLUS" | "AGE_RATING_13_PLUS" | "AGE_RATING_17_PLUS", boolean, boolean, boolean, boolean, boolean>) | ({
            path: `universes/${UniverseId}`;
            createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
        } & {
            group: `groups/${number}`;
            user?: false | 0 | null | undefined;
        } & Universe<string, string, "PRIVATE" | "PUBLIC" | "VISIBILITY_UNSPECIFIED", boolean, "AGE_RATING_UNSPECIFIED" | "AGE_RATING_ALL" | "AGE_RATING_9_PLUS" | "AGE_RATING_13_PLUS" | "AGE_RATING_17_PLUS", boolean, boolean, boolean, boolean, boolean>);
    };
} & {
    again: () => Promise<{
        data: {
            path: `universes/${UniverseId}`;
            createTime: Date;
            updateTime: Date;
            user: `users/${number}`;
            group?: false | 0 | null | undefined;
            displayName: string;
            description: string;
            visibility: "PRIVATE" | "PUBLIC" | "VISIBILITY_UNSPECIFIED";
            facebookSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            twitterSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            youtubeSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            twitchSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            discordSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            robloxGroupSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            guildedSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            voiceChatEnabled: boolean;
            ageRating: "AGE_RATING_UNSPECIFIED" | "AGE_RATING_ALL" | "AGE_RATING_9_PLUS" | "AGE_RATING_13_PLUS" | "AGE_RATING_17_PLUS";
            privateServerPriceRobux?: number | undefined;
            desktopEnabled: boolean;
            mobileEnabled: boolean;
            tabletEnabled: boolean;
            consoleEnabled: boolean;
            vrEnabled: boolean;
        } | {
            path: `universes/${UniverseId}`;
            createTime: Date;
            updateTime: Date;
            group: `groups/${number}`;
            user?: false | 0 | null | undefined;
            displayName: string;
            description: string;
            visibility: "PRIVATE" | "PUBLIC" | "VISIBILITY_UNSPECIFIED";
            facebookSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            twitterSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            youtubeSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            twitchSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            discordSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            robloxGroupSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            guildedSocialLink?: {
                title: string;
                uri: `https://${string}`;
            } | undefined;
            voiceChatEnabled: boolean;
            ageRating: "AGE_RATING_UNSPECIFIED" | "AGE_RATING_ALL" | "AGE_RATING_9_PLUS" | "AGE_RATING_13_PLUS" | "AGE_RATING_17_PLUS";
            privateServerPriceRobux?: number | undefined;
            desktopEnabled: boolean;
            mobileEnabled: boolean;
            tabletEnabled: boolean;
            consoleEnabled: boolean;
            vrEnabled: boolean;
        };
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: ({
                path: `universes/${UniverseId}`;
                createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
                updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            } & {
                user: `users/${number}`;
                group?: false | 0 | null | undefined;
            } & Universe<string, string, "PRIVATE" | "PUBLIC" | "VISIBILITY_UNSPECIFIED", boolean, "AGE_RATING_UNSPECIFIED" | "AGE_RATING_ALL" | "AGE_RATING_9_PLUS" | "AGE_RATING_13_PLUS" | "AGE_RATING_17_PLUS", boolean, boolean, boolean, boolean, boolean>) | ({
                path: `universes/${UniverseId}`;
                createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
                updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            } & {
                group: `groups/${number}`;
                user?: false | 0 | null | undefined;
            } & Universe<string, string, "PRIVATE" | "PUBLIC" | "VISIBILITY_UNSPECIFIED", boolean, "AGE_RATING_UNSPECIFIED" | "AGE_RATING_ALL" | "AGE_RATING_9_PLUS" | "AGE_RATING_13_PLUS" | "AGE_RATING_17_PLUS", boolean, boolean, boolean, boolean, boolean>);
        };
    }>;
}>;
/**
 * Updates a universes information.
 * @endpoint PATCH /cloud/v2/universes/{universeId}
 *
 * @param universeId The id of the universe to update.
 * @param displayName The new display name for the universe.
 * @param description The new description for the universe.
 * @param visibility The new visibility for the universe.
 * @param facebookSocialLink The new facebook social link for the universe.
 * @param twitterSocialLink The new twitter social link for the universe.
 * @param youtubeSocialLink The new youtube social link for the universe.
 * @param twitchSocialLink The new twitch social link for the universe.
 * @param discordSocialLink The new discord social link for the universe.
 * @param robloxGroupSocialLink The new roblox group social link for the universe.
 * @param guildedSocialLink The new guilded social link for the universe.
 * @param voiceChatEnabled if voice chat will be enabled for the universe.
 * @param ageRating The new age rating for the universe.
 * @param privateServerPriceRobux The new private server price (in robux) for the universe.
 * @param desktopEnabled if desktop players will be allowed to access the universe.
 * @param mobileEnabled if mobile players will be allowed to access the universe.
 * @param tabletEnabled if tablet players will be allowed to access the universe.
 * @param consoleEnabled if console players will be allowed to access the universe.
 * @param vrEnabled if vr players will be allowed to access the universe.
 *
 * @example
 * const { data:updatedData } = await ExperiencesApi.updateUniverse({
     universeId: 5795192361, displayName: "Lorem Ipsum", visibility: "PRIVATE"
   })
 * @exampleData {"path":"universes/5795192361","createTime":"2024-03-25T10:42:46.360Z","updateTime":"2024-03-25T10:42:46.360Z","displayName":"MightyPart's Place Number: 201","description":"","user":"users/45348281","visibility":"PRIVATE","voiceChatEnabled":false,"ageRating":"AGE_RATING_UNSPECIFIED","desktopEnabled":true,"mobileEnabled":true,"tabletEnabled":true,"consoleEnabled":false,"vrEnabled":true}
 * @exampleRawBody {"path":"universes/5795192361","createTime":"2024-03-25T10:42:46.360Z","updateTime":"2024-03-25T10:42:46.360Z","displayName":"MightyPart's Place Number: 201","description":"","user":"users/45348281","visibility":"PRIVATE","voiceChatEnabled":false,"ageRating":"AGE_RATING_UNSPECIFIED","desktopEnabled":true,"mobileEnabled":true,"tabletEnabled":true,"consoleEnabled":false,"vrEnabled":true}
 */
export declare const updateUniverse: <UniverseId extends Identifier, DisplayName extends string, Description extends string, Visibility extends "PRIVATE" | "PUBLIC" | "VISIBILITY_UNSPECIFIED", VoiceChatEnabled extends boolean, AgeRating extends "AGE_RATING_UNSPECIFIED" | "AGE_RATING_ALL" | "AGE_RATING_9_PLUS" | "AGE_RATING_13_PLUS" | "AGE_RATING_17_PLUS", DesktopEnabled extends boolean, MobileEnabled extends boolean, TabletEnabled extends boolean, ConsoleEnabled extends boolean, VREnabled extends boolean>(this: any, args: {
    universeId: UniverseId;
} & Partial<Universe<DisplayName, Description, Visibility, VoiceChatEnabled, AgeRating, DesktopEnabled, MobileEnabled, TabletEnabled, ConsoleEnabled, VREnabled>>) => Promise<{
    data: {
        path: `universes/${UniverseId}`;
        createTime: Date;
        updateTime: Date;
        displayName: DisplayName;
        description: Description;
        user: `users/${number}`;
        visibility: Visibility;
        voiceChatEnabled: VoiceChatEnabled;
        ageRating: AgeRating;
        desktopEnabled: DesktopEnabled;
        mobileEnabled: MobileEnabled;
        tabletEnabled: TabletEnabled;
        consoleEnabled: ConsoleEnabled;
        vrEnabled: VREnabled;
    };
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: {
            path: `universes/${UniverseId}`;
            createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            displayName: DisplayName;
            description: Description;
            user: `users/${number}`;
            visibility: Visibility;
            voiceChatEnabled: VoiceChatEnabled;
            ageRating: AgeRating;
            desktopEnabled: DesktopEnabled;
            mobileEnabled: MobileEnabled;
            tabletEnabled: TabletEnabled;
            consoleEnabled: ConsoleEnabled;
            vrEnabled: VREnabled;
        };
    };
} & {
    again: () => Promise<{
        data: {
            path: `universes/${UniverseId}`;
            createTime: Date;
            updateTime: Date;
            displayName: DisplayName;
            description: Description;
            user: `users/${number}`;
            visibility: Visibility;
            voiceChatEnabled: VoiceChatEnabled;
            ageRating: AgeRating;
            desktopEnabled: DesktopEnabled;
            mobileEnabled: MobileEnabled;
            tabletEnabled: TabletEnabled;
            consoleEnabled: ConsoleEnabled;
            vrEnabled: VREnabled;
        };
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: {
                path: `universes/${UniverseId}`;
                createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
                updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
                displayName: DisplayName;
                description: Description;
                user: `users/${number}`;
                visibility: Visibility;
                voiceChatEnabled: VoiceChatEnabled;
                ageRating: AgeRating;
                desktopEnabled: DesktopEnabled;
                mobileEnabled: MobileEnabled;
                tabletEnabled: TabletEnabled;
                consoleEnabled: ConsoleEnabled;
                vrEnabled: VREnabled;
            };
        };
    }>;
}>;
/**
 * Restarts all currently running servers for a given universe. Used for releasing experience updates.
 * @category Users
 * @endpoint GET /cloud/v2/universes/{universeId}
 *
 * @param universeId The id of the universe to restart servers for.
 *
 * @example await ExperiencesApi.restartUniverseServers({ universeId: 5795192361 });
 * @exampleData {}
 * @exampleRawBody {}
 */
export declare const restartUniverseServers: <UniverseId extends Identifier>(this: any, args: {
    universeId: UniverseId;
}) => Promise<{
    data: {};
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: {};
    };
} & {
    again: () => Promise<{
        data: {};
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: {};
        };
    }>;
}>;
/**
 * Gets information about a universes place.
 * @endpoint GET /cloud/v2/universes/{universeId}/{placeId}
 *
 * @param universeId The id of the universe to get place information about.
 * @param placeId The id of the place to get information about.
 *
 * @example const { data:placeInfo } = await ExperiencesApi.placeInfo({ universeId: 5795192361, placeId: 16866553538 })
 * @exampleData {"path":"universes/5795192361/places/16866553538","createTime":"2024-03-25T10:42:46.297Z","updateTime":"2024-03-26T16:50:19.023Z","displayName":"MightyPart's Place Number: 201","description":"","serverSize":50}
 * @exampleRawBody {"path":"universes/5795192361/places/16866553538","createTime":"2024-03-25T10:42:46.297Z","updateTime":"2024-03-26T16:50:19.023Z","displayName":"MightyPart's Place Number: 201","description":"","serverSize":50}
 */
export declare const placeInfo: <UniverseId extends Identifier, PlaceId extends Identifier>(this: any, args: {
    universeId: UniverseId;
    placeId: PlaceId;
}) => Promise<{
    data: {
        path: `universes/${UniverseId}/places/${PlaceId}`;
        createTime: Date;
        updateTime: Date;
        displayName: string;
        description: string;
        serverSize: number;
    };
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: {
            path: `universes/${UniverseId}/places/${PlaceId}`;
            createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            displayName: string;
            description: string;
            serverSize: number;
        };
    };
} & {
    again: () => Promise<{
        data: {
            path: `universes/${UniverseId}/places/${PlaceId}`;
            createTime: Date;
            updateTime: Date;
            displayName: string;
            description: string;
            serverSize: number;
        };
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: {
                path: `universes/${UniverseId}/places/${PlaceId}`;
                createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
                updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
                displayName: string;
                description: string;
                serverSize: number;
            };
        };
    }>;
}>;
/**
 * Updates a places information.
 * @endpoint PATCH /cloud/v2/universes/{universeId}/places/{PlaceId}
 *
 * @param universeId The id of the universe to update place information for.
 * @param placeId The id of the place to update.
 * @param displayName The new display name for the place.
 * @param description The new description for the place.
 * @param serverSize The new server size for the place.
 *
 * @example
 * const { data:updatedInfo } = await ExperiencesApi.updatePlace({
     universeId: 5795192361, placeId: 16866553538, displayName: "Hello World"
   })
 * @exampleData {"path":"universes/5795192361/places/16866553538","createTime":"2024-03-25T10:42:46.297Z","updateTime":"2024-05-13T10:21:20.247Z","displayName":"Hello World","description":"","serverSize":50}
 * @exampleRawBody {"path":"universes/5795192361/places/16866553538","createTime":"2024-03-25T10:42:46.297Z","updateTime":"2024-05-13T10:21:20.247157600Z","displayName":"Hello World","description":"","serverSize":50}
 */
export declare const updatePlace: <UniverseId extends Identifier, PlaceId extends Identifier, DisplayName extends string, Description extends string, ServerSize extends number>(this: any, args: {
    universeId: UniverseId;
    placeId: PlaceId;
    displayName?: DisplayName | undefined;
    description?: Description | undefined;
    serverSize?: ServerSize | undefined;
}) => Promise<{
    data: {
        path: `universes/${UniverseId}/places/${PlaceId}`;
        createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
        updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
        displayName: DisplayName;
        description: Description;
        serverSize: ServerSize;
    };
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: {
            path: `universes/${UniverseId}/places/${PlaceId}`;
            createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            displayName: DisplayName;
            description: Description;
            serverSize: ServerSize;
        };
    };
} & {
    again: () => Promise<{
        data: {
            path: `universes/${UniverseId}/places/${PlaceId}`;
            createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}