Module: Tremendous

Defined in:
lib/tremendous/api_error.rb,
lib/tremendous.rb,
lib/tremendous/version.rb,
lib/tremendous/api_client.rb,
lib/tremendous/models/role.rb,
lib/tremendous/models/field.rb,
lib/tremendous/models/order.rb,
lib/tremendous/models/topup.rb,
lib/tremendous/configuration.rb,
lib/tremendous/models/member.rb,
lib/tremendous/models/payout.rb,
lib/tremendous/models/report.rb,
lib/tremendous/models/reward.rb,
lib/tremendous/models/channel.rb,
lib/tremendous/models/invoice.rb,
lib/tremendous/models/product.rb,
lib/tremendous/models/webhook.rb,
lib/tremendous/models/allow_ip.rb,
lib/tremendous/models/campaign.rb,
lib/tremendous/models/allow_ip1.rb,
lib/tremendous/models/recipient.rb,
lib/tremendous/models/review_ip.rb,
lib/tremendous/models/order_base.rb,
lib/tremendous/models/review_ip1.rb,
lib/tremendous/api/tremendous_api.rb,
lib/tremendous/models/allow_email.rb,
lib/tremendous/models/error_model.rb,
lib/tremendous/models/member_base.rb,
lib/tremendous/models/reward_base.rb,
lib/tremendous/models/reward_link.rb,
lib/tremendous/models/allow_email1.rb,
lib/tremendous/models/create_field.rb,
lib/tremendous/models/custom_field.rb,
lib/tremendous/models/fraud_review.rb,
lib/tremendous/models/order_status.rb,
lib/tremendous/models/organization.rb,
lib/tremendous/models/review_email.rb,
lib/tremendous/models/reward_token.rb,
lib/tremendous/models/reward_value.rb,
lib/tremendous/models/webhook_post.rb,
lib/tremendous/models/campaign_base.rb,
lib/tremendous/models/create_member.rb,
lib/tremendous/models/inline_object.rb,
lib/tremendous/models/review_email1.rb,
lib/tremendous/models/currency_codes.rb,
lib/tremendous/models/funding_source.rb,
lib/tremendous/models/inline_object1.rb,
lib/tremendous/models/refund_details.rb,
lib/tremendous/models/review_country.rb,
lib/tremendous/models/delivery_method.rb,
lib/tremendous/models/delivery_status.rb,
lib/tremendous/models/fraud_config_ip.rb,
lib/tremendous/models/fraud_rule_type.rb,
lib/tremendous/models/order_with_link.rb,
lib/tremendous/models/payment_details.rb,
lib/tremendous/models/review_country1.rb,
lib/tremendous/models/update_campaign.rb,
lib/tremendous/models/delivery_details.rb,
lib/tremendous/models/fraud_review_geo.rb,
lib/tremendous/models/reward_with_link.rb,
lib/tremendous/models/delivery_metadata.rb,
lib/tremendous/models/fraud_review_base.rb,
lib/tremendous/models/fraud_review_risk.rb,
lib/tremendous/models/product_documents.rb,
lib/tremendous/models/fraud_rule_request.rb,
lib/tremendous/models/member_with_events.rb,
lib/tremendous/models/order_base_payment.rb,
lib/tremendous/models/order_without_link.rb,
lib/tremendous/models/balance_transaction.rb,
lib/tremendous/models/create_organization.rb,
lib/tremendous/models/fraud_review_reason.rb,
lib/tremendous/models/fraud_review_status.rb,
lib/tremendous/models/list_forex_response.rb,
lib/tremendous/models/reward_without_link.rb,
lib/tremendous/models/single_reward_order.rb,
lib/tremendous/models/create_field_request.rb,
lib/tremendous/models/create_order_request.rb,
lib/tremendous/models/create_topup_request.rb,
lib/tremendous/models/fraud_config_country.rb,
lib/tremendous/models/get_product_response.rb,
lib/tremendous/models/topup_create_request.rb,
lib/tremendous/models/base_order_for_create.rb,
lib/tremendous/models/create_member_request.rb,
lib/tremendous/models/create_report_request.rb,
lib/tremendous/models/fraud_rules_list_item.rb,
lib/tremendous/models/get_order200_response.rb,
lib/tremendous/models/inline_object1_reward.rb,
lib/tremendous/models/member_without_events.rb,
lib/tremendous/models/resend_reward_request.rb,
lib/tremendous/models/connected_organization.rb,
lib/tremendous/models/create_invoice_request.rb,
lib/tremendous/models/create_webhook_request.rb,
lib/tremendous/models/fraud_generic_response.rb,
lib/tremendous/models/fraud_review_list_item.rb,
lib/tremendous/models/fraud_rule200_response.rb,
lib/tremendous/models/fraud_rule400_response.rb,
lib/tremendous/models/fraud_rule422_response.rb,
lib/tremendous/models/get_member200_response.rb,
lib/tremendous/models/get_reward200_response.rb,
lib/tremendous/models/list_products_response.rb,
lib/tremendous/models/list_roles200_response.rb,
lib/tremendous/models/payment_details_refund.rb,
lib/tremendous/models/create_campaign_request.rb,
lib/tremendous/models/list_fields200_response.rb,
lib/tremendous/models/list_orders200_response.rb,
lib/tremendous/models/list_topups200_response.rb,
lib/tremendous/models/reward_for_order_create.rb,
lib/tremendous/models/update_campaign_request.rb,
lib/tremendous/models/create_field200_response.rb,
lib/tremendous/models/create_order200_response.rb,
lib/tremendous/models/create_order201_response.rb,
lib/tremendous/models/create_topup200_response.rb,
lib/tremendous/models/fraud_config_allow_email.rb,
lib/tremendous/models/list_members200_response.rb,
lib/tremendous/models/list_rewards200_response.rb,
lib/tremendous/models/list_rewards401_response.rb,
lib/tremendous/models/list_rewards429_response.rb,
lib/tremendous/models/simulate_webhook_request.rb,
lib/tremendous/models/balance_transaction_order.rb,
lib/tremendous/models/create_field_request_data.rb,
lib/tremendous/models/create_member200_response.rb,
lib/tremendous/models/create_report200_response.rb,
lib/tremendous/models/create_report201_response.rb,
lib/tremendous/models/fraud_config_review_email.rb,
lib/tremendous/models/fraud_rule_request_config.rb,
lib/tremendous/models/list_invoices200_response.rb,
lib/tremendous/models/list_webhooks200_response.rb,
lib/tremendous/models/resend_reward422_response.rb,
lib/tremendous/models/reward_with_link_delivery.rb,
lib/tremendous/models/create_api_key200_response.rb,
lib/tremendous/models/create_invoice200_response.rb,
lib/tremendous/models/create_webhook200_response.rb,
lib/tremendous/models/delivery_details_with_link.rb,
lib/tremendous/models/list_campaigns200_response.rb,
lib/tremendous/models/single_reward_order_reward.rb,
lib/tremendous/models/create_campaign200_response.rb,
lib/tremendous/models/create_campaign201_response.rb,
lib/tremendous/models/create_organization_request.rb,
lib/tremendous/models/single_reward_order_payment.rb,
lib/tremendous/models/fraud_review_related_rewards.rb,
lib/tremendous/models/get_fraud_review200_response.rb,
lib/tremendous/models/get_organization200_response.rb,
lib/tremendous/models/list_fraud_rules200_response.rb,
lib/tremendous/models/reward_without_link_delivery.rb,
lib/tremendous/models/connected_organization_member.rb,
lib/tremendous/models/create_report_request_filters.rb,
lib/tremendous/models/delete_fraud_rule200_response.rb,
lib/tremendous/models/get_member200_response_member.rb,
lib/tremendous/models/order_with_link_rewards_inner.rb,
lib/tremendous/models/review_redeemed_rewards_count.rb,
lib/tremendous/models/single_reward_order_with_link.rb,
lib/tremendous/models/create_order200_response_order.rb,
lib/tremendous/models/create_organization_properties.rb,
lib/tremendous/models/fraud_review_redemption_method.rb,
lib/tremendous/models/get_funding_source200_response.rb,
lib/tremendous/models/list_fraud_reviews200_response.rb,
lib/tremendous/models/list_organizations200_response.rb,
lib/tremendous/models/review_redeemed_rewards_amount.rb,
lib/tremendous/models/update_fraud_rule_list_request.rb,
lib/tremendous/models/create_organization200_response.rb,
lib/tremendous/models/list_rewards401_response_errors.rb,
lib/tremendous/models/list_webhook_events200_response.rb,
lib/tremendous/models/reward_base_custom_fields_inner.rb,
lib/tremendous/models/create_organization_for_response.rb,
lib/tremendous/models/create_report200_response_report.rb,
lib/tremendous/models/create_report201_response_report.rb,
lib/tremendous/models/fraud_config_country_update_list.rb,
lib/tremendous/models/generate_reward_link200_response.rb,
lib/tremendous/models/generate_reward_link403_response.rb,
lib/tremendous/models/list_funding_sources200_response.rb,
lib/tremendous/models/order_without_link_rewards_inner.rb,
lib/tremendous/models/single_reward_order_without_link.rb,
lib/tremendous/models/balance_transaction_order_payment.rb,
lib/tremendous/models/generate_reward_token200_response.rb,
lib/tremendous/models/list_roles200_response_roles_inner.rb,
lib/tremendous/models/update_fraud_rule_list200_response.rb,
lib/tremendous/models/connected_organization_organization.rb,
lib/tremendous/models/fraud_config_redeemed_rewards_count.rb,
lib/tremendous/models/single_reward_order_reward_delivery.rb,
lib/tremendous/models/single_reward_order_with_link_order.rb,
lib/tremendous/models/connected_organization_member_member.rb,
lib/tremendous/models/fraud_config_redeemed_rewards_amount.rb,
lib/tremendous/models/list_fields200_response_fields_inner.rb,
lib/tremendous/models/list_orders200_response_orders_inner.rb,
lib/tremendous/models/list_topups200_response_topups_inner.rb,
lib/tremendous/models/connected_organization_member_session.rb,
lib/tremendous/models/create_connected_organization_request.rb,
lib/tremendous/models/list_balance_transactions200_response.rb,
lib/tremendous/models/list_products_response_products_inner.rb,
lib/tremendous/models/update_fraud_rule_list_request_config.rb,
lib/tremendous/models/list_members200_response_members_inner.rb,
lib/tremendous/models/list_rewards200_response_rewards_inner.rb,
lib/tremendous/models/single_reward_order_without_link_order.rb,
lib/tremendous/models/generate_reward_link200_response_reward.rb,
lib/tremendous/models/generate_reward_token200_response_reward.rb,
lib/tremendous/models/list_connected_organizations200_response.rb,
lib/tremendous/models/list_invoices200_response_invoices_inner.rb,
lib/tremendous/models/list_webhooks200_response_webhooks_inner.rb,
lib/tremendous/models/single_reward_order_reward_delivery_meta.rb,
lib/tremendous/models/create_connected_organization200_response.rb,
lib/tremendous/models/create_organization_request_copy_settings.rb,
lib/tremendous/models/get_fraud_review200_response_fraud_review.rb,
lib/tremendous/models/list_fields200_response_fields_inner_data.rb,
lib/tremendous/models/get_member200_response_member_events_inner.rb,
lib/tremendous/models/list_campaigns200_response_campaigns_inner.rb,
lib/tremendous/models/create_connected_organization_member_request.rb,
lib/tremendous/models/create_order200_response_order_rewards_inner.rb,
lib/tremendous/models/create_organization200_response_organization.rb,
lib/tremendous/models/list_orders200_response_orders_inner_payment.rb,
lib/tremendous/models/list_rewards200_response_rewards_inner_value.rb,
lib/tremendous/models/create_report_request_filters_digital_rewards.rb,
lib/tremendous/models/get_fraud_review200_response_fraud_review_geo.rb,
lib/tremendous/models/list_fraud_rules200_response_fraud_rules_inner.rb,
lib/tremendous/models/single_reward_order_reward_custom_fields_inner.rb,
lib/tremendous/models/list_connected_organization_members200_response.rb,
lib/tremendous/models/list_products_response_products_inner_documents.rb,
lib/tremendous/models/list_rewards200_response_rewards_inner_delivery.rb,
lib/tremendous/models/create_connected_organization_member200_response.rb,
lib/tremendous/models/list_products_response_products_inner_skus_inner.rb,
lib/tremendous/models/list_rewards200_response_rewards_inner_recipient.rb,
lib/tremendous/models/list_fraud_reviews200_response_fraud_reviews_inner.rb,
lib/tremendous/models/list_organizations200_response_organizations_inner.rb,
lib/tremendous/models/list_products_response_products_inner_images_inner.rb,
lib/tremendous/models/list_orders200_response_orders_inner_payment_refund.rb,
lib/tremendous/models/create_connected_organization_member_session_request.rb,
lib/tremendous/models/create_report_request_filters_digital_rewards_amount.rb,
lib/tremendous/models/create_order200_response_order_rewards_inner_delivery.rb,
lib/tremendous/models/list_products_response_products_inner_countries_inner.rb,
lib/tremendous/models/list_campaigns200_response_campaigns_inner_email_style.rb,
lib/tremendous/models/list_fraud_reviews200_response_fraud_reviews_inner_geo.rb,
lib/tremendous/models/list_funding_sources200_response_funding_sources_inner.rb,
lib/tremendous/models/create_connected_organization_member_session200_response.rb,
lib/tremendous/models/create_report_request_filters_digital_rewards_created_at.rb,
lib/tremendous/models/list_balance_transactions200_response_transactions_inner.rb,
lib/tremendous/models/list_campaigns200_response_campaigns_inner_webpage_style.rb,
lib/tremendous/models/get_fraud_review200_response_fraud_review_related_rewards.rb,
lib/tremendous/models/list_rewards200_response_rewards_inner_custom_fields_inner.rb,
lib/tremendous/models/list_funding_sources200_response_funding_sources_inner_meta.rb,
lib/tremendous/models/list_balance_transactions200_response_transactions_inner_order.rb,
lib/tremendous/models/list_balance_transactions200_response_transactions_inner_order_payment.rb,
lib/tremendous/models/list_connected_organizations200_response_connected_organizations_inner.rb,
lib/tremendous/models/list_funding_sources200_response_funding_sources_inner_meta_failure_details.rb,
lib/tremendous/models/list_connected_organizations200_response_connected_organizations_inner_organization.rb,
lib/tremendous/models/list_connected_organization_members200_response_connected_organization_members_inner.rb,
lib/tremendous/models/list_connected_organization_members200_response_connected_organization_members_inner_member.rb,
lib/tremendous/models/create_connected_organization_member_session200_response_connected_organization_member_session.rb

