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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tremendous-python
-Version: 5.17.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.19.0/pyproject.toml

@@ -0,0 +1,30 @@
+[tool.poetry]
+name = "tremendous"
+version = "5.19.0"
+long_description="Python API client for Tremendous"
+description = "Python API client for Tremendous"
+authors = ["API Support <developers@tremendous.com>"]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/tremendous-rewards/tremendous-python"
+keywords = ["Api", "Gift cards", "Rewards", "Incentives", "Tremendous"]
+include = ["tremendous/py.typed"]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+
+urllib3 = ">= 2.1.0"
+python-dateutil = ">=2.8.2"
+pydantic = ">=2"
+typing-extensions = ">=4.7.1"
+
+[tool.poetry.dev-dependencies]
+pytest = ">=7.2.1"
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"

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

@@ -58,6 +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_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
@@ -106,6 +107,7 @@ from tremendous.models.fraud_config_ip import FraudConfigIP
 from tremendous.models.fraud_config_redeemed_rewards_amount import FraudConfigRedeemedRewardsAmount
 from tremendous.models.fraud_config_redeemed_rewards_count import FraudConfigRedeemedRewardsCount
 from tremendous.models.fraud_config_review_email import FraudConfigReviewEmail
+from tremendous.models.fraud_config_review_vpn import FraudConfigReviewVpn
 from tremendous.models.fraud_generic_response import FraudGenericResponse
 from tremendous.models.fraud_review import FraudReview
 from tremendous.models.fraud_review_base import FraudReviewBase
@@ -234,6 +236,7 @@ from tremendous.models.review_ip import ReviewIp
 from tremendous.models.review_ip1 import ReviewIp1
 from tremendous.models.review_redeemed_rewards_amount import ReviewRedeemedRewardsAmount
 from tremendous.models.review_redeemed_rewards_count import ReviewRedeemedRewardsCount
+from tremendous.models.review_vpn import ReviewVpn
 from tremendous.models.reward import Reward
 from tremendous.models.reward_base import RewardBase
 from tremendous.models.reward_base_custom_fields_inner import RewardBaseCustomFieldsInner

