tremendous-python 5.18.0__tar.gz → 5.19.0__tar.gz

{tremendous_python-5.18.0 → tremendous_python-5.19.0}/PKG-INFO

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

{tremendous_python-5.18.0 → tremendous_python-5.19.0}/pyproject.toml

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

{tremendous_python-5.18.0 → tremendous_python-5.19.0}/tremendous/__init__.py

@@ -58,7 +58,7 @@ 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_connected_organization_request_kyb import CreateConnectedOrganizationRequestKyb
+from tremendous.models.create_connected_organization_request_kyb_prefill import CreateConnectedOrganizationRequestKybPrefill
 from tremendous.models.create_field import CreateField
 from tremendous.models.create_field200_response import CreateField200Response
 from tremendous.models.create_field_request import CreateFieldRequest
@@ -159,8 +159,6 @@ from tremendous.models.list_connected_organization_members200_response_connected
 from tremendous.models.list_connected_organizations200_response import ListConnectedOrganizations200Response
 from tremendous.models.list_connected_organizations200_response_connected_organizations_inner import ListConnectedOrganizations200ResponseConnectedOrganizationsInner
 from tremendous.models.list_connected_organizations200_response_connected_organizations_inner_organization import ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
-from tremendous.models.list_connected_organizations200_response_connected_organizations_inner_prefilled_kyb_details import ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
-from tremendous.models.list_connected_organizations200_response_connected_organizations_inner_prefilled_kyb_details_address import ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
 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

{tremendous_python-5.18.0 → tremendous_python-5.19.0}/tremendous/api/tremendous_api.py

@@ -1490,7 +1490,7 @@ class TremendousApi:
     ) -> CreateConnectedOrganization200Response:
         """Create connected organization
 
-        Create a connected organization.  Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client's onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.  The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only. 
+        Create a connected organization.  Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client's onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. 
 
         :param create_connected_organization_request: Connected organization to create (required)
         :type create_connected_organization_request: CreateConnectedOrganizationRequest
@@ -1561,7 +1561,7 @@ class TremendousApi:
     ) -> ApiResponse[CreateConnectedOrganization200Response]:
         """Create connected organization
 
-        Create a connected organization.  Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client's onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.  The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only. 
+        Create a connected organization.  Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client's onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. 
 
         :param create_connected_organization_request: Connected organization to create (required)
         :type create_connected_organization_request: CreateConnectedOrganizationRequest
@@ -1632,7 +1632,7 @@ class TremendousApi:
     ) -> RESTResponseType:
         """Create connected organization
 
-        Create a connected organization.  Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client's onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.  The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only. 
+        Create a connected organization.  Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client's onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. 
 
         :param create_connected_organization_request: Connected organization to create (required)
         :type create_connected_organization_request: CreateConnectedOrganizationRequest

{tremendous_python-5.18.0 → tremendous_python-5.19.0}/tremendous/models/__init__.py

@@ -41,7 +41,7 @@ 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_connected_organization_request_kyb import CreateConnectedOrganizationRequestKyb
+from tremendous.models.create_connected_organization_request_kyb_prefill import CreateConnectedOrganizationRequestKybPrefill
 from tremendous.models.create_field import CreateField
 from tremendous.models.create_field200_response import CreateField200Response
 from tremendous.models.create_field_request import CreateFieldRequest
@@ -142,8 +142,6 @@ from tremendous.models.list_connected_organization_members200_response_connected
 from tremendous.models.list_connected_organizations200_response import ListConnectedOrganizations200Response
 from tremendous.models.list_connected_organizations200_response_connected_organizations_inner import ListConnectedOrganizations200ResponseConnectedOrganizationsInner
 from tremendous.models.list_connected_organizations200_response_connected_organizations_inner_organization import ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
-from tremendous.models.list_connected_organizations200_response_connected_organizations_inner_prefilled_kyb_details import ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
-from tremendous.models.list_connected_organizations200_response_connected_organizations_inner_prefilled_kyb_details_address import ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
 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

{tremendous_python-5.18.0 → tremendous_python-5.19.0}/tremendous/models/connected_organization.py

@@ -23,7 +23,6 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
 from tremendous.models.connected_organization_organization import ConnectedOrganizationOrganization
-from tremendous.models.list_connected_organizations200_response_connected_organizations_inner_prefilled_kyb_details import ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -35,8 +34,7 @@ class ConnectedOrganization(BaseModel):
     client_id: StrictStr = Field(description="Client ID of the OAuth app that is to be used by the platform once the integration is complete.")
     created_at: datetime = Field(description="Timestamp of when the connected organization was created.")
     organization: Optional[ConnectedOrganizationOrganization] = None
-    prefilled_kyb_details: Optional[ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails] = None
-    __properties: ClassVar[List[str]] = ["id", "client_id", "created_at", "organization", "prefilled_kyb_details"]
+    __properties: ClassVar[List[str]] = ["id", "client_id", "created_at", "organization"]
 
     @field_validator('id')
     def id_validate_regular_expression(cls, value):
@@ -89,19 +87,11 @@ class ConnectedOrganization(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of organization
         if self.organization:
             _dict['organization'] = self.organization.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of prefilled_kyb_details
-        if self.prefilled_kyb_details:
-            _dict['prefilled_kyb_details'] = self.prefilled_kyb_details.to_dict()
         # set to None if organization (nullable) is None
         # and model_fields_set contains the field
         if self.organization is None and "organization" in self.model_fields_set:
             _dict['organization'] = None
 
-        # set to None if prefilled_kyb_details (nullable) is None
-        # and model_fields_set contains the field
-        if self.prefilled_kyb_details is None and "prefilled_kyb_details" in self.model_fields_set:
-            _dict['prefilled_kyb_details'] = None
-
         return _dict
 
     @classmethod
@@ -117,8 +107,7 @@ class ConnectedOrganization(BaseModel):
             "id": obj.get("id"),
             "client_id": obj.get("client_id"),
             "created_at": obj.get("created_at"),
-            "organization": ConnectedOrganizationOrganization.from_dict(obj["organization"]) if obj.get("organization") is not None else None,
-            "prefilled_kyb_details": ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails.from_dict(obj["prefilled_kyb_details"]) if obj.get("prefilled_kyb_details") is not None else None
+            "organization": ConnectedOrganizationOrganization.from_dict(obj["organization"]) if obj.get("organization") is not None else None
         })
         return _obj
 

{tremendous_python-5.18.0 → tremendous_python-5.19.0}/tremendous/models/create_connected_organization_request.py

@@ -20,7 +20,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from tremendous.models.create_connected_organization_request_kyb import CreateConnectedOrganizationRequestKyb
+from tremendous.models.create_connected_organization_request_kyb_prefill import CreateConnectedOrganizationRequestKybPrefill
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -29,8 +29,8 @@ class CreateConnectedOrganizationRequest(BaseModel):
     CreateConnectedOrganizationRequest
     """ # noqa: E501
     client_id: StrictStr = Field(description="The client ID of the OAuth application.")
