tremendous-python 5.12.0__tar.gz → 5.14.0__tar.gz

{tremendous_python-5.12.0/tremendous_python.egg-info → tremendous_python-5.14.0}/PKG-INFO

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

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/pyproject.toml

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

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/balance_transaction.py

@@ -30,12 +30,13 @@ class BalanceTransaction(BaseModel):
     A balance transaction represents a specific movement or change in an account's balance. 
     """ # noqa: E501
     created_at: datetime = Field(description="Date that the transaction was created")
-    amount: Union[StrictFloat, StrictInt] = Field(description="Amount of the transaction in USD")
-    balance: Union[StrictFloat, StrictInt] = Field(description="The updated total after the transaction. Note that this running balance may be delayed and contain `null`.")
+    amount: Union[StrictFloat, StrictInt] = Field(description="Amount of the transaction, denominated in `currency_code`.")
+    currency_code: StrictStr = Field(description="Currency of the transaction amount and running balance. Always matches the organization's currency.")
+    balance: Union[StrictFloat, StrictInt] = Field(description="The updated total after the transaction, denominated in `currency_code`. 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")
     order: Optional[BalanceTransactionOrder] = None
-    __properties: ClassVar[List[str]] = ["created_at", "amount", "balance", "action", "description", "order"]
+    __properties: ClassVar[List[str]] = ["created_at", "amount", "currency_code", "balance", "action", "description", "order"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -93,6 +94,7 @@ class BalanceTransaction(BaseModel):
         _obj = cls.model_validate({
             "created_at": obj.get("created_at"),
             "amount": obj.get("amount"),
+            "currency_code": obj.get("currency_code"),
             "balance": obj.get("balance"),
             "action": obj.get("action"),
             "description": obj.get("description"),

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/balance_transaction_order_payment.py

@@ -18,7 +18,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing_extensions import Annotated
 from tremendous.models.payment_details_refund import PaymentDetailsRefund
@@ -29,12 +29,13 @@ 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)")
+    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, denominated in `currency_code`.")
+    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, denominated in `currency_code`.")
+    fees: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="Fees for the order, denominated in `currency_code`.")
+    discount: Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]] = Field(description="Discount for the order, denominated in `currency_code`.")
+    currency_code: StrictStr = Field(description="Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated.  This always matches the organization's currency. ")
     refund: Optional[PaymentDetailsRefund] = None
-    __properties: ClassVar[List[str]] = ["subtotal", "total", "fees", "discount", "refund"]
+    __properties: ClassVar[List[str]] = ["subtotal", "total", "fees", "discount", "currency_code", "refund"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -70,12 +71,14 @@ class BalanceTransactionOrderPayment(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([
             "subtotal",
             "total",
             "fees",
             "discount",
+            "currency_code",
         ])
 
         _dict = self.model_dump(
@@ -102,6 +105,7 @@ class BalanceTransactionOrderPayment(BaseModel):
             "total": obj.get("total"),
             "fees": obj.get("fees"),
             "discount": obj.get("discount"),
+            "currency_code": obj.get("currency_code"),
             "refund": PaymentDetailsRefund.from_dict(obj["refund"]) if obj.get("refund") is not None else None
         })
         return _obj

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/campaign.py

@@ -34,9 +34,10 @@ class Campaign(BaseModel):
     name: StrictStr = Field(description="Name of the campaign")
     description: Optional[StrictStr] = Field(description="Description of the campaign")
     products: List[Annotated[str, Field(strict=True)]] = Field(description="List of IDs of products (different gift cards, charity, etc.) that are available in this campaign. ")
+    fee_charged_to: Optional[StrictStr] = Field(default=None, description="Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient's reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product. ")
     webpage_style: Optional[ListCampaigns200ResponseCampaignsInnerWebpageStyle] = None
     email_style: Optional[ListCampaigns200ResponseCampaignsInnerEmailStyle] = None
-    __properties: ClassVar[List[str]] = ["id", "name", "description", "products", "webpage_style", "email_style"]
+    __properties: ClassVar[List[str]] = ["id", "name", "description", "products", "fee_charged_to", "webpage_style", "email_style"]
 
     @field_validator('id')
     def id_validate_regular_expression(cls, value):
@@ -48,6 +49,16 @@ class Campaign(BaseModel):
             raise ValueError(r"must validate the regular expression /[A-Z0-9]{4,20}/")
         return value
 
+    @field_validator('fee_charged_to')
+    def fee_charged_to_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['SENDER', 'RECIPIENT']):
+            raise ValueError("must be one of enum values ('SENDER', 'RECIPIENT')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
@@ -100,6 +111,11 @@ class Campaign(BaseModel):
         if self.description is None and "description" in self.model_fields_set:
             _dict['description'] = None
 
+        # set to None if fee_charged_to (nullable) is None
+        # and model_fields_set contains the field
+        if self.fee_charged_to is None and "fee_charged_to" in self.model_fields_set:
+            _dict['fee_charged_to'] = None
+
         return _dict
 
     @classmethod
@@ -116,6 +132,7 @@ class Campaign(BaseModel):
             "name": obj.get("name"),
             "description": obj.get("description"),
             "products": obj.get("products"),
+            "fee_charged_to": obj.get("fee_charged_to"),
             "webpage_style": ListCampaigns200ResponseCampaignsInnerWebpageStyle.from_dict(obj["webpage_style"]) if obj.get("webpage_style") is not None else None,
             "email_style": ListCampaigns200ResponseCampaignsInnerEmailStyle.from_dict(obj["email_style"]) if obj.get("email_style") is not None else None
         })

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/campaign_base.py

@@ -34,9 +34,10 @@ class CampaignBase(BaseModel):
     name: Optional[StrictStr] = Field(default=None, description="Name of the campaign")
     description: Optional[StrictStr] = Field(default=None, description="Description of the campaign")
     products: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="List of IDs of products (different gift cards, charity, etc.) that are available in this campaign. ")
+    fee_charged_to: Optional[StrictStr] = Field(default=None, description="Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient's reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product. ")
     webpage_style: Optional[ListCampaigns200ResponseCampaignsInnerWebpageStyle] = None
     email_style: Optional[ListCampaigns200ResponseCampaignsInnerEmailStyle] = None
-    __properties: ClassVar[List[str]] = ["id", "name", "description", "products", "webpage_style", "email_style"]
+    __properties: ClassVar[List[str]] = ["id", "name", "description", "products", "fee_charged_to", "webpage_style", "email_style"]
 
     @field_validator('id')
     def id_validate_regular_expression(cls, value):
@@ -48,6 +49,16 @@ class CampaignBase(BaseModel):
             raise ValueError(r"must validate the regular expression /[A-Z0-9]{4,20}/")
         return value
 
+    @field_validator('fee_charged_to')
+    def fee_charged_to_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['SENDER', 'RECIPIENT']):
+            raise ValueError("must be one of enum values ('SENDER', 'RECIPIENT')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
@@ -100,6 +111,11 @@ class CampaignBase(BaseModel):
         if self.description is None and "description" in self.model_fields_set:
             _dict['description'] = None
 
+        # set to None if fee_charged_to (nullable) is None
+        # and model_fields_set contains the field
+        if self.fee_charged_to is None and "fee_charged_to" in self.model_fields_set:
+            _dict['fee_charged_to'] = None
+
         return _dict
 
     @classmethod
@@ -116,6 +132,7 @@ class CampaignBase(BaseModel):
             "name": obj.get("name"),
             "description": obj.get("description"),
             "products": obj.get("products"),
+            "fee_charged_to": obj.get("fee_charged_to"),
             "webpage_style": ListCampaigns200ResponseCampaignsInnerWebpageStyle.from_dict(obj["webpage_style"]) if obj.get("webpage_style") is not None else None,
             "email_style": ListCampaigns200ResponseCampaignsInnerEmailStyle.from_dict(obj["email_style"]) if obj.get("email_style") is not None else None
         })

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/connected_organization_organization.py

@@ -32,9 +32,10 @@ class ConnectedOrganizationOrganization(BaseModel):
     id: Optional[Annotated[str, Field(strict=True)]] = None
     name: StrictStr = Field(description="Name of the organization")
     website: StrictStr = Field(description="URL of the website of that organization")
+    currency_code: Optional[StrictStr] = Field(default=None, description="Currency used for this organization's balances, orders, and transactions.")
     status: Optional[StrictStr] = Field(default=None, description="Status of the organization. Organizations need to be approved to be able to use them to send out rewards.")
     created_at: Optional[date] = Field(default=None, description="Timestamp of when the organization has been created.  *This field is only returned when creating an organization.* It is not returned anymore when retrieving or listing organizations. ")
-    __properties: ClassVar[List[str]] = ["id", "name", "website", "status", "created_at"]
+    __properties: ClassVar[List[str]] = ["id", "name", "website", "currency_code", "status", "created_at"]
 
     @field_validator('id')
     def id_validate_regular_expression(cls, value):
@@ -116,6 +117,7 @@ class ConnectedOrganizationOrganization(BaseModel):
             "id": obj.get("id"),
             "name": obj.get("name"),
             "website": obj.get("website"),
+            "currency_code": obj.get("currency_code"),
             "status": obj.get("status"),
             "created_at": obj.get("created_at")
         })

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/create_campaign_request.py

@@ -33,9 +33,20 @@ class CreateCampaignRequest(BaseModel):
     name: StrictStr = Field(description="Name of the campaign")
     description: Optional[StrictStr] = Field(description="Description of the campaign")
     products: List[Annotated[str, Field(strict=True)]] = Field(description="List of IDs of products (different gift cards, charity, etc.) that are available in this campaign. ")
+    fee_charged_to: Optional[StrictStr] = Field(default=None, description="Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient's reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product. ")
     webpage_style: Optional[ListCampaigns200ResponseCampaignsInnerWebpageStyle] = None
     email_style: Optional[ListCampaigns200ResponseCampaignsInnerEmailStyle] = None
-    __properties: ClassVar[List[str]] = ["name", "description", "products", "webpage_style", "email_style"]
+    __properties: ClassVar[List[str]] = ["name", "description", "products", "fee_charged_to", "webpage_style", "email_style"]
+
+    @field_validator('fee_charged_to')
+    def fee_charged_to_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['SENDER', 'RECIPIENT']):
+            raise ValueError("must be one of enum values ('SENDER', 'RECIPIENT')")
+        return value
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -87,6 +98,11 @@ class CreateCampaignRequest(BaseModel):
         if self.description is None and "description" in self.model_fields_set:
             _dict['description'] = None
 
+        # set to None if fee_charged_to (nullable) is None
+        # and model_fields_set contains the field
+        if self.fee_charged_to is None and "fee_charged_to" in self.model_fields_set:
+            _dict['fee_charged_to'] = None
+
         return _dict
 
     @classmethod
@@ -102,6 +118,7 @@ class CreateCampaignRequest(BaseModel):
             "name": obj.get("name"),
             "description": obj.get("description"),
             "products": obj.get("products"),
+            "fee_charged_to": obj.get("fee_charged_to"),
             "webpage_style": ListCampaigns200ResponseCampaignsInnerWebpageStyle.from_dict(obj["webpage_style"]) if obj.get("webpage_style") is not None else None,
             "email_style": ListCampaigns200ResponseCampaignsInnerEmailStyle.from_dict(obj["email_style"]) if obj.get("email_style") is not None else None
         })

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/create_order200_response_order.py

@@ -34,7 +34,7 @@ class CreateOrder200ResponseOrder(BaseModel):
     id: Annotated[str, Field(strict=True)] = Field(description="Tremendous ID of the order")
     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. ")
     campaign_id: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. ")
-    created_at: datetime = Field(description="Date the order has been created")
+    created_at: datetime = Field(description="Date the order was created")
     status: StrictStr = Field(description="Execution status of a given order  <table>   <thead>     <tr>       <th>         Status       </th>       <th>         Description       </th>     </tr>   </thead>   <tbody>     <tr>       <td>         <code>           CANCELED         </code>       </td>       <td>         The order and all of its rewards were canceled.       </td>     </tr>     <tr>       <td>         <code>           OPEN         </code>       </td>       <td>         The order has been created, but hasn't yet been processed.       </td>     </tr>     <tr>       <td>         <code>           EXECUTED         </code>       </td>       <td>         The order has been executed. Payment has been handled and rewards are being delivered (if applicable).       </td>     </tr>     <tr>       <td>         <code>           FAILED         </code>       </td>       <td>         The order could not be processed due to an error. E.g. due to insufficient funds in the account.       </td>     </tr>     <tr>       <td>         <code>           PENDING APPROVAL         </code>       </td>       <td>         The order has been created but needs approval to be executed.       </td>     </tr>     <tr>       <td>         <code>           PENDING INTERNAL PAYMENT APPROVAL         </code>       </td>       <td>         The order has been created but it is under review and requires approval from our team.       </td>     </tr>     <tr>       <td>         <code>           PENDING SETTLEMENT         </code>       </td>       <td>         The order has been created but the funds are being held until the settlement window clears.       </td>     </tr>    </tbody> </table> ")
     channel: Optional[StrictStr] = Field(default=None, description="Name of the channel in which the order was created")
     payment: Optional[ListOrders200ResponseOrdersInnerPayment] = None

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/create_organization.py

@@ -36,8 +36,9 @@ class CreateOrganization(BaseModel):
     with_api_key: StrictBool = Field(description="Default value is `false`. Set to true to also generate an API key associated to the new organization.")
     copy_settings: Optional[CreateOrganizationRequestCopySettings] = None
     phone: Optional[StrictStr] = Field(default=None, description="Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).")
+    currency_code: Optional[StrictStr] = Field(default=None, description="Currency code for the new organization. Defaults to the current organization's currency if not provided.")
     created_at: Optional[date] = Field(default=None, description="Timestamp of when the organization has been created. ")
-    __properties: ClassVar[List[str]] = ["id", "name", "website", "with_api_key", "copy_settings", "phone", "created_at"]
+    __properties: ClassVar[List[str]] = ["id", "name", "website", "with_api_key", "copy_settings", "phone", "currency_code", "created_at"]
 
     @field_validator('id')
     def id_validate_regular_expression(cls, value):
@@ -113,6 +114,7 @@ class CreateOrganization(BaseModel):
             "with_api_key": obj.get("with_api_key"),
             "copy_settings": CreateOrganizationRequestCopySettings.from_dict(obj["copy_settings"]) if obj.get("copy_settings") is not None else None,
             "phone": obj.get("phone"),
+            "currency_code": obj.get("currency_code"),
             "created_at": obj.get("created_at")
         })
         return _obj

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/create_organization200_response_organization.py

@@ -35,9 +35,10 @@ class CreateOrganization200ResponseOrganization(BaseModel):
     website: StrictStr = Field(description="URL of the website of that organization")
     copy_settings: Optional[CreateOrganizationRequestCopySettings] = None
     phone: Optional[StrictStr] = Field(default=None, description="Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).")
+    currency_code: Optional[StrictStr] = Field(default=None, description="Currency code for the new organization. Defaults to the current organization's currency if not provided.")
     created_at: Optional[date] = Field(default=None, description="Timestamp of when the organization has been created. ")
     api_key: Optional[StrictStr] = Field(default=None, description="The API key for the created organization. This property is only returned when `api_key` is set to `true`. ")
-    __properties: ClassVar[List[str]] = ["id", "name", "website", "copy_settings", "phone", "created_at", "api_key"]
+    __properties: ClassVar[List[str]] = ["id", "name", "website", "copy_settings", "phone", "currency_code", "created_at", "api_key"]
 
     @field_validator('id')
     def id_validate_regular_expression(cls, value):
@@ -113,6 +114,7 @@ class CreateOrganization200ResponseOrganization(BaseModel):
             "website": obj.get("website"),
             "copy_settings": CreateOrganizationRequestCopySettings.from_dict(obj["copy_settings"]) if obj.get("copy_settings") is not None else None,
             "phone": obj.get("phone"),
+            "currency_code": obj.get("currency_code"),
             "created_at": obj.get("created_at"),
             "api_key": obj.get("api_key")
         })

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/create_organization_for_response.py

@@ -36,8 +36,9 @@ class CreateOrganizationForResponse(BaseModel):
     with_api_key: Optional[StrictBool] = Field(default=None, description="Default value is `false`. Set to true to also generate an API key associated to the new organization.")
     copy_settings: Optional[CreateOrganizationRequestCopySettings] = None
     phone: Optional[StrictStr] = Field(default=None, description="Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).")
+    currency_code: Optional[StrictStr] = Field(default=None, description="Currency code for the new organization. Defaults to the current organization's currency if not provided.")
     created_at: Optional[date] = Field(default=None, description="Timestamp of when the organization has been created. ")
-    __properties: ClassVar[List[str]] = ["id", "name", "website", "with_api_key", "copy_settings", "phone", "created_at"]
+    __properties: ClassVar[List[str]] = ["id", "name", "website", "with_api_key", "copy_settings", "phone", "currency_code", "created_at"]
 
     @field_validator('id')
     def id_validate_regular_expression(cls, value):
@@ -118,6 +119,7 @@ class CreateOrganizationForResponse(BaseModel):
             "with_api_key": obj.get("with_api_key"),
             "copy_settings": CreateOrganizationRequestCopySettings.from_dict(obj["copy_settings"]) if obj.get("copy_settings") is not None else None,
             "phone": obj.get("phone"),
+            "currency_code": obj.get("currency_code"),
             "created_at": obj.get("created_at")
         })
         return _obj

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/create_organization_properties.py

@@ -36,8 +36,9 @@ class CreateOrganizationProperties(BaseModel):
     with_api_key: Optional[StrictBool] = Field(default=None, description="Default value is `false`. Set to true to also generate an API key associated to the new organization.")
     copy_settings: Optional[CreateOrganizationRequestCopySettings] = None
     phone: Optional[StrictStr] = Field(default=None, description="Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).")
+    currency_code: Optional[StrictStr] = Field(default=None, description="Currency code for the new organization. Defaults to the current organization's currency if not provided.")
     created_at: Optional[date] = Field(default=None, description="Timestamp of when the organization has been created. ")
-    __properties: ClassVar[List[str]] = ["id", "name", "website", "with_api_key", "copy_settings", "phone", "created_at"]
+    __properties: ClassVar[List[str]] = ["id", "name", "website", "with_api_key", "copy_settings", "phone", "currency_code", "created_at"]
 
     @field_validator('id')
     def id_validate_regular_expression(cls, value):
@@ -113,6 +114,7 @@ class CreateOrganizationProperties(BaseModel):
             "with_api_key": obj.get("with_api_key"),
             "copy_settings": CreateOrganizationRequestCopySettings.from_dict(obj["copy_settings"]) if obj.get("copy_settings") is not None else None,
             "phone": obj.get("phone"),
+            "currency_code": obj.get("currency_code"),
             "created_at": obj.get("created_at")
         })
         return _obj

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/create_organization_request.py

@@ -33,7 +33,8 @@ class CreateOrganizationRequest(BaseModel):
     with_api_key: StrictBool = Field(description="Default value is `false`. Set to true to also generate an API key associated to the new organization.")
     copy_settings: Optional[CreateOrganizationRequestCopySettings] = None
     phone: Optional[StrictStr] = Field(default=None, description="Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +).")
-    __properties: ClassVar[List[str]] = ["name", "website", "with_api_key", "copy_settings", "phone"]
+    currency_code: Optional[StrictStr] = Field(default=None, description="Currency code for the new organization. Defaults to the current organization's currency if not provided.")
+    __properties: ClassVar[List[str]] = ["name", "website", "with_api_key", "copy_settings", "phone", "currency_code"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -93,7 +94,8 @@ class CreateOrganizationRequest(BaseModel):
             "website": obj.get("website"),
             "with_api_key": obj.get("with_api_key"),
             "copy_settings": CreateOrganizationRequestCopySettings.from_dict(obj["copy_settings"]) if obj.get("copy_settings") is not None else None,
-            "phone": obj.get("phone")
+            "phone": obj.get("phone"),
+            "currency_code": obj.get("currency_code")
         })
         return _obj
 

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/create_topup_request.py

@@ -29,7 +29,7 @@ class CreateTopupRequest(BaseModel):
     """ # noqa: E501
     funding_source_id: StrictStr = Field(description="The ID of the funding source to top up.")
     idempotency_key: StrictStr = Field(description="Unique key that ensures this request is only processed once. ")
