com.amazon.ask.model.services.ups

Class UpsServiceClient

java.lang.Object

com.amazon.ask.model.services.BaseServiceClient

com.amazon.ask.model.services.ups.UpsServiceClient

All Implemented Interfaces:

UpsService

public class UpsServiceClient
extends com.amazon.ask.model.services.BaseServiceClient
implements UpsService

Field Summary

Fields inherited from class com.amazon.ask.model.services.BaseServiceClient

apiClient, apiEndpoint, authorizationValue, serializer

Constructor Summary

Constructors

Constructor and Description
UpsServiceClient(com.amazon.ask.model.services.ApiConfiguration apiConfiguration)

Method Summary

Modifier and Type	Method and Description
com.amazon.ask.model.services.ApiResponse<String>	callGetPersonsProfileGivenName() Gets the given name (first name) of the recognized speaker at person-level.
com.amazon.ask.model.services.ApiResponse<PhoneNumber>	callGetPersonsProfileMobileNumber() Gets the mobile phone number of the recognized speaker at person-level.
com.amazon.ask.model.services.ApiResponse<String>	callGetPersonsProfileName() Gets the full name of the recognized speaker at person-level.
com.amazon.ask.model.services.ApiResponse<String>	callGetProfileEmail() Gets the email address of the customer associated with the current enablement.
com.amazon.ask.model.services.ApiResponse<String>	callGetProfileGivenName() Gets the given name (first name) of the customer associated with the current enablement.
com.amazon.ask.model.services.ApiResponse<PhoneNumber>	callGetProfileMobileNumber() Gets the mobile phone number of the customer associated with the current enablement.
com.amazon.ask.model.services.ApiResponse<String>	callGetProfileName() Gets the full name of the customer associated with the current enablement.
com.amazon.ask.model.services.ApiResponse<DistanceUnits>	callGetSystemDistanceUnits(String deviceId) Gets the distance measurement unit of the device.
com.amazon.ask.model.services.ApiResponse<TemperatureUnit>	callGetSystemTemperatureUnit(String deviceId) Gets the temperature measurement units of the device.
com.amazon.ask.model.services.ApiResponse<String>	callGetSystemTimeZone(String deviceId) Gets the time zone of the device.
String	getPersonsProfileGivenName() Gets the given name (first name) of the recognized speaker at person-level.
PhoneNumber	getPersonsProfileMobileNumber() Gets the mobile phone number of the recognized speaker at person-level.
String	getPersonsProfileName() Gets the full name of the recognized speaker at person-level.
String	getProfileEmail() Gets the email address of the customer associated with the current enablement.
String	getProfileGivenName() Gets the given name (first name) of the customer associated with the current enablement.
PhoneNumber	getProfileMobileNumber() Gets the mobile phone number of the customer associated with the current enablement.
String	getProfileName() Gets the full name of the customer associated with the current enablement.
DistanceUnits	getSystemDistanceUnits(String deviceId) Gets the distance measurement unit of the device.
TemperatureUnit	getSystemTemperatureUnit(String deviceId) Gets the temperature measurement units of the device.
String	getSystemTimeZone(String deviceId) Gets the time zone of the device.

Methods inherited from class com.amazon.ask.model.services.BaseServiceClient

executeRequest, invoke, invoke

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UpsServiceClient

public UpsServiceClient(com.amazon.ask.model.services.ApiConfiguration apiConfiguration)

Method Detail

callGetProfileEmail

public com.amazon.ask.model.services.ApiResponse<String> callGetProfileEmail()
                                                                      throws com.amazon.ask.model.services.ServiceException

Gets the email address of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:email:read]

Specified by:

callGetProfileEmail in interface UpsService

Returns:

String

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getProfileEmail

public String getProfileEmail()
                       throws com.amazon.ask.model.services.ServiceException

Gets the email address of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:email:read]

Specified by:

getProfileEmail in interface UpsService

Returns:

String

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetProfileGivenName

public com.amazon.ask.model.services.ApiResponse<String> callGetProfileGivenName()
                                                                          throws com.amazon.ask.model.services.ServiceException

Gets the given name (first name) of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:given_name:read]

Specified by:

callGetProfileGivenName in interface UpsService

Returns:

String

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getProfileGivenName

public String getProfileGivenName()
                           throws com.amazon.ask.model.services.ServiceException

Gets the given name (first name) of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:given_name:read]

Specified by:

getProfileGivenName in interface UpsService

Returns:

String

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetProfileMobileNumber

public com.amazon.ask.model.services.ApiResponse<PhoneNumber> callGetProfileMobileNumber()
                                                                                  throws com.amazon.ask.model.services.ServiceException

Gets the mobile phone number of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:mobile_number:read]

Specified by:

callGetProfileMobileNumber in interface UpsService

Returns:

com.amazon.ask.model.services.ups.PhoneNumber

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getProfileMobileNumber

public PhoneNumber getProfileMobileNumber()
                                   throws com.amazon.ask.model.services.ServiceException

Gets the mobile phone number of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:mobile_number:read]

Specified by:

getProfileMobileNumber in interface UpsService

Returns:

com.amazon.ask.model.services.ups.PhoneNumber

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetProfileName

public com.amazon.ask.model.services.ApiResponse<String> callGetProfileName()
                                                                     throws com.amazon.ask.model.services.ServiceException

