Skip to content

voucherifyio/voucherify-ruby-sdk

BranchesTags

Repository files navigation

Voucherify Ruby SDK

Official Voucherify Ruby SDK

Gem Version Gem Downloads License GitHub issues

👋 Intro

Voucherify is an Incentive Optimization Engine that helps digital teams launch, test, and optimize targeted incentives – from coupons and promotions to loyalty programs and personalized offers – all with API.

We build Voucherify so you can run fewer incentives, but better ones.

Launch fast.

Test every day.

Drop what doesn’t work.

And optimize what does.

Integrate easily with your existing stack to make experimentation and optimization effortless.

📝 Useful info

This SDK is automatically generated by the OpenAPI Generator based on Voucherify API reference, v2018-08-01 version.

For more info, here are some useful places to visit:

⚙️ Install

Use any of the following methods to install the SDK.

Gem repository

The SDK is hosted in RubeGems. Add this line to your application's Gemfile:

gem 'voucherify'

Then run:

bundle install

Manual installation

Optionally, run:

gem install voucherify

🔒 Get your keys and address

Get your Voucherify keys for valid authorization and setting the basePath (cluster) to match your server URL:

  1. In Voucherify dashboard, go to Project settings.
  2. In Application information, find your basePath (cluster) address. For shared clusters:
    • Europe (default): https://api.voucherify.io
    • United States: https://us1.api.voucherify.io
    • Asia (Singapore): https://as1.api.voucherify.io
  3. Scroll down to Application Keys to grab your Application ID and Secret key.

🚀 Run code

Once installed, you can use pre-created example.rb with code for testing.

# 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

You can run the code from the directory where the file is placed (root for this repository):

ruby example.rb

Optionally, if you're using bundler, run:

bundle exec ruby example.rb

Note

This code just lists campaigns, so it won't affect your Voucherify data.

Once set up, check the following methods to give Voucherify a more interesting spin:

Tip

Check the test implementation in the Test folder and the Examples file.

🐳 Run 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.

🛠️ Contribute

Do you want to contribute?

Read more about how to contribute to this SDK in the Contributing guide in the main repo.

This SDK is auto-generated (except for tests), so changes made here will be overwritten by the generator.

🔐 Authorization

Authorization schemes defined for the API.

# 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

X-App-Id

  • Type: API key
  • API key parameter name: X-App-Id
  • Location: HTTP header

X-App-Token

  • Type: API key
  • API key parameter name: X-App-Token
  • Location: HTTP header

X-Client-Token

  • Type: API key
  • API key parameter name: X-Client-Token
  • Location: HTTP header

X-Client-Application-Id

  • Type: API key
  • API key parameter name: X-Client-Application-Id
  • Location: HTTP header

X-Management-Id

  • Type: API key
  • API key parameter name: X-Management-Id
  • Location: HTTP header

X-Management-Token

  • Type: API key
  • API key parameter name: X-Management-Token
  • Location: HTTP header

