tremendous-python 5.5.0__tar.gz → 5.6.0__tar.gz

{tremendous_python-5.5.0/tremendous_python.egg-info → tremendous_python-5.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tremendous-python
-Version: 5.5.0
+Version: 5.6.0
 Summary: Python API client for Tremendous
 Home-page: https://github.com/tremendous-rewards/tremendous-python
 Author: Tremendous

{tremendous_python-5.5.0 → tremendous_python-5.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tremendous"
-version = "5.5.0"
+version = "5.6.0"
 long_description="Python API client for Tremendous"
 description = "Python API client for Tremendous"
 authors = ["API Support <developers@tremendous.com>"]

{tremendous_python-5.5.0 → tremendous_python-5.6.0}/tremendous/__init__.py

@@ -58,6 +58,10 @@ from tremendous.models.create_connected_organization_member_session200_response
 from tremendous.models.create_connected_organization_member_session200_response_connected_organization_member_session import CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession
 from tremendous.models.create_connected_organization_member_session_request import CreateConnectedOrganizationMemberSessionRequest
 from tremendous.models.create_connected_organization_request import CreateConnectedOrganizationRequest
+from tremendous.models.create_field import CreateField
+from tremendous.models.create_field200_response import CreateField200Response
+from tremendous.models.create_field_request import CreateFieldRequest
+from tremendous.models.create_field_request_data import CreateFieldRequestData
 from tremendous.models.create_invoice200_response import CreateInvoice200Response
 from tremendous.models.create_invoice_request import CreateInvoiceRequest
 from tremendous.models.create_member import CreateMember
@@ -154,6 +158,7 @@ from tremendous.models.list_connected_organizations200_response_connected_organi
 from tremendous.models.list_connected_organizations200_response_connected_organizations_inner_organization import ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
 from tremendous.models.list_fields200_response import ListFields200Response
 from tremendous.models.list_fields200_response_fields_inner import ListFields200ResponseFieldsInner
+from tremendous.models.list_fields200_response_fields_inner_data import ListFields200ResponseFieldsInnerData
 from tremendous.models.list_forex_response import ListForexResponse
 from tremendous.models.list_fraud_reviews200_response import ListFraudReviews200Response
 from tremendous.models.list_fraud_reviews200_response_fraud_reviews_inner import ListFraudReviews200ResponseFraudReviewsInner

{tremendous_python-5.5.0 → tremendous_python-5.6.0}/tremendous/api/tremendous_api.py

@@ -29,6 +29,8 @@ from tremendous.models.create_connected_organization_member_request import Creat
 from tremendous.models.create_connected_organization_member_session200_response import CreateConnectedOrganizationMemberSession200Response
 from tremendous.models.create_connected_organization_member_session_request import CreateConnectedOrganizationMemberSessionRequest
 from tremendous.models.create_connected_organization_request import CreateConnectedOrganizationRequest
+from tremendous.models.create_field200_response import CreateField200Response
+from tremendous.models.create_field_request import CreateFieldRequest
 from tremendous.models.create_invoice200_response import CreateInvoice200Response
 from tremendous.models.create_invoice_request import CreateInvoiceRequest
 from tremendous.models.create_member200_response import CreateMember200Response
@@ -2342,6 +2344,292 @@ class TremendousApi:
 
 
 
+    @validate_call
+    def create_field(
+        self,
+        create_field_request: Annotated[CreateFieldRequest, Field(description="Field details")],
+        _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,
+    ) -> CreateField200Response:
+        """Create field
+
+        Create a custom field to be associated with rewards. Custom fields can be used for reporting and analytics purposes. 
+
+        :param create_field_request: Field details (required)
+        :type create_field_request: CreateFieldRequest
+        :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._create_field_serialize(
+            create_field_request=create_field_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CreateField200Response",
+            '401': "ListRewards401Response",
+            '422': "ResendReward422Response",
+            '429': "ListRewards429Response",
+            '500': "ListRewards401Response",
+        }
+        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 create_field_with_http_info(
+        self,
+        create_field_request: Annotated[CreateFieldRequest, Field(description="Field details")],
+        _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[CreateField200Response]:
+        """Create field
+
+        Create a custom field to be associated with rewards. Custom fields can be used for reporting and analytics purposes. 
+
+        :param create_field_request: Field details (required)
+        :type create_field_request: CreateFieldRequest
+        :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._create_field_serialize(
+            create_field_request=create_field_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CreateField200Response",
+            '401': "ListRewards401Response",
+            '422': "ResendReward422Response",
+            '429': "ListRewards429Response",
+            '500': "ListRewards401Response",
+        }
+        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 create_field_without_preload_content(
+        self,
+        create_field_request: Annotated[CreateFieldRequest, Field(description="Field details")],
+        _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 field
+
+        Create a custom field to be associated with rewards. Custom fields can be used for reporting and analytics purposes. 
+
+        :param create_field_request: Field details (required)
+        :type create_field_request: CreateFieldRequest
+        :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._create_field_serialize(
+            create_field_request=create_field_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CreateField200Response",
+            '401': "ListRewards401Response",
+            '422': "ResendReward422Response",
+            '429': "ListRewards429Response",
+            '500': "ListRewards401Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _create_field_serialize(
+        self,
+        create_field_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
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if create_field_request is not None:
+            _body_params = create_field_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] = [
+            'BearerApiKey'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/fields',
+            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 create_invoice(
         self,

{tremendous_python-5.5.0 → tremendous_python-5.6.0}/tremendous/models/__init__.py

@@ -41,6 +41,10 @@ from tremendous.models.create_connected_organization_member_session200_response
 from tremendous.models.create_connected_organization_member_session200_response_connected_organization_member_session import CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession
 from tremendous.models.create_connected_organization_member_session_request import CreateConnectedOrganizationMemberSessionRequest
 from tremendous.models.create_connected_organization_request import CreateConnectedOrganizationRequest
+from tremendous.models.create_field import CreateField
+from tremendous.models.create_field200_response import CreateField200Response
+from tremendous.models.create_field_request import CreateFieldRequest
+from tremendous.models.create_field_request_data import CreateFieldRequestData
 from tremendous.models.create_invoice200_response import CreateInvoice200Response
 from tremendous.models.create_invoice_request import CreateInvoiceRequest
 from tremendous.models.create_member import CreateMember
@@ -137,6 +141,7 @@ from tremendous.models.list_connected_organizations200_response_connected_organi
 from tremendous.models.list_connected_organizations200_response_connected_organizations_inner_organization import ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
 from tremendous.models.list_fields200_response import ListFields200Response
 from tremendous.models.list_fields200_response_fields_inner import ListFields200ResponseFieldsInner
+from tremendous.models.list_fields200_response_fields_inner_data import ListFields200ResponseFieldsInnerData
 from tremendous.models.list_forex_response import ListForexResponse
 from tremendous.models.list_fraud_reviews200_response import ListFraudReviews200Response
 from tremendous.models.list_fraud_reviews200_response_fraud_reviews_inner import ListFraudReviews200ResponseFraudReviewsInner

tremendous_python-5.6.0/tremendous/models/create_field.py

@@ -0,0 +1,107 @@
+# coding: utf-8
+
+"""
+    API Endpoints
+
+    Deliver monetary rewards and incentives to employees, customers, survey participants, and more through the Tremendous API. For organizational tasks, like managing your organization and its members within Tremendous, please see the Tremendous Organizational API.
+
+    The version of the OpenAPI document: 2
+    Contact: developers@tremendous.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 tremendous.models.create_field_request_data import CreateFieldRequestData
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateField(BaseModel):
+    """
+    CreateField
+    """ # noqa: E501
+    display_name: StrictStr = Field(description="A human-readable name for the field. Can contain letters, numbers, spaces, and underscores. The field's `label` (a reference name used in API requests) will be automatically derived from this value. ")
+    data_type: StrictStr = Field(description="Type of the values of the field  <table>   <thead>     <tr>       <th>Type</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>       <td><code>Checkbox</code></td>       <td>A boolean value (true/false)</td>     </tr>     <tr>       <td><code>Currency</code></td>       <td>A monetary value</td>     </tr>     <tr>       <td><code>Date</code></td>       <td>A date value</td>     </tr>     <tr>       <td><code>Dropdown</code></td>       <td>A single selection from predefined options (see <code>data.options</code>)</td>     </tr>     <tr>       <td><code>Email</code></td>       <td>An email address</td>     </tr>     <tr>       <td><code>List</code></td>       <td>Multiple selections from predefined options (see <code>data.options</code>)</td>     </tr>     <tr>       <td><code>Number</code></td>       <td>A numeric value</td>     </tr>     <tr>       <td><code>Phone</code></td>       <td>A phone number</td>     </tr>     <tr>       <td><code>Text</code></td>       <td>A single-line text value</td>     </tr>     <tr>       <td><code>TextArea</code></td>       <td>A multi-line text value</td>     </tr>   </tbody> </table> ")
+    data: Optional[CreateFieldRequestData] = None
+    required: Optional[StrictBool] = Field(default=False, description="Is this field required (true) or optional (false). Defaults to false.")
+    description: Optional[StrictStr] = Field(default=None, description="A description of the field's purpose")
+    __properties: ClassVar[List[str]] = ["display_name", "data_type", "data", "required", "description"]
+
+    @field_validator('data_type')
+    def data_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['Checkbox', 'Currency', 'Date', 'Dropdown', 'Email', 'List', 'Number', 'Phone', 'Text', 'TextArea']):
+            raise ValueError("must be one of enum values ('Checkbox', 'Currency', 'Date', 'Dropdown', 'Email', 'List', 'Number', 'Phone', 'Text', 'TextArea')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreateField 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 CreateField from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "display_name": obj.get("display_name"),
+            "data_type": obj.get("data_type"),
+            "data": CreateFieldRequestData.from_dict(obj["data"]) if obj.get("data") is not None else None,
+            "required": obj.get("required") if obj.get("required") is not None else False,
+            "description": obj.get("description")
+        })
+        return _obj
+
+

tremendous_python-5.6.0/tremendous/models/create_field200_response.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    API Endpoints
+
+    Deliver monetary rewards and incentives to employees, customers, survey participants, and more through the Tremendous API. For organizational tasks, like managing your organization and its members within Tremendous, please see the Tremendous Organizational API.
+
+    The version of the OpenAPI document: 2
+    Contact: developers@tremendous.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
+from typing import Any, ClassVar, Dict, List
+from tremendous.models.list_fields200_response_fields_inner import ListFields200ResponseFieldsInner
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateField200Response(BaseModel):
+    """
+    CreateField200Response
+    """ # noqa: E501
+    var_field: ListFields200ResponseFieldsInner = Field(alias="field")
+    __properties: ClassVar[List[str]] = ["field"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreateField200Response 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 var_field
+        if self.var_field:
+            _dict['field'] = self.var_field.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateField200Response from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "field": ListFields200ResponseFieldsInner.from_dict(obj["field"]) if obj.get("field") is not None else None
+        })
+        return _obj
+
+

tremendous_python-5.6.0/tremendous/models/create_field_request.py

@@ -0,0 +1,107 @@
+# coding: utf-8
+
+"""
+    API Endpoints
+
+    Deliver monetary rewards and incentives to employees, customers, survey participants, and more through the Tremendous API. For organizational tasks, like managing your organization and its members within Tremendous, please see the Tremendous Organizational API.
+
+    The version of the OpenAPI document: 2
+    Contact: developers@tremendous.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 tremendous.models.create_field_request_data import CreateFieldRequestData
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateFieldRequest(BaseModel):
+    """
+    CreateFieldRequest
+    """ # noqa: E501
+    display_name: StrictStr = Field(description="A human-readable name for the field. Can contain letters, numbers, spaces, and underscores. The field's `label` (a reference name used in API requests) will be automatically derived from this value. ")
+    data_type: StrictStr = Field(description="Type of the values of the field  <table>   <thead>     <tr>       <th>Type</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>       <td><code>Checkbox</code></td>       <td>A boolean value (true/false)</td>     </tr>     <tr>       <td><code>Currency</code></td>       <td>A monetary value</td>     </tr>     <tr>       <td><code>Date</code></td>       <td>A date value</td>     </tr>     <tr>       <td><code>Dropdown</code></td>       <td>A single selection from predefined options (see <code>data.options</code>)</td>     </tr>     <tr>       <td><code>Email</code></td>       <td>An email address</td>     </tr>     <tr>       <td><code>List</code></td>       <td>Multiple selections from predefined options (see <code>data.options</code>)</td>     </tr>     <tr>       <td><code>Number</code></td>       <td>A numeric value</td>     </tr>     <tr>       <td><code>Phone</code></td>       <td>A phone number</td>     </tr>     <tr>       <td><code>Text</code></td>       <td>A single-line text value</td>     </tr>     <tr>       <td><code>TextArea</code></td>       <td>A multi-line text value</td>     </tr>   </tbody> </table> ")
+    data: Optional[CreateFieldRequestData] = None
+    required: Optional[StrictBool] = Field(default=False, description="Is this field required (true) or optional (false). Defaults to false.")
+    description: Optional[StrictStr] = Field(default=None, description="A description of the field's purpose")
+    __properties: ClassVar[List[str]] = ["display_name", "data_type", "data", "required", "description"]
+
+    @field_validator('data_type')
+    def data_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['Checkbox', 'Currency', 'Date', 'Dropdown', 'Email', 'List', 'Number', 'Phone', 'Text', 'TextArea']):
+            raise ValueError("must be one of enum values ('Checkbox', 'Currency', 'Date', 'Dropdown', 'Email', 'List', 'Number', 'Phone', 'Text', 'TextArea')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreateFieldRequest 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 CreateFieldRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "display_name": obj.get("display_name"),
+            "data_type": obj.get("data_type"),
+            "data": CreateFieldRequestData.from_dict(obj["data"]) if obj.get("data") is not None else None,
+            "required": obj.get("required") if obj.get("required") is not None else False,
+            "description": obj.get("description")
+        })
+        return _obj
+
+