tremendous_ruby 5.28.0 → 5.30.0
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.
- checksums.yaml +4 -4
- data/lib/tremendous/api/tremendous_api.rb +55 -52
- data/lib/tremendous/api_client.rb +7 -3
- data/lib/tremendous/api_error.rb +1 -1
- data/lib/tremendous/api_model_base.rb +88 -0
- data/lib/tremendous/configuration.rb +1 -1
- data/lib/tremendous/models/allow_email.rb +2 -75
- data/lib/tremendous/models/allow_ip.rb +2 -75
- data/lib/tremendous/models/balance_transaction.rb +2 -75
- data/lib/tremendous/models/balance_transaction_order.rb +2 -75
- data/lib/tremendous/models/balance_transaction_order_payment.rb +2 -75
- data/lib/tremendous/models/base_order_for_create.rb +2 -75
- data/lib/tremendous/models/campaign.rb +4 -77
- data/lib/tremendous/models/campaign_base.rb +4 -77
- data/lib/tremendous/models/campaign_base_products_inner.rb +102 -0
- data/lib/tremendous/models/channel.rb +1 -1
- data/lib/tremendous/models/connected_organization.rb +2 -75
- data/lib/tremendous/models/connected_organization_member.rb +2 -75
- data/lib/tremendous/models/connected_organization_member_member.rb +2 -75
- data/lib/tremendous/models/connected_organization_member_response.rb +164 -0
- data/lib/tremendous/models/connected_organization_member_response_connected_organization_member.rb +273 -0
- data/lib/tremendous/models/connected_organization_member_session.rb +2 -75
- data/lib/tremendous/models/connected_organization_member_session_response.rb +164 -0
- data/lib/tremendous/models/connected_organization_member_session_response_connected_organization_member_session.rb +310 -0
- data/lib/tremendous/models/connected_organization_organization.rb +2 -75
- data/lib/tremendous/models/{generate_reward_link403_response.rb → connected_organization_response.rb} +20 -103
- data/lib/tremendous/models/connected_organization_response_connected_organization.rb +240 -0
- data/lib/tremendous/models/create_api_key200_response.rb +2 -75
- data/lib/tremendous/models/create_api_key_request.rb +2 -75
- data/lib/tremendous/models/create_campaign200_response.rb +2 -75
- data/lib/tremendous/models/create_campaign_request.rb +4 -77
- data/lib/tremendous/models/create_connected_organization200_response.rb +2 -75
- data/lib/tremendous/models/create_connected_organization_member200_response.rb +2 -75
- data/lib/tremendous/models/create_connected_organization_member_request.rb +2 -75
- data/lib/tremendous/models/create_connected_organization_member_session200_response.rb +2 -75
- data/lib/tremendous/models/create_connected_organization_member_session200_response_connected_organization_member_session.rb +2 -75
- data/lib/tremendous/models/create_connected_organization_member_session_request.rb +2 -75
- data/lib/tremendous/models/create_connected_organization_request.rb +16 -76
- data/lib/tremendous/models/create_connected_organization_request_kyb_prefill.rb +15 -78
- data/lib/tremendous/models/create_field.rb +2 -75
- data/lib/tremendous/models/create_field200_response.rb +2 -75
- data/lib/tremendous/models/create_field_request.rb +2 -75
- data/lib/tremendous/models/create_field_request_data.rb +2 -75
- data/lib/tremendous/models/create_invoice200_response.rb +2 -75
- data/lib/tremendous/models/create_invoice_request.rb +4 -77
- data/lib/tremendous/models/create_member.rb +2 -75
- data/lib/tremendous/models/create_member200_response.rb +2 -75
- data/lib/tremendous/models/create_member_request.rb +2 -75
- data/lib/tremendous/models/create_order200_response.rb +2 -75
- data/lib/tremendous/models/create_order200_response_order.rb +3 -76
- data/lib/tremendous/models/create_order200_response_order_rewards_inner.rb +2 -75
- data/lib/tremendous/models/create_order200_response_order_rewards_inner_delivery.rb +2 -75
- data/lib/tremendous/models/create_order_request.rb +3 -4
- data/lib/tremendous/models/create_organization.rb +2 -75
- data/lib/tremendous/models/create_organization200_response.rb +2 -75
- data/lib/tremendous/models/create_organization200_response_organization.rb +2 -75
- data/lib/tremendous/models/create_organization_for_response.rb +2 -75
- data/lib/tremendous/models/create_organization_properties.rb +2 -75
- data/lib/tremendous/models/create_organization_request.rb +2 -75
- data/lib/tremendous/models/create_organization_request_copy_settings.rb +2 -75
- data/lib/tremendous/models/create_organization_response.rb +147 -0
- data/lib/tremendous/models/create_organization_response_organization.rb +282 -0
- data/lib/tremendous/models/create_report200_response.rb +2 -75
- data/lib/tremendous/models/create_report200_response_report.rb +2 -75
- data/lib/tremendous/models/create_report_request.rb +2 -75
- data/lib/tremendous/models/create_report_request_filters.rb +2 -75
- data/lib/tremendous/models/create_report_request_filters_digital_rewards.rb +2 -75
- data/lib/tremendous/models/create_report_request_filters_digital_rewards_amount.rb +2 -75
- data/lib/tremendous/models/create_report_request_filters_digital_rewards_created_at.rb +2 -75
- data/lib/tremendous/models/create_topup200_response.rb +2 -75
- data/lib/tremendous/models/create_topup_request.rb +2 -75
- data/lib/tremendous/models/create_webhook200_response.rb +2 -75
- data/lib/tremendous/models/create_webhook_request.rb +2 -75
- data/lib/tremendous/models/currency_codes.rb +1 -1
- data/lib/tremendous/models/custom_field.rb +2 -75
- data/lib/tremendous/models/delivery_details.rb +2 -75
- data/lib/tremendous/models/delivery_details_with_link.rb +2 -75
- data/lib/tremendous/models/delivery_metadata.rb +2 -75
- data/lib/tremendous/models/delivery_method.rb +1 -1
- data/lib/tremendous/models/delivery_status.rb +1 -1
- data/lib/tremendous/models/error_model.rb +2 -75
- data/lib/tremendous/models/field.rb +2 -75
- data/lib/tremendous/models/fraud_config_allow_email.rb +2 -75
- data/lib/tremendous/models/fraud_config_country.rb +2 -75
- data/lib/tremendous/models/fraud_config_country_update_list.rb +2 -75
- data/lib/tremendous/models/fraud_config_ip.rb +2 -75
- data/lib/tremendous/models/fraud_config_redeemed_rewards_amount.rb +2 -75
- data/lib/tremendous/models/fraud_config_redeemed_rewards_count.rb +2 -75
- data/lib/tremendous/models/fraud_config_review_email.rb +2 -75
- data/lib/tremendous/models/fraud_config_review_vpn.rb +2 -75
- data/lib/tremendous/models/fraud_generic_response.rb +2 -75
- data/lib/tremendous/models/fraud_review.rb +3 -76
- data/lib/tremendous/models/fraud_review_base.rb +3 -76
- data/lib/tremendous/models/fraud_review_geo.rb +2 -75
- data/lib/tremendous/models/fraud_review_list_item.rb +3 -76
- data/lib/tremendous/models/fraud_review_reason.rb +1 -1
- data/lib/tremendous/models/fraud_review_redemption_method.rb +1 -1
- data/lib/tremendous/models/fraud_review_related_rewards.rb +2 -75
- data/lib/tremendous/models/fraud_review_risk.rb +1 -1
- data/lib/tremendous/models/fraud_review_status.rb +1 -1
- data/lib/tremendous/models/fraud_rule200_response.rb +2 -75
- data/lib/tremendous/models/fraud_rule_request.rb +2 -75
- data/lib/tremendous/models/fraud_rule_request_config.rb +3 -4
- data/lib/tremendous/models/fraud_rule_type.rb +1 -1
- data/lib/tremendous/models/fraud_rules_list_item.rb +2 -75
- data/lib/tremendous/models/funding_source.rb +3 -76
- data/lib/tremendous/models/generate_reward_link200_response.rb +2 -75
- data/lib/tremendous/models/generate_reward_link200_response_reward.rb +2 -75
- data/lib/tremendous/models/get_fraud_review200_response.rb +2 -75
- data/lib/tremendous/models/get_fraud_review200_response_fraud_review.rb +2 -75
- data/lib/tremendous/models/get_fraud_review200_response_fraud_review_related_rewards.rb +2 -75
- data/lib/tremendous/models/get_funding_source200_response.rb +2 -75
- data/lib/tremendous/models/get_member200_response.rb +2 -75
- data/lib/tremendous/models/get_member200_response_member.rb +2 -75
- data/lib/tremendous/models/get_member200_response_member_events_inner.rb +2 -75
- data/lib/tremendous/models/get_order200_response.rb +2 -75
- data/lib/tremendous/models/get_organization200_response.rb +2 -75
- data/lib/tremendous/models/get_product_response.rb +2 -75
- data/lib/tremendous/models/get_reward200_response.rb +2 -75
- data/lib/tremendous/models/inline_object.rb +2 -75
- data/lib/tremendous/models/invoice.rb +4 -77
- data/lib/tremendous/models/invoice_response.rb +164 -0
- data/lib/tremendous/models/invoice_response_invoice.rb +370 -0
- data/lib/tremendous/models/list_balance_transactions200_response.rb +2 -75
- data/lib/tremendous/models/list_balance_transactions200_response_transactions_inner.rb +2 -75
- data/lib/tremendous/models/list_balance_transactions200_response_transactions_inner_order.rb +2 -75
- data/lib/tremendous/models/list_balance_transactions200_response_transactions_inner_order_payment.rb +2 -75
- data/lib/tremendous/models/list_campaigns200_response.rb +2 -75
- data/lib/tremendous/models/list_campaigns200_response_campaigns_inner.rb +4 -77
- data/lib/tremendous/models/list_campaigns200_response_campaigns_inner_auto_add_product_rule.rb +2 -75
- data/lib/tremendous/models/list_campaigns200_response_campaigns_inner_email_style.rb +2 -75
- data/lib/tremendous/models/list_campaigns200_response_campaigns_inner_products_inner.rb +102 -0
- data/lib/tremendous/models/list_campaigns200_response_campaigns_inner_webpage_style.rb +2 -75
- data/lib/tremendous/models/list_connected_organization_members200_response.rb +2 -75
- data/lib/tremendous/models/list_connected_organization_members200_response_connected_organization_members_inner.rb +2 -75
- data/lib/tremendous/models/list_connected_organization_members200_response_connected_organization_members_inner_member.rb +2 -75
- data/lib/tremendous/models/list_connected_organizations200_response.rb +2 -75
- data/lib/tremendous/models/list_connected_organizations200_response_connected_organizations_inner.rb +2 -75
- data/lib/tremendous/models/list_connected_organizations200_response_connected_organizations_inner_organization.rb +2 -75
- data/lib/tremendous/models/list_fields200_response.rb +2 -75
- data/lib/tremendous/models/list_fields200_response_fields_inner.rb +2 -75
- data/lib/tremendous/models/list_fields200_response_fields_inner_data.rb +2 -75
- data/lib/tremendous/models/list_forex_response.rb +2 -75
- data/lib/tremendous/models/list_fraud_reviews200_response.rb +2 -75
- data/lib/tremendous/models/list_fraud_reviews200_response_fraud_reviews_inner.rb +2 -75
- data/lib/tremendous/models/list_fraud_reviews200_response_fraud_reviews_inner_geo.rb +2 -75
- data/lib/tremendous/models/list_fraud_rules200_response.rb +2 -75
- data/lib/tremendous/models/list_fraud_rules200_response_fraud_rules_inner.rb +2 -75
- data/lib/tremendous/models/list_funding_sources200_response.rb +2 -75
- data/lib/tremendous/models/list_funding_sources200_response_funding_sources_inner.rb +3 -76
- data/lib/tremendous/models/list_funding_sources200_response_funding_sources_inner_meta.rb +17 -78
- data/lib/tremendous/models/list_funding_sources200_response_funding_sources_inner_meta_failure_details.rb +2 -75
- data/lib/tremendous/models/list_invoices200_response.rb +2 -75
- data/lib/tremendous/models/list_invoices200_response_invoices_inner.rb +4 -77
- data/lib/tremendous/models/list_members200_response.rb +2 -75
- data/lib/tremendous/models/list_members200_response_members_inner.rb +2 -75
- data/lib/tremendous/models/list_orders200_response.rb +2 -75
- data/lib/tremendous/models/list_orders200_response_orders_inner.rb +3 -76
- data/lib/tremendous/models/list_orders200_response_orders_inner_payment.rb +2 -75
- data/lib/tremendous/models/list_orders200_response_orders_inner_payment_refund.rb +2 -75
- data/lib/tremendous/models/list_organizations200_response.rb +2 -75
- data/lib/tremendous/models/list_organizations200_response_organizations_inner.rb +2 -75
- data/lib/tremendous/models/list_products_response.rb +2 -75
- data/lib/tremendous/models/list_products_response_products_inner.rb +4 -77
- data/lib/tremendous/models/list_products_response_products_inner_countries_inner.rb +2 -75
- data/lib/tremendous/models/list_products_response_products_inner_documents.rb +2 -75
- data/lib/tremendous/models/list_products_response_products_inner_images_inner.rb +2 -75
- data/lib/tremendous/models/list_products_response_products_inner_skus_inner.rb +61 -81
- data/lib/tremendous/models/list_rewards200_response.rb +2 -75
- data/lib/tremendous/models/list_rewards200_response_rewards_inner.rb +2 -75
- data/lib/tremendous/models/list_rewards200_response_rewards_inner_custom_fields_inner.rb +2 -75
- data/lib/tremendous/models/list_rewards200_response_rewards_inner_delivery.rb +2 -75
- data/lib/tremendous/models/list_rewards200_response_rewards_inner_recipient.rb +2 -75
- data/lib/tremendous/models/list_rewards200_response_rewards_inner_value.rb +2 -75
- data/lib/tremendous/models/list_rewards401_response.rb +2 -75
- data/lib/tremendous/models/list_rewards401_response_errors.rb +2 -75
- data/lib/tremendous/models/list_roles200_response.rb +2 -75
- data/lib/tremendous/models/list_roles200_response_roles_inner.rb +2 -75
- data/lib/tremendous/models/list_topups200_response.rb +2 -75
- data/lib/tremendous/models/list_topups200_response_topups_inner.rb +3 -76
- data/lib/tremendous/models/list_webhook_events200_response.rb +2 -75
- data/lib/tremendous/models/list_webhooks200_response.rb +2 -75
- data/lib/tremendous/models/list_webhooks200_response_webhooks_inner.rb +2 -75
- data/lib/tremendous/models/member.rb +2 -75
- data/lib/tremendous/models/member_base.rb +2 -75
- data/lib/tremendous/models/member_with_events.rb +2 -75
- data/lib/tremendous/models/member_without_events.rb +2 -75
- data/lib/tremendous/models/{fraud_rule400_response.rb → member_without_events_response.rb} +20 -103
- data/lib/tremendous/models/member_without_events_response_member.rb +311 -0
- data/lib/tremendous/models/order.rb +4 -77
- data/lib/tremendous/models/order_base.rb +3 -76
- data/lib/tremendous/models/order_base_payment.rb +2 -75
- data/lib/tremendous/models/order_status.rb +1 -1
- data/lib/tremendous/models/order_with_link.rb +3 -76
- data/lib/tremendous/models/order_with_link_rewards_inner.rb +2 -75
- data/lib/tremendous/models/order_without_link.rb +4 -77
- data/lib/tremendous/models/organization.rb +2 -75
- data/lib/tremendous/models/organization_response.rb +147 -0
- data/lib/tremendous/models/organization_response_organization.rb +285 -0
- data/lib/tremendous/models/payment_details.rb +2 -75
- data/lib/tremendous/models/payment_details_refund.rb +2 -75
- data/lib/tremendous/models/payout.rb +2 -75
- data/lib/tremendous/models/product.rb +4 -77
- data/lib/tremendous/models/product_documents.rb +2 -75
- data/lib/tremendous/models/recipient.rb +2 -75
- data/lib/tremendous/models/refund_details.rb +2 -75
- data/lib/tremendous/models/report.rb +2 -75
- data/lib/tremendous/models/{delete_fraud_rule200_response.rb → report_response.rb} +25 -89
- data/lib/tremendous/models/resend_reward_request.rb +2 -75
- data/lib/tremendous/models/review_country.rb +2 -75
- data/lib/tremendous/models/review_country1.rb +2 -75
- data/lib/tremendous/models/review_email.rb +2 -75
- data/lib/tremendous/models/review_ip.rb +2 -75
- data/lib/tremendous/models/review_redeemed_rewards_amount.rb +2 -75
- data/lib/tremendous/models/review_redeemed_rewards_count.rb +2 -75
- data/lib/tremendous/models/review_vpn.rb +2 -75
- data/lib/tremendous/models/reward.rb +2 -75
- data/lib/tremendous/models/reward_base.rb +2 -75
- data/lib/tremendous/models/reward_base_custom_fields_inner.rb +2 -75
- data/lib/tremendous/models/reward_for_order_create.rb +2 -75
- data/lib/tremendous/models/reward_link.rb +2 -75
- data/lib/tremendous/models/{inline_object1.rb → reward_link_response.rb} +5 -78
- data/lib/tremendous/models/reward_link_response_reward.rb +180 -0
- data/lib/tremendous/models/reward_response.rb +164 -0
- data/lib/tremendous/models/{order_without_link_rewards_inner.rb → reward_response_reward.rb} +4 -77
- data/lib/tremendous/models/reward_token.rb +2 -75
- data/lib/tremendous/models/reward_token_response.rb +164 -0
- data/lib/tremendous/models/{inline_object1_reward.rb → reward_token_response_reward.rb} +4 -77
- data/lib/tremendous/models/reward_value.rb +2 -75
- data/lib/tremendous/models/reward_with_link.rb +2 -75
- data/lib/tremendous/models/reward_with_link_delivery.rb +2 -75
- data/lib/tremendous/models/reward_without_link.rb +2 -75
- data/lib/tremendous/models/reward_without_link_delivery.rb +2 -75
- data/lib/tremendous/models/role.rb +2 -75
- data/lib/tremendous/models/simulate_webhook_request.rb +2 -75
- data/lib/tremendous/models/single_reward_order.rb +2 -75
- data/lib/tremendous/models/single_reward_order_payment.rb +3 -76
- data/lib/tremendous/models/single_reward_order_reward.rb +2 -75
- data/lib/tremendous/models/single_reward_order_reward_custom_fields_inner.rb +2 -75
- data/lib/tremendous/models/single_reward_order_reward_delivery.rb +2 -75
- data/lib/tremendous/models/single_reward_order_reward_delivery_meta.rb +2 -75
- data/lib/tremendous/models/single_reward_order_with_link.rb +2 -75
- data/lib/tremendous/models/single_reward_order_with_link_order.rb +3 -76
- data/lib/tremendous/models/single_reward_order_without_link.rb +2 -75
- data/lib/tremendous/models/single_reward_order_without_link_order.rb +4 -77
- data/lib/tremendous/models/topup.rb +3 -76
- data/lib/tremendous/models/topup_create_request.rb +2 -75
- data/lib/tremendous/models/topup_response.rb +147 -0
- data/lib/tremendous/models/update_campaign.rb +4 -77
- data/lib/tremendous/models/update_campaign_request.rb +4 -77
- data/lib/tremendous/models/update_fraud_rule_list_request.rb +2 -75
- data/lib/tremendous/models/update_fraud_rule_list_request_config.rb +7 -8
- data/lib/tremendous/models/update_member.rb +2 -75
- data/lib/tremendous/models/update_member_request.rb +2 -75
- data/lib/tremendous/models/webhook.rb +2 -75
- data/lib/tremendous/models/webhook_post.rb +2 -75
- data/lib/tremendous/models/webhook_response.rb +147 -0
- data/lib/tremendous/models/{update_fraud_rule_list200_response.rb → webhook_response_webhook.rb} +47 -94
- data/lib/tremendous/version.rb +1 -1
- data/lib/tremendous.rb +28 -15
- metadata +28 -15
- data/lib/tremendous/models/allow_email1.rb +0 -250
- data/lib/tremendous/models/allow_ip1.rb +0 -250
- data/lib/tremendous/models/fraud_rule422_response.rb +0 -247
- data/lib/tremendous/models/list_rewards429_response.rb +0 -247
- data/lib/tremendous/models/resend_reward422_response.rb +0 -247
- data/lib/tremendous/models/review_email1.rb +0 -255
- data/lib/tremendous/models/review_ip1.rb +0 -250
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
The version of the OpenAPI document: 2
|
|
7
7
|
Contact: developers@tremendous.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.
|
|
9
|
+
Generator version: 7.25.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -48,7 +48,7 @@ module Tremendous
|
|
|
48
48
|
end
|
|
49
49
|
|
|
50
50
|
# resource path
|
|
51
|
-
local_var_path = '/order_approvals/{id}/approve'.sub('{
|
|
51
|
+
local_var_path = '/order_approvals/{id}/approve'.sub('{id}', CGI.escape(id.to_s))
|
|
52
52
|
|
|
53
53
|
# query parameters
|
|
54
54
|
query_params = opts[:query_params] || {}
|
|
@@ -111,7 +111,7 @@ module Tremendous
|
|
|
111
111
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.block_fraud_review"
|
|
112
112
|
end
|
|
113
113
|
# resource path
|
|
114
|
-
local_var_path = '/fraud_reviews/{id}/block'.sub('{
|
|
114
|
+
local_var_path = '/fraud_reviews/{id}/block'.sub('{id}', CGI.escape(id.to_s))
|
|
115
115
|
|
|
116
116
|
# query parameters
|
|
117
117
|
query_params = opts[:query_params] || {}
|
|
@@ -179,7 +179,7 @@ module Tremendous
|
|
|
179
179
|
end
|
|
180
180
|
|
|
181
181
|
# resource path
|
|
182
|
-
local_var_path = '/rewards/{id}/cancel'.sub('{
|
|
182
|
+
local_var_path = '/rewards/{id}/cancel'.sub('{id}', CGI.escape(id.to_s))
|
|
183
183
|
|
|
184
184
|
# query parameters
|
|
185
185
|
query_params = opts[:query_params] || {}
|
|
@@ -349,7 +349,7 @@ module Tremendous
|
|
|
349
349
|
end
|
|
350
350
|
|
|
351
351
|
# Create connected organization
|
|
352
|
-
# Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client's onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
|
|
352
|
+
# Create a connected organization. Optionally pass `currency_code` to set the connected organization's balance currency. Supported values are `USD`, `EUR`, `GBP`, and `CAD`. If omitted, the balance currency defaults to `USD`. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client's onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
|
|
353
353
|
# @param create_connected_organization_request [CreateConnectedOrganizationRequest] Connected organization to create
|
|
354
354
|
# @param [Hash] opts the optional parameters
|
|
355
355
|
# @return [CreateConnectedOrganization200Response]
|
|
@@ -359,7 +359,7 @@ module Tremendous
|
|
|
359
359
|
end
|
|
360
360
|
|
|
361
361
|
# Create connected organization
|
|
362
|
-
# Create a connected organization. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client's onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
|
|
362
|
+
# Create a connected organization. Optionally pass `currency_code` to set the connected organization's balance currency. Supported values are `USD`, `EUR`, `GBP`, and `CAD`. If omitted, the balance currency defaults to `USD`. Optionally pass a `kyb_prefill` object to forward KYB (Know Your Business) details you have already collected for the end client. When provided, these values prefill the end client's onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb_prefill` field is optional, but any value provided is validated. Malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`.
|
|
363
363
|
# @param create_connected_organization_request [CreateConnectedOrganizationRequest] Connected organization to create
|
|
364
364
|
# @param [Hash] opts the optional parameters
|
|
365
365
|
# @return [Array<(CreateConnectedOrganization200Response, Integer, Hash)>] CreateConnectedOrganization200Response data, response status code and response headers
|
|
@@ -514,7 +514,7 @@ module Tremendous
|
|
|
514
514
|
fail ArgumentError, "Missing the required parameter 'create_connected_organization_member_session_request' when calling TremendousApi.create_connected_organization_member_session"
|
|
515
515
|
end
|
|
516
516
|
# resource path
|
|
517
|
-
local_var_path = '/connected_organization_members/{id}/sessions'.sub('{
|
|
517
|
+
local_var_path = '/connected_organization_members/{id}/sessions'.sub('{id}', CGI.escape(id.to_s))
|
|
518
518
|
|
|
519
519
|
# query parameters
|
|
520
520
|
query_params = opts[:query_params] || {}
|
|
@@ -763,7 +763,7 @@ module Tremendous
|
|
|
763
763
|
end
|
|
764
764
|
|
|
765
765
|
# Create order
|
|
766
|
-
# 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. Use <code>balance</code> to use your Tremendous's balance.</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'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 "sender name" used in the delivery. If it's an email reward, "via Tremendous" 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.
|
|
766
|
+
# 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'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'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 "sender name" used in the delivery. If it's an email reward, "via Tremendous" 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.
|
|
767
767
|
# @param create_order_request [CreateOrderRequest] Order to create
|
|
768
768
|
# @param [Hash] opts the optional parameters
|
|
769
769
|
# @return [CreateOrder200Response]
|
|
@@ -773,7 +773,7 @@ module Tremendous
|
|
|
773
773
|
end
|
|
774
774
|
|
|
775
775
|
# Create order
|
|
776
|
-
# 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. Use <code>balance</code> to use your Tremendous&#39;s balance.</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.
|
|
776
|
+
# 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.
|
|
777
777
|
# @param create_order_request [CreateOrderRequest] Order to create
|
|
778
778
|
# @param [Hash] opts the optional parameters
|
|
779
779
|
# @return [Array<(CreateOrder200Response, Integer, Hash)>] CreateOrder200Response data, response status code and response headers
|
|
@@ -1120,7 +1120,7 @@ module Tremendous
|
|
|
1120
1120
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.delete_connected_organization"
|
|
1121
1121
|
end
|
|
1122
1122
|
# resource path
|
|
1123
|
-
local_var_path = '/connected_organizations/{id}'.sub('{
|
|
1123
|
+
local_var_path = '/connected_organizations/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
1124
1124
|
|
|
1125
1125
|
# query parameters
|
|
1126
1126
|
query_params = opts[:query_params] || {}
|
|
@@ -1183,7 +1183,7 @@ module Tremendous
|
|
|
1183
1183
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.delete_connected_organization_member"
|
|
1184
1184
|
end
|
|
1185
1185
|
# resource path
|
|
1186
|
-
local_var_path = '/connected_organization_members/{id}'.sub('{
|
|
1186
|
+
local_var_path = '/connected_organization_members/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
1187
1187
|
|
|
1188
1188
|
# query parameters
|
|
1189
1189
|
query_params = opts[:query_params] || {}
|
|
@@ -1226,7 +1226,7 @@ module Tremendous
|
|
|
1226
1226
|
# Deletes the rule of the type passed in the URL.
|
|
1227
1227
|
# @param rule_type [String] The rule type to create or update.
|
|
1228
1228
|
# @param [Hash] opts the optional parameters
|
|
1229
|
-
# @return [
|
|
1229
|
+
# @return [FraudRule200Response]
|
|
1230
1230
|
def delete_fraud_rule(rule_type, opts = {})
|
|
1231
1231
|
data, _status_code, _headers = delete_fraud_rule_with_http_info(rule_type, opts)
|
|
1232
1232
|
data
|
|
@@ -1236,7 +1236,7 @@ module Tremendous
|
|
|
1236
1236
|
# Deletes the rule of the type passed in the URL.
|
|
1237
1237
|
# @param rule_type [String] The rule type to create or update.
|
|
1238
1238
|
# @param [Hash] opts the optional parameters
|
|
1239
|
-
# @return [Array<(
|
|
1239
|
+
# @return [Array<(FraudRule200Response, Integer, Hash)>] FraudRule200Response data, response status code and response headers
|
|
1240
1240
|
def delete_fraud_rule_with_http_info(rule_type, opts = {})
|
|
1241
1241
|
if @api_client.config.debugging
|
|
1242
1242
|
@api_client.config.logger.debug 'Calling API: TremendousApi.delete_fraud_rule ...'
|
|
@@ -1251,7 +1251,7 @@ module Tremendous
|
|
|
1251
1251
|
fail ArgumentError, "invalid value for \"rule_type\", must be one of #{allowable_values}"
|
|
1252
1252
|
end
|
|
1253
1253
|
# resource path
|
|
1254
|
-
local_var_path = '/fraud_rules/{rule_type}'.sub('{
|
|
1254
|
+
local_var_path = '/fraud_rules/{rule_type}'.sub('{rule_type}', CGI.escape(rule_type.to_s))
|
|
1255
1255
|
|
|
1256
1256
|
# query parameters
|
|
1257
1257
|
query_params = opts[:query_params] || {}
|
|
@@ -1268,7 +1268,7 @@ module Tremendous
|
|
|
1268
1268
|
post_body = opts[:debug_body]
|
|
1269
1269
|
|
|
1270
1270
|
# return_type
|
|
1271
|
-
return_type = opts[:debug_return_type] || '
|
|
1271
|
+
return_type = opts[:debug_return_type] || 'FraudRule200Response'
|
|
1272
1272
|
|
|
1273
1273
|
# auth_names
|
|
1274
1274
|
auth_names = opts[:debug_auth_names] || ['BearerApiKey']
|
|
@@ -1314,7 +1314,7 @@ module Tremendous
|
|
|
1314
1314
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.delete_invoices"
|
|
1315
1315
|
end
|
|
1316
1316
|
# resource path
|
|
1317
|
-
local_var_path = '/invoices/{id}'.sub('{
|
|
1317
|
+
local_var_path = '/invoices/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
1318
1318
|
|
|
1319
1319
|
# query parameters
|
|
1320
1320
|
query_params = opts[:query_params] || {}
|
|
@@ -1382,7 +1382,7 @@ module Tremendous
|
|
|
1382
1382
|
end
|
|
1383
1383
|
|
|
1384
1384
|
# resource path
|
|
1385
|
-
local_var_path = '/members/{id}'.sub('{
|
|
1385
|
+
local_var_path = '/members/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
1386
1386
|
|
|
1387
1387
|
# query parameters
|
|
1388
1388
|
query_params = opts[:query_params] || {}
|
|
@@ -1450,7 +1450,7 @@ module Tremendous
|
|
|
1450
1450
|
end
|
|
1451
1451
|
|
|
1452
1452
|
# resource path
|
|
1453
|
-
local_var_path = '/webhooks/{id}'.sub('{
|
|
1453
|
+
local_var_path = '/webhooks/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
1454
1454
|
|
|
1455
1455
|
# query parameters
|
|
1456
1456
|
query_params = opts[:query_params] || {}
|
|
@@ -1513,7 +1513,7 @@ module Tremendous
|
|
|
1513
1513
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.download_invoice_csv"
|
|
1514
1514
|
end
|
|
1515
1515
|
# resource path
|
|
1516
|
-
local_var_path = '/invoices/{id}/csv'.sub('{
|
|
1516
|
+
local_var_path = '/invoices/{id}/csv'.sub('{id}', CGI.escape(id.to_s))
|
|
1517
1517
|
|
|
1518
1518
|
# query parameters
|
|
1519
1519
|
query_params = opts[:query_params] || {}
|
|
@@ -1576,7 +1576,7 @@ module Tremendous
|
|
|
1576
1576
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.download_invoice_pdf"
|
|
1577
1577
|
end
|
|
1578
1578
|
# resource path
|
|
1579
|
-
local_var_path = '/invoices/{id}/pdf'.sub('{
|
|
1579
|
+
local_var_path = '/invoices/{id}/pdf'.sub('{id}', CGI.escape(id.to_s))
|
|
1580
1580
|
|
|
1581
1581
|
# query parameters
|
|
1582
1582
|
query_params = opts[:query_params] || {}
|
|
@@ -1646,7 +1646,7 @@ module Tremendous
|
|
|
1646
1646
|
fail ArgumentError, "invalid value for \"rule_type\", must be one of #{allowable_values}"
|
|
1647
1647
|
end
|
|
1648
1648
|
# resource path
|
|
1649
|
-
local_var_path = '/fraud_rules/{rule_type}'.sub('{
|
|
1649
|
+
local_var_path = '/fraud_rules/{rule_type}'.sub('{rule_type}', CGI.escape(rule_type.to_s))
|
|
1650
1650
|
|
|
1651
1651
|
# query parameters
|
|
1652
1652
|
query_params = opts[:query_params] || {}
|
|
@@ -1719,7 +1719,7 @@ module Tremendous
|
|
|
1719
1719
|
end
|
|
1720
1720
|
|
|
1721
1721
|
# resource path
|
|
1722
|
-
local_var_path = '/rewards/{id}/generate_link'.sub('{
|
|
1722
|
+
local_var_path = '/rewards/{id}/generate_link'.sub('{id}', CGI.escape(id.to_s))
|
|
1723
1723
|
|
|
1724
1724
|
# query parameters
|
|
1725
1725
|
query_params = opts[:query_params] || {}
|
|
@@ -1787,7 +1787,7 @@ module Tremendous
|
|
|
1787
1787
|
end
|
|
1788
1788
|
|
|
1789
1789
|
# resource path
|
|
1790
|
-
local_var_path = '/campaigns/{id}'.sub('{
|
|
1790
|
+
local_var_path = '/campaigns/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
1791
1791
|
|
|
1792
1792
|
# query parameters
|
|
1793
1793
|
query_params = opts[:query_params] || {}
|
|
@@ -1850,7 +1850,7 @@ module Tremendous
|
|
|
1850
1850
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.get_connected_organization"
|
|
1851
1851
|
end
|
|
1852
1852
|
# resource path
|
|
1853
|
-
local_var_path = '/connected_organizations/{id}'.sub('{
|
|
1853
|
+
local_var_path = '/connected_organizations/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
1854
1854
|
|
|
1855
1855
|
# query parameters
|
|
1856
1856
|
query_params = opts[:query_params] || {}
|
|
@@ -1913,7 +1913,7 @@ module Tremendous
|
|
|
1913
1913
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.get_connected_organization_member"
|
|
1914
1914
|
end
|
|
1915
1915
|
# resource path
|
|
1916
|
-
local_var_path = '/connected_organization_members/{id}'.sub('{
|
|
1916
|
+
local_var_path = '/connected_organization_members/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
1917
1917
|
|
|
1918
1918
|
# query parameters
|
|
1919
1919
|
query_params = opts[:query_params] || {}
|
|
@@ -1976,7 +1976,7 @@ module Tremendous
|
|
|
1976
1976
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.get_fraud_review"
|
|
1977
1977
|
end
|
|
1978
1978
|
# resource path
|
|
1979
|
-
local_var_path = '/fraud_reviews/{id}'.sub('{
|
|
1979
|
+
local_var_path = '/fraud_reviews/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
1980
1980
|
|
|
1981
1981
|
# query parameters
|
|
1982
1982
|
query_params = opts[:query_params] || {}
|
|
@@ -2016,8 +2016,8 @@ module Tremendous
|
|
|
2016
2016
|
end
|
|
2017
2017
|
|
|
2018
2018
|
# Retrieve funding source
|
|
2019
|
-
# Retrieve a funding source, identified by the given `id` in the URL. You can also use the special
|
|
2020
|
-
# @param id [String] ID of the funding source that should be retrieved. Can also use
|
|
2019
|
+
# Retrieve a funding source, identified by the given `id` in the URL. You can also use the following special keywords (case-insensitive): - `BALANCE` retrieves the organization's balance funding source. - `INVOICE` retrieves the organization's active commercial invoice funding source. **Note:** Commercial invoicing is 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.
|
|
2020
|
+
# @param id [String] ID of the funding source that should be retrieved. Can also use `BALANCE` or `INVOICE` (case-insensitive) to retrieve the corresponding funding source.
|
|
2021
2021
|
# @param [Hash] opts the optional parameters
|
|
2022
2022
|
# @return [GetFundingSource200Response]
|
|
2023
2023
|
def get_funding_source(id, opts = {})
|
|
@@ -2026,8 +2026,8 @@ module Tremendous
|
|
|
2026
2026
|
end
|
|
2027
2027
|
|
|
2028
2028
|
# Retrieve funding source
|
|
2029
|
-
# Retrieve a funding source, identified by the given `id` in the URL. You can also use the special
|
|
2030
|
-
# @param id [String] ID of the funding source that should be retrieved. Can also use
|
|
2029
|
+
# Retrieve a funding source, identified by the given `id` in the URL. You can also use the following special keywords (case-insensitive): - `BALANCE` retrieves the organization's balance funding source. - `INVOICE` retrieves the organization's active commercial invoice funding source. **Note:** Commercial invoicing is 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.
|
|
2030
|
+
# @param id [String] ID of the funding source that should be retrieved. Can also use `BALANCE` or `INVOICE` (case-insensitive) to retrieve the corresponding funding source.
|
|
2031
2031
|
# @param [Hash] opts the optional parameters
|
|
2032
2032
|
# @return [Array<(GetFundingSource200Response, Integer, Hash)>] GetFundingSource200Response data, response status code and response headers
|
|
2033
2033
|
def get_funding_source_with_http_info(id, opts = {})
|
|
@@ -2038,13 +2038,13 @@ module Tremendous
|
|
|
2038
2038
|
if @api_client.config.client_side_validation && id.nil?
|
|
2039
2039
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.get_funding_source"
|
|
2040
2040
|
end
|
|
2041
|
-
pattern = Regexp.new(/^([A-Z0-9]{4,20}|[Bb][Aa][Ll][Aa][Nn][Cc][Ee])$/)
|
|
2041
|
+
pattern = Regexp.new(/^([A-Z0-9]{4,20}|[Bb][Aa][Ll][Aa][Nn][Cc][Ee]|[Ii][Nn][Vv][Oo][Ii][Cc][Ee])$/)
|
|
2042
2042
|
if @api_client.config.client_side_validation && id !~ pattern
|
|
2043
2043
|
fail ArgumentError, "invalid value for 'id' when calling TremendousApi.get_funding_source, must conform to the pattern #{pattern}."
|
|
2044
2044
|
end
|
|
2045
2045
|
|
|
2046
2046
|
# resource path
|
|
2047
|
-
local_var_path = '/funding_sources/{id}'.sub('{
|
|
2047
|
+
local_var_path = '/funding_sources/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
2048
2048
|
|
|
2049
2049
|
# query parameters
|
|
2050
2050
|
query_params = opts[:query_params] || {}
|
|
@@ -2107,7 +2107,7 @@ module Tremendous
|
|
|
2107
2107
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.get_invoice"
|
|
2108
2108
|
end
|
|
2109
2109
|
# resource path
|
|
2110
|
-
local_var_path = '/invoices/{id}'.sub('{
|
|
2110
|
+
local_var_path = '/invoices/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
2111
2111
|
|
|
2112
2112
|
# query parameters
|
|
2113
2113
|
query_params = opts[:query_params] || {}
|
|
@@ -2173,7 +2173,7 @@ module Tremendous
|
|
|
2173
2173
|
end
|
|
2174
2174
|
|
|
2175
2175
|
# resource path
|
|
2176
|
-
local_var_path = '/members/{id}'.sub('{
|
|
2176
|
+
local_var_path = '/members/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
2177
2177
|
|
|
2178
2178
|
# query parameters
|
|
2179
2179
|
query_params = opts[:query_params] || {}
|
|
@@ -2236,7 +2236,7 @@ module Tremendous
|
|
|
2236
2236
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.get_order"
|
|
2237
2237
|
end
|
|
2238
2238
|
# resource path
|
|
2239
|
-
local_var_path = '/orders/{id}'.sub('{
|
|
2239
|
+
local_var_path = '/orders/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
2240
2240
|
|
|
2241
2241
|
# query parameters
|
|
2242
2242
|
query_params = opts[:query_params] || {}
|
|
@@ -2302,7 +2302,7 @@ module Tremendous
|
|
|
2302
2302
|
end
|
|
2303
2303
|
|
|
2304
2304
|
# resource path
|
|
2305
|
-
local_var_path = '/organizations/{id}'.sub('{
|
|
2305
|
+
local_var_path = '/organizations/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
2306
2306
|
|
|
2307
2307
|
# query parameters
|
|
2308
2308
|
query_params = opts[:query_params] || {}
|
|
@@ -2370,7 +2370,7 @@ module Tremendous
|
|
|
2370
2370
|
end
|
|
2371
2371
|
|
|
2372
2372
|
# resource path
|
|
2373
|
-
local_var_path = '/products/{id}'.sub('{
|
|
2373
|
+
local_var_path = '/products/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
2374
2374
|
|
|
2375
2375
|
# query parameters
|
|
2376
2376
|
query_params = opts[:query_params] || {}
|
|
@@ -2433,7 +2433,7 @@ module Tremendous
|
|
|
2433
2433
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.get_report"
|
|
2434
2434
|
end
|
|
2435
2435
|
# resource path
|
|
2436
|
-
local_var_path = '/reports/{id}'.sub('{
|
|
2436
|
+
local_var_path = '/reports/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
2437
2437
|
|
|
2438
2438
|
# query parameters
|
|
2439
2439
|
query_params = opts[:query_params] || {}
|
|
@@ -2501,7 +2501,7 @@ module Tremendous
|
|
|
2501
2501
|
end
|
|
2502
2502
|
|
|
2503
2503
|
# resource path
|
|
2504
|
-
local_var_path = '/rewards/{id}'.sub('{
|
|
2504
|
+
local_var_path = '/rewards/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
2505
2505
|
|
|
2506
2506
|
# query parameters
|
|
2507
2507
|
query_params = opts[:query_params] || {}
|
|
@@ -2569,7 +2569,7 @@ module Tremendous
|
|
|
2569
2569
|
end
|
|
2570
2570
|
|
|
2571
2571
|
# resource path
|
|
2572
|
-
local_var_path = '/topups/{id}'.sub('{
|
|
2572
|
+
local_var_path = '/topups/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
2573
2573
|
|
|
2574
2574
|
# query parameters
|
|
2575
2575
|
query_params = opts[:query_params] || {}
|
|
@@ -2637,7 +2637,7 @@ module Tremendous
|
|
|
2637
2637
|
end
|
|
2638
2638
|
|
|
2639
2639
|
# resource path
|
|
2640
|
-
local_var_path = '/webhooks/{id}'.sub('{
|
|
2640
|
+
local_var_path = '/webhooks/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
2641
2641
|
|
|
2642
2642
|
# query parameters
|
|
2643
2643
|
query_params = opts[:query_params] || {}
|
|
@@ -3515,6 +3515,7 @@ module Tremendous
|
|
|
3515
3515
|
# List products
|
|
3516
3516
|
# Retrieve a list of available products
|
|
3517
3517
|
# @param [Hash] opts the optional parameters
|
|
3518
|
+
# @option opts [String] :id Comma-separated list of product IDs, used to only retrieve the provided products. Also accepts the special value `ALL_FEE_FREE`, which stands for every product in your catalog that carries no fee.
|
|
3518
3519
|
# @option opts [String] :country Comma-separated list of [Alpha-2 country codes](https://www.iban.com/country-codes), used to only retrieve products available in the provided countries
|
|
3519
3520
|
# @option opts [String] :currency Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies
|
|
3520
3521
|
# @option opts [String] :subcategory Comma-separated list of [subcategories](https://developers.tremendous.com/reference/obj-schema-products-1), used to only retrieve products with the provided subcategories
|
|
@@ -3527,6 +3528,7 @@ module Tremendous
|
|
|
3527
3528
|
# List products
|
|
3528
3529
|
# Retrieve a list of available products
|
|
3529
3530
|
# @param [Hash] opts the optional parameters
|
|
3531
|
+
# @option opts [String] :id Comma-separated list of product IDs, used to only retrieve the provided products. Also accepts the special value `ALL_FEE_FREE`, which stands for every product in your catalog that carries no fee.
|
|
3530
3532
|
# @option opts [String] :country Comma-separated list of [Alpha-2 country codes](https://www.iban.com/country-codes), used to only retrieve products available in the provided countries
|
|
3531
3533
|
# @option opts [String] :currency Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies
|
|
3532
3534
|
# @option opts [String] :subcategory Comma-separated list of [subcategories](https://developers.tremendous.com/reference/obj-schema-products-1), used to only retrieve products with the provided subcategories
|
|
@@ -3540,6 +3542,7 @@ module Tremendous
|
|
|
3540
3542
|
|
|
3541
3543
|
# query parameters
|
|
3542
3544
|
query_params = opts[:query_params] || {}
|
|
3545
|
+
query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
|
|
3543
3546
|
query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
|
|
3544
3547
|
query_params[:'currency'] = opts[:'currency'] if !opts[:'currency'].nil?
|
|
3545
3548
|
query_params[:'subcategory'] = opts[:'subcategory'] if !opts[:'subcategory'].nil?
|
|
@@ -3787,7 +3790,7 @@ module Tremendous
|
|
|
3787
3790
|
end
|
|
3788
3791
|
|
|
3789
3792
|
# resource path
|
|
3790
|
-
local_var_path = '/webhooks/{id}/events'.sub('{
|
|
3793
|
+
local_var_path = '/webhooks/{id}/events'.sub('{id}', CGI.escape(id.to_s))
|
|
3791
3794
|
|
|
3792
3795
|
# query parameters
|
|
3793
3796
|
query_params = opts[:query_params] || {}
|
|
@@ -3912,7 +3915,7 @@ module Tremendous
|
|
|
3912
3915
|
end
|
|
3913
3916
|
|
|
3914
3917
|
# resource path
|
|
3915
|
-
local_var_path = '/order_approvals/{id}/reject'.sub('{
|
|
3918
|
+
local_var_path = '/order_approvals/{id}/reject'.sub('{id}', CGI.escape(id.to_s))
|
|
3916
3919
|
|
|
3917
3920
|
# query parameters
|
|
3918
3921
|
query_params = opts[:query_params] || {}
|
|
@@ -3975,7 +3978,7 @@ module Tremendous
|
|
|
3975
3978
|
fail ArgumentError, "Missing the required parameter 'id' when calling TremendousApi.release_fraud_review"
|
|
3976
3979
|
end
|
|
3977
3980
|
# resource path
|
|
3978
|
-
local_var_path = '/fraud_reviews/{id}/release'.sub('{
|
|
3981
|
+
local_var_path = '/fraud_reviews/{id}/release'.sub('{id}', CGI.escape(id.to_s))
|
|
3979
3982
|
|
|
3980
3983
|
# query parameters
|
|
3981
3984
|
query_params = opts[:query_params] || {}
|
|
@@ -4045,7 +4048,7 @@ module Tremendous
|
|
|
4045
4048
|
end
|
|
4046
4049
|
|
|
4047
4050
|
# resource path
|
|
4048
|
-
local_var_path = '/rewards/{id}/resend'.sub('{
|
|
4051
|
+
local_var_path = '/rewards/{id}/resend'.sub('{id}', CGI.escape(id.to_s))
|
|
4049
4052
|
|
|
4050
4053
|
# query parameters
|
|
4051
4054
|
query_params = opts[:query_params] || {}
|
|
@@ -4124,7 +4127,7 @@ module Tremendous
|
|
|
4124
4127
|
fail ArgumentError, "Missing the required parameter 'simulate_webhook_request' when calling TremendousApi.simulate_webhook"
|
|
4125
4128
|
end
|
|
4126
4129
|
# resource path
|
|
4127
|
-
local_var_path = '/webhooks/{id}/simulate'.sub('{
|
|
4130
|
+
local_var_path = '/webhooks/{id}/simulate'.sub('{id}', CGI.escape(id.to_s))
|
|
4128
4131
|
|
|
4129
4132
|
# query parameters
|
|
4130
4133
|
query_params = opts[:query_params] || {}
|
|
@@ -4201,7 +4204,7 @@ module Tremendous
|
|
|
4201
4204
|
fail ArgumentError, "Missing the required parameter 'update_campaign_request' when calling TremendousApi.update_campaign"
|
|
4202
4205
|
end
|
|
4203
4206
|
# resource path
|
|
4204
|
-
local_var_path = '/campaigns/{id}'.sub('{
|
|
4207
|
+
local_var_path = '/campaigns/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
4205
4208
|
|
|
4206
4209
|
# query parameters
|
|
4207
4210
|
query_params = opts[:query_params] || {}
|
|
@@ -4250,7 +4253,7 @@ module Tremendous
|
|
|
4250
4253
|
# @param rule_type [String] The rule type to create or update.
|
|
4251
4254
|
# @param update_fraud_rule_list_request [UpdateFraudRuleListRequest] The lists to add or remove from the current configuration
|
|
4252
4255
|
# @param [Hash] opts the optional parameters
|
|
4253
|
-
# @return [
|
|
4256
|
+
# @return [FraudRule200Response]
|
|
4254
4257
|
def update_fraud_rule_list(rule_type, update_fraud_rule_list_request, opts = {})
|
|
4255
4258
|
data, _status_code, _headers = update_fraud_rule_list_with_http_info(rule_type, update_fraud_rule_list_request, opts)
|
|
4256
4259
|
data
|
|
@@ -4261,7 +4264,7 @@ module Tremendous
|
|
|
4261
4264
|
# @param rule_type [String] The rule type to create or update.
|
|
4262
4265
|
# @param update_fraud_rule_list_request [UpdateFraudRuleListRequest] The lists to add or remove from the current configuration
|
|
4263
4266
|
# @param [Hash] opts the optional parameters
|
|
4264
|
-
# @return [Array<(
|
|
4267
|
+
# @return [Array<(FraudRule200Response, Integer, Hash)>] FraudRule200Response data, response status code and response headers
|
|
4265
4268
|
def update_fraud_rule_list_with_http_info(rule_type, update_fraud_rule_list_request, opts = {})
|
|
4266
4269
|
if @api_client.config.debugging
|
|
4267
4270
|
@api_client.config.logger.debug 'Calling API: TremendousApi.update_fraud_rule_list ...'
|
|
@@ -4280,7 +4283,7 @@ module Tremendous
|
|
|
4280
4283
|
fail ArgumentError, "Missing the required parameter 'update_fraud_rule_list_request' when calling TremendousApi.update_fraud_rule_list"
|
|
4281
4284
|
end
|
|
4282
4285
|
# resource path
|
|
4283
|
-
local_var_path = '/fraud_rules/{rule_type}/update_list'.sub('{
|
|
4286
|
+
local_var_path = '/fraud_rules/{rule_type}/update_list'.sub('{rule_type}', CGI.escape(rule_type.to_s))
|
|
4284
4287
|
|
|
4285
4288
|
# query parameters
|
|
4286
4289
|
query_params = opts[:query_params] || {}
|
|
@@ -4302,7 +4305,7 @@ module Tremendous
|
|
|
4302
4305
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_fraud_rule_list_request)
|
|
4303
4306
|
|
|
4304
4307
|
# return_type
|
|
4305
|
-
return_type = opts[:debug_return_type] || '
|
|
4308
|
+
return_type = opts[:debug_return_type] || 'FraudRule200Response'
|
|
4306
4309
|
|
|
4307
4310
|
# auth_names
|
|
4308
4311
|
auth_names = opts[:debug_auth_names] || ['BearerApiKey']
|
|
@@ -4359,7 +4362,7 @@ module Tremendous
|
|
|
4359
4362
|
fail ArgumentError, "Missing the required parameter 'update_member_request' when calling TremendousApi.update_member"
|
|
4360
4363
|
end
|
|
4361
4364
|
# resource path
|
|
4362
|
-
local_var_path = '/members/{id}'.sub('{
|
|
4365
|
+
local_var_path = '/members/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
4363
4366
|
|
|
4364
4367
|
# query parameters
|
|
4365
4368
|
query_params = opts[:query_params] || {}
|