Module: Tremendous

Defined in:
lib/tremendous/api_error.rb,
lib/tremendous.rb,
lib/tremendous/version.rb,
lib/tremendous/api_client.rb,
lib/tremendous/models/field.rb,
lib/tremendous/models/order.rb,
lib/tremendous/configuration.rb,
lib/tremendous/models/member.rb,
lib/tremendous/models/reward.rb,
lib/tremendous/models/invoice.rb,
lib/tremendous/models/product.rb,
lib/tremendous/models/webhook.rb,
lib/tremendous/models/campaign.rb,
lib/tremendous/models/recipient.rb,
lib/tremendous/models/order_base.rb,
lib/tremendous/api/tremendous_api.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/custom_field.rb,
lib/tremendous/models/order_status.rb,
lib/tremendous/models/organization.rb,
lib/tremendous/models/reward_token.rb,
lib/tremendous/models/reward_value.rb,
lib/tremendous/models/webhook_post.rb,
lib/tremendous/models/create_member.rb,
lib/tremendous/models/create_invoice.rb,
lib/tremendous/models/currency_codes.rb,
lib/tremendous/models/funding_source.rb,
lib/tremendous/models/refund_details.rb,
lib/tremendous/models/delivery_method.rb,
lib/tremendous/models/delivery_status.rb,
lib/tremendous/models/order_with_link.rb,
lib/tremendous/models/payment_details.rb,
lib/tremendous/models/delivery_details.rb,
lib/tremendous/models/order_for_create.rb,
lib/tremendous/models/reward_with_link.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/reward_without_link.rb,
lib/tremendous/models/create_order_request.rb,
lib/tremendous/models/get_product_response.rb,
lib/tremendous/models/create_member_request.rb,
lib/tremendous/models/member_without_events.rb,
lib/tremendous/models/create_invoice_request.rb,
lib/tremendous/models/create_webhook_request.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/payment_details_refund.rb,
lib/tremendous/models/get_product200_response.rb,
lib/tremendous/models/list_fields200_response.rb,
lib/tremendous/models/list_orders200_response.rb,
lib/tremendous/models/order_for_create_reward.rb,
lib/tremendous/models/reward_for_order_create.rb,
lib/tremendous/models/create_order200_response.rb,
lib/tremendous/models/create_order201_response.rb,
lib/tremendous/models/get_campaign200_response.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/create_member200_response.rb,
lib/tremendous/models/list_invoices200_response.rb,
lib/tremendous/models/list_products200_response.rb,
lib/tremendous/models/list_webhooks200_response.rb,
lib/tremendous/models/order_without_link_reward.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/create_order_request_reward.rb,
lib/tremendous/models/create_organization_request.rb,
lib/tremendous/models/create_order_request_payment.rb,
lib/tremendous/models/get_organization200_response.rb,
lib/tremendous/models/reward_without_link_delivery.rb,
lib/tremendous/models/get_member200_response_member.rb,
lib/tremendous/models/order_with_link_rewards_inner.rb,
lib/tremendous/models/create_order200_response_order.rb,
lib/tremendous/models/get_funding_source200_response.rb,
lib/tremendous/models/list_organizations200_response.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/generate_reward_link200_response.rb,
lib/tremendous/models/generate_reward_link403_response.rb,
lib/tremendous/models/list_funding_sources200_response.rb,
lib/tremendous/models/generate_reward_token200_response.rb,
lib/tremendous/models/create_order_request_reward_delivery.rb,
lib/tremendous/models/list_fields200_response_fields_inner.rb,
lib/tremendous/models/list_orders200_response_orders_inner.rb,
lib/tremendous/models/list_balance_transactions200_response.rb,
lib/tremendous/models/list_products_response_products_inner.rb,
lib/tremendous/models/list_members200_response_members_inner.rb,
lib/tremendous/models/list_rewards200_response_rewards_inner.rb,
lib/tremendous/models/generate_reward_link200_response_reward.rb,
lib/tremendous/models/generate_reward_token200_response_reward.rb,
lib/tremendous/models/list_invoices200_response_invoices_inner.rb,
lib/tremendous/models/list_products200_response_products_inner.rb,
lib/tremendous/models/list_webhooks200_response_webhooks_inner.rb,
lib/tremendous/models/create_organization_request_copy_settings.rb,
lib/tremendous/models/get_member200_response_member_events_inner.rb,
lib/tremendous/models/list_campaigns200_response_campaigns_inner.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/list_rewards200_response_rewards_inner_delivery.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_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/list_products200_response_products_inner_skus_inner.rb,
lib/tremendous/models/list_balance_transactions200_response_invoices_inner.rb,
lib/tremendous/models/create_order200_response_order_rewards_inner_delivery.rb,
lib/tremendous/models/list_products200_response_products_inner_images_inner.rb,
lib/tremendous/models/list_products_response_products_inner_countries_inner.rb,
lib/tremendous/models/list_funding_sources200_response_funding_sources_inner.rb,
lib/tremendous/models/list_products200_response_products_inner_countries_inner.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

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 it’s members within Tremendous, please see the Tremendous Organizational API.

