Class CallRequests

Collection of requests related to X Calls.

Index

Constructors

Methods

cancel create customize linkedCalendars list refreshCalendars reminder rsvp schedule searchPeople unlinkCalendar update userAvailability

Constructors

constructor

new CallRequests(): CallRequests
Returns CallRequests

Methods

`Static`cancel

cancel(id: string, options?: ICallOccurrenceOptions): AxiosRequestConfig
Parameters
- id: string
  The id of the scheduled call to cancel.
- Optionaloptions: ICallOccurrenceOptions
  The occurrence(s) of the scheduled call to cancel.
Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:75

`Static`create

create(audioOnly?: boolean): AxiosRequestConfig
Parameters
- OptionalaudioOnly: boolean
  Whether the call is audio-only.
Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:87

`Static`customize

customize(
    id: string,
    customization: ICallCustomization,
    options?: ICallOccurrenceOptions,
): AxiosRequestConfig
Parameters
- id: string
  The id of the scheduled call to customize.
- customization: ICallCustomization
  The customization to apply.
- Optionaloptions: ICallOccurrenceOptions
  The occurrence(s) of the scheduled call to customize.
Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:98

`Static`linkedCalendars

linkedCalendars(): AxiosRequestConfig
Lists the external calendars linked to X Calls.

Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:121

`Static`list

list(fromTime: Date, toTime: Date): AxiosRequestConfig
Parameters
- fromTime: Date
  The start of the time window.
- toTime: Date
  The end of the time window.
Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:130

`Static`refreshCalendars

refreshCalendars(fromTime: Date, toTime: Date): AxiosRequestConfig
Parameters
- fromTime: Date
  The start of the time window.
- toTime: Date
  The end of the time window.
Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:141

`Static`reminder

reminder(
    id: string,
    minutes: number,
    options?: ICallOccurrenceOptions,
): AxiosRequestConfig
Parameters
- id: string
  The id of the scheduled call.
- minutes: number
  The number of minutes before the call at which to be reminded.
- Optionaloptions: ICallOccurrenceOptions
  The occurrence(s) of the scheduled call to set the reminder for.
Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:153

`Static`rsvp

rsvp(
    id: string,
    status: CallRsvpStatus,
    options?: ICallOccurrenceOptions,
): AxiosRequestConfig
Parameters
- id: string
  The id of the scheduled call.
- status: CallRsvpStatus
  The RSVP status to respond with.
- Optionaloptions: ICallOccurrenceOptions
  The occurrence(s) of the scheduled call to respond to.
Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:169

`Static`schedule

schedule(call: INewCall): AxiosRequestConfig
Parameters
- call: INewCall
  The call to schedule.
Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:183

`Static`searchPeople

searchPeople(query: string, count?: number): AxiosRequestConfig
Parameters
- query: string
  The search query.
- Optionalcount: number
  The maximum number of users to fetch.
Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:210

`Static`unlinkCalendar

unlinkCalendar(provider: CalendarProvider): AxiosRequestConfig
Parameters
- provider: CalendarProvider
  The provider of the external calendar to unlink.
Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:220

`Static`update

update(
    id: string,
    updates: ICallUpdates,
    options?: ICallOccurrenceOptions,
): AxiosRequestConfig
Parameters
- id: string
  The id of the scheduled call to update.
- updates: ICallUpdates
  The updates to apply.
- Optionaloptions: ICallOccurrenceOptions
  The occurrence(s) of the scheduled call to update.
Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:231

`Static`userAvailability

userAvailability(id: string, fromTime: Date, toTime: Date): AxiosRequestConfig
Parameters
- id: string
  The id of the user whose shared calendar is to be fetched.
- fromTime: Date
  The start of the time window.
- toTime: Date
  The end of the time window.
Returns AxiosRequestConfig
- Defined in src/requests/Call.ts:259