uipath 2.1.49__py3-none-any.whl → 2.1.51__py3-none-any.whl

uipath/models/entities.py

@@ -0,0 +1,286 @@
+from enum import Enum
+from typing import Any, Dict, List, Optional, Type, Union, get_args, get_origin
+
+from pydantic import BaseModel, ConfigDict, Field, create_model
+
+
+class ReferenceType(Enum):
+    ManyToOne = "ManyToOne"
+
+
+class FieldDisplayType(Enum):
+    Basic = "Basic"
+    Relationship = "Relationship"
+    File = "File"
+    ChoiceSetSingle = "ChoiceSetSingle"
+    ChoiceSetMultiple = "ChoiceSetMultiple"
+    AutoNumber = "AutoNumber"
+
+
+class DataDirectionType(Enum):
+    ReadOnly = "ReadOnly"
+    ReadAndWrite = "ReadAndWrite"
+
+
+class JoinType(Enum):
+    LeftJoin = "LeftJoin"
+
+
+class EntityType(Enum):
+    Entity = "Entity"
+    ChoiceSet = "ChoiceSet"
+    InternalEntity = "InternalEntity"
+    SystemEntity = "SystemEntity"
+
+
+class EntityFieldMetadata(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+    )
+    type: str
+    required: bool
+    name: str
+
+
+class ExternalConnection(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+    )
+    id: str
+    connection_id: str = Field(alias="connectionId")
+    element_instance_id: str = Field(alias="elementInstanceId")
+    folder_id: str = Field(alias="folderKey")  # named folderKey in TS SDK
+    connector_id: str = Field(alias="connectorKey")  # named connectorKey in TS SDK
+    connector_name: str = Field(alias="connectorName")
+    connection_name: str = Field(alias="connectionName")
+
+
+class ExternalFieldMapping(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+    )
+    id: str
+    external_field_name: str = Field(alias="externalFieldName")
+    external_field_display_name: str = Field(alias="externalFieldDisplayName")
+    external_object_id: str = Field(alias="externalObjectId")
+    external_field_type: str = Field(alias="externalFieldType")
+    internal_field_id: str = Field(alias="internalFieldId")
+    direction_type: DataDirectionType = Field(alias="directionType")
+
+
+class FieldDataType(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+    )
+    name: str
+    length_limit: Optional[int] = Field(default=None, alias="LengthLimit")
+    max_value: Optional[int] = Field(default=None, alias="MaxValue")
+    min_value: Optional[int] = Field(default=None, alias="MinValue")
+    decimal_precision: Optional[int] = Field(default=None, alias="DecimalPrecision")
+
+
+class FieldMetadata(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+    )
+    id: Optional[str] = Field(default=None, alias="id")
+    name: str
+    is_primary_key: bool = Field(alias="isPrimaryKey")
+    is_foreign_key: bool = Field(alias="isForeignKey")
+    is_external_field: bool = Field(alias="isExternalField")
+    is_hidden_field: bool = Field(alias="isHiddenField")
+    is_unique: bool = Field(alias="isUnique")
+    reference_name: Optional[str] = Field(default=None, alias="referenceName")
+    reference_entity: Optional["Entity"] = Field(default=None, alias="referenceEntity")
+    reference_choiceset: Optional["Entity"] = Field(
+        default=None, alias="referenceChoiceset"
+    )
+    reference_field: Optional["EntityField"] = Field(
+        default=None, alias="referenceField"
+    )
+    reference_type: ReferenceType = Field(alias="referenceType")
+    sql_type: "FieldDataType" = Field(alias="sqlType")
+    is_required: bool = Field(alias="isRequired")
+    display_name: str = Field(alias="displayName")
+    description: Optional[str] = Field(default=None, alias="description")
+    is_system_field: bool = Field(alias="isSystemField")
+    field_display_type: Optional[str] = Field(
+        default=None, alias="fieldDisplayType"
+    )  # Should be FieldDisplayType enum
+    choiceset_id: Optional[str] = Field(default=None, alias="choicesetId")
+    default_value: Optional[str] = Field(default=None, alias="defaultValue")
+    is_attachment: bool = Field(alias="isAttachment")
+    is_rbac_enabled: bool = Field(alias="isRbacEnabled")
+
+
+class ExternalField(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+    )
+    field_metadata: FieldMetadata = Field(alias="fieldMetadata")
+    external_field_mapping_detail: ExternalFieldMapping = Field(
+        alias="externalFieldMappingDetail"
+    )
+
+
+class EntityField(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+    )
+    id: Optional[str] = Field(default=None, alias="id")
+    definition: Optional[FieldMetadata] = Field(default=None, alias="definition")
+
+
+class ExternalObject(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+    )
+    id: str
+    external_object_name: str = Field(alias="externalObjectName")
+    external_object_display_name: str = Field(alias="externalObjectDisplayName")
+    primary_key: str = Field(alias="primaryKey")
+    external_connection_id: str = Field(alias="externalConnectionId")
+    entity_id: str = Field(alias="entityId")
+    is_primary_source: bool = Field(alias="isPrimarySource")
+
+
+class ExternalSourceFields(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+    )
+    fields: List[ExternalField]
+    external_object_detail: ExternalObject = Field(alias="externalObject")
+    external_connection_detail: ExternalConnection = Field(alias="externalConnection")
+
+
+class SourceJoinCriteria(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+    )
+    id: str
+    entity_id: str = Field(alias="entityId")
+    join_field_name: str = Field(alias="joinFieldName")
+    join_type: str = Field(alias="joinType")
+    related_source_object_id: str = Field(alias="relatedSourceObjectId")
+    related_source_object_field_name: str = Field(alias="relatedSourceObjectFieldName")
+    related_source_field_name: str = Field(alias="relatedSourceFieldName")
+
+
+class EntityRecord(BaseModel):
+    model_config = {
+        "validate_by_name": True,
+        "validate_by_alias": True,
+        "extra": "allow",
+    }
+
+    id: str = Field(alias="Id")  # Mandatory field validated by Pydantic
+
+    @classmethod
+    def from_data(
+        cls, data: Dict[str, Any], model: Optional[Any] = None
+    ) -> "EntityRecord":
+        """Create an EntityRecord instance by validating raw data and optionally instantiating a custom model.
+
+        :param data: Raw data dictionary for the entity.
+        :param model: Optional user-defined class for validation.
+        :return: EntityRecord instance
+        """
+        # Validate the "Id" field is mandatory and must be a string
+        id_value = data.get("Id", None)
+        if id_value is None or not isinstance(id_value, str):
+            raise ValueError("Field 'Id' is mandatory and must be a string.")
+
+        if model:
+            # Check if the model is a plain Python class or Pydantic model
+            cls._validate_against_user_model(data, model)
+
+        return cls(**data)
+
+    @staticmethod
+    def _validate_against_user_model(
+        data: Dict[str, Any], user_class: Type[Any]
+    ) -> None:
+        user_class_annotations = getattr(user_class, "__annotations__", None)
+        if user_class_annotations is None:
+            raise ValueError(
+                f"User-provided class '{user_class.__name__}' is missing type annotations."
+            )
+
+        # Dynamically define a Pydantic model based on the user's class annotations
+        # Fields must be valid type annotations directly
+        pydantic_fields = {}
+
+        for name, annotation in user_class_annotations.items():
+            is_optional = False
+
+            origin = get_origin(annotation)
+            args = get_args(annotation)
+
+            # Handle Optional[...] or X | None
+            if origin is Union and type(None) in args:
+                is_optional = True
+
+            # Check for optional fields
+            if is_optional:
+                pydantic_fields[name] = (annotation, None)  # Not required
+            else:
+                pydantic_fields[name] = (annotation, ...)  # type: ignore
+
+        # Dynamically create the Pydantic model class
+        dynamic_model = create_model(
+            f"Dynamic_{user_class.__name__}",
+            **pydantic_fields,  # type: ignore
+        )
+
+        # Validate input data
+        dynamic_model.model_validate(data)
+
+
+class Entity(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+    )
+
+    name: str
+    display_name: str = Field(alias="displayName")
+    entity_type: str = Field(alias="entityType")
+    description: Optional[str] = Field(default=None, alias="description")
+    fields: Optional[List[FieldMetadata]] = Field(default=None, alias="fields")
+    external_fields: Optional[List[ExternalSourceFields]] = Field(
+        default=None, alias="externalFields"
+    )
+    source_join_criteria: Optional[List[SourceJoinCriteria]] = Field(
+        default=None, alias="sourceJoinCriteria"
+    )
+    record_count: Optional[int] = Field(default=None, alias="recordCount")
+    storage_size_in_mb: Optional[float] = Field(default=None, alias="storageSizeInMB")
+    used_storage_size_in_mb: Optional[float] = Field(
+        default=None, alias="usedStorageSizeInMB"
+    )
+    attachment_size_in_byte: Optional[int] = Field(
+        default=None, alias="attachmentSizeInBytes"
+    )
+    is_rbac_enabled: bool = Field(alias="isRbacEnabled")
+    id: str
+
+
+class EntityRecordsBatchResponse(BaseModel):
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+    )
+
+    success_records: List[EntityRecord] = Field(alias="successRecords")
+    failure_records: List[EntityRecord] = Field(alias="failureRecords")
+
+
+Entity.model_rebuild()