-    kyb: Optional[CreateConnectedOrganizationRequestKyb] = None
-    __properties: ClassVar[List[str]] = ["client_id", "kyb"]
+    kyb_prefill: Optional[CreateConnectedOrganizationRequestKybPrefill] = None
+    __properties: ClassVar[List[str]] = ["client_id", "kyb_prefill"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -71,9 +71,9 @@ class CreateConnectedOrganizationRequest(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of kyb
-        if self.kyb:
-            _dict['kyb'] = self.kyb.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of kyb_prefill
+        if self.kyb_prefill:
+            _dict['kyb_prefill'] = self.kyb_prefill.to_dict()
         return _dict
 
     @classmethod
@@ -87,7 +87,7 @@ class CreateConnectedOrganizationRequest(BaseModel):
 
         _obj = cls.model_validate({
             "client_id": obj.get("client_id"),
-            "kyb": CreateConnectedOrganizationRequestKyb.from_dict(obj["kyb"]) if obj.get("kyb") is not None else None
+            "kyb_prefill": CreateConnectedOrganizationRequestKybPrefill.from_dict(obj["kyb_prefill"]) if obj.get("kyb_prefill") is not None else None
         })
         return _obj
 

tremendous_python-5.19.0/tremendous/models/create_connected_organization_request_kyb_prefill.py

@@ -0,0 +1,106 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateConnectedOrganizationRequestKybPrefill(BaseModel):
+    """
+    Optional KYB details to forward for the end client. When provided, these values prefill the end client's onboarding form. Every field is optional. 
+    """ # noqa: E501
+    company_name: Optional[StrictStr] = Field(default=None, description="The registered legal name of the company.")
+    doing_business_as: Optional[StrictStr] = Field(default=None, description="The trade name (DBA) the company operates under, if different from its legal name.")
+    company_structure: Optional[StrictStr] = Field(default=None, description="The company's legal entity type. Free-form text; any value is accepted. Common values include `Sole proprietorship`, `Corporation (Inc)`, `Limited liability company (LLC)`, `Limited liability partnership (LLP)`, `Public limited company (PLC)`, and `Private limited company (LTD)`. ")
+    company_registration_number: Optional[StrictStr] = Field(default=None, description="The company's tax ID or registration number.")
+    country_code: Optional[StrictStr] = Field(default=None, description="The ISO 3166-1 alpha-2 country code of the company. Must be a supported country.")
+    website_url: Optional[StrictStr] = Field(default=None, description="The company's website URL. Must be a well-formed URL.")
+    address_1: Optional[StrictStr] = Field(default=None, description="The company's street address.")
+    city: Optional[StrictStr] = Field(default=None, description="The company's city.")
+    state: Optional[StrictStr] = Field(default=None, description="The company's state or province.")
+    postal_code: Optional[StrictStr] = Field(default=None, description="The company's ZIP or postal code.")
+    __properties: ClassVar[List[str]] = ["company_name", "doing_business_as", "company_structure", "company_registration_number", "country_code", "website_url", "address_1", "city", "state", "postal_code"]
+
+    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 CreateConnectedOrganizationRequestKybPrefill from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateConnectedOrganizationRequestKybPrefill from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "company_name": obj.get("company_name"),
+            "doing_business_as": obj.get("doing_business_as"),
+            "company_structure": obj.get("company_structure"),
+            "company_registration_number": obj.get("company_registration_number"),
+            "country_code": obj.get("country_code"),
+            "website_url": obj.get("website_url"),
+            "address_1": obj.get("address_1"),
+            "city": obj.get("city"),
+            "state": obj.get("state"),
+            "postal_code": obj.get("postal_code")
+        })
+        return _obj
+
+