-    amount: Union[StrictFloat, StrictInt] = Field(description="Amount in USD intended to be added to your organization’s balance.")
+    amount: Union[StrictFloat, StrictInt] = Field(description="Amount to add to your organization's balance, denominated in `currency_code`.")
     __properties: ClassVar[List[str]] = ["funding_source_id", "idempotency_key", "amount"]
 
     model_config = ConfigDict(

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/fraud_config_redeemed_rewards_amount.py

@@ -28,7 +28,7 @@ class FraudConfigRedeemedRewardsAmount(BaseModel):
     """
     FraudConfigRedeemedRewardsAmount
     """ # noqa: E501
-    amount: Union[Annotated[float, Field(strict=True, ge=1)], Annotated[int, Field(strict=True, ge=1)]] = Field(description="The total amount in USD of redeemed rewards to use as a threshold.")
+    amount: Union[Annotated[float, Field(strict=True, ge=1)], Annotated[int, Field(strict=True, ge=1)]] = Field(description="The total amount of redeemed rewards to use as a threshold. The amount is denominated in the organization's currency.")
     period: StrictStr = Field(description="The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards.")
     __properties: ClassVar[List[str]] = ["amount", "period"]
 

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/fraud_review.py

@@ -21,7 +21,7 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
-from tremendous.models.get_fraud_review200_response_fraud_review_related_rewards import GetFraudReview200ResponseFraudReviewRelatedRewards
+from tremendous.models.fraud_review_related_rewards import FraudReviewRelatedRewards
 from tremendous.models.list_fraud_reviews200_response_fraud_reviews_inner_geo import ListFraudReviews200ResponseFraudReviewsInnerGeo
 from tremendous.models.order_without_link_rewards_inner import OrderWithoutLinkRewardsInner
 from typing import Optional, Set
@@ -42,7 +42,7 @@ class FraudReview(BaseModel):
     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`. ")
     redemption_method_account_hash: Optional[StrictStr] = Field(default=None, description="A hash of the destination account for redemption methods that require providing 3rd party account details (e.g., PayPal, Venmo, ACH/CashApp, international bank transfers, etc.). The hash is globally unique by redemption method + account combination. This field is omitted for redemption methods that don't have a destination account (e.g., merchant cards, charities, etc.). ")
     risk: Optional[StrictStr] = Field(default=None, description="The fraud risk associated with the reward.")
-    related_rewards: Optional[GetFraudReview200ResponseFraudReviewRelatedRewards] = None
+    related_rewards: Optional[FraudReviewRelatedRewards] = None
     __properties: ClassVar[List[str]] = ["status", "reasons", "device_id", "redemption_method", "redeemed_at", "geo", "reward", "reviewed_by", "reviewed_at", "redemption_method_account_hash", "risk", "related_rewards"]
 
     @field_validator('status')
@@ -167,7 +167,7 @@ class FraudReview(BaseModel):
             "reviewed_at": obj.get("reviewed_at"),
             "redemption_method_account_hash": obj.get("redemption_method_account_hash"),
             "risk": obj.get("risk"),
-            "related_rewards": GetFraudReview200ResponseFraudReviewRelatedRewards.from_dict(obj["related_rewards"]) if obj.get("related_rewards") is not None else None
+            "related_rewards": FraudReviewRelatedRewards.from_dict(obj["related_rewards"]) if obj.get("related_rewards") is not None else None
         })
         return _obj
 

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/fraud_review_related_rewards.py

@@ -26,13 +26,14 @@ from typing_extensions import Self
 
 class FraudReviewRelatedRewards(BaseModel):
     """
-    FraudReviewRelatedRewards
+    The related rewards associated with the fraud review.
     """ # noqa: E501
     ids: Optional[List[StrictStr]] = Field(default=None, description="The IDs of rewards that have similar attributes to the fraud reward. A maximum of 100 IDs is returned. ")
     count: Optional[Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="How many related rewards were found in total.")
     blocked_count: Optional[Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="How many related rewards have been blocked.")
-    aggregated_value: Optional[Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="Total amount claimed by the related rewards (in USD).")
-    __properties: ClassVar[List[str]] = ["ids", "count", "blocked_count", "aggregated_value"]
+    aggregated_value: Optional[Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="Total amount claimed by the related rewards, denominated in `currency_code`. ")
+    currency_code: Optional[StrictStr] = Field(default=None, description="Currency of the aggregated value. Always matches the organization's currency.")
+    __properties: ClassVar[List[str]] = ["ids", "count", "blocked_count", "aggregated_value", "currency_code"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -64,8 +65,10 @@ class FraudReviewRelatedRewards(BaseModel):
         * `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([
+            "currency_code",
         ])
 
         _dict = self.model_dump(
@@ -88,7 +91,8 @@ class FraudReviewRelatedRewards(BaseModel):
             "ids": obj.get("ids"),
             "count": obj.get("count"),
             "blocked_count": obj.get("blocked_count"),
-            "aggregated_value": obj.get("aggregated_value")
+            "aggregated_value": obj.get("aggregated_value"),
+            "currency_code": obj.get("currency_code")
         })
         return _obj
 

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/fraud_rule_type.py

