openblox
Version:
Roblox API Wrapper For Both Classic And OpenCloud APIs.
556 lines • 88.6 kB
TypeScript
import type { Identifier, IsUnion, ObjectEither } from "typeforge";
import type { AuthenticatedUserEventPermissionsForHostData, EventCategory, EventStatus, Or, PrettifiedRsvpCountersData, PrettifiedRsvpsData, RawRsvpCountersData, RawRsvpsData } from "./virtualEvents.types";
/**
* Gets information about an event.
* @endpoint GET /v1/virtual-events/{eventId}
*
* @param eventId The ID of the event to get information for.
*
* @example const { data:eventInfo } = await ClassicVirtualEventsApi.eventInfo({ eventId: "5904751593700196492" })
* @exampleData {"id":"5904751593700196492","title":"My Cool Event Of Epic Awesomeness","displayTitle":"My Cool Event Of Epic Awesomeness","description":"hello","displayDescription":"hello","eventTime":{"startUtc":"2024-07-12T19:18:00.000Z","endUtc":"2024-07-13T20:30:00.000Z"},"host":{"hostName":"Bloxfolio","hasVerifiedBadge":false,"hostType":"group","hostId":15842838},"universeId":6255645791,"eventStatus":"active","createdUtc":"2024-07-12T19:01:41.661Z","updatedUtc":"2024-07-13T20:29:50.734Z","eventCategories":[{"category":"activity","rank":0},{"category":"systemUpdate","rank":1}],"thumbnails":[{"mediaId":18459197740,"rank":0}],"allThumbnailsCreated":false,"userRsvpStatus":"going"}
* @exampleRawBody {"id":"5904751593700196492","title":"My Cool Event Of Epic Awesomeness","displayTitle":"My Cool Event Of Epic Awesomeness","description":"hello","displayDescription":"hello","eventTime":{"startUtc":"2024-07-12T19:18:00.000Z","endUtc":"2024-07-13T20:30:00.000Z"},"host":{"hostName":"Bloxfolio","hasVerifiedBadge":false,"hostType":"group","hostId":15842838},"universeId":6255645791,"eventStatus":"active","createdUtc":"2024-07-12T19:01:41.661Z","updatedUtc":"2024-07-13T20:29:50.734Z","eventCategories":[{"category":"activity","rank":0},{"category":"systemUpdate","rank":1}],"thumbnails":[{"mediaId":18459197740,"rank":0}],"allThumbnailsCreated":false,"userRsvpStatus":"going"}
*/
export declare const eventInfo: <EventId extends Identifier>(this: any, args: {
eventId: Identifier;
}) => Promise<{
data: {
id: EventId;
title: string;
displayTitle: string | null;
description: string;
displayDescription: string | null;
eventTime: {
startUtc: Date;
endUtc: Date;
};
host: {
hostName: string;
hasVerifiedBadge: boolean;
hostType: "user" | "group";
hostId: Identifier;
};
universeId: Identifier;
eventStatus: EventStatus;
createdUtc: Date;
updatedUtc: Date;
eventCategories: [{
category: EventCategory;
rank: 0;
}, {
category: EventCategory;
rank: 1;
}] | null;
thumbnails: {
mediaId: Identifier;
rank: number;
}[];
allThumbnailsCreated: boolean;
userRsvpStatus: "none" | "going" | "maybeGoing" | "notGoing";
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
id: EventId;
title: string;
displayTitle: string | null;
description: string;
displayDescription: string | null;
eventTime: {
startUtc: `${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}`;
endUtc: `${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}`;
};
host: {
hostName: string;
hasVerifiedBadge: boolean;
hostType: "user" | "group";
hostId: Identifier;
};
universeId: Identifier;
eventStatus: EventStatus;
createdUtc: `${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}`;
updatedUtc: `${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}`;
eventCategories: [{
category: EventCategory;
rank: 0;
}, {
category: EventCategory;
rank: 1;
}] | null;
thumbnails: {
mediaId: Identifier;
rank: number;
}[];
allThumbnailsCreated: boolean;
userRsvpStatus: "none" | "going" | "maybeGoing" | "notGoing";
};
};
} & {
again: () => Promise<{
data: {
id: EventId;
title: string;
displayTitle: string | null;
description: string;
displayDescription: string | null;
eventTime: {
startUtc: Date;
endUtc: Date;
};
host: {
hostName: string;
hasVerifiedBadge: boolean;
hostType: "user" | "group";
hostId: Identifier;
};
universeId: Identifier;
eventStatus: EventStatus;
createdUtc: Date;
updatedUtc: Date;
eventCategories: [{
category: EventCategory;
rank: 0;
}, {
category: EventCategory;
rank: 1;
}] | null;
thumbnails: {
mediaId: Identifier;
rank: number;
}[];
allThumbnailsCreated: boolean;
userRsvpStatus: "none" | "going" | "maybeGoing" | "notGoing";
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
id: EventId;
title: string;
displayTitle: string | null;
description: string;
displayDescription: string | null;
eventTime: {
startUtc: `${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}`;
endUtc: `${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}`;
};
host: {
hostName: string;
hasVerifiedBadge: boolean;
hostType: "user" | "group";
hostId: Identifier;
};
universeId: Identifier;
eventStatus: EventStatus;
createdUtc: `${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}`;
updatedUtc: `${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}`;
eventCategories: [{
category: EventCategory;
rank: 0;
}, {
category: EventCategory;
rank: 1;
}] | null;
thumbnails: {
mediaId: Identifier;
rank: number;
}[];
allThumbnailsCreated: boolean;
userRsvpStatus: "none" | "going" | "maybeGoing" | "notGoing";
};
};
}>;
}>;
/**
* Creates a virtual event.
* @endpoint POST /v1/virtual-events/create
*
* @param title The title of the event.
* @param description The description of the event.
* @param startTime The start time of the event.
* @param endTime The end time of the event.
* @param universeId The ID of the universe to create the event in.
* @param groupId The ID of the group to create the event in. The universe must be owned by this group.
* @param primaryCategory The primary purpose/category of this event.
* @param secondaryCategory The secondary purpose/category of this event.
* @param thumbnailIds An array of thumbnailIds to be used for this event.
*
* @example
* const { data:createdEvent } = await ClassicVirtualEventsApi.createEvent({
title: "Event Name", description: "Description",
startTime: "2024-08-14T00:46:54.000Z", endTime: "2024-08-14T01:46:54.000Z",
universeId: 6255645791, groupId: 15842838,
primaryCategory: "contentUpdate", secondaryCategory: "activity"
})
* @exampleData {"id":"6533473338141704368","title":"Event Name","displayTitle":null,"description":"Description","displayDescription":null,"eventTime":{"startUtc":"2024-08-14T00:46:54.000Z","endUtc":"2024-08-14T01:46:54.000Z"},"host":{"hostName":"Bloxfolio","hasVerifiedBadge":false,"hostType":"group","hostId":15842838},"universeId":6255645791,"eventStatus":"unpublished","createdUtc":"2024-07-14T00:35:35.487Z","updatedUtc":"2024-07-14T00:35:35.487Z","eventCategories":[{"category":"contentUpdate","rank":0},{"category":"activity","rank":1}],"thumbnails":null,"allThumbnailsCreated":false}
* @exampleRawBody {"id":"6533473338141704368","title":"Event Name","displayTitle":null,"description":"Description","displayDescription":null,"eventTime":{"startUtc":"2024-08-14T00:46:54+00:00","endUtc":"2024-08-14T01:46:54+00:00"},"host":{"hostName":"Bloxfolio","hasVerifiedBadge":false,"hostType":"group","hostId":15842838},"universeId":6255645791,"eventStatus":"unpublished","createdUtc":"2024-07-14T00:35:35.487+00:00","updatedUtc":"2024-07-14T00:35:35.487+00:00","eventCategories":[{"category":"contentUpdate","rank":0},{"category":"activity","rank":1}],"thumbnails":null,"allThumbnailsCreated":false}
*/
export declare const createEvent: <Title extends string, Description extends string, StartTime extends Date | `${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}`, EndTime extends Date | `${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}`, UniverseId extends Identifier, GroupId extends Identifier, SecondaryCategory extends PrimaryCategory extends undefined ? EventCategory : IsUnion<PrimaryCategory> extends true ? EventCategory : Exclude<"contentUpdate", PrimaryCategory> | Exclude<"locationUpdate", PrimaryCategory> | Exclude<"systemUpdate", PrimaryCategory> | Exclude<"activity", PrimaryCategory>, PrimaryCategory extends EventCategory | undefined = undefined, const ThumbnailIds extends Identifier[] = []>(this: any, args: {
title: Title;
description: Description;
startTime: StartTime;
endTime: EndTime;
universeId: UniverseId;
groupId: GroupId;
thumbnailIds?: ThumbnailIds | undefined;
primaryCategory?: PrimaryCategory | undefined;
secondaryCategory?: SecondaryCategory | undefined;
}) => Promise<{
data: {
id: Identifier;
title: Title;
displayTitle: string | null;
description: Description;
displayDescription: string | null;
eventTime: {
startUtc: Date;
endUtc: Date;
};
host: {
hostName: string;
hasVerifiedBadge: boolean;
hostType: "group";
hostId: GroupId;
};
universeId: UniverseId;
eventStatus: "unpublished";
createdUtc: Date;
updatedUtc: Date;
eventCategories: PrimaryCategory extends undefined ? null : [{
category: PrimaryCategory;
rank: 0;
}, ...(SecondaryCategory extends undefined ? null : {
category: SecondaryCategory;
rank: 1;
}) extends infer T ? T extends (SecondaryCategory extends undefined ? null : {
category: SecondaryCategory;
rank: 1;
}) ? T extends null ? [] : [T] : never : never];
thumbnails: ThumbnailIds["length"] extends 0 ? null : import("typeforge").UnionPrettify<import("typeforge").UnionToArray<{ [Idx in keyof (Exclude<keyof ThumbnailIds, number | typeof Symbol.iterator | typeof Symbol.unscopables | "length" | "toString" | "concat" | "indexOf" | "lastIndexOf" | "slice" | "includes" | "at" | "toLocaleString" | "join" | "every" | "some" | "forEach" | "map" | "filter" | "reduce" | "reduceRight" | "find" | "findIndex" | "entries" | "keys" | "values" | "flatMap" | "flat" | "pop" | "push" | "reverse" | "shift" | "sort" | "splice" | "unshift" | "fill" | "copyWithin"> extends infer T_1 extends keyof ThumbnailIds ? { [P in T_1]: ThumbnailIds[P]; } : never)]: {
mediaId: ThumbnailIds[Idx];
rank: Idx;
}; }[Exclude<keyof ThumbnailIds, number | typeof Symbol.iterator | typeof Symbol.unscopables | "length" | "toString" | "concat" | "indexOf" | "lastIndexOf" | "slice" | "includes" | "at" | "toLocaleString" | "join" | "every" | "some" | "forEach" | "map" | "filter" | "reduce" | "reduceRight" | "find" | "findIndex" | "entries" | "keys" | "values" | "flatMap" | "flat" | "pop" | "push" | "reverse" | "shift" | "sort" | "splice" | "unshift" | "fill" | "copyWithin">], []>[number]>[];
allThumbnailsCreated: boolean;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
id: Identifier;
title: Title;
displayTitle: string | null;
description: Description;
displayDescription: string | null;
eventTime: {
startUtc: StartTime;
endUtc: EndTime;
};
host: {
hostName: string;
hasVerifiedBadge: boolean;
hostType: "group";
hostId: GroupId;
};
universeId: UniverseId;
eventStatus: "unpublished";
createdUtc: `${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}`;
updatedUtc: `${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}`;
eventCategories: PrimaryCategory extends undefined ? null : [{
category: PrimaryCategory;
rank: 0;
}, ...(SecondaryCategory extends undefined ? null : {
category: SecondaryCategory;
rank: 1;
}) extends infer T ? T extends (SecondaryCategory extends undefined ? null : {
category: SecondaryCategory;
rank: 1;
}) ? T extends null ? [] : [T] : never : never];
thumbnails: ThumbnailIds["length"] extends 0 ? null : import("typeforge").UnionPrettify<import("typeforge").UnionToArray<{ [Idx in keyof (Exclude<keyof ThumbnailIds, number | typeof Symbol.iterator | typeof Symbol.unscopables | "length" | "toString" | "concat" | "indexOf" | "lastIndexOf" | "slice" | "includes" | "at" | "toLocaleString" | "join" | "every" | "some" | "forEach" | "map" | "filter" | "reduce" | "reduceRight" | "find" | "findIndex" | "entries" | "keys" | "values" | "flatMap" | "flat" | "pop" | "push" | "reverse" | "shift" | "sort" | "splice" | "unshift" | "fill" | "copyWithin"> extends infer T_1 extends keyof ThumbnailIds ? { [P in T_1]: ThumbnailIds[P]; } : never)]: {
mediaId: ThumbnailIds[Idx];
rank: Idx;
}; }[Exclude<keyof ThumbnailIds, number | typeof Symbol.iterator | typeof Symbol.unscopables | "length" | "toString" | "concat" | "indexOf" | "lastIndexOf" | "slice" | "includes" | "at" | "toLocaleString" | "join" | "every" | "some" | "forEach" | "map" | "filter" | "reduce" | "reduceRight" | "find" | "findIndex" | "entries" | "keys" | "values" | "flatMap" | "flat" | "pop" | "push" | "reverse" | "shift" | "sort" | "splice" | "unshift" | "fill" | "copyWithin">], []>[number]>[];
allThumbnailsCreated: boolean;
};
};
} & {
again: () => Promise<{
data: {
id: Identifier;
title: Title;
displayTitle: string | null;
description: Description;
displayDescription: string | null;
eventTime: {
startUtc: Date;
endUtc: Date;
};
host: {
hostName: string;
hasVerifiedBadge: boolean;
hostType: "group";
hostId: GroupId;
};
universeId: UniverseId;
eventStatus: "unpublished";
createdUtc: Date;
updatedUtc: Date;
eventCategories: PrimaryCategory extends undefined ? null : [{
category: PrimaryCategory;
rank: 0;
}, ...(SecondaryCategory extends undefined ? null : {
category: SecondaryCategory;
rank: 1;
}) extends infer T ? T extends (SecondaryCategory extends undefined ? null : {
category: SecondaryCategory;
rank: 1;
}) ? T extends null ? [] : [T] : never : never];
thumbnails: ThumbnailIds["length"] extends 0 ? null : import("typeforge").UnionPrettify<import("typeforge").UnionToArray<{ [Idx in keyof (Exclude<keyof ThumbnailIds, number | typeof Symbol.iterator | typeof Symbol.unscopables | "length" | "toString" | "concat" | "indexOf" | "lastIndexOf" | "slice" | "includes" | "at" | "toLocaleString" | "join" | "every" | "some" | "forEach" | "map" | "filter" | "reduce" | "reduceRight" | "find" | "findIndex" | "entries" | "keys" | "values" | "flatMap" | "flat" | "pop" | "push" | "reverse" | "shift" | "sort" | "splice" | "unshift" | "fill" | "copyWithin"> extends infer T_1 extends keyof ThumbnailIds ? { [P in T_1]: ThumbnailIds[P]; } : never)]: {
mediaId: ThumbnailIds[Idx];
rank: Idx;
}; }[Exclude<keyof ThumbnailIds, number | typeof Symbol.iterator | typeof Symbol.unscopables | "length" | "toString" | "concat" | "indexOf" | "lastIndexOf" | "slice" | "includes" | "at" | "toLocaleString" | "join" | "every" | "some" | "forEach" | "map" | "filter" | "reduce" | "reduceRight" | "find" | "findIndex" | "entries" | "keys" | "values" | "flatMap" | "flat" | "pop" | "push" | "reverse" | "shift" | "sort" | "splice" | "unshift" | "fill" | "copyWithin">], []>[number]>[];
allThumbnailsCreated: boolean;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
id: Identifier;
title: Title;
displayTitle: string | null;
description: Description;
displayDescription: string | null;
eventTime: {
startUtc: StartTime;
endUtc: EndTime;
};
host: {
hostName: string;
hasVerifiedBadge: boolean;
hostType: "group";
hostId: GroupId;
};
universeId: UniverseId;
eventStatus: "unpublished";
createdUtc: `${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}`;
updatedUtc: `${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}`;
eventCategories: PrimaryCategory extends undefined ? null : [{
category: PrimaryCategory;
rank: 0;
}, ...(SecondaryCategory extends undefined ? null : {
category: SecondaryCategory;
rank: 1;
}) extends infer T ? T extends (SecondaryCategory extends undefined ? null : {
category: SecondaryCategory;
rank: 1;
}) ? T extends null ? [] : [T] : never : never];
thumbnails: ThumbnailIds["length"] extends 0 ? null : import("typeforge").UnionPrettify<import("typeforge").UnionToArray<{ [Idx in keyof (Exclude<keyof ThumbnailIds, number | typeof Symbol.iterator | typeof Symbol.unscopables | "length" | "toString" | "concat" | "indexOf" | "lastIndexOf" | "slice" | "includes" | "at" | "toLocaleString" | "join" | "every" | "some" | "forEach" | "map" | "filter" | "reduce" | "reduceRight" | "find" | "findIndex" | "entries" | "keys" | "values" | "flatMap" | "flat" | "pop" | "push" | "reverse" | "shift" | "sort" | "splice" | "unshift" | "fill" | "copyWithin"> extends infer T_1 extends keyof ThumbnailIds ? { [P in T_1]: ThumbnailIds[P]; } : never)]: {
mediaId: ThumbnailIds[Idx];
rank: Idx;
}; }[Exclude<keyof ThumbnailIds, number | typeof Symbol.iterator | typeof Symbol.unscopables | "length" | "toString" | "concat" | "indexOf" | "lastIndexOf" | "slice" | "includes" | "at" | "toLocaleString" | "join" | "every" | "some" | "forEach" | "map" | "filter" | "reduce" | "reduceRight" | "find" | "findIndex" | "entries" | "keys" | "values" | "flatMap" | "flat" | "pop" | "push" | "reverse" | "shift" | "sort" | "splice" | "unshift" | "fill" | "copyWithin">], []>[number]>[];
allThumbnailsCreated: boolean;
};
};
}>;
}>;
/**
* DESCRIPTION
* @endpoint REST /...
*
* @param
*
* @example
* const { data:updatedEvent } = await ClassicVirtualEventsApi.updateEvent({
eventId: "7512531542949494927", title: "Event Name", description: "Description",
startTime: "2024-08-14T00:46:54.000Z", endTime: "2024-08-14T01:46:54.000Z",
primaryCategory: "contentUpdate", secondaryCategory: "locationUpdate"
})
* @exampleData {"isUpdated":true,"thumbnailsUpdated":false,"categoriesUpdated":true}
* @exampleRawBody {"isUpdated":true,"thumbnailsUpdated":false,"categoriesUpdated":true}
*/
export declare const updateEvent: <SecondaryCategory extends PrimaryCategory extends undefined ? undefined : Exclude<"contentUpdate", PrimaryCategory> | Exclude<"locationUpdate", PrimaryCategory> | Exclude<"systemUpdate", PrimaryCategory> | Exclude<"activity", PrimaryCategory>, PrimaryCategory extends EventCategory | undefined = undefined, const ThumbnailIds extends Identifier[] = [], _IsCategoriesUpdated extends boolean = Or<PrimaryCategory extends undefined ? false : true, SecondaryCategory extends undefined ? false : true>, _ThunbnailsUpdated extends boolean = ThumbnailIds["length"] extends 0 ? false : true>(this: any, args: {
eventId: Identifier;
title?: string | undefined;
description?: string | undefined;
startTime?: Date | `${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;
endTime?: Date | `${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;
thumbnailIds?: ThumbnailIds | undefined;
primaryCategory?: PrimaryCategory | undefined;
secondaryCategory?: SecondaryCategory | undefined;
}) => Promise<{
data: {
isUpdated: true;
thumbnailsUpdated: _ThunbnailsUpdated;
categoriesUpdated: _IsCategoriesUpdated;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
isUpdated: true;
thumbnailsUpdated: _ThunbnailsUpdated;
categoriesUpdated: _IsCategoriesUpdated;
};
};
} & {
again: () => Promise<{
data: {
isUpdated: true;
thumbnailsUpdated: _ThunbnailsUpdated;
categoriesUpdated: _IsCategoriesUpdated;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
isUpdated: true;
thumbnailsUpdated: _ThunbnailsUpdated;
categoriesUpdated: _IsCategoriesUpdated;
};
};
}>;
}>;
/**
* Publishes an event.
* @endpoint POST /v1/virtual-events/{eventId}/status
*
* @param eventId The ID of the event to update status for.
*
* @example const { data:success } = await ClassicVirtualEventsApi.publishEvent({ eventId: "6533473338141704368" })
* @exampleData { isUpdated: true }
* @exampleRawBody true
*/
export declare const publishEvent: import("../../apiGroup/apiGroup.types").CallApiMethod<{
eventId: 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: {
isUpdated: boolean;
}) => string) | undefined;
getCursorsFn?: ((rawData: {
isUpdated: boolean;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
isUpdated: boolean;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{
isUpdated: boolean;
}, boolean>, false>;
/**
* Gets rsvps for an event.
* @endpoint GET /v1/virtual-events/{eventId}/rsvps
*
* @param eventId The ID of the event to get rsvps for.
*
* @example const { data:rsvps } = await ClassicVirtualEventsApi.eventRsvps({ eventId: "5904751593700196492" })
* @exampleData [{"userId":45348281,"rsvpStatus":"going","shouldSeeNotificationsUpsellModal":false}]
* @exampleRawBody {"nextPageCursor":"","previousPageCursor":"","data":[{"userId":45348281,"rsvpStatus":"going","shouldSeeNotificationsUpsellModal":false}]}
*/
export declare const eventRsvps: import("../../apiGroup/apiGroup.types").CallApiMethod<{
eventId: Identifier;
limit?: 25 | 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: RawRsvpsData) => string) | undefined;
getCursorsFn?: ((rawData: {
nextPageCursor: string;
previousPageCursor: string;
data: PrettifiedRsvpsData;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
nextPageCursor: string;
previousPageCursor: string;
data: PrettifiedRsvpsData;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: {
userId: Identifier;
rsvpStatus: "none" | "going" | "maybeGoing" | "notGoing";
shouldSeeNotificationUpsellModel: boolean;
}[] | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawRsvpsData, PrettifiedRsvpsData>, true>;
/**
* Gets rsvp counters for an event.
* @endpoint GET /v1/virtual-events/{eventId}/rsvps/counters
*
* @param eventId The ID of the event to get rsvp counters for.
*
* @example const { data:counters } = await ClassicVirtualEventsApi.eventRsvpCounters({ eventId: "5904751593700196492" })
* @exampleData {"none":0,"going":1,"maybeGoing":0,"notGoing":0}
* @exampleRawBody {"counters":{"none":0,"going":1,"maybeGoing":0,"notGoing":0}}
*/
export declare const eventRsvpCounters: import("../../apiGroup/apiGroup.types").CallApiMethod<{
eventId: 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: RawRsvpCountersData) => string) | undefined;
getCursorsFn?: ((rawData: {
counters: PrettifiedRsvpCountersData;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
counters: PrettifiedRsvpCountersData;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: {
none: number;
going: number;
maybeGoing: number;
notGoing: number;
} | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawRsvpCountersData, PrettifiedRsvpCountersData>, false>;
/**
* Gets permissions for all events created by either a user or a group.
* @endpoint GET /v1/virtual-events/permissions
*
* @param userId Define a userId to get permissions for all events created by the user.
* @param groupId Define a groupId to get permissions for all events created by the group.
*
* @example const { data:permissions } = await ClassicVirtualEventsApi.authenticatedUserEventPermissionsForHost({ groupId: 15842838 })
* @exampleData {"maxPermissionLevel":"edit"}
* @exampleRawBody {"maxPermissionLevel":"edit"}
*/
export declare const authenticatedUserEventPermissionsForHost: import("../../apiGroup/apiGroup.types").CallApiMethod<ObjectEither<{