The version of the OpenAPI document: 2 Contact: [email protected] Generated by: openapi-generator.tech OpenAPI Generator version: 7.3.0

Defined Under Namespace

Classes: ApiClient, ApiError, BalanceTransaction, Campaign, Configuration, CreateApiKey200Response, CreateInvoice, CreateInvoice200Response, CreateInvoiceRequest, CreateMember, CreateMember200Response, CreateMemberRequest, CreateOrder200Response, CreateOrder200ResponseOrder, CreateOrder200ResponseOrderRewardsInner, CreateOrder200ResponseOrderRewardsInnerDelivery, CreateOrder201Response, CreateOrderRequest, CreateOrderRequestPayment, CreateOrderRequestReward, CreateOrderRequestRewardDelivery, CreateOrganization, CreateOrganization200Response, CreateOrganization200ResponseOrganization, CreateOrganizationRequest, CreateOrganizationRequestCopySettings, CreateWebhook200Response, CreateWebhookRequest, CurrencyCodes, CustomField, DeliveryDetails, DeliveryDetailsWithLink, DeliveryMethod, DeliveryStatus, ErrorModel, Field, FundingSource, GenerateRewardLink200Response, GenerateRewardLink200ResponseReward, GenerateRewardLink403Response, GenerateRewardToken200Response, GenerateRewardToken200ResponseReward, GetCampaign200Response, GetFundingSource200Response, GetMember200Response, GetMember200ResponseMember, GetMember200ResponseMemberEventsInner, GetOrganization200Response, GetProduct200Response, GetProductResponse, GetReward200Response, Invoice, ListBalanceTransactions200Response, ListBalanceTransactions200ResponseInvoicesInner, ListCampaigns200Response, ListCampaigns200ResponseCampaignsInner, ListFields200Response, ListFields200ResponseFieldsInner, ListFundingSources200Response, ListFundingSources200ResponseFundingSourcesInner, ListFundingSources200ResponseFundingSourcesInnerMeta, ListInvoices200Response, ListInvoices200ResponseInvoicesInner, ListMembers200Response, ListMembers200ResponseMembersInner, ListOrders200Response, ListOrders200ResponseOrdersInner, ListOrders200ResponseOrdersInnerPayment, ListOrders200ResponseOrdersInnerPaymentRefund, ListOrganizations200Response, ListOrganizations200ResponseOrganizationsInner, ListProducts200Response, ListProducts200ResponseProductsInner, ListProducts200ResponseProductsInnerCountriesInner, ListProducts200ResponseProductsInnerImagesInner, ListProducts200ResponseProductsInnerSkusInner, ListProductsResponse, ListProductsResponseProductsInner, ListProductsResponseProductsInnerCountriesInner, ListProductsResponseProductsInnerImagesInner, ListProductsResponseProductsInnerSkusInner, ListRewards200Response, ListRewards200ResponseRewardsInner, ListRewards200ResponseRewardsInnerCustomFieldsInner, ListRewards200ResponseRewardsInnerDelivery, ListRewards200ResponseRewardsInnerRecipient, ListRewards200ResponseRewardsInnerValue, ListRewards401Response, ListRewards401ResponseErrors, ListRewards429Response, ListWebhookEvents200Response, ListWebhooks200Response, ListWebhooks200ResponseWebhooksInner, Member, MemberBase, MemberWithEvents, MemberWithoutEvents, Order, OrderBase, OrderBasePayment, OrderForCreate, OrderForCreateReward, OrderStatus, OrderWithLink, OrderWithLinkRewardsInner, OrderWithoutLink, OrderWithoutLinkReward, Organization, PaymentDetails, PaymentDetailsRefund, Product, Recipient, RefundDetails, ResendReward422Response, Reward, RewardBase, RewardBaseCustomFieldsInner, RewardForOrderCreate, RewardLink, RewardToken, RewardValue, RewardWithLink, RewardWithLinkDelivery, RewardWithoutLink, RewardWithoutLinkDelivery, SimulateWebhookRequest, TremendousApi, Webhook, WebhookPost

Constant Summary collapse

VERSION =
"5.0.0"

Class Method Summary collapse

Class Method Details

.configureObject

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.



151
152
153
154
155
156
157
# File 'lib/tremendous.rb', line 151

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