{tremendous_python-5.18.0 → tremendous_python-5.19.0}/tremendous/models/list_connected_organizations200_response_connected_organizations_inner.py

@@ -23,7 +23,6 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
 from tremendous.models.list_connected_organizations200_response_connected_organizations_inner_organization import ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization
-from tremendous.models.list_connected_organizations200_response_connected_organizations_inner_prefilled_kyb_details import ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -35,8 +34,7 @@ class ListConnectedOrganizations200ResponseConnectedOrganizationsInner(BaseModel
     client_id: StrictStr = Field(description="Client ID of the OAuth app that is to be used by the platform once the integration is complete.")
     created_at: datetime = Field(description="Timestamp of when the connected organization was created.")
     organization: Optional[ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization] = None
-    prefilled_kyb_details: Optional[ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails] = None
-    __properties: ClassVar[List[str]] = ["id", "client_id", "created_at", "organization", "prefilled_kyb_details"]
+    __properties: ClassVar[List[str]] = ["id", "client_id", "created_at", "organization"]
 
     @field_validator('id')
     def id_validate_regular_expression(cls, value):
@@ -87,19 +85,11 @@ class ListConnectedOrganizations200ResponseConnectedOrganizationsInner(BaseModel
         # override the default output from pydantic by calling `to_dict()` of organization
         if self.organization:
             _dict['organization'] = self.organization.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of prefilled_kyb_details
-        if self.prefilled_kyb_details:
-            _dict['prefilled_kyb_details'] = self.prefilled_kyb_details.to_dict()
         # set to None if organization (nullable) is None
         # and model_fields_set contains the field
         if self.organization is None and "organization" in self.model_fields_set:
             _dict['organization'] = None
 
-        # set to None if prefilled_kyb_details (nullable) is None
-        # and model_fields_set contains the field
-        if self.prefilled_kyb_details is None and "prefilled_kyb_details" in self.model_fields_set:
-            _dict['prefilled_kyb_details'] = None
-
         return _dict
 
     @classmethod
@@ -115,8 +105,7 @@ class ListConnectedOrganizations200ResponseConnectedOrganizationsInner(BaseModel
             "id": obj.get("id"),
             "client_id": obj.get("client_id"),
             "created_at": obj.get("created_at"),
-            "organization": ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization.from_dict(obj["organization"]) if obj.get("organization") is not None else None,
-            "prefilled_kyb_details": ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails.from_dict(obj["prefilled_kyb_details"]) if obj.get("prefilled_kyb_details") is not None else None
+            "organization": ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization.from_dict(obj["organization"]) if obj.get("organization") is not None else None
         })
         return _obj
 

tremendous_python-5.19.0/tremendous/version.py

@@ -0,0 +1 @@
+__version__ = '5.19.0'

{tremendous_python-5.18.0 → tremendous_python-5.19.0}/tremendous_python.egg-info/PKG-INFO

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

{tremendous_python-5.18.0 → tremendous_python-5.19.0}/tremendous_python.egg-info/SOURCES.txt

@@ -48,6 +48,7 @@ tremendous/models/create_connected_organization_member_session200_response_conne
 tremendous/models/create_connected_organization_member_session_request.py
 tremendous/models/create_connected_organization_request.py
 tremendous/models/create_connected_organization_request_kyb.py
+tremendous/models/create_connected_organization_request_kyb_prefill.py
 tremendous/models/create_field.py
 tremendous/models/create_field200_response.py
 tremendous/models/create_field_request.py

tremendous_python-5.18.0/tremendous/version.py

@@ -1 +0,0 @@
-__version__ = '5.18.0'