Skip to content

User Profile

get

Retrieve the profile of the authenticated user

Source code in pyskroutz/resources/users.py 
30
31
32
33
34
35
36
37
@fluent
def get(
    self,
) -> None:
    """Retrieve the profile of the authenticated user"""
    self._set_prepared_request(
        url=f"{self.BASE_URL}/{self.ENDPOINT_PATH}", model=users.UserRetrieve
    )

Example

pyskroutz.user(client).get().execute()

update

Update profile information

Parameters:

Name Type Description Default
**kwargs

Pass the field name and the new value.

 {}
Source code in pyskroutz/resources/users.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
@fluent
def update(self, **kwargs) -> None:
    """
    Update profile information

    Args:
        **kwargs: Pass the field name and the new value.
    """
    self._set_prepared_request(
        url=f"{self.BASE_URL}/{self.ENDPOINT_PATH}",
        model=users.UserRetrieve,
        method="PATCH",
        json=kwargs,
    )

Example

pyskroutz.users(client).update(sex="male", birthyear=1980).execute()

get_avatars

Retrieve the selection of predefined avatars

Source code in pyskroutz/resources/users.py 
54
55
56
57
58
59
@fluent
def get_avatars(self) -> None:
    """Retrieve the selection of predefined avatars"""
    self._set_prepared_request(
        url=f"{self.BASE_URL}/{self.ENDPOINT_PATH}/avatars", model=users.AvatarList
    )

Example

pyskroutz.users(client).get_avatars().execute()

get_addresses

Retrieve user addresses

Source code in pyskroutz/resources/users.py 
61
62
63
64
65
66
67
@fluent
def get_addresses(self) -> None:
    """Retrieve user addresses"""
    self._set_prepared_request(
        url=f"{self.BASE_URL}/{self.ENDPOINT_PATH}/addresses",
        model=users.AddressList,
    )

Example

pyskroutz.users(client).get_addresses().execute()

get_address_form

Retrieve user address form

Source code in pyskroutz/resources/users.py 
69
70
71
72
73
74
75
@fluent
def get_address_form(self) -> None:
    """Retrieve user address form"""
    self._set_prepared_request(
        url=f"{self.BASE_URL}/{self.ENDPOINT_PATH}/addresses/new",
        model=users.AddressFormRetrieve,
    )

Example

pyskroutz.users(client).get_address_form().execute()

new_address_form

Retrieve user address form

Source code in pyskroutz/resources/users.py 
69
70
71
72
73
74
75
@fluent
def get_address_form(self) -> None:
    """Retrieve user address form"""
    self._set_prepared_request(
        url=f"{self.BASE_URL}/{self.ENDPOINT_PATH}/addresses/new",
        model=users.AddressFormRetrieve,
    )

Example

pyskroutz.users(client).new_address_form(
    label="home", first_name="bill", last_name="Testopoulos",
    street_name="Panagouli", street_number="61",
    city="Nea Ionia", zip=14123, reqion_id=5
).execute()

update_address

Update an existing user address

Parameters:

Name Type Description Default
_id

Addres identifier

 required
**address_kwargs

label: address label first_name: first name last_name: last name street_name: street name street_number: street number city: city zip: zip code reqion_id: region id phone: phone number mobile: mobile number lng: longtitude lat: latitude

 {}
Source code in pyskroutz/resources/users.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
@fluent
def update_address(self, _id, **address_kwargs) -> None:
    """Update an existing user address

    Args:
        _id: Addres identifier
        **address_kwargs:
            label: address label
            first_name: first name
            last_name: last name
            street_name: street name
            street_number: street number
            city: city
            zip: zip code
            reqion_id: region id
            phone: phone number
            mobile: mobile number
            lng: longtitude
            lat: latitude
    """
    self._set_prepared_request(
        url=f"{self.BASE_URL}/{self.ENDPOINT_PATH}/addresses/{_id}",
        model=users.AddressItem,
        json=address_kwargs,
        method="POST",
    )

Example

pyskroutz.users(client).update_address(
    48937, street_number=62
).execute()

delete_address

Delete an existing user address

Parameters:

Name Type Description Default
_id

Address identifier

 required
Source code in pyskroutz/resources/users.py 
130
131
132
133
134
135
136
137
138
139
140
141
@fluent
def delete_address(self, _id) -> None:
    """Delete an existing user address

    Args:
        _id: Address identifier
    """
    self._set_prepared_request(
        url=f"{self.BASE_URL}/{self.ENDPOINT_PATH}/addresses/{_id}",
        method="DELETE",
        model=None,
    )

Example

pyskroutz.users(client).delete_address(48937).execute()

saved_orders

User saved orders

Source code in pyskroutz/resources/users.py 
143
144
145
146
147
148
149
@fluent
def saved_orders(self) -> None:
    """User saved orders"""
    self._set_prepared_request(
        url=f"{self.BASE_URL}/{self.ENDPOINT_PATH}/saved_orders",
        model=users.SavedOrdersList,
    )

Example

pyskroutz.user(client).saved_orders().execute()

logout

User logout

Source code in pyskroutz/resources/users.py 
151
152
153
154
155
156
157
158
@fluent
def logout(self) -> None:
    """User logout"""
    self._set_prepared_request(
        url=f"{self.BASE_URL}/{self.ENDPOINT_PATH}/logout",
        model=None,
        method="DELETE",
    )

Example

pyskroutz.users(client).logout().execute()

Response Models

Response models for User resources