tremendous-python 3.2.0__tar.gz → 4.0.0__tar.gz

{tremendous_python-3.2.0 → tremendous_python-4.0.0}/PKG-INFO

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

{tremendous_python-3.2.0 → tremendous_python-4.0.0}/README.md

@@ -3,7 +3,7 @@
 A Python client library for the [Tremendous API][docs].
 
 > [!NOTE]
-> This branch includes the v3 version of the Tremendous Python client, a new version based
+> This branch includes the v4 version of the Tremendous Python client, a new version based
 > on our [API schema][ref] docs. If you are using the v2 versions, please check our
 > [`UPGRADING`](UPGRADING.md) guide
 
@@ -35,26 +35,29 @@ client = TremendousApi(api)
 Submitting an order:
 
 ```py
-from tremendous import CreateOrderRequest
+from tremendous import CreateOrderRequest, SingleRewardOrder
 
 request = CreateOrderRequest(
-  payment = {
-    "funding_source_id": "balance"
-  },
-  reward = {
-    "campaign_id": "CAMPAIGN_ID",
-    "delivery": {
-        "method": "EMAIL"
+  SingleRewardOrder(
+    payment = {
+      "funding_source_id": "balance"
     },
-    "recipient": {
-      "email": "sarah@tremendous.com",
-      "name": "Sarah Smith"
-    },
-    "value": {
-        "denomination": 20,
-        "currency_code": "USD"
+    reward = {
+      "campaign_id": "CAMPAIGN_ID",
+      "delivery": {
+          "method": "EMAIL"
+      },
+      "recipient": {
+        "email": "sarah@tremendous.com",
+        "name": "Sarah Smith"
+      },
+      "value": {
+          "denomination": 20,
+          "currency_code": "USD"
+      }
     }
-  })
+  )
+)
 
 response = client.create_order(request)
 print("Order created! ID: %s" % response.order.id)

{tremendous_python-3.2.0 → tremendous_python-4.0.0}/pyproject.toml

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

tremendous_python-4.0.0/test/test_orders.py

@@ -0,0 +1,85 @@
+import json
+import os
+
+import pytest
+from tremendous import Configuration, ApiClient, TremendousApi, CreateOrderRequest, SingleRewardOrder
+from tremendous.exceptions import BadRequestException
+
+CAMPAIGN_ID = os.environ["TEST_CAMPAIGN_ID"]
+RECIPIENT_EMAIL = os.environ["TEST_RECIPIENT_EMAIL"]
+
+class TestOrders:
+  configuration = Configuration(
+     server_index=Configuration.Environment["testflight"],
+      access_token = os.environ["SANDBOX_API_TOKEN"]
+  )
+
+  api = ApiClient(configuration)
+  client = TremendousApi(api)
+
+  def test_list_orders(self):
+    orders = self.client.list_orders().orders
+
+    assert len(orders) > 0
+
+    for order in orders[:10]:
+        assert hasattr(order, "id")
+        assert hasattr(order, "created_at")
+        assert hasattr(order, "payment")
+
+  def test_submit_order(self):
+    request = CreateOrderRequest(
+      SingleRewardOrder(
+        payment = {
+          "funding_source_id": "balance"
+        },
+        reward = {
+          "campaign_id": CAMPAIGN_ID,
+          "delivery": {
+              "method": "EMAIL"
+          },
+          "recipient": {
+              "name": "Recipient Name",
+              "email": RECIPIENT_EMAIL
+          },
+          "value": {
+              "denomination": 5.0,
+              "currency_code": "USD"
+          }
+        })
+      )
+
+    data = self.client.create_order(request)
+
+    assert data.order.id != None
+    assert data.order.campaign_id == CAMPAIGN_ID
+    assert data.order.status == "EXECUTED"
+
+  def test_raise_validation_errors(self):
+    with pytest.raises(BadRequestException) as e_info:
+      request = CreateOrderRequest(
+        SingleRewardOrder(
+          payment = {
+            "funding_source_id": "NOT A VALID FUNDING SOURCE ID"
+          },
+          reward = {
+            "campaign_id": CAMPAIGN_ID,
+            "delivery": {
+                "method": "EMAIL"
+            },
+            "recipient": {
+                "name": "Recipient Name",
+                "email": RECIPIENT_EMAIL
+            },
+            "value": {
+                "denomination": 5.0,
+                "currency_code": "USD"
+            }
+          })
+        )
+
+      self.client.create_order(request)
+
+    response = json.loads(e_info.value.body)
+    assert "message" in response["errors"]
+    assert "payload" in response["errors"]

{tremendous_python-3.2.0 → tremendous_python-4.0.0}/tremendous/__init__.py

@@ -32,51 +32,72 @@ from tremendous.exceptions import ApiAttributeError
 from tremendous.exceptions import ApiException
 
 # import models into sdk package
+from tremendous.models.allow_email import AllowEmail
+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.base_order_for_create import BaseOrderForCreate
 from tremendous.models.campaign import Campaign
 from tremendous.models.campaign_base import CampaignBase
+from tremendous.models.channel import Channel
 from tremendous.models.create_api_key200_response import CreateApiKey200Response
 from tremendous.models.create_campaign201_response import CreateCampaign201Response
 from tremendous.models.create_campaign_request import CreateCampaignRequest
-from tremendous.models.create_invoice import CreateInvoice
 from tremendous.models.create_invoice200_response import CreateInvoice200Response
 from tremendous.models.create_invoice_request import CreateInvoiceRequest
 from tremendous.models.create_member import CreateMember
 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_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_order_request_payment import CreateOrderRequestPayment
-from tremendous.models.create_order_request_reward import CreateOrderRequestReward
-from tremendous.models.create_order_request_reward_custom_fields_inner import CreateOrderRequestRewardCustomFieldsInner
-from tremendous.models.create_order_request_reward_delivery import CreateOrderRequestRewardDelivery
 from tremendous.models.create_organization import CreateOrganization
 from tremendous.models.create_organization200_response import CreateOrganization200Response
 from tremendous.models.create_organization200_response_organization import CreateOrganization200ResponseOrganization
 from tremendous.models.create_organization_request import CreateOrganizationRequest
 from tremendous.models.create_organization_request_copy_settings import CreateOrganizationRequestCopySettings
 from tremendous.models.create_public_key import CreatePublicKey
-from tremendous.models.create_public_key200_response import CreatePublicKey200Response
-from tremendous.models.create_public_key_request import CreatePublicKeyRequest
 from tremendous.models.create_webhook200_response import CreateWebhook200Response
 from tremendous.models.create_webhook_request import CreateWebhookRequest
 from tremendous.models.currency_codes import CurrencyCodes
 from tremendous.models.custom_field import CustomField
+from tremendous.models.delete_fraud_rule200_response import DeleteFraudRule200Response
 from tremendous.models.delivery_details import DeliveryDetails
-from tremendous.models.delivery_details_with_link import DeliveryDetailsWithLink
 from tremendous.models.delivery_method import DeliveryMethod
 from tremendous.models.delivery_status import DeliveryStatus
 from tremendous.models.error_model import ErrorModel
+from tremendous.models.fraud_config_allow_email import FraudConfigAllowEmail
+from tremendous.models.fraud_config_country import FraudConfigCountry
+from tremendous.models.fraud_config_country_update_list import FraudConfigCountryUpdateList
+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_generic_response import FraudGenericResponse
+from tremendous.models.fraud_review import FraudReview
+from tremendous.models.fraud_review_geo import FraudReviewGeo
+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_status import FraudReviewStatus
+from tremendous.models.fraud_rule200_response import FraudRule200Response
+from tremendous.models.fraud_rule400_response import FraudRule400Response
+from tremendous.models.fraud_rule422_response import FraudRule422Response
+from tremendous.models.fraud_rule_request import FraudRuleRequest
+from tremendous.models.fraud_rule_request_config import FraudRuleRequestConfig
+from tremendous.models.fraud_rule_type import FraudRuleType
+from tremendous.models.fraud_rules_list_item import FraudRulesListItem
 from tremendous.models.funding_source import FundingSource
 from tremendous.models.generate_reward_link200_response import GenerateRewardLink200Response
 from tremendous.models.generate_reward_link200_response_reward import GenerateRewardLink200ResponseReward
 from tremendous.models.generate_reward_link403_response import GenerateRewardLink403Response
 from tremendous.models.generate_reward_token200_response import GenerateRewardToken200Response
 from tremendous.models.generate_reward_token200_response_reward import GenerateRewardToken200ResponseReward
+from tremendous.models.get_fraud_review200_response import GetFraudReview200Response
+from tremendous.models.get_fraud_review200_response_fraud_review import GetFraudReview200ResponseFraudReview
+from tremendous.models.get_fraud_review200_response_fraud_review_geo import GetFraudReview200ResponseFraudReviewGeo
+from tremendous.models.get_fraud_review200_response_fraud_review_related_rewards import GetFraudReview200ResponseFraudReviewRelatedRewards
 from tremendous.models.get_funding_source200_response import GetFundingSource200Response
 from tremendous.models.get_member200_response import GetMember200Response
 from tremendous.models.get_member200_response_member import GetMember200ResponseMember
@@ -86,7 +107,7 @@ 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_invoices_inner import ListBalanceTransactions200ResponseInvoicesInner
+from tremendous.models.list_balance_transactions200_response_transactions_inner import ListBalanceTransactions200ResponseTransactionsInner
 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
@@ -94,6 +115,10 @@ from tremendous.models.list_campaigns200_response_campaigns_inner_webpage_style
 from tremendous.models.list_fields200_response import ListFields200Response
 from tremendous.models.list_fields200_response_fields_inner import ListFields200ResponseFieldsInner
 from tremendous.models.list_forex_response import ListForexResponse
+from tremendous.models.list_fraud_reviews200_response import ListFraudReviews200Response
+from tremendous.models.list_fraud_reviews200_response_fraud_reviews_inner import ListFraudReviews200ResponseFraudReviewsInner
+from tremendous.models.list_fraud_rules200_response import ListFraudRules200Response
+from tremendous.models.list_fraud_rules200_response_fraud_rules_inner import ListFraudRules200ResponseFraudRulesInner
 from tremendous.models.list_funding_sources200_response import ListFundingSources200Response
 from tremendous.models.list_funding_sources200_response_funding_sources_inner import ListFundingSources200ResponseFundingSourcesInner
 from tremendous.models.list_funding_sources200_response_funding_sources_inner_meta import ListFundingSources200ResponseFundingSourcesInnerMeta
@@ -134,23 +159,25 @@ from tremendous.models.model_field import ModelField
 from tremendous.models.order import Order
 from tremendous.models.order_base import OrderBase
 from tremendous.models.order_base_payment import OrderBasePayment
-from tremendous.models.order_for_create import OrderForCreate
-from tremendous.models.order_for_create_reward import OrderForCreateReward
 from tremendous.models.order_status import OrderStatus
-from tremendous.models.order_with_link import OrderWithLink
-from tremendous.models.order_with_link_rewards_inner import OrderWithLinkRewardsInner
 from tremendous.models.order_without_link import OrderWithoutLink
-from tremendous.models.order_without_link_reward import OrderWithoutLinkReward
+from tremendous.models.order_without_link_rewards_inner import OrderWithoutLinkRewardsInner
 from tremendous.models.organization import Organization
 from tremendous.models.payment_details import PaymentDetails
 from tremendous.models.payment_details_refund import PaymentDetailsRefund
 from tremendous.models.product import Product
 from tremendous.models.public_key import PublicKey
-from tremendous.models.public_keys_response import PublicKeysResponse
-from tremendous.models.public_keys_response_public_keys_inner import PublicKeysResponsePublicKeysInner
 from tremendous.models.recipient import Recipient
 from tremendous.models.refund_details import RefundDetails
 from tremendous.models.resend_reward422_response import ResendReward422Response
+from tremendous.models.review_country import ReviewCountry
+from tremendous.models.review_country1 import ReviewCountry1
+from tremendous.models.review_email import ReviewEmail
+from tremendous.models.review_email1 import ReviewEmail1
+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.reward import Reward
 from tremendous.models.reward_base import RewardBase
 from tremendous.models.reward_base_custom_fields_inner import RewardBaseCustomFieldsInner
@@ -158,15 +185,22 @@ from tremendous.models.reward_for_order_create import RewardForOrderCreate
 from tremendous.models.reward_link import RewardLink
 from tremendous.models.reward_token import RewardToken
 from tremendous.models.reward_value import RewardValue
-from tremendous.models.reward_with_link import RewardWithLink
-from tremendous.models.reward_with_link_delivery import RewardWithLinkDelivery
 from tremendous.models.reward_without_link import RewardWithoutLink
 from tremendous.models.reward_without_link_delivery import RewardWithoutLinkDelivery
 from tremendous.models.role import Role
 from tremendous.models.simulate_webhook_request import SimulateWebhookRequest
+from tremendous.models.single_reward_order import SingleRewardOrder
+from tremendous.models.single_reward_order_payment import SingleRewardOrderPayment
+from tremendous.models.single_reward_order_reward import SingleRewardOrderReward
+from tremendous.models.single_reward_order_reward_custom_fields_inner import SingleRewardOrderRewardCustomFieldsInner
+from tremendous.models.single_reward_order_reward_delivery import SingleRewardOrderRewardDelivery
+from tremendous.models.single_reward_order_without_link import SingleRewardOrderWithoutLink
+from tremendous.models.single_reward_order_without_link_order import SingleRewardOrderWithoutLinkOrder
 from tremendous.models.test_public_key import TestPublicKey
-from tremendous.models.test_public_key_request import TestPublicKeyRequest
 from tremendous.models.update_campaign import UpdateCampaign
 from tremendous.models.update_campaign_request import UpdateCampaignRequest
+from tremendous.models.update_fraud_rule_list200_response import UpdateFraudRuleList200Response
+from tremendous.models.update_fraud_rule_list_request import UpdateFraudRuleListRequest
+from tremendous.models.update_fraud_rule_list_request_config import UpdateFraudRuleListRequestConfig
 from tremendous.models.webhook import Webhook
 from tremendous.models.webhook_post import WebhookPost