tremendous-python 4.1.0__tar.gz → 4.2.0__tar.gz

{tremendous_python-4.1.0 → tremendous_python-4.2.0}/PKG-INFO

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

{tremendous_python-4.1.0 → tremendous_python-4.2.0}/pyproject.toml

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

{tremendous_python-4.1.0 → tremendous_python-4.2.0}/tremendous/__init__.py

@@ -37,6 +37,8 @@ from tremendous.models.allow_email1 import AllowEmail1
 from tremendous.models.allow_ip import AllowIp
 from tremendous.models.allow_ip1 import AllowIp1
 from tremendous.models.balance_transaction import BalanceTransaction
+from tremendous.models.balance_transaction_order import BalanceTransactionOrder
+from tremendous.models.balance_transaction_order_payment import BalanceTransactionOrderPayment
 from tremendous.models.base_order_for_create import BaseOrderForCreate
 from tremendous.models.campaign import Campaign
 from tremendous.models.campaign_base import CampaignBase
@@ -53,7 +55,6 @@ from tremendous.models.create_order200_response import CreateOrder200Response
 from tremendous.models.create_order200_response_order import CreateOrder200ResponseOrder
 from tremendous.models.create_order200_response_order_rewards_inner import CreateOrder200ResponseOrderRewardsInner
 from tremendous.models.create_order200_response_order_rewards_inner_delivery import CreateOrder200ResponseOrderRewardsInnerDelivery
-from tremendous.models.create_order201_response import CreateOrder201Response
 from tremendous.models.create_order_request import CreateOrderRequest
 from tremendous.models.create_organization import CreateOrganization
 from tremendous.models.create_organization200_response import CreateOrganization200Response
@@ -93,6 +94,7 @@ from tremendous.models.fraud_review_list_item import FraudReviewListItem
 from tremendous.models.fraud_review_reason import FraudReviewReason
 from tremendous.models.fraud_review_redemption_method import FraudReviewRedemptionMethod
 from tremendous.models.fraud_review_related_rewards import FraudReviewRelatedRewards
+from tremendous.models.fraud_review_risk import FraudReviewRisk
 from tremendous.models.fraud_review_status import FraudReviewStatus
 from tremendous.models.fraud_rule200_response import FraudRule200Response
 from tremendous.models.fraud_rule400_response import FraudRule400Response
@@ -115,12 +117,15 @@ from tremendous.models.get_funding_source200_response import GetFundingSource200
 from tremendous.models.get_member200_response import GetMember200Response
 from tremendous.models.get_member200_response_member import GetMember200ResponseMember
 from tremendous.models.get_member200_response_member_events_inner import GetMember200ResponseMemberEventsInner
+from tremendous.models.get_order200_response import GetOrder200Response
 from tremendous.models.get_organization200_response import GetOrganization200Response
 from tremendous.models.get_product_response import GetProductResponse
 from tremendous.models.get_reward200_response import GetReward200Response
 from tremendous.models.invoice import Invoice
 from tremendous.models.list_balance_transactions200_response import ListBalanceTransactions200Response
 from tremendous.models.list_balance_transactions200_response_transactions_inner import ListBalanceTransactions200ResponseTransactionsInner
+from tremendous.models.list_balance_transactions200_response_transactions_inner_order import ListBalanceTransactions200ResponseTransactionsInnerOrder
+from tremendous.models.list_balance_transactions200_response_transactions_inner_order_payment import ListBalanceTransactions200ResponseTransactionsInnerOrderPayment
 from tremendous.models.list_campaigns200_response import ListCampaigns200Response
 from tremendous.models.list_campaigns200_response_campaigns_inner import ListCampaigns200ResponseCampaignsInner
 from tremendous.models.list_campaigns200_response_campaigns_inner_email_style import ListCampaigns200ResponseCampaignsInnerEmailStyle

{tremendous_python-4.1.0 → tremendous_python-4.2.0}/tremendous/api/tremendous_api.py

@@ -28,7 +28,6 @@ from tremendous.models.create_invoice_request import CreateInvoiceRequest
 from tremendous.models.create_member200_response import CreateMember200Response
 from tremendous.models.create_member_request import CreateMemberRequest
 from tremendous.models.create_order200_response import CreateOrder200Response