@@ -21,7 +21,7 @@ from typing_extensions import Self
 
 class FraudRuleType(str, Enum):
     """
-    * `review_country` - Flags when the recipient's IP country matches the criteria in the rule * `review_ip` - Flags when recipient's IP matches one in the list * `review_email` - Flags when the recipient's email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config * `review_multiple_emails` - Flags when recipient's device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient's IP matches one in the list * `allow_email` - Releases a reward when the recipient's email matches one in the list 
+    * `review_country` - Flags when the recipient's IP country matches the criteria in the rule * `review_ip` - Flags when recipient's IP matches one in the list * `review_email` - Flags when the recipient's email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config. The amount is denominated in the organization's currency. * `review_multiple_emails` - Flags when recipient's device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient's IP matches one in the list * `allow_email` - Releases a reward when the recipient's email matches one in the list 
     """
 
     """

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/fraud_rules_list_item.py

@@ -27,7 +27,7 @@ class FraudRulesListItem(BaseModel):
     """
     An active fraud rule
     """ # noqa: E501
-    rule_type: Optional[StrictStr] = Field(default=None, description="* `review_country` - Flags when the recipient's IP country matches the criteria in the rule * `review_ip` - Flags when recipient's IP matches one in the list * `review_email` - Flags when the recipient's email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config * `review_multiple_emails` - Flags when recipient's device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient's IP matches one in the list * `allow_email` - Releases a reward when the recipient's email matches one in the list ")
+    rule_type: Optional[StrictStr] = Field(default=None, description="* `review_country` - Flags when the recipient's IP country matches the criteria in the rule * `review_ip` - Flags when recipient's IP matches one in the list * `review_email` - Flags when the recipient's email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config. The amount is denominated in the organization's currency. * `review_multiple_emails` - Flags when recipient's device or account has multiple emails associated * `review_vpn` - Flags when VPN is suspected * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient's IP matches one in the list * `allow_email` - Releases a reward when the recipient's email matches one in the list ")
     config: Optional[Dict[str, Any]] = Field(default=None, description="The configuration associated with the rule. The properties allowed depend on the type of rule. This property is only present for rules that require configuration. ")
     __properties: ClassVar[List[str]] = ["rule_type", "config"]
 

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/get_fraud_review200_response_fraud_review_related_rewards.py

@@ -31,8 +31,9 @@ class GetFraudReview200ResponseFraudReviewRelatedRewards(BaseModel):
     ids: Optional[List[StrictStr]] = Field(default=None, description="The IDs of rewards that have similar attributes to the fraud reward. A maximum of 100 IDs is returned. ")
     count: Optional[Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="How many related rewards were found in total.")
     blocked_count: Optional[Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="How many related rewards have been blocked.")
-    aggregated_value: Optional[Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="Total amount claimed by the related rewards (in USD).")
-    __properties: ClassVar[List[str]] = ["ids", "count", "blocked_count", "aggregated_value"]
+    aggregated_value: Optional[Union[Annotated[float, Field(strict=True, ge=0)], Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, description="Total amount claimed by the related rewards, denominated in `currency_code`. ")
+    currency_code: Optional[StrictStr] = Field(default=None, description="Currency of the aggregated value. Always matches the organization's currency.")
+    __properties: ClassVar[List[str]] = ["ids", "count", "blocked_count", "aggregated_value", "currency_code"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -88,7 +89,8 @@ class GetFraudReview200ResponseFraudReviewRelatedRewards(BaseModel):
             "ids": obj.get("ids"),
             "count": obj.get("count"),
             "blocked_count": obj.get("blocked_count"),
-            "aggregated_value": obj.get("aggregated_value")
+            "aggregated_value": obj.get("aggregated_value"),
+            "currency_code": obj.get("currency_code")
         })
         return _obj
 

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/invoice.py

@@ -32,14 +32,25 @@ class Invoice(BaseModel):
     id: StrictStr = Field(description="The invoice number")
     po_number: Optional[StrictStr] = Field(default=None, description="Reference to the purchase order number within your organization")
     amount: Union[StrictFloat, StrictInt] = Field(description="Amount of the invoice")
-    currency: Optional[StrictStr] = Field(default='USD', description="Currency of the invoice")
+    currency_code: Optional[StrictStr] = Field(default=None, description="Currency of the invoice")
+    currency: Optional[StrictStr] = Field(default=None, description="Deprecated: Use `currency_code` instead.")
     international: Optional[StrictBool] = None
     status: StrictStr = Field(description="Status of this invoice  <table>   <thead>     <tr>       <th>Status</th>       <th>Description</th>     </tr>   </thead>   <tbody>     <tr>       <td><code>DELETED</code></td>       <td>Invoice has been deleted by your organization</td>     </tr>     <tr>       <td><code>PAID</code></td>       <td>Invoice has been paid by your organization</td>     </tr>     <tr>       <td><code>OPEN</code></td>       <td>Invoice has been created by your organization but has not been paid, yet</td>     </tr>   </tbody> </table> ")
     orders: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="List of orders related to the invoice (it doesn't apply to prefunding)")
     rewards: Optional[List[Annotated[str, Field(strict=True)]]] = Field(default=None, description="List of rewards related to the invoice (it doesn't apply to prefunding)")
     created_at: datetime = Field(description="Timestamp of when the invoice has been created. ")
     paid_at: Optional[datetime] = Field(description="Timestamp of when the invoice has been paid. ")
-    __properties: ClassVar[List[str]] = ["id", "po_number", "amount", "currency", "international", "status", "orders", "rewards", "created_at", "paid_at"]
+    __properties: ClassVar[List[str]] = ["id", "po_number", "amount", "currency_code", "currency", "international", "status", "orders", "rewards", "created_at", "paid_at"]
+
+    @field_validator('currency_code')
+    def currency_code_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['USD', 'EUR', 'GBP']):
+            raise ValueError("must be one of enum values ('USD', 'EUR', 'GBP')")
+        return value
 
     @field_validator('currency')
     def currency_validate_enum(cls, value):
@@ -122,7 +133,8 @@ class Invoice(BaseModel):
             "id": obj.get("id"),
             "po_number": obj.get("po_number"),
             "amount": obj.get("amount"),
-            "currency": obj.get("currency") if obj.get("currency") is not None else 'USD',
+            "currency_code": obj.get("currency_code"),
+            "currency": obj.get("currency"),
             "international": obj.get("international"),
             "status": obj.get("status"),
             "orders": obj.get("orders"),

{tremendous_python-5.12.0 → tremendous_python-5.14.0}/tremendous/models/list_balance_transactions200_response_transactions_inner.py

@@ -30,12 +30,13 @@ class ListBalanceTransactions200ResponseTransactionsInner(BaseModel):
     A balance transaction represents a specific movement or change in an account's balance. 
     """ # noqa: E501
     created_at: datetime = Field(description="Date that the transaction was created")
