tremendous-python 6.0.0__py3-none-any.whl → 7.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. tremendous/api/tremendous_api.py +9 -9
  2. tremendous/models/balance_transaction.py +3 -1
  3. tremendous/models/create_order200_response_order_rewards_inner.py +1 -1
  4. tremendous/models/currency_codes.py +0 -1
  5. tremendous/models/fraud_review.py +1 -1
  6. tremendous/models/fraud_review_base.py +1 -1
  7. tremendous/models/fraud_review_list_item.py +1 -1
  8. tremendous/models/fraud_review_reason.py +5 -0
  9. tremendous/models/fraud_review_redemption_method.py +4 -0
  10. tremendous/models/get_fraud_review200_response_fraud_review.py +1 -1
  11. tremendous/models/list_balance_transactions200_response_transactions_inner.py +3 -1
  12. tremendous/models/list_fraud_reviews200_response_fraud_reviews_inner.py +1 -1
  13. tremendous/models/list_funding_sources200_response_funding_sources_inner_meta_failure_details.py +10 -0
  14. tremendous/models/list_products_response_products_inner.py +1 -1
  15. tremendous/models/list_rewards200_response_rewards_inner.py +1 -1
  16. tremendous/models/order_with_link_rewards_inner.py +1 -1
  17. tremendous/models/product.py +1 -1
  18. tremendous/models/reward.py +1 -1
  19. tremendous/models/reward_base.py +1 -1
  20. tremendous/models/reward_for_order_create.py +1 -1
  21. tremendous/models/reward_response_reward.py +1 -1
  22. tremendous/models/reward_with_link.py +1 -1
  23. tremendous/models/reward_without_link.py +1 -1
  24. tremendous/models/single_reward_order_reward.py +1 -1
  25. tremendous/version.py +1 -1
  26. {tremendous_python-6.0.0.dist-info → tremendous_python-7.0.0.dist-info}/METADATA +1 -1
  27. {tremendous_python-6.0.0.dist-info → tremendous_python-7.0.0.dist-info}/RECORD +30 -30
  28. {tremendous_python-6.0.0.dist-info → tremendous_python-7.0.0.dist-info}/WHEEL +1 -1
  29. {tremendous_python-6.0.0.dist-info → tremendous_python-7.0.0.dist-info}/licenses/LICENSE +0 -0
  30. {tremendous_python-6.0.0.dist-info → tremendous_python-7.0.0.dist-info}/top_level.txt +0 -0
@@ -3251,7 +3251,7 @@ class TremendousApi:
3251
3251
  ) -> CreateOrder200Response:
3252
3252
  """Create order
3253
3253
 
3254
- Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order.</p> <p>You can also pass one of the following magic values (case-insensitive):</p> <ul> <li><code>BALANCE</code> — pay from your Tremendous balance.</li> <li><code>INVOICE</code> — pay from your commercial invoice account.</li> <li><code>INVOICE_THEN_BALANCE</code> — pay from your commercial invoice account if doing so wouldn&#39;t exceed your credit limit, otherwise fall back to your Tremendous balance. The balance must have sufficient funds to pay for the order.</li> </ul> <p><strong>Note:</strong> <code>INVOICE</code> and <code>INVOICE_THEN_BALANCE</code> are only available to select Enterprise clients with an existing commercial invoicing setup. If your organization already uses commercial invoicing and you have questions, contact your Customer Success Manager.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward. Defaults to the organization&#39;s currency if not provided.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $100,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it's recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with an already existing `external_id` will not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
3254
+ Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order.</p> <p>You can also pass one of the following magic values (case-insensitive):</p> <ul> <li><code>BALANCE</code> — pay from your Tremendous balance.</li> <li><code>INVOICE</code> — pay from your commercial invoice account.</li> <li><code>INVOICE_THEN_BALANCE</code> — pay from your commercial invoice account if doing so wouldn&#39;t exceed your credit limit, otherwise fall back to your Tremendous balance. The balance must have sufficient funds to pay for the order.</li> </ul> <p><strong>Note:</strong> <code>INVOICE</code> and <code>INVOICE_THEN_BALANCE</code> are only available to select Enterprise clients with an existing commercial invoicing setup. If your organization already uses commercial invoicing and you have questions, contact your Customer Success Manager.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward. Defaults to the organization&#39;s currency if not provided.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization&#39;s time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $100,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it's recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with the `external_id` of a submitted order will not create a new order, including while its card payment is still processing. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource. ### Pending card payments If the card processor's outcome is still unknown, the order remains `OPEN` and rewards remain unsent while the payment is reconciled. Repeating an equivalent request with the same `external_id` returns `201` with the existing order; a conflicting request returns `409`. An unknown outcome does not permit a new charge.
3255
3255
 
3256
3256
  :param create_order_request: Order to create (required)
3257
3257
  :type create_order_request: CreateOrderRequest
@@ -3326,7 +3326,7 @@ class TremendousApi:
3326
3326
  ) -> ApiResponse[CreateOrder200Response]:
3327
3327
  """Create order
3328
3328
 
3329
- Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order.</p> <p>You can also pass one of the following magic values (case-insensitive):</p> <ul> <li><code>BALANCE</code> — pay from your Tremendous balance.</li> <li><code>INVOICE</code> — pay from your commercial invoice account.</li> <li><code>INVOICE_THEN_BALANCE</code> — pay from your commercial invoice account if doing so wouldn&#39;t exceed your credit limit, otherwise fall back to your Tremendous balance. The balance must have sufficient funds to pay for the order.</li> </ul> <p><strong>Note:</strong> <code>INVOICE</code> and <code>INVOICE_THEN_BALANCE</code> are only available to select Enterprise clients with an existing commercial invoicing setup. If your organization already uses commercial invoicing and you have questions, contact your Customer Success Manager.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward. Defaults to the organization&#39;s currency if not provided.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $100,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it's recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with an already existing `external_id` will not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
3329
+ Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order.</p> <p>You can also pass one of the following magic values (case-insensitive):</p> <ul> <li><code>BALANCE</code> — pay from your Tremendous balance.</li> <li><code>INVOICE</code> — pay from your commercial invoice account.</li> <li><code>INVOICE_THEN_BALANCE</code> — pay from your commercial invoice account if doing so wouldn&#39;t exceed your credit limit, otherwise fall back to your Tremendous balance. The balance must have sufficient funds to pay for the order.</li> </ul> <p><strong>Note:</strong> <code>INVOICE</code> and <code>INVOICE_THEN_BALANCE</code> are only available to select Enterprise clients with an existing commercial invoicing setup. If your organization already uses commercial invoicing and you have questions, contact your Customer Success Manager.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward. Defaults to the organization&#39;s currency if not provided.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization&#39;s time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $100,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it's recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with the `external_id` of a submitted order will not create a new order, including while its card payment is still processing. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource. ### Pending card payments If the card processor's outcome is still unknown, the order remains `OPEN` and rewards remain unsent while the payment is reconciled. Repeating an equivalent request with the same `external_id` returns `201` with the existing order; a conflicting request returns `409`. An unknown outcome does not permit a new charge.
3330
3330
 
3331
3331
  :param create_order_request: Order to create (required)
3332
3332
  :type create_order_request: CreateOrderRequest
@@ -3401,7 +3401,7 @@ class TremendousApi:
3401
3401
  ) -> RESTResponseType:
