ask_smapi_model.v1.skill.account_linking 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_smapi_model.v1.skill.account_linking.access_token_scheme_type module¶
-
class
ask_smapi_model.v1.skill.account_linking.access_token_scheme_type.
AccessTokenSchemeType
¶ Bases:
enum.Enum
The type of client authentication scheme.
Allowed enum values: [HTTP_BASIC, REQUEST_BODY_CREDENTIALS]
-
HTTP_BASIC
= 'HTTP_BASIC'¶
-
REQUEST_BODY_CREDENTIALS
= 'REQUEST_BODY_CREDENTIALS'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-
ask_smapi_model.v1.skill.account_linking.account_linking_request module¶
-
class
ask_smapi_model.v1.skill.account_linking.account_linking_request.
AccountLinkingRequest
(object_type=None, authorization_url=None, domains=None, client_id=None, scopes=None, access_token_url=None, client_secret=None, access_token_scheme=None, default_token_expiration_in_seconds=None, reciprocal_access_token_url=None, redirect_urls=None, authorization_urls_by_platform=None)¶ Bases:
object
The payload for creating the account linking partner.
Parameters: - object_type ((optional) ask_smapi_model.v1.skill.account_linking.account_linking_type.AccountLinkingType) –
- authorization_url ((optional) str) – The url where customers will be redirected in the companion app to enter login credentials.
- domains ((optional) list[str]) – The list of domains that the authorization URL will fetch content from.
- client_id ((optional) str) – The unique public string used to identify the client requesting for authentication.
- scopes ((optional) list[str]) – The list of permissions which will be requested from the skill user.
- access_token_url ((optional) str) – The url used for access token and token refresh requests.
- client_secret ((optional) str) – The client secret provided by developer.
- access_token_scheme ((optional) ask_smapi_model.v1.skill.account_linking.access_token_scheme_type.AccessTokenSchemeType) –
- default_token_expiration_in_seconds ((optional) int) – The time in seconds for which access token is valid. If OAuth client returns "expires_in", it will be overwrite this parameter.
- reciprocal_access_token_url ((optional) str) – Optional, if your skill requires reciprocal authorization, provide this additional access token url to handle reciprocal (Alexa) authorization codes that can be exchanged for Alexa access tokens.
- redirect_urls ((optional) list[str]) – The list of valid urls to redirect back to, when the linking process is initiated from a third party system.
- authorization_urls_by_platform ((optional) list[ask_smapi_model.v1.skill.account_linking.account_linking_platform_authorization_url.AccountLinkingPlatformAuthorizationUrl]) – The list of valid authorization urls for allowed platforms to initiate account linking.
-
attribute_map
= {'access_token_scheme': 'accessTokenScheme', 'access_token_url': 'accessTokenUrl', 'authorization_url': 'authorizationUrl', 'authorization_urls_by_platform': 'authorizationUrlsByPlatform', 'client_id': 'clientId', 'client_secret': 'clientSecret', 'default_token_expiration_in_seconds': 'defaultTokenExpirationInSeconds', 'domains': 'domains', 'object_type': 'type', 'reciprocal_access_token_url': 'reciprocalAccessTokenUrl', 'redirect_urls': 'redirectUrls', 'scopes': 'scopes'}¶
-
deserialized_types
= {'access_token_scheme': 'ask_smapi_model.v1.skill.account_linking.access_token_scheme_type.AccessTokenSchemeType', 'access_token_url': 'str', 'authorization_url': 'str', 'authorization_urls_by_platform': 'list[ask_smapi_model.v1.skill.account_linking.account_linking_platform_authorization_url.AccountLinkingPlatformAuthorizationUrl]', 'client_id': 'str', 'client_secret': 'str', 'default_token_expiration_in_seconds': 'int', 'domains': 'list[str]', 'object_type': 'ask_smapi_model.v1.skill.account_linking.account_linking_type.AccountLinkingType', 'reciprocal_access_token_url': 'str', 'redirect_urls': 'list[str]', 'scopes': '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_smapi_model.v1.skill.account_linking.account_linking_response module¶
-
class
ask_smapi_model.v1.skill.account_linking.account_linking_response.
AccountLinkingResponse
(object_type=None, authorization_url=None, domains=None, client_id=None, scopes=None, access_token_url=None, access_token_scheme=None, default_token_expiration_in_seconds=None, redirect_urls=None, authorization_urls_by_platform=None)¶ Bases:
object
The account linking information of a skill.
Parameters: - object_type ((optional) ask_smapi_model.v1.skill.account_linking.account_linking_type.AccountLinkingType) –
- authorization_url ((optional) str) – The url where customers will be redirected in the companion app to enter login credentials.
- domains ((optional) list[str]) – The list of domains that the authorization URL will fetch content from.
- client_id ((optional) str) – The unique public string used to identify the client requesting for authentication.
- scopes ((optional) list[str]) – The list of permissions which will be requested from the skill user.
- access_token_url ((optional) str) – The url used for access token and token refresh requests.
- access_token_scheme ((optional) ask_smapi_model.v1.skill.account_linking.access_token_scheme_type.AccessTokenSchemeType) –
- default_token_expiration_in_seconds ((optional) int) – The time in seconds for which access token is valid. If OAuth client returns "expires_in", it will be overwrite this parameter.
- redirect_urls ((optional) list[str]) – The list of valid urls to redirect back to, when the linking process is initiated from a third party system.
- authorization_urls_by_platform ((optional) list[ask_smapi_model.v1.skill.account_linking.account_linking_platform_authorization_url.AccountLinkingPlatformAuthorizationUrl]) – The list of valid authorization urls for allowed platforms to initiate account linking.
-
attribute_map
= {'access_token_scheme': 'accessTokenScheme', 'access_token_url': 'accessTokenUrl', 'authorization_url': 'authorizationUrl', 'authorization_urls_by_platform': 'authorizationUrlsByPlatform', 'client_id': 'clientId', 'default_token_expiration_in_seconds': 'defaultTokenExpirationInSeconds', 'domains': 'domains', 'object_type': 'type', 'redirect_urls': 'redirectUrls', 'scopes': 'scopes'}¶
-
deserialized_types
= {'access_token_scheme': 'ask_smapi_model.v1.skill.account_linking.access_token_scheme_type.AccessTokenSchemeType', 'access_token_url': 'str', 'authorization_url': 'str', 'authorization_urls_by_platform': 'list[ask_smapi_model.v1.skill.account_linking.account_linking_platform_authorization_url.AccountLinkingPlatformAuthorizationUrl]', 'client_id': 'str', 'default_token_expiration_in_seconds': 'int', 'domains': 'list[str]', 'object_type': 'ask_smapi_model.v1.skill.account_linking.account_linking_type.AccountLinkingType', 'redirect_urls': 'list[str]', 'scopes': '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_smapi_model.v1.skill.account_linking.account_linking_type module¶
-
class
ask_smapi_model.v1.skill.account_linking.account_linking_type.
AccountLinkingType
¶ Bases:
enum.Enum
The type of account linking.
Allowed enum values: [AUTH_CODE, IMPLICIT]
-
AUTH_CODE
= 'AUTH_CODE'¶
-
IMPLICIT
= 'IMPLICIT'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-