ask_sdk_model.events.skillevents 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.events.skillevents.account_linked_body module

class ask_sdk_model.events.skillevents.account_linked_body.AccountLinkedBody(access_token=None)

Bases: object

Parameters:access_token ((optional) str) –

attribute_map = {'access_token': 'accessToken'}

deserialized_types = {'access_token': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.account_linked_request module

class ask_sdk_model.events.skillevents.account_linked_request.AccountLinkedRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

This event indicates that a customer has linked an account in a third-party application with the Alexa app. This event is useful for an application that support out-of-session (non-voice) user interactions so that this application can be notified when the internal customer can be associated with the Alexa customer. This event is required for many applications that synchronize customer Alexa lists with application lists. During the account linking process, the Alexa app directs the user to the skill website where the customer logs in. When the customer logs in, the skill then provides an access token and a consent token to Alexa. The event includes the same access token and consent token.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.events.skillevents.account_linked_body.AccountLinkedBody) –
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.events.skillevents.account_linked_body.AccountLinkedBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.permission module

class ask_sdk_model.events.skillevents.permission.Permission(scope=None)

Bases: object

Parameters:scope ((optional) str) –

attribute_map = {'scope': 'scope'}

deserialized_types = {'scope': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.permission_accepted_request module

class ask_sdk_model.events.skillevents.permission_accepted_request.PermissionAcceptedRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.events.skillevents.permission_body.PermissionBody) –
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.events.skillevents.permission_body.PermissionBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.permission_body module

class ask_sdk_model.events.skillevents.permission_body.PermissionBody(accepted_permissions=None)

Bases: object

Parameters:accepted_permissions ((optional) list[ask_sdk_model.events.skillevents.permission.Permission]) –

attribute_map = {'accepted_permissions': 'acceptedPermissions'}

deserialized_types = {'accepted_permissions': 'list[ask_sdk_model.events.skillevents.permission.Permission]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.permission_changed_request module

class ask_sdk_model.events.skillevents.permission_changed_request.PermissionChangedRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.events.skillevents.permission_body.PermissionBody) –
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.events.skillevents.permission_body.PermissionBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.proactive_subscription_changed_body module

class ask_sdk_model.events.skillevents.proactive_subscription_changed_body.ProactiveSubscriptionChangedBody(subscriptions=None)

Bases: object

Parameters:subscriptions ((optional) list[ask_sdk_model.events.skillevents.proactive_subscription_event.ProactiveSubscriptionEvent]) – The list of events that this customer is currently subscribed to. If a customer unsubscribes from an event, this list will contain remaining event types to which the customer is still subscribed to receive from your skill. If the list of subscriptions is empty, this customer has unsubscribed from all event types from your skill.

attribute_map = {'subscriptions': 'subscriptions'}

deserialized_types = {'subscriptions': 'list[ask_sdk_model.events.skillevents.proactive_subscription_event.ProactiveSubscriptionEvent]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.proactive_subscription_changed_request module

class ask_sdk_model.events.skillevents.proactive_subscription_changed_request.ProactiveSubscriptionChangedRequest(request_id=None, timestamp=None, locale=None, body=None)

Bases: ask_sdk_model.request.Request

This event indicates a customer subscription to receive events from your skill and contains information for that user. You need this information to know the userId in order to send events to individual users. Note that these events can arrive out of order, so ensure that your skill service uses the timestamp in the event to correctly record the latest subscription state for a customer.

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• body ((optional) ask_sdk_model.events.skillevents.proactive_subscription_changed_body.ProactiveSubscriptionChangedBody) –

attribute_map = {'body': 'body', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'body': 'ask_sdk_model.events.skillevents.proactive_subscription_changed_body.ProactiveSubscriptionChangedBody', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.proactive_subscription_event module

class ask_sdk_model.events.skillevents.proactive_subscription_event.ProactiveSubscriptionEvent(event_name=None)

Bases: object

Parameters:event_name ((optional) str) –

attribute_map = {'event_name': 'eventName'}

deserialized_types = {'event_name': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.skill_disabled_request module

class ask_sdk_model.events.skillevents.skill_disabled_request.SkillDisabledRequest(request_id=None, timestamp=None, locale=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.events.skillevents.skill_enabled_request module

class ask_sdk_model.events.skillevents.skill_enabled_request.SkillEnabledRequest(request_id=None, timestamp=None, locale=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:

• request_id ((optional) str) – Represents the unique identifier for the specific request.
• timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
• locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
• event_creation_time ((optional) datetime) –
• event_publishing_time ((optional) datetime) –

attribute_map = {'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}

deserialized_types = {'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model