kodexa 7.0.8895840398__py3-none-any.whl → 7.0.8897197016__py3-none-any.whl

kodexa/model/entities/product.py

@@ -1,8 +1,6 @@
-from dataclasses import Field
 from typing import Optional, List
 
-from pydantic import BaseModel, ConfigDict
-
+from pydantic import BaseModel, ConfigDict, Field
 from kodexa.model.base import StandardDateTime
 from kodexa.platform.client import EntityEndpoint, PageEndpoint, EntitiesEndpoint
 
@@ -21,7 +19,8 @@ class Product(BaseModel):
     A product
     """
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+
+    id: Optional[str] = None
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")

kodexa/model/entities/product_subscription.py

@@ -1,7 +1,6 @@
-from dataclasses import Field
 from typing import Optional, List
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, Field
 
 from kodexa.model.base import StandardDateTime
 from kodexa.model.entities.product import Product
@@ -20,7 +19,7 @@ class ProductSubscription(BaseModel):
         protected_namespaces=("model_config",),
     )
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")

kodexa/model/objects.py

@@ -218,7 +218,7 @@ class Organization(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -240,7 +240,7 @@ class Team(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1115,7 +1115,7 @@ class AttributeStatus(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
     updated_on: Optional[StandardDateTime] = Field(None, alias="updatedOn")
@@ -1202,7 +1202,7 @@ class DocumentStatus(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1237,7 +1237,7 @@ class DocumentTransition(BaseModel):
     Provides the definition of a transition for a document, where a change was applied by an assistant, user or external process
     """
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1417,7 +1417,7 @@ class Label(BaseModel):
     The labels from the latest content object in the family
     """
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1441,7 +1441,7 @@ class ProjectTag(BaseModel):
     A project tag
     """
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     name: str
     color: Optional[str] = None
 