-from tremendous.models.create_order201_response import CreateOrder201Response
 from tremendous.models.create_order_request import CreateOrderRequest
 from tremendous.models.create_organization200_response import CreateOrganization200Response
 from tremendous.models.create_organization_request import CreateOrganizationRequest
@@ -44,6 +43,7 @@ from tremendous.models.generate_reward_token200_response import GenerateRewardTo
 from tremendous.models.get_fraud_review200_response import GetFraudReview200Response
 from tremendous.models.get_funding_source200_response import GetFundingSource200Response
 from tremendous.models.get_member200_response import GetMember200Response
+from tremendous.models.get_order200_response import GetOrder200Response
 from tremendous.models.get_organization200_response import GetOrganization200Response
 from tremendous.models.get_product_response import GetProductResponse
 from tremendous.models.get_reward200_response import GetReward200Response
@@ -103,7 +103,7 @@ class TremendousApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> CreateOrder201Response:
+    ) -> GetOrder200Response:
         """Approve order
 
         Approves an order that is pending review, identified by the given `id` in the URL.  Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable 'Allow approvals via API' via the organization''s 'Order Approvals' settings from the Tremendous dashboard. 
@@ -141,7 +141,7 @@ class TremendousApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CreateOrder201Response",
+            '200': "GetOrder200Response",
             '401': "ListRewards401Response",
             '402': "ListRewards401Response",
             '403': "GenerateRewardLink403Response",
@@ -177,7 +177,7 @@ class TremendousApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[CreateOrder201Response]:
+    ) -> ApiResponse[GetOrder200Response]:
         """Approve order
 
         Approves an order that is pending review, identified by the given `id` in the URL.  Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable 'Allow approvals via API' via the organization''s 'Order Approvals' settings from the Tremendous dashboard. 
@@ -215,7 +215,7 @@ class TremendousApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CreateOrder201Response",
+            '200': "GetOrder200Response",
             '401': "ListRewards401Response",
             '402': "ListRewards401Response",
             '403': "GenerateRewardLink403Response",
@@ -289,7 +289,7 @@ class TremendousApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CreateOrder201Response",
+            '200': "GetOrder200Response",
             '401': "ListRewards401Response",
             '402': "ListRewards401Response",
             '403': "GenerateRewardLink403Response",
@@ -1792,7 +1792,7 @@ class TremendousApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "CreateOrder200Response",
-            '201': "CreateOrder201Response",
+            '201': "CreateOrder200Response",
             '400': "ResendReward422Response",
             '401': "ListRewards401Response",
             '402': "ListRewards401Response",
@@ -1866,7 +1866,7 @@ class TremendousApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "CreateOrder200Response",
-            '201': "CreateOrder201Response",
+            '201': "CreateOrder200Response",
             '400': "ResendReward422Response",
             '401': "ListRewards401Response",
             '402': "ListRewards401Response",
@@ -1940,7 +1940,7 @@ class TremendousApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "CreateOrder200Response",
-            '201': "CreateOrder201Response",
+            '201': "CreateOrder200Response",
             '400': "ResendReward422Response",
             '401': "ListRewards401Response",
             '402': "ListRewards401Response",
@@ -6446,7 +6446,7 @@ class TremendousApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> CreateOrder201Response:
+    ) -> GetOrder200Response:
         """Retrieve order
 
         Retrieve the order, identified by the given `id` in the URL 
@@ -6484,7 +6484,7 @@ class TremendousApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CreateOrder201Response",
+            '200': "GetOrder200Response",
             '401': "ListRewards401Response",
             '404': "ListRewards401Response",
             '429': "ListRewards429Response",
@@ -6517,7 +6517,7 @@ class TremendousApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[CreateOrder201Response]:
+    ) -> ApiResponse[GetOrder200Response]:
         """Retrieve order
 
         Retrieve the order, identified by the given `id` in the URL 
@@ -6555,7 +6555,7 @@ class TremendousApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CreateOrder201Response",
+            '200': "GetOrder200Response",
             '401': "ListRewards401Response",
             '404': "ListRewards401Response",
             '429': "ListRewards429Response",
