solvimon-python-sdk 0.0.4b0__py3-none-any.whl

solvimon_python_sdk/api/contacts_api.py

@@ -0,0 +1,2036 @@
+"""
+    Solvimon API
+
+    Unified Solvimon API covering Configuration, Event, Identity, and Transaction domains.
+
+    The version of the OpenAPI document: 0.0.4-beta
+    Contact: contact@solvimon.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, StrictInt, StrictStr
+from typing import Dict, Optional
+from typing_extensions import Annotated
+from solvimon_python_sdk.models.contact import Contact
+from solvimon_python_sdk.models.contact_create_request import ContactCreateRequest
+from solvimon_python_sdk.models.contact_response_wrapper import ContactResponseWrapper
+from solvimon_python_sdk.models.contact_update_request import ContactUpdateRequest
+
+from solvimon_python_sdk.api_client import ApiClient, RequestSerialized
+from solvimon_python_sdk.api_response import ApiResponse
+from solvimon_python_sdk.rest import RESTResponseType
+
+
+class ContactsApi:
+    """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 delete_contacts_by_resource_id(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _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,
+    ) -> Contact:
+        """Delete a contact by ID
+
+        Requires the CONTACT.DELETE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id: The ID of the resource to be requested. (required)
+        :type resource_id: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: 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._delete_contacts_by_resource_id_serialize(
+            version=version,
+            resource_id=resource_id,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        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 delete_contacts_by_resource_id_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _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[Contact]:
+        """Delete a contact by ID
+
+        Requires the CONTACT.DELETE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id: The ID of the resource to be requested. (required)
+        :type resource_id: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: 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._delete_contacts_by_resource_id_serialize(
+            version=version,
+            resource_id=resource_id,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        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 delete_contacts_by_resource_id_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _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:
+        """Delete a contact by ID
+
+        Requires the CONTACT.DELETE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id: The ID of the resource to be requested. (required)
+        :type resource_id: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: 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._delete_contacts_by_resource_id_serialize(
+            version=version,
+            resource_id=resource_id,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _delete_contacts_by_resource_id_serialize(
+        self,
+        version,
+        resource_id,
+        x_platform_id,
+        _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
+        if version is not None:
+            _path_params['version'] = version
+        if resource_id is not None:
+            _path_params['resourceId'] = resource_id
+        # process the query parameters
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # 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] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='DELETE',
+            resource_path='/v{version}/contacts/{resourceId}',
+            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
+        )
+
+
+
+
+    @validate_call
+    def get_contacts(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        customer_id: Annotated[Optional[StrictStr], Field(description="The resource id of the customer.")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
+        limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
+        custom_field: Annotated[Optional[StrictStr], Field(description="Filter the response by a custom field value.")] = None,
+        _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,
+    ) -> ContactResponseWrapper:
+        """Get a list of contacts
+
+        Requires the CONTACT.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param customer_id: The resource id of the customer.
+        :type customer_id: str
+        :param page: The page which is going to be shown
+        :type page: int
+        :param limit: The amount of records shown in the list
+        :type limit: int
+        :param custom_field: Filter the response by a custom field value.
+        :type custom_field: 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._get_contacts_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            customer_id=customer_id,
+            page=page,
+            limit=limit,
+            custom_field=custom_field,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ContactResponseWrapper",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        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 get_contacts_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        customer_id: Annotated[Optional[StrictStr], Field(description="The resource id of the customer.")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
+        limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
+        custom_field: Annotated[Optional[StrictStr], Field(description="Filter the response by a custom field value.")] = None,
+        _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[ContactResponseWrapper]:
+        """Get a list of contacts
+
+        Requires the CONTACT.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param customer_id: The resource id of the customer.
+        :type customer_id: str
+        :param page: The page which is going to be shown
+        :type page: int
+        :param limit: The amount of records shown in the list
+        :type limit: int
+        :param custom_field: Filter the response by a custom field value.
+        :type custom_field: 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._get_contacts_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            customer_id=customer_id,
+            page=page,
+            limit=limit,
+            custom_field=custom_field,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ContactResponseWrapper",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        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 get_contacts_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        customer_id: Annotated[Optional[StrictStr], Field(description="The resource id of the customer.")] = None,
+        page: Annotated[Optional[StrictInt], Field(description="The page which is going to be shown")] = None,
+        limit: Annotated[Optional[StrictInt], Field(description="The amount of records shown in the list")] = None,
+        custom_field: Annotated[Optional[StrictStr], Field(description="Filter the response by a custom field value.")] = None,
+        _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:
+        """Get a list of contacts
+
+        Requires the CONTACT.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param customer_id: The resource id of the customer.
+        :type customer_id: str
+        :param page: The page which is going to be shown
+        :type page: int
+        :param limit: The amount of records shown in the list
+        :type limit: int
+        :param custom_field: Filter the response by a custom field value.
+        :type custom_field: 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._get_contacts_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            customer_id=customer_id,
+            page=page,
+            limit=limit,
+            custom_field=custom_field,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ContactResponseWrapper",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_contacts_serialize(
+        self,
+        version,
+        x_platform_id,
+        customer_id,
+        page,
+        limit,
+        custom_field,
+        _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
+        if version is not None:
+            _path_params['version'] = version
+        # process the query parameters
+        if customer_id is not None:
+            
+            _query_params.append(('customer_id', customer_id))
+            
+        if page is not None:
+            
+            _query_params.append(('page', page))
+            
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        if custom_field is not None:
+            
+            _query_params.append(('custom_field', custom_field))
+            
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # 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] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v{version}/contacts',
+            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
+        )
+
+
+
+
+    @validate_call
+    def get_contacts_by_resource_id(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _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,
+    ) -> Contact:
+        """Get a contact by ID
+
+        Requires the CONTACT.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id: The ID of the resource to be requested. (required)
+        :type resource_id: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: 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._get_contacts_by_resource_id_serialize(
+            version=version,
+            resource_id=resource_id,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        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 get_contacts_by_resource_id_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _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[Contact]:
+        """Get a contact by ID
+
+        Requires the CONTACT.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id: The ID of the resource to be requested. (required)
+        :type resource_id: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: 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._get_contacts_by_resource_id_serialize(
+            version=version,
+            resource_id=resource_id,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        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 get_contacts_by_resource_id_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        _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:
+        """Get a contact by ID
+
+        Requires the CONTACT.VIEW permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id: The ID of the resource to be requested. (required)
+        :type resource_id: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: 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._get_contacts_by_resource_id_serialize(
+            version=version,
+            resource_id=resource_id,
+            x_platform_id=x_platform_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_contacts_by_resource_id_serialize(
+        self,
+        version,
+        resource_id,
+        x_platform_id,
+        _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
+        if version is not None:
+            _path_params['version'] = version
+        if resource_id is not None:
+            _path_params['resourceId'] = resource_id
+        # process the query parameters
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # 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] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v{version}/contacts/{resourceId}',
+            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
+        )
+
+
+
+
+    @validate_call
+    def post_contacts(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        contact_create_request: Optional[ContactCreateRequest] = None,
+        _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,
+    ) -> Contact:
+        """Create a contact
+
+        Requires the CONTACT.CREATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param contact_create_request:
+        :type contact_create_request: ContactCreateRequest
+        :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._post_contacts_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            contact_create_request=contact_create_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '409': "ApiError",
+            '500': "ApiError",
+        }
+        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 post_contacts_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        contact_create_request: Optional[ContactCreateRequest] = None,
+        _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[Contact]:
+        """Create a contact
+
+        Requires the CONTACT.CREATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param contact_create_request:
+        :type contact_create_request: ContactCreateRequest
+        :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._post_contacts_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            contact_create_request=contact_create_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '409': "ApiError",
+            '500': "ApiError",
+        }
+        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 post_contacts_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        contact_create_request: Optional[ContactCreateRequest] = None,
+        _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:
+        """Create a contact
+
+        Requires the CONTACT.CREATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param contact_create_request:
+        :type contact_create_request: ContactCreateRequest
+        :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._post_contacts_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            contact_create_request=contact_create_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '409': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _post_contacts_serialize(
+        self,
+        version,
+        x_platform_id,
+        contact_create_request,
+        _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
+        if version is not None:
+            _path_params['version'] = version
+        # process the query parameters
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # process the form parameters
+        # process the body parameter
+        if contact_create_request is not None:
+            _body_params = contact_create_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    '*/*'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/v{version}/contacts',
+            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
+        )
+
+
+
+
+    @validate_call
+    def update_contacts(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        identifier_field: Annotated[Optional[StrictStr], Field(description="Which field to use to identify whether the resource exists or not")] = None,
+        custom_field_reference: Annotated[Optional[StrictStr], Field(description="Which custom field to use to identify whether the resource exists or not")] = None,
+        field_actions: Annotated[Optional[Dict[str, Dict[str, StrictStr]]], Field(description="The list of actions for specific fields.")] = None,
+        contact_create_request: Optional[ContactCreateRequest] = None,
+        _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,
+    ) -> Contact:
+        """Update or create a contact (upsert)
+
+        Requires the CONTACT.CREATE or CONTACT.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param identifier_field: Which field to use to identify whether the resource exists or not
+        :type identifier_field: str
+        :param custom_field_reference: Which custom field to use to identify whether the resource exists or not
+        :type custom_field_reference: str
+        :param field_actions: The list of actions for specific fields.
+        :type field_actions: Dict[str, str]
+        :param contact_create_request:
+        :type contact_create_request: ContactCreateRequest
+        :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._update_contacts_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            identifier_field=identifier_field,
+            custom_field_reference=custom_field_reference,
+            field_actions=field_actions,
+            contact_create_request=contact_create_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '404': "ApiError",
+            '500': "ApiError",
+        }
+        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 update_contacts_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        identifier_field: Annotated[Optional[StrictStr], Field(description="Which field to use to identify whether the resource exists or not")] = None,
+        custom_field_reference: Annotated[Optional[StrictStr], Field(description="Which custom field to use to identify whether the resource exists or not")] = None,
+        field_actions: Annotated[Optional[Dict[str, Dict[str, StrictStr]]], Field(description="The list of actions for specific fields.")] = None,
+        contact_create_request: Optional[ContactCreateRequest] = None,
+        _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[Contact]:
+        """Update or create a contact (upsert)
+
+        Requires the CONTACT.CREATE or CONTACT.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param identifier_field: Which field to use to identify whether the resource exists or not
+        :type identifier_field: str
+        :param custom_field_reference: Which custom field to use to identify whether the resource exists or not
+        :type custom_field_reference: str
+        :param field_actions: The list of actions for specific fields.
+        :type field_actions: Dict[str, str]
+        :param contact_create_request:
+        :type contact_create_request: ContactCreateRequest
+        :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._update_contacts_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            identifier_field=identifier_field,
+            custom_field_reference=custom_field_reference,
+            field_actions=field_actions,
+            contact_create_request=contact_create_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '404': "ApiError",
+            '500': "ApiError",
+        }
+        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 update_contacts_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        identifier_field: Annotated[Optional[StrictStr], Field(description="Which field to use to identify whether the resource exists or not")] = None,
+        custom_field_reference: Annotated[Optional[StrictStr], Field(description="Which custom field to use to identify whether the resource exists or not")] = None,
+        field_actions: Annotated[Optional[Dict[str, Dict[str, StrictStr]]], Field(description="The list of actions for specific fields.")] = None,
+        contact_create_request: Optional[ContactCreateRequest] = None,
+        _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:
+        """Update or create a contact (upsert)
+
+        Requires the CONTACT.CREATE or CONTACT.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param identifier_field: Which field to use to identify whether the resource exists or not
+        :type identifier_field: str
+        :param custom_field_reference: Which custom field to use to identify whether the resource exists or not
+        :type custom_field_reference: str
+        :param field_actions: The list of actions for specific fields.
+        :type field_actions: Dict[str, str]
+        :param contact_create_request:
+        :type contact_create_request: ContactCreateRequest
+        :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._update_contacts_serialize(
+            version=version,
+            x_platform_id=x_platform_id,
+            identifier_field=identifier_field,
+            custom_field_reference=custom_field_reference,
+            field_actions=field_actions,
+            contact_create_request=contact_create_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '404': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _update_contacts_serialize(
+        self,
+        version,
+        x_platform_id,
+        identifier_field,
+        custom_field_reference,
+        field_actions,
+        contact_create_request,
+        _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
+        if version is not None:
+            _path_params['version'] = version
+        # process the query parameters
+        if identifier_field is not None:
+            
+            _query_params.append(('identifier_field', identifier_field))
+            
+        if custom_field_reference is not None:
+            
+            _query_params.append(('custom_field_reference', custom_field_reference))
+            
+        if field_actions is not None:
+            
+            _query_params.append(('field_actions', field_actions))
+            
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # process the form parameters
+        # process the body parameter
+        if contact_create_request is not None:
+            _body_params = contact_create_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    '*/*'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='PUT',
+            resource_path='/v{version}/contacts',
+            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
+        )
+
+
+
+
+    @validate_call
+    def update_contacts_by_resource_id(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        contact_update_request: Optional[ContactUpdateRequest] = None,
+        _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,
+    ) -> Contact:
+        """Update a contact
+
+        Requires the CONTACT.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id: The ID of the resource to be requested. (required)
+        :type resource_id: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param contact_update_request:
+        :type contact_update_request: ContactUpdateRequest
+        :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._update_contacts_by_resource_id_serialize(
+            version=version,
+            resource_id=resource_id,
+            x_platform_id=x_platform_id,
+            contact_update_request=contact_update_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        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 update_contacts_by_resource_id_with_http_info(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        contact_update_request: Optional[ContactUpdateRequest] = None,
+        _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[Contact]:
+        """Update a contact
+
+        Requires the CONTACT.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id: The ID of the resource to be requested. (required)
+        :type resource_id: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param contact_update_request:
+        :type contact_update_request: ContactUpdateRequest
+        :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._update_contacts_by_resource_id_serialize(
+            version=version,
+            resource_id=resource_id,
+            x_platform_id=x_platform_id,
+            contact_update_request=contact_update_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        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 update_contacts_by_resource_id_without_preload_content(
+        self,
+        version: Annotated[StrictStr, Field(description="version")],
+        resource_id: Annotated[StrictStr, Field(description="The ID of the resource to be requested.")],
+        x_platform_id: Annotated[Optional[StrictStr], Field(description="Platform ID.")] = None,
+        contact_update_request: Optional[ContactUpdateRequest] = None,
+        _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:
+        """Update a contact
+
+        Requires the CONTACT.UPDATE permission.
+
+        :param version: version (required)
+        :type version: str
+        :param resource_id: The ID of the resource to be requested. (required)
+        :type resource_id: str
+        :param x_platform_id: Platform ID.
+        :type x_platform_id: str
+        :param contact_update_request:
+        :type contact_update_request: ContactUpdateRequest
+        :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._update_contacts_by_resource_id_serialize(
+            version=version,
+            resource_id=resource_id,
+            x_platform_id=x_platform_id,
+            contact_update_request=contact_update_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Contact",
+            '400': "ApiError",
+            '401': "ApiError",
+            '403': "ApiError",
+            '500': "ApiError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _update_contacts_by_resource_id_serialize(
+        self,
+        version,
+        resource_id,
+        x_platform_id,
+        contact_update_request,
+        _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
+        if version is not None:
+            _path_params['version'] = version
+        if resource_id is not None:
+            _path_params['resourceId'] = resource_id
+        # process the query parameters
+        # process the header parameters
+        if x_platform_id is not None:
+            _header_params['x-platform-id'] = x_platform_id
+        # process the form parameters
+        # process the body parameter
+        if contact_update_request is not None:
+            _body_params = contact_update_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    '*/*'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'JWT-Authentication', 
+            'API-Key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='PATCH',
+            resource_path='/v{version}/contacts/{resourceId}',
+            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
+        )
+
+