📅 Changelog

  • 2024-01-29 - 8.0.3
    • Added support for GET /v1/loyalties/{campaignId}/pending-points
    • Added support for GET /v1/loyalties/members/{memberId}/pending-points
    • Added support for GET /v1/loyalties/{campaignId}/members/{memberId}/pending-points
    • Added support for POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate
    • Added support for POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel
    • Added types for pending points (loyalties) and access settings (areas and stores)
  • 2024-11-26 - 8.0.2
    • Added support for STANDALONE campaign type.
    • Added optional metadata in OrderCalculatedItemSku
    • New possible value of ParameterExpandListCampaigns
    • New optional error parameter in Error
    • Updated LoyaltyCardTransactionDetailsBalance
  • 2024-11-04 - 8.0.1
    • Added support for returning campaign_id and campaign_name in stackable validation endpoint, when redeemable option is expanded
  • 2024-10-28 - 8.0.0
    • Added missing enums in few filters models
    • !!! BREAKING CHANGES !!!
      • VouchersApi.generateRandomCode now requires VouchersCreateResponseBody instead of plain object
      • property product in model Discount now uses DiscountProduct instead of SimpleProductDiscountUnit
      • property filters of model ExportsCreateRequestBodyParameters now uses plain object instead of ExportsCreateRequestBodyParametersFilters
  • 2024-10-25 - 7.0.0
    • Fix object parsing in query. For example filters while listing redemptions.
    • !!! BREAKING CHANGES !!!
      • Remove support for /v1/customers/{customerId}/consents - put Update Customer's consents [Deprecated]
      • Remove support for /v1/consents - get List Consents [Deprecated]
      • Remove support for /client/v1/customers/{customerId}/consents - put Update Customer's consents (client-side) [Deprecated]
      • Pagination changed on listing card transactions(listLoyaltyCardTransactions) - NO page param is supported - use starting_after_id instead.
      • Pagination changed on listing voucher transactions(listVoucherTransactions) - NO page param is supported - use starting_after_id instead.
      • ApplicableToEffect - changed - EVERY -> TO_EVERY, CHEAPEST -> TO_CHEAPEST, MOST_EXPENSIVE -> TO_MOST_EXPENSIVE, 2 new values introduced.
      • listPublications parameter filters have changed - now uses ParameterFiltersListPublications instead of String
      • ParameterFiltersListRedemptions and ParameterFiltersListCustomerRedeemables have been updated
      • enum LUCKY_DRAW, LUCKY_DRAW_CODE, VOUCHER_LUCKY_DRAW_CODE, CAMPAIGN_LUCKY_DRAW have been deleted from everywhere and no longer supported
      • CampaignsUpdateRequestBody - properties activityDurationAfterPublishing, joinOnce, autoJoin, type, uniqueWinners, uniqueWinnersPerDraw and enum AUTO_UPDATE | STATIC have been deleted and no longer supported
      • updateCustomersConsents has been deleted and no longer supported
      • FilterConditionsDateTimeConditions model has been renamed to FilterConditionsDateTime
      • FilterConditionsDateTime - conditions has been divided on $after, $before, $hasValue, $isUnknown, moreThan, lessThan properties
      • ParamterFiltersListCustomerRedeemables - model name of createdAt has been renamed from FilterConditionsDateTime to ParameterFiltersListCustomerRedeemablesCreatedAt
      • filter property in schemas ProductCollectionsCreateRequestBody, ProductCollectionsCreateResponseBody, ProductCollectionsItem and ProductCollectionsGetResponseBody has changed. Uses plain object.
      • discount property in schema CampaignsUpdateRequestBody now uses Discount model
      • properties winnersCount, uniqueWinnersPerDraw, uniqueWinners in model CampaignsUpdateRequestBody were deleted.
      • property stackingRulesType were deleted from models CategoriesGetResponseBody, Category
      • property categories in model ClientValidationsValidateResponseBodyRedeemablesItem uses now Array model
      • model ParameterFiltersListCustomerRedeemablesCampaignId has been fixed, can use junction properly.
      • model ParameterFiltersListRedemptions has been fixed, can use junction properly.
      • property filter in model ProductCollectionsCreateRequestBody now uses plain Object
      • property categories in model QualificationsRedeemable now uses Array<CategoryWithStackingRulesType>
    • Added support:
      • /v1/metadata-schemas - get List Metadata Schemas
      • /v1/metadata-schemas/{resource} - get Get Metadata Schema
      • /v1/locations - List Locations
      • /v1/locations/{locationId} - get Get Location
      • /v1/referrals/{campaignId}/members/{memberId}/holders - post Add Referral Code Holders
      • /v1/referrals/{campaignId}/members/{memberId}/holders - get List Referral Code Holders
      • /v1/referrals/{campaignId}/members/{memberId}/holders/{holderId} - delete Remove Referral Card Holder
      • /v1/referrals/members/{memberId}/holders - post Add Referral Code Holders
      • /v1/referrals/members/{memberId}/holders - get List Referral Code Holders
      • /v1/referrals/members/{memberId}/holders/{holderId} - delete Remove Referral Card Holder
      • /v1/trash-bin - get List Bin Entries
      • /v1/trash-bin/{binEntryId} - delete Delete Bin Entry
      • /v1/templates/campaigns - get List Campaign Templates
      • /v1/templates/campaigns - post Create Campaign Template
      • /v1/templates/campaigns/{campaignTemplateId} - get Get Campaign Template
      • /v1/templates/campaigns/{campaignTemplateId} - put Update Campaign Template
      • /v1/templates/campaigns/{campaignTemplateId} - delete Delete Campaign Template
      • /v1/templates/campaigns/{campaignTemplateId}/campaign-setup - post Create Campaign From Template
      • /v1/templates/campaigns/{campaignTemplateId}/tier-setup - post Add Promotion Tier From Template
      • /management/v1/projects - post Create Project
      • /management/v1/projects - get List Projects
      • /management/v1/projects/{projectId} - get Get Project
      • /management/v1/projects/{projectId} - put Update Project
      • /management/v1/projects/{projectId} - delete Delete Project
      • /management/v1/projects/{projectId}/users - post Assign User
      • /management/v1/projects/{projectId}/users/{userId} - put Update User
      • /management/v1/projects/{projectId}/users/{userId} - delete Unassign User
      • /management/v1/projects/users/invite - post Invite a New User
      • /management/v1/projects/{projectId}/templates/campaigns - get List Campaign Templates
      • /management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copy - post Copy Campaign Template to a Project
      • /management/v1/projects/{projectId}/stacking-rules - post Create Stacking Rules
      • /management/v1/projects/{projectId}/stacking-rules - get List Stacking Rules
      • /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} - get Get Stacking Rules
      • /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} - put Update Stacking Rules
      • /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} - delete Delete Stacking Rules
      • /management/v1/projects/{projectId}/metadata-schemas - post Create Metadata Schema
      • /management/v1/projects/{projectId}/metadata-schemas - get List Metadata Schemas
      • /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} - get Get Metadata Schema
      • /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} - put Update Metadata Schema
      • /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} - delete Delete Metadata Schema
      • /management/v1/projects/{projectId}/custom-event-schemas - post Create Custom Event Schema
      • /management/v1/projects/{projectId}/custom-event-schemas - get List Custom Event Schemas
      • /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} - get Get Custom Event Schema
      • /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} - put Update Custom Event Schema
      • /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} - delete Delete Custom Event Schema
      • /management/v1/projects/{projectId}/webhooks - post Create Webhook
      • /management/v1/projects/{projectId}/webhooks - get List Webhooks
      • /management/v1/projects/{projectId}/webhooks/{webhookId} - get Get Webhook
      • /management/v1/projects/{projectId}/webhooks/{webhookId} - put Update Webhook
      • /management/v1/projects/{projectId}/webhooks/{webhookId} - delete Delete Webhook
      • /management/v1/projects/{projectId}/branding - post Create Brand
      • /management/v1/projects/{projectId}/branding - get List Brands
      • /management/v1/projects/{projectId}/branding/{brandingId} - get Get Brand
      • /management/v1/projects/{projectId}/branding/{brandingId} - put Update Brand
      • /management/v1/projects/{projectId}/branding/{brandingId} - delete Delete Brand
  • 2024-09-05 - 6.0.0 - The new version of the SKD includes coverage for all the most commonly used Voucherify endpoints and supports typed models.

