ask_sdk_model.services.device_address 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.device_address.address module

class ask_sdk_model.services.device_address.address.Address(address_line1=None, address_line2=None, address_line3=None, country_code=None, state_or_region=None, city=None, district_or_county=None, postal_code=None)

Bases: object

Represents the full address response from the service.

Parameters:
  • address_line1 ((optional) str) –
  • address_line2 ((optional) str) –
  • address_line3 ((optional) str) –
  • country_code ((optional) str) –
  • state_or_region ((optional) str) –
  • city ((optional) str) –
  • district_or_county ((optional) str) –
  • postal_code ((optional) str) –
attribute_map = {'address_line1': 'addressLine1', 'address_line2': 'addressLine2', 'address_line3': 'addressLine3', 'city': 'city', 'country_code': 'countryCode', 'district_or_county': 'districtOrCounty', 'postal_code': 'postalCode', 'state_or_region': 'stateOrRegion'}
deserialized_types = {'address_line1': 'str', 'address_line2': 'str', 'address_line3': 'str', 'city': 'str', 'country_code': 'str', 'district_or_county': 'str', 'postal_code': 'str', 'state_or_region': '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.device_address.device_address_service_client module

class ask_sdk_model.services.device_address.device_address_service_client.DeviceAddressServiceClient(api_configuration)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the DeviceAddressService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration
get_country_and_postal_code(device_id, **kwargs)

Gets the country and postal code of a device

Parameters:
  • device_id (str) – (required) The device Id for which to get the country and postal code
  • 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, ShortAddress, Error]

get_full_address(device_id, **kwargs)

Gets the address of a device

Parameters:
  • device_id (str) – (required) The device Id for which to get the address
  • 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, Address, Error]

ask_sdk_model.services.device_address.error module

class ask_sdk_model.services.device_address.error.Error(object_type=None, message=None)

Bases: object

Parameters:
  • object_type ((optional) str) – The corresponding type of the http status code being returned.
  • message ((optional) str) – A human readable description of error.
attribute_map = {'message': 'message', 'object_type': 'type'}
deserialized_types = {'message': 'str', 'object_type': '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.device_address.short_address module

class ask_sdk_model.services.device_address.short_address.ShortAddress(country_code=None, postal_code=None)

Bases: object

Parameters:
  • country_code ((optional) str) –
  • postal_code ((optional) str) –
attribute_map = {'country_code': 'countryCode', 'postal_code': 'postalCode'}
deserialized_types = {'country_code': 'str', 'postal_code': 'str'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model