masstack-python-client 0.0.5__tar.gz → 0.1.0__tar.gz

{masstack_python_client-0.0.5/src/masstack_python_client.egg-info → masstack_python_client-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: masstack-python-client
-Version: 0.0.5
+Version: 0.1.0
 Summary: This Python API client provides access to masmovil core API domains
 Author-email: Borja Gimeno <borja.gimeno@somconnexio.coop>
 License: GPL-3.0-only
@@ -25,36 +25,37 @@ This Python API client provides access to masmovil core API domains.
 
 ## Resources
 
-* Feasibility
-    - Coverage - find an address
-        - Streets:
-            - search: returns a list of street by text
-            - get_building_info_by_street: returns a list of building info by street id
-        - Buildings:
-            - search: returns a list of buildings by text
-            - multi_search: returns a list of buildings by request body
-            - get: returns a building by id with a list of units
-        - Units:
-            - get: returns a unit by id with a list of coverages
-            - get_coverage: returns coverage info for a unit id and territory_owner
-    - Portability - Checks if a landline portability or an access transfer is allowed
-        - PortabilityCheck:
-            - check: Returns whether the portability process can be carried out and whether it requires a new installation
-
-* Customers
-    - Signups - access to signups new clients
-        - post new client
-    - Users
-        - returns customer tree data associated to a given document identification, email or number of the client. 
-        - returns user data by userId
-
-* Catalogue
-    - bundled_products - access to bundled products
-        - get sellable bundled products
-
-* Provision inventory network
-    - fixed - Obtain fixed numbering for sale
-        - get number
+- **Feasibility**
+	-  Coverage - find an address
+		- Streets:
+			- *search: returns a list of street by text*
+			- *get_building_info_by_street: returns a list of building info by street id*
+		- Buildings:
+			- *search: returns a list of buildings by text*
+			- *multi_search: returns a list of buildings by request body*
+			- *get: returns a building by id with a list of units*
+		- Units:
+			- *get: returns a unit by id with a list of coverages*
+			- *get_coverage: returns coverage info for a unit id and territory_owner*
+	- Portability - Checks if a landline portability or an access transfer is allowed
+		- PortabilityCheck:
+			- *check: Returns whether the portability process can be carried out and whether it requires a new* installation
+
+- **Customers**
+	- Signups - access to signups new clients
+		- *post new client*
+	- Users
+		- *returns customer tree data associated to a given document identification, email or number of the client.*
+		- *returns user data by userId*
+
+- **Catalogue**
+	- bundled_products - access to bundled products
+		- Sellable:
+			- *get: Returns sellable bundled products*
+
+- **Provision inventory network**
+	- fixed - Obtain fixed numbering for sale
+		- *get number*
 
 
 ## Installation

{masstack_python_client-0.0.5 → masstack_python_client-0.1.0}/README.md

@@ -8,36 +8,37 @@ This Python API client provides access to masmovil core API domains.
 
 ## Resources
 
-* Feasibility
-    - Coverage - find an address
-        - Streets:
-            - search: returns a list of street by text
-            - get_building_info_by_street: returns a list of building info by street id
-        - Buildings:
-            - search: returns a list of buildings by text
-            - multi_search: returns a list of buildings by request body
-            - get: returns a building by id with a list of units
-        - Units:
-            - get: returns a unit by id with a list of coverages
-            - get_coverage: returns coverage info for a unit id and territory_owner
-    - Portability - Checks if a landline portability or an access transfer is allowed
-        - PortabilityCheck:
-            - check: Returns whether the portability process can be carried out and whether it requires a new installation
-
-* Customers
-    - Signups - access to signups new clients
-        - post new client
-    - Users
-        - returns customer tree data associated to a given document identification, email or number of the client. 
-        - returns user data by userId
-
-* Catalogue
-    - bundled_products - access to bundled products
-        - get sellable bundled products
-
-* Provision inventory network
-    - fixed - Obtain fixed numbering for sale
-        - get number
+- **Feasibility**
+	-  Coverage - find an address
+		- Streets:
+			- *search: returns a list of street by text*
+			- *get_building_info_by_street: returns a list of building info by street id*
+		- Buildings:
+			- *search: returns a list of buildings by text*
+			- *multi_search: returns a list of buildings by request body*
+			- *get: returns a building by id with a list of units*
+		- Units:
+			- *get: returns a unit by id with a list of coverages*
+			- *get_coverage: returns coverage info for a unit id and territory_owner*
+	- Portability - Checks if a landline portability or an access transfer is allowed
+		- PortabilityCheck:
+			- *check: Returns whether the portability process can be carried out and whether it requires a new* installation
+
+- **Customers**
+	- Signups - access to signups new clients
+		- *post new client*
+	- Users
+		- *returns customer tree data associated to a given document identification, email or number of the client.*
+		- *returns user data by userId*
+
+- **Catalogue**
+	- bundled_products - access to bundled products
+		- Sellable:
+			- *get: Returns sellable bundled products*
+
+- **Provision inventory network**
+	- fixed - Obtain fixed numbering for sale
+		- *get number*
 
 
 ## Installation

{masstack_python_client-0.0.5 → masstack_python_client-0.1.0}/src/masstack_python_client/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.5"
+__version__ = "0.1.0"
 __homepage__ = "https://somconnexio.coop/"
 __author__ = "Borja Gimeno <borja.gimeno@somconnexio.coop>"
 __license__ = "GPL-3.0-only"

masstack_python_client-0.1.0/src/masstack_python_client/resources/base.py

@@ -0,0 +1,59 @@
+from typing import Optional, Union
+from masstack_python_client.client import MasstackClient
+
+
+class BaseResource:
+    __abstract__ = True
+
+    required_class_attributes = (
+        "_api_path",
+        "_api_domain",
+        "_version",
+    )
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+
+        if cls.__dict__.get("__abstract__", False):
+            return
+
+        missing = [
+            attr for attr in cls.required_class_attributes if not hasattr(cls, attr)
+        ]
+
+        if missing:
+            raise TypeError(
+                f"{cls.__name__} missing required class attributes: "
+                f"{', '.join(missing)}"
+            )
+
+    @classmethod
+    def _get_endpoint(cls, suffix: str = "") -> str:
+        parts = [
+            cls._api_path,
+            getattr(cls, "_api_subpath", ""),
+            suffix,
+        ]
+        return "/".join(part.strip("/") for part in parts if part)
+
+    @classmethod
+    def _request(
+        cls,
+        *,
+        method: str,
+        suffix: Optional[str] = "",
+        header: Optional[dict] = None,
+        data: Optional[dict] = None,
+        params: Optional[dict] = None,
+    ) -> Union[dict, list]:
+        client = MasstackClient()
+        func = getattr(client, method)
+
+        return func(
+            api=cls._api_domain,
+            version=cls._version,
+            endpoint=cls._get_endpoint(suffix),
+            params=params,
+            data=data,
+            header=header,
+        )

{masstack_python_client-0.0.5 → masstack_python_client-0.1.0}/src/masstack_python_client/resources/catalogue.py

@@ -1,5 +1,9 @@
 from typing import Optional, List
-from masstack_python_client.client import MasstackClient
+from masstack_python_client.resources.base import BaseResource
+from masstack_python_client.resources.enums.customer_type_name import CustomerTypeName
+from masstack_python_client.resources.enums.sale_type_name import SaleTypeName
+from masstack_python_client.resources.enums.technology_name import TechnologyName
+from masstack_python_client.resources.models.bundled import BundledProduct
 from masstack_python_client.resources.enums.bundled_product_category import (
     BundleCategory,
 )
@@ -9,50 +13,25 @@ from masstack_python_client.resources.enums.commercial_segment_name import (
 from masstack_python_client.resources.enums.customer_segment_name import (
     CustomerSegmentName,
 )
-from masstack_python_client.resources.enums.customer_type_name import CustomerTypeName
-from masstack_python_client.resources.enums.sale_type_name import SaleTypeName
-from masstack_python_client.resources.enums.technology_name import TechnologyName
-from masstack_python_client.resources.models.bundled import BundledProduct
+from masstack_python_client.resources.utils.serialize import remove_none
 
 
-class CatalogueResource:
+class CatalogueResource(BaseResource):
     """Support sales and post-sales operations from catalogue perspective
     https://developers.masstack.com/en/docs/apis_catalogue_doc_swagger/2/apioverview/
     """
 
+    __abstract__ = True
     _api_domain = "catalogue"
 
 
 class BundledProducts(CatalogueResource):
+    __abstract__ = True
     _api_path = "bundled_products"
     _version = "v2"
 
-    @classmethod
-    def _get_endpoint(cls, subpath: str) -> str:
-        return f"{cls._api_path}/{subpath}"
-
-    @classmethod
-    def _request(
-        cls,
-        method: str,
-        subpath: str,
-        params: Optional[dict] = None,
-        data: Optional[dict] = None,
-    ) -> dict:
-        client = MasstackClient()
-        func = getattr(client, method)
-
-        return func(
-            api=cls._api_domain,
-            version=cls._version,
-            endpoint=cls._get_endpoint(subpath),
-            params=params,
-            data=data,
-        )
-
 
 class Sellable(BundledProducts):
-
     _api_subpath = "sellable"
 
     @classmethod
@@ -87,22 +66,22 @@ class Sellable(BundledProducts):
         """
         params = {
             "commercial_profile_name": commercial_profile_name,
-            "technology_name": technology_name,
+            "technology_name": technology_name.value if technology_name else None,
             "territory_owner_id": territory_owner_id,
-            "category": category,
-            "customer_segment_name": customer_segment_name,
-            "commercial_segment_name": commercial_segment_name,
-            "customer_type_name": customer_type_name,
-            "sale_type_name": sale_type_name,
+            "category": category.value if category else None,
+            "customer_segment_name": (
+                customer_segment_name.value if customer_segment_name else None
+            ),
+            "commercial_segment_name": (
+                commercial_segment_name.value if commercial_segment_name else None
+            ),
+            "customer_type_name": (
+                customer_type_name.value if customer_type_name else None
+            ),
+            "sale_type_name": sale_type_name.value if sale_type_name else None,
         }
         sellable_bundled_products = cls._request(
-            "get",
-            cls._api_subpath,
-            {
-                k: (v.value if hasattr(v, "value") else v)
-                for k, v in params.items()
-                if v is not None
-            },
+            method="get", params=remove_none(params)
         )
         return [
             BundledProduct.from_dict(**sellable_bundled_product)

{masstack_python_client-0.0.5 → masstack_python_client-0.1.0}/src/masstack_python_client/resources/customers.py

@@ -1,7 +1,7 @@
-from typing import Optional
 from dataclasses import asdict
-
-from masstack_python_client.client import MasstackClient
+from masstack_python_client.resources.base import BaseResource
+from masstack_python_client.resources.models.user import UserData
+from masstack_python_client.resources.utils.serialize import remove_none
 from masstack_python_client.resources.enums.document_type_search import (
     DocumentTypeSearch,
 )
@@ -9,37 +9,17 @@ from masstack_python_client.resources.models.signup import (
     SignupRequestData,
     SignupsResponseData,
 )
-from masstack_python_client.resources.models.user import UserData
-from masstack_python_client.resources.utils.serialize import remove_none
 
 
-class CustomersResource:
+class CustomersResource(BaseResource):
     """Provide the necessary functionality to be able to give
     E2E coverage to the entire life-cycle of a client
     https://developers.masstack.com/en/docs/apis_customers_doc_swagger/2/apioverview
     """
 
+    __abstract__ = True
     _api_domain = "customers"
 
-    @classmethod
-    def _request(
-        cls,
-        method: str,
-        endpoint: str,
-        params: Optional[dict] = None,
-        data: Optional[dict] = None,
-    ) -> dict:
-        client = MasstackClient()
-        func = getattr(client, method)
-
-        return func(
-            api=cls._api_domain,
-            version=cls._version,
-            endpoint=endpoint,
-            params=params,
-            data=data,
-        )
-
 
 class SignupsResource(CustomersResource):
     _api_path = "signups"
@@ -58,7 +38,6 @@ class SignupsResource(CustomersResource):
         payload = remove_none(asdict(customer_data))
         result = cls._request(
             method="post",
-            endpoint=cls._api_path,
             data=payload,
         )
 
@@ -86,10 +65,7 @@ class Users(CustomersResource):
             user id.
         """
         data = {"document_type": doc_type.value, "document": doc}
-
-        return cls._request(method="post", endpoint=f"{cls._api_path}/tree", data=data)[
-            "id"
-        ]
+        return cls._request(method="post", suffix="tree", data=data)["id"]
 
     @classmethod
     def get_user_by_id(cls, user_id: str) -> dict:
@@ -102,5 +78,5 @@ class Users(CustomersResource):
         Returns:
             UserData
         """
-        user = cls._request(method="get", endpoint=f"{cls._api_path}/{user_id}")
+        user = cls._request(method="get", suffix=user_id)
         return UserData.from_dict(**user)

{masstack_python_client-0.0.5 → masstack_python_client-0.1.0}/src/masstack_python_client/resources/feasibility.py

@@ -1,7 +1,8 @@
 import os
-from typing import Optional, List
-from masstack_python_client.client import MasstackClient
+from typing import Optional, List, Union
+from masstack_python_client.resources.base import BaseResource
 from masstack_python_client.resources.enums.technology import Technology
+from masstack_python_client.resources.models.portability import PortabilityData
 from masstack_python_client.resources.models.address import (
     BuildingData,
     ClarifierData,
@@ -9,62 +10,35 @@ from masstack_python_client.resources.models.address import (
     StreetData,
     UnitData,
 )
-from masstack_python_client.resources.models.portability import PortabilityData
-
 
 """
-FeasibilityResource
-├── Coverage
-│   ├── Streets
-│   ├── Buildings
-│   └── Units
-└── Portability
-    └── PortabilityCheck
+BaseResource
+└──FeasibilityResource
+    ├── Coverage
+    │   ├── Streets
+    │   ├── Buildings
+    │   └── Units
+    └── Portability
+        └── PortabilityCheck
 """
 
 
-class FeasibilityResource:
+class FeasibilityResource(BaseResource):
     """Resource for feasibility operations
     https://developers.masstack.com/en/docs/apis_feasibility_doc_swagger/1/apioverview
     """
 
+    __abstract__ = True
     _api_domain = "feasibility"
 
-    @classmethod
-    def _get_endpoint(cls, suffix: str) -> str:
-        return f"{cls._api_path}/{cls._api_subpath}{suffix}"
-
-    @classmethod
-    def _request(
-        cls,
-        *,
-        method: str,
-        suffix: Optional[str] = "",
-        header: Optional[dict] = None,
-        data: Optional[dict] = None,
-        params: Optional[dict] = None,
-    ) -> dict | list:
-        client = MasstackClient()
-        func = getattr(client, method)
-
-        return func(
-            api=cls._api_domain,
-            version=cls._version,
-            endpoint=cls._get_endpoint(suffix),
-            params=params,
-            data=data,
-            header=header,
-        )
-
 
 class Portability(FeasibilityResource):
-
+    __abstract__ = True
     _api_path = "portability"
     _version = "v2"
 
 
 class PortabilityCheck(Portability):
-
     _api_subpath = "portabilityCheck"
 
     @classmethod
@@ -105,7 +79,7 @@ class PortabilityCheck(Portability):
 
 
 class Coverage(FeasibilityResource):
-
+    __abstract__ = True
     _api_path = "coverage"
     _version = "v1"
 
@@ -126,12 +100,11 @@ class Coverage(FeasibilityResource):
         }
 
     @classmethod
-    def _request(cls, *, uuid: str, **kwargs) -> dict | list:
+    def _request(cls, *, uuid: str, **kwargs) -> Union[dict, list]:
         return super()._request(header=cls._get_header(uuid), **kwargs)
 
 
 class Streets(Coverage):
-
     _api_subpath = "streets"
 
     @classmethod
@@ -169,7 +142,7 @@ class Streets(Coverage):
         """
         clarifiers = cls._request(
             method="get",
-            suffix=f"/clarifiers/{street_id}",
+            suffix=f"clarifiers/{street_id}",
             uuid=uuid,
         )
 
@@ -177,7 +150,6 @@ class Streets(Coverage):
 
 
 class Buildings(Coverage):
-
     _api_subpath = "buildings"
 
     @classmethod
@@ -218,7 +190,7 @@ class Buildings(Coverage):
         """
         building = cls._request(
             method="get",
-            suffix=f"/{id}",
+            suffix=id,
             uuid=uuid,
             params={"unit_to_data": unit_to_data},
         )
@@ -257,7 +229,7 @@ class Buildings(Coverage):
 
         buildings = cls._request(
             method="post",
-            suffix="/search",
+            suffix="search",
             uuid=uuid,
             data={
                 "way_name": way_name,
@@ -273,7 +245,6 @@ class Buildings(Coverage):
 
 
 class Units(Coverage):
-
     _api_subpath = "units"
 
     @classmethod
@@ -293,7 +264,7 @@ class Units(Coverage):
         """
         unit = cls._request(
             method="get",
-            suffix=f"/{unit_id}",
+            suffix=unit_id,
             uuid=uuid,
             params={"parent_coverage": parent_coverage},
         )
@@ -321,7 +292,7 @@ class Units(Coverage):
         """
         unit = cls._request(
             method="get",
-            suffix="/extra",
+            suffix="extra",
             uuid=uuid,
             params={"id": unit_id, "territory_owner": territory_owner},
         )

{masstack_python_client-0.0.5 → masstack_python_client-0.1.0}/src/masstack_python_client/resources/models/portability.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from typing import Optional
 
 
 @dataclass(frozen=True)
@@ -23,17 +24,21 @@ class PortabilityData:
     isPortable: bool
     installationRequired: bool
     operator: OperatorData
-    installationInfo: InstallationInfoData
+    installationInfo: Optional[InstallationInfoData] = None
 
     @classmethod
     def from_dict(
         cls,
         operator,
-        installationInformation,
+        installationInformation=None,
         **kwargs,
     ):
         return cls(
             operator=OperatorData(**operator),
-            installationInfo=InstallationInfoData(**installationInformation),
+            installationInfo=(
+                InstallationInfoData(**installationInformation)
+                if installationInformation
+                else None
+            ),
             **kwargs,
         )

{masstack_python_client-0.0.5 → masstack_python_client-0.1.0}/src/masstack_python_client/resources/provision.py

@@ -1,14 +1,14 @@
-from typing import Optional
-from masstack_python_client.client import MasstackClient
+from masstack_python_client.resources.base import BaseResource
 from masstack_python_client.resources.models.fixed_phone import FixedPhoneData
 
 
 "https://provision-inventory-network.sta.masstack.com/v1/orgs/marblanca/fixed/number"
 
 
-class ProvisionNetworkResource:
+class ProvisionNetworkResource(BaseResource):
     """not documented"""
 
+    __abstract__ = True
     _api_domain = "provision-inventory-network"
 
 
@@ -16,29 +16,6 @@ class FixedPhone(ProvisionNetworkResource):
     _api_path = "fixed"
     _version = "v1"
 
-    @classmethod
-    def _get_endpoint(cls, subpath: str) -> str:
-        return f"{cls._api_path}/{subpath}"
-
-    @classmethod
-    def _request(
-        cls,
-        method: str,
-        subpath: str,
-        params: Optional[dict] = None,
-        data: Optional[dict] = None,
-    ) -> dict:
-        client = MasstackClient()
-        func = getattr(client, method)
-
-        return func(
-            api=cls._api_domain,
-            version=cls._version,
-            endpoint=cls._get_endpoint(subpath),
-            params=params,
-            data=data,
-        )
-
     @classmethod
     def get_number(cls, postal_code: str, state: str = "new"):
         """Obtain fixed numbering for sale.
@@ -51,9 +28,9 @@ class FixedPhone(ProvisionNetworkResource):
 
         """
         response = cls._request(
-            "get",
-            "number",
-            {
+            method="get",
+            suffix="number",
+            params={
                 "postal_code": postal_code,
                 "state": state,
             },

{masstack_python_client-0.0.5 → masstack_python_client-0.1.0/src/masstack_python_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: masstack-python-client
-Version: 0.0.5
+Version: 0.1.0
 Summary: This Python API client provides access to masmovil core API domains
 Author-email: Borja Gimeno <borja.gimeno@somconnexio.coop>
 License: GPL-3.0-only
@@ -25,36 +25,37 @@ This Python API client provides access to masmovil core API domains.
 
 ## Resources
 
-* Feasibility
-    - Coverage - find an address
-        - Streets:
-            - search: returns a list of street by text
-            - get_building_info_by_street: returns a list of building info by street id
-        - Buildings:
-            - search: returns a list of buildings by text
-            - multi_search: returns a list of buildings by request body
-            - get: returns a building by id with a list of units
-        - Units:
-            - get: returns a unit by id with a list of coverages
-            - get_coverage: returns coverage info for a unit id and territory_owner
-    - Portability - Checks if a landline portability or an access transfer is allowed
-        - PortabilityCheck:
-            - check: Returns whether the portability process can be carried out and whether it requires a new installation
-
-* Customers
-    - Signups - access to signups new clients
-        - post new client
-    - Users
-        - returns customer tree data associated to a given document identification, email or number of the client. 
-        - returns user data by userId
-
-* Catalogue
-    - bundled_products - access to bundled products
-        - get sellable bundled products
-
-* Provision inventory network
-    - fixed - Obtain fixed numbering for sale
-        - get number
+- **Feasibility**
+	-  Coverage - find an address
+		- Streets:
+			- *search: returns a list of street by text*
+			- *get_building_info_by_street: returns a list of building info by street id*
+		- Buildings:
+			- *search: returns a list of buildings by text*
+			- *multi_search: returns a list of buildings by request body*
+			- *get: returns a building by id with a list of units*
+		- Units:
+			- *get: returns a unit by id with a list of coverages*
+			- *get_coverage: returns coverage info for a unit id and territory_owner*
+	- Portability - Checks if a landline portability or an access transfer is allowed
+		- PortabilityCheck:
+			- *check: Returns whether the portability process can be carried out and whether it requires a new* installation
+
+- **Customers**
+	- Signups - access to signups new clients
+		- *post new client*
+	- Users
+		- *returns customer tree data associated to a given document identification, email or number of the client.*
+		- *returns user data by userId*
+
+- **Catalogue**
+	- bundled_products - access to bundled products
+		- Sellable:
+			- *get: Returns sellable bundled products*
+
+- **Provision inventory network**
+	- fixed - Obtain fixed numbering for sale
+		- *get number*
 
 
 ## Installation

{masstack_python_client-0.0.5 → masstack_python_client-0.1.0}/src/masstack_python_client.egg-info/SOURCES.txt

@@ -19,6 +19,7 @@ src/masstack_python_client/data/province_translation.csv
 src/masstack_python_client/data/street_type_translation.csv
 src/masstack_python_client/data/unit_translation.csv
 src/masstack_python_client/resources/__init__.py
+src/masstack_python_client/resources/base.py
 src/masstack_python_client/resources/catalogue.py
 src/masstack_python_client/resources/customers.py
 src/masstack_python_client/resources/feasibility.py