Skip to content

Commit

Permalink
Add models for Alexa Presentation Language
Browse files Browse the repository at this point in the history
  • Loading branch information
nikhilym committed Oct 30, 2018
1 parent 704ba36 commit af962d1
Show file tree
Hide file tree
Showing 30 changed files with 2,016 additions and 10 deletions.
8 changes: 8 additions & 0 deletions ask-sdk-model/CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,11 @@ CHANGELOG

* Models for "PrintRequest" and "ReservationRequest" in Skill Connections.

1.3.0
~~~~~

* Models for "Alexa Presentation Language". The Alexa Presentation Language
(APL) enables you to build interactive voice experiences that include
graphics, images, slideshows, and video, and to customize them for
different device types.

2 changes: 1 addition & 1 deletion ask-sdk-model/ask_sdk_model/__version__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
__pip_package_name__ = 'ask-sdk-model'
__description__ = 'The ASK SDK Model package provides model definitions, for building Alexa Skills.'
__url__ = 'https://github.com/alexa/alexa-apis-for-python'
__version__ = '1.2.0'
__version__ = '1.3.0'
__author__ = 'Alexa Skills Kit'
__author_email__ = 'ask-sdk-dynamic@amazon.com'
__license__ = 'Apache 2.0'
Expand Down
16 changes: 12 additions & 4 deletions ask-sdk-model/ask_sdk_model/context.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
from datetime import datetime
from ask_sdk_model.interfaces.system.system_state import SystemState
from ask_sdk_model.interfaces.audioplayer.audio_player_state import AudioPlayerState
from ask_sdk_model.interfaces.viewport.viewport_state import ViewportState
from ask_sdk_model.interfaces.display.display_state import DisplayState


