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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: masstack-python-client
-Version: 0.0.3
+Version: 0.0.5
 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
@@ -37,6 +37,9 @@ This Python API client provides access to masmovil core API domains.
         - 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
@@ -45,6 +48,15 @@ This Python API client provides access to masmovil core API domains.
         - 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
+
+
 ## Installation
 
 ```commandline

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

@@ -20,6 +20,9 @@ This Python API client provides access to masmovil core API domains.
         - 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
@@ -28,6 +31,15 @@ This Python API client provides access to masmovil core API domains.
         - 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
+
+
 ## Installation
 
 ```commandline

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

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

masstack_python_client-0.0.5/src/masstack_python_client/resources/catalogue.py

@@ -0,0 +1,110 @@
+from typing import Optional, List
+from masstack_python_client.client import MasstackClient
+from masstack_python_client.resources.enums.bundled_product_category import (
+    BundleCategory,
+)
+from masstack_python_client.resources.enums.commercial_segment_name import (
+    CommercialSegmentName,
+)
+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
+
+
+class CatalogueResource:
+    """Support sales and post-sales operations from catalogue perspective
+    https://developers.masstack.com/en/docs/apis_catalogue_doc_swagger/2/apioverview/
+    """
+
+    _api_domain = "catalogue"
+
+
+class BundledProducts(CatalogueResource):
+    _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
+    def get(
+        cls,
+        commercial_profile_name: Optional[str] = None,
+        technology_name: Optional[TechnologyName] = None,
+        territory_owner_id: Optional[str] = None,
+        category: Optional[BundleCategory] = None,
+        customer_segment_name: Optional[CustomerSegmentName] = None,
+        commercial_segment_name: Optional[CommercialSegmentName] = None,
+        customer_type_name: Optional[CustomerTypeName] = None,
+        sale_type_name: Optional[SaleTypeName] = None,
+    ) -> List[BundledProduct]:
+        """Returns an array of sellable bundled products based on input criteria,
+         including the mandatory bundled commercial products for each bundled product.
+         Provides details for each bundled commercial product about the marketing name.
+
+        Args:
+            commercial_profile_name (str): commercial profile name
+            technology_name (TechnologyName): technology name
+            territory_owner_id (str): territory owner identifier
+            category (BundleCategory): bundled product category
+            customer_segment_name (CustomerSegmentName): customer segment name
+            commercial_segment_name(CommercialSegmentName): SmallMediumEnterprise or Consumer
+            customer_type_name(CustomerTypeName): customer type name
+            sale_type_name(SaleTypeName): sale type name
+
+        Returns:
+            BundledProduct
+
+        """
+        params = {
+            "commercial_profile_name": commercial_profile_name,
+            "technology_name": technology_name,
+            "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,
+        }
+        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
+            },
+        )
+        return [
+            BundledProduct.from_dict(**sellable_bundled_product)
+            for sellable_bundled_product in sellable_bundled_products
+        ]

masstack_python_client-0.0.5/src/masstack_python_client/resources/enums/bundled_product_category.py

@@ -0,0 +1,12 @@
+from enum import Enum
+
+
+class BundleCategory(Enum):
+    MOBILE = "Mobile"
+    TV = "TV"
+    FIXED_BROADBAND = "Fixed+Broadband"
+    FIXED_MOBILE = "Fixed+Mobile"
+    FIXED_BROADBAND_MOBILE = "Fixed+Broadband+Mobile"
+    FIXED_BROADBAND_TV = "Fixed+Broadband+TV"
+    FIXED_BROADBAND_MOBILE_NTX = "Fixed+Broadband+Mobile+Netflix"
+    FIXED_BROADBAND_MOBILE_TV = "Fixed+Broadband+Mobile+TV"

masstack_python_client-0.0.5/src/masstack_python_client/resources/enums/commercial_segment_name.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class CommercialSegmentName(Enum):
+    SME = "SME"
+    CONSUMER = "Consumer"