Overview

#API Endpoints

#Deliver monetary rewards and incentives to employees, customers, survey participants, and more through the Tremendous API. For organizational tasks, like managing your organization and its members within Tremendous, please see the Tremendous Organizational API.

The version of the OpenAPI document: 2 Contact: developers@tremendous.com Generated by: openapi-generator.tech Generator version: 7.12.0

Defined Under Namespace

Modules: CreateOrderRequest, FraudRuleRequestConfig, UpdateFraudRuleListRequestConfig Classes: AllowEmail, AllowEmail1, AllowIp, AllowIp1, ApiClient, ApiError, BalanceTransaction, BalanceTransactionOrder, BalanceTransactionOrderPayment, BaseOrderForCreate, Campaign, CampaignBase, Channel, Configuration, ConnectedOrganization, ConnectedOrganizationMember, ConnectedOrganizationMemberMember, ConnectedOrganizationMemberSession, ConnectedOrganizationOrganization, CreateApiKey200Response, CreateCampaign200Response, CreateCampaign201Response, CreateCampaignRequest, CreateConnectedOrganization200Response, CreateConnectedOrganizationMember200Response, CreateConnectedOrganizationMemberRequest, CreateConnectedOrganizationMemberSession200Response, CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession, CreateConnectedOrganizationMemberSessionRequest, CreateConnectedOrganizationRequest, CreateField, CreateField200Response, CreateFieldRequest, CreateFieldRequestData, CreateInvoice200Response, CreateInvoiceRequest, CreateMember, CreateMember200Response, CreateMemberRequest, CreateOrder200Response, CreateOrder200ResponseOrder, CreateOrder200ResponseOrderRewardsInner, CreateOrder200ResponseOrderRewardsInnerDelivery, CreateOrder201Response, CreateOrganization, CreateOrganization200Response, CreateOrganization200ResponseOrganization, CreateOrganizationForResponse, CreateOrganizationProperties, CreateOrganizationRequest, CreateOrganizationRequestCopySettings, CreateReport200Response, CreateReport200ResponseReport, CreateReport201Response, CreateReport201ResponseReport, CreateReportRequest, CreateReportRequestFilters, CreateReportRequestFiltersDigitalRewards, CreateReportRequestFiltersDigitalRewardsAmount, CreateReportRequestFiltersDigitalRewardsCreatedAt, CreateTopup200Response, CreateTopupRequest, CreateWebhook200Response, CreateWebhookRequest, CurrencyCodes, CustomField, DeleteFraudRule200Response, DeliveryDetails, DeliveryDetailsWithLink, DeliveryMetadata, DeliveryMethod, DeliveryStatus, ErrorModel, Field, FraudConfigAllowEmail, FraudConfigCountry, FraudConfigCountryUpdateList, FraudConfigIP, FraudConfigRedeemedRewardsAmount, FraudConfigRedeemedRewardsCount, FraudConfigReviewEmail, FraudGenericResponse, FraudReview, FraudReviewBase, FraudReviewGeo, FraudReviewListItem, FraudReviewReason, FraudReviewRedemptionMethod, FraudReviewRelatedRewards, FraudReviewRisk, FraudReviewStatus, FraudRule200Response, FraudRule400Response, FraudRule422Response, FraudRuleRequest, FraudRuleType, FraudRulesListItem, FundingSource, GenerateRewardLink200Response, GenerateRewardLink200ResponseReward, GenerateRewardLink403Response, GenerateRewardToken200Response, GenerateRewardToken200ResponseReward, GetFraudReview200Response, GetFraudReview200ResponseFraudReview, GetFraudReview200ResponseFraudReviewGeo, GetFraudReview200ResponseFraudReviewRelatedRewards, GetFundingSource200Response, GetMember200Response, GetMember200ResponseMember, GetMember200ResponseMemberEventsInner, GetOrder200Response, GetOrganization200Response, GetProductResponse, GetReward200Response, InlineObject, InlineObject1, InlineObject1Reward, Invoice, ListBalanceTransactions200Response, ListBalanceTransactions200ResponseTransactionsInner, ListBalanceTransactions200ResponseTransactionsInnerOrder, ListBalanceTransactions200ResponseTransactionsInnerOrderPayment, ListCampaigns200Response, ListCampaigns200ResponseCampaignsInner, ListCampaigns200ResponseCampaignsInnerEmailStyle, ListCampaigns200ResponseCampaignsInnerWebpageStyle, ListConnectedOrganizationMembers200Response, ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner, ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember, ListConnectedOrganizations200Response, ListConnectedOrganizations200ResponseConnectedOrganizationsInner, ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization, ListFields200Response, ListFields200ResponseFieldsInner, ListFields200ResponseFieldsInnerData, ListForexResponse, ListFraudReviews200Response, ListFraudReviews200ResponseFraudReviewsInner, ListFraudReviews200ResponseFraudReviewsInnerGeo, ListFraudRules200Response, ListFraudRules200ResponseFraudRulesInner, ListFundingSources200Response, ListFundingSources200ResponseFundingSourcesInner, ListFundingSources200ResponseFundingSourcesInnerMeta, ListFundingSources200ResponseFundingSourcesInnerMetaFailureDetails, ListInvoices200Response, ListInvoices200ResponseInvoicesInner, ListMembers200Response, ListMembers200ResponseMembersInner, ListOrders200Response, ListOrders200ResponseOrdersInner, ListOrders200ResponseOrdersInnerPayment, ListOrders200ResponseOrdersInnerPaymentRefund, ListOrganizations200Response, ListOrganizations200ResponseOrganizationsInner, ListProductsResponse, ListProductsResponseProductsInner, ListProductsResponseProductsInnerCountriesInner, ListProductsResponseProductsInnerDocuments, ListProductsResponseProductsInnerImagesInner, ListProductsResponseProductsInnerSkusInner, ListRewards200Response, ListRewards200ResponseRewardsInner, ListRewards200ResponseRewardsInnerCustomFieldsInner, ListRewards200ResponseRewardsInnerDelivery, ListRewards200ResponseRewardsInnerRecipient, ListRewards200ResponseRewardsInnerValue, ListRewards401Response, ListRewards401ResponseErrors, ListRewards429Response, ListRoles200Response, ListRoles200ResponseRolesInner, ListTopups200Response, ListTopups200ResponseTopupsInner, ListWebhookEvents200Response, ListWebhooks200Response, ListWebhooks200ResponseWebhooksInner, Member, MemberBase, MemberWithEvents, MemberWithoutEvents, Order, OrderBase, OrderBasePayment, OrderStatus, OrderWithLink, OrderWithLinkRewardsInner, OrderWithoutLink, OrderWithoutLinkRewardsInner, Organization, PaymentDetails, PaymentDetailsRefund, Payout, Product, ProductDocuments, Recipient, RefundDetails, Report, ResendReward422Response, ResendRewardRequest, ReviewCountry, ReviewCountry1, ReviewEmail, ReviewEmail1, ReviewIp, ReviewIp1, ReviewRedeemedRewardsAmount, ReviewRedeemedRewardsCount, Reward, RewardBase, RewardBaseCustomFieldsInner, RewardForOrderCreate, RewardLink, RewardToken, RewardValue, RewardWithLink, RewardWithLinkDelivery, RewardWithoutLink, RewardWithoutLinkDelivery, Role, SimulateWebhookRequest, SingleRewardOrder, SingleRewardOrderPayment, SingleRewardOrderReward, SingleRewardOrderRewardCustomFieldsInner, SingleRewardOrderRewardDelivery, SingleRewardOrderRewardDeliveryMeta, SingleRewardOrderWithLink, SingleRewardOrderWithLinkOrder, SingleRewardOrderWithoutLink, SingleRewardOrderWithoutLinkOrder, Topup, TopupCreateRequest, TremendousApi, UpdateCampaign, UpdateCampaignRequest, UpdateFraudRuleList200Response, UpdateFraudRuleListRequest, Webhook, WebhookPost

Constant Summary collapse

VERSION = 
"5.19.0"

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Tremendous.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



265
266
267
268
269
270
271
 
# File 'lib/tremendous.rb', line 265

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end