Gets the full name of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:name:read]

Specified by:

callGetProfileName in interface UpsService

Returns:

String

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getProfileName

public String getProfileName()
                      throws com.amazon.ask.model.services.ServiceException

Gets the full name of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:name:read]

Specified by:

getProfileName in interface UpsService

Returns:

String

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetSystemDistanceUnits

public com.amazon.ask.model.services.ApiResponse<DistanceUnits> callGetSystemDistanceUnits(String deviceId)
                                                                                    throws com.amazon.ask.model.services.ServiceException

Gets the distance measurement unit of the device. Does not require explict customer consent.

Specified by:

callGetSystemDistanceUnits in interface UpsService

Parameters:

deviceId - The device Id (required)

Returns:

com.amazon.ask.model.services.ups.DistanceUnits

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getSystemDistanceUnits

public DistanceUnits getSystemDistanceUnits(String deviceId)
                                     throws com.amazon.ask.model.services.ServiceException

Gets the distance measurement unit of the device. Does not require explict customer consent.

Specified by:

getSystemDistanceUnits in interface UpsService

Parameters:

deviceId - The device Id (required)

Returns:

com.amazon.ask.model.services.ups.DistanceUnits

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetSystemTemperatureUnit

public com.amazon.ask.model.services.ApiResponse<TemperatureUnit> callGetSystemTemperatureUnit(String deviceId)
                                                                                        throws com.amazon.ask.model.services.ServiceException

Gets the temperature measurement units of the device. Does not require explict customer consent.

Specified by:

callGetSystemTemperatureUnit in interface UpsService

Parameters:

deviceId - The device Id (required)

Returns:

com.amazon.ask.model.services.ups.TemperatureUnit

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getSystemTemperatureUnit

public TemperatureUnit getSystemTemperatureUnit(String deviceId)
                                         throws com.amazon.ask.model.services.ServiceException

Gets the temperature measurement units of the device. Does not require explict customer consent.

Specified by:

getSystemTemperatureUnit in interface UpsService

Parameters:

deviceId - The device Id (required)

Returns:

com.amazon.ask.model.services.ups.TemperatureUnit

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetSystemTimeZone

public com.amazon.ask.model.services.ApiResponse<String> callGetSystemTimeZone(String deviceId)
                                                                        throws com.amazon.ask.model.services.ServiceException

Gets the time zone of the device. Does not require explict customer consent.

Specified by:

callGetSystemTimeZone in interface UpsService

Parameters:

deviceId - The device Id (required)

Returns:

String

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getSystemTimeZone

public String getSystemTimeZone(String deviceId)
                         throws com.amazon.ask.model.services.ServiceException

Gets the time zone of the device. Does not require explict customer consent.

Specified by:

getSystemTimeZone in interface UpsService

Parameters:

deviceId - The device Id (required)

Returns:

String

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetPersonsProfileGivenName

public com.amazon.ask.model.services.ApiResponse<String> callGetPersonsProfileGivenName()
                                                                                 throws com.amazon.ask.model.services.ServiceException

Gets the given name (first name) of the recognized speaker at person-level. Requires speaker consent at person-level for scopes: [alexa::profile:given_name:read]

Specified by:

callGetPersonsProfileGivenName in interface UpsService

Returns:

String

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getPersonsProfileGivenName

public String getPersonsProfileGivenName()
                                  throws com.amazon.ask.model.services.ServiceException

Gets the given name (first name) of the recognized speaker at person-level. Requires speaker consent at person-level for scopes: [alexa::profile:given_name:read]

Specified by:

getPersonsProfileGivenName in interface UpsService

Returns:

String

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetPersonsProfileMobileNumber

public com.amazon.ask.model.services.ApiResponse<PhoneNumber> callGetPersonsProfileMobileNumber()
                                                                                         throws com.amazon.ask.model.services.ServiceException

Gets the mobile phone number of the recognized speaker at person-level. Requires speaker consent at person-level for scopes: [alexa::profile:mobile_number:read]

Specified by:

callGetPersonsProfileMobileNumber in interface UpsService

Returns:

com.amazon.ask.model.services.ups.PhoneNumber

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getPersonsProfileMobileNumber

public PhoneNumber getPersonsProfileMobileNumber()
                                          throws com.amazon.ask.model.services.ServiceException

Gets the mobile phone number of the recognized speaker at person-level. Requires speaker consent at person-level for scopes: [alexa::profile:mobile_number:read]

Specified by:

getPersonsProfileMobileNumber in interface UpsService

Returns:

com.amazon.ask.model.services.ups.PhoneNumber

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetPersonsProfileName

public com.amazon.ask.model.services.ApiResponse<String> callGetPersonsProfileName()
                                                                            throws com.amazon.ask.model.services.ServiceException

Gets the full name of the recognized speaker at person-level. Requires speaker consent at person-level for scopes: [alexa::profile:name:read]

Specified by:

callGetPersonsProfileName in interface UpsService

Returns:

String

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getPersonsProfileName

public String getPersonsProfileName()
                             throws com.amazon.ask.model.services.ServiceException

Gets the full name of the recognized speaker at person-level. Requires speaker consent at person-level for scopes: [alexa::profile:name:read]

Specified by:

getPersonsProfileName in interface UpsService

Returns:

String

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call