rapidata 2.27.0__py3-none-any.whl → 2.44.4__py3-none-any.whl

rapidata/api_client/models/campaign_filter.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CampaignFilter(BaseModel):
+    """
+    CampaignFilter
+    """ # noqa: E501
+    t: StrictStr = Field(description="Discriminator value for CampaignFilter", alias="_t")
+    campaign_ids: List[StrictStr] = Field(alias="campaignIds")
+    execution_order: Optional[StrictInt] = Field(default=None, alias="executionOrder")
+    __properties: ClassVar[List[str]] = ["_t", "campaignIds", "executionOrder"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['CampaignFilter']):
+            raise ValueError("must be one of enum values ('CampaignFilter')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CampaignFilter from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CampaignFilter from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "_t": obj.get("_t") if obj.get("_t") is not None else 'CampaignFilter',
+            "campaignIds": obj.get("campaignIds"),
+            "executionOrder": obj.get("executionOrder")
+        })
+        return _obj
+
+

rapidata/api_client/models/campaign_query_result.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Rapidata.Dataset
+    Rapidata Asset API
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    The API for the Rapidata Asset service
 
     The version of the OpenAPI document: v1
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -18,8 +18,10 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.boosting_profile import BoostingProfile
+from rapidata.api_client.models.campaign_status import CampaignStatus
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -30,17 +32,12 @@ class CampaignQueryResult(BaseModel):
     id: StrictStr
     owner_mail: StrictStr = Field(alias="ownerMail")
     name: StrictStr
-    status: StrictStr
+    status: CampaignStatus
     priority: StrictInt
+    boosting_profile: BoostingProfile = Field(alias="boostingProfile")
+    requires_booster: Optional[StrictBool] = Field(default=None, alias="requiresBooster")
     created_at: datetime = Field(alias="createdAt")
-    __properties: ClassVar[List[str]] = ["id", "ownerMail", "name", "status", "priority", "createdAt"]
-
-    @field_validator('status')
-    def status_validate_enum(cls, value):
-        """Validates the enum"""
-        if value not in set(['Created', 'Preview', 'Active', 'Analysis', 'Paused', 'Completed']):
-            raise ValueError("must be one of enum values ('Created', 'Preview', 'Active', 'Analysis', 'Paused', 'Completed')")
-        return value
+    __properties: ClassVar[List[str]] = ["id", "ownerMail", "name", "status", "priority", "boostingProfile", "requiresBooster", "createdAt"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -81,6 +78,9 @@ class CampaignQueryResult(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of boosting_profile
+        if self.boosting_profile:
+            _dict['boostingProfile'] = self.boosting_profile.to_dict()
         return _dict
 
     @classmethod
@@ -98,6 +98,8 @@ class CampaignQueryResult(BaseModel):
             "name": obj.get("name"),
             "status": obj.get("status"),
             "priority": obj.get("priority"),
+            "boostingProfile": BoostingProfile.from_dict(obj["boostingProfile"]) if obj.get("boostingProfile") is not None else None,
+            "requiresBooster": obj.get("requiresBooster"),
             "createdAt": obj.get("createdAt")
         })
         return _obj

rapidata/api_client/models/campaign_status.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Rapidata.Dataset
+    Rapidata Asset API
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    The API for the Rapidata Asset service
 
     The version of the OpenAPI document: v1
     Generated by OpenAPI Generator (https://openapi-generator.tech)

rapidata/api_client/models/change_boost_model.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    Rapidata Asset API
+
+    The API for the Rapidata Asset service
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ChangeBoostModel(BaseModel):
+    """
+    ChangeBoostModel
+    """ # noqa: E501
+    is_manual: StrictBool = Field(alias="isManual")
+    is_active: StrictBool = Field(alias="isActive")
+    __properties: ClassVar[List[str]] = ["isManual", "isActive"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ChangeBoostModel from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ChangeBoostModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "isManual": obj.get("isManual"),
+            "isActive": obj.get("isActive")
+        })
+        return _obj
+
+

rapidata/api_client/models/classification_metadata.py

@@ -28,7 +28,7 @@ class ClassificationMetadata(BaseModel):
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for ClassificationMetadata", alias="_t")
     classification: StrictStr