-    amount: Union[StrictFloat, StrictInt] = Field(description="Amount of the transaction in USD")
-    balance: Union[StrictFloat, StrictInt] = Field(description="The updated total after the transaction. Note that this running balance may be delayed and contain `null`.")
+    amount: Union[StrictFloat, StrictInt] = Field(description="Amount of the transaction, denominated in `currency_code`.")
+    currency_code: StrictStr = Field(description="Currency of the transaction amount and running balance. Always matches the organization's currency.")
+    balance: Union[StrictFloat, StrictInt] = Field(description="The updated total after the transaction, denominated in `currency_code`. 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")
     order: Optional[ListBalanceTransactions200ResponseTransactionsInnerOrder] = None
-    __properties: ClassVar[List[str]] = ["created_at", "amount", "balance", "action", "description", "order"]
+    __properties: ClassVar[List[str]] = ["created_at", "amount", "currency_code", "balance", "action", "description", "order"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -93,6 +94,7 @@ class ListBalanceTransactions200ResponseTransactionsInner(BaseModel):
         _obj = cls.model_validate({
             "created_at": obj.get("created_at"),
             "amount": obj.get("amount"),
+            "currency_code": obj.get("currency_code"),
             "balance": obj.get("balance"),
             "action": obj.get("action"),
             "description": obj.get("description"),