Class CalendarEventSeriesService

constructor

• new CalendarEventSeriesService(httpRequest): CalendarEventSeriesService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns CalendarEventSeriesService

Readonly httpRequest

calendarEventSeriesDelete

• calendarEventSeriesDelete(options): CancelablePromise<void>

• Delete a calendar event series

  Throws

  ApiError

  Parameters

  • options: {
        calendarEventSeriesId: string;
        channelId: string;
        requestBody?: {
            calendarEventId?: number;
        };
    }

    • calendarEventSeriesId: string

    • channelId: string

    • Optional requestBody?: {
          calendarEventId?: number;
      }

      • Optional calendarEventId?: number

        Control the deletion of the series from the calendarEventId forward. If not defined, it will delete all events

  Returns CancelablePromise<void>

  void

calendarEventSeriesUpdate

• calendarEventSeriesUpdate(options): CancelablePromise<void>

• Update a calendar event series

  Throws

  ApiError

  Parameters

  • options: {
        calendarEventSeriesId: string;
        channelId: string;
        requestBody: {
            autofillWaitlist?: boolean;
            calendarEventId?: number;
            color?: number;
            description?: string;
            duration?: number;
            isAllDay?: boolean;
            isPrivate?: boolean;
            location?: string;
            name?: string;
            repeatInfo?: {
                endDate?: string;
                endsAfterOccurrences?: number;
                every?: {
                    count: number;
                    interval: "day" | "month" | "year" | "week";
                };
                on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[];
                type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom";
            };
            roleIds?: number[];
            rsvpDisabled?: boolean;
            rsvpLimit?: number;
            startsAt?: string;
            url?: string;
        };
    }

    • calendarEventSeriesId: string

    • channelId: string

    • requestBody: {
          autofillWaitlist?: boolean;
          calendarEventId?: number;
          color?: number;
          description?: string;
          duration?: number;
          isAllDay?: boolean;
          isPrivate?: boolean;
          location?: string;
          name?: string;
          repeatInfo?: {
              endDate?: string;
              endsAfterOccurrences?: number;
              every?: {
                  count: number;
                  interval: "day" | "month" | "year" | "week";
              };
              on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[];
              type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom";
          };
          roleIds?: number[];
          rsvpDisabled?: boolean;
          rsvpLimit?: number;
          startsAt?: string;
          url?: string;
      }

      • Optional autofillWaitlist?: boolean

        When rsvpLimit is set, users from the waitlist will be added as space becomes available in the event

      • Optional calendarEventId?: number

        Control the updating of the series from the calendarEventId forward. If not defined, it will edit all events

      • Optional color?: number

        The integer value corresponds to the decimal RGB representation for the color. The color of the event when viewing in the calendar

      • Optional description?: string

        The description of the event

      • Optional duration?: number

        The duration of the event in minutes

      • Optional isAllDay?: boolean

        Does the event last all day? If passed with duration, duration will only be applied if it is an interval of minutes represented in days (e.g., duration: 2880)

      • Optional isPrivate?: boolean

      • Optional location?: string

        The location of the event

      • Optional name?: string

        The name of the event

      • Optional repeatInfo?: {
            endDate?: string;
            endsAfterOccurrences?: number;
            every?: {
                count: number;
                interval: "day" | "month" | "year" | "week";
            };
            on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[];
            type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom";
        }

        • Optional endDate?: string

          The ISO 8601 timestamp that the event ends at. Used to control the end date of the event repeat (only used when type is custom; if used with endsAfterOccurrences, the earliest resultant date of the two will be used)

        • Optional endsAfterOccurrences?: number

          Used to control the end date of the event repeat (only used when type is custom; if used with endDate, the earliest resultant date of the two will be used)

        • Optional every?: {
              count: number;
              interval: "day" | "month" | "year" | "week";
          }

          Apply further clarification to your events. This must have type set to custom

          • count: number

            How often between your interval the event should repeat. For example, 1 would be every interval, 2 would be every second occurrence of the interval

          • interval: "day" | "month" | "year" | "week"

            Coupled with count, this indicates the time range you are repeating your event over

        • Optional on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[]

          Used to control the day of the week that the event should repeat on (only used when type is custom and when every.interval is week)

        • type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom"

          How often you want your event to repeat (important note: this will repeat for the next 180 days unless custom is defined)

      • Optional roleIds?: number[]

        The role IDs to restrict the event to. Passing an empty array will clear the role IDs on the event

      • Optional rsvpDisabled?: boolean

        When disabled, users will not be able to RSVP to the event

      • Optional rsvpLimit?: number

        The number of RSVPs to allow before waitlisting RSVPs

      • Optional startsAt?: string

        The ISO 8601 timestamp that the event starts at

      • Optional url?: string

        A URL to associate with the event

  Returns CancelablePromise<void>

  void