-    visibilities: Optional[StrictStr] = None
+    visibilities: Optional[List[StrictStr]] = None
     __properties: ClassVar[List[str]] = ["_t", "classification", "visibilities"]
 
     @field_validator('t')
@@ -38,6 +38,17 @@ class ClassificationMetadata(BaseModel):
             raise ValueError("must be one of enum values ('ClassificationMetadata')")
         return value
 
+    @field_validator('visibilities')
+    def visibilities_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']):
+                raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

rapidata/api_client/models/classify_payload.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Rapidata.Dataset
+    Rapidata Asset API
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    The API for the Rapidata Asset service
 
     The version of the OpenAPI document: v1
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -17,8 +17,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List
+from rapidata.api_client.models.classify_payload_category import ClassifyPayloadCategory
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -26,17 +27,9 @@ class ClassifyPayload(BaseModel):
     """
     ClassifyPayload
     """ # noqa: E501
-    t: StrictStr = Field(description="Discriminator value for ClassifyPayload", alias="_t")
-    possible_categories: List[StrictStr] = Field(alias="possibleCategories")
+    categories: List[ClassifyPayloadCategory]
     title: StrictStr
-    __properties: ClassVar[List[str]] = ["_t", "possibleCategories", "title"]
-
-    @field_validator('t')
-    def t_validate_enum(cls, value):
-        """Validates the enum"""
-        if value not in set(['ClassifyPayload']):
-            raise ValueError("must be one of enum values ('ClassifyPayload')")
-        return value
+    __properties: ClassVar[List[str]] = ["categories", "title"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -77,6 +70,13 @@ class ClassifyPayload(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of each item in categories (list)
+        _items = []
+        if self.categories:
+            for _item_categories in self.categories:
+                if _item_categories:
+                    _items.append(_item_categories.to_dict())
+            _dict['categories'] = _items
         return _dict
 
     @classmethod
@@ -89,8 +89,7 @@ class ClassifyPayload(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "_t": obj.get("_t") if obj.get("_t") is not None else 'ClassifyPayload',
-            "possibleCategories": obj.get("possibleCategories"),
+            "categories": [ClassifyPayloadCategory.from_dict(_item) for _item in obj["categories"]] if obj.get("categories") is not None else None,
             "title": obj.get("title")
         })
         return _obj

rapidata/api_client/models/classify_payload_category.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    Rapidata Asset API
+
+    The API for the Rapidata Asset service
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ClassifyPayloadCategory(BaseModel):
+    """
+    ClassifyPayloadCategory
+    """ # noqa: E501
+    label: StrictStr
+    value: StrictStr
+    __properties: ClassVar[List[str]] = ["label", "value"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ClassifyPayloadCategory from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ClassifyPayloadCategory from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "label": obj.get("label"),
+            "value": obj.get("value")
+        })
+        return _obj
+
+

rapidata/api_client/models/client_model.py

