wxc_sdk.me.call_notify package

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

Bases: ApiChild

get() → CallNotify[source]

Get Call Notify Settings for User

Get Call Notify Settings for the authenticated user.

Call Notify allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

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

Return type:

CallNotify

update(enabled: bool, email_address: str | None = None)[source]

Modify Call Notify Settings for User

Update Call Notify Settings for the authenticated user.

Call Notify allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.

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

Parameters:

  • enabled (bool) – Indicates whether the call notify feature should be enabled or disabled for the user.

  • email_address (str) – Email Address to which call notifications to be received.

Return type:

None

criteria_create(criteria: CallNotifyCriteria) → str[source]

Add a Call Notify Criteria

Create a Call Notify Criteria for the authenticated user.

Call Notify allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

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

Parameters:

criteria – Criteria to be created.

Return type:

str

criteria_delete(criteria_id: str)[source]

Delete a Call Notify Criteria

Delete a Call Notify criteria for the authenticated user.

Call Notify allows you to set up a unique ringtone based on predefined criteria. This API removes a specific criteria rule by its unique identifier.

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

Parameters:

criteria_id (str) – The criteria_id parameter specifies the unique identifier for the call notify criteria.

Return type:

None

criteria_get(criteria_id: str) → CallNotifyCriteria[source]

Get Call Notify Criteria Settings

Get Call Notify Criteria Settings for the authenticated user.

Call Notify allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

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

Parameters:

criteria_id (str) – The id parameter specifies the unique identifier for the call notify criteria.

Return type:

CallNotifyCriteria

criteria_update(criteria: CallNotifyCriteria, criteria_id: str | None = None)[source]

Modify a Call Notify Criteria

Modify Call Notify Criteria Settings for the authenticated user.

Call Notify allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.

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

Parameters:

  • criteria (CallNotifyCriteria) – Criteria to be modified.

  • criteria_id (str) – The id parameter specifies the unique identifier for the call notify criteria. Default: id from criteria

Return type:

None

base = 'telephony/config/people/me'
class wxc_sdk.me.call_notify.CallNotify(*, enabled: bool | None = None, emailAddress: str | None = None, criteria: list[SelectiveCrit] | None = None, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool | None

Indicates whether the call notify feature is enabled for the user.

email_address: str | None

Email Address to which call notifications to be received.

criteria: list[SelectiveCrit] | None

List of Call Notify Criteria configured by the user.

class wxc_sdk.me.call_notify.CallNotifyCriteria(*, id: str | None = None, scheduleName: str | None = None, scheduleType: ScheduleType | None = None, scheduleLevel: SelectiveScheduleLevel | None = None, callsFrom: SelectiveFrom | None = None, anonymousCallersEnabled: bool | None = None, unavailableCallersEnabled: bool | None = None, phoneNumbers: list[Annotated[str, BeforeValidator(func=e164, json_schema_input_type=PydanticUndefined)]] | None = None, enabled: bool | None = None, **extra_data: Any)[source]

Bases: SelectiveCriteria

model_post_init(context: Any, /) → None

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

  • self – The BaseModel instance.

  • context – The context.