VoyadoEngage TypeScript SDK 1.0.0

Welcome to the VoyadoEngage SDK documentation. This guide will help you get started with integrating and using the VoyadoEngage SDK in your project.

Versions

• API version: v2
• SDK version: 1.0.0

About the API

The Voyado Engage API enables developers to interact with Voyado's customer experience platform, allowing for the management and personalization of marketing efforts.

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • Access Token Authentication
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: TypeScript >= 4.8.4

Installation

To get started with the SDK, we recommend installing using npm:

npm install voyado_engage

Authentication

Access Token Authentication

The VoyadoEngage API uses an Access Token for authentication.

This token must be provided to authenticate your requests to the API.

Setting the Access Token

When you initialize the SDK, you can set the access token as follows:

const sdk = new VoyadoEngage({ token: 'YOUR_TOKEN' });

If you need to set or update the access token after initializing the SDK, you can use:

const sdk = new VoyadoEngage();
sdk.token = 'YOUR_TOKEN';

Services

The SDK provides various services to interact with the API.

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

| 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 | | | ApiAdjustRewardPointsResponse1 | | | 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 | | | OrderItem | | | TaxDetail | | | OrderPaymentMethod | | | 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 | | | ReceiptPaymentMethod | | | ReceiptItem | | | ReceiptTaxDetail | | | ReceiptUsedBonusCheck | | | ReceiptUsedPromotion | | | ReceiptExtraDataItem | | | ReceiptContactMatchKeyType | | | ReceiptItemType | | | ReceiptItemDiscount | |

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.