@@ -6626,7 +6626,7 @@ class TremendousApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CreateOrder201Response",
+            '200': "GetOrder200Response",
             '401': "ListRewards401Response",
             '404': "ListRewards401Response",
             '429': "ListRewards429Response",
@@ -12510,7 +12510,7 @@ class TremendousApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> CreateOrder201Response:
+    ) -> GetOrder200Response:
         """Reject order
 
         Rejects an order that is pending review, identified by the given `id` in the URL.  Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable 'Allow approvals via API' via the organization''s 'Order Approvals' settings from the Tremendous dashboard. 
@@ -12548,7 +12548,7 @@ class TremendousApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CreateOrder201Response",
+            '200': "GetOrder200Response",
             '401': "ListRewards401Response",
             '403': "GenerateRewardLink403Response",
             '404': "ListRewards401Response",
@@ -12583,7 +12583,7 @@ class TremendousApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[CreateOrder201Response]:
+    ) -> ApiResponse[GetOrder200Response]:
         """Reject order
 
         Rejects an order that is pending review, identified by the given `id` in the URL.  Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable 'Allow approvals via API' via the organization''s 'Order Approvals' settings from the Tremendous dashboard. 
@@ -12621,7 +12621,7 @@ class TremendousApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CreateOrder201Response",
+            '200': "GetOrder200Response",
             '401': "ListRewards401Response",
             '403': "GenerateRewardLink403Response",
             '404': "ListRewards401Response",
@@ -12694,7 +12694,7 @@ class TremendousApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CreateOrder201Response",
+            '200': "GetOrder200Response",
             '401': "ListRewards401Response",
             '403': "GenerateRewardLink403Response",
             '404': "ListRewards401Response",

{tremendous_python-4.1.0 → tremendous_python-4.2.0}/tremendous/models/__init__.py

@@ -20,6 +20,8 @@ from tremendous.models.allow_email1 import AllowEmail1
 from tremendous.models.allow_ip import AllowIp
 from tremendous.models.allow_ip1 import AllowIp1
 from tremendous.models.balance_transaction import BalanceTransaction
+from tremendous.models.balance_transaction_order import BalanceTransactionOrder
+from tremendous.models.balance_transaction_order_payment import BalanceTransactionOrderPayment
 from tremendous.models.base_order_for_create import BaseOrderForCreate
 from tremendous.models.campaign import Campaign
 from tremendous.models.campaign_base import CampaignBase
@@ -36,7 +38,6 @@ from tremendous.models.create_order200_response import CreateOrder200Response
 from tremendous.models.create_order200_response_order import CreateOrder200ResponseOrder
 from tremendous.models.create_order200_response_order_rewards_inner import CreateOrder200ResponseOrderRewardsInner
 from tremendous.models.create_order200_response_order_rewards_inner_delivery import CreateOrder200ResponseOrderRewardsInnerDelivery
-from tremendous.models.create_order201_response import CreateOrder201Response
 from tremendous.models.create_order_request import CreateOrderRequest
 from tremendous.models.create_organization import CreateOrganization
 from tremendous.models.create_organization200_response import CreateOrganization200Response
@@ -76,6 +77,7 @@ from tremendous.models.fraud_review_list_item import FraudReviewListItem
 from tremendous.models.fraud_review_reason import FraudReviewReason
 from tremendous.models.fraud_review_redemption_method import FraudReviewRedemptionMethod
 from tremendous.models.fraud_review_related_rewards import FraudReviewRelatedRewards
+from tremendous.models.fraud_review_risk import FraudReviewRisk
 from tremendous.models.fraud_review_status import FraudReviewStatus
 from tremendous.models.fraud_rule200_response import FraudRule200Response
 from tremendous.models.fraud_rule400_response import FraudRule400Response
@@ -98,12 +100,15 @@ from tremendous.models.get_funding_source200_response import GetFundingSource200
 from tremendous.models.get_member200_response import GetMember200Response
 from tremendous.models.get_member200_response_member import GetMember200ResponseMember
 from tremendous.models.get_member200_response_member_events_inner import GetMember200ResponseMemberEventsInner
