guilded-api-typings/dist/structures/CalendarEvent.d.ts

Type definitions for the Guilded API.

import { APIMentions } from './Channel';
/**
 * Represents a calendar event on Guilded.
 * @see https://www.guilded.gg/docs/api/calendarEvents/CalendarEvent
 */
export interface APICalendarEvent {
    /** The ID of the calendar event. */
    id: number;
    /** The ID of the server the calendar event belongs to. */
    serverId: string;
    /** The ID of the channel the calendar event belongs to. */
    channelId: string;
    /** The name of the calendar event. */
    name: string;
    /** The description of the calendar event. */
    description?: string;
    /** The location of the calendar event. */
    location?: string;
    /** The url of the calendar event. */
    url?: string;
    /** The color of the calendar event. */
    color?: number;
    /** The limit of RSVPs of the calendar event. */
    rsvpLimit?: number;
    /** The date the calendar event starts. */
    startsAt: string;
    /** The duration of the calendar event. */
    duration?: number;
    /** Whether the calendar event is private. */
    isPrivate?: boolean;
    /** The mentions of the calendar event. */
    mentions?: APIMentions;
    /** The date the calendar event was created. */
    createdAt: string;
    /** The ID of the user that created the calendar event. */
    createdBy: string;
    /** The cancellation of the calendar event. */
    cancellation?: APICalendarEventCancellation;
}
/**
 * Represents a calendar event cancellation on Guilded.
 * @see https://www.guilded.gg/docs/api/calendarEvents/CalendarEvent
 */
export interface APICalendarEventCancellation {
    /** The description of the cancellation. */
    description?: string;
    /** The ID of the user that created the cancellation. */
    createdBy?: string;
}
/**
 * The payload for creating a calendar event.
 * @see https://www.guilded.gg/docs/api/calendarEvents/CalendarEventCreate
 */
export interface APICalendarEventPayload {
    /** The name of the calendar event. */
    name: string;
    /** The description of the calendar event. */
    description?: string;
    /** The location of the calendar event. */
    location?: string;
    /** The date the calendar event starts. */
    startsAt?: Date;
    /** The url of the calendar event. */
    url?: string;
    /** The color of the calendar event. */
    color?: number;
    /** The limit of RSVPs of the calendar event. */
    rsvpLimit?: number;
    /** The duration of the calendar event. */
    duration?: number;
    /** Whether the calendar event is private. */
    isPrivate?: boolean;
}
/**
 * The payload for editing a calendar event.
 * @see https://www.guilded.gg/docs/api/calendarEvents/CalendarEventUpdate
 */
export declare type APICalendarEventEditPayload = Partial<APICalendarEventPayload>;
/**
 * The options for fetching calendar events.
 * @see https://www.guilded.gg/docs/api/calendarEvents/CalendarEventReadMany
 */
export interface APICalendarEventFetchManyOptions {
    /** The date to fetch calendar events before. */
    before?: Date;
    /** The date to fetch calendar events after. */
    after?: Date;
    /** The maximum number of calendar events to fetch. */
    limit?: number;
}
/**
 * Represents a calendar event RSVP on Guilded.
 * @see https://www.guilded.gg/docs/api/calendarEvents/CalendarEventRsvp
 */
export interface APICalendarEventRsvp {
    /** The ID of the calendar event. */
    calendarEventId: number;
    /** The ID of the channel the RSVP belongs to. */
    channelId: string;
    /** The ID of the server the RSVP belongs to. */
    serverId: string;
    /** The ID of the user the RSVP belongs to. */
    userId: string;
    /** The status of the RSVP. */
    status: CalendarEventRsvpStatus;
    /** The ID of the user that created the RSVP. */
    createdBy: string;
    /** The date the RSVP was created. */
    createdAt: string;
    /** The ID of the user that edited the RSVP. */
    updatedBy?: string;
    /** The date the RSVP was edited. */
    updatedAt?: string;
}
/**
 * The status of a calendar event RSVP.
 * @see https://www.guilded.gg/docs/api/calendarEvents/CalendarEventRsvp
 */
export declare enum CalendarEventRsvpStatus {
    Going = "going",
    Maybe = "maybe",
    Declined = "declined",
    Invited = "invited",
    Waitlisted = "waitlisted"
}
/**
 * The payload for editing a calendar event RSVP.
 * @see https://www.guilded.gg/docs/api/calendarEvents/CalendarEventRsvpUpdate
 */
export interface APICalendarEventRsvpEditPayload {
    /** The status of the RSVP. */
    status: CalendarEventRsvpStatus;
}
//# sourceMappingURL=CalendarEvent.d.ts.map