masstack_python_client-0.0.5/src/masstack_python_client/resources/enums/customer_segment_name.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class CustomerSegmentName(Enum):
+    RESIDENTIAL = "RESIDENCIAL"
+    COMPANY = "EMPRESA"
+    AUTONOMOUS = "AUTONOMO"
+    HORECA = "HORECA"

masstack_python_client-0.0.5/src/masstack_python_client/resources/enums/customer_type_name.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class CustomerTypeName(Enum):
+    NEW = "Nuevo"
+    EXISTING = "Existente"

masstack_python_client-0.0.5/src/masstack_python_client/resources/enums/sale_type_name.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class SaleTypeName(Enum):
+    SALE = "Venta"
+    MIGRATION = "Migración"
+    ADD_LINE = "Añadir Línea"
+    CROSS_SELL = "Cross Sell"
+    WALLET = "Cartera"

masstack_python_client-0.0.5/src/masstack_python_client/resources/enums/technology.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class Technology(Enum):
+    ADSL = "ADSL"
+    FTTH = "FTTH"
+    MIFIJO = "MIFIJO"

masstack_python_client-0.0.5/src/masstack_python_client/resources/enums/technology_name.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class TechnologyName(Enum):
+    ADSL = "ADSL"
+    FIBRA = "FIBRA"

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

@@ -1,6 +1,7 @@
 import os
 from typing import Optional, List
 from masstack_python_client.client import MasstackClient
