No project description provided
Project description
VoyadoEngageSdk Python SDK 1.0.0
Welcome to the VoyadoEngageSdk SDK documentation. This guide will help you get started with integrating and using the VoyadoEngageSdk SDK in your project.
Versions
- API version:
v2 - SDK version:
1.0.0
Table of Contents
Setup & Configuration
Supported Language Versions
This SDK is compatible with the following versions: Python >= 3.7
Installation
To get started with the SDK, we recommend installing using pip:
pip install voyado-engage-client
Authentication
API Key Authentication
The VoyadoEngageSdk API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.
Setting the API key
When you initialize the SDK, you can set the API key as follows:
VoyadoEngageSdk(
api_key="YOUR_API_KEY",
api_key_header="YOUR_API_KEY_HEADER"
)
If you need to set or update the API key after initializing the SDK, you can use:
sdk.set_api_key("YOUR_API_KEY", "YOUR_API_KEY_HEADER")
Services
The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
Models
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models with links to their detailed documentation:
This data uses to displey in different kind of views, for an example in Email messages etc.
This fields populates the "Presentation" section in the admin UI. |
| MultichannelPromotionRedemptionChannelModel | |
| AssignDateRange | The validity time of the promotion set when assignment occured |
| Unit | |
| MultichannelPromotionRedemptionChannelModelType | |
| MultichannelPromotionRedemptionChannelModelValueType | |
| CartItemApiModel | Cart item model |
| Utm | |
| ReceiptContact | |
| ReceiptTaxDetail | |
| ReceiptPaymentMethod | |
| ReceiptItem | |
| ReceiptUsedBonusCheck | |
| ReceiptUsedPromotion | |
| ReceiptExtraDataItem | |
| ReceiptContactMatchKeyType | |
| ReceiptItemType | |
| ReceiptItemDiscount | |
License
This SDK is licensed under the MIT License.
See the LICENSE file for more details.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for voyado-engage-client-1.0.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 33ba65dcacdd5685f5627483e7d6231d8215b4df75d5f41a10bdd989a53ffd24 |
|
| MD5 | 5e349cdc84dd2233c454999993d3deb3 |
|
| BLAKE2b-256 | 9668d57be433fc511cba50f90044b4fbe40be9bd795e565b7b387e85ff07bbf2 |
Hashes for voyado_engage_client-1.0.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 02c8f3c60be1718deccbaf067f5b9181db9c1ed20fcf3ee58bd1c6fbe9b8ac35 |
|
| MD5 | 2b4946e4e11daae3ba14354b7cae1792 |
|
| BLAKE2b-256 | 9f049db13980d7f067fc301db0ab7fc9501ee092eb20c5db3e939efac53da8e2 |
