Skip to content

User Favorite

get_lists

List favorite lists

Source code in pyskroutz/resources/favorites.py 
15
16
17
18
19
20
21
22
@fluent
def get_lists(
    self,
) -> None:
    """List favorite lists"""
    self._set_prepared_request(
        url=f"{self.BASE_URL}/favorite_lists", model=favorites.FavoriteList
    )

Example

pyskroutz.favorites(client).get_lists().execute()

create_list

Create a favorite_list. It trying to create a custom list with the same name as an existing custom list you will be presented with an error message.

Parameters:

Name Type Description Default
name str

favorite list name

 required
Source code in pyskroutz/resources/favorites.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
@fluent
def create_list(self, name: str) -> None:
    """Create a favorite_list.
    It trying to create a custom list with the same name as an
    existing custom list you will be presented with an error message.

    Args:
        name: favorite list name
    """
    self._set_prepared_request(
        url=f"{self.BASE_URL}/favorite_lists",
        model=favorites.FavoriteListRetrieve,
        method="POST",
        json={"favorite_list": {"name": name}},
    )

Example

pyskroutz.favorites(client).create_list("test name").execute()

destroy_list

Destroy a favorite_list. The response status is 204 and with an empty response body when resource is destroyed. Status code is 404 when the resource does not exist.

Parameters:

Name Type Description Default
id int

favorite list identifier

 required
Source code in pyskroutz/resources/favorites.py 
40
41
42
43
44
45
46
47
48
49
50
51
@fluent
def destroy_list(self, id: int) -> None:
    """Destroy a favorite_list.
    The response status is 204 and with an empty response body when resource is destroyed.
    Status code is 404 when the resource does not exist.

    Args:
        id: favorite list identifier
    """
    self._set_prepared_request(
        url=f"{self.BASE_URL}/favorite_lists/{id}", model=None, method="DELETE"
    )

Example

pyskroutz.favorites(client).destroy_list(973812).execute()

list_favorites

List favorites (all or specify a favorite list)

Source code in pyskroutz/resources/favorites.py 
53
54
55
56
57
58
59
60
61
@fluent
def list_favorites(self, favorite_list: Optional[int] = None) -> None:
    """List favorites (all or specify a favorite list)"""
    self._set_prepared_request(
        url=f"{self.BASE_URL}/favorites"
        if favorite_list is None
        else f"{self.BASE_URL}/favorite_lists/{favorite_list}/favorites",
        model=favorites.FavoriteList,
    )

Example

pyskroutz.favorites(client).list_favorites().execute()

get_favorite

Retrieve a single favorite

Parameters:

Name Type Description Default
id int

favorite identifier

 required
Source code in pyskroutz/resources/favorites.py 
63
64
65
66
67
68
69
70
71
72
@fluent
def get_favorite(self, id: int) -> None:
    """Retrieve a single favorite

    Args:
        id: favorite identifier
    """
    self._set_prepared_request(
        url=f"{self.BASE_URL}/favorites/{id}", model=favorites.FavoriteRetrieve
    )

Example

pyskroutz.favorites(client).get_favorite(5896665).execute()

create_favorite

Create a new favorite

Parameters:

Name Type Description Default
sku_id int

SKU identifier

 required
Source code in pyskroutz/resources/favorites.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
@fluent
def create_favorite(self, sku_id: int) -> None:
    """Create a new favorite

    Args:
        sku_id: SKU identifier
    """
    self._set_prepared_request(
        url=f"{self.BASE_URL}/favorites",
        model=favorites.FavoriteRetrieve,
        method="POST",
        json={"favorite": {"sku_id": sku_id}},
    )

Example

pyskroutz.favorites(client).create_favorite(7957675).execute()

destroy_favorite

Destroy a favorite

Parameters:

Name Type Description Default
id int

Favorite identifier

 required
Source code in pyskroutz/resources/favorites.py 
88
89
90
91
92
93
94
95
96
97
98
99
@fluent
def destroy_favorite(self, id: int) -> None:
    """Destroy a favorite

    Args:
        id: Favorite identifier
    """
    self._set_prepared_request(
        url=f"{self.BASE_URL}/favorites/{id}",
        model=None,
        method="DELETE",
    )

Example

pyskroutz.favorites(client).destroy_favorite(5896665).execute()

Response Models

Response models for User resources