+from tremendous.models.get_order200_response import GetOrder200Response
 from tremendous.models.get_organization200_response import GetOrganization200Response
 from tremendous.models.get_product_response import GetProductResponse
 from tremendous.models.get_reward200_response import GetReward200Response
 from tremendous.models.invoice import Invoice
 from tremendous.models.list_balance_transactions200_response import ListBalanceTransactions200Response
 from tremendous.models.list_balance_transactions200_response_transactions_inner import ListBalanceTransactions200ResponseTransactionsInner
+from tremendous.models.list_balance_transactions200_response_transactions_inner_order import ListBalanceTransactions200ResponseTransactionsInnerOrder
+from tremendous.models.list_balance_transactions200_response_transactions_inner_order_payment import ListBalanceTransactions200ResponseTransactionsInnerOrderPayment
 from tremendous.models.list_campaigns200_response import ListCampaigns200Response
 from tremendous.models.list_campaigns200_response_campaigns_inner import ListCampaigns200ResponseCampaignsInner
 from tremendous.models.list_campaigns200_response_campaigns_inner_email_style import ListCampaigns200ResponseCampaignsInnerEmailStyle

{tremendous_python-4.1.0 → tremendous_python-4.2.0}/tremendous/models/balance_transaction.py

@@ -20,7 +20,8 @@ import json
 
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Union
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from tremendous.models.balance_transaction_order import BalanceTransactionOrder
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -33,7 +34,8 @@ class BalanceTransaction(BaseModel):
     balance: Union[StrictFloat, StrictInt] = Field(description="The updated total after the transaction. Note that this running balance may be delayed and contain `null`.")
     action: StrictStr = Field(description="The action that was performed")
     description: StrictStr = Field(description="A brief description of the transaction")
-    __properties: ClassVar[List[str]] = ["created_at", "amount", "balance", "action", "description"]
+    order: Optional[BalanceTransactionOrder] = None
+    __properties: ClassVar[List[str]] = ["created_at", "amount", "balance", "action", "description", "order"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -74,6 +76,9 @@ class BalanceTransaction(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of order
+        if self.order:
+            _dict['order'] = self.order.to_dict()
         return _dict
 
     @classmethod
@@ -90,7 +95,8 @@ class BalanceTransaction(BaseModel):
             "amount": obj.get("amount"),
             "balance": obj.get("balance"),
             "action": obj.get("action"),
-            "description": obj.get("description")
+            "description": obj.get("description"),
+            "order": BalanceTransactionOrder.from_dict(obj["order"]) if obj.get("order") is not None else None
         })
         return _obj
 

tremendous_python-4.2.0/tremendous/models/balance_transaction_order.py

@@ -0,0 +1,114 @@
+# 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 it's 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from tremendous.models.balance_transaction_order_payment import BalanceTransactionOrderPayment
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BalanceTransactionOrder(BaseModel):
+    """
+    Order details
+    """ # noqa: E501
+    id: Optional[Annotated[str, Field(strict=True)]] = None
+    external_id: Optional[StrictStr] = Field(default=None, description="Reference for this order, supplied by the customer.  When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders.  It also allows for retrieving by `external_id` instead of `id` only. ")
+    payment: Optional[BalanceTransactionOrderPayment] = None
+    __properties: ClassVar[List[str]] = ["id", "external_id", "payment"]
+
+    @field_validator('id')
+    def id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"[A-Z0-9]{4,20}", value):
+            raise ValueError(r"must validate the regular expression /[A-Z0-9]{4,20}/")
+        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 BalanceTransactionOrder 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.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "id",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of payment
+        if self.payment:
+            _dict['payment'] = self.payment.to_dict()
+        # set to None if external_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.external_id is None and "external_id" in self.model_fields_set:
+            _dict['external_id'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BalanceTransactionOrder from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "external_id": obj.get("external_id"),
+            "payment": BalanceTransactionOrderPayment.from_dict(obj["payment"]) if obj.get("payment") is not None else None
+        })
+        return _obj
+
+

tremendous_python-4.2.0/tremendous/models/balance_transaction_order_payment.py

