wxc_sdk.me.schedules package

class wxc_sdk.me.schedules.MeSchedulesApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

get_location_schedule(schedule_type: ScheduleType, schedule_id: str) → Schedule[source]

Get User’s Location Level Schedule

Get Location Schedule for Call Settings of the authenticated user.

Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.

This API requires a user auth token with a scope of spark:telephony_config_read.

Parameters:

  • schedule_type (ScheduleType) – Type of the schedule.

  • schedule_id (str) – Retrieve the schedule with the matching ID.

Return type:

Schedule

list() → list[Schedule][source]

Get User (and Location) Schedules

Get Schedules for Call Settings for the authenticated user.

Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.

This API requires a user auth token with a scope of spark:telephony_config_read.

Return type:

list[UserSchedule]

create(schedule: Schedule) → str[source]

Add a User level Schedule for Call Settings

Create a new Schedule for the authenticated user.

Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.

This API requires a user auth token with a scope of spark:telephony_config_write.

Parameters:

schedule (Schedule) – Schedule details

Return type:

str

delete(schedule_type: ScheduleType, schedule_id: str)[source]

Delete a User Schedule

Delete a specific schedule for the authenticated user.

Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.

This API requires a user auth token with a scope of spark:telephony_config_write.

Parameters:

  • schedule_type (ScheduleType) – Type of the schedule.

  • schedule_id (str) – Delete the schedule with the matching ID.

Return type:

None

get_user_schedule(schedule_type: ScheduleType, schedule_id: str) → Schedule[source]

Get User Schedule

Get a Schedule details for Call Settings of the authenticated user.

Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.

This API requires a user auth token with a scope of spark:telephony_config_read.

Parameters:

  • schedule_type (ScheduleType) – Type of the schedule.

  • schedule_id (str) – Retrieve the schedule with the matching ID.

Return type:

UserScheduleGetResponse

update(schedule: Schedule, schedule_type: ScheduleType | None = None, schedule_id: str | None = None)[source]

Modify User Schedule

Modify a Schedule details for Call Settings of the authenticated user.

Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.

This API requires a user auth token with a scope of spark:telephony_config_read.

Parameters:

  • schedule (Schedule) – Schedule details

  • schedule_type (ScheduleType) – Type of the schedule. Default: schedule_type from schedule

  • schedule_id (str) – Update the schedule with the matching ID. Default: schedule_id from schedule

Return type:

None

event_create(schedule_type: ScheduleType, schedule_id: str, event: Event) → str[source]

Add an event for a User Schedule

Create a new Event for the authenticated user’s specified schedule.

Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.

This API requires a user auth token with a scope of spark:telephony_config_write.

Parameters:

  • schedule_type (ScheduleType) – Type of the schedule.

  • schedule_id (str) – add an event for the specified schedule ID.

  • event (Event) – Event details

Return type:

str

event_delete(schedule_type: ScheduleType, schedule_id: str, event_id: str)[source]

Delete User a Schedule Event

Delete a specific schedule event for the authenticated user.

Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.

This API requires a user auth token with a scope of spark:telephony_config_write.

Parameters:

  • schedule_type (ScheduleType) – Type of the schedule.

  • schedule_id (str) – Delete an event for the specified schedule ID.

  • event_id (str) – Delete the event with the matching ID.

Return type:

None

event_get(schedule_type: ScheduleType, schedule_id: str, event_id: str) → Event[source]

Get User Schedule Event

Get a Schedule Event details for Call Settings of the authenticated user.

Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.

This API requires a user auth token with a scope of spark:telephony_config_read.

Parameters:

schedule_type – Type of the schedule.

  • businessHours - Business hours schedule type.

  • holidays - Holidays schedule type.

Parameters:

  • schedule_id (str) – Retrieve the schedule with the matching ID.

  • event_id (str) – Retrieve the event with the matching ID.

Return type:

Event

event_update(schedule_type: ScheduleType, schedule_id: str, event: Event, event_id: str | None = None)[source]

Modify User Schedule Event

Modify a Schedule event details for Call Settings of the authenticated user.

Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.

This API requires a user auth token with a scope of spark:telephony_config_read.

Parameters:

schedule_type – Type of the schedule.

  • businessHours - Business hours schedule type.

  • holidays - Holidays schedule type.

Parameters:

  • schedule_id (str) – Update an event for the specified schedule ID.

  • event (Event) – Event details

  • event_id (str) – Update the event with the matching ID. Default: event id from event

Return type:

None

base = 'telephony/config/people/me'