Skip to content

Config

Accessed via sdk.config on an AspiaSpace instance.

Allows credentials in session to be updated without termination.

Source code in src/aspiaspace/services/config.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
class AspiaSpaceConfig:
    """Allows credentials in session to be updated without termination.
    """
    def __init__(
        self,
        client
        ):
        self._client = client


    def update_customer_credentials(
        self,
        client_id: str,
        client_secret: str,
        scope: str = "",
        ):
        """Update current session credentials

        Args:
            client_id (str): Your client ID
            client_secret (str): Your client secret
            scope (str, optional): The access scope. Defaults to "".
        """
        oauth_client = OAuthClient(
            token_url=self._client.oauth_client.token_url,
            client_id=client_id,
            client_secret=client_secret,
            scope=scope,
        )
        self._client.oauth_client = oauth_client
        self._reset_session()

    def update_api_details(
        self,
        token_url: str,
        request_url: str,
        timeout: int = 30,
        ):
        """Update the urls of your session

        Args:
            token_url (str): Authentication url
            request_url (str): Request URL.
            timeout (int, optional): Session timeout in seconds. Defaults to 30.
        """
        oauth_client = OAuthClient(
            token_url=token_url,
            client_id=self._client.oauth_client.client_id,
            client_secret=self._client.oauth_client.client_secret,
            scope=self._client.oauth_client.scope,
        )
        self._client.base_url = request_url
        self._client.timeout = timeout
        self._client.oauth_client = oauth_client
        self._reset_session()

    def get_config (self):
        """Get your current session details

        Returns:
            parameters (dict): Dictionary of session parameters.
        """
        return {
            "baseUrl":self._client.base_url,
            "timeout":self._client.timeout,
            "tokenUrl":self._client.oauth_client.token_url,
            "client_id":self._client.oauth_client.client_id,
            "client_secret":self._client.oauth_client.client_secret,
            "scope":self._client.oauth_client.scope,

        }

    def _reset_session (self):
        try:
            self.session.close()
        except Exception:
            pass
        self.session = requests.Session()

get_config()

Get your current session details

Returns:

Name Type Description
parameters dict

Dictionary of session parameters.
Source code in src/aspiaspace/services/config.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def get_config (self):
    """Get your current session details

    Returns:
        parameters (dict): Dictionary of session parameters.
    """
    return {
        "baseUrl":self._client.base_url,
        "timeout":self._client.timeout,
        "tokenUrl":self._client.oauth_client.token_url,
        "client_id":self._client.oauth_client.client_id,
        "client_secret":self._client.oauth_client.client_secret,
        "scope":self._client.oauth_client.scope,

    }

update_api_details(token_url, request_url, timeout=30)

Update the urls of your session

Parameters:

Name Type Description Default
token_url str

Authentication url

 required
request_url str

Request URL.

 required
timeout int

Session timeout in seconds. Defaults to 30.

 30
Source code in src/aspiaspace/services/config.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def update_api_details(
    self,
    token_url: str,
    request_url: str,
    timeout: int = 30,
    ):
    """Update the urls of your session

    Args:
        token_url (str): Authentication url
        request_url (str): Request URL.
        timeout (int, optional): Session timeout in seconds. Defaults to 30.
    """
    oauth_client = OAuthClient(
        token_url=token_url,
        client_id=self._client.oauth_client.client_id,
        client_secret=self._client.oauth_client.client_secret,
        scope=self._client.oauth_client.scope,
    )
    self._client.base_url = request_url
    self._client.timeout = timeout
    self._client.oauth_client = oauth_client
    self._reset_session()

update_customer_credentials(client_id, client_secret, scope='')

Update current session credentials

Parameters:

Name Type Description Default
client_id str

Your client ID

 required
client_secret str

Your client secret

 required
scope str

The access scope. Defaults to "".

 ''
Source code in src/aspiaspace/services/config.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def update_customer_credentials(
    self,
    client_id: str,
    client_secret: str,
    scope: str = "",
    ):
    """Update current session credentials

    Args:
        client_id (str): Your client ID
        client_secret (str): Your client secret
        scope (str, optional): The access scope. Defaults to "".
    """
    oauth_client = OAuthClient(
        token_url=self._client.oauth_client.token_url,
        client_id=client_id,
        client_secret=client_secret,
        scope=scope,
    )
    self._client.oauth_client = oauth_client
    self._reset_session()