ask_sdk_model.services.proactive_events package

Submodules

Note

Canonical imports have been added in the __init__.py of the package. This helps in importing the class directly from the package, than through the module.

For eg: if package a has module b with class C, you can do from a import C instead of from a.b import C.

ask_sdk_model.services.proactive_events.create_proactive_event_request module

class ask_sdk_model.services.proactive_events.create_proactive_event_request.CreateProactiveEventRequest(timestamp=None, reference_id=None, expiry_time=None, event=None, localized_attributes=None, relevant_audience=None)

Bases: object

Parameters:
  • timestamp ((optional) datetime) – The date and time of the event associated with this request, in ISO 8601 format.
  • reference_id ((optional) str) – Client-supplied ID for correlating the event with external entities. The allowed characters for the referenceId field are alphanumeric and ~, and the length of the referenceId field must be 1-100 characters.
  • expiry_time ((optional) datetime) – The date and time, in ISO 8601 format, when the service will automatically delete the notification if it is still in the pending state.
  • event ((optional) ask_sdk_model.services.proactive_events.event.Event) –
  • localized_attributes ((optional) list[object]) – A list of items, each of which contains the set of event attributes that requires localization support.
  • relevant_audience ((optional) ask_sdk_model.services.proactive_events.relevant_audience.RelevantAudience) –
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.proactive_events.error module

class ask_sdk_model.services.proactive_events.error.Error(code=None, message=None)

Bases: object

Parameters:
  • code ((optional) int) –
  • message ((optional) str) –
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.proactive_events.event module

class ask_sdk_model.services.proactive_events.event.Event(name=None, payload=None)

Bases: object

The event data to be sent to customers, conforming to the schema associated with this event.

Parameters:
  • name ((optional) str) –
  • payload ((optional) object) –
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.proactive_events.proactive_events_service_client module

class ask_sdk_model.services.proactive_events.proactive_events_service_client.ProactiveEventsServiceClient(api_configuration, authentication_configuration)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the ProactiveEventsService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ask_sdk_model.services.api_configuration.ApiConfiguration
create_proactive_event(create_proactive_event_request, stage, **kwargs)

Create a new proactive event in live stage.

Parameters:create_proactive_event_request (ask_sdk_model.services.proactive_events.create_proactive_event_request.CreateProactiveEventRequest) – (required) Request to create a new proactive event.
Return type:None

ask_sdk_model.services.proactive_events.relevant_audience module

class ask_sdk_model.services.proactive_events.relevant_audience.RelevantAudience(object_type=None, payload=None)

Bases: object

The audience for this event.

Parameters:
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.proactive_events.relevant_audience_type module

class ask_sdk_model.services.proactive_events.relevant_audience_type.RelevantAudienceType

Bases: enum.Enum

The audience for this event. Use Multicast to target information to all customers subscribed to that event, or use Unicast to target information containing the actual userId for individual events.

Allowed enum values: [Unicast, Multicast]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.proactive_events.skill_stage module

class ask_sdk_model.services.proactive_events.skill_stage.SkillStage

Bases: enum.Enum

Stage for creating Proactive events.

Since proactive events can be created on the DEVELOPMENT and LIVE stages of the skill, this enum provides the stage values that can be used to pass to the service call.

Allowed enum values: [DEVELOPMENT, LIVE]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model