@blazeo.com/calendar-client 1.0.18 → 1.0.19

package/dist/index.d.ts

@@ -1,200 +1,236 @@
-/** @blazeo.com/calendar-client - type declarations */
-
-export function configure(env: { baseUrl?: string; consumer?: string; fetch?: typeof fetch; getDefaultOffset?: () => number }): void;
-export function getConfig(): { baseUrl?: string; consumer?: string; fetch?: typeof fetch; getDefaultOffset?: () => number } | null;
-export function setBaseUrl(baseUrl: string): void;
-export function setConsumer(consumer: string): void;
-export function getConfigStore(): unknown;
-
-export const ConfigModel: unknown;
-
-export const CalendarModel: {
-  get(calendarId: string): Promise<unknown>;
-  getRaw(calendarId: string): Promise<{ status: string; data?: unknown; message?: string }>;
-  getByCompany(
-    companyKey: string,
-    opts?: {
-      skip?: number;
-      take?: number;
-      /** Maps to API query `sort`. */
-      sortBy?: string;
-      /** Maps to API query `sort_dir` (`asc` / `desc`). */
-      sortOrder?: 'ASC' | 'DESC' | 'asc' | 'desc' | string;
-      /** Same as `sortBy` (sent as `sort` on the wire). */
-      sort?: string;
-      sort_column?: string;
-      /** Same as `sortOrder` (sent as `sort_dir` on the wire). */
-      sort_dir?: 'asc' | 'desc' | string;
-      page?: number;
-      page_size?: number;
-    }
-  ): Promise<{ calendars: unknown[]; totalCount: number } | null>;
-  getTimeZones(): Promise<unknown>;
-  getTimeZone(timezoneId: string): Promise<unknown>;
-  getParticipants(calendarId: string): Promise<unknown>;
-  getAllParticipantOpeningHours(calendarId: string): Promise<unknown[] | null>;
-  getCalendarParticipant(calendarId: string): Promise<unknown>;
-  getParticipantsInfo(calendarId: string): Promise<unknown>;
-  getMonth(calendarId: string, year: number, month: number): Promise<unknown>;
-  getEvents(calendarId: string): Promise<unknown>;
-  createWithParticipants(name: string, companyKey: string, participantIds: string[], description: string, calendarId?: string): Promise<unknown>;
-  editWithParticipants(calendarId: string, name: string, participantIds: string[], description: string): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-
-export const EventModel: {
-  get(eventId: string): Promise<unknown>;
-  getByExternalId(externalEventId: string): Promise<unknown>;
-  getRoundRobinParticipant(calendarId: string): Promise<unknown>;
-  getEarliestAvailableDays(calendarId: string, count: number, opts?: { year?: number; month?: number; day?: number; offset?: number }): Promise<string[] | null>;
-  getDaySelectable(calendarId: string, year: number, month: number, day: number, opts?: { participantId?: string; offset?: number }): Promise<boolean>;
-  getByVisitorEmail(email: string, opts: { companyKey?: string; calendarId?: string; offset?: number }): Promise<unknown[] | null>;
-  getByVisitorPhone(phone: string, opts: { companyKey?: string; calendarId?: string; offset?: number }): Promise<unknown[] | null>;
-  getAvailability(calendarId: string, year: number, month: number, day: number, opts?: { participantId?: string; offset?: number }): Promise<unknown[]>;
-  getExternalUnavailability(
-    participantId: string,
-    opts?:
-      | { startUtc: string; endUtc: string; offset?: number }
-      | { year: number; month: number; day: number; days?: number; offset?: number }
-  ): Promise<unknown[]>;
-  cancel(eventId: string): Promise<unknown>;
-  getCancellable(eventId: string): Promise<boolean>;
-  createEvent(payload: object, offsetMinutes?: number): Promise<unknown>;
-  reschedule(payload: object, offsetMinutes?: number): Promise<unknown>;
-  updateEvent(payload: object): Promise<unknown>;
-  createTest(payload: object, offsetMinutes?: number): Promise<unknown>;
-  getCustomData(calendarId: string, eventId?: string): Promise<unknown>;
-  setReminder(eventId: string): Promise<unknown>;
-  setAttendeeStatus(eventId: string, attendeeStatus: number | string): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-
-export const AvailabilityModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const AvailabilityDetailModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const CalendarParticipantModel: {
-  getByCalendar(calendarId: string): Promise<unknown[] | null>;
-  getInfoByCalendar(calendarId: string): Promise<unknown[] | null>;
-  getByParticipant(participantId: string): Promise<unknown[] | null>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-export const ParticipantModel: {
-  get(participantId: string): Promise<unknown>;
-  getByIds(participantIds: string[] | string): Promise<unknown[] | null>;
-  getAll(companyKey: string): Promise<unknown[] | null>;
-  add(payload: object, calendarId?: string): Promise<unknown>;
-  remove(participantId: string): Promise<unknown>;
-  update(payload: object): Promise<unknown>;
-  save(payload: object): Promise<unknown>;
-  sendEmail(participantId: string): Promise<unknown>;
-  migrate(participantId: string, userId: string): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-export const OpeningHourModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const TimeSlotModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const TimeFrameModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const SettingModel: {
-  get(calendarId: string): Promise<unknown>;
-  save(payload: object): Promise<unknown>;
-  uploadLogo(calendarId: string, file: File | Blob): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-export const CompanyModel: {
-  get(companyKey: string): Promise<unknown>;
-  getAll(): Promise<unknown[] | null>;
-  save(payload: object): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-export const CalendarDayModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const ParticipantInfoModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const PreferenceModel: {
-  getScopes(): Promise<string[] | null>;
-  getOptions(): Promise<string[] | null>;
-  getOptionTemplate(option: string): Promise<unknown>;
-  get(option: string, keys: string | string[]): Promise<unknown>;
-  set(scope: string, key: string, option: string, body: string | object): Promise<unknown>;
-  delete(preferenceId: string): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-export const PreferenceScope: Record<string, number>;
-
-export const FlowModel: {
-  getRaw(flowId: string): Promise<{ status: string; data?: unknown; message?: string }>;
-  list(companyKey: string, includeDeleted?: boolean): Promise<unknown[] | null>;
-  get(flowId: string): Promise<unknown>;
-  createFlow(payload: object): Promise<unknown>;
-  updateFlow(payload: object): Promise<unknown>;
-  delete(flowId: string): Promise<unknown>;
-  duplicate(flowId: string, newName?: string): Promise<unknown>;
-  getAppearance(flowId: string): Promise<unknown>;
-  saveAppearance(payload: object): Promise<unknown>;
-  getEmbed(flowId: string): Promise<unknown>;
-  saveEmbed(payload: object): Promise<unknown>;
-  getPublic(flowId: string): Promise<{ flow: unknown; appearance: unknown; embed: unknown } | null>;
-  getPreview(flowId: string): Promise<{ flow: unknown; appearance: unknown; embed: unknown } | null>;
-  /** Empty snapshot is valid: `FlowModel.create({}, { env })` after configure() */
-  create(snapshot?: object, options?: { env?: object }): unknown;
-};
-
-export const LeadModel: {
-  getRaw(leadId: string): Promise<{ status: string; data?: unknown; message?: string }>;
-  get(leadId: string): Promise<unknown>;
-  getByEmail(email: string, companyKey: string): Promise<unknown>;
-  createLead(payload: {
-    email: string;
-    companyKey: string;
-    name?: string;
-    phone?: string;
-    source?: string;
-    leadType?: 'sales' | 'service' | 'others' | number;
-    referrerLink?: string;
-  }): Promise<unknown>;
-  updateLead(payload: {
-    leadId: string;
-    email?: string;
-    companyKey?: string;
-    name?: string;
-    phone?: string;
-    source?: string;
-    leadType?: 'sales' | 'service' | 'others' | number;
-    referrerLink?: string;
-  }): Promise<unknown>;
-  deleteLead(leadId: string): Promise<{ status: string; data?: unknown; message?: string }>;
-  requestExport(
-    companyKey: string,
-    opts?: {
-      notifyPath?: string;
-      notify_path?: string;
-      consumer?: string;
-      Consumer?: string;
-    }
-  ): Promise<{ status: string; data?: unknown; message?: string }>;
-  getByCompany(
-    companyKey: string,
-    opts?: {
-      skip?: number;
-      take?: number;
-      /** Maps to API query `sort`. */
-      sortBy?: string;
-      /** Maps to API query `sort_dir` (`asc` / `desc`). */
-      sortOrder?: 'ASC' | 'DESC' | 'asc' | 'desc' | string;
-      /** Same as `sortBy` (sent as `sort` on the wire). */
-      sort?: string;
-      sort_column?: string;
-      /** Same as `sortOrder` (sent as `sort_dir` on the wire). */
-      sort_dir?: 'asc' | 'desc' | string;
-      page?: number;
-      page_size?: number;
-    }
-  ): Promise<unknown[] | null>;
-  /** Empty snapshot is valid: `LeadModel.create({}, { env })` after configure() */
-  create(snapshot?: object, options?: { env?: object }): unknown;
-};
-
-export const RootStore: unknown;
-export function createRootStore(initialState?: object): unknown;
-
-export const Unit: Record<string, number>;
-export const AssignmentMethod: Record<string, number>;
-export const AttendeeStatus: Record<string, number>;
-export const RecurringFrequency: Record<string, number>;
-export const DayOfWeek: Record<string, number>;
+/** @blazeo.com/calendar-client - type declarations */
+
+export function configure(env: { baseUrl?: string; consumer?: string; fetch?: typeof fetch; getDefaultOffset?: () => number }): void;
+export function getConfig(): { baseUrl?: string; consumer?: string; fetch?: typeof fetch; getDefaultOffset?: () => number } | null;
+export function setBaseUrl(baseUrl: string): void;
+export function setConsumer(consumer: string): void;
+export function getConfigStore(): unknown;
+
+export const ConfigModel: unknown;
+
+export const CalendarModel: {
+  get(calendarId: string): Promise<unknown>;
+  getRaw(calendarId: string): Promise<{ status: string; data?: unknown; message?: string }>;
+  getByCompany(
+    companyKey: string,
+    opts?: {
+      skip?: number;
+      take?: number;
+      /** Maps to API query `sort`. */
+      sortBy?: string;
+      /** Maps to API query `sort_dir` (`asc` / `desc`). */
+      sortOrder?: 'ASC' | 'DESC' | 'asc' | 'desc' | string;
+      /** Same as `sortBy` (sent as `sort` on the wire). */
+      sort?: string;
+      sort_column?: string;
+      /** Same as `sortOrder` (sent as `sort_dir` on the wire). */
+      sort_dir?: 'asc' | 'desc' | string;
+      page?: number;
+      page_size?: number;
+    }
+  ): Promise<{ calendars: unknown[]; totalCount: number } | null>;
+  getTimeZones(): Promise<unknown>;
+  getTimeZone(timezoneId: string): Promise<unknown>;
+  getParticipants(calendarId: string): Promise<unknown>;
+  getAllParticipantOpeningHours(calendarId: string): Promise<unknown[] | null>;
+  getCalendarParticipant(calendarId: string): Promise<unknown>;
+  getParticipantsInfo(calendarId: string): Promise<unknown>;
+  getMonth(calendarId: string, year: number, month: number): Promise<unknown>;
+  getEvents(calendarId: string): Promise<unknown>;
+  createWithParticipants(name: string, companyKey: string, participantIds: string[], description: string, calendarId?: string): Promise<unknown>;
+  editWithParticipants(calendarId: string, name: string, participantIds: string[], description: string): Promise<unknown>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+
+export const EventModel: {
+  get(eventId: string): Promise<unknown>;
+  getByExternalId(externalEventId: string): Promise<unknown>;
+  getRoundRobinParticipant(calendarId: string): Promise<unknown>;
+  getEarliestAvailableDays(calendarId: string, count: number, opts?: { year?: number; month?: number; day?: number; offset?: number }): Promise<string[] | null>;
+  getDaySelectable(calendarId: string, year: number, month: number, day: number, opts?: { participantId?: string; offset?: number }): Promise<boolean>;
+  getByVisitorEmail(email: string, opts: { companyKey?: string; calendarId?: string; offset?: number }): Promise<unknown[] | null>;
+  getByVisitorPhone(phone: string, opts: { companyKey?: string; calendarId?: string; offset?: number }): Promise<unknown[] | null>;
+  getAvailability(calendarId: string, year: number, month: number, day: number, opts?: { participantId?: string; offset?: number }): Promise<unknown[]>;
+  getExternalUnavailability(
+    participantId: string,
+    opts?:
+      | { startUtc: string; endUtc: string; offset?: number }
+      | { year: number; month: number; day: number; days?: number; offset?: number }
+  ): Promise<unknown[]>;
+  cancel(eventId: string): Promise<unknown>;
+  getCancellable(eventId: string): Promise<boolean>;
+  createEvent(payload: object, offsetMinutes?: number): Promise<unknown>;
+  reschedule(payload: object, offsetMinutes?: number): Promise<unknown>;
+  updateEvent(payload: object): Promise<unknown>;
+  createTest(payload: object, offsetMinutes?: number): Promise<unknown>;
+  getCustomData(calendarId: string, eventId?: string): Promise<unknown>;
+  setReminder(eventId: string): Promise<unknown>;
+  setAttendeeStatus(eventId: string, attendeeStatus: number | string): Promise<unknown>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+
+export const AvailabilityModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const AvailabilityDetailModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const CalendarParticipantModel: {
+  getByCalendar(calendarId: string): Promise<unknown[] | null>;
+  getInfoByCalendar(calendarId: string): Promise<unknown[] | null>;
+  getByParticipant(participantId: string): Promise<unknown[] | null>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+export const ParticipantModel: {
+  get(participantId: string): Promise<unknown>;
+  getByIds(participantIds: string[] | string): Promise<unknown[] | null>;
+  getAll(companyKey: string): Promise<unknown[] | null>;
+  add(payload: object, calendarId?: string): Promise<unknown>;
+  remove(participantId: string): Promise<unknown>;
+  update(payload: object): Promise<unknown>;
+  save(payload: object): Promise<unknown>;
+  sendEmail(participantId: string): Promise<unknown>;
+  migrate(participantId: string, userId: string): Promise<unknown>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+export const OpeningHourModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const TimeSlotModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const TimeFrameModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const SettingModel: {
+  get(calendarId: string): Promise<unknown>;
+  save(payload: object): Promise<unknown>;
+  uploadLogo(calendarId: string, file: File | Blob): Promise<unknown>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+export const CompanyModel: {
+  get(companyKey: string): Promise<unknown>;
+  getAll(): Promise<unknown[] | null>;
+  save(payload: object): Promise<unknown>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+export const AssetModel: {
+  upload(
+    file: File | Blob,
+    opts: {
+      category: string;
+      companyKey?: string;
+      calendarId?: string;
+      consumer?: string;
+    }
+  ): Promise<{ status: string; data?: unknown; message?: string }>;
+  create(
+    snapshot?: {
+      url?: string | null;
+      blobPath?: string | null;
+      category?: string | null;
+      contentType?: string | null;
+      size?: number | null;
+    },
+    options?: { env?: object }
+  ): unknown;
+};
+export const CalendarDayModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const ParticipantInfoModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const PreferenceModel: {
+  getScopes(): Promise<string[] | null>;
+  getOptions(): Promise<string[] | null>;
+  getOptionTemplate(option: string): Promise<unknown>;
+  get(option: string, keys: string | string[]): Promise<unknown>;
+  set(scope: string, key: string, option: string, body: string | object): Promise<unknown>;
+  delete(preferenceId: string): Promise<unknown>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+export const PreferenceScope: Record<string, number>;
+
+export const FlowModel: {
+  getRaw(flowId: string): Promise<{ status: string; data?: unknown; message?: string }>;
+  list(companyKey: string, includeDeleted?: boolean): Promise<unknown[] | null>;
+  get(flowId: string): Promise<unknown>;
+  createFlow(payload: object): Promise<unknown>;
+  updateFlow(payload: object): Promise<unknown>;
+  delete(flowId: string): Promise<unknown>;
+  duplicate(flowId: string, newName?: string): Promise<unknown>;
+  getAppearance(flowId: string): Promise<unknown>;
+  saveAppearance(payload: object): Promise<unknown>;
+  getEmbed(flowId: string): Promise<unknown>;
+  saveEmbed(payload: object): Promise<unknown>;
+  getPublic(flowId: string): Promise<{ flow: unknown; appearance: unknown; embed: unknown } | null>;
+  getPreview(flowId: string): Promise<{ flow: unknown; appearance: unknown; embed: unknown } | null>;
+  /** Empty snapshot is valid: `FlowModel.create({}, { env })` after configure() */
+  create(snapshot?: object, options?: { env?: object }): unknown;
+};
+
+export const LeadModel: {
+  getRaw(leadId: string): Promise<{ status: string; data?: unknown; message?: string }>;
+  get(leadId: string): Promise<unknown>;
+  getByEmail(email: string, companyKey: string): Promise<unknown>;
+  createLead(payload: {
+    email: string;
+    companyKey: string;
+    name?: string;
+    phone?: string;
+    source?: string;
+    leadType?: 'sales' | 'service' | 'others' | number;
+    referrerLink?: string;
+  }): Promise<unknown>;
+  updateLead(payload: {
+    leadId: string;
+    email?: string;
+    companyKey?: string;
+    name?: string;
+    phone?: string;
+    source?: string;
+    leadType?: 'sales' | 'service' | 'others' | number;
+    referrerLink?: string;
+  }): Promise<unknown>;
+  deleteLead(leadId: string): Promise<{ status: string; data?: unknown; message?: string }>;
+  requestExport(
+    companyKey: string,
+    opts?: {
+      notifyPath?: string;
+      notify_path?: string;
+      consumer?: string;
+      Consumer?: string;
+    }
+  ): Promise<{ status: string; data?: unknown; message?: string }>;
+  getByCompany(
+    companyKey: string,
+    opts?: {
+      skip?: number;
+      take?: number;
+      /** Maps to API query `sort`. */
+      sortBy?: string;
+      /** Maps to API query `sort_dir` (`asc` / `desc`). */
+      sortOrder?: 'ASC' | 'DESC' | 'asc' | 'desc' | string;
+      /** Same as `sortBy` (sent as `sort` on the wire). */
+      sort?: string;
+      sort_column?: string;
+      /** Same as `sortOrder` (sent as `sort_dir` on the wire). */
+      sort_dir?: 'asc' | 'desc' | string;
+      page?: number;
+      page_size?: number;
+    }
+  ): Promise<unknown[] | null>;
+  /** Empty snapshot is valid: `LeadModel.create({}, { env })` after configure() */
+  create(snapshot?: object, options?: { env?: object }): unknown;
+};
+
+export const CustomFieldModel: {
+  getAll(calendarId: string): Promise<unknown[] | null>;
+  getFieldType(fieldType: string): Promise<unknown>;
+  getFieldTypes(): Promise<unknown>;
+  add(payload: object): Promise<unknown>;
+  removeField(customFieldId: string): Promise<unknown>;
+  removeAllFields(calendarId: string): Promise<unknown>;
+  getForm(calendarId: string, dataId?: string): Promise<unknown>;
+  saveForm(calendarId: string, fields: unknown[]): Promise<unknown>;
+  getFormData(calendarId: string, dataId?: string): Promise<unknown>;
+  saveFormData(dataId: string, fields: unknown[]): Promise<unknown>;
+  saveFormFieldData(fieldPayload: object): Promise<unknown>;
+  create(snapshot?: object, options?: { env?: object }): unknown;
+};
+
+export const RootStore: unknown;
+export function createRootStore(initialState?: object): unknown;
+
+export const Unit: Record<string, number>;
+export const AssignmentMethod: Record<string, number>;
+export const AttendeeStatus: Record<string, number>;
+export const RecurringFrequency: Record<string, number>;
+export const DayOfWeek: Record<string, number>;