3402
3402
  """Create order
3403
3403
 
3404
- Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order.</p> <p>You can also pass one of the following magic values (case-insensitive):</p> <ul> <li><code>BALANCE</code> — pay from your Tremendous balance.</li> <li><code>INVOICE</code> — pay from your commercial invoice account.</li> <li><code>INVOICE_THEN_BALANCE</code> — pay from your commercial invoice account if doing so wouldn&#39;t exceed your credit limit, otherwise fall back to your Tremendous balance. The balance must have sufficient funds to pay for the order.</li> </ul> <p><strong>Note:</strong> <code>INVOICE</code> and <code>INVOICE_THEN_BALANCE</code> are only available to select Enterprise clients with an existing commercial invoicing setup. If your organization already uses commercial invoicing and you have questions, contact your Customer Success Manager.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward. Defaults to the organization&#39;s currency if not provided.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $100,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it's recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with an already existing `external_id` will not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource.
3404
+ Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > <strong><a style=\"display: block; margin-top: 20px;\" href=\"/docs/sending-rewards-intro\">Check it out!</a></strong> ## Request body <div class=\"object-schema-request-schema\"> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">external_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Reference for this order, supplied by the customer.</p> <p>When set, <code>external_id</code> makes order idempotent. All requests that use the same <code>external_id</code> after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a <code>201</code> response code. These responses <strong>fail</strong> to create any further orders.</p> <p>It also allows for retrieving by <code>external_id</code> instead of <code>id</code> only.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">payment</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">funding_source_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the funding source that will be used to pay for the order.</p> <p>You can also pass one of the following magic values (case-insensitive):</p> <ul> <li><code>BALANCE</code> — pay from your Tremendous balance.</li> <li><code>INVOICE</code> — pay from your commercial invoice account.</li> <li><code>INVOICE_THEN_BALANCE</code> — pay from your commercial invoice account if doing so wouldn&#39;t exceed your credit limit, otherwise fall back to your Tremendous balance. The balance must have sufficient funds to pay for the order.</li> </ul> <p><strong>Note:</strong> <code>INVOICE</code> and <code>INVOICE_THEN_BALANCE</code> are only available to select Enterprise clients with an existing commercial invoicing setup. If your organization already uses commercial invoicing and you have questions, contact your Customer Success Manager.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">reward</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>A single reward, sent to a recipient. A reward is always part of an order.</p> <p>Either <code>products</code> or <code>campaign_id</code> must be specified.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the reward</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">order_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the order this reward is part of.</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">created_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Date the reward was created</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">expires_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date-time</span></td><td><p>Expiration date of the reward. If null, the reward does not expire.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">campaign_id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.</p> </td></tr> <tr class=\"property-conditional-hint-request-only\"><td><div class=\"property-name\"> <code class=\"property-name\">products</code> </div> </td><td><span class=\"property-type\">array</span> <span class=\"property-format\">string</span></td><td><p>List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.</p> <p>Providing a <code>products</code> array will override the products made available by the campaign specified using the <code>campaign_id</code> property unless the <code>products</code> array is empty. It will <em>not</em> override other campaign attributes, like the message and customization of the look and feel.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">object</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">denomination</code> </div> </td><td><span class=\"property-type\">number</span> <span class=\"property-format\">double</span></td><td><p>Amount of the reward</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">currency_code</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Currency of the reward. Defaults to the organization&#39;s currency if not provided.</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">recipient</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details of the recipient of the reward</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Name of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">email</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Email address of the recipient</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">phone</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">deliver_at</code> </div> </td><td><span class=\"property-type\">string</span> <span class=\"property-format\">date</span></td><td><p>Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization&#39;s time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">custom_fields</code> </div> </td><td><span class=\"property-type\">array</span></td><td></td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show array item type</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">id</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Tremendous ID of the custom field</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">value</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Value of the custom field</p> </td></tr> <tr class=\"property-conditional-hint-response-only\"><td><div class=\"property-name\"> <code class=\"property-name\">label</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Label of the custom field</p> </td></tr> </tbody> </table> </tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">language</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>Set this to translate the redemption experience for this reward. Pass a 2-letter <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO-639-1 code</a> for the desired language. Defaults to <code>en</code>.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">delivery</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Details on how the reward is delivered to the recipient.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">method</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>How to deliver the reward to the recipient.</p> <table> <thead> <tr> <th>Delivery Method</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>EMAIL</code></td> <td>Deliver the reward to the recipient by email</td> </tr> <tr> <td><code>LINK</code></td> <td> <p>Deliver the reward to the recipient via a link.</p> <p>The initial <code>POST /orders</code> response for a link reward includes the link in <code>delivery.link</code>.</p> <p>The link must then be delivered to the recipient out-of-band.</p> <p>To obtain a new link for an existing reward, call <code>POST /rewards/{id}/generate_link</code>.</p> </td> </tr> <tr> <td><code>PHONE</code></td> <td>Deliver the reward to the recipient by SMS</td> </tr> </tbody> </table> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">meta</code> </div> </td><td><span class=\"property-type\">object</span></td><td><p>Customizable reward delivery metadata, taking precedence over the related campaign settings.</p> </td></tr> <tr> <td colspan=\"3\"> <details> <summary>Show object properties</summary> <table> <thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class=\"object-schema-table-body\"> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">sender_name</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The &quot;sender name&quot; used in the delivery. If it&#39;s an email reward, &quot;via Tremendous&quot; will be appended to the value. Please note that you cannot customize the sender email.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">subject_line</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The subject line used in the delivery.</p> </td></tr> <tr class=\"\"><td><div class=\"property-name\"> <code class=\"property-name\">message</code> </div> </td><td><span class=\"property-type\">string</span></td><td><p>The content of the message of the reward, shown in the email / SMS and on the landing page.</p> </td></tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </tr> </tbody> </table> </div> ### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $100,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it's recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with the `external_id` of a submitted order will not create a new order, including while its card payment is still processing. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource. ### Pending card payments If the card processor's outcome is still unknown, the order remains `OPEN` and rewards remain unsent while the payment is reconciled. Repeating an equivalent request with the same `external_id` returns `201` with the existing order; a conflicting request returns `409`. An unknown outcome does not permit a new charge.
3405
3405
 
3406
3406
  :param create_order_request: Order to create (required)
3407
3407
  :type create_order_request: CreateOrderRequest
@@ -9369,7 +9369,7 @@ class TremendousApi:
9369
9369
  @validate_call
9370
9370
  def get_order(
9371
9371
  self,
9372
- id: Annotated[StrictStr, Field(description="ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it's possible to use it instead. ")],
9372
+ id: Annotated[StrictStr, Field(description="ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it's possible to use it instead. When several attempts share an external ID, the submitted order takes precedence; otherwise, the most recent attempt is returned. Use an order's own ID to retrieve a specific failed or canceled attempt. ")],
9373
9373
  _request_timeout: Union[
9374
9374
  None,
9375
9375
  Annotated[StrictFloat, Field(gt=0)],
@@ -9387,7 +9387,7 @@ class TremendousApi:
9387
9387
 
9388
9388
  Retrieve the order, identified by the given `id` in the URL
9389
9389
 
9390
- :param id: ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it's possible to use it instead. (required)
9390
+ :param id: ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it's possible to use it instead. When several attempts share an external ID, the submitted order takes precedence; otherwise, the most recent attempt is returned. Use an order's own ID to retrieve a specific failed or canceled attempt. (required)
9391
9391
  :type id: str
9392
9392
  :param _request_timeout: timeout setting for this request. If one
9393
9393
  number provided, it will be total request
@@ -9440,7 +9440,7 @@ class TremendousApi:
9440
9440
  @validate_call
9441
9441
  def get_order_with_http_info(
9442
9442
  self,
9443
- id: Annotated[StrictStr, Field(description="ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it's possible to use it instead. ")],
9443
+ id: Annotated[StrictStr, Field(description="ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it's possible to use it instead. When several attempts share an external ID, the submitted order takes precedence; otherwise, the most recent attempt is returned. Use an order's own ID to retrieve a specific failed or canceled attempt. ")],
9444
9444
  _request_timeout: Union[
9445
9445
  None,
9446
9446
  Annotated[StrictFloat, Field(gt=0)],
@@ -9458,7 +9458,7 @@ class TremendousApi:
9458
9458
 
9459
9459
  Retrieve the order, identified by the given `id` in the URL
9460
9460
 
9461
- :param id: ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it's possible to use it instead. (required)
9461
+ :param id: ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it's possible to use it instead. When several attempts share an external ID, the submitted order takes precedence; otherwise, the most recent attempt is returned. Use an order's own ID to retrieve a specific failed or canceled attempt. (required)
9462
9462
  :type id: str
9463
9463
  :param _request_timeout: timeout setting for this request. If one
9464
9464
  number provided, it will be total request
@@ -9511,7 +9511,7 @@ class TremendousApi:
9511
9511
  @validate_call
9512
9512
  def get_order_without_preload_content(
9513
9513
  self,
9514
- id: Annotated[StrictStr, Field(description="ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it's possible to use it instead. ")],
9514
+ id: Annotated[StrictStr, Field(description="ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it's possible to use it instead. When several attempts share an external ID, the submitted order takes precedence; otherwise, the most recent attempt is returned. Use an order's own ID to retrieve a specific failed or canceled attempt. ")],
9515
9515
  _request_timeout: Union[
9516
9516
  None,
9517
9517
  Annotated[StrictFloat, Field(gt=0)],
@@ -9529,7 +9529,7 @@ class TremendousApi:
9529
9529
 
9530
9530
  Retrieve the order, identified by the given `id` in the URL
9531
9531
 
9532
- :param id: ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it's possible to use it instead. (required)
9532
+ :param id: ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it's possible to use it instead. When several attempts share an external ID, the submitted order takes precedence; otherwise, the most recent attempt is returned. Use an order's own ID to retrieve a specific failed or canceled attempt. (required)
9533
9533
  :type id: str
9534
9534
  :param _request_timeout: timeout setting for this request. If one
9535
9535
  number provided, it will be total request
@@ -36,8 +36,9 @@ class BalanceTransaction(BaseModel):
36
36
  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`.", json_schema_extra={"examples": [92.48]})
37
37
  action: StrictStr = Field(description="The action that was performed", json_schema_extra={"examples": ["Deposit"]})
38
38
  description: StrictStr = Field(description="A brief description of the transaction")
39
+ payment_id: Optional[StrictStr] = Field(default=None, description="ID of the payment behind the transaction, shown as \"Payment ID\" in the dashboard's balance transactions export and as \"Prefund confirmation\" on deposit receipts. Use it to match deposits, including auto-reloads, against your bank or card statements. Only present on transactions tied to a payment into your balance, such as deposits, the credit recorded when an order is paid by card or bank transfer, and transfers between organizations. Omitted otherwise, for example on the debit for an order paid from your balance. ", json_schema_extra={"examples": ["PAYMENTID123"]})
39
40
  order: Optional[BalanceTransactionOrder] = None
40
- __properties: ClassVar[List[str]] = ["created_at", "amount", "currency_code", "balance", "action", "description", "order"]
41
+ __properties: ClassVar[List[str]] = ["created_at", "amount", "currency_code", "balance", "action", "description", "payment_id", "order"]
41
42
 
42
43
  model_config = ConfigDict(
43
44
  validate_by_name=True,
@@ -99,6 +100,7 @@ class BalanceTransaction(BaseModel):
99
100
  "balance": obj.get("balance"),
100
101
  "action": obj.get("action"),
101
102
  "description": obj.get("description"),
103
+ "payment_id": obj.get("payment_id"),
102
104
  "order": BalanceTransactionOrder.from_dict(obj["order"]) if obj.get("order") is not None else None
103
105
  })
104
106
  return _obj
@@ -40,7 +40,7 @@ class CreateOrder200ResponseOrderRewardsInner(BaseModel):
40
40
  expires_at: Optional[datetime] = Field(default=None, description="Expiration date of the reward. If null, the reward does not expire.")
41
41
  value: Optional[ListRewards200ResponseRewardsInnerValue] = None
42
42
  recipient: Optional[ListRewards200ResponseRewardsInnerRecipient] = None
43
- deliver_at: Optional[date] = Field(default=None, description="Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
43
+ deliver_at: Optional[date] = Field(default=None, description="Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization's time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
44
44
  custom_fields: Optional[List[ListRewards200ResponseRewardsInnerCustomFieldsInner]] = None
45
45
  delivery: Optional[CreateOrder200ResponseOrderRewardsInnerDelivery] = None
46
46
  __properties: ClassVar[List[str]] = ["id", "order_id", "created_at", "expires_at", "value", "recipient", "deliver_at", "custom_fields", "delivery"]
@@ -69,7 +69,6 @@ class CurrencyCodes(str, Enum):
69
69
  GTQ = 'GTQ'
70
70
  HKD = 'HKD'
71
71
  HNL = 'HNL'
72
- HRK = 'HRK'
73
72
  HUF = 'HUF'
74
73
  IDR = 'IDR'
75
74
  ILS = 'ILS'
@@ -33,7 +33,7 @@ class FraudReview(BaseModel):
33
33
  The fraud review associated with a reward.
34
34
  """ # noqa: E501