@@ -0,0 +1,181 @@
+# coding: utf-8
+
+"""
+    Rapidata Asset API
+
+    The API for the Rapidata Asset service
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.json_web_key_set import JsonWebKeySet
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ClientModel(BaseModel):
+    """
+    ClientModel
+    """ # noqa: E501
+    client_id: StrictStr
+    client_secret: Optional[StrictStr]
+    client_id_issued_at: StrictInt
+    client_secret_expires_at: StrictInt
+    redirect_uris: Optional[List[List[StrictStr]]]
+    grant_types: Optional[List[List[StrictStr]]]
+    response_types: Optional[List[List[StrictStr]]]
+    client_name: Optional[StrictStr]
+    client_uri: Optional[StrictStr]
+    logo_uri: Optional[StrictStr]
+    scope: Optional[StrictStr]
+    contacts: List[StrictStr]
+    tos_uri: Optional[StrictStr]
+    policy_uri: Optional[StrictStr]
+    jwks_uri: Optional[StrictStr]
+    jwks: Optional[JsonWebKeySet]
+    __properties: ClassVar[List[str]] = ["client_id", "client_secret", "client_id_issued_at", "client_secret_expires_at", "redirect_uris", "grant_types", "response_types", "client_name", "client_uri", "logo_uri", "scope", "contacts", "tos_uri", "policy_uri", "jwks_uri", "jwks"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ClientModel from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of jwks
+        if self.jwks:
+            _dict['jwks'] = self.jwks.to_dict()
+        # set to None if client_secret (nullable) is None
+        # and model_fields_set contains the field
+        if self.client_secret is None and "client_secret" in self.model_fields_set:
+            _dict['client_secret'] = None
+
+        # set to None if redirect_uris (nullable) is None
+        # and model_fields_set contains the field
+        if self.redirect_uris is None and "redirect_uris" in self.model_fields_set:
+            _dict['redirect_uris'] = None
+
+        # set to None if grant_types (nullable) is None
+        # and model_fields_set contains the field
+        if self.grant_types is None and "grant_types" in self.model_fields_set:
+            _dict['grant_types'] = None
+
+        # set to None if response_types (nullable) is None
+        # and model_fields_set contains the field
+        if self.response_types is None and "response_types" in self.model_fields_set:
+            _dict['response_types'] = None
+
+        # set to None if client_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.client_name is None and "client_name" in self.model_fields_set:
+            _dict['client_name'] = None
+
+        # set to None if client_uri (nullable) is None
+        # and model_fields_set contains the field
+        if self.client_uri is None and "client_uri" in self.model_fields_set:
+            _dict['client_uri'] = None
+
+        # set to None if logo_uri (nullable) is None
+        # and model_fields_set contains the field
+        if self.logo_uri is None and "logo_uri" in self.model_fields_set:
+            _dict['logo_uri'] = None
+
+        # set to None if scope (nullable) is None
+        # and model_fields_set contains the field
+        if self.scope is None and "scope" in self.model_fields_set:
+            _dict['scope'] = None
+
+        # set to None if tos_uri (nullable) is None
+        # and model_fields_set contains the field
+        if self.tos_uri is None and "tos_uri" in self.model_fields_set:
+            _dict['tos_uri'] = None
+
+        # set to None if policy_uri (nullable) is None
+        # and model_fields_set contains the field
+        if self.policy_uri is None and "policy_uri" in self.model_fields_set:
+            _dict['policy_uri'] = None
+
+        # set to None if jwks_uri (nullable) is None
+        # and model_fields_set contains the field
+        if self.jwks_uri is None and "jwks_uri" in self.model_fields_set:
+            _dict['jwks_uri'] = None
+
+        # set to None if jwks (nullable) is None
+        # and model_fields_set contains the field
+        if self.jwks is None and "jwks" in self.model_fields_set:
+            _dict['jwks'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ClientModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "client_id": obj.get("client_id"),
+            "client_secret": obj.get("client_secret"),
+            "client_id_issued_at": obj.get("client_id_issued_at"),
+            "client_secret_expires_at": obj.get("client_secret_expires_at"),
+            "redirect_uris": obj.get("redirect_uris"),
+            "grant_types": obj.get("grant_types"),
+            "response_types": obj.get("response_types"),
+            "client_name": obj.get("client_name"),
+            "client_uri": obj.get("client_uri"),
+            "logo_uri": obj.get("logo_uri"),
+            "scope": obj.get("scope"),
+            "contacts": obj.get("contacts"),
+            "tos_uri": obj.get("tos_uri"),
+            "policy_uri": obj.get("policy_uri"),
+            "jwks_uri": obj.get("jwks_uri"),
+            "jwks": JsonWebKeySet.from_dict(obj["jwks"]) if obj.get("jwks") is not None else None
+        })
+        return _obj
+
+

rapidata/api_client/models/clients_query_result.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Rapidata.Dataset
+    Rapidata Asset API
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    The API for the Rapidata Asset service
 
     The version of the OpenAPI document: v1
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -27,9 +27,9 @@ class ClientsQueryResult(BaseModel):
     """
     ClientsQueryResult
     """ # noqa: E501
-    client_id: Optional[StrictStr] = Field(default=None, alias="clientId")
-    display_name: Optional[StrictStr] = Field(default=None, alias="displayName")
-    created_at: Optional[datetime] = Field(default=None, alias="createdAt")
+    client_id: Optional[StrictStr] = Field(alias="clientId")
+    display_name: Optional[StrictStr] = Field(alias="displayName")
+    created_at: Optional[datetime] = Field(alias="createdAt")
     __properties: ClassVar[List[str]] = ["clientId", "displayName", "createdAt"]
 
     model_config = ConfigDict(