{uipath-2.1.49.dist-info → uipath-2.1.51.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.1.49
+Version: 2.1.51
 Summary: Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools.
 Project-URL: Homepage, https://uipath.com
 Project-URL: Repository, https://github.com/UiPath/uipath-python

{uipath-2.1.49.dist-info → uipath-2.1.51.dist-info}/RECORD

@@ -2,15 +2,15 @@ uipath/__init__.py,sha256=IaeKItOOQXMa95avueJ3dAq-XcRHyZVNjcCGwlSB000,634
 uipath/_config.py,sha256=pi3qxPzDTxMEstj_XkGOgKJqD6RTHHv7vYv8sS_-d5Q,92
 uipath/_execution_context.py,sha256=Qo8VMUFgtiL-40KsZrvul5bGv1CRERle_fCw1ORCggY,2374
 uipath/_folder_context.py,sha256=D-bgxdwpwJP4b_QdVKcPODYh15kMDrOar2xNonmMSm4,1861
-uipath/_uipath.py,sha256=lDsF2rBurqxm24DlRan25z9SU9t9b2RkAGvoI645QSw,4314
+uipath/_uipath.py,sha256=p2ccvWpzBXAGFSSF_YaaSWdEqzMmRt786d0pFWrCEwU,4463
 uipath/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 uipath/_cli/README.md,sha256=GLtCfbeIKZKNnGTCsfSVqRQ27V1btT1i2bSAyW_xZl4,474
-uipath/_cli/__init__.py,sha256=kf4GINkunFGMZkTk2Z4f1Q3-OsxpNnV6u_9BsBt1i0E,2229
+uipath/_cli/__init__.py,sha256=tscKceSouYcEOxUbGjoyHi4qGi74giBFeXG1I-ut1hs,2308
 uipath/_cli/cli_auth.py,sha256=i3ykLlCg68xgPXHHaa0agHwGFIiLiTLzOiF6Su8XaEo,2436
 uipath/_cli/cli_deploy.py,sha256=KPCmQ0c_NYD5JofSDao5r6QYxHshVCRxlWDVnQvlp5w,645
 uipath/_cli/cli_dev.py,sha256=nEfpjw1PZ72O6jmufYWVrueVwihFxDPOeJakdvNHdOA,2146
 uipath/_cli/cli_eval.py,sha256=fYJWQlyiIc8SpTzY9QPNQWOx40PagMEKdsGZIu9As2A,4402
-uipath/_cli/cli_init.py,sha256=ls577uNm2zWccknIhtVFS3ah2ds0QSy2_TgMp6z7Wt4,6049
+uipath/_cli/cli_init.py,sha256=Ac3-9tIH3rpikIX1ehWTo7InW5tjVNoz_w6fjvgLK4w,7052
 uipath/_cli/cli_invoke.py,sha256=4jyhqcy7tPrpxvaUhW-9gut6ddsCGMdJJcpOXXmIe8g,4348
 uipath/_cli/cli_new.py,sha256=9378NYUBc9j-qKVXV7oja-jahfJhXBg8zKVyaon7ctY,2102
 uipath/_cli/cli_pack.py,sha256=NmwZTfwZ2fURiHyiX1BM0juAtBOjPB1Jmcpu-rD7p-4,11025
@@ -45,7 +45,7 @@ uipath/_cli/_dev/_terminal/_utils/_chat.py,sha256=YUZxYVdmEManwHDuZsczJT1dWIYE1d
 uipath/_cli/_dev/_terminal/_utils/_exporter.py,sha256=oI6D_eMwrh_2aqDYUh4GrJg8VLGrLYhDahR-_o0uJns,4144
 uipath/_cli/_dev/_terminal/_utils/_logger.py,sha256=jeNShEED27cNIHTe_NNx-2kUiXpSLTmi0onM6tVkqRM,888
 uipath/_cli/_evals/_runtime.py,sha256=q4h3zp_7Ygkhj1zE_YTKKXRp3BhkHaPj8CWqjkzerTk,4748
-uipath/_cli/_evals/progress_reporter.py,sha256=m1Dio1vG-04nFTFz5ijM_j1dhudlgOzQukmTkkg6wS4,11490
+uipath/_cli/_evals/progress_reporter.py,sha256=PGt1rs7IH1C6HPw8fWUwb98GB3UBuM6eUiiqGthfCIk,11174
 uipath/_cli/_evals/_evaluators/__init__.py,sha256=jD7KNLjbsUpsESFXX11eW2MEPXDNuPp2-t-IPB-inlM,734
 uipath/_cli/_evals/_evaluators/_deterministic_evaluator_base.py,sha256=BTl0puBjp9iCsU3YFfYWqk4TOz4iE19O3q1-dK6qUOI,1723
 uipath/_cli/_evals/_evaluators/_evaluator_base.py,sha256=knHUwYFt0gMG1uJhq5TGEab6M_YevxX019yT3yYwZsw,3787
@@ -83,7 +83,8 @@ uipath/_cli/_utils/_project_files.py,sha256=a_mhBN0CLp2h56DYswjE79BP3M_LpIMYteJc
 uipath/_cli/_utils/_studio_project.py,sha256=HvzcpIIIA4hUIvMbId1dsAhmFLMuhnS2ZtyNdcpXJ8c,15422
 uipath/_cli/_utils/_tracing.py,sha256=2igb03j3EHjF_A406UhtCKkPfudVfFPjUq5tXUEG4oo,1541
 uipath/_cli/_utils/_uv_helpers.py,sha256=6SvoLnZPoKIxW0sjMvD1-ENV_HOXDYzH34GjBqwT138,3450
-uipath/_services/__init__.py,sha256=10xtw3ENC30yR9CCq_b94RMZ3YrUeyfHV33yWYUd8tU,896
+uipath/_resources/AGENTS.md,sha256=YWhWuX9XIbyVhVT3PnPc4Of3_q6bsNJcuzYu3N8f_Ug,25850
+uipath/_services/__init__.py,sha256=W08UO7ZBQRD8LBHsC6gaM4YBSUl8az0S4d6iZSKsdPE,965
 uipath/_services/_base_service.py,sha256=x9-9jhPzn9Z16KRdFHhJNvV-FZHvTniMsDfxlS4Cutk,5782
 uipath/_services/actions_service.py,sha256=2RPMR-hFMsOlqEyjIf3aF7-lrf57jdrSD0pBjj0Kyko,16040
 uipath/_services/api_client.py,sha256=kGm04ijk9AOEQd2BMxvQg-2QoB8dmyoDwFFDPyutAGw,1966
@@ -91,10 +92,11 @@ uipath/_services/assets_service.py,sha256=pG0Io--SeiRRQmfUWPQPl1vq3csZlQgx30LBNK
 uipath/_services/attachments_service.py,sha256=NPQYK7CGjfBaNT_1S5vEAfODmOChTbQZforllFM2ofU,26678
 uipath/_services/buckets_service.py,sha256=5s8tuivd7GUZYj774DDUYTa0axxlUuesc4EBY1V5sdk,18496
 uipath/_services/connections_service.py,sha256=Rf-DCm43tsDM6Cfp41iwGR4gUk_YCdobGcmbSoKvQ6E,7480
-uipath/_services/context_grounding_service.py,sha256=EBf7lIIYz_s1ubf_07OAZXQHjS8kpZ2vqxo4mI3VL-A,25009
+uipath/_services/context_grounding_service.py,sha256=kp7h6Hd-VUuTqiDO-G7IanmXhaq0XHjXUk0ISFev-5c,24835
+uipath/_services/entities_service.py,sha256=QKCLE6wRgq3HZraF-M2mljy-8il4vsNHrQhUgkewVVk,14028
 uipath/_services/folder_service.py,sha256=9JqgjKhWD-G_KUnfUTP2BADxL6OK9QNZsBsWZHAULdE,2749
-uipath/_services/jobs_service.py,sha256=UwsY0Cir7Yd5_mTeH0uHLmcmQZpdbT8KNx3z3F0cHZA,32775
-uipath/_services/llm_gateway_service.py,sha256=oZR--75V8ULdLjVC7lo-lJ5786J_qfXUDe0R9iWNAKs,24306
+uipath/_services/jobs_service.py,sha256=tTZNsdZKN3uP7bWPQyBCpJeQxTfuOWbKYOR4L-_yJo4,32736
+uipath/_services/llm_gateway_service.py,sha256=Ka1WCoOBKJfIlm7H9NmbKAPr27UYDYQCTExMbLKMY68,24249
 uipath/_services/processes_service.py,sha256=O_uHgQ1rnwiV5quG0OQqabAnE6Rf6cWrMENYY2jKWt8,8585
 uipath/_services/queues_service.py,sha256=VaG3dWL2QK6AJBOLoW2NQTpkPfZjsqsYPl9-kfXPFzA,13534
 uipath/_utils/__init__.py,sha256=VdcpnENJIa0R6Y26NoxY64-wUVyvb4pKfTh1wXDQeMk,526
@@ -129,6 +131,7 @@ uipath/models/buckets.py,sha256=N3Lj_dVCv709-ywhOOdyCSvsuLn41eGuAfSiik6Q6F8,1285
 uipath/models/connections.py,sha256=V6Ecx10HBDO2HGaIGG8NGx4q2sEhViAoPOUgPosPfvE,2418
 uipath/models/context_grounding.py,sha256=3MaF2Fv2QYle8UUWvKGkCN5XGpx2T4a34fdbBqJ2fCs,1137
 uipath/models/context_grounding_index.py,sha256=OhRyxZDHDSrEmBFK0-JLqMMMT64jir4XkHtQ54IKtc0,2683
+uipath/models/entities.py,sha256=x6jbq4o_QhgL_pCgvHFsp9O8l333kQhn8e9ZCBs72UM,9823
 uipath/models/errors.py,sha256=WCxxHBlLzLF17YxjqsFkkyBLwEQM_dc6fFU5qmBjD4A,597
 uipath/models/exceptions.py,sha256=F0ITAhJsl6Agvmnv4nxvgY5oC_lrYIlxWTLs0yx859M,1636
 uipath/models/interrupt_models.py,sha256=UzuVTMVesI204YQ4qFQFaN-gN3kksddkrujofcaC7zQ,881
@@ -145,8 +148,8 @@ uipath/tracing/_traced.py,sha256=qeVDrds2OUnpdUIA0RhtF0kg2dlAZhyC1RRkI-qivTM,185
 uipath/tracing/_utils.py,sha256=wJRELaPu69iY0AhV432Dk5QYf_N_ViRU4kAUG1BI1ew,10384
 uipath/utils/__init__.py,sha256=VD-KXFpF_oWexFg6zyiWMkxl2HM4hYJMIUDZ1UEtGx0,105
 uipath/utils/_endpoints_manager.py,sha256=iRTl5Q0XAm_YgcnMcJOXtj-8052sr6jpWuPNz6CgT0Q,8408
-uipath-2.1.49.dist-info/METADATA,sha256=P2ab9mn67546ol40e40jUyA0fsS1SM9mefHzryHG5zw,6482
-uipath-2.1.49.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-uipath-2.1.49.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
-uipath-2.1.49.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
-uipath-2.1.49.dist-info/RECORD,,
+uipath-2.1.51.dist-info/METADATA,sha256=eCmpOjEple77twr2UUCa3-mSTvU0SnozK-4TRqdhdjY,6482
+uipath-2.1.51.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+uipath-2.1.51.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
+uipath-2.1.51.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
+uipath-2.1.51.dist-info/RECORD,,