+from masstack_python_client.resources.enums.technology import Technology
 from masstack_python_client.resources.models.address import (
     BuildingData,
     ClarifierData,
@@ -8,6 +9,18 @@ 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
+"""
 
 
 class FeasibilityResource:
@@ -17,6 +30,79 @@ class FeasibilityResource:
 
     _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):
+
+    _api_path = "portability"
+    _version = "v2"
+
+
+class PortabilityCheck(Portability):
+
+    _api_subpath = "portabilityCheck"
+
+    @classmethod
+    def check(
+        cls,
+        number: str,
+        address_id: str,
+        territory_owner: Optional[str] = None,
+        technical_id: Optional[str] = None,
+        technology: Technology = Technology.FTTH,
+    ) -> PortabilityData:
+        """Returns whether the portability process can be carried out
+        and whether it requires a new installation
+
+        Args:
+            number (str): Fixed number to be ported
+            address_id (str): Unique address ID
+            territory_owner (str): Territory owner. Not mandatory if technology is MIFIJO
+            technical_id (str): Technical id. Not mandatory if technology is MIFIJO. g17 or g37
+            technology (Technology): Technology to be provided
+
+        Returns:
+            PortabilityData
+
+        """
+
+        portability = cls._request(
+            method="post",
+            data={
+                "number": number,
+                "territoryOwner": territory_owner,
+                "technicalId": technical_id,
+                "addressId": address_id,
+                "technology": technology.value,
+            },
+        )
+        return PortabilityData.from_dict(**portability)
+
 
 class Coverage(FeasibilityResource):
 
@@ -31,10 +117,6 @@ class Coverage(FeasibilityResource):
     def _sf_channel() -> str:
         return os.environ.get("MASSTACK_COVERAGE_CHANNEL", "")
 
-    @classmethod
-    def _get_endpoint(cls, subpath: str) -> str:
-        return f"{cls._api_path}/{subpath}"
-
     @classmethod
     def _get_header(cls, uuid: str) -> dict:
         return {
@@ -44,25 +126,8 @@ class Coverage(FeasibilityResource):
         }
 
     @classmethod
-    def _request(
-        cls,
-        method: str,
-        subpath: str,
-        uuid: str,
-        data: Optional[dict] = None,
-        params: 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,
-            header=cls._get_header(uuid),
-        )
+    def _request(cls, *, uuid: str, **kwargs) -> dict | list:
+        return super()._request(header=cls._get_header(uuid), **kwargs)
 
 
 class Streets(Coverage):
@@ -83,9 +148,8 @@ class Streets(Coverage):
 
         """
         streets = cls._request(
-            "get",
-            cls._api_subpath,
-            uuid,
+            method="get",
+            uuid=uuid,
             params={"search": text},
         )
         return [StreetData.from_dict(uuid, lang, **street) for street in streets]
@@ -104,9 +168,9 @@ class Streets(Coverage):
             ClarifierData
         """
         clarifiers = cls._request(
-            "get",
-            f"{cls._api_subpath}/clarifiers/{street_id}",
-            uuid,
+            method="get",
+            suffix=f"/clarifiers/{street_id}",
+            uuid=uuid,
         )
 
         return [ClarifierData(uuid, **clarifier) for clarifier in clarifiers]
@@ -129,9 +193,8 @@ class Buildings(Coverage):
             BuildingData
         """
         buildings = cls._request(
-            "get",
-            cls._api_subpath,
-            uuid,
+            method="get",
+            uuid=uuid,
             params={"search": text},
         )
         return [
@@ -154,9 +217,9 @@ class Buildings(Coverage):
             BuildingData
         """
         building = cls._request(
-            "get",
-            f"{cls._api_subpath}/{id}",
-            uuid,
+            method="get",
+            suffix=f"/{id}",
+            uuid=uuid,
             params={"unit_to_data": unit_to_data},
         )
         return BuildingData.from_dict(
@@ -193,9 +256,9 @@ class Buildings(Coverage):
         """
 
         buildings = cls._request(
-            "post",
-            f"{cls._api_subpath}/search",
-            uuid,
+            method="post",
+            suffix="/search",
+            uuid=uuid,
             data={
                 "way_name": way_name,
                 "number": number,
@@ -229,9 +292,9 @@ class Units(Coverage):
             UnitData
         """
         unit = cls._request(
-            "get",
-            f"{cls._api_subpath}/{unit_id}",
-            uuid,
+            method="get",
+            suffix=f"/{unit_id}",
+            uuid=uuid,
             params={"parent_coverage": parent_coverage},
         )
         return UnitData.from_dict(
@@ -257,9 +320,9 @@ class Units(Coverage):
             CoverageData
         """
         unit = cls._request(
-            "get",
-            f"{cls._api_subpath}/extra",
-            uuid,
+            method="get",
+            suffix="/extra",
+            uuid=uuid,
             params={"id": unit_id, "territory_owner": territory_owner},
         )
         return CoverageData.from_dict(

masstack_python_client-0.0.5/src/masstack_python_client/resources/models/bundled.py

@@ -0,0 +1,58 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class SubsType:
+    id: str
+    name: str
+    description: str
+
+
+@dataclass(frozen=True)
+class ComercialProduct:
+    id: str
+    name: str
+
+    @classmethod
+    def from_dict(cls, commercial_product, **kwargs) -> "ComercialProduct":
+        return cls(commercial_product["id"], commercial_product["name"])
+
+
+@dataclass(frozen=True)
+class BundledProductSubtype:
+    id: str
+    bundled_commercial_products: list[ComercialProduct]
+    subs_type: SubsType
+
+    @classmethod
+    def from_dict(
+        cls, id, bundled_commercial_products, subs_type, **kwargs
+    ) -> "BundledProductSubtype":
+        return cls(
+            id,
+            bundled_commercial_products=[
+                ComercialProduct.from_dict(**bundled_commercial_product)
+                for bundled_commercial_product in bundled_commercial_products
+            ],
+            subs_type=SubsType(**subs_type),
+        )
+
+
+@dataclass(frozen=True)
+class BundledProduct:
+    id: str
+    name: str
+    bundled_product_subs_types: list[BundledProductSubtype]
+
+    @classmethod
+    def from_dict(
+        cls, id, name, bundled_product_subs_types, **kwargs
+    ) -> "BundledProduct":
+        return cls(
+            id,
+            name,
+            bundled_product_subs_types=[
+                BundledProductSubtype.from_dict(**bundled_product_subs_type)
+                for bundled_product_subs_type in bundled_product_subs_types
+            ],
+        )

masstack_python_client-0.0.5/src/masstack_python_client/resources/models/fixed_phone.py

@@ -0,0 +1,6 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class FixedPhoneData:
+    number: str

masstack_python_client-0.0.5/src/masstack_python_client/resources/models/portability.py

@@ -0,0 +1,39 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class InstallationInfoData:
+    internalAccess: bool
+    iua: str
+    brand: str
+    number: str
+    documentNumber: str
+    gescal: str
+
+
+@dataclass(frozen=True)
+class OperatorData:
+    code: str
+    name: str
+
+
+@dataclass(frozen=True)
+class PortabilityData:
+    internalPortability: bool
+    isPortable: bool
+    installationRequired: bool
+    operator: OperatorData
+    installationInfo: InstallationInfoData
+
+    @classmethod
+    def from_dict(
+        cls,
+        operator,
+        installationInformation,
+        **kwargs,
+    ):
+        return cls(
+            operator=OperatorData(**operator),
+            installationInfo=InstallationInfoData(**installationInformation),
+            **kwargs,
+        )

masstack_python_client-0.0.5/src/masstack_python_client/resources/provision.py

@@ -0,0 +1,61 @@
+from typing import Optional
+from masstack_python_client.client import MasstackClient
+from masstack_python_client.resources.models.fixed_phone import FixedPhoneData
+
+
+"https://provision-inventory-network.sta.masstack.com/v1/orgs/marblanca/fixed/number"
+
+
+class ProvisionNetworkResource:
+    """not documented"""
+
+    _api_domain = "provision-inventory-network"
+
+
+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.
+
+        Args:
+            postal_code (str): postal code
+            state (str): state
+        Returns:
+            FixedPhoneData
+
+        """
+        response = cls._request(
+            "get",
+            "number",
+            {
+                "postal_code": postal_code,
+                "state": state,
+            },
+        )
+        return FixedPhoneData(response["number"])

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: masstack-python-client
-Version: 0.0.3
+Version: 0.0.5
 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
@@ -37,6 +37,9 @@ This Python API client provides access to masmovil core API domains.
         - 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
@@ -45,6 +48,15 @@ This Python API client provides access to masmovil core API domains.
         - 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
+
+
 ## Installation
 
 ```commandline

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

@@ -19,13 +19,26 @@ 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/catalogue.py
 src/masstack_python_client/resources/customers.py
 src/masstack_python_client/resources/feasibility.py
+src/masstack_python_client/resources/provision.py
+src/masstack_python_client/resources/enums/__init__.py
+src/masstack_python_client/resources/enums/bundled_product_category.py
+src/masstack_python_client/resources/enums/commercial_segment_name.py
+src/masstack_python_client/resources/enums/customer_segment_name.py
+src/masstack_python_client/resources/enums/customer_type_name.py
 src/masstack_python_client/resources/enums/document_type_search.py
+src/masstack_python_client/resources/enums/sale_type_name.py
+src/masstack_python_client/resources/enums/technology.py
+src/masstack_python_client/resources/enums/technology_name.py
 src/masstack_python_client/resources/models/address.py
+src/masstack_python_client/resources/models/bundled.py
 src/masstack_python_client/resources/models/client_address.py
 src/masstack_python_client/resources/models/client_attribute.py
 src/masstack_python_client/resources/models/client_payment.py
+src/masstack_python_client/resources/models/fixed_phone.py
+src/masstack_python_client/resources/models/portability.py
 src/masstack_python_client/resources/models/products.py
 src/masstack_python_client/resources/models/signup.py
 src/masstack_python_client/resources/models/user.py