Voucherify Ruby SDK

Official Voucherify SDK for Ruby

Gem Version Gem Downloads License GitHub issues

Voucherify empowers marketers and developers with flexible building blocks to come up with, implement, and track targeted promotional campaigns.

Learn more about Voucherify by visiting our site.

This SDK is automatically generated by the OpenAPI Generator based on our Documentation with v2018-08-01 version.

The legacy version of Ruby SDK could be found here

📝 Documentation

You will find detailed description and example responses at our official documentation. Most method headers point to more detailed descriptions of arguments you can use.

📚 Want to learn more? Visit our official site or our Success Portal.

👽 Having troubles? Check our Help center.

🧪 Looking for promotion ideas? Check our Cookbook to get an inspiration.

🐛 Encounter a bug? Please file a report in the Issues.

⚙️ Installation

Gem Repository

The SDK is hosted in RubeGems and could be easy obtained by adding this line to Your application's Gemfile:

gem 'voucherify'

And then execute:

bundle install

Or install it yourself as:

gem install voucherify

🚀 Running code

When You have Voucherify gem installed You could use pre-created example.rb with example code for testing purpose.

```ruby example.rb

Load the gem

require 'VoucherifySdk'

Setup authorization

VoucherifySdk.configure do |config| # Configure API key authorization: X-App-Id config.api_key['X-App-Id'] = 'YOUR API KEY'

# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'

# (Optional) Configure Voucherify cluster, default is https://api.voucherify.io
# config.host = 'https://us1.api.voucherify.io'

end

Creating API Instance

api_instance = VoucherifySdk::CampaignsApi.new

Calling list_campaigns

begin result = api_instance.list_campaigns() puts result rescue VoucherifySdk::ApiError => e puts "Exception when calling VouchersApi->list_campaigns: #e" end


Code could be run from the directory where the file is placed (root for this repository), by using:

```shell
ruby example.rb

Or, if You're using bundler:

bundle exec ruby example.rb

🛡️ This code does simple campaign list, so it won't affect Your Voucherify data.

🔒 Remember to fill Your Voucherify keys for the valid authorization.

💅 More examples and good practices You could find in the EXAMPLES.md document.

🐳 Running local tests with docker

  1. Copy .env.example to .env and fill in the values.
  2. Run docker build -t ruby . to build the image.
  3. Run docker run --rm ruby to run the tests and delete container immediately after.

🛠️ Contributing

Read more about how to Contribute to Voucherify Ruby SDK by visiting main repo GENERATING-SDKS.md

Remember that this SDK is auto generated (except of the tests) so changes made here will be overwritten by generator.

🔐 Documentation for Authorization

# Setup authorization
VoucherifySdk.configure do |config|
    # Application Keys
    config.api_key['X-App-Id'] = 'YOUR API ID'
    config.api_key['X-App-Token'] = 'YOUR API TOKEN'

    # Client-side Keys
    config.api_key['X-Client-Application-Id'] = 'YOUR CLIENT API ID'
    config.api_key['X-Client-Token'] = 'YOUR CLIENT API TOKEN'

    # Cluster (Optional)
    # default is https://api.voucherify.io
    config.host = 'https://us1.api.voucherify.io'
end

🌐 Documentation for API Endpoints

All URIs are relative to https://api.voucherify.io

