Skip to content

Login models

Auth

Bases: BaseModel

class representing the authentication of the ClashOfClans API login

Source code in pyclasher/api/models/login/login_models.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class Auth(BaseModel):
    def __init__(self, data):
        super().__init__(data)
        return

    @property
    def uid(self):
        return self._get_data('uid')

    @property
    def token(self):
        return self._get_data('token')

    @property
    def ua(self):
        return self._get_data('ua')

    @property
    def ip(self):
        return self._get_data('ip')

token: str property

user token

:return: the user token :rtype: str

ua property

user agent of the authentication

:return: the user agent of the authentication

uid: str property

user id of the authentication

:return: the user id :rtype: str

Developer

Bases: BaseModel

class representing the developer that logged in via the ClashOfClans login API

Source code in pyclasher/api/models/login/login_models.py 
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
class Developer(BaseModel):
    @property
    def id(self):
        return self._get_data('id')

    @property
    def name(self):
        return self._get_data('name')

    @property
    def game(self):
        return self._get_data('game')

    @property
    def email(self):
        return self._get_data('email')

    @property
    def tier(self):
        return self._get_data('tier')

    @property
    def allowed_scopes(self):
        return self._get_data('allowedScopes')

    @property
    def max_cidrs(self):
        return self._get_data('maxCidrs')

    @property
    def prev_login_ts(self):
        return self._get_data('prevLoginTs')

    @property
    def prev_login_ip(self):
        return self._get_data('prevLoginIp')

    @property
    def prev_login_ua(self):
        return self._get_data('prevLoginUa')

allowed_scopes property

allowed scopes of the developer

:return: the developer's allowed scopes

email: str property

email address of the developer

:return: the developer's email address :rtype: str

game: str property

game of the developer

:return: the developer's name :rtype: str

id: str property

id of the developer

:return: the developer's id :rtype: str

max_cidrs property

max cidrs of the developer

:return: the developer's max cidrs

name: str property

name of the developer

:return: the developer's name :rtype: str

prev_login_ip: str property

previous login ip address of the developer

:return: the developer's previous login ip address :rtype: str

prev_login_ts: str property

previous login timestamp of the developer

:return: the developer's previous login timestamp :rtype: str

prev_login_ua: str property

previous login user agent of the developer

:return: the developer's previous login user agent :rtype: str

tier: str property

tier of the developer

:return: the developer's tier :rtype: str

LoginModel

Bases: BaseModel

login model class

Source code in pyclasher/api/models/login/login_models.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
class LoginModel(BaseModel):
    @property
    def status(self):
        return Status(self._get_data('status'))

    @property
    def session_expires_in_seconds(self):
        return self._get_data('sessionExpiresInSeconds')

    @property
    def auth(self):
        return Auth(self._get_data('auth'))

    @property
    def developer(self):
        return Developer(self._get_data('developer'))

    @property
    def temporary_api_token(self):
        return self._get_data('temporaryAPIToken')

    @property
    def swagger_url(self):
        return self._get_data('swaggerUrl')

auth: Auth property

login authentication

:return: the login's authentication :rtype: Auth

developer: Developer property

developer of the login

:return: the developer that logged in :rtype: Developer

session_expires_in_seconds: int property

expiration duration of the login in seconds

:return: the login's expiration duration in seconds :rtype: int

status: Status property

login status

:return: the login status :rtype: Status

swagger_url: str property

swagger URL (usually https://api.clashofclans.com/v1)

:return: the swagger URL :rtype: str

temporary_api_token: str property

returned temporary API token

:return: the returned temporary API token :rtype: str

Status

Bases: BaseModel

class representing the status of the ClashOfClans API login

Source code in pyclasher/api/models/login/login_models.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
class Status(BaseModel):
    """
    class representing the status of the ClashOfClans API login
    """

    @property
    def code(self):
        return self._get_data('code')

    @property
    def message(self):
        return self._get_data('message')

    @property
    def detail(self):
        return self._get_data('detail')

code: int property

status code

:return: the status code :rtype: int

message: str property

status message

:return: the status message :rtype: str