{tremendous_python-5.17.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. 
+        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. 
+        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. 
+        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
@@ -6573,7 +6573,7 @@ class TremendousApi:
     def fraud_rule(
         self,
         rule_type: Annotated[StrictStr, Field(description="The rule type to create or update.")],
-        fraud_rule_request: Annotated[Optional[FraudRuleRequest], Field(description="Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.")] = None,
+        fraud_rule_request: Annotated[Optional[FraudRuleRequest], Field(description="Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -6593,7 +6593,7 @@ class TremendousApi:
 
         :param rule_type: The rule type to create or update. (required)
         :type rule_type: str
-        :param fraud_rule_request: Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.
+        :param fraud_rule_request: Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged. 
         :type fraud_rule_request: FraudRuleRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -6650,7 +6650,7 @@ class TremendousApi:
     def fraud_rule_with_http_info(
         self,
         rule_type: Annotated[StrictStr, Field(description="The rule type to create or update.")],
-        fraud_rule_request: Annotated[Optional[FraudRuleRequest], Field(description="Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.")] = None,
+        fraud_rule_request: Annotated[Optional[FraudRuleRequest], Field(description="Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -6670,7 +6670,7 @@ class TremendousApi:
 
         :param rule_type: The rule type to create or update. (required)
         :type rule_type: str
-        :param fraud_rule_request: Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.
+        :param fraud_rule_request: Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged. 
         :type fraud_rule_request: FraudRuleRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -6727,7 +6727,7 @@ class TremendousApi:
     def fraud_rule_without_preload_content(
         self,
         rule_type: Annotated[StrictStr, Field(description="The rule type to create or update.")],
-        fraud_rule_request: Annotated[Optional[FraudRuleRequest], Field(description="Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.")] = None,
+        fraud_rule_request: Annotated[Optional[FraudRuleRequest], Field(description="Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged. ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -6747,7 +6747,7 @@ class TremendousApi:
 
         :param rule_type: The rule type to create or update. (required)
         :type rule_type: str
-        :param fraud_rule_request: Rules `review_multiple_emails`, `review_vpn`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body.
+        :param fraud_rule_request: Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged. 
         :type fraud_rule_request: FraudRuleRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

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

@@ -41,6 +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_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
@@ -89,6 +90,7 @@ from tremendous.models.fraud_config_ip import FraudConfigIP
 from tremendous.models.fraud_config_redeemed_rewards_amount import FraudConfigRedeemedRewardsAmount
 from tremendous.models.fraud_config_redeemed_rewards_count import FraudConfigRedeemedRewardsCount
 from tremendous.models.fraud_config_review_email import FraudConfigReviewEmail
+from tremendous.models.fraud_config_review_vpn import FraudConfigReviewVpn
 from tremendous.models.fraud_generic_response import FraudGenericResponse
 from tremendous.models.fraud_review import FraudReview
 from tremendous.models.fraud_review_base import FraudReviewBase
@@ -217,6 +219,7 @@ from tremendous.models.review_ip import ReviewIp
 from tremendous.models.review_ip1 import ReviewIp1
 from tremendous.models.review_redeemed_rewards_amount import ReviewRedeemedRewardsAmount
 from tremendous.models.review_redeemed_rewards_count import ReviewRedeemedRewardsCount
+from tremendous.models.review_vpn import ReviewVpn
 from tremendous.models.reward import Reward
 from tremendous.models.reward_base import RewardBase
 from tremendous.models.reward_base_custom_fields_inner import RewardBaseCustomFieldsInner

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

@@ -19,7 +19,8 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
+from tremendous.models.create_connected_organization_request_kyb_prefill import CreateConnectedOrganizationRequestKybPrefill
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -28,7 +29,8 @@ class CreateConnectedOrganizationRequest(BaseModel):
     CreateConnectedOrganizationRequest
     """ # noqa: E501
     client_id: StrictStr = Field(description="The client ID of the OAuth application.")
-    __properties: ClassVar[List[str]] = ["client_id"]
+    kyb_prefill: Optional[CreateConnectedOrganizationRequestKybPrefill] = None
+    __properties: ClassVar[List[str]] = ["client_id", "kyb_prefill"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -69,6 +71,9 @@ class CreateConnectedOrganizationRequest(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # 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
@@ -81,7 +86,8 @@ class CreateConnectedOrganizationRequest(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "client_id": obj.get("client_id")
+            "client_id": obj.get("client_id"),
+            "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.py

@@ -0,0 +1,104 @@
+# 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 tremendous.models.list_connected_organizations200_response_connected_organizations_inner_prefilled_kyb_details_address import ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateConnectedOrganizationRequestKyb(BaseModel):
+    """
+    Optional KYB details to forward for the end client. When provided, these values pre-fill the end client's onboarding form and remain fully editable; the end client still reviews and submits. 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 to support entity types outside the common presets. Common values are `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: Optional[ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress] = None
+    __properties: ClassVar[List[str]] = ["company_name", "doing_business_as", "company_structure", "company_registration_number", "country_code", "website_url", "address"]
+
+    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 CreateConnectedOrganizationRequestKyb 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 address
+        if self.address:
+            _dict['address'] = self.address.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateConnectedOrganizationRequestKyb 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": ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress.from_dict(obj["address"]) if obj.get("address") 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.19.0/tremendous/models/fraud_config_review_vpn.py

@@ -0,0 +1,88 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FraudConfigReviewVpn(BaseModel):
+    """
+    FraudConfigReviewVpn
+    """ # noqa: E501
+    skip_apple_private_relay: Optional[StrictBool] = Field(default=False, description="Whether Apple Private Relay traffic should be excluded from VPN fraud review. When omitted or false, Apple Private Relay traffic is flagged with other VPN and proxy traffic. ")
+    __properties: ClassVar[List[str]] = ["skip_apple_private_relay"]
+
+    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 FraudConfigReviewVpn 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 FraudConfigReviewVpn from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "skip_apple_private_relay": obj.get("skip_apple_private_relay") if obj.get("skip_apple_private_relay") is not None else False
+        })
+        return _obj
+
+

{tremendous_python-5.17.0 → tremendous_python-5.19.0}/tremendous/models/fraud_review.py

@@ -32,7 +32,7 @@ class FraudReview(BaseModel):
     The fraud review associated with a reward.
     """ # noqa: E501
     status: Optional[StrictStr] = Field(default=None, description="The current status of the fraud review:  * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released. ")
-    reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following:  * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
+    reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following:  * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
     device_id: Optional[StrictStr] = Field(default=None, description="The device fingerprint, if known.")
     redemption_method: Optional[StrictStr] = Field(default=None, description="The product selected to claim the reward")
     redeemed_at: Optional[datetime] = Field(default=None, description="Date the reward was redeemed")
@@ -62,8 +62,8 @@ class FraudReview(BaseModel):
             return value
 
         for i in value:
-            if i not in set(['Disallowed IP', 'Disallowed email', 'Disallowed country', 'Over reward amount limit', 'Over reward count limit', 'VPN detected', 'Device related to multiple emails', 'Device or account related to multiple emails', 'IP on a Tremendous fraud list', 'Bank account on a Tremendous fraud list', 'Fingerprint on a Tremendous fraud list', 'Email on a Tremendous fraud list', 'Phone on a Tremendous fraud list', 'Device on a Tremendous fraud list', 'IP related to a blocked reward', 'Device related to a blocked reward', 'Bank account related to a blocked reward', 'Fingerprint related to a blocked reward', 'Email related to a blocked reward', 'Phone related to a blocked reward', 'Allowed IP', 'Allowed email', 'Allowed country']):
-                raise ValueError("each list item must be one of ('Disallowed IP', 'Disallowed email', 'Disallowed country', 'Over reward amount limit', 'Over reward count limit', 'VPN detected', 'Device related to multiple emails', 'Device or account related to multiple emails', 'IP on a Tremendous fraud list', 'Bank account on a Tremendous fraud list', 'Fingerprint on a Tremendous fraud list', 'Email on a Tremendous fraud list', 'Phone on a Tremendous fraud list', 'Device on a Tremendous fraud list', 'IP related to a blocked reward', 'Device related to a blocked reward', 'Bank account related to a blocked reward', 'Fingerprint related to a blocked reward', 'Email related to a blocked reward', 'Phone related to a blocked reward', 'Allowed IP', 'Allowed email', 'Allowed country')")
+            if i not in set(['Disallowed IP', 'Disallowed email', 'Disallowed country', 'Over reward amount limit', 'Over reward count limit', 'VPN detected', 'Apple Private Relay', 'Device related to multiple emails', 'Device or account related to multiple emails', 'IP on a Tremendous fraud list', 'Bank account on a Tremendous fraud list', 'Fingerprint on a Tremendous fraud list', 'Email on a Tremendous fraud list', 'Phone on a Tremendous fraud list', 'Device on a Tremendous fraud list', 'IP related to a blocked reward', 'Device related to a blocked reward', 'Bank account related to a blocked reward', 'Fingerprint related to a blocked reward', 'Email related to a blocked reward', 'Phone related to a blocked reward', 'Allowed IP', 'Allowed email', 'Allowed country']):
+                raise ValueError("each list item must be one of ('Disallowed IP', 'Disallowed email', 'Disallowed country', 'Over reward amount limit', 'Over reward count limit', 'VPN detected', 'Apple Private Relay', 'Device related to multiple emails', 'Device or account related to multiple emails', 'IP on a Tremendous fraud list', 'Bank account on a Tremendous fraud list', 'Fingerprint on a Tremendous fraud list', 'Email on a Tremendous fraud list', 'Phone on a Tremendous fraud list', 'Device on a Tremendous fraud list', 'IP related to a blocked reward', 'Device related to a blocked reward', 'Bank account related to a blocked reward', 'Fingerprint related to a blocked reward', 'Email related to a blocked reward', 'Phone related to a blocked reward', 'Allowed IP', 'Allowed email', 'Allowed country')")
         return value
 
     @field_validator('redemption_method')

{tremendous_python-5.17.0 → tremendous_python-5.19.0}/tremendous/models/fraud_review_base.py

@@ -31,7 +31,7 @@ class FraudReviewBase(BaseModel):
     The fraud review associated with a reward.
     """ # noqa: E501
     status: Optional[StrictStr] = Field(default=None, description="The current status of the fraud review:  * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released. ")
-    reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following:  * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
+    reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following:  * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
     device_id: Optional[StrictStr] = Field(default=None, description="The device fingerprint, if known.")
     redemption_method: Optional[StrictStr] = Field(default=None, description="The product selected to claim the reward")
     redeemed_at: Optional[datetime] = Field(default=None, description="Date the reward was redeemed")
@@ -59,8 +59,8 @@ class FraudReviewBase(BaseModel):
             return value
 
         for i in value:
-            if i not in set(['Disallowed IP', 'Disallowed email', 'Disallowed country', 'Over reward amount limit', 'Over reward count limit', 'VPN detected', 'Device related to multiple emails', 'Device or account related to multiple emails', 'IP on a Tremendous fraud list', 'Bank account on a Tremendous fraud list', 'Fingerprint on a Tremendous fraud list', 'Email on a Tremendous fraud list', 'Phone on a Tremendous fraud list', 'Device on a Tremendous fraud list', 'IP related to a blocked reward', 'Device related to a blocked reward', 'Bank account related to a blocked reward', 'Fingerprint related to a blocked reward', 'Email related to a blocked reward', 'Phone related to a blocked reward', 'Allowed IP', 'Allowed email', 'Allowed country']):
-                raise ValueError("each list item must be one of ('Disallowed IP', 'Disallowed email', 'Disallowed country', 'Over reward amount limit', 'Over reward count limit', 'VPN detected', 'Device related to multiple emails', 'Device or account related to multiple emails', 'IP on a Tremendous fraud list', 'Bank account on a Tremendous fraud list', 'Fingerprint on a Tremendous fraud list', 'Email on a Tremendous fraud list', 'Phone on a Tremendous fraud list', 'Device on a Tremendous fraud list', 'IP related to a blocked reward', 'Device related to a blocked reward', 'Bank account related to a blocked reward', 'Fingerprint related to a blocked reward', 'Email related to a blocked reward', 'Phone related to a blocked reward', 'Allowed IP', 'Allowed email', 'Allowed country')")
+            if i not in set(['Disallowed IP', 'Disallowed email', 'Disallowed country', 'Over reward amount limit', 'Over reward count limit', 'VPN detected', 'Apple Private Relay', 'Device related to multiple emails', 'Device or account related to multiple emails', 'IP on a Tremendous fraud list', 'Bank account on a Tremendous fraud list', 'Fingerprint on a Tremendous fraud list', 'Email on a Tremendous fraud list', 'Phone on a Tremendous fraud list', 'Device on a Tremendous fraud list', 'IP related to a blocked reward', 'Device related to a blocked reward', 'Bank account related to a blocked reward', 'Fingerprint related to a blocked reward', 'Email related to a blocked reward', 'Phone related to a blocked reward', 'Allowed IP', 'Allowed email', 'Allowed country']):
+                raise ValueError("each list item must be one of ('Disallowed IP', 'Disallowed email', 'Disallowed country', 'Over reward amount limit', 'Over reward count limit', 'VPN detected', 'Apple Private Relay', 'Device related to multiple emails', 'Device or account related to multiple emails', 'IP on a Tremendous fraud list', 'Bank account on a Tremendous fraud list', 'Fingerprint on a Tremendous fraud list', 'Email on a Tremendous fraud list', 'Phone on a Tremendous fraud list', 'Device on a Tremendous fraud list', 'IP related to a blocked reward', 'Device related to a blocked reward', 'Bank account related to a blocked reward', 'Fingerprint related to a blocked reward', 'Email related to a blocked reward', 'Phone related to a blocked reward', 'Allowed IP', 'Allowed email', 'Allowed country')")
         return value
 
     @field_validator('redemption_method')

{tremendous_python-5.17.0 → tremendous_python-5.19.0}/tremendous/models/fraud_review_list_item.py

@@ -31,7 +31,7 @@ class FraudReviewListItem(BaseModel):
     The fraud review associated with a reward.
     """ # noqa: E501
     status: Optional[StrictStr] = Field(default=None, description="The current status of the fraud review:  * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released. ")
-    reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following:  * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
+    reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following:  * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
     device_id: Optional[StrictStr] = Field(default=None, description="The device fingerprint, if known.")
     redemption_method: Optional[StrictStr] = Field(default=None, description="The product selected to claim the reward")
     redeemed_at: Optional[datetime] = Field(default=None, description="Date the reward was redeemed")
@@ -59,8 +59,8 @@ class FraudReviewListItem(BaseModel):
             return value
 
         for i in value:
-            if i not in set(['Disallowed IP', 'Disallowed email', 'Disallowed country', 'Over reward amount limit', 'Over reward count limit', 'VPN detected', 'Device related to multiple emails', 'Device or account related to multiple emails', 'IP on a Tremendous fraud list', 'Bank account on a Tremendous fraud list', 'Fingerprint on a Tremendous fraud list', 'Email on a Tremendous fraud list', 'Phone on a Tremendous fraud list', 'Device on a Tremendous fraud list', 'IP related to a blocked reward', 'Device related to a blocked reward', 'Bank account related to a blocked reward', 'Fingerprint related to a blocked reward', 'Email related to a blocked reward', 'Phone related to a blocked reward', 'Allowed IP', 'Allowed email', 'Allowed country']):
-                raise ValueError("each list item must be one of ('Disallowed IP', 'Disallowed email', 'Disallowed country', 'Over reward amount limit', 'Over reward count limit', 'VPN detected', 'Device related to multiple emails', 'Device or account related to multiple emails', 'IP on a Tremendous fraud list', 'Bank account on a Tremendous fraud list', 'Fingerprint on a Tremendous fraud list', 'Email on a Tremendous fraud list', 'Phone on a Tremendous fraud list', 'Device on a Tremendous fraud list', 'IP related to a blocked reward', 'Device related to a blocked reward', 'Bank account related to a blocked reward', 'Fingerprint related to a blocked reward', 'Email related to a blocked reward', 'Phone related to a blocked reward', 'Allowed IP', 'Allowed email', 'Allowed country')")
+            if i not in set(['Disallowed IP', 'Disallowed email', 'Disallowed country', 'Over reward amount limit', 'Over reward count limit', 'VPN detected', 'Apple Private Relay', 'Device related to multiple emails', 'Device or account related to multiple emails', 'IP on a Tremendous fraud list', 'Bank account on a Tremendous fraud list', 'Fingerprint on a Tremendous fraud list', 'Email on a Tremendous fraud list', 'Phone on a Tremendous fraud list', 'Device on a Tremendous fraud list', 'IP related to a blocked reward', 'Device related to a blocked reward', 'Bank account related to a blocked reward', 'Fingerprint related to a blocked reward', 'Email related to a blocked reward', 'Phone related to a blocked reward', 'Allowed IP', 'Allowed email', 'Allowed country']):
+                raise ValueError("each list item must be one of ('Disallowed IP', 'Disallowed email', 'Disallowed country', 'Over reward amount limit', 'Over reward count limit', 'VPN detected', 'Apple Private Relay', 'Device related to multiple emails', 'Device or account related to multiple emails', 'IP on a Tremendous fraud list', 'Bank account on a Tremendous fraud list', 'Fingerprint on a Tremendous fraud list', 'Email on a Tremendous fraud list', 'Phone on a Tremendous fraud list', 'Device on a Tremendous fraud list', 'IP related to a blocked reward', 'Device related to a blocked reward', 'Bank account related to a blocked reward', 'Fingerprint related to a blocked reward', 'Email related to a blocked reward', 'Phone related to a blocked reward', 'Allowed IP', 'Allowed email', 'Allowed country')")
         return value
 
     @field_validator('redemption_method')

{tremendous_python-5.17.0 → tremendous_python-5.19.0}/tremendous/models/fraud_review_reason.py

@@ -33,6 +33,7 @@ class FraudReviewReason(str, Enum):
     OVER_REWARD_AMOUNT_LIMIT = 'Over reward amount limit'
     OVER_REWARD_COUNT_LIMIT = 'Over reward count limit'
     VPN_DETECTED = 'VPN detected'
+    APPLE_PRIVATE_RELAY = 'Apple Private Relay'
     DEVICE_RELATED_TO_MULTIPLE_EMAILS = 'Device related to multiple emails'
     DEVICE_OR_ACCOUNT_RELATED_TO_MULTIPLE_EMAILS = 'Device or account related to multiple emails'
     IP_ON_A_TREMENDOUS_FRAUD_LIST = 'IP on a Tremendous fraud list'