@squidcloud/google-calendar-client 1.0.407

package/dist/common/src/google-calendar-types.d.ts

@@ -0,0 +1,150 @@
+/**
+ * OAuth2 scopes (ie level of access) required for Google Calendar integration.
+ * Use these scopes when requesting the OAuth2 auth code from Google. Provided here for convenience only.
+ *
+ */
+export declare const GOOGLE_CALENDAR_SCOPES: readonly ["openid", "email", "https://www.googleapis.com/auth/calendar.events"];
+/**
+ * Request to exchange a Google OAuth2 authorization code for access and refresh tokens, which are then saved in the
+ * Squid backend for future use.
+ * This is called after the user completes the Google OAuth flow and receives an authorization code.
+ */
+export interface SaveAuthCodeRequest {
+    /**
+     * OAuth2 authorization code received from Google after user consent.
+     * This is a one-time use code that can be exchanged for access/refresh tokens.
+     */
+    authCode: string;
+    /** The ID of the Google Calendar integration in the Squid console. */
+    integrationId: string;
+    /**
+     * User-specific identifier to associate the tokens with a particular user.
+     * This identifier will be used later to retrieve the correct tokens for API calls.
+     */
+    identifier: string;
+}
+/**
+ * Represents an attendee of a calendar event
+ */
+export interface CalendarEventAttendee {
+    email: string;
+    status: string;
+}
+/**
+ * Represents a formatted calendar event with all relevant details
+ */
+export interface CalendarEvent {
+    id: string;
+    summary: string;
+    description?: string;
+    start: string;
+    end: string;
+    location?: string;
+    attendees?: Array<CalendarEventAttendee>;
+    htmlLink?: string;
+}
+/**
+ * Request parameters for retrieving calendar events
+ */
+export interface GetCalendarEventsRequest {
+    /** The ID of the Google Calendar integration in the Squid console. */
+    integrationId: string;
+    /**
+     * User-specific identifier to retrieve the correct OAuth tokens.
+     */
+    identifier: string;
+    /** Start date for the event query. Defaults to today. */
+    startDate?: Date;
+    /** End date for the event query. Defaults to 7 days from start. */
+    endDate?: Date;
+    /** Maximum number of events to return. Defaults to 50. */
+    maxResults?: number;
+    /** Calendar ID to query. Defaults to "primary". */
+    calendarId?: string;
+}
+/**
+ * Attendee information for a calendar event
+ */
+export interface EventAttendee {
+    /** Email address of the attendee */
+    email: string;
+    /** Display name of the attendee (optional) */
+    displayName?: string;
+}
+/**
+ * Event reminder/notification
+ */
+export interface EventReminder {
+    /** Reminder method: 'email' or 'popup' */
+    method: 'email' | 'popup';
+    /** Number of minutes before the event when the reminder should trigger */
+    minutes: number;
+}
+/**
+ * Recurrence rule frequency
+ */
+export type RecurrenceFrequency = 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY';
+/**
+ * Recurrence rule for repeating events
+ */
+export interface RecurrenceRule {
+    /** How often the event repeats */
+    frequency: RecurrenceFrequency;
+    /** Number of occurrences after which to stop repeating. Mutually exclusive with until. */
+    count?: number;
+    /** Date until which the event repeats. Mutually exclusive with count. */
+    until?: Date;
+    /** Interval between recurrences (e.g., every 2 weeks). Defaults to 1. */
+    interval?: number;
+    /** For WEEKLY frequency, which days of the week (e.g., ['MO', 'WE', 'FR']). */
+    byDay?: Array<'MO' | 'TU' | 'WE' | 'TH' | 'FR' | 'SA' | 'SU'>;
+}
+/**
+ * Event visibility settings
+ */
+export type EventVisibility = 'default' | 'public' | 'private';
+/**
+ * Request parameters for upserting (creating or updating) a calendar event
+ */
+export interface UpsertCalendarEventRequest {
+    /** The ID of the Google Calendar integration in the Squid console. */
+    integrationId: string;
+    /**
+     * User-specific identifier to retrieve the correct OAuth tokens.
+     */
+    identifier: string;
+    /** Event ID for updating an existing event. If not provided, creates a new event. */
+    eventId?: string;
+    /** Calendar ID where the event should be created/updated. Defaults to "primary". */
+    calendarId?: string;
+    /** Title/summary of the event (required) */
+    summary: string;
+    /** Detailed description of the event (optional) */
+    description?: string;
+    /** Event start time. For all-day events, use date without time. */
+    start: Date;
+    /** Event end time. For all-day events, use date without time. */
+    end: Date;
+    /** Whether this is an all-day event. If true, start/end are treated as dates only. */
+    isAllDay?: boolean;
+    /** Geographic location of the event as free-form text (optional) */
+    location?: string;
+    /** List of attendees to invite to the event (optional) */
+    attendees?: Array<EventAttendee>;
+    /** Timezone for the event (e.g., "America/Los_Angeles"). Defaults to user's calendar timezone. */
+    timeZone?: string;
+    /** Add Google Meet video conferencing to the event. If true, creates a Google Meet link. */
+    addMeetLink?: boolean;
+    /** List of reminders/notifications for the event (optional) */
+    reminders?: Array<EventReminder>;
+    /** Recurrence rule for repeating events (optional) */
+    recurrence?: RecurrenceRule;
+    /** Visibility of the event. Defaults to "default". */
+    visibility?: EventVisibility;
+    /** Whether guests can modify the event. Defaults to false. */
+    guestsCanModify?: boolean;
+    /** Whether guests can invite others. Defaults to true. */
+    guestsCanInviteOthers?: boolean;
+    /** Whether guests can see other guests. Defaults to true. */
+    guestsCanSeeOtherGuests?: boolean;
+}