@@ -1519,7 +1519,7 @@ class Session(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1578,7 +1578,7 @@ class ValidationError(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
     updated_on: Optional[StandardDateTime] = Field(None, alias="updatedOn")
@@ -1672,7 +1672,7 @@ class DataException(BaseModel):
     A data exception
     """
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1822,7 +1822,7 @@ class PlatformConfiguration(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -1874,7 +1874,7 @@ class ModelTraining(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     name: Optional[str] = None
     state: Optional[str] = None
@@ -1967,7 +1967,7 @@ class ExecutionLogEntry(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -2194,7 +2194,7 @@ class User(BaseModel):
     A user within the Kodexa platform
     """
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -2684,7 +2684,7 @@ class ContentObject(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -2718,7 +2718,7 @@ class DocumentAssignment(BaseModel):
     A list of the assignments to users for this document
     """
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -2795,7 +2795,7 @@ class ProjectStatus(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -2825,7 +2825,7 @@ class Project(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3119,7 +3119,7 @@ class DataAttribute(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3164,7 +3164,7 @@ class Role(BaseModel):
     A role that can be used to manage rights
     """
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3184,7 +3184,7 @@ class Membership(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3614,7 +3614,7 @@ class ContentException(BaseModel):
     A list of the content exceptions from the content objects
     """
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3693,7 +3693,7 @@ class Execution(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3728,7 +3728,7 @@ class ExecutionSnapshot(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3864,7 +3864,7 @@ class DocumentFamily(BaseModel):
     A document family is the representation of a single piece of external content (ie. a PDF) and all the related document representations of that file
     """
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -3963,7 +3963,7 @@ class ExecutionAssistant(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -4010,7 +4010,7 @@ class DataObject(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -4042,7 +4042,7 @@ class Assistant(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -4248,7 +4248,7 @@ class ExecutionEvent(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -4476,7 +4476,7 @@ class SearchContent(BaseModel):
     A document family is the representation of a single peice of external content (ie. a PDF) and all the related document representations of that file
     """
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -4560,7 +4560,7 @@ class PlatformEvent(BaseModel):
         arbitrary_types_allowed=True,
         protected_namespaces=("model_config",),
     )
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")
@@ -4617,7 +4617,7 @@ class AuditEvent(BaseModel):
     An audit event captures a data to a data structure or document
     """
 
-    id: Optional[str] = Field(None, description="The ID of the object")
+    id: Optional[str] = Field(None)
     uuid: Optional[str] = None
     change_sequence: Optional[int] = Field(None, alias="changeSequence")
     created_on: Optional[StandardDateTime] = Field(None, alias="createdOn")

kodexa/platform/client.py

@@ -888,6 +888,44 @@ class OrganizationsEndpoint(EntitiesEndpoint):
             return None
         return organizations.content[0]
 
+    def get_subscriptions(self, page: int = 1, page_size: int = 10) -> "PageProductSubscriptionEndpoint":
+        """
+        Get the subscriptions of the organization.
+
+        Returns:
+            The subscriptions of the organization.
+        """
+        url = f"/api/productSubscriptions"
+        params = {
+            filter: f"organization.id: '{self.organization.id}'",
+        }
+        response = self.client.get(url, params=params)
+
+        from kodexa.model.entities.product_subscription import PageProductSubscriptionEndpoint
+        return PageProductSubscriptionEndpoint.model_validate(response.json()).set_client(self.client)
+
+    def remove_subscription(self, subscription_id: str) -> None:
+        """
+        Remove a subscription from the organization.
+
+        Args:
+            subscription_id (str): The id of the subscription to remove.
+        """
+        url = f"/api/productSubscriptions/{subscription_id}"
+        self.client.delete(url)
+
+    def add_subscription(self, product: "Product") -> None:
+        """
+        Add a subscription to the organization.
+
+        Args:
+            product (Product): The product to subscribe to.
+        """
+        url = f"/api/productSubscriptions"
+        from kodexa.model.entities.product_subscription import ProductSubscription
+        new_product_subscription = ProductSubscription(organization=self.organization, product=product)
+        self.client.post(url, body=new_product_subscription.model_dump_json(by_alias=True))
+
 
 class PageEndpoint(ClientEndpoint):
     """
@@ -6184,6 +6222,8 @@ class KodexaClient:
         self.channels = ChannelsEndpoint(self)
         self.assistants = AssistantsEndpoint(self)
         self.messages = MessagesEndpoint(self)
+        from kodexa.model.entities.product import ProductsEndpoint
+        self.products = ProductsEndpoint(self)
 
     @staticmethod
     def login(url, token):
@@ -6733,6 +6773,8 @@ class KodexaClient:
 
                 raise Exception("A store must have a storeType")
 
+            from kodexa.model.entities.product import ProductEndpoint
+            from kodexa.model.entities.product_subscription import ProductSubscriptionEndpoint
             known_components = {
                 "taxonomy": TaxonomyEndpoint,
                 "pipeline": PipelineEndpoint,
@@ -6756,6 +6798,8 @@ class KodexaClient:
                 "prompt": PromptEndpoint,
                 "guidance": GuidanceSetEndpoint,
                 "channel": ChannelEndpoint,
+                "product": ProductEndpoint,
+                "productSubscription": ProductSubscriptionEndpoint,
             }
 
             if component_type in known_components:

{kodexa-7.0.8895840398.dist-info → kodexa-7.0.8897197016.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kodexa
-Version: 7.0.8895840398
+Version: 7.0.8897197016
 Summary: Python SDK for the Kodexa Platform
 Author: Austin Redenbaugh
 Author-email: austin@kodexa.com

{kodexa-7.0.8895840398.dist-info → kodexa-7.0.8897197016.dist-info}/RECORD

@@ -5,15 +5,16 @@ kodexa/connectors/__init__.py,sha256=WF6G_MUeU32TlKSUKkpNoNX7dq8iBPliFMep4E8BmZc
 kodexa/connectors/connectors.py,sha256=FpUZDkSyHld2b9eYRuVOWzaFtuGoaRuPXXicJB7THbc,10413
 kodexa/model/__init__.py,sha256=rtLXYJBxB-rnukhslN9rlqoB3--1H3253HyHGbD_Gc8,796
 kodexa/model/base.py,sha256=CaZK8nMhT1LdCpt4aLhebJGcorjq9qRID1FjnXnP14M,521
-kodexa/model/entities/product.py,sha256=tQOJcaysEUqXvKErU4gQw1OBf90z-H1jmnKjI0XNHQA,3592
-kodexa/model/entities/product_subscription.py,sha256=3Slmx57dTqHc441r0QMhejSmZceYXLWyIcJ6DXHD144,3873
+kodexa/model/entities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kodexa/model/entities/product.py,sha256=ZDpHuBE_9FJ-klnkyBvTfPwYOqBkM1wraZMtHqNA8FQ,3526
+kodexa/model/entities/product_subscription.py,sha256=vWKYo3OWlLdQIIp7onjT8R5FTHnm7ZwpdP3DrbQ2FfA,3814
 kodexa/model/model.py,sha256=xAUPiW_1V9Kn9yitrvKFVuG_ms_N4HlAx23dwGln8Ro,115561
-kodexa/model/objects.py,sha256=aC2PeG8wttjh9Moqi3ALOSp_uzh7UCGnmyQZy2jHggM,175470
+kodexa/model/objects.py,sha256=aMDDBN3sKMsSvz3i5ZjDof1oFaTNQ65W87GJh7l9GoY,174318
 kodexa/model/persistence.py,sha256=sx5FwTSsWMdAZpAs0-6PqyULHkQyNQClApUKJZ-ly8M,62032
 kodexa/pipeline/__init__.py,sha256=sA7f5D6qkdMrpp2xTIeefnrUBI6xxEEWostvxfX_1Cs,236
 kodexa/pipeline/pipeline.py,sha256=ZYpJAWcwV4YRK589DUhU0vXGQlkNSj4J2TsGbYqTLjo,25221
 kodexa/platform/__init__.py,sha256=1O3oiWMg292NPL_NacKDnK1T3_R6cMorrPRue_9e-O4,216
-kodexa/platform/client.py,sha256=mCFyK4VUhjOaKq2KFMcV70Zbk-EoDOoI6N9BwLfxeDg,214979
+kodexa/platform/client.py,sha256=w8SZFUNy9bKvbsWnnfXLlKapM53ZXtJh8GDE5QFvYi4,216867
 kodexa/platform/interaction.py,sha256=6zpcwXKNZstUGNS6m4JsoRXAqCZPJHWI-ZN3co8nnF0,1055
 kodexa/platform/kodexa.py,sha256=Bvf6x43FWsFuAuQ4N8TvjSZq6niEtBTESmFCWVPASeQ,34024
 kodexa/selectors/__init__.py,sha256=xA9-4vpyaAZWPSk3bh2kvDLkdv6XEmm7PjFbpziiTIk,100
@@ -37,7 +38,7 @@ kodexa/testing/test_components.py,sha256=g5lP-GY0nTHuH5cIEw45vIejEeBaWkPKQGHL36j
 kodexa/testing/test_utils.py,sha256=DrLCkHxdb6AbZ-X3WmTMbQmnVIm55VEBL8MjtUK9POs,14021
 kodexa/training/__init__.py,sha256=xs2L62YpRkIRfslQwtQZ5Yxjhm7sLzX2TrVX6EuBnZQ,52
 kodexa/training/train_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kodexa-7.0.8895840398.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-kodexa-7.0.8895840398.dist-info/METADATA,sha256=OPwSM3gyYUA2fevOIzwH7LbatztBDE4RRZT4QQhNibc,3493
-kodexa-7.0.8895840398.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-kodexa-7.0.8895840398.dist-info/RECORD,,
+kodexa-7.0.8897197016.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+kodexa-7.0.8897197016.dist-info/METADATA,sha256=zpuMYng4et9dXwqOqfQ-pHiKQdJuf5_DGRn7pZY5IQQ,3493
+kodexa-7.0.8897197016.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+kodexa-7.0.8897197016.dist-info/RECORD,,