35
35
  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. ")
36
- reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
36
+ reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP on a Tremendous allow list` * `Bank account on a Tremendous allow list` * `Email on a Tremendous allow list` * `Phone on a Tremendous allow list` * `Device on a Tremendous allow list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
37
37
  device_id: Optional[StrictStr] = Field(default=None, description="The device fingerprint, if known.")
38
38
  redemption_method: Optional[StrictStr] = Field(default=None, description="The product selected to claim the reward")
39
39
  redeemed_at: Optional[datetime] = Field(default=None, description="Date the reward was redeemed")
@@ -32,7 +32,7 @@ class FraudReviewBase(BaseModel):
32
32
  The fraud review associated with a reward.
33
33
  """ # noqa: E501
34
34
  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. ")
35
- reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
35
+ reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP on a Tremendous allow list` * `Bank account on a Tremendous allow list` * `Email on a Tremendous allow list` * `Phone on a Tremendous allow list` * `Device on a Tremendous allow list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
36
36
  device_id: Optional[StrictStr] = Field(default=None, description="The device fingerprint, if known.")
37
37
  redemption_method: Optional[StrictStr] = Field(default=None, description="The product selected to claim the reward")
38
38
  redeemed_at: Optional[datetime] = Field(default=None, description="Date the reward was redeemed")
@@ -32,7 +32,7 @@ class FraudReviewListItem(BaseModel):
32
32
  The fraud review associated with a reward.
33
33
  """ # noqa: E501
34
34
  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. ")
35
- reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
35
+ reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP on a Tremendous allow list` * `Bank account on a Tremendous allow list` * `Email on a Tremendous allow list` * `Phone on a Tremendous allow list` * `Device on a Tremendous allow list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
36
36
  device_id: Optional[StrictStr] = Field(default=None, description="The device fingerprint, if known.")
37
37
  redemption_method: Optional[StrictStr] = Field(default=None, description="The product selected to claim the reward")
38
38
  redeemed_at: Optional[datetime] = Field(default=None, description="Date the reward was redeemed")
@@ -42,6 +42,11 @@ class FraudReviewReason(str, Enum):
42
42
  EMAIL_ON_A_TREMENDOUS_FRAUD_LIST = 'Email on a Tremendous fraud list'
43
43
  PHONE_ON_A_TREMENDOUS_FRAUD_LIST = 'Phone on a Tremendous fraud list'
44
44
  DEVICE_ON_A_TREMENDOUS_FRAUD_LIST = 'Device on a Tremendous fraud list'
45
+ IP_ON_A_TREMENDOUS_ALLOW_LIST = 'IP on a Tremendous allow list'
46
+ BANK_ACCOUNT_ON_A_TREMENDOUS_ALLOW_LIST = 'Bank account on a Tremendous allow list'
47
+ EMAIL_ON_A_TREMENDOUS_ALLOW_LIST = 'Email on a Tremendous allow list'
48
+ PHONE_ON_A_TREMENDOUS_ALLOW_LIST = 'Phone on a Tremendous allow list'
49
+ DEVICE_ON_A_TREMENDOUS_ALLOW_LIST = 'Device on a Tremendous allow list'
45
50
  IP_RELATED_TO_A_BLOCKED_REWARD = 'IP related to a blocked reward'
46
51
  DEVICE_RELATED_TO_A_BLOCKED_REWARD = 'Device related to a blocked reward'
47
52
  BANK_ACCOUNT_RELATED_TO_A_BLOCKED_REWARD = 'Bank account related to a blocked reward'
@@ -28,13 +28,17 @@ class FraudReviewRedemptionMethod(str, Enum):
28
28
  allowed enum values
29
29
  """
30
30
  BANK_TRANSFER = 'bank transfer'
31
+ CASH_APP = 'cash app'
31
32
  CHARITY = 'charity'
33
+ CRYPTO = 'crypto'
32
34
  INSTANT_DEBIT_TRANSFER = 'instant debit transfer'
33
35
  INTERNATIONAL_BANK_TRANSFER = 'international bank transfer'
34
36
  MERCHANT_CARD = 'merchant card'
35
37
  PAYPAL = 'paypal'
38
+ RECIPIENT_PROMOTION = 'recipient_promotion'
36
39
  VENMO = 'venmo'
37
40
  VISA_CARD = 'visa card'
41
+ ZELLE = 'zelle'
38
42
 
39
43
  @classmethod
40
44
  def from_json(cls, json_str: str) -> Self:
@@ -33,7 +33,7 @@ class GetFraudReview200ResponseFraudReview(BaseModel):
33
33
  The fraud review associated with a reward.
34
34
  """ # noqa: E501
35
35
  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. ")
36
- reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
36
+ reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP on a Tremendous allow list` * `Bank account on a Tremendous allow list` * `Email on a Tremendous allow list` * `Phone on a Tremendous allow list` * `Device on a Tremendous allow list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
37
37
  device_id: Optional[StrictStr] = Field(default=None, description="The device fingerprint, if known.")
38
38
  redemption_method: Optional[StrictStr] = Field(default=None, description="The product selected to claim the reward")
39
39
  redeemed_at: Optional[datetime] = Field(default=None, description="Date the reward was redeemed")
@@ -36,8 +36,9 @@ class ListBalanceTransactions200ResponseTransactionsInner(BaseModel):
36
36
  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`.", json_schema_extra={"examples": [92.48]})
37
37
  action: StrictStr = Field(description="The action that was performed", json_schema_extra={"examples": ["Deposit"]})
38
38
  description: StrictStr = Field(description="A brief description of the transaction")
39
+ payment_id: Optional[StrictStr] = Field(default=None, description="ID of the payment behind the transaction, shown as \"Payment ID\" in the dashboard's balance transactions export and as \"Prefund confirmation\" on deposit receipts. Use it to match deposits, including auto-reloads, against your bank or card statements. Only present on transactions tied to a payment into your balance, such as deposits, the credit recorded when an order is paid by card or bank transfer, and transfers between organizations. Omitted otherwise, for example on the debit for an order paid from your balance. ", json_schema_extra={"examples": ["PAYMENTID123"]})
39
40
  order: Optional[ListBalanceTransactions200ResponseTransactionsInnerOrder] = None
40
- __properties: ClassVar[List[str]] = ["created_at", "amount", "currency_code", "balance", "action", "description", "order"]
41
+ __properties: ClassVar[List[str]] = ["created_at", "amount", "currency_code", "balance", "action", "description", "payment_id", "order"]
41
42
 
42
43
  model_config = ConfigDict(
43
44
  validate_by_name=True,
@@ -99,6 +100,7 @@ class ListBalanceTransactions200ResponseTransactionsInner(BaseModel):
99
100
  "balance": obj.get("balance"),
100
101
  "action": obj.get("action"),
101
102
  "description": obj.get("description"),
103
+ "payment_id": obj.get("payment_id"),
102
104
  "order": ListBalanceTransactions200ResponseTransactionsInnerOrder.from_dict(obj["order"]) if obj.get("order") is not None else None
103
105
  })
104
106
  return _obj
@@ -32,7 +32,7 @@ class ListFraudReviews200ResponseFraudReviewsInner(BaseModel):
32
32
  The fraud review associated with a reward.
33
33
  """ # noqa: E501
34
34
  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. ")
35
- reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
35
+ reasons: Optional[List[StrictStr]] = Field(default=None, description="The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP on a Tremendous allow list` * `Bank account on a Tremendous allow list` * `Email on a Tremendous allow list` * `Phone on a Tremendous allow list` * `Device on a Tremendous allow list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` ")
36
36
  device_id: Optional[StrictStr] = Field(default=None, description="The device fingerprint, if known.")
