voyado-engage-client 1.0.0

No project description provided

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
  • Installation
• Authentication
  • API Key Authentication
• Services
• Models
• License

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:

Name
AchievementsService
AutomationService
BisnodeService
BonuschecksService
ChallengesService
ConsentsService
ContactoverviewService
ContactsService
InteractionsService
InteractionschemasService
InventoryService
MemberstatusService
OrdersService
PersonlookupService
PointAccountsService
PosoffersService
PromotionsService
SmsService
StoresService
TargetAudiencesService
TrackingService
TransactionsService

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:

Name	Description
ApiAchievementValue
PagedResultOfApiAchievementDefinition
EnrichmentVariableGroup	Grouped BCI enrichment varioables
PagedResultOfAllBonusCheckModel
PagedResultOfRedeemedBonusCheckModel
PagedResultOfAvailableBonusCheckModel
RedeemedBonusCheckModel
ChallengeAssignmentModel
ChallengeDefinitionModel
ChallengeDefinitionModelsResult
ChallengeGetChallengeDefinitionsStatus
ChallengeAssignmentModelsResult
ChallengeGetChallengesFilter
ChallengeCheckPointDto
AddCheckpointToChallengeAssignmentResult
ApiConsentDefinition
IApiContact
ProductRecommendationsModel
PurchaseHistorySummary
ListResultOfApiMessage
PagedResultOfApiMessage
PagedResultOfTransactionItem
PagedResultOfBonusPointTransactionModel
ChangeType
ApiPromotionModel
BoolRequest
ApiAdjustRewardPoints
ApiAdjustRewardPointsResponse
RedeemBodyModel
InteractionModel
InteractionPage
InteractionCreateResponse
InteractionSchemaWithoutJsonModel
InteractionSchemaResponse
InteractionSchemaModel
StockLevelRequest
SubscriptionRequest
SubscriptionResponse
MemberStatusModel
Order
StatusCodeResult
ContactSearchResult
PointAccountModel
PointDefinitionModel
PointTransactionModel
PointAccountModelsResult
PointTransactionModelsResult
PointAccountPointTransactions2Filter
PointTransactionToAccount
PointTransactionToAccountResultModel
PagedResultOfAllLoyaltyBarClaimModel
PagedResultOfAvailableLoyaltyBarClaimModel
RedeemedLoyaltyBarClaimModel
MultichannelPromotionModel
PromotionValidityModel	Following class holds the duration information for a promotion.
The this object uses to set and get the duration of a promotion.
MultichannelBasePromotionModel
SendSmsRequest
SendSmsResponse
ApiStore
IdName
CartApiModel	Cart model
OkResult
ProductViewApiModel
Receipt
ImportTransactionsObject
ApiAchievementDefinition
EnrichmentVariable	An enrichment value for a certain BCI variable
AllBonusCheckModel
AvailableBonusCheckModel
ChallengeAssignmentModelStatus
IHypermediaLink
CheckpointAssignOn
ChallengeDefinitionModelStatus
IApiConsent
ApiMessage
TransactionItem
BonusPointTransactionModel
BonusPointTransactionModelType
ApiPromotionRedemptionChannelModel
ApiPromotionRedemptionChannelModelType
ApiPromotionRedemptionChannelModelValueType
HypermediaLink
InteractionCreateResponseSelf
InteractionSchemaResponseSelf
OrderContact
TaxDetail
OrderPaymentMethod
OrderItem
OrderFee
OrderContactMatchKeyType
OrderItemType
OrderItemDiscount
StatusCode
SearchKey
UnregisteredFromOnlineRegisterInformation
AllLoyaltyBarClaimModel
AvailableLoyaltyBarClaimModel
MultichannelPromotionModelStatus	Current status of the promotion
PromotionBasicPresentationModel	Following object is for get/set the presentational side of the promotion.

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.