orq-ai-sdk 4.2.0rc28__py3-none-any.whl → 4.3.0rc7__py3-none-any.whl

orq_ai_sdk/models/createidentityop.py

@@ -0,0 +1,176 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import datetime
+from orq_ai_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from orq_ai_sdk.utils import parse_datetime
+import pydantic
+from pydantic import model_serializer
+from typing import Any, Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CreateIdentityRequestBodyTypedDict(TypedDict):
+    r"""Identity profile information"""
+
+    external_id: str
+    r"""Unique string value to identify the contact user in the customer's system. This should be the same ID you use in your system to reference this user."""
+    display_name: NotRequired[Nullable[str]]
+    r"""Display name or nickname of the contact user. This is typically shown in user interfaces."""
+    email: NotRequired[Nullable[str]]
+    r"""Email address of the contact user"""
+    avatar_url: NotRequired[Nullable[str]]
+    r"""URL linking to the contact user's avatar image"""
+    tags: NotRequired[List[str]]
+    r"""Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications."""
+    metadata: NotRequired[Dict[str, Any]]
+    r"""Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application."""
+
+
+class CreateIdentityRequestBody(BaseModel):
+    r"""Identity profile information"""
+
+    external_id: str
+    r"""Unique string value to identify the contact user in the customer's system. This should be the same ID you use in your system to reference this user."""
+
+    display_name: OptionalNullable[str] = UNSET
+    r"""Display name or nickname of the contact user. This is typically shown in user interfaces."""
+
+    email: OptionalNullable[str] = UNSET
+    r"""Email address of the contact user"""
+
+    avatar_url: OptionalNullable[str] = UNSET
+    r"""URL linking to the contact user's avatar image"""
+
+    tags: Optional[List[str]] = None
+    r"""Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications."""
+
+    metadata: Optional[Dict[str, Any]] = None
+    r"""Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            ["display_name", "email", "avatar_url", "tags", "metadata"]
+        )
+        nullable_fields = set(["display_name", "email", "avatar_url"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m
+
+
+class CreateIdentityResponseBodyTypedDict(TypedDict):
+    r"""Created Identity"""
+
+    id: str
+    r"""Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the contact"""
+    external_id: str
+    r"""Unique string value to identify the contact user in the customer's system. This should be the same ID you use in your system to reference this user."""
+    workspace_id: str
+    r"""Unique identifier for the workspace to which the contact belongs"""
+    display_name: NotRequired[Nullable[str]]
+    r"""Display name or nickname of the contact user. This is typically shown in user interfaces."""
+    email: NotRequired[Nullable[str]]
+    r"""Email address of the contact user"""
+    avatar_url: NotRequired[Nullable[str]]
+    r"""URL linking to the contact user's avatar image"""
+    tags: NotRequired[List[str]]
+    r"""Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications."""
+    metadata: NotRequired[Dict[str, Any]]
+    r"""Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application."""
+    created: NotRequired[datetime]
+    r"""The date and time the resource was created"""
+    updated: NotRequired[datetime]
+    r"""The date and time the resource was last updated"""
+
+
+class CreateIdentityResponseBody(BaseModel):
+    r"""Created Identity"""
+
+    id: Annotated[str, pydantic.Field(alias="_id")]
+    r"""Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the contact"""
+
+    external_id: str
+    r"""Unique string value to identify the contact user in the customer's system. This should be the same ID you use in your system to reference this user."""
+
+    workspace_id: str
+    r"""Unique identifier for the workspace to which the contact belongs"""
+
+    display_name: OptionalNullable[str] = UNSET
+    r"""Display name or nickname of the contact user. This is typically shown in user interfaces."""
+
+    email: OptionalNullable[str] = UNSET
+    r"""Email address of the contact user"""
+
+    avatar_url: OptionalNullable[str] = UNSET
+    r"""URL linking to the contact user's avatar image"""
+
+    tags: Optional[List[str]] = None
+    r"""Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications."""
+
+    metadata: Optional[Dict[str, Any]] = None
+    r"""Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application."""
+
+    created: Optional[datetime] = None
+    r"""The date and time the resource was created"""
+
+    updated: Optional[datetime] = parse_datetime("2026-01-28T17:03:47.548Z")
+    r"""The date and time the resource was last updated"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "display_name",
+                "email",
+                "avatar_url",
+                "tags",
+                "metadata",
+                "created",
+                "updated",
+            ]
+        )
+        nullable_fields = set(["display_name", "email", "avatar_url"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m