37
37
  redemption_method: Optional[StrictStr] = Field(default=None, description="The product selected to claim the reward")
38
38
  redeemed_at: Optional[datetime] = Field(default=None, description="Date the reward was redeemed")
@@ -71,6 +71,16 @@ class ListFundingSources200ResponseFundingSourcesInnerMetaFailureDetails(BaseMod
71
71
  exclude=excluded_fields,
72
72
  exclude_none=True,
73
73
  )
74
+ # set to None if return_code (nullable) is None
75
+ # and model_fields_set contains the field
76
+ if self.return_code is None and "return_code" in self.model_fields_set:
77
+ _dict['return_code'] = None
78
+
79
+ # set to None if description (nullable) is None
80
+ # and model_fields_set contains the field
81
+ if self.description is None and "description" in self.model_fields_set:
82
+ _dict['description'] = None
83
+
74
84
  return _dict
75
85
 
76
86
  @classmethod
@@ -38,7 +38,7 @@ class ListProductsResponseProductsInner(BaseModel):
38
38
  description: StrictStr = Field(description="Detailed description of the product.")
39
39
  category: StrictStr = Field(description="The category of the product <table> <thead> <tr> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>ach</code></td> <td>Bank transfer to the recipient</td> </tr> <tr> <td><code>charity</code></td> <td>Donations to a charity</td> </tr> <tr> <td><code>instant_debit_transfer</code></td> <td>Instant debit transfer to the recipient</td> </tr> <tr> <td><code>merchant_card</code></td> <td>A gift card for a certain merchant (e.g. Amazon)</td> </tr> <tr> <td><code>paypal</code></td> <td>Payout via PayPal</td> </tr> <tr> <td><code>venmo</code></td> <td>Payout via Venmo</td> </tr> <tr> <td><code>visa_card</code></td> <td>Payout in form of a Visa debit card</td> </tr> <tr> <td><code>cash_app</code></td> <td>Payout via Cash App</td> </tr> <tr> <td><code>international_bank</code></td> <td>Bank transfer to recipients outside of the US</td> </tr> <tr> <td><code>wallet</code></td> <td>Payout to a digital wallet (e.g. GCash, MoMo)</td> </tr> </tbody> </table> ", json_schema_extra={"examples": ["merchant_card"]})
40
40
  subcategory: Optional[StrictStr] = Field(default=None, description="Additional classification for the product. Only applicable to products with a `category` of `merchant_card`. Possible subcategories: * `beauty_and_health` * `digital_financial_services` * `electronics` * `entertainment` * `fashion` * `food_and_drink` * `general_merchandise` * `grocery_and_supermarkets` * `home_and_living` * `mobility_and_fuel` * `sports_and_outdoor_gear` * `travel_and_hospitality` ", json_schema_extra={"examples": ["general_merchandise"]})
41
- disclosure: StrictStr = Field(description="Legal disclosures for this product. Can be in HTML format.", json_schema_extra={"examples": ["<ul><li><p>This card may not be exchanged for cash.</p></li><li><p>…</p></li></ul>"]})
41
+ disclosure: StrictStr = Field(description="Legal disclosures for this product, as an HTML fragment that uses basic formatting tags such as paragraphs, lists, links, and emphasis. Some products return plain text. Sanitize the value before rendering it.", json_schema_extra={"examples": ["<ul><li><p>This card may not be exchanged for cash.</p></li><li><p>…</p></li></ul>"]})
42
42
  skus: Optional[List[ListProductsResponseProductsInnerSkusInner]] = Field(default=None, description="Products are restricted in their usage based on the amount of the reward. The `skus` array defines bands of denominations in which this product may be used for payouts. The skus apply to orders in any of the product's `currency_codes`. ")
43
43
  currency_codes: Annotated[List[StrictStr], Field(min_length=1)] = Field(description="Available currencies for this product")
44
44
  countries: Annotated[List[ListProductsResponseProductsInnerCountriesInner], Field(min_length=1)] = Field(description="List of countries in which this product is available to recipients.", json_schema_extra={"examples": [[{"abbr": "US"}]]})
@@ -40,7 +40,7 @@ class ListRewards200ResponseRewardsInner(BaseModel):
40
40
  expires_at: Optional[datetime] = Field(default=None, description="Expiration date of the reward. If null, the reward does not expire.")
41
41
  value: Optional[ListRewards200ResponseRewardsInnerValue] = None
42
42
  recipient: Optional[ListRewards200ResponseRewardsInnerRecipient] = None
