openblox
Version:
Roblox API Wrapper For Both Classic And OpenCloud APIs.
36 lines (35 loc) • 1.47 kB
TypeScript
import type { Identifier } from "typeforge";
/**
* Gets the parent universe Id from a place Id.
* @endpoint GET /v1/places/{placeId}/universe
*
* @param placeId The id of the place to get the universe id for.
*
* @example const { data:universeId } = await ClassicUniversesApi.universeIdFromPlaceId({ placeId: 16349154726 })
* @exampleData 5638577595
* @exampleRawBody {"universeId":5638577595}
*/
export declare const universeIdFromPlaceId: import("../../apiGroup/apiGroup.types").CallApiMethod<{
placeId: 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: {
universeId: Identifier;
}) => string) | undefined;
getCursorsFn?: ((rawData: {
universeId: Identifier;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
universeId: Identifier;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: Identifier | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{
universeId: Identifier;
}, Identifier>, false>;