@@ -0,0 +1,109 @@
+# 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 it's 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, Optional, Union
+from typing_extensions import Annotated
+from tremendous.models.payment_details_refund import PaymentDetailsRefund
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BalanceTransactionOrderPayment(BaseModel):
+    """
+    BalanceTransactionOrderPayment
+    """ # noqa: E501
+    subtotal: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="Total price of the order before fees (in USD)")
+    total: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="Total price of the order including fees (in USD)")
+    fees: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="Fees for the order (in USD)")
+    discount: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="Discount for the order (in USD)")
+    refund: Optional[PaymentDetailsRefund] = None
+    __properties: ClassVar[List[str]] = ["subtotal", "total", "fees", "discount", "refund"]
+
+    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 BalanceTransactionOrderPayment 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "subtotal",
+            "total",
+            "fees",
+            "discount",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of refund
+        if self.refund:
+            _dict['refund'] = self.refund.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BalanceTransactionOrderPayment from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "subtotal": obj.get("subtotal"),
+            "total": obj.get("total"),
+            "fees": obj.get("fees"),
+            "discount": obj.get("discount"),
+            "refund": PaymentDetailsRefund.from_dict(obj["refund"]) if obj.get("refund") is not None else None
+        })
+        return _obj
+
+

{tremendous_python-4.1.0 → tremendous_python-4.2.0}/tremendous/models/fraud_review.py

@@ -32,6 +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. ")
+    risk: Optional[StrictStr] = Field(default=None, description="The fraud risk associated with the reward.")
     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 dollar 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` * `IP 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` ")
     reviewed_by: Optional[StrictStr] = Field(default=None, description="The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days.  This field is only present if the status is not `flagged`. ")
     reviewed_at: Optional[datetime] = Field(default=None, description="When the reward was blocked or released following fraud review.  This field is only present if the status is not `flagged`. ")
@@ -41,7 +42,7 @@ class FraudReview(BaseModel):
     redeemed_at: Optional[datetime] = Field(default=None, description="Date the reward was redeemed")
     geo: Optional[GetFraudReview200ResponseFraudReviewGeo] = None
     reward: Optional[OrderWithoutLinkRewardsInner] = None
-    __properties: ClassVar[List[str]] = ["status", "reasons", "reviewed_by", "reviewed_at", "related_rewards", "device_id", "redemption_method", "redeemed_at", "geo", "reward"]
+    __properties: ClassVar[List[str]] = ["status", "risk", "reasons", "reviewed_by", "reviewed_at", "related_rewards", "device_id", "redemption_method", "redeemed_at", "geo", "reward"]
 
     @field_validator('status')
     def status_validate_enum(cls, value):
@@ -53,6 +54,16 @@ class FraudReview(BaseModel):
             raise ValueError("must be one of enum values ('flagged', 'blocked', 'released')")
         return value
 
+    @field_validator('risk')
+    def risk_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['high', 'medium', 'low']):
+            raise ValueError("must be one of enum values ('high', 'medium', 'low')")
+        return value
+
     @field_validator('reasons')
     def reasons_validate_enum(cls, value):
         """Validates the enum"""
@@ -107,9 +118,11 @@ class FraudReview(BaseModel):
         * OpenAPI `readOnly` fields are excluded.
         * OpenAPI `readOnly` fields are excluded.
         * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
         """
         excluded_fields: Set[str] = set([
             "status",
+            "risk",
             "reasons",
             "redemption_method",
         ])
@@ -141,6 +154,7 @@ class FraudReview(BaseModel):
 
         _obj = cls.model_validate({
             "status": obj.get("status"),
+            "risk": obj.get("risk"),
             "reasons": obj.get("reasons"),
             "reviewed_by": obj.get("reviewed_by"),
             "reviewed_at": obj.get("reviewed_at"),

tremendous_python-4.2.0/tremendous/models/fraud_review_risk.py

@@ -0,0 +1,39 @@
+# 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 it's 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class FraudReviewRisk(str, Enum):
+    """
+    The fraud risk associated with the reward.
+    """
+
+    """
+    allowed enum values
+    """
+    HIGH = 'high'
+    MEDIUM = 'medium'
+    LOW = 'low'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FraudReviewRisk from a JSON string"""
+        return cls(json.loads(json_str))
+
+