vtexpy 0.0.0b12__tar.gz → 0.0.0b13__tar.gz

{vtexpy-0.0.0b12 → vtexpy-0.0.0b13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vtexpy
-Version: 0.0.0b12
+Version: 0.0.0b13
 Summary: Unofficial Python SDK for VTEX API
 Home-page: https://github.com/lvieirajr/vtex-python
 License: MIT

{vtexpy-0.0.0b12 → vtexpy-0.0.0b13}/pyproject.toml

@@ -32,7 +32,7 @@ classifiers = [
 packages = [
     {include = "vtex"},
 ]
-version = "0.0.0b12"
+version = "0.0.0b13"
 
 [build-system]
 requires = ["poetry-core"]

vtexpy-0.0.0b13/vtex/_api/license_manager.py

@@ -0,0 +1,74 @@
+from typing import Any, List, Union
+
+from .._constants import LIST_ROLES_MAX_PAGE_SIZE, LIST_ROLES_START_PAGE, MIN_PAGE_SIZE
+from .._dto import VTEXDataResponse, VTEXItemsResponse, VTEXPaginatedItemsResponse
+from .._sentinels import UNDEFINED, UndefinedSentinel
+from .._types import OrderingDirectionType
+from .base import BaseAPI
+from .types.license_manager import GetAccountData, ListRolesData, Role, UserRole
+
+
+class LicenseManagerAPI(BaseAPI):
+    """
+    Client for the License Manager API.
+    https://developers.vtex.com/docs/api-reference/license-manager-api
+    """
+
+    ENVIRONMENT = "vtexcommercestable"
+
+    def get_account(self, **kwargs: Any) -> VTEXDataResponse[GetAccountData]:
+        return self._request(
+            method="GET",
+            environment=self.ENVIRONMENT,
+            endpoint="/api/vlm/account",
+            config=self.client.config.with_overrides(**kwargs),
+            response_class=VTEXDataResponse[GetAccountData],
+        )
+
+    def get_user_roles(
+        self,
+        user_id: Union[str, UndefinedSentinel] = UNDEFINED,
+        **kwargs: Any,
+    ) -> VTEXItemsResponse[List[UserRole], UserRole]:
+        config = self.client.config.with_overrides(**kwargs)
+
+        if not user_id:
+            app_keys = {
+                app_key["app_key"]: app_key
+                for app_key in self.get_account().data["app_keys"]
+            }
+
+            user_id = app_keys[config.get_app_key()]["id"]
+
+        return self._request(
+            method="GET",
+            environment=self.ENVIRONMENT,
+            endpoint=f"/api/license-manager/users/{user_id}/roles",
+            config=config,
+            response_class=VTEXItemsResponse[List[UserRole], UserRole],
+        )
+
+    def list_roles(
+        self,
+        order_by_field: str = "id",
+        order_by_direction: OrderingDirectionType = "DESC",
+        page: int = LIST_ROLES_START_PAGE,
+        page_size: int = LIST_ROLES_MAX_PAGE_SIZE,
+        **kwargs: Any,
+    ) -> VTEXPaginatedItemsResponse[ListRolesData, Role]:
+        return self._request(
+            method="GET",
+            environment=self.ENVIRONMENT,
+            endpoint="/api/license-manager/site/pvt/roles/list/paged",
+            params={
+                "sort": order_by_field,
+                "sortType": order_by_direction,
+                "pageNumber": max(page, LIST_ROLES_START_PAGE),
+                "numItems": max(
+                    min(page_size, LIST_ROLES_MAX_PAGE_SIZE),
+                    MIN_PAGE_SIZE,
+                ),
+            },
+            config=self.client.config.with_overrides(**kwargs),
+            response_class=VTEXPaginatedItemsResponse[ListRolesData, Role],
+        )

{vtexpy-0.0.0b12 → vtexpy-0.0.0b13}/vtex/_api/orders.py

@@ -31,7 +31,7 @@ class OrdersAPI(BaseAPI):
         creation_date_to: Union[datetime, UndefinedSentinel] = UNDEFINED,
         incomplete: bool = False,
         order_by_field: str = "creationDate",
-        order_by_direction: OrderingDirectionType = "desc",
+        order_by_direction: OrderingDirectionType = "DESC",
         page: int = LIST_ORDERS_START_PAGE,
         page_size: int = LIST_ORDERS_MAX_PAGE_SIZE,
         **kwargs: Any,

vtexpy-0.0.0b13/vtex/_api/types/generic.py

@@ -0,0 +1,22 @@
+from typing import TypedDict
+
+
+class CurrentPagePagination(TypedDict, total=True):
+    current_page: int
+    pages: int
+    per_page: int
+    total: int
+
+
+class PagePagination(TypedDict, total=True):
+    page: int
+    pages: int
+    per_page: int
+    total: int
+
+
+class RowsPagination(TypedDict, total=True):
+    page: int
+    size: int
+    total_page: int
+    total_rows: int

vtexpy-0.0.0b13/vtex/_api/types/license_manager.py

@@ -0,0 +1,50 @@
+from typing import List, TypedDict, Union
+
+from .generic import PagePagination
+
+
+class AccountAppKey(TypedDict, total=False):
+    app_key: str
+    id: str
+    is_active: bool
+    is_blocked: bool
+    label: str
+
+
+class GetAccountData(TypedDict, total=False):
+    account_name: str
+    app_keys: List[AccountAppKey]
+    company_name: str
+    creation_date: str
+    have_parent_account: bool
+    id: str
+    inactivation_date: Union[str, None]
+    is_active: bool
+    is_operating: bool
+    name: str
+    operation_date: Union[str, None]
+    parent_account_id: Union[str, None]
+    parent_account_name: Union[str, None]
+    trading_name: str
+
+
+class UserRole(TypedDict, total=False):
+    id: int
+    name: str
+
+
+class RoleProduct(TypedDict, total=False):
+    name: str
+
+
+class Role(TypedDict, total=False):
+    id: int
+    is_admin: bool
+    name: str
+    products: List[RoleProduct]
+    role_type: int
+
+
+class ListRolesData(TypedDict, total=False):
+    items: List[Role]
+    paging: PagePagination

{vtexpy-0.0.0b12 → vtexpy-0.0.0b13}/vtex/_constants.py

@@ -50,6 +50,10 @@ LIST_CATEGORIES_MAX_PAGE_SIZE = 50
 
 GET_CATEGORY_TREE_MAX_LEVELS = 1_000_000
 
+# License Manager
+LIST_ROLES_START_PAGE = 1
+LIST_ROLES_MAX_PAGE_SIZE = 1_000
+
 # Logistics
 LIST_CARRIERS_START_PAGE = 1
 LIST_CARRIERS_MAX_PAGE_SIZE = 1_000

vtexpy-0.0.0b12/vtex/_api/license_manager.py

@@ -1,23 +0,0 @@
-from typing import Any
-
-from .._dto import VTEXDataResponse
-from .base import BaseAPI
-from .types.license_manager import GetAccountData
-
-
-class LicenseManagerAPI(BaseAPI):
-    """
-    Client for the License Manager API.
-    https://developers.vtex.com/docs/api-reference/license-manager-api
-    """
-
-    ENVIRONMENT = "vtexcommercestable"
-
-    def get_account(self, **kwargs: Any) -> VTEXDataResponse[GetAccountData]:
-        return self._request(
-            method="GET",
-            environment=self.ENVIRONMENT,
-            endpoint="/api/vlm/account",
-            config=self.client.config.with_overrides(**kwargs),
-            response_class=VTEXDataResponse[GetAccountData],
-        )

vtexpy-0.0.0b12/vtex/_api/types/license_manager.py

@@ -1,17 +0,0 @@
-from typing import TypedDict, Union
-
-
-class GetAccountData(TypedDict, total=False):
-    account_name: str
-    company_name: str
-    creation_date: str
-    have_parent_account: bool
-    id: str
-    inactivation_date: Union[str, None]
-    is_active: bool
-    is_operating: bool
-    name: str
-    operation_date: Union[str, None]
-    parent_account_id: Union[str, None]
-    parent_account_name: Union[str, None]
-    trading_name: str