43
- deliver_at: Optional[date] = Field(default=None, description="Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
43
+ deliver_at: Optional[date] = Field(default=None, description="Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization's time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
44
44
  custom_fields: Optional[List[ListRewards200ResponseRewardsInnerCustomFieldsInner]] = None
45
45
  delivery: Optional[ListRewards200ResponseRewardsInnerDelivery] = None
46
46
  __properties: ClassVar[List[str]] = ["id", "order_id", "created_at", "expires_at", "value", "recipient", "deliver_at", "custom_fields", "delivery"]
@@ -42,7 +42,7 @@ class OrderWithLinkRewardsInner(BaseModel):
42
42
  products: Optional[Annotated[List[Annotated[str, Field(strict=True)]], Field(min_length=1)]] = Field(default=None, description="List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. ")
43
43
  value: Optional[ListRewards200ResponseRewardsInnerValue] = None
44
44
  recipient: Optional[ListRewards200ResponseRewardsInnerRecipient] = None
45
- deliver_at: Optional[date] = Field(default=None, description="Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
45
+ deliver_at: Optional[date] = Field(default=None, description="Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization's time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
46
46
  custom_fields: Optional[List[RewardBaseCustomFieldsInner]] = None
47
47
  delivery: Optional[RewardWithLinkDelivery] = None
48
48
  __properties: ClassVar[List[str]] = ["id", "order_id", "created_at", "expires_at", "campaign_id", "products", "value", "recipient", "deliver_at", "custom_fields", "delivery"]
@@ -38,7 +38,7 @@ class Product(BaseModel):
38
38
  description: StrictStr = Field(description="Detailed description of the product.")
39
39
  category: StrictStr = Field(description="The category of the product <table> <thead> <tr> <th>Category</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>ach</code></td> <td>Bank transfer to the recipient</td> </tr> <tr> <td><code>charity</code></td> <td>Donations to a charity</td> </tr> <tr> <td><code>instant_debit_transfer</code></td> <td>Instant debit transfer to the recipient</td> </tr> <tr> <td><code>merchant_card</code></td> <td>A gift card for a certain merchant (e.g. Amazon)</td> </tr> <tr> <td><code>paypal</code></td> <td>Payout via PayPal</td> </tr> <tr> <td><code>venmo</code></td> <td>Payout via Venmo</td> </tr> <tr> <td><code>visa_card</code></td> <td>Payout in form of a Visa debit card</td> </tr> <tr> <td><code>cash_app</code></td> <td>Payout via Cash App</td> </tr> <tr> <td><code>international_bank</code></td> <td>Bank transfer to recipients outside of the US</td> </tr> <tr> <td><code>wallet</code></td> <td>Payout to a digital wallet (e.g. GCash, MoMo)</td> </tr> </tbody> </table> ", json_schema_extra={"examples": ["merchant_card"]})
40
40
  subcategory: Optional[StrictStr] = Field(default=None, description="Additional classification for the product. Only applicable to products with a `category` of `merchant_card`. Possible subcategories: * `beauty_and_health` * `digital_financial_services` * `electronics` * `entertainment` * `fashion` * `food_and_drink` * `general_merchandise` * `grocery_and_supermarkets` * `home_and_living` * `mobility_and_fuel` * `sports_and_outdoor_gear` * `travel_and_hospitality` ", json_schema_extra={"examples": ["general_merchandise"]})
41
- disclosure: StrictStr = Field(description="Legal disclosures for this product. Can be in HTML format.", json_schema_extra={"examples": ["<ul><li><p>This card may not be exchanged for cash.</p></li><li><p>…</p></li></ul>"]})
41
+ disclosure: StrictStr = Field(description="Legal disclosures for this product, as an HTML fragment that uses basic formatting tags such as paragraphs, lists, links, and emphasis. Some products return plain text. Sanitize the value before rendering it.", json_schema_extra={"examples": ["<ul><li><p>This card may not be exchanged for cash.</p></li><li><p>…</p></li></ul>"]})
42
42
  skus: Optional[List[ListProductsResponseProductsInnerSkusInner]] = Field(default=None, description="Products are restricted in their usage based on the amount of the reward. The `skus` array defines bands of denominations in which this product may be used for payouts. The skus apply to orders in any of the product's `currency_codes`. ")
43
43
  currency_codes: Annotated[List[StrictStr], Field(min_length=1)] = Field(description="Available currencies for this product")
44
44
  countries: Annotated[List[ListProductsResponseProductsInnerCountriesInner], Field(min_length=1)] = Field(description="List of countries in which this product is available to recipients.", json_schema_extra={"examples": [[{"abbr": "US"}]]})
@@ -42,7 +42,7 @@ class Reward(BaseModel):
42
42
  products: Optional[Annotated[List[Annotated[str, Field(strict=True)]], Field(min_length=1)]] = Field(default=None, description="List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. ")
43
43
  value: Optional[ListRewards200ResponseRewardsInnerValue] = None
44
44
  recipient: Optional[ListRewards200ResponseRewardsInnerRecipient] = None
45
- deliver_at: Optional[date] = Field(default=None, description="Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
45
+ deliver_at: Optional[date] = Field(default=None, description="Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization's time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
46
46
  custom_fields: Optional[List[RewardBaseCustomFieldsInner]] = None
47
47
  delivery: Optional[RewardWithoutLinkDelivery] = None
48
48
  __properties: ClassVar[List[str]] = ["id", "order_id", "created_at", "expires_at", "campaign_id", "products", "value", "recipient", "deliver_at", "custom_fields", "delivery"]
@@ -41,7 +41,7 @@ class RewardBase(BaseModel):
41
41
  products: Optional[Annotated[List[Annotated[str, Field(strict=True)]], Field(min_length=1)]] = Field(default=None, description="List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. ")
42
42
  value: Optional[ListRewards200ResponseRewardsInnerValue] = None
43
43
  recipient: Optional[ListRewards200ResponseRewardsInnerRecipient] = None
44
- deliver_at: Optional[date] = Field(default=None, description="Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
44
+ deliver_at: Optional[date] = Field(default=None, description="Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization's time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
45
45
  custom_fields: Optional[List[RewardBaseCustomFieldsInner]] = None
46
46
  __properties: ClassVar[List[str]] = ["id", "order_id", "created_at", "expires_at", "campaign_id", "products", "value", "recipient", "deliver_at", "custom_fields"]
47
47
 
@@ -42,7 +42,7 @@ class RewardForOrderCreate(BaseModel):
42
42
  products: Optional[Annotated[List[Annotated[str, Field(strict=True)]], Field(min_length=1)]] = Field(default=None, description="List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. ")
43
43
  value: Optional[ListRewards200ResponseRewardsInnerValue] = None
44
44
  recipient: Optional[ListRewards200ResponseRewardsInnerRecipient] = None
45
- deliver_at: Optional[date] = Field(default=None, description="Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
45
+ deliver_at: Optional[date] = Field(default=None, description="Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization's time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
46
46
  custom_fields: Optional[List[RewardBaseCustomFieldsInner]] = None
47
47
  language: Optional[StrictStr] = Field(default=None, description="Set this to translate the redemption experience for this reward. Pass a 2-letter [ISO-639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the desired language. Defaults to `en`. ", json_schema_extra={"examples": ["de"]})
48
48
  delivery: Optional[SingleRewardOrderRewardDelivery] = None
@@ -42,7 +42,7 @@ class RewardResponseReward(BaseModel):
42
42
  products: Optional[Annotated[List[Annotated[str, Field(strict=True)]], Field(min_length=1)]] = Field(default=None, description="List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. ")
43
43
  value: Optional[ListRewards200ResponseRewardsInnerValue] = None
44
44
  recipient: Optional[ListRewards200ResponseRewardsInnerRecipient] = None
45
- deliver_at: Optional[date] = Field(default=None, description="Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
45
+ deliver_at: Optional[date] = Field(default=None, description="Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization's time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
46
46
  custom_fields: Optional[List[RewardBaseCustomFieldsInner]] = None
47
47
  delivery: Optional[RewardWithoutLinkDelivery] = None
48
48
  __properties: ClassVar[List[str]] = ["id", "order_id", "created_at", "expires_at", "campaign_id", "products", "value", "recipient", "deliver_at", "custom_fields", "delivery"]
@@ -42,7 +42,7 @@ class RewardWithLink(BaseModel):
42
42
  products: Optional[Annotated[List[Annotated[str, Field(strict=True)]], Field(min_length=1)]] = Field(default=None, description="List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. ")
43
43
  value: Optional[ListRewards200ResponseRewardsInnerValue] = None
44
44
  recipient: Optional[ListRewards200ResponseRewardsInnerRecipient] = None
45
- deliver_at: Optional[date] = Field(default=None, description="Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
45
+ deliver_at: Optional[date] = Field(default=None, description="Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization's time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
46
46
  custom_fields: Optional[List[RewardBaseCustomFieldsInner]] = None
47
47
  delivery: Optional[RewardWithLinkDelivery] = None
48
48
  __properties: ClassVar[List[str]] = ["id", "order_id", "created_at", "expires_at", "campaign_id", "products", "value", "recipient", "deliver_at", "custom_fields", "delivery"]
@@ -42,7 +42,7 @@ class RewardWithoutLink(BaseModel):
42
42
  products: Optional[Annotated[List[Annotated[str, Field(strict=True)]], Field(min_length=1)]] = Field(default=None, description="List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. ")
43
43
  value: Optional[ListRewards200ResponseRewardsInnerValue] = None
44
44
  recipient: Optional[ListRewards200ResponseRewardsInnerRecipient] = None
45
- deliver_at: Optional[date] = Field(default=None, description="Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
45
+ deliver_at: Optional[date] = Field(default=None, description="Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization's time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
46
46
  custom_fields: Optional[List[RewardBaseCustomFieldsInner]] = None
47
47
  delivery: Optional[RewardWithoutLinkDelivery] = None
48
48
  __properties: ClassVar[List[str]] = ["id", "order_id", "created_at", "expires_at", "campaign_id", "products", "value", "recipient", "deliver_at", "custom_fields", "delivery"]
@@ -38,7 +38,7 @@ class SingleRewardOrderReward(BaseModel):
38
38
  products: Optional[Annotated[List[Annotated[str, Field(strict=True)]], Field(min_length=1)]] = Field(default=None, description="List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. ")
39
39
  value: Optional[ListRewards200ResponseRewardsInnerValue] = None
40
40
  recipient: Optional[ListRewards200ResponseRewardsInnerRecipient] = None
41
- deliver_at: Optional[date] = Field(default=None, description="Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
41
+ deliver_at: Optional[date] = Field(default=None, description="Date of reward delivery, within the next year. The reward is delivered at 12pm in your organization's time zone on that date, or at 12pm Eastern Time when the organization has no time zone set. Note that if date-time is provided, the time values will be ignored.", json_schema_extra={"examples": ["2023-12-31"]})
42
42
  custom_fields: Optional[List[SingleRewardOrderRewardCustomFieldsInner]] = None
43
43
  language: Optional[StrictStr] = Field(default=None, description="Set this to translate the redemption experience for this reward. Pass a 2-letter [ISO-639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the desired language. Defaults to `en`. ", json_schema_extra={"examples": ["de"]})
44
44
  delivery: Optional[SingleRewardOrderRewardDelivery] = None
tremendous/version.py CHANGED
@@ -1 +1 @@
1
- __version__ = '6.0.0'
1
+ __version__ = '7.0.0'
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: tremendous-python
3
- Version: 6.0.0
3
+ Version: 7.0.0
4
4
  Summary: Python API client for Tremendous
5
5
  Home-page: https://github.com/tremendous-rewards/tremendous-python
6
6
  Author: Tremendous
@@ -5,13 +5,13 @@ tremendous/configuration.py,sha256=PxpczV9Y5k5zjG2k1aLzb4iOfe3kHoY9uaXFk2iiSuU,2
5
5
  tremendous/exceptions.py,sha256=PwPv6N4tyNx59A7INIbjTTgmoRHVgOkaJp31K4idGDQ,6718
6
6
  tremendous/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
7
7
  tremendous/rest.py,sha256=sUSFRzvY2kEbum_aktjZZXW8B35IDZsdvx0OYAwgLoo,12538
8
- tremendous/version.py,sha256=9jLyA4y8NmfLmizrpmOWmBtFFOh8Fd0opTdILVmbjI0,22
8
+ tremendous/version.py,sha256=5v8xXXAk4_rm42bKyUqenBD8aQotaa7Iwldhc8Bw3Ro,22
9
9
  tremendous/api/__init__.py,sha256=NspQ9vNaLWIkAoRM3v1XOFlg7vY3l1r61TiwAUiWsvc,104
10
- tremendous/api/tremendous_api.py,sha256=35C6RP7JbK8h9PIDfJ0DdVFXW97HaV3UGLo0mP2z9yg,857914
10
+ tremendous/api/tremendous_api.py,sha256=E27dtJTTZXmrSTnJjTEjGTgoPvXwmce3bYmvJtcxfVE,860791
11
11
  tremendous/models/__init__.py,sha256=mropzl5XF_nMfwl3YY9vHTsrZC-Fj1NAduOpvW2hfrg,22714
12
12
  tremendous/models/allow_email.py,sha256=N_-9xMM9w1UhqucVS3Z__H3E6lo9DyxG_LMKo8Wcn_8,2870
13
13
  tremendous/models/allow_ip.py,sha256=7DYpcJ0iduB2c1pc2H94GRFee0c16kwWWI0S6oJLQX8,2918
14
- tremendous/models/balance_transaction.py,sha256=QGNEODtzb-6XYLksK1ex6KffJWimmrq3lJX21OdOYWc,4437
14
+ tremendous/models/balance_transaction.py,sha256=Hvbn24R-AONOw1ctE7n32mP47yLZ1DDxNc_bAnyKxy8,5149
15
15
  tremendous/models/balance_transaction_order.py,sha256=t2hV9c0qE6em2OI5YERG7IRXk_C5Ohwbdk14wiSH2MM,4654
16
16
  tremendous/models/balance_transaction_order_payment.py,sha256=k2M6W-sIDm9a9jZ_0srmIQeMip07AY142I-jyxFK-dM,4946
17
17
  tremendous/models/base_order_for_create.py,sha256=ZuWfPEDmefg10bNRJbV1_wZaUx5Vylp9hyr4dtlWqoA,3934
@@ -53,7 +53,7 @@ tremendous/models/create_member200_response.py,sha256=nb4YrCKaY1QebCE2GF3xI75rRR
53
53
  tremendous/models/create_member_request.py,sha256=tfZijZNWddU8XV05AFgjnj3gWymU3ou0JWg7qhO6MGQ,2991
54
54
  tremendous/models/create_order200_response.py,sha256=deJ7nx8navX69L-lTR0hWmh-iWWPNaRyfJbVuDS7VIc,3038
55
55
  tremendous/models/create_order200_response_order.py,sha256=Fk3g5wY0P2_lbR29SiaragWMDbr37iIwmfa1hT4HW_s,8244
56
- tremendous/models/create_order200_response_order_rewards_inner.py,sha256=9MvryExY5Y0TwZzZrb_zygpHYnvJ0fHQ4Di1tuadbOM,7370
56
+ tremendous/models/create_order200_response_order_rewards_inner.py,sha256=9YkTMZBZkLTrnrN08JXnCX6d6RGPHrre7vg5xclR510,7513
57
57
  tremendous/models/create_order200_response_order_rewards_inner_delivery.py,sha256=oDeJdgDCtmTcSzYPVoIdQsxeavEHVB_O-7_btzjGnFw,4508
58
58
  tremendous/models/create_order_request.py,sha256=bXINrvdl1BBtD0vUJTelwZaAS6qeGBzUuNtUJqmCpU0,4830
59
59
  tremendous/models/create_organization.py,sha256=u9hRbNzBpjZFFOtuP14xiWDSJCWBoJ0cenLO4_Nb7_Y,5345
@@ -76,7 +76,7 @@ tremendous/models/create_topup200_response.py,sha256=41Quzygh_JMeaW3jtMXiiUDQeMA
76
76
  tremendous/models/create_topup_request.py,sha256=BDzJYe8zgRrBCX02L0KPiOXgpNJu9Um6aw1CnFtaIcE,3374
77
77
  tremendous/models/create_webhook200_response.py,sha256=0rFOCrzZV4vWJPF_wELDcjpJ0kRDqYzodZeRSz1MU2M,3128
78
78
  tremendous/models/create_webhook_request.py,sha256=d2l2eKjWAoulj593VS8zWR2divANOLmR-qYSNu802lg,2825
79
- tremendous/models/currency_codes.py,sha256=wVRgmYK4extdFeD4vPFrpnQB2R7h6TdAhA85mevHd28,2680
79
+ tremendous/models/currency_codes.py,sha256=JQ388ofM_XIbbJMgIC8-CwuTjT-8Oaq_AcN59B-Ghc8,2664
80
80
  tremendous/models/custom_field.py,sha256=etSrJtf-JH-qHaDiTmE1srSYlSe6LiAtH0V3XIRBHHA,4093
81
81
  tremendous/models/delivery_details.py,sha256=56M8NUCT-yCb1yv7g99sB2sTAjxYfHXVeJSuK4VfSWo,4211
82
82
  tremendous/models/delivery_details_with_link.py,sha256=pWdKDNKezL1ZzkA1FYxhzBY93JX2wfi1t7plNT-uhmw,4578
@@ -93,12 +93,12 @@ tremendous/models/fraud_config_redeemed_rewards_count.py,sha256=MsNsV2GqbIWlDscj
93
93
  tremendous/models/fraud_config_review_email.py,sha256=9n4MZ6y7UNHoMQ0eDIBpuj7Ns0d77XUltaDVebE-_Qw,3097
94
94
  tremendous/models/fraud_config_review_vpn.py,sha256=b-z7T5VwT9QK_-4KPet8FSZ2EK7YISA0mSH4rguSTF8,3080
95
95
  tremendous/models/fraud_generic_response.py,sha256=h6TO5xoxA70CRagRZVe60IhwZ2n3vAa48WE4MnRGTHc,2816
96
- tremendous/models/fraud_review.py,sha256=tDQl6YqU3ITRqk4nJJFHgNTC_XPFXwG4sJNl2NfIFhs,7834
97
- tremendous/models/fraud_review_base.py,sha256=V_SQlOHjWtfEMgrvEUQpjPHXOkETS4MgtRew79H0kdE,7112
96
+ tremendous/models/fraud_review.py,sha256=QQZXX0Z-oRoFS6HqI9kS0C4_PzrwcYkCMe60AdlLH1o,8024
97
+ tremendous/models/fraud_review_base.py,sha256=PZlW4ow77UJw2zNaL8YHfm-pN9QnwEjolHPZfJfE5k4,7302
98
98
  tremendous/models/fraud_review_geo.py,sha256=1oblC6HMmmg2q41x5D14OMw38plRbf-iEG9Rx85IFBQ,3150
99
- tremendous/models/fraud_review_list_item.py,sha256=U-3Bz1T2Hq4xqfEXz7j6vb9_OqZ3QOgEeiZ3OotQsOY,7124
100
- tremendous/models/fraud_review_reason.py,sha256=mytmI4zJBZxBxRhS6kI1f6JyfZXaAP4Zh6mgHMrfS8M,2460
101
- tremendous/models/fraud_review_redemption_method.py,sha256=j6wZNp59T24gWQDA_s_olvRNtVjQSd3WcmgStMZzJKM,1230
99
+ tremendous/models/fraud_review_list_item.py,sha256=H4Px8DKlHv2Mkt8azGax57ONRjJPO9RDxglQfDiYq84,7314
100
+ tremendous/models/fraud_review_reason.py,sha256=Cv57V-h3EbCqg7nP52CIS2vQ9fSheMuPD4R12UQU-mQ,2840
101
+ tremendous/models/fraud_review_redemption_method.py,sha256=vtwIoCD2qddzw-SAAiINLHRZ6GuYf9Iov6wEj4UHvVQ,1346
102
102
  tremendous/models/fraud_review_related_rewards.py,sha256=bKYoPL5A-nzNp8H2OHHaQg4TCSEDBMXCyVMSVZ44Z5M,4261
103
103
  tremendous/models/fraud_review_risk.py,sha256=TSPvllNyTSpIo7BsCrcWB-gb6ZWiMlxZPCbwtT4ZuWA,993
104
104
  tremendous/models/fraud_review_status.py,sha256=auHWScm8ulvZpOC-QHvK4vgqtMXxYzMFCdt2Plx-mEc,1191
@@ -111,7 +111,7 @@ tremendous/models/funding_source.py,sha256=HRBM-6x36lEWZogIOQDrH73Q4_X-2YaTrgMow
111
111
  tremendous/models/generate_reward_link200_response.py,sha256=JGcBaiQW9ejAz41TZPX5bClIqOC8ZwLgf5CBUyFiCwU,3108
112
112
  tremendous/models/generate_reward_link200_response_reward.py,sha256=rG2CLxLB6opKXrCPqNpYYukqt1_2vdZWjurjDfmKc6Y,3671
113
113
  tremendous/models/get_fraud_review200_response.py,sha256=5l8EfEV9KB8iW38OIpzskqjLhzXuE9veq-Nh0L7jOxM,3151
114
- tremendous/models/get_fraud_review200_response_fraud_review.py,sha256=vDd2XTgDHQAdpWqOS6YvV0jxG_H6IHSRBuPRxGhkkQM,7677
114
+ tremendous/models/get_fraud_review200_response_fraud_review.py,sha256=LCIoRRab-iZAoxvBv_aOqGQ9ZbQm3dFrhJy-3580Mk4,7867
115
115
  tremendous/models/get_fraud_review200_response_fraud_review_related_rewards.py,sha256=mFFkwyK64fyh_c0RZdkcApnaK9E2blmESz-KESl-N0Y,4257
116
116
  tremendous/models/get_funding_source200_response.py,sha256=lmKwwxWiCUQGPfRSWuKpHTT_tJN3KRGWhIcmRRknSlU,3226
117
117
  tremendous/models/get_member200_response.py,sha256=WVMs0nulDW5sGXw0TR-WwqBEA7hOoLYEHbW13cIQeg0,3035
@@ -126,7 +126,7 @@ tremendous/models/invoice.py,sha256=urOS33KNhto4P096dz3y-n8TYTbFD4cRc_j14WyX3f4,
126
126
  tremendous/models/invoice_response.py,sha256=8kKIa_6plSKWe_jOSLdsso7MWVlyuxOcd-MU2hlgzeU,3007
127
127
  tremendous/models/invoice_response_invoice.py,sha256=3Mz81XgKZhO2QxExF5kP_kv1ANtPm02b0EAM5VquEJw,6168
128
128
  tremendous/models/list_balance_transactions200_response.py,sha256=I7thN_p2QJvLHJ0hSmPIO7sEZM7TsT6oJrXTbrt5vz0,3454
129
- tremendous/models/list_balance_transactions200_response_transactions_inner.py,sha256=B7Jye3z2eQZ6Kqk06Q-vKJCgu5IPdt-dlCR5vxkqcFg,4672
129
+ tremendous/models/list_balance_transactions200_response_transactions_inner.py,sha256=dmp45v9hmIJeN-8B12R2IhzAKQ0JpDcipHC8VMpixko,5384
130
130
  tremendous/models/list_balance_transactions200_response_transactions_inner_order.py,sha256=eeCZtkPpZDtIFyVlA462UpN50CX5lr_vyW3W_WM1Zlw,4821
131
131
  tremendous/models/list_balance_transactions200_response_transactions_inner_order_payment.py,sha256=qh67PcnwByRuOljMLSVGQD2L9H33AcOzwLnrXFQkIQk,4814
132
132
  tremendous/models/list_campaigns200_response.py,sha256=Sb784GsmVo1PfBE2d8k42-0YDx1qJ5sO_8aMsPo03m8,3325
@@ -146,14 +146,14 @@ tremendous/models/list_fields200_response_fields_inner.py,sha256=rsReGOzr9UsK28k
146
146
  tremendous/models/list_fields200_response_fields_inner_data.py,sha256=pOXKw03d7M5HgJJwQSmo7lftyk0w1GYVPyhQZF0lfLI,3503
147
147
  tremendous/models/list_forex_response.py,sha256=dbWYoLs2rbS8rjd1FRHZoEP2ISSG6EWHgG5SAkkei9s,2949
148
148
  tremendous/models/list_fraud_reviews200_response.py,sha256=csYP6guG0sHxpVzF7kRnPkp-uzqwvLChxN0R-ZoGj04,3616
149
- tremendous/models/list_fraud_reviews200_response_fraud_reviews_inner.py,sha256=OyWnynZrI5hEIhIKjeg6k4041cSONWmuoCfoIdgVbxw,6933
149
+ tremendous/models/list_fraud_reviews200_response_fraud_reviews_inner.py,sha256=hedtwTSW5uGzbIKa02Wcg28olmF4rgdnFW9tbve5TPc,7123
150
150
  tremendous/models/list_fraud_reviews200_response_fraud_reviews_inner_geo.py,sha256=Sz9ZvClZKn_DZhMpvIHH64QZb49Xr5yGacKHKNNv4Es,3281
151
151
  tremendous/models/list_fraud_rules200_response.py,sha256=SZNc2BKiUobIRp0-KrmopVJNIdZi0uIoMw_0TbOzGeE,3363
152
152
  tremendous/models/list_fraud_rules200_response_fraud_rules_inner.py,sha256=uQgPdm1DEs2ktgThGWjoSAx-XCjIe_NhQ799BWx3eck,4510
153
153
  tremendous/models/list_funding_sources200_response.py,sha256=5kwHD5_Ee7u0THbZYwZeM95ZG0qjvOBMMojgWGEeqIw,3459
154
154
  tremendous/models/list_funding_sources200_response_funding_sources_inner.py,sha256=Npqj0A8XY3nNjknfxtE33mJzjP3pQ15Zbbfr_20ED7E,6340
155
155
  tremendous/models/list_funding_sources200_response_funding_sources_inner_meta.py,sha256=_tk1zHBaKLtd9WfhgKDargwxPTg93KeAz2g2RgSRLo0,17721
156
- tremendous/models/list_funding_sources200_response_funding_sources_inner_meta_failure_details.py,sha256=duv87xhLUZuFQyTVPPYyQCQfxIhcCwZuhT9Re38NzrM,3267
156
+ tremendous/models/list_funding_sources200_response_funding_sources_inner_meta_failure_details.py,sha256=G9gB9HAublo7N7W2mZ5_Xxz2FQrel1FrAduBuko_y4M,3721
157
157
  tremendous/models/list_invoices200_response.py,sha256=EmFW75AvWafTRXHKhnwJCVS5lh0xFHbJMLBS6HmojOE,3518
158
158
  tremendous/models/list_invoices200_response_invoices_inner.py,sha256=LyeGpN3Upkg_591D5jn4YeYZq3_UHvwUOmLPe78U_rU,6210
159
159
  tremendous/models/list_members200_response.py,sha256=5ijAz_XKlN7D8Ovrq5I8eEhxA4WFPqrPvpGahOQD1YA,3277
@@ -165,13 +165,13 @@ tremendous/models/list_orders200_response_orders_inner_payment_refund.py,sha256=
165
165
  tremendous/models/list_organizations200_response.py,sha256=y-wRp43KhcIjrm5pKNYiKtFw4svcUCNLS6hn4yP46Sw,3448
166
166
  tremendous/models/list_organizations200_response_organizations_inner.py,sha256=VxzIPGH5HPFgoqh4xkiFQr9TSJW6UgP8ZUtEG6nQNZ8,4984
167
167
  tremendous/models/list_products_response.py,sha256=yZS7hottznylIJ52oqgTKFkTYjhPKXFuIjTDcbQWRMQ,3277
168
- tremendous/models/list_products_response_products_inner.py,sha256=wVabYntMQ-fe0Ctk5T5CMSQVF4SpsfSnvI3CEHvhIDY,10378
168
+ tremendous/models/list_products_response_products_inner.py,sha256=StkaOOIMTvg4Fy-NRHLFpkyTmsMTSK1kpdZ9bL7522c,10528
169
169
  tremendous/models/list_products_response_products_inner_countries_inner.py,sha256=eQr4OUCa1e0noan5haiCndHd-E2DLoSAvrc-zZmw99s,2896
170
170
  tremendous/models/list_products_response_products_inner_documents.py,sha256=K1yM9cnORBamBlxbjPJ2wtNalHGm4Ub71n0JApBfcvk,3647
171
171
  tremendous/models/list_products_response_products_inner_images_inner.py,sha256=3hA-ZbbDlDMOhyEEk8_eE5KabBUisp9YVmq_KwIp5cM,3376
172
172
  tremendous/models/list_products_response_products_inner_skus_inner.py,sha256=jmpG-9uqsScwOQD4tmPFzDYvbKLeWMuqAdbQzd4IJn8,3509
173
173
  tremendous/models/list_rewards200_response.py,sha256=cn_DBJhhWAPd2hY9_9CerwgBawmRqJ71WNYBboR8wQs,3544
174
- tremendous/models/list_rewards200_response_rewards_inner.py,sha256=_NjQB3JATmg1qN1jHESk5lUJPyqaQ0G-g79iDax83fY,7334
174
+ tremendous/models/list_rewards200_response_rewards_inner.py,sha256=i08lWfUoAjrnUcwmXYqwk3DFRQEcxcOD9h1DvkiV34w,7477
175
175
  tremendous/models/list_rewards200_response_rewards_inner_custom_fields_inner.py,sha256=ETcu59jZuGO_4ATccnnycpSXEG4XAWnNywzs_SdCyMk,4142
176
176
  tremendous/models/list_rewards200_response_rewards_inner_delivery.py,sha256=VrCq8lT3YbUoPztdB7IttCwdECUZ-KhKb7Za9OkQ3cg,4220
177
177
  tremendous/models/list_rewards200_response_rewards_inner_recipient.py,sha256=wrs3PyQ88f3k1qayB_YQBwcbPjmnFHw6JqX2ZvS2sXw,3590
@@ -197,7 +197,7 @@ tremendous/models/order_base.py,sha256=u5FnmkwMdas6xU6GHZ6Bl2Yzm7TzyM_7cJ-tsS5rW
197
197
  tremendous/models/order_base_payment.py,sha256=VtJKIq6xNDQsQAw6uQ73ng7NpZ96WEjgRdqvfIAkG3g,5153
198
198
  tremendous/models/order_status.py,sha256=4K-e2k5t3hfg-D527gPGBwL0HueCza5pKOjUdujVQS8,2387
199
199
  tremendous/models/order_with_link.py,sha256=FS8c035KgTMd7V0B05urUe_sqnaTUB-dtIcM-8khhEg,8492
200
- tremendous/models/order_with_link_rewards_inner.py,sha256=7pOo4redv0HHAUfA6DLpLz4qUPuLRgSabphoTRFlMqw,8992
200
+ tremendous/models/order_with_link_rewards_inner.py,sha256=uYJBv-BIDsuMB3NP7YFKKFn5cAkqoeS14BCzSOEvCcY,9135
201
201
  tremendous/models/order_without_link.py,sha256=CidG6AHKsRmQ5FWU1XSEeU00QuLquzLpuWMHbIjcxRc,8479
202
202
  tremendous/models/organization.py,sha256=Uzo9t1ng01rqybjNMGCNvjeNYy10Wbpsow3_Y6CgkFg,5098
203
203
  tremendous/models/organization_response.py,sha256=oUKAUvmcXoQM6bEDX-dN4AOD8YDF5TRfSwCSQ3aOZ2c,3139
@@ -205,7 +205,7 @@ tremendous/models/organization_response_organization.py,sha256=c0zO8vZrRmTIRRKiE
205
205
  tremendous/models/payment_details.py,sha256=Dlemj1RzmpNSlISUUNA-ZdmJyob0IhB98zKO4d4v4Qs,4882
206
206
  tremendous/models/payment_details_refund.py,sha256=L9pPDkTjXI-TEhCg_9ER0osA7sQ2qSS2B868yL1C4w8,3540
207
207
  tremendous/models/payout.py,sha256=lxwpVZQ5Z5t0KbooGpP8PLY5JGedbHra23YJzfWs75U,5739
208
- tremendous/models/product.py,sha256=mBjVb-qg3lO38VIQhv1dA_fPnd1epjNzGe4sG8Ns2Sg,10368
208
+ tremendous/models/product.py,sha256=NYB_Ir7DjL4P0TetaXkePwO5TJntEvVvrXf46uaY7Rc,10518
209
209
  tremendous/models/product_documents.py,sha256=znCWzJfSDGLMeiVOnOQ_4r7R9e3dzM0fOOMNSvuHJ9k,3569
210
210
  tremendous/models/recipient.py,sha256=zZN_zScW0lGN4Gx42YuDZs-UTcsbfJdwxEPRf8z7wLw,3488
211
211
  tremendous/models/refund_details.py,sha256=SGvwMC14c9TPW4ZQgrs8p8nXXDPK1efjkwZ5K8fWVnY,3321
@@ -219,28 +219,28 @@ tremendous/models/review_ip.py,sha256=lwr_iOvAbd0YzKyB2DMWx6LtS6ITxwVC5hTQ0IJVfM
219
219
  tremendous/models/review_redeemed_rewards_amount.py,sha256=xLG5z3IZYqmonepIkX4oMW4YWWvcLiToOhy3231PPTM,3324
220
220
  tremendous/models/review_redeemed_rewards_count.py,sha256=90iK1BnUVwgkDfIS6RIZOQa4CI_AXWxJQv66ZzwBclM,3193
221
221
  tremendous/models/review_vpn.py,sha256=O_neKY5fR8GtkejIM9FzDs9ZxHPgW-2AAMEKe1jCfAk,3184
222
- tremendous/models/reward.py,sha256=-VqVuNiML2v0A4e1U7JtIRNKvgapWaWTBW7dB6VXu4s,8947
223
- tremendous/models/reward_base.py,sha256=fISLF7TswVK_xVOZmBOmgPv-bC57AnAfKpLuZURUFiU,8513
222
+ tremendous/models/reward.py,sha256=-lqb3KgnyDg3qklRpD13OQxG_0YAmY3jDwSNEVxPDvk,9090
223
+ tremendous/models/reward_base.py,sha256=C0dmyzlA1Eq-ZwGL1PuByV0fcCsYXGrNXxruChltTHo,8656
224
224
  tremendous/models/reward_base_custom_fields_inner.py,sha256=yErDHNpht8AiRuJ6Dl7cUsdsPathuAZeRxDRYBcjMqo,4141
225
- tremendous/models/reward_for_order_create.py,sha256=fr5ncntCx1XTxA1Szn9QonQXcY0twhgEGS8FHoTjBjI,9391
225
+ tremendous/models/reward_for_order_create.py,sha256=S4UJlJhiOzdbx_zL_Eo-1p7LWj0Ps2D6xPnuUE_dtYU,9534
226
226
  tremendous/models/reward_link.py,sha256=zoTyVUMjgJG8_B074NE3cIXZD1MZSvyLyvbURUmbz74,3734
227
227
  tremendous/models/reward_link_response.py,sha256=qZUxYsiMobGcJPgTLjhzMmYthLwiedQ4rIhn7p995bw,3019
228
228
  tremendous/models/reward_link_response_reward.py,sha256=ghJBx8zZuJtmsT9eIHw7Ccf9UFsdBBi9BhvqcLycU70,3776
229
229
  tremendous/models/reward_response.py,sha256=-dyP-j_k6vTs-II0JH6sRefQ_TC4NJfcDe3uh4DVOfo,2986
230
- tremendous/models/reward_response_reward.py,sha256=3eKgDkqQcuCWS9n5WEA5Umvj67fUcXYgAXgIsp3XcN8,8989
230
+ tremendous/models/reward_response_reward.py,sha256=5uS5GCdV9vTKZ-8Nr9NniErIWVIK6O61S-sCBLXfbHw,9132
231
231
  tremendous/models/reward_token.py,sha256=cmwBjgnsJIBtZ91KwUB-FDM9B5-duK1G2kBYyd9FDV0,3912
232
232
  tremendous/models/reward_token_response.py,sha256=ohfv0GMIZ6wYA_z8V0cSop6pXBOOqJBJYHpFxngZsSQ,3027
233
233
  tremendous/models/reward_token_response_reward.py,sha256=dDDdMZ0epOg7KWogoa7N4YPJO6e3BwO7CGVyZq9AWcY,3954
234
234
  tremendous/models/reward_value.py,sha256=LW0nWfkygS78D68VliweloIzZqZnvKjITm4lZWwbp2g,3091
235
- tremendous/models/reward_with_link.py,sha256=4KU5Och6zrLDIZL9TbWxLARfr6O1ggIVP7m2z_Xv7pE,8959
235
+ tremendous/models/reward_with_link.py,sha256=fCJp4hItL1XfXoYJMHFwNRpVgCmb2y_4jKA1UveN_YQ,9102
236
236
  tremendous/models/reward_with_link_delivery.py,sha256=dU57-RS1wrTu2lr_e1Y7RqyjCSmQCtxt3pe5U-uX-tE,4575
237
- tremendous/models/reward_without_link.py,sha256=mU00V4b8AZ6dqwRYMkRKgttHL05bYDqJCwhf3xntbMo,8980
237
+ tremendous/models/reward_without_link.py,sha256=iGVa_DiuuS_109At7PjaF1I6RMTg6S1Q48CYBdBTJAY,9123
238
238
  tremendous/models/reward_without_link_delivery.py,sha256=hzWgeBUnqk-XC45_GALPpVAaaK9X_cJtgOhh8j2_V9s,4241
239
239
  tremendous/models/role.py,sha256=2D7fkCG-Zr5RZeE8v0zDfIzjVmOpBlaNjASVG65wFoA,3587
240
240
  tremendous/models/simulate_webhook_request.py,sha256=PNPRkqhkrWIXQDsJVzOvTcGPQGTw7vfOIkLplWYiBuA,2910
241
241
  tremendous/models/single_reward_order.py,sha256=IJqY6WRfHcwjfOxSgzeh_a62IzS4MJLjBFvtLMXRqoA,4415
242
242
  tremendous/models/single_reward_order_payment.py,sha256=f8QxUtOGkxjsWVGgdPeY-3dFqpykGsTNV2oGT1cOvlM,3537
243
- tremendous/models/single_reward_order_reward.py,sha256=9tCHz1TgyYfeUiOPpgZFnxvemRsw01BeG4rmKhgVz8Y,7328
243
+ tremendous/models/single_reward_order_reward.py,sha256=TXexinNCIhKNsHPFZh-NlEPf5Ov3YG91qFb9HnhrdIA,7471
244
244
  tremendous/models/single_reward_order_reward_custom_fields_inner.py,sha256=CRkwi2VkAed-JsA4DnTmXyS4FbeW6DaCss0g4qe-eS0,3911
245
245
  tremendous/models/single_reward_order_reward_delivery.py,sha256=XMJweIPTS5n5iJcYOE8zuUUwEh8AxhP0CIBnvDwsHrE,4169
246
246
  tremendous/models/single_reward_order_reward_delivery_meta.py,sha256=72yAQHr6xieNf9GzxVGjGBdAONpDNOZ6UAZIkwoVTpM,3478
@@ -261,8 +261,8 @@ tremendous/models/webhook.py,sha256=HsyCLdYHZxjjDvzw2iPpwt7XrZJ5Z8KTYjUJyykvS9c,
261
261
  tremendous/models/webhook_post.py,sha256=Uru2jl-7SQ0gbM4pfiTi6cmzaYH3EPuqQgh8ADNE_8Y,2789
262
262
  tremendous/models/webhook_response.py,sha256=uCTGJ1Eka0KWjpKAiRXqT50mR2nYFcQ6HaCY_T6l6Aw,3034
263
263
  tremendous/models/webhook_response_webhook.py,sha256=s1fzTOWRyvzZQ3zfALRuCixuCCe_jmceR9-POrRiEhY,4020
264
- tremendous_python-6.0.0.dist-info/licenses/LICENSE,sha256=w2FQEW9lLNgnbTqAtfE83pweZmuKxBDGJuI2CEK72Ns,1105
265
- tremendous_python-6.0.0.dist-info/METADATA,sha256=I2KcXdMoPXo7_GHtJOhBzG4HcTpH4_uEzVSJFG_YaYQ,636
266
- tremendous_python-6.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
267
- tremendous_python-6.0.0.dist-info/top_level.txt,sha256=BtFjKKgW-uLrCNyBgKRucWH89zjLzYCCFoev2H1cj_Y,11
268
- tremendous_python-6.0.0.dist-info/RECORD,,
264
+ tremendous_python-7.0.0.dist-info/licenses/LICENSE,sha256=w2FQEW9lLNgnbTqAtfE83pweZmuKxBDGJuI2CEK72Ns,1105
265
+ tremendous_python-7.0.0.dist-info/METADATA,sha256=mDO0Z-VyRzshCD0Vk3ygsEc4B2Wm0njJLP_GuhuNfxk,636
266
+ tremendous_python-7.0.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
267
+ tremendous_python-7.0.0.dist-info/top_level.txt,sha256=BtFjKKgW-uLrCNyBgKRucWH89zjLzYCCFoev2H1cj_Y,11
268
+ tremendous_python-7.0.0.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (84.0.0)
2
+ Generator: setuptools (84.2.1)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5