ask_sdk_model.services.endpoint_enumeration 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.endpoint_enumeration.endpoint_capability module

class ask_sdk_model.services.endpoint_enumeration.endpoint_capability.EndpointCapability(interface=None, object_type=None, version=None)

Bases: object

Parameters:

• interface ((optional) str) – The name of the capability interface.
• object_type ((optional) str) – The type of capability interface. This is usually AlexaInterface.
• version ((optional) str) – The version of the capability interface that the endpoint supports.

attribute_map = {'interface': 'interface', 'object_type': 'type', 'version': 'version'}

deserialized_types = {'interface': 'str', 'object_type': '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.endpoint_enumeration.endpoint_enumeration_response module

class ask_sdk_model.services.endpoint_enumeration.endpoint_enumeration_response.EndpointEnumerationResponse(endpoints=None)

Bases: object

Contains the list of endpoints.

Parameters:endpoints ((optional) list[ask_sdk_model.services.endpoint_enumeration.endpoint_info.EndpointInfo]) – The list of endpoints.

attribute_map = {'endpoints': 'endpoints'}

deserialized_types = {'endpoints': 'list[ask_sdk_model.services.endpoint_enumeration.endpoint_info.EndpointInfo]'}

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.endpoint_enumeration.endpoint_enumeration_service_client module

class ask_sdk_model.services.endpoint_enumeration.endpoint_enumeration_service_client.EndpointEnumerationServiceClient(api_configuration, custom_user_agent=None)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the EndpointEnumerationService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration

get_endpoints(**kwargs)

This API is invoked by the skill to retrieve endpoints connected to the Echo device.

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, EndpointEnumerationResponse, Error]

ask_sdk_model.services.endpoint_enumeration.endpoint_info module

class ask_sdk_model.services.endpoint_enumeration.endpoint_info.EndpointInfo(endpoint_id=None, friendly_name=None, capabilities=None)

Bases: object

Contains the list of connected endpoints and their declared capabilities.

Parameters:

• endpoint_id ((optional) str) – A unique identifier for the endpoint.
• friendly_name ((optional) str) – The name of the endpoint. Because this name might be changed by the user or the platform, it might be different than the Bluetooth friendly name.
• capabilities ((optional) list[ask_sdk_model.services.endpoint_enumeration.endpoint_capability.EndpointCapability]) – The list of endpoint capabilities.

attribute_map = {'capabilities': 'capabilities', 'endpoint_id': 'endpointId', 'friendly_name': 'friendlyName'}

deserialized_types = {'capabilities': 'list[ask_sdk_model.services.endpoint_enumeration.endpoint_capability.EndpointCapability]', 'endpoint_id': 'str', 'friendly_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.services.endpoint_enumeration.error module

class ask_sdk_model.services.endpoint_enumeration.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