smartytalent-client 0.2.5.dev1__tar.gz → 0.3.1.dev1__tar.gz

{smartytalent_client-0.2.5.dev1/smartytalent_client.egg-info → smartytalent_client-0.3.1.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smartytalent_client
-Version: 0.2.5.dev1
+Version: 0.3.1.dev1
 Summary: SmartyMeet Dev03 API REST
 Home-page: 
 Author: SmartyTalent API Support

{smartytalent_client-0.2.5.dev1 → smartytalent_client-0.3.1.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "smartytalent_client"
-version = "0.2.5.dev1"
+version = "0.3.1.dev1"
 description = "SmartyMeet Dev03 API REST"
 authors = [
   {name = "SmartyTalent API Support",email = "developer@smartymeet.com"},

{smartytalent_client-0.2.5.dev1 → smartytalent_client-0.3.1.dev1}/smartytalent_client/__init__.py

@@ -32,6 +32,7 @@ __all__ = [
     "CallsApi",
     "CandidatesApi",
     "ChatsApi",
+    "ClaimsApi",
     "CommentsApi",
     "ConversationsApi",
     "EmailsApi",
@@ -218,6 +219,9 @@ __all__ = [
     "ChatResourceSchema",
     "ChatSchema",
     "ChatsSchema",
+    "ClaimAttributesSchema",
+    "ClaimSchema",
+    "ClaimSchemaData",
     "CommentAttributesSchema",
     "CommentRelationshipsAuthorSchema",
     "CommentRelationshipsAuthorSchemaData",
@@ -836,6 +840,7 @@ from smartytalent_client.api.calendars_api import CalendarsApi as CalendarsApi
 from smartytalent_client.api.calls_api import CallsApi as CallsApi
 from smartytalent_client.api.candidates_api import CandidatesApi as CandidatesApi
 from smartytalent_client.api.chats_api import ChatsApi as ChatsApi
+from smartytalent_client.api.claims_api import ClaimsApi as ClaimsApi
 from smartytalent_client.api.comments_api import CommentsApi as CommentsApi
 from smartytalent_client.api.conversations_api import ConversationsApi as ConversationsApi
 from smartytalent_client.api.emails_api import EmailsApi as EmailsApi
@@ -1026,6 +1031,9 @@ from smartytalent_client.models.chat_relationships_user_schema import ChatRelati
 from smartytalent_client.models.chat_resource_schema import ChatResourceSchema as ChatResourceSchema
 from smartytalent_client.models.chat_schema import ChatSchema as ChatSchema
 from smartytalent_client.models.chats_schema import ChatsSchema as ChatsSchema
+from smartytalent_client.models.claim_attributes_schema import ClaimAttributesSchema as ClaimAttributesSchema
+from smartytalent_client.models.claim_schema import ClaimSchema as ClaimSchema
+from smartytalent_client.models.claim_schema_data import ClaimSchemaData as ClaimSchemaData
 from smartytalent_client.models.comment_attributes_schema import CommentAttributesSchema as CommentAttributesSchema
 from smartytalent_client.models.comment_relationships_author_schema import CommentRelationshipsAuthorSchema as CommentRelationshipsAuthorSchema
 from smartytalent_client.models.comment_relationships_author_schema_data import CommentRelationshipsAuthorSchemaData as CommentRelationshipsAuthorSchemaData

{smartytalent_client-0.2.5.dev1 → smartytalent_client-0.3.1.dev1}/smartytalent_client/api/__init__.py

@@ -14,6 +14,7 @@ from smartytalent_client.api.calendars_api import CalendarsApi
 from smartytalent_client.api.calls_api import CallsApi
 from smartytalent_client.api.candidates_api import CandidatesApi
 from smartytalent_client.api.chats_api import ChatsApi
+from smartytalent_client.api.claims_api import ClaimsApi
 from smartytalent_client.api.comments_api import CommentsApi
 from smartytalent_client.api.conversations_api import ConversationsApi
 from smartytalent_client.api.emails_api import EmailsApi

smartytalent_client-0.3.1.dev1/smartytalent_client/api/claims_api.py

@@ -0,0 +1,325 @@
+"""
+    SmartyMeet Dev03 API REST
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.1
+    Contact: developer@smartymeet.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictStr, field_validator
+from typing_extensions import Annotated
+from smartytalent_client.models.claim_schema import ClaimSchema
+
+from smartytalent_client.api_client import ApiClient, RequestSerialized
+from smartytalent_client.api_response import ApiResponse
+from smartytalent_client.rest import RESTResponseType
+
+
+class ClaimsApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def list_claims(
+        self,
+        filter_type: StrictStr,
+        filter_value: Annotated[StrictStr, Field(description="The exact name to check (email address, E.164 phone, or shortCode). Normalized to lowercase server-side.")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ClaimSchema:
+        """Check Claim Availability
+
+        Checks whether a global name (virtual-employee email address, E.164 phone number, or tenant shortCode) is available in the claim registry. The response never identifies a foreign owner: callers learn only `available`, plus `ownedByYou` and `status` for claims held by their own tenant. The check is advisory (TOCTOU) - the atomic gate is the conditional claim at write time, so a rename submit can still return a conflict after a green check.
+
+        :param filter_type: (required)
+        :type filter_type: str
+        :param filter_value: The exact name to check (email address, E.164 phone, or shortCode). Normalized to lowercase server-side. (required)
+        :type filter_value: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_claims_serialize(
+            filter_type=filter_type,
+            filter_value=filter_value,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ClaimSchema",
+            '400': "ErrorSchema",
+            '401': "ErrorSchema",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def list_claims_with_http_info(
+        self,
+        filter_type: StrictStr,
+        filter_value: Annotated[StrictStr, Field(description="The exact name to check (email address, E.164 phone, or shortCode). Normalized to lowercase server-side.")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[ClaimSchema]:
+        """Check Claim Availability
+
+        Checks whether a global name (virtual-employee email address, E.164 phone number, or tenant shortCode) is available in the claim registry. The response never identifies a foreign owner: callers learn only `available`, plus `ownedByYou` and `status` for claims held by their own tenant. The check is advisory (TOCTOU) - the atomic gate is the conditional claim at write time, so a rename submit can still return a conflict after a green check.
+
+        :param filter_type: (required)
+        :type filter_type: str
+        :param filter_value: The exact name to check (email address, E.164 phone, or shortCode). Normalized to lowercase server-side. (required)
+        :type filter_value: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_claims_serialize(
+            filter_type=filter_type,
+            filter_value=filter_value,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ClaimSchema",
+            '400': "ErrorSchema",
+            '401': "ErrorSchema",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def list_claims_without_preload_content(
+        self,
+        filter_type: StrictStr,
+        filter_value: Annotated[StrictStr, Field(description="The exact name to check (email address, E.164 phone, or shortCode). Normalized to lowercase server-side.")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Check Claim Availability
+
+        Checks whether a global name (virtual-employee email address, E.164 phone number, or tenant shortCode) is available in the claim registry. The response never identifies a foreign owner: callers learn only `available`, plus `ownedByYou` and `status` for claims held by their own tenant. The check is advisory (TOCTOU) - the atomic gate is the conditional claim at write time, so a rename submit can still return a conflict after a green check.
+
+        :param filter_type: (required)
+        :type filter_type: str
+        :param filter_value: The exact name to check (email address, E.164 phone, or shortCode). Normalized to lowercase server-side. (required)
+        :type filter_value: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_claims_serialize(
+            filter_type=filter_type,
+            filter_value=filter_value,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ClaimSchema",
+            '400': "ErrorSchema",
+            '401': "ErrorSchema",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _list_claims_serialize(
+        self,
+        filter_type,
+        filter_value,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if filter_type is not None:
+            
+            _query_params.append(('filterType', filter_type))
+            
+        if filter_value is not None:
+            
+            _query_params.append(('filterValue', filter_value))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'ApiKeyAuth', 
+            'OAuth2Auth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v1/claims',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

{smartytalent_client-0.2.5.dev1 → smartytalent_client-0.3.1.dev1}/smartytalent_client/models/__init__.py

@@ -161,6 +161,9 @@ from smartytalent_client.models.chat_relationships_user_schema import ChatRelati
 from smartytalent_client.models.chat_resource_schema import ChatResourceSchema
 from smartytalent_client.models.chat_schema import ChatSchema
 from smartytalent_client.models.chats_schema import ChatsSchema
+from smartytalent_client.models.claim_attributes_schema import ClaimAttributesSchema
+from smartytalent_client.models.claim_schema import ClaimSchema
+from smartytalent_client.models.claim_schema_data import ClaimSchemaData
 from smartytalent_client.models.comment_attributes_schema import CommentAttributesSchema
 from smartytalent_client.models.comment_relationships_author_schema import CommentRelationshipsAuthorSchema
 from smartytalent_client.models.comment_relationships_author_schema_data import CommentRelationshipsAuthorSchemaData

smartytalent_client-0.3.1.dev1/smartytalent_client/models/claim_attributes_schema.py

@@ -0,0 +1,117 @@
+# coding: utf-8
+
+"""
+    SmartyMeet Dev03 API REST
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.1
+    Contact: developer@smartymeet.com
+    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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ClaimAttributesSchema(BaseModel):
+    """
+    ClaimAttributesSchema
+    """ # noqa: E501
+    claim_type: Optional[StrictStr] = Field(default=None, alias="claimType")
+    value: Optional[StrictStr] = None
+    available: Optional[StrictBool] = Field(default=None, description="True when the name is unclaimed. False covers active claims AND rename aliases still blocking the name (a released alias frees up once its TTL removes the row).")
+    owned_by_you: Optional[StrictBool] = Field(default=None, description="True when the caller's tenant holds this claim - a claim your tenant owns can always be (re)used by it.", alias="ownedByYou")
+    status: Optional[StrictStr] = Field(default=None, description="Present ONLY on claims owned by the caller's tenant; never revealed for foreign claims.")
+    __properties: ClassVar[List[str]] = ["claimType", "value", "available", "ownedByYou", "status"]
+
+    @field_validator('claim_type')
+    def claim_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['shortcode', 'email', 'phone']):
+            raise ValueError("must be one of enum values ('shortcode', 'email', 'phone')")
+        return value
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['active', 'alias']):
+            raise ValueError("must be one of enum values ('active', 'alias')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ClaimAttributesSchema 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 ClaimAttributesSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "claimType": obj.get("claimType"),
+            "value": obj.get("value"),
+            "available": obj.get("available"),
+            "ownedByYou": obj.get("ownedByYou"),
+            "status": obj.get("status")
+        })
+        return _obj
+
+

smartytalent_client-0.3.1.dev1/smartytalent_client/models/claim_schema.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    SmartyMeet Dev03 API REST
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.1
+    Contact: developer@smartymeet.com
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from smartytalent_client.models.claim_schema_data import ClaimSchemaData
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ClaimSchema(BaseModel):
+    """
+    ClaimSchema
+    """ # noqa: E501
+    data: Optional[ClaimSchemaData] = None
+    __properties: ClassVar[List[str]] = ["data"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ClaimSchema 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 data
+        if self.data:
+            _dict['data'] = self.data.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ClaimSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "data": ClaimSchemaData.from_dict(obj["data"]) if obj.get("data") is not None else None
+        })
+        return _obj
+
+