ask_sdk_model.services.reminder_management 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.reminder_management.alert_info module

class ask_sdk_model.services.reminder_management.alert_info.AlertInfo(spoken_info=None)

Bases: object

Alert info for VUI / GUI

Parameters:spoken_info ((optional) ask_sdk_model.services.reminder_management.alert_info_spoken_info.SpokenInfo) –
attribute_map = {'spoken_info': 'spokenInfo'}
deserialized_types = {'spoken_info': 'ask_sdk_model.services.reminder_management.alert_info_spoken_info.SpokenInfo'}
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.services.reminder_management.alert_info_spoken_info module

class ask_sdk_model.services.reminder_management.alert_info_spoken_info.SpokenInfo(content=None)

Bases: object

Parameters for VUI presentation of the reminder

Parameters:content ((optional) list[ask_sdk_model.services.reminder_management.spoken_text.SpokenText]) –
attribute_map = {'content': 'content'}
deserialized_types = {'content': 'list[ask_sdk_model.services.reminder_management.spoken_text.SpokenText]'}
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.services.reminder_management.error module

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

Bases: object

Parameters:
  • code ((optional) str) – Domain specific error code
  • message ((optional) str) – Detailed error message
attribute_map = {'code': 'code', 'message': 'message'}
deserialized_types = {'code': 'str', 'message': '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.services.reminder_management.event module

class ask_sdk_model.services.reminder_management.event.Event(status=None, alert_token=None)

Bases: object

Parameters:
attribute_map = {'alert_token': 'alertToken', 'status': 'status'}
deserialized_types = {'alert_token': 'str', 'status': 'ask_sdk_model.services.reminder_management.status.Status'}
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.services.reminder_management.get_reminder_response module

class ask_sdk_model.services.reminder_management.get_reminder_response.GetReminderResponse(alert_token=None, created_time=None, updated_time=None, status=None, trigger=None, alert_info=None, push_notification=None, version=None)

Bases: ask_sdk_model.services.reminder_management.reminder.Reminder

Response object for get reminder request

Parameters:
attribute_map = {'alert_info': 'alertInfo', 'alert_token': 'alertToken', 'created_time': 'createdTime', 'push_notification': 'pushNotification', 'status': 'status', 'trigger': 'trigger', 'updated_time': 'updatedTime', 'version': 'version'}
deserialized_types = {'alert_info': 'ask_sdk_model.services.reminder_management.alert_info.AlertInfo', 'alert_token': 'str', 'created_time': 'datetime', 'push_notification': 'ask_sdk_model.services.reminder_management.push_notification.PushNotification', 'status': 'ask_sdk_model.services.reminder_management.status.Status', 'trigger': 'ask_sdk_model.services.reminder_management.trigger.Trigger', 'updated_time': 'datetime', 'version': '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.services.reminder_management.get_reminders_response module

class ask_sdk_model.services.reminder_management.get_reminders_response.GetRemindersResponse(total_count=None, alerts=None, links=None)

Bases: object

Response object for get reminders request

Parameters:
attribute_map = {'alerts': 'alerts', 'links': 'links', 'total_count': 'totalCount'}
deserialized_types = {'alerts': 'list[ask_sdk_model.services.reminder_management.reminder.Reminder]', 'links': 'str', 'total_count': '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.services.reminder_management.push_notification module

class ask_sdk_model.services.reminder_management.push_notification.PushNotification(status=None)

Bases: object

Enable / disable reminders push notifications to Alexa mobile apps

Parameters:status ((optional) ask_sdk_model.services.reminder_management.push_notification_status.PushNotificationStatus) –
attribute_map = {'status': 'status'}
deserialized_types = {'status': 'ask_sdk_model.services.reminder_management.push_notification_status.PushNotificationStatus'}
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.services.reminder_management.push_notification_status module

class ask_sdk_model.services.reminder_management.push_notification_status.PushNotificationStatus

Bases: enum.Enum

Push notification status - Enabled/Disabled

Allowed enum values: [ENABLED, DISABLED]

DISABLED = 'DISABLED'
ENABLED = 'ENABLED'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.recurrence module

class ask_sdk_model.services.reminder_management.recurrence.Recurrence(freq=None, by_day=None, interval=None)

Bases: object

Recurring date/time using the RFC 5545 standard in JSON object form

Parameters:
attribute_map = {'by_day': 'byDay', 'freq': 'freq', 'interval': 'interval'}
deserialized_types = {'by_day': 'list[ask_sdk_model.services.reminder_management.recurrence_day.RecurrenceDay]', 'freq': 'ask_sdk_model.services.reminder_management.recurrence_freq.RecurrenceFreq', 'interval': 'int'}
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.services.reminder_management.recurrence_day module

class ask_sdk_model.services.reminder_management.recurrence_day.RecurrenceDay

Bases: enum.Enum

Day of recurrence

Allowed enum values: [SU, MO, TU, WE, TH, FR, SA]

FR = 'FR'
MO = 'MO'
SA = 'SA'
SU = 'SU'
TH = 'TH'
TU = 'TU'
WE = 'WE'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.recurrence_freq module

class ask_sdk_model.services.reminder_management.recurrence_freq.RecurrenceFreq

Bases: enum.Enum

Frequency of recurrence

Allowed enum values: [WEEKLY, DAILY]

DAILY = 'DAILY'
WEEKLY = 'WEEKLY'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.reminder module

class ask_sdk_model.services.reminder_management.reminder.Reminder(alert_token=None, created_time=None, updated_time=None, status=None, trigger=None, alert_info=None, push_notification=None, version=None)

Bases: object

Reminder object

Parameters:
attribute_map = {'alert_info': 'alertInfo', 'alert_token': 'alertToken', 'created_time': 'createdTime', 'push_notification': 'pushNotification', 'status': 'status', 'trigger': 'trigger', 'updated_time': 'updatedTime', 'version': 'version'}
deserialized_types = {'alert_info': 'ask_sdk_model.services.reminder_management.alert_info.AlertInfo', 'alert_token': 'str', 'created_time': 'datetime', 'push_notification': 'ask_sdk_model.services.reminder_management.push_notification.PushNotification', 'status': 'ask_sdk_model.services.reminder_management.status.Status', 'trigger': 'ask_sdk_model.services.reminder_management.trigger.Trigger', 'updated_time': 'datetime', 'version': '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.services.reminder_management.reminder_created_event_request module

class ask_sdk_model.services.reminder_management.reminder_created_event_request.ReminderCreatedEventRequest(request_id=None, timestamp=None, locale=None, body=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.services.reminder_management.event.Event) –
attribute_map = {'body': 'body', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}
deserialized_types = {'body': 'ask_sdk_model.services.reminder_management.event.Event', '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.services.reminder_management.reminder_deleted_event module

class ask_sdk_model.services.reminder_management.reminder_deleted_event.ReminderDeletedEvent(alert_tokens=None)

Bases: object

Parameters:alert_tokens ((optional) list[str]) –
attribute_map = {'alert_tokens': 'alertTokens'}
deserialized_types = {'alert_tokens': 'list[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.services.reminder_management.reminder_deleted_event_request module

class ask_sdk_model.services.reminder_management.reminder_deleted_event_request.ReminderDeletedEventRequest(request_id=None, timestamp=None, locale=None, body=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.services.reminder_management.reminder_deleted_event.ReminderDeletedEvent) –
attribute_map = {'body': 'body', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}
deserialized_types = {'body': 'ask_sdk_model.services.reminder_management.reminder_deleted_event.ReminderDeletedEvent', '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.services.reminder_management.reminder_management_service_client module

class ask_sdk_model.services.reminder_management.reminder_management_service_client.ReminderManagementServiceClient(api_configuration)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the ReminderManagementService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration
create_reminder(reminder_request, **kwargs)

This API is invoked by the skill to create a new reminder.

Parameters:
Return type:

Union[ApiResponse, ReminderResponse, Error]

delete_reminder(alert_token, **kwargs)

This API is invoked by the skill to delete a single reminder.

Parameters:
  • alert_token (str) – (required)
  • full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:

Union[ApiResponse, Error]

get_reminder(alert_token, **kwargs)

This API is invoked by the skill to get a single reminder.

Parameters:
  • alert_token (str) – (required)
  • full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:

Union[ApiResponse, GetReminderResponse, Error]

get_reminders(**kwargs)

This API is invoked by the skill to get a all reminders created by the caller.

Parameters:full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:Union[ApiResponse, GetRemindersResponse, Error]
update_reminder(alert_token, reminder_request, **kwargs)

This API is invoked by the skill to update a reminder.

Parameters:
Return type:

Union[ApiResponse, ReminderResponse, Error]

ask_sdk_model.services.reminder_management.reminder_request module

class ask_sdk_model.services.reminder_management.reminder_request.ReminderRequest(request_time=None, trigger=None, alert_info=None, push_notification=None)

Bases: object

Input request for creating a reminder

Parameters:
attribute_map = {'alert_info': 'alertInfo', 'push_notification': 'pushNotification', 'request_time': 'requestTime', 'trigger': 'trigger'}
deserialized_types = {'alert_info': 'ask_sdk_model.services.reminder_management.alert_info.AlertInfo', 'push_notification': 'ask_sdk_model.services.reminder_management.push_notification.PushNotification', 'request_time': 'datetime', 'trigger': 'ask_sdk_model.services.reminder_management.trigger.Trigger'}
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.services.reminder_management.reminder_response module

class ask_sdk_model.services.reminder_management.reminder_response.ReminderResponse(alert_token=None, created_time=None, updated_time=None, status=None, version=None, href=None)

Bases: object

Response object for post/put/delete reminder request

Parameters:
  • alert_token ((optional) str) – Unique id of this reminder alert
  • created_time ((optional) str) – Valid ISO 8601 format - Creation time of this reminder alert
  • updated_time ((optional) str) – Valid ISO 8601 format - Last updated time of this reminder alert
  • status ((optional) ask_sdk_model.services.reminder_management.status.Status) –
  • version ((optional) str) – Version of reminder alert
  • href ((optional) str) – URI to retrieve the created alert
attribute_map = {'alert_token': 'alertToken', 'created_time': 'createdTime', 'href': 'href', 'status': 'status', 'updated_time': 'updatedTime', 'version': 'version'}
deserialized_types = {'alert_token': 'str', 'created_time': 'str', 'href': 'str', 'status': 'ask_sdk_model.services.reminder_management.status.Status', 'updated_time': 'str', 'version': '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.services.reminder_management.reminder_started_event_request module

class ask_sdk_model.services.reminder_management.reminder_started_event_request.ReminderStartedEventRequest(request_id=None, timestamp=None, locale=None, body=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.services.reminder_management.event.Event) –
attribute_map = {'body': 'body', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}
deserialized_types = {'body': 'ask_sdk_model.services.reminder_management.event.Event', '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.services.reminder_management.reminder_status_changed_event_request module

class ask_sdk_model.services.reminder_management.reminder_status_changed_event_request.ReminderStatusChangedEventRequest(request_id=None, timestamp=None, locale=None, body=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.services.reminder_management.event.Event) –
attribute_map = {'body': 'body', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}
deserialized_types = {'body': 'ask_sdk_model.services.reminder_management.event.Event', '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.services.reminder_management.reminder_updated_event_request module

class ask_sdk_model.services.reminder_management.reminder_updated_event_request.ReminderUpdatedEventRequest(request_id=None, timestamp=None, locale=None, body=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.services.reminder_management.event.Event) –
attribute_map = {'body': 'body', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}
deserialized_types = {'body': 'ask_sdk_model.services.reminder_management.event.Event', '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.services.reminder_management.spoken_text module

class ask_sdk_model.services.reminder_management.spoken_text.SpokenText(locale=None, ssml=None, text=None)

Bases: object

Parameters:
  • locale ((optional) str) – The locale in which the spoken text is rendered. e.g. en-US
  • ssml ((optional) str) – Spoken text in SSML format.
  • text ((optional) str) – Spoken text in plain text format.
attribute_map = {'locale': 'locale', 'ssml': 'ssml', 'text': 'text'}
deserialized_types = {'locale': 'str', 'ssml': 'str', 'text': '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.services.reminder_management.status module

class ask_sdk_model.services.reminder_management.status.Status

Bases: enum.Enum

Status of reminder

Allowed enum values: [ON, COMPLETED]

COMPLETED = 'COMPLETED'
ON = 'ON'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.reminder_management.trigger module

class ask_sdk_model.services.reminder_management.trigger.Trigger(object_type=None, scheduled_time=None, offset_in_seconds=None, time_zone_id=None, recurrence=None)

Bases: object

Trigger information for Reminder

Parameters:
attribute_map = {'object_type': 'type', 'offset_in_seconds': 'offsetInSeconds', 'recurrence': 'recurrence', 'scheduled_time': 'scheduledTime', 'time_zone_id': 'timeZoneId'}
deserialized_types = {'object_type': 'ask_sdk_model.services.reminder_management.trigger_type.TriggerType', 'offset_in_seconds': 'int', 'recurrence': 'ask_sdk_model.services.reminder_management.recurrence.Recurrence', 'scheduled_time': 'datetime', 'time_zone_id': '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.services.reminder_management.trigger_type module

class ask_sdk_model.services.reminder_management.trigger_type.TriggerType

Bases: enum.Enum

Type of reminder - Absolute / Relative

Allowed enum values: [SCHEDULED_ABSOLUTE, SCHEDULED_RELATIVE]

SCHEDULED_ABSOLUTE = 'SCHEDULED_ABSOLUTE'
SCHEDULED_RELATIVE = 'SCHEDULED_RELATIVE'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model