Expand All @@ -37,22 +38,26 @@ class Context(object):
:type audio_player: (optional) ask_sdk_model.interfaces.audioplayer.audio_player_state.AudioPlayerState
:param display: Provides the current state for the Display interface.
:type display: (optional) ask_sdk_model.interfaces.display.display_state.DisplayState
:param viewport: Provides the characteristics of a device's viewport.
:type viewport: (optional) ask_sdk_model.interfaces.viewport.viewport_state.ViewportState
"""
deserialized_types = {
'system': 'ask_sdk_model.interfaces.system.system_state.SystemState',
'audio_player': 'ask_sdk_model.interfaces.audioplayer.audio_player_state.AudioPlayerState',
'display': 'ask_sdk_model.interfaces.display.display_state.DisplayState'
'display': 'ask_sdk_model.interfaces.display.display_state.DisplayState',
'viewport': 'ask_sdk_model.interfaces.viewport.viewport_state.ViewportState'
}

attribute_map = {
'system': 'System',
'audio_player': 'AudioPlayer',
'display': 'Display'
'display': 'Display',
'viewport': 'Viewport'
}

def __init__(self, system=None, audio_player=None, display=None):
# type: (Optional[SystemState], Optional[AudioPlayerState], Optional[DisplayState]) -> None
def __init__(self, system=None, audio_player=None, display=None, viewport=None):
# type: (Optional[SystemState], Optional[AudioPlayerState], Optional[DisplayState], Optional[ViewportState]) -> None
"""
:param system: Provides information about the current state of the Alexa service and the device interacting with your skill.
Expand All @@ -61,12 +66,15 @@ def __init__(self, system=None, audio_player=None, display=None):
:type audio_player: (optional) ask_sdk_model.interfaces.audioplayer.audio_player_state.AudioPlayerState
:param display: Provides the current state for the Display interface.
:type display: (optional) ask_sdk_model.interfaces.display.display_state.DisplayState
:param viewport: Provides the characteristics of a device's viewport.
:type viewport: (optional) ask_sdk_model.interfaces.viewport.viewport_state.ViewportState
"""
self.__discriminator_value = None

self.system = system
self.audio_player = audio_player
self.display = display
self.viewport = viewport

def to_dict(self):
# type: () -> Dict[str, object]
Expand Down
6 changes: 6 additions & 0 deletions ask-sdk-model/ask_sdk_model/directive.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ class Directive(object):
|
| AudioPlayer.Play: :py:class:`ask_sdk_model.interfaces.audioplayer.play_directive.PlayDirective`,
|
| Alexa.Presentation.APL.ExecuteCommands: :py:class:`ask_sdk_model.interfaces.alexa.presentation.apl.execute_commands_directive.ExecuteCommandsDirective`,
|
| Connections.SendRequest: :py:class:`ask_sdk_model.interfaces.connections.send_request_directive.SendRequestDirective`,
|
| Display.RenderTemplate: :py:class:`ask_sdk_model.interfaces.display.render_template_directive.RenderTemplateDirective`,
Expand All @@ -61,6 +63,8 @@ class Directive(object):
|
| GameEngine.StopInputHandler: :py:class:`ask_sdk_model.interfaces.game_engine.stop_input_handler_directive.StopInputHandlerDirective`,
|
| Alexa.Presentation.APL.RenderDocument: :py:class:`ask_sdk_model.interfaces.alexa.presentation.apl.render_document_directive.RenderDocumentDirective`,
|
| Connections.SendResponse: :py:class:`ask_sdk_model.interfaces.connections.send_response_directive.SendResponseDirective`,
|
| Dialog.ElicitSlot: :py:class:`ask_sdk_model.dialog.elicit_slot_directive.ElicitSlotDirective`,
Expand All @@ -80,6 +84,7 @@ class Directive(object):
'AudioPlayer.Stop': 'ask_sdk_model.interfaces.audioplayer.stop_directive.StopDirective',
'Dialog.ConfirmSlot': 'ask_sdk_model.dialog.confirm_slot_directive.ConfirmSlotDirective',
'AudioPlayer.Play': 'ask_sdk_model.interfaces.audioplayer.play_directive.PlayDirective',
'Alexa.Presentation.APL.ExecuteCommands': 'ask_sdk_model.interfaces.alexa.presentation.apl.execute_commands_directive.ExecuteCommandsDirective',
'Connections.SendRequest': 'ask_sdk_model.interfaces.connections.send_request_directive.SendRequestDirective',
'Display.RenderTemplate': 'ask_sdk_model.interfaces.display.render_template_directive.RenderTemplateDirective',
'GadgetController.SetLight': 'ask_sdk_model.interfaces.gadget_controller.set_light_directive.SetLightDirective',
Expand All @@ -89,6 +94,7 @@ class Directive(object):
'GameEngine.StartInputHandler': 'ask_sdk_model.interfaces.game_engine.start_input_handler_directive.StartInputHandlerDirective',
'VideoApp.Launch': 'ask_sdk_model.interfaces.videoapp.launch_directive.LaunchDirective',
'GameEngine.StopInputHandler': 'ask_sdk_model.interfaces.game_engine.stop_input_handler_directive.StopInputHandlerDirective',
'Alexa.Presentation.APL.RenderDocument': 'ask_sdk_model.interfaces.alexa.presentation.apl.render_document_directive.RenderDocumentDirective',
'Connections.SendResponse': 'ask_sdk_model.interfaces.connections.send_response_directive.SendResponseDirective',
'Dialog.ElicitSlot': 'ask_sdk_model.dialog.elicit_slot_directive.ElicitSlotDirective',
'AudioPlayer.ClearQueue': 'ask_sdk_model.interfaces.audioplayer.clear_queue_directive.ClearQueueDirective'
Expand Down
16 changes: 16 additions & 0 deletions ask-sdk-model/ask_sdk_model/interfaces/alexa/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# coding: utf-8

#
# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the 'License'). You may not use this file
# except in compliance with the License. A copy of the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for
# the specific language governing permissions and limitations under the License.
#
from __future__ import absolute_import

Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# coding: utf-8

#
# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the 'License'). You may not use this file
# except in compliance with the License. A copy of the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for
# the specific language governing permissions and limitations under the License.
#
from __future__ import absolute_import

Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# coding: utf-8

#
# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the 'License'). You may not use this file
# except in compliance with the License. A copy of the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for
# the specific language governing permissions and limitations under the License.
#
from __future__ import absolute_import

from .alexa_presentation_apl_interface import AlexaPresentationAplInterface
from .align import Align
from .auto_page_command import AutoPageCommand
from .command import Command
from .execute_commands_directive import ExecuteCommandsDirective
from .highlight_mode import HighlightMode
from .position import Position
from .render_document_directive import RenderDocumentDirective
from .runtime import Runtime
from .set_page_command import SetPageCommand
from .speak_item_command import SpeakItemCommand
from .user_event import UserEvent
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# coding: utf-8

#
# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file
# except in compliance with the License. A copy of the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for
# the specific language governing permissions and limitations under the License.
#

import pprint
import re # noqa: F401
import six
import typing
from enum import Enum


if typing.TYPE_CHECKING:
from typing import Dict, List, Optional
from datetime import datetime
from ask_sdk_model.interfaces.alexa.presentation.apl.runtime import Runtime


class AlexaPresentationAplInterface(object):
"""
:param runtime:
:type runtime: (optional) ask_sdk_model.interfaces.alexa.presentation.apl.runtime.Runtime
"""
deserialized_types = {
'runtime': 'ask_sdk_model.interfaces.alexa.presentation.apl.runtime.Runtime'
}

attribute_map = {
'runtime': 'runtime'
}

def __init__(self, runtime=None):
# type: (Optional[Runtime]) -> None
"""
:param runtime:
:type runtime: (optional) ask_sdk_model.interfaces.alexa.presentation.apl.runtime.Runtime
"""
self.__discriminator_value = None

self.runtime = runtime

def to_dict(self):
# type: () -> Dict[str, object]
"""Returns the model properties as a dict"""
result = {}

for attr, _ in six.iteritems(self.deserialized_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else
x.value if isinstance(x, Enum) else x,
value
))
elif isinstance(value, Enum):
result[attr] = value.value
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else
(item[0], item[1].value)
if isinstance(item[1], Enum) else item,
value.items()
))
else:
result[attr] = value

return result

def to_str(self):
# type: () -> str
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())

def __repr__(self):
# type: () -> str
"""For `print` and `pprint`"""
return self.to_str()

def __eq__(self, other):
# type: (object) -> bool
"""Returns true if both objects are equal"""
if not isinstance(other, AlexaPresentationAplInterface):
return False

return self.__dict__ == other.__dict__

def __ne__(self, other):
# type: (object) -> bool
"""Returns true if both objects are not equal"""
return not self == other
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# coding: utf-8

#
# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file
# except in compliance with the License. A copy of the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for
# the specific language governing permissions and limitations under the License.
#

import pprint
import re # noqa: F401
import six
import typing
from enum import Enum


if typing.TYPE_CHECKING:
from typing import Dict, List, Optional
from datetime import datetime


class Align(Enum):
"""
The alignment of the item after scrolling. Defaults to visible.
Allowed enum values: [CENTER, FIRST, LAST, VISIBLE]
"""
CENTER = "CENTER"
FIRST = "FIRST"
LAST = "LAST"
VISIBLE = "VISIBLE"
def to_dict(self):
# type: () -> Dict[str, object]
"""Returns the model properties as a dict"""
result = {self.name: self.value}
return result

def to_str(self):
# type: () -> str
"""Returns the string representation of the model"""
return pprint.pformat(self.value)

def __repr__(self):
# type: () -> str
"""For `print` and `pprint`"""
return self.to_str()

def __eq__(self, other):
# type: (object) -> bool
"""Returns true if both objects are equal"""
if not isinstance(other, Align):
return False

return self.__dict__ == other.__dict__

def __ne__(self, other):
# type: (object) -> bool
"""Returns true if both objects are not equal"""
return not self == other
Loading

0 comments on commit af962d1

Please sign in to comment.