Class Method HTTP request Description
VoucherifySdk::CampaignsApi add_voucher_with_specific_code_to_campaign POST /v1/campaigns/campaignId/vouchers/code Add Voucher with Specific Code to Campaign
VoucherifySdk::CampaignsApi add_vouchers_to_campaign POST /v1/campaigns/campaignId/vouchers Add Vouchers to Campaign
VoucherifySdk::CampaignsApi create_campaign POST /v1/campaigns Create Campaign
VoucherifySdk::CampaignsApi delete_campaign DELETE /v1/campaigns/campaignId Delete Campaign
VoucherifySdk::CampaignsApi disable_campaign POST /v1/campaigns/campaignId/disable Disable Campaign
VoucherifySdk::CampaignsApi enable_campaign POST /v1/campaigns/campaignId/enable Enable Campaign
VoucherifySdk::CampaignsApi get_campaign GET /v1/campaigns/campaignId Get Campaign
VoucherifySdk::CampaignsApi import_vouchers_to_campaign POST /v1/campaigns/campaignId/import Import Vouchers to Campaign
VoucherifySdk::CampaignsApi import_vouchers_to_campaign_using_csv POST /v1/campaigns/campaignId/importCSV Import Vouchers to Campaign by CSV
VoucherifySdk::CampaignsApi list_campaigns GET /v1/campaigns List Campaigns
VoucherifySdk::CampaignsApi update_campaign PUT /v1/campaigns/campaignId Update Campaign
VoucherifySdk::CategoriesApi create_category POST /v1/categories Create Category
VoucherifySdk::CategoriesApi delete_category DELETE /v1/categories/categoryId Delete Category
VoucherifySdk::CategoriesApi get_category GET /v1/categories/categoryId Get Category
VoucherifySdk::CategoriesApi list_categories GET /v1/categories List Categories
VoucherifySdk::CategoriesApi update_category PUT /v1/categories/categoryId Update Category
VoucherifySdk::ClientSideApi check_eligibility_client_side POST /client/v1/qualifications Check Eligibility (client-side)
VoucherifySdk::ClientSideApi redeem_stacked_discounts_client_side POST /client/v1/redemptions Redeem Stackable Discounts (client-side)
VoucherifySdk::ClientSideApi track_custom_event_client_side POST /client/v1/events Track Custom Event (client-side)
VoucherifySdk::ClientSideApi update_customers_consents_client_side PUT /client/v1/customers/customerId/consents Update Customer's consents (client-side)
VoucherifySdk::ClientSideApi validate_stacked_discounts_client_side POST /client/v1/validations Validate Stackable Discounts (client-side)
VoucherifySdk::CustomersApi create_customer POST /v1/customers Create Customer
VoucherifySdk::CustomersApi customer_permanently_deletion POST /v1/customers/customerId/permanent-deletion Delete Customer Permanently
VoucherifySdk::CustomersApi delete_customer DELETE /v1/customers/customerId Delete Customer
VoucherifySdk::CustomersApi get_customer GET /v1/customers/customerId Get Customer
VoucherifySdk::CustomersApi import_customers_using_csv POST /v1/customers/importCSV Import and Update Customers using CSV
VoucherifySdk::CustomersApi list_customer_activities GET /v1/customers/customerId/activities List Customer Activities
VoucherifySdk::CustomersApi list_customer_segments GET /v1/customers/customerId/segments List Customer's Segments
VoucherifySdk::CustomersApi list_customers GET /v1/customers List Customers
VoucherifySdk::CustomersApi update_customer PUT /v1/customers/customerId Update Customer
VoucherifySdk::CustomersApi update_customers_consents PUT /v1/customers/customerId/consents Update Customer's consents
VoucherifySdk::CustomersApi update_customers_in_bulk POST /v1/customers/bulk/async Update Customers in bulk
VoucherifySdk::CustomersApi update_customers_metadata_in_bulk POST /v1/customers/metadata/async Update Customers' Metadata in bulk
VoucherifySdk::EventsApi track_custom_event POST /v1/events Track Custom Event
VoucherifySdk::ExportsApi create_export POST /v1/exports Create Export
VoucherifySdk::ExportsApi delete_export DELETE /v1/exports/exportId Delete Export
VoucherifySdk::ExportsApi download_export GET /v1/exports/export_Id Download Export
VoucherifySdk::ExportsApi get_export GET /v1/exports/exportId Get Export
VoucherifySdk::ExportsApi list_exports GET /v1/exports List Exports
VoucherifySdk::LoyaltiesApi create_in_bulk_loyalty_tiers POST /v1/loyalties/campaignId/tiers Create loyalty tiers
VoucherifySdk::LoyaltiesApi delete_earning_rule DELETE /v1/loyalties/campaignId/earning-rules/earningRuleId Delete Earning Rule
VoucherifySdk::LoyaltiesApi delete_loyalty_program DELETE /v1/loyalties/campaignId Delete Loyalty Campaign
VoucherifySdk::LoyaltiesApi delete_reward_assignment1 DELETE /v1/loyalties/campaignId/rewards/assignmentId Delete Reward Assignment
VoucherifySdk::LoyaltiesApi disable_earning_rule POST /v1/loyalties/campaignId/earning-rules/earningRuleId/disable Disable Earning Rule
VoucherifySdk::LoyaltiesApi enable_earning_rule POST /v1/loyalties/campaignId/earning-rules/earningRuleId/enable Enable Earning Rule
VoucherifySdk::LoyaltiesApi export_loyalty_card_transactions POST /v1/loyalties/members/memberId/transactions/export Export Loyalty Card Transactions
VoucherifySdk::LoyaltiesApi export_loyalty_card_transactions1 POST /v1/loyalties/campaignId/members/memberId/transactions/export Export Loyalty Card Transactions
VoucherifySdk::LoyaltiesApi get_earning_rule GET /v1/loyalties/campaignId/earning-rules/earningRuleId Get Earning Rule
VoucherifySdk::LoyaltiesApi get_loyalty_tier GET /v1/loyalties/campaignId/tiers/loyaltyTierId Get Loyalty Tier
VoucherifySdk::LoyaltiesApi get_reward_assignment1 GET /v1/loyalties/campaignId/reward-assignments/assignmentId Get Reward Assignment
VoucherifySdk::LoyaltiesApi get_reward_assignment2 GET /v1/loyalties/campaignId/rewards/assignmentId Get Reward Assignment
VoucherifySdk::LoyaltiesApi get_reward_details GET /v1/loyalties/campaignId/reward-assignments/assignmentId/reward Get Reward Details
VoucherifySdk::LoyaltiesApi list_loyalty_card_transactions GET /v1/loyalties/members/memberId/transactions List Loyalty Card Transactions
VoucherifySdk::LoyaltiesApi list_loyalty_card_transactions1 GET /v1/loyalties/campaignId/members/memberId/transactions List Loyalty Card Transactions
VoucherifySdk::LoyaltiesApi list_loyalty_tier_earning_rules GET /v1/loyalties/campaignId/tiers/loyaltyTierId/earning-rules List Loyalty Tier Earning Rules
VoucherifySdk::LoyaltiesApi list_loyalty_tier_rewards GET /v1/loyalties/campaignId/tiers/loyaltyTierId/rewards List Loyalty Tier Rewards
VoucherifySdk::LoyaltiesApi list_loyalty_tiers GET /v1/loyalties/campaignId/tiers List Loyalty Tiers
VoucherifySdk::LoyaltiesApi list_member_loyalty_tier GET /v1/loyalties/members/memberId/tiers List Member's Loyalty Tiers
VoucherifySdk::LoyaltiesApi list_member_rewards GET /v1/loyalties/members/memberId/rewards List Member Rewards
VoucherifySdk::LoyaltiesApi list_points_expiration GET /v1/loyalties/campaignId/members/memberId/points-expiration Get Points Expiration
VoucherifySdk::LoyaltiesApi redeem_reward POST /v1/loyalties/members/memberId/redemption Redeem Reward
VoucherifySdk::LoyaltiesApi redeem_reward1 POST /v1/loyalties/campaignId/members/memberId/redemption Redeem Reward
VoucherifySdk::LoyaltiesApi transfer_points POST /v1/loyalties/campaignId/members/memberId/transfers Transfer Loyalty Points
VoucherifySdk::LoyaltiesApi update_loyalty_card_balance POST /v1/loyalties/members/memberId/balance Add or Remove Loyalty Card Balance
VoucherifySdk::LoyaltiesApi update_loyalty_card_balance1 POST /v1/loyalties/campaignId/members/memberId/balance Add or Remove Loyalty Card Balance
VoucherifySdk::OrdersApi create_order POST /v1/orders Create Order
VoucherifySdk::OrdersApi create_order_export POST /v1/orders/export Create Orders Export
VoucherifySdk::OrdersApi get_order GET /v1/orders/orderId Get Order
VoucherifySdk::OrdersApi import_orders POST /v1/orders/import Import Orders
VoucherifySdk::OrdersApi list_orders GET /v1/orders List Orders
VoucherifySdk::OrdersApi update_order PUT /v1/orders/orderId Update Order
VoucherifySdk::ProductCollectionsApi create_product_collection POST /v1/product-collections Create Product Collection
VoucherifySdk::ProductCollectionsApi delete_product_collection DELETE /v1/product-collections/productCollectionId Delete Product Collection
VoucherifySdk::ProductCollectionsApi get_product_collection GET /v1/product-collections/productCollectionId Get Product Collection
VoucherifySdk::ProductCollectionsApi list_product_collections GET /v1/product-collections List Product Collections
VoucherifySdk::ProductCollectionsApi list_products_in_collection GET /v1/product-collections/productCollectionId/products List Products in Collection
VoucherifySdk::ProductsApi create_product POST /v1/products Create Product
VoucherifySdk::ProductsApi create_sku POST /v1/products/productId/skus Create SKU
VoucherifySdk::ProductsApi delete_product DELETE /v1/products/productId Delete Product
VoucherifySdk::ProductsApi delete_sku DELETE /v1/products/productId/skus/skuId Delete SKU
VoucherifySdk::ProductsApi get_product GET /v1/products/productId Get Product
VoucherifySdk::ProductsApi get_sku GET /v1/skus/skuId Get SKU
VoucherifySdk::ProductsApi import_products_using_csv POST /v1/products/importCSV Import Products using CSV
VoucherifySdk::ProductsApi import_skus_using_csv POST /v1/skus/importCSV Import SKUs using CSV
VoucherifySdk::ProductsApi list_products GET /v1/products List Products
VoucherifySdk::ProductsApi list_skus_in_product GET /v1/products/productId/skus List SKUs in Product
VoucherifySdk::ProductsApi update_product PUT /v1/products/productId Update Product
VoucherifySdk::ProductsApi update_products_in_bulk POST /v1/products/bulk/async Update Products in bulk
VoucherifySdk::ProductsApi update_products_metadata_in_bulk POST /v1/products/metadata/async Update Products' Metadata in bulk
VoucherifySdk::ProductsApi update_sku PUT /v1/products/productId/skus/skuId Update SKU
VoucherifySdk::PromotionsApi create_promotion_stack POST /v1/promotions/campaignId/stacks Create Promotion Stack
VoucherifySdk::PromotionsApi delete_promotion_stack DELETE /v1/promotions/campaignId/stacks/stackId Delete Promotion Stack
VoucherifySdk::PromotionsApi delete_promotion_tier DELETE /v1/promotions/tiers/promotionTierId Delete Promotion Tier
VoucherifySdk::PromotionsApi disable_promotion_tier POST /v1/promotions/tiers/promotionTierId/disable Disable Promotion Tier
VoucherifySdk::PromotionsApi enable_promotion_tier POST /v1/promotions/tiers/promotionTierId/enable Enable Promotion Tier
VoucherifySdk::PromotionsApi get_promotion_stack GET /v1/promotions/campaignId/stacks/stackId Get Promotion Stack
VoucherifySdk::PromotionsApi get_promotion_tier GET /v1/promotions/tiers/promotionTierId Get Promotion Tier
VoucherifySdk::PromotionsApi list_all_promotion_stacks GET /v1/promotions/stacks List Promotion Stacks
VoucherifySdk::PromotionsApi list_promotion_stacks_in_campaign GET /v1/promotions/campaignId/stacks List Promotion Stacks in Campaign
VoucherifySdk::PromotionsApi list_promotion_tiers_from_campaign GET /v1/promotions/campaignId/tiers List Promotion Tiers from Campaign
VoucherifySdk::PromotionsApi update_promotion_stack PUT /v1/promotions/campaignId/stacks/stackId Update Promotion Stack
VoucherifySdk::PublicationsApi create_publication POST /v1/publications Create Publication
VoucherifySdk::PublicationsApi create_publication1 GET /v1/publications/create Create Publication
VoucherifySdk::PublicationsApi list_publications GET /v1/publications List Publications
VoucherifySdk::QualificationsApi check_eligibility POST /v1/qualifications Check Eligibility
VoucherifySdk::RedemptionsApi get_redemption GET /v1/redemptions/redemptionId Get Redemption
VoucherifySdk::RedemptionsApi get_voucher_redemptions GET /v1/vouchers/code/redemption Get Voucher's Redemptions
VoucherifySdk::RedemptionsApi list_redemptions GET /v1/redemptions List Redemptions
VoucherifySdk::RedemptionsApi redeem_stacked_discounts POST /v1/redemptions Redeem Stackable Discounts
VoucherifySdk::RedemptionsApi rollback_redemption POST /v1/redemptions/redemptionId/rollback Rollback Redemption
VoucherifySdk::RedemptionsApi rollback_stacked_redemptions POST /v1/redemptions/parentRedemptionId/rollbacks Rollback Stackable Redemptions
VoucherifySdk::RewardsApi create_reward_assignment POST /v1/rewards/rewardId/assignments Create Reward Assignment
VoucherifySdk::RewardsApi delete_reward DELETE /v1/rewards/rewardId Delete Reward
VoucherifySdk::RewardsApi delete_reward_assignment DELETE /v1/rewards/rewardId/assignments/assignmentId Delete Reward Assignment
VoucherifySdk::RewardsApi get_reward_assignment GET /v1/rewards/rewardId/assignments/assignmentId Get Reward Assignment
VoucherifySdk::RewardsApi list_reward_assignments GET /v1/rewards/rewardId/assignments List Reward Assignments
VoucherifySdk::RewardsApi update_reward_assignment PUT /v1/rewards/rewardId/assignments/assignmentId Update Reward Assignment
VoucherifySdk::SegmentsApi delete_segment DELETE /v1/segments/segmentId Delete Segment
VoucherifySdk::ValidationRulesApi create_validation_rules POST /v1/validation-rules Create Validation Rules
VoucherifySdk::ValidationRulesApi delete_validation_rule_assignment DELETE /v1/validation-rules/validationRuleId/assignments/assignmentId Delete Validation Rule Assignment
VoucherifySdk::ValidationRulesApi delete_validation_rules DELETE /v1/validation-rules/validationRuleId Delete Validation Rule
VoucherifySdk::ValidationRulesApi get_validation_rule GET /v1/validation-rules/validationRuleId Get Validation Rule
VoucherifySdk::ValidationRulesApi list_validation_rule_assignments GET /v1/validation-rules/validationRuleId/assignments List Validation Rule Assignments
VoucherifySdk::ValidationRulesApi list_validation_rules GET /v1/validation-rules List Validation Rules
VoucherifySdk::ValidationRulesApi list_validation_rules_assignments GET /v1/validation-rules-assignments List Validation Rules' Assignment(s)
VoucherifySdk::ValidationRulesApi update_validation_rule PUT /v1/validation-rules/validationRuleId Update Validation Rule
VoucherifySdk::ValidationsApi validate_stacked_discounts POST /v1/validations Validate Stackable Discounts
VoucherifySdk::VouchersApi delete_voucher DELETE /v1/vouchers/code Delete Voucher
VoucherifySdk::VouchersApi disable_voucher POST /v1/vouchers/code/disable Disable Voucher
VoucherifySdk::VouchersApi enable_voucher POST /v1/vouchers/code/enable Enable Voucher
VoucherifySdk::VouchersApi export_voucher_transactions POST /v1/vouchers/code/transactions/export Export Voucher Transactions
VoucherifySdk::VouchersApi get_voucher GET /v1/vouchers/code Get Voucher
VoucherifySdk::VouchersApi import_vouchers_using_csv POST /v1/vouchers/importCSV Import Vouchers using CSV
VoucherifySdk::VouchersApi list_voucher_transactions GET /v1/vouchers/code/transactions List Voucher Transactions
VoucherifySdk::VouchersApi release_validation_session DELETE /v1/vouchers/code/sessions/sessionKey Release Validation Session
VoucherifySdk::VouchersApi update_voucher_balance POST /v1/vouchers/code/balance Add or Remove Voucher Balance

📚 Documentation for Models