Skip to content
/ voucherify-python-sdk Public

Voucherify Python SDK | Use cases: online coupons, prepaid vouchers, in-app promo codes

www.voucherify.io

License

MIT license
11 stars 10 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

voucherifyio/voucherify-python-sdk

BranchesTags

Repository files navigation

Voucherify Python SDK

Official Voucherify SDK for Python

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 Python 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.

✅ Supported endpoint can be found here

Requirements.

Python 3.7+

Installation

To install the API client library to your local Maven repository, simply execute:

pip install 'Voucherify'

Then import the package:

import voucherify

🚀 Running code

Please follow the installation instruction and execute the following Python code:

import os
import voucherify
from dotenv import load_dotenv

load_dotenv()

HOST = os.getenv('VOUCHERIFY_HOST', 'https://api.voucherify.io')
X_APP_ID = os.getenv('X_APP_ID')
X_APP_TOKEN = os.getenv('X_APP_TOKEN')

if not X_APP_ID or not X_APP_TOKEN:
    raise ValueError("X_APP_ID and X_APP_TOKEN must be set in the .env file.")

configuration = voucherify.Configuration(
    host=HOST,
    api_key={
            "X-App-Id": X_APP_ID,
            "X-App-Token": X_APP_TOKEN
        }
)
# Debugging line
api_key_id = configuration.get_api_key_with_prefix('X-App-Id')
api_key_token = configuration.get_api_key_with_prefix('X-App-Token')

# Print whether both API keys are present and valid
are_keys_present = bool(api_key_id) and bool(api_key_token)
print(f"Configuration loaded: {are_keys_present}")

if(are_keys_present):
    with voucherify.ApiClient(configuration) as api_client:
        customers_api_instance = voucherify.CustomersApi(api_client)

        try:
            result = customers_api_instance.list_customers()
            print(result)

        except voucherifyClient.ApiException as e:
            self.fail(e)

It may be useful to check the tests implementation in the folder tests (./__tests__)

🐳 Running local tests with docker

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

🛠️ Contributing

Read more about how to Contribute to Voucherify Python 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.

📅 Changelog

  • 2024-09-18 - 3.0.0
    • The new version of the SDK includes coverage for all the most commonly used Voucherify endpoints and supports typed models.

Previous versions of the API are no longer supported, and we highly recommend upgrading to version 3.0.0, which is now designated as Long-Term Support (LTS).

Changelog for previous versions could be found in here

🔐 Documentation for Authorization

import os
import voucherify
from dotenv import load_dotenv

load_dotenv()

HOST = os.getenv('VOUCHERIFY_HOST', 'https://api.voucherify.io')
X_APP_ID = os.getenv('X_APP_ID')
X_APP_TOKEN = os.getenv('X_APP_TOKEN')

if not X_APP_ID or not X_APP_TOKEN:
    raise ValueError("X_APP_ID and X_APP_TOKEN must be set in the .env file.")

configuration = voucherify.Configuration(
    host=HOST,
    api_key={
            "X-App-Id": X_APP_ID,
            "X-App-Token": X_APP_TOKEN
        }
)
# Debugging line
api_key_id = configuration.get_api_key_with_prefix('X-App-Id')
api_key_token = configuration.get_api_key_with_prefix('X-App-Token')

# Print whether both API keys are present and valid
are_keys_present = bool(api_key_id) and bool(api_key_token)
print(f"Configuration loaded: {are_keys_present}")

then use

import voucherify

(...)
    with voucherify.ApiClient(configuration) as api_client:

Documentation for API Endpoints

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

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

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

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

Author

support@voucherify.io

About

Voucherify Python SDK | Use cases: online coupons, prepaid vouchers, in-app promo codes

www.voucherify.io

Topics

python sdk voucher

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

11 stars

Watchers

9 watching

Forks

10 forks
Report repository

Releases 6

v5.0.2 Latest
Nov 28, 2024
+ 5 releases

Packages

No packages published

Contributors 10

Languages