masstack-python-client 0.0.3__py3-none-any.whl → 0.0.4__py3-none-any.whl

masstack_python_client/__init__.py

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

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/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/resources/enums/commercial_segment_name.py

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

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/resources/enums/customer_type_name.py

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

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/resources/enums/technology_name.py

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

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.3.dist-info → masstack_python_client-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: masstack-python-client
-Version: 0.0.3
+Version: 0.0.4
 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
@@ -45,6 +45,10 @@ 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
+
 ## Installation
 
 ```commandline

{masstack_python_client-0.0.3.dist-info → masstack_python_client-0.0.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-masstack_python_client/__init__.py,sha256=ZGw_LqC_xbgEF9n0CyxrpBpNtc1-3gLH0fxTScbA7Bk,154
+masstack_python_client/__init__.py,sha256=6TDc7ulFeITzFwqtn2Uqj3pBTqGRHYGHN43zbbpu5aY,154
 masstack_python_client/client.py,sha256=5b52Q2ekABi7DlZPsNobcmaJXOKzZfhKE_kHvNEqE9Q,2496
 masstack_python_client/exceptions.py,sha256=HkX1cP4Ryeas59CzIVW8N5gmnRE1x0yQUQwS3tm9QZQ,2115
 masstack_python_client/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -10,10 +10,19 @@ masstack_python_client/data/province_translation.csv,sha256=Jpd6jbjYaqeNOk9lUA3W
 masstack_python_client/data/street_type_translation.csv,sha256=2MGeTs0v6wVz2yRMyZUuoNOYA4NSqKGJCGYIRi9X8Ic,1791
 masstack_python_client/data/unit_translation.csv,sha256=34FPfaCC1eSmBfV0BbHSHJ-tktQk7YLlfT8tMxnfnys,194
 masstack_python_client/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+masstack_python_client/resources/catalogue.py,sha256=6evwB75NC2jRsTQ6Zz3-qmzNo9dFsQhdtAtYhwW9Zu0,4002
 masstack_python_client/resources/customers.py,sha256=9GTXQ5fiVosbAzK__uydZOBu9wXC9yO4pHufseHqD38,2924
 masstack_python_client/resources/feasibility.py,sha256=DbiPwWa9orSmITgcID7RVPKf7b50Pk8h1XQh0xxGYhw,7119
+masstack_python_client/resources/enums/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+masstack_python_client/resources/enums/bundled_product_category.py,sha256=0rEsOud4kyDVX07DQ15C_DPcw8hZy84bAVj8j7nT22k,388
+masstack_python_client/resources/enums/commercial_segment_name.py,sha256=94yOXfHNCcZNCoR9ELQ-x2tarNin7gdYBVZ-CTzJsGA,101
+masstack_python_client/resources/enums/customer_segment_name.py,sha256=NSQUUSUGL-vYEUe4w9deym9Vuez-QGn26hs_2fOojh0,163
+masstack_python_client/resources/enums/customer_type_name.py,sha256=mMdZh0D7qLDMxe6QYVQLGMqHqQMBAnZaPkjgE8q_D9Q,99
 masstack_python_client/resources/enums/document_type_search.py,sha256=pniXpUA_odqeKyxS6yYiN2uje0-F1kKXXBLOk0F8UTQ,136
+masstack_python_client/resources/enums/sale_type_name.py,sha256=NWl5j_SkbysOGVBn4-c7gVbzynOiE44Aqj34n_1v_sU,183
+masstack_python_client/resources/enums/technology_name.py,sha256=7h8LUyZ-2XHAxOZXelUkkFifmk9dCcwmBbWueFABfQ4,90
 masstack_python_client/resources/models/address.py,sha256=hKnEUVVz8AfGjhaDngzQ0HuR4_Z6zhK6Xe8Aj6xJR7I,5451
+masstack_python_client/resources/models/bundled.py,sha256=1zhWZFrQh15slaGSEZIDa1rURU76gRH5czppXYNSyow,1480
 masstack_python_client/resources/models/client_address.py,sha256=7WBiPTce2X6uZUVVZvZlTMgiohbVITUzmKgYYPvpM-w,204
 masstack_python_client/resources/models/client_attribute.py,sha256=rZlLjJeBVD6IpXbSEucujTqcmHhqoJGRTOV1wqyStak,697
 masstack_python_client/resources/models/client_payment.py,sha256=yMGMTuk_07-TzXWO89sCaaZv8soTO9cT0TzfV3xQa1o,262
@@ -21,8 +30,8 @@ masstack_python_client/resources/models/products.py,sha256=cIuUlEKs0OfvBXtYxxUwG
 masstack_python_client/resources/models/signup.py,sha256=Hvo5nZce1ikpUUMEoLt_2g2HipHwh4XRIz344X8_IJk,2018
 masstack_python_client/resources/models/user.py,sha256=N5mwuZN0Saxiro2UXYcCxLL6jrpIU83crHhmrdAcgE8,1080
 masstack_python_client/resources/utils/serialize.py,sha256=F6JxqR2M9HH0TpYKaJritnppWkYlpPztZ9ZC43FdPLg,251
-masstack_python_client-0.0.3.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-masstack_python_client-0.0.3.dist-info/METADATA,sha256=lIkct6n2EgZkeXZ4u1GJv4UIqpJjk9KvMIc4KjEjPoU,3713
-masstack_python_client-0.0.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-masstack_python_client-0.0.3.dist-info/top_level.txt,sha256=q_iYlqJq22lhg_2O2iktARr7Mzz3QfjaW4l6J4vwyE8,23
-masstack_python_client-0.0.3.dist-info/RECORD,,
+masstack_python_client-0.0.4.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+masstack_python_client-0.0.4.dist-info/METADATA,sha256=GJo4SVII_bljYCjkMAjrpbXHGYrX0YGSZk4Fz7uLYZ0,3818
+masstack_python_client-0.0.4.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+masstack_python_client-0.0.4.dist-info/top_level.txt,sha256=q_iYlqJq22lhg_2O2iktARr7Mzz3QfjaW4l6J4vwyE8,23
+masstack_python_client-0.0.4.dist-info/RECORD,,