UNPKG

openblox

Version:

Roblox API Wrapper For Both Classic And OpenCloud APIs.

498 lines 335 kB
import type { Identifier, ObjectEither, ArrayNonEmptyIfConst } from "typeforge"; import type { PrettifiedGameTemplatesData, PrettifiedPluginsInfoData, PrettifiedTeamCreateActiveMembersData, PrettifiedTeamCreateSettingsForUniversesData, PrettifiedUniversePlacesData, RawGameTemplatesData, RawPluginsInfoData, RawTeamCreateActiveMembersData, RawTeamCreateSettingsForUniversesData, RawUniversesInfoData, PrettifiedUniversesInfoData, RawAuthenticatedUserPermissionsForUniversesData, PrettifiedAuthenticatedUserPermissionsForUniversesData, RawAuthenticatedUserGroupsCanManage, PrettifiedAuthenticatedUserGroupsCanManage, PrettifiedAuthenticatedUserUniversesData, RawAuthenticatedUserUniversesData } from "./develop.types"; import type { SortOrder } from "../../../utils/utils.types"; /** * Gets a page of templates that can be used to start off making games * @endpoint GET /v1/gametemplates * * @example const { data:templates } = await ClassicDevelopApi.gameTemplates() * @exampleData [{"gameTemplateType":"Generic","hasTutorials":false,"universe":{"id":28220420,"name":"Baseplate","description":null,"isArchived":false,"rootPlaceId":95206881,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2013-11-01T08:47:14.070Z","updated":"2023-05-02T22:03:01.107Z"}},{"gameTemplateType":"Generic","hasTutorials":false,"universe":{"id":2464612126,"name":"Classic Baseplate","description":null,"isArchived":false,"rootPlaceId":6560363541,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2021-03-24T00:56:45.957Z","updated":"2021-04-16T18:55:13.820Z"}},{"gameTemplateType":"Generic","hasTutorials":false,"universe":{"id":28223770,"name":"Flat Terrain","description":null,"isArchived":false,"rootPlaceId":95206192,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2013-11-01T08:47:18.013Z","updated":"2023-05-02T22:17:58.570Z"}},{"gameTemplateType":"Gameplay","hasTutorials":false,"universe":{"id":6106389365,"name":"Laser Tag","description":null,"isArchived":false,"rootPlaceId":17823019220,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2024-06-11T21:29:12.993Z","updated":"2024-06-20T16:58:40.577Z"}},{"gameTemplateType":"Gameplay","hasTutorials":false,"universe":{"id":6106388692,"name":"FPS System","description":null,"isArchived":false,"rootPlaceId":17823017290,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2024-06-11T21:28:57.433Z","updated":"2024-06-20T16:58:54.493Z"}},{"gameTemplateType":"Gameplay","hasTutorials":false,"universe":{"id":5557500170,"name":"Racing","description":null,"isArchived":false,"rootPlaceId":16078915506,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2024-01-22T19:47:42.920Z","updated":"2024-01-29T17:39:18.837Z"}},{"gameTemplateType":"Theme","hasTutorials":true,"universe":{"id":202770430,"name":"Village","description":null,"isArchived":false,"rootPlaceId":520390648,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2016-10-10T21:32:42.780Z","updated":"2023-05-03T23:39:56.663Z"}},{"gameTemplateType":"Theme","hasTutorials":true,"universe":{"id":93411794,"name":"Castle","description":null,"isArchived":false,"rootPlaceId":203810088,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2015-01-14T21:46:11.363Z","updated":"2023-05-03T23:46:03.850Z"}},{"gameTemplateType":"Theme","hasTutorials":false,"universe":{"id":138962641,"name":"Suburban","description":null,"isArchived":false,"rootPlaceId":366130569,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2016-02-20T00:02:36.483Z","updated":"2023-05-03T23:45:29.983Z"}},{"gameTemplateType":"Theme","hasTutorials":true,"universe":{"id":107387509,"name":"Pirate Island","description":null,"isArchived":false,"rootPlaceId":264719325,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2015-07-01T22:54:38.927Z","updated":"2023-05-03T23:49:39.753Z"}},{"gameTemplateType":"Gameplay","hasTutorials":false,"universe":{"id":93412282,"name":"Obby","description":null,"isArchived":false,"rootPlaceId":203812057,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2015-01-14T21:51:25.830Z","updated":"2023-05-03T23:50:57.623Z"}},{"gameTemplateType":"Theme","hasTutorials":true,"universe":{"id":142606178,"name":"Starting Place","description":null,"isArchived":false,"rootPlaceId":379736082,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2016-03-09T19:04:30.723Z","updated":"2023-05-04T00:09:23.643Z"}},{"gameTemplateType":"Gameplay","hasTutorials":false,"universe":{"id":115791780,"name":"Line Runner","description":null,"isArchived":false,"rootPlaceId":301530843,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2015-09-28T22:16:52.420Z","updated":"2023-05-04T00:10:55.837Z"}},{"gameTemplateType":"Theme","hasTutorials":false,"universe":{"id":3760683948,"name":"Concert","description":null,"isArchived":false,"rootPlaceId":10275826693,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2022-07-19T00:42:50.713Z","updated":"2023-05-03T23:14:32.480Z"}},{"gameTemplateType":"Theme","hasTutorials":false,"universe":{"id":4594822820,"name":"Modern City","description":null,"isArchived":false,"rootPlaceId":13165709401,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2023-04-17T18:33:52.930Z","updated":"2023-04-17T23:24:03.373Z"}}] * @exampleRawBody {"data":[{"gameTemplateType":"Generic","hasTutorials":false,"universe":{"id":28220420,"name":"Baseplate","description":null,"isArchived":false,"rootPlaceId":95206881,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2013-11-01T08:47:14.07Z","updated":"2023-05-02T22:03:01.107Z"}},{"gameTemplateType":"Generic","hasTutorials":false,"universe":{"id":2464612126,"name":"Classic Baseplate","description":null,"isArchived":false,"rootPlaceId":6560363541,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2021-03-24T00:56:45.957Z","updated":"2021-04-16T18:55:13.82Z"}},{"gameTemplateType":"Generic","hasTutorials":false,"universe":{"id":28223770,"name":"Flat Terrain","description":null,"isArchived":false,"rootPlaceId":95206192,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2013-11-01T08:47:18.013Z","updated":"2023-05-02T22:17:58.57Z"}},{"gameTemplateType":"Gameplay","hasTutorials":false,"universe":{"id":6106389365,"name":"Laser Tag","description":null,"isArchived":false,"rootPlaceId":17823019220,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2024-06-11T21:29:12.993Z","updated":"2024-06-20T16:58:40.577Z"}},{"gameTemplateType":"Gameplay","hasTutorials":false,"universe":{"id":6106388692,"name":"FPS System","description":null,"isArchived":false,"rootPlaceId":17823017290,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2024-06-11T21:28:57.433Z","updated":"2024-06-20T16:58:54.493Z"}},{"gameTemplateType":"Gameplay","hasTutorials":false,"universe":{"id":5557500170,"name":"Racing","description":null,"isArchived":false,"rootPlaceId":16078915506,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2024-01-22T19:47:42.92Z","updated":"2024-01-29T17:39:18.837Z"}},{"gameTemplateType":"Theme","hasTutorials":true,"universe":{"id":202770430,"name":"Village","description":null,"isArchived":false,"rootPlaceId":520390648,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2016-10-10T21:32:42.78Z","updated":"2023-05-03T23:39:56.663Z"}},{"gameTemplateType":"Theme","hasTutorials":true,"universe":{"id":93411794,"name":"Castle","description":null,"isArchived":false,"rootPlaceId":203810088,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2015-01-14T21:46:11.363Z","updated":"2023-05-03T23:46:03.85Z"}},{"gameTemplateType":"Theme","hasTutorials":false,"universe":{"id":138962641,"name":"Suburban","description":null,"isArchived":false,"rootPlaceId":366130569,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2016-02-20T00:02:36.483Z","updated":"2023-05-03T23:45:29.983Z"}},{"gameTemplateType":"Theme","hasTutorials":true,"universe":{"id":107387509,"name":"Pirate Island","description":null,"isArchived":false,"rootPlaceId":264719325,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2015-07-01T22:54:38.927Z","updated":"2023-05-03T23:49:39.753Z"}},{"gameTemplateType":"Gameplay","hasTutorials":false,"universe":{"id":93412282,"name":"Obby","description":null,"isArchived":false,"rootPlaceId":203812057,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2015-01-14T21:51:25.83Z","updated":"2023-05-03T23:50:57.623Z"}},{"gameTemplateType":"Theme","hasTutorials":true,"universe":{"id":142606178,"name":"Starting Place","description":null,"isArchived":false,"rootPlaceId":379736082,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2016-03-09T19:04:30.723Z","updated":"2023-05-04T00:09:23.643Z"}},{"gameTemplateType":"Gameplay","hasTutorials":false,"universe":{"id":115791780,"name":"Line Runner","description":null,"isArchived":false,"rootPlaceId":301530843,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2015-09-28T22:16:52.42Z","updated":"2023-05-04T00:10:55.837Z"}},{"gameTemplateType":"Theme","hasTutorials":false,"universe":{"id":3760683948,"name":"Concert","description":null,"isArchived":false,"rootPlaceId":10275826693,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2022-07-19T00:42:50.713Z","updated":"2023-05-03T23:14:32.48Z"}},{"gameTemplateType":"Theme","hasTutorials":false,"universe":{"id":4594822820,"name":"Modern City","description":null,"isArchived":false,"rootPlaceId":13165709401,"isActive":true,"privacyType":"Public","creatorType":"User","creatorTargetId":998796,"creatorName":"Templates","created":"2023-04-17T18:33:52.93Z","updated":"2023-04-17T23:24:03.373Z"}}]} */ export declare const gameTemplates: import("../../apiGroup/apiGroup.types").CallApiMethod<Record<any, any>, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGameTemplatesData) => string) | undefined; getCursorsFn?: ((rawData: { data: { gameTemplateType: "Generic" | "Gameplay" | "Theme"; hasTutorials: boolean; universe: { id: Identifier; name: string; description: string | null; isArchived: boolean; rootPlaceId: Identifier; isActive: boolean; privacyType: "Public"; creatorType: "User"; creatorTargetId: Identifier; creatorName: string; created: `${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}`; updated: `${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}`; }; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { gameTemplateType: "Generic" | "Gameplay" | "Theme"; hasTutorials: boolean; universe: { id: Identifier; name: string; description: string | null; isArchived: boolean; rootPlaceId: Identifier; isActive: boolean; privacyType: "Public"; creatorType: "User"; creatorTargetId: Identifier; creatorName: string; created: `${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}`; updated: `${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}`; }; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { gameTemplateType: "Generic" | "Gameplay" | "Theme"; hasTutorials: boolean; universe: { id: Identifier; name: string; description: string | null; isArchived: boolean; rootPlaceId: Identifier; isActive: boolean; privacyType: "Public"; creatorType: "User"; creatorTargetId: Identifier; creatorName: string; created: Date; updated: Date; }; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawGameTemplatesData, PrettifiedGameTemplatesData>, false>; /** * Gets a list of universes for the given group. * @endpoint GET /v1/groups/{groupId}/universes * * @param groupId The ID of the group to get universes from. * @param isArchived Whether or not to return archived games. * @param limit The number of results per request. * @param sortOrder The order to sort the results in. Sorted by universeId. * @param cursor The paging cursor for the previous or next page. * * @example const { data:universes } = await ClassicDevelopApi.groupUniverses({ groupId: 5850082 }) * @exampleData [{"id":1651554338,"name":"Ninjas Unleashed: Legion","description":"No secret projects here\r\nScriptor/Game Designer - NamelessGuy2005\r\nBuilder/Animator - Flaroh\r\n","isArchived":false,"rootPlaceId":4857762148,"isActive":false,"privacyType":"Private","creatorType":"Group","creatorTargetId":5850082,"creatorName":"MightyPart Games","created":"2020-04-04T13:17:08.120Z","updated":"2020-04-20T15:37:55.803Z"}] * @exampleRawBody {"previousPageCursor":null,"nextPageCursor":null,"data":[{"id":1651554338,"name":"Ninjas Unleashed: Legion","description":"No secret projects here\r\nScriptor/Game Designer - NamelessGuy2005\r\nBuilder/Animator - Flaroh\r\n","isArchived":false,"rootPlaceId":4857762148,"isActive":false,"privacyType":"Private","creatorType":"Group","creatorTargetId":5850082,"creatorName":"MightyPart Games","created":"2020-04-04T13:17:08.12Z","updated":"2020-04-20T15:37:55.803Z"}]} */ export declare const groupUniverses: <GroupId extends Identifier>(this: any, args: { groupId: GroupId; isArchived?: boolean | undefined; limit?: 10 | 25 | 50 | 100 | undefined; sortOrder?: SortOrder | undefined; cursor?: string | undefined; }) => Promise<{ data: { id: Identifier; name: string; description: string; isArchived: boolean; rootPlaceId: Identifier; isActive: boolean; privacyType: "Private" | "Public"; creatorType: "Group"; creatorTargetId: GroupId; creatorName: string; created: Date; updated: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { previousPageCursor: string | null; nextPageCursor: string | null; data: { id: Identifier; name: string; description: string; isArchived: boolean; rootPlaceId: Identifier; isActive: boolean; privacyType: "Private" | "Public"; creatorType: "Group"; creatorTargetId: GroupId; creatorName: string; created: `${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}`; updated: `${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}`; }[]; }; }; cursors: { previous: import("../../apiGroup/apiGroup.types").Cursor; next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: () => AsyncGenerator<{ data: { id: Identifier; name: string; description: string; isArchived: boolean; rootPlaceId: Identifier; isActive: boolean; privacyType: "Private" | "Public"; creatorType: "Group"; creatorTargetId: GroupId; creatorName: string; created: Date; updated: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { previousPageCursor: string | null; nextPageCursor: string | null; data: { id: Identifier; name: string; description: string; isArchived: boolean; rootPlaceId: Identifier; isActive: boolean; privacyType: "Private" | "Public"; creatorType: "Group"; creatorTargetId: GroupId; creatorName: string; created: `${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}`; updated: `${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}`; }[]; }; }; cursors: { previous: import("../../apiGroup/apiGroup.types").Cursor; next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: null; } & { again: () => Promise<{ data: { id: Identifier; name: string; description: string; isArchived: boolean; rootPlaceId: Identifier; isActive: boolean; privacyType: "Private" | "Public"; creatorType: "Group"; creatorTargetId: GroupId; creatorName: string; created: Date; updated: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { previousPageCursor: string | null; nextPageCursor: string | null; data: { id: Identifier; name: string; description: string; isArchived: boolean; rootPlaceId: Identifier; isActive: boolean; privacyType: "Private" | "Public"; creatorType: "Group"; creatorTargetId: GroupId; creatorName: string; created: `${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}`; updated: `${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}`; }[]; }; }; }>; }, any, unknown>; } & { again: () => Promise<{ data: { id: Identifier; name: string; description: string; isArchived: boolean; rootPlaceId: Identifier; isActive: boolean; privacyType: "Private" | "Public"; creatorType: "Group"; creatorTargetId: GroupId; creatorName: string; created: Date; updated: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { previousPageCursor: string | null; nextPageCursor: string | null; data: { id: Identifier; name: string; description: string; isArchived: boolean; rootPlaceId: Identifier; isActive: boolean; privacyType: "Private" | "Public"; creatorType: "Group"; creatorTargetId: GroupId; creatorName: string; created: `${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}`; updated: `${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}`; }[]; }; }; }>; }>; /** * List of users in the active Team Create session. * @endpoint GET /v1/places/{placeId}/teamcreate/active_session/members * * @param placeId The ID of the place to get active team create members from. * @param limit The number of results per request. * @param cursor The paging cursor for the previous or next page. * * @example const { data:activeMembers } = await ClassicDevelopApi.teamCreateActiveMembers({ placeId: 17718644108 }) * @exampleData [{"id":45348281,"name":"MightyPart","displayName":"Mighty"}] * @exampleRawBody {"previousPageCursor":null,"nextPageCursor":null,"data":[{"id":45348281,"name":"MightyPart","displayName":"Mighty"}]} */ export declare const teamCreateActiveMembers: import("../../apiGroup/apiGroup.types").CallApiMethod<{ placeId: Identifier; limit?: 10 | 25 | 50 | 100 | undefined; cursor?: string | undefined; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawTeamCreateActiveMembersData) => string) | undefined; getCursorsFn?: ((rawData: { previousPageCursor: string | null; nextPageCursor: string | null; data: { id: Identifier; name: string; displayName: string; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { previousPageCursor: string | null; nextPageCursor: string | null; data: { id: Identifier; name: string; displayName: string; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { id: Identifier; name: string; displayName: string; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawTeamCreateActiveMembersData, PrettifiedTeamCreateActiveMembersData>, true>; /** * Gets team create settings for a universe. * @endpoint GET /v1/universes/{universeId}/teamcreate * * @param universeId The ID of the universe to get team create settings for. * * @example const { data:settings } = await ClassicDevelopApi.teamCreateSettingsForUniverse({ universeId: 6069031486 }) * @exampleData {"isEnabled":true} * @exampleRawBody {"isEnabled":true} */ export declare const teamCreateSettingsForUniverse: import("../../apiGroup/apiGroup.types").CallApiMethod<{ universeId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { isEnabled: boolean; }) => string) | undefined; getCursorsFn?: ((rawData: { isEnabled: boolean; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { isEnabled: boolean; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { isEnabled: boolean; } | undefined; }, false>; /** * Updates team create settings for a universe. * @endpoint PATCH /v1/universes/{universeId}/teamcreate * * @param universeId The ID of the universe to update team create settings for. * @param isEnabled If team create should be enabled. * * @example const { data:success } = await ClassicDevelopApi.setTeamCreateSettingsForUniverse({ universeId: 6069031486, isEnabled: false }) * @exampleData true * @exampleRawBody {} */ export declare const setTeamCreateSettingsForUniverse: import("../../apiGroup/apiGroup.types").CallApiMethod<{ universeId: Identifier; isEnabled: boolean; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Gets team create settings for many universes. * @endpoint GET /v1/universes/multiget/teamcreate * * @param universeIds The ID of the universe to get team create settings for. * * @example const { data:settings } = await ClassicDevelopApi.teamCreateSettingsForUniverses({ universeIds: [ 6069031486 ] }) * @exampleData {"6069031486":{"isEnabled":false}} * @exampleRawBody {"data":[{"id":6069031486,"isEnabled":false}]} */ export declare const teamCreateSettingsForUniverses: <UniverseId extends Identifier>(this: any, args: { universeIds: ArrayNonEmptyIfConst<UniverseId>; }) => Promise<{ data: Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawTeamCreateSettingsForUniversesData<UniverseId>) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: UniverseId; isEnabled: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: UniverseId; isEnabled: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedTeamCreateSettingsForUniversesData<UniverseId> extends infer T ? T extends PrettifiedTeamCreateSettingsForUniversesData<UniverseId> ? T extends undefined ? { data: { id: UniverseId; isEnabled: boolean; }[]; } : import("typeforge").Prettify<T, T extends Date ? true : false> : never : never) | undefined; } & (PrettifiedTeamCreateSettingsForUniversesData<UniverseId> extends infer T_1 ? T_1 extends PrettifiedTeamCreateSettingsForUniversesData<UniverseId> ? T_1 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawTeamCreateSettingsForUniversesData<UniverseId>, PrettifiedTeamCreateSettingsForUniversesData<UniverseId> extends infer T_2 ? T_2 extends PrettifiedTeamCreateSettingsForUniversesData<UniverseId> ? T_2 extends undefined ? RawTeamCreateSettingsForUniversesData<UniverseId> : T_2 : never : never> : never : never))["🔒__PRIVATE_FORMATTED_DATA"], undefined>; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: import("typeforge").Prettify<Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawTeamCreateSettingsForUniversesData<UniverseId>) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: UniverseId; isEnabled: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: UniverseId; isEnabled: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedTeamCreateSettingsForUniversesData<UniverseId> extends infer T_3 ? T_3 extends PrettifiedTeamCreateSettingsForUniversesData<UniverseId> ? T_3 extends undefined ? { data: { id: UniverseId; isEnabled: boolean; }[]; } : import("typeforge").Prettify<T_3, T_3 extends Date ? true : false> : never : never) | undefined; } & (PrettifiedTeamCreateSettingsForUniversesData<UniverseId> extends infer T_4 ? T_4 extends PrettifiedTeamCreateSettingsForUniversesData<UniverseId> ? T_4 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawTeamCreateSettingsForUniversesData<UniverseId>, PrettifiedTeamCreateSettingsForUniversesData<UniverseId> extends infer T_5 ? T_5 extends PrettifiedTeamCreateSettingsForUniversesData<UniverseId> ? T_5 extends undefined ? RawTeamCreateSettingsForUniversesData<UniverseId> : T_5 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawTeamCreateSettingsForUniversesData<UniverseId>) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: UniverseId; isEnabled: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: UniverseId; isEnabled: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedTeamCreateSettingsForUniversesData<UniverseId> extends infer T_6 ? T_6 extends PrettifiedTeamCreateSettingsForUniversesData<UniverseId> ? T_6 extends undefined ? { data: { id: UniverseId; isEnabled: boolean; }[]; } : import("typeforge").Prettify<T_6, T_6 extends Date ? true : false> : never : never) | undefined; } & (PrettifiedTeamCreateSettingsForUniversesData<UniverseId> extends infer T_7 ? T_7 extends PrettifiedTeamCreateSettingsForUniversesData<UniverseId> ? T_7 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawTeamCreateSettingsForUniversesData<UniverseId>, PrettifiedTeamCreateSettingsForUniversesData<UniverseId> extends infer T_8 ? T_8 extends PrettifiedTeamCreateSettingsForUniversesData<UniverseId> ? T_8 extends undefined ? RawTeamCreateSettingsForUniversesData<UniverseId> : T_8 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined> extends infer T_9 ? T_9 extends Exclude<({ method: import(".