Previous versions of the SDK are no longer supported. We highly recommend upgrading to version 6.0.0 or newer, as it is now designated as Long-Term Support (LTS).

Changelog for previous versions is in the DEPRECATED_CHANGELOG.md file.

🌐 Documentation of API endpoints

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

Class Method HTTP request Description
VoucherifySdk::AsyncActionsApi get_async_action GET /v1/async-actions/{asyncActionId} Get Async Action
VoucherifySdk::AsyncActionsApi list_async_actions GET /v1/async-actions List Async Actions
VoucherifySdk::BinApi delete_bin_entry DELETE /v1/trash-bin/{binEntryId} Delete Bin Entry
VoucherifySdk::BinApi list_bin_entries GET /v1/trash-bin List Bin Entries
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 list_promotion_tiers_client_side GET /client/v1/promotions/tiers List Promotion Tiers (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 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 [Deprecated]
VoucherifySdk::CustomersApi list_customer_activity GET /v1/customers/{customerId}/activity List Customer Activity
VoucherifySdk::CustomersApi list_customer_redeemables GET /v1/customers/{customerId}/redeemables List Customer's Redeemables
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_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::LocationsApi get_location GET /v1/locations/{locationId} Get Location
VoucherifySdk::LocationsApi list_locations GET /v1/locations List Locations
VoucherifySdk::LoyaltiesApi activate_member_pending_points POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate Activate Member Pending Points
VoucherifySdk::LoyaltiesApi add_member POST /v1/loyalties/{campaignId}/members Add Member
VoucherifySdk::LoyaltiesApi cancel_member_pending_points POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel Cancel Member Pending Points
VoucherifySdk::LoyaltiesApi create_earning_rule POST /v1/loyalties/{campaignId}/earning-rules Create Earning Rule
VoucherifySdk::LoyaltiesApi create_in_bulk_loyalty_tiers POST /v1/loyalties/{campaignId}/tiers Create loyalty tiers
VoucherifySdk::LoyaltiesApi create_loyalty_program POST /v1/loyalties Create Loyalty Campaign
VoucherifySdk::LoyaltiesApi create_points_expiration_export POST /v1/loyalties/{campaignId}/points-expiration/export Export Loyalty Campaign Point Expiration
VoucherifySdk::LoyaltiesApi create_reward_assignment1 POST /v1/loyalties/{campaignId}/rewards Create Reward Assignment
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_program GET /v1/loyalties/{campaignId} Get Loyalty Campaign
VoucherifySdk::LoyaltiesApi get_loyalty_tier GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} Get Loyalty Tier
VoucherifySdk::LoyaltiesApi get_member GET /v1/loyalties/members/{memberId} Get Member
VoucherifySdk::LoyaltiesApi get_member1 GET /v1/loyalties/{campaignId}/members/{memberId} Get Member
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_campaign_pending_points GET /v1/loyalties/{campaignId}/pending-points List Campaign Pending Points
VoucherifySdk::LoyaltiesApi list_earning_rules GET /v1/loyalties/{campaignId}/earning-rules List Earning Rules
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_programs GET /v1/loyalties List Loyalty Campaigns
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_activity GET /v1/loyalties/members/{memberId}/activity List Member Activity
VoucherifySdk::LoyaltiesApi list_member_activity1 GET /v1/loyalties/{campaignId}/members/{memberId}/activity List Member Activity
VoucherifySdk::LoyaltiesApi list_member_loyalty_tier GET /v1/loyalties/members/{memberId}/tiers List Member's Loyalty Tiers
VoucherifySdk::LoyaltiesApi list_member_pending_points GET /v1/loyalties/members/{memberId}/pending-points List Member Pending Points
VoucherifySdk::LoyaltiesApi list_member_pending_points1 GET /v1/loyalties/{campaignId}/members/{memberId}/pending-points List Member Pending Points
VoucherifySdk::LoyaltiesApi list_member_rewards GET /v1/loyalties/members/{memberId}/rewards List Member Rewards
VoucherifySdk::LoyaltiesApi list_members GET /v1/loyalties/{campaignId}/members List Members
VoucherifySdk::LoyaltiesApi list_points_expiration GET /v1/loyalties/{campaignId}/members/{memberId}/points-expiration List Loyalty Card Point Expiration
VoucherifySdk::LoyaltiesApi list_reward_assignments1 GET /v1/loyalties/{campaignId}/reward-assignments List Reward Assignments
VoucherifySdk::LoyaltiesApi list_reward_assignments2 GET /v1/loyalties/{campaignId}/rewards List Reward Assignments
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_earning_rule PUT /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} Update Earning Rule
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::LoyaltiesApi update_loyalty_program PUT /v1/loyalties/{campaignId} Update Loyalty Campaign
VoucherifySdk::LoyaltiesApi update_reward_assignment1 PUT /v1/loyalties/{campaignId}/rewards/{assignmentId} Update Reward Assignment
VoucherifySdk::ManagementApi assign_user POST /management/v1/projects/{projectId}/users Assign User
VoucherifySdk::ManagementApi create_brand POST /management/v1/projects/{projectId}/branding Create Brand
VoucherifySdk::ManagementApi create_custom_event_schema POST /management/v1/projects/{projectId}/custom-event-schemas Create Custom Event Schema
VoucherifySdk::ManagementApi create_metadata_schema POST /management/v1/projects/{projectId}/metadata-schemas Create Metadata Schema
VoucherifySdk::ManagementApi create_project POST /management/v1/projects Create Project
VoucherifySdk::ManagementApi create_stacking_rules POST /management/v1/projects/{projectId}/stacking-rules Create Stacking Rules
VoucherifySdk::ManagementApi create_webhook POST /management/v1/projects/{projectId}/webhooks Create Webhook
VoucherifySdk::ManagementApi delete_brand DELETE /management/v1/projects/{projectId}/branding/{brandingId} Delete Brand
VoucherifySdk::ManagementApi delete_custom_event_schema DELETE /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} Delete Custom Event Schema
VoucherifySdk::ManagementApi delete_metadata_schema DELETE /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} Delete Metadata Schema
VoucherifySdk::ManagementApi delete_project DELETE /management/v1/projects/{projectId} Delete Project
VoucherifySdk::ManagementApi delete_stacking_rules DELETE /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} Delete Stacking Rules
VoucherifySdk::ManagementApi delete_webhook DELETE /management/v1/projects/{projectId}/webhooks/{webhookId} Delete Webhook
VoucherifySdk::ManagementApi get_brand GET /management/v1/projects/{projectId}/branding/{brandingId} Get Brand
VoucherifySdk::ManagementApi get_custom_event_schema GET /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} Get Custom Event Schema
VoucherifySdk::ManagementApi get_metadata_schema1 GET /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} Get Metadata Schema
VoucherifySdk::ManagementApi get_project GET /management/v1/projects/{projectId} Get Project
VoucherifySdk::ManagementApi get_stacking_rules GET /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} Get Stacking Rules
VoucherifySdk::ManagementApi get_user GET /management/v1/projects/{projectId}/users/{userId} Get User
VoucherifySdk::ManagementApi get_webhook GET /management/v1/projects/{projectId}/webhooks/{webhookId} Get Webhook
VoucherifySdk::ManagementApi invite_user POST /management/v1/projects/users/invite Invite a New User
VoucherifySdk::ManagementApi list_brands GET /management/v1/projects/{projectId}/branding List Brands
VoucherifySdk::ManagementApi list_custom_event_schemas GET /management/v1/projects/{projectId}/custom-event-schemas List Custom Event Schemas
VoucherifySdk::ManagementApi list_metadata_schemas1 GET /management/v1/projects/{projectId}/metadata-schemas List Metadata Schemas
VoucherifySdk::ManagementApi list_projects GET /management/v1/projects List Projects
VoucherifySdk::ManagementApi list_stacking_rules GET /management/v1/projects/{projectId}/stacking-rules List Stacking Rules
VoucherifySdk::ManagementApi list_users GET /management/v1/projects/{projectId}/users List Users
VoucherifySdk::ManagementApi list_webhooks GET /management/v1/projects/{projectId}/webhooks List Webhooks
VoucherifySdk::ManagementApi management_copy_campaign_template POST /management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copy Copy Campaign Template to a Project
VoucherifySdk::ManagementApi management_list_campaign_templates GET /management/v1/projects/{projectId}/templates/campaigns List Campaign Templates
VoucherifySdk::ManagementApi unassign_user DELETE /management/v1/projects/{projectId}/users/{userId} Unassign User
VoucherifySdk::ManagementApi update_brand PUT /management/v1/projects/{projectId}/branding/{brandingId} Update Brand
VoucherifySdk::ManagementApi update_custom_event_schema PUT /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} Update Custom Event Schema
VoucherifySdk::ManagementApi update_metadata_schema PUT /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} Update Metadata Schema
VoucherifySdk::ManagementApi update_project PUT /management/v1/projects/{projectId} Update Project
VoucherifySdk::ManagementApi update_stacking_rules PUT /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} Update Stacking Rules
VoucherifySdk::ManagementApi update_user PUT /management/v1/projects/{projectId}/users/{userId} Update User
VoucherifySdk::ManagementApi update_webhook PUT /management/v1/projects/{projectId}/webhooks/{webhookId} Update Webhook
VoucherifySdk::MetadataSchemasApi get_metadata_schema GET /v1/metadata-schemas/{resource} Get Metadata Schema
VoucherifySdk::MetadataSchemasApi list_metadata_schemas GET /v1/metadata-schemas List Metadata Schemas
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 add_promotion_tier_to_campaign POST /v1/promotions/{campaignId}/tiers Add Promotion Tier to Campaign
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 GET /v1/promotions/tiers List Promotion Tiers
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::PromotionsApi update_promotion_tier PUT /v1/promotions/tiers/{promotionTierId} Update Promotion Tier
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::ReferralsApi referrals_add_holders POST /v1/referrals/members/{memberId}/holders Add Referral Code Holders
VoucherifySdk::ReferralsApi referrals_add_holders1 POST /v1/referrals/{campaignId}/members/{memberId}/holders Add Referral Code Holders
VoucherifySdk::ReferralsApi referrals_code_holders GET /v1/referrals/{campaignId}/members/{memberId}/holders List Referral Code Holders
VoucherifySdk::ReferralsApi referrals_code_holders1 GET /v1/referrals/members/{memberId}/holders List Referral Code Holders
VoucherifySdk::ReferralsApi referrals_remove_holder DELETE /v1/referrals/members/{memberId}/holders/{holderId} Remove Referral Card Holder
VoucherifySdk::ReferralsApi referrals_remove_holder1 DELETE /v1/referrals/{campaignId}/members/{memberId}/holders/{holderId} Remove Referral Card Holder
VoucherifySdk::RewardsApi create_reward POST /v1/rewards Create Reward
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 GET /v1/rewards/{rewardId} Get Reward
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 list_rewards GET /v1/rewards List Rewards
VoucherifySdk::RewardsApi update_reward PUT /v1/rewards/{rewardId} Update Reward
VoucherifySdk::RewardsApi update_reward_assignment PUT /v1/rewards/{rewardId}/assignments/{assignmentId} Update Reward Assignment
VoucherifySdk::SegmentsApi create_segment POST /v1/segments Create Segment
VoucherifySdk::SegmentsApi delete_segment DELETE /v1/segments/{segmentId} Delete Segment
VoucherifySdk::SegmentsApi get_segment GET /v1/segments/{segmentId} Get Segment
VoucherifySdk::TemplatesApi add_tier_from_template POST /v1/templates/campaigns/{campaignTemplateId}/tier-setup Add Promotion Tier From Template
VoucherifySdk::TemplatesApi create_campaign_from_template POST /v1/templates/campaigns/{campaignTemplateId}/campaign-setup Create Campaign From Template
VoucherifySdk::TemplatesApi create_campaign_template POST /v1/templates/campaigns Create Campaign Template
VoucherifySdk::TemplatesApi delete_campaign_template DELETE /v1/templates/campaigns/{campaignTemplateId} Delete Campaign Template
VoucherifySdk::TemplatesApi get_campaign_template GET /v1/templates/campaigns/{campaignTemplateId} Get Campaign Template
VoucherifySdk::TemplatesApi list_campaign_templates GET /v1/templates/campaigns List Campaign Templates
VoucherifySdk::TemplatesApi update_campaign_template PUT /v1/templates/campaigns/{campaignTemplateId} Update Campaign Template
VoucherifySdk::ValidationRulesApi create_validation_rule_assignment POST /v1/validation-rules/{validationRuleId}/assignments Create Validation Rules Assignments
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 create_voucher POST /v1/vouchers/{code} Create Voucher
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 generate_random_code POST /v1/vouchers Generate Random Code
VoucherifySdk::VouchersApi get_voucher GET /v1/vouchers/{code} Get Voucher
VoucherifySdk::VouchersApi import_vouchers POST /v1/vouchers/import Import Vouchers
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 list_vouchers GET /v1/vouchers List Vouchers
VoucherifySdk::VouchersApi release_validation_session DELETE /v1/vouchers/{code}/sessions/{sessionKey} Release Validation Session
VoucherifySdk::VouchersApi update_voucher PUT /v1/vouchers/{code} Update Voucher
VoucherifySdk::VouchersApi update_voucher_balance POST /v1/vouchers/{code}/balance Add or Remove Voucher Balance
VoucherifySdk::VouchersApi update_vouchers_in_bulk POST /v1/vouchers/bulk/async Update Vouchers in Bulk
VoucherifySdk::VouchersApi update_vouchers_metadata_in_bulk POST /v1/vouchers/metadata/async Update Vouchers' Metadata in Bulk

📚 Documentation of models

About

Ruby SDK for Voucherify - coupons, vouchers, promo codes

www.voucherify.io

Topics

ruby sdk voucher

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

11 stars

Watchers

6 watching

Forks

13 forks
Report repository

Releases 8

v8.0.3 Latest
Feb 6, 2025
+ 7 releases